cace366a-ffad-45f1-9b60-678e607fa527

Committed 14 May 2024 02:21PM UTC coverage: 60.862% (-35.0%) from 95.908%

Build # cace366a-ffad-45f1-9b60-678e607fa527

Build Type

push

circleci

Committed by

jrgriffiniii

Commit Message

wip

Run Details

1 of 3 new or added lines in 2 files covered. (33.33%)

1194 existing lines in 57 files now uncovered.

2076 of 3411 relevant lines covered (60.86%)

22.71 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.75

/app/models/pdc_metadata/resource.rb

# frozen_string_literal: true
module PDCMetadata
  # Represents a PUL Datacite resource
  # https://support.datacite.org/docs/datacite-metadata-schema-v44-properties-overview

  def self.fuzzy_match(obj, value)
    obj.key.to_s == value or obj.value.casecmp(value).zero?
  end

  # rubocop:disable Metrics/ClassLength
  class Resource
    attr_accessor :creators, :titles, :publisher, :publication_year, :resource_type, :resource_type_general,
      :description, :doi, :ark, :rights_many, :version_number, :collection_tags, :keywords, :related_objects,
      :funders, :organizational_contributors, :domains, :migrated, :communities, :subcommunities

    # rubocop:disable Metrics/MethodLength
    def initialize(doi: nil, title: nil, resource_type: nil, resource_type_general: nil, creators: [], description: nil)
      @titles = []
      @titles << PDCMetadata::Title.new(title:) unless title.nil?
      @description = description
      @collection_tags = []
      @creators = creators
      @resource_type = resource_type || "Dataset"
      @resource_type_general = resource_type_general || self.class.default_resource_type_general
      @publisher = "Princeton University"
      @publication_year = Time.zone.today.year
      @ark = nil
      @doi = doi
      @rights_many = []
      @version_number = "1"
      @related_objects = []
      @keywords = []
      @contributors = []
      @organizational_contributors = []
      @funders = []
      @domains = []
      @communities = []
      @subcommunities = []
      @migrated = false
    end
    # rubocop:enable Metrics/MethodLength

    def accessors
      setters = methods.map(&:to_s).filter { |s| s.match?(/\w=$/) }
      setters.map { |s| s.delete("=").to_sym }
    end

    def individual_contributors
      @contributors
    end

    def individual_contributors=(value)
      @contributors = value
    end

    def identifier
      @doi
    end

    def identifier_type
      return nil if @doi.nil?
      "DOI"
    end

    def main_title
      @titles.find(&:main?)&.title
    end

    def other_titles
      @titles.select { |title| title.main? == false }
    end

    def to_xml
      xml_declaration = '<?xml version="1.0"?>'
      xml_body = datacite_serialization.to_xml
      xml_declaration + "\n" + xml_body + "\n"
    end

    def datacite_serialization
      @datacite_serialization ||= PDCSerialization::Datacite.new_from_work_resource(self)
    end

    class << self
      # Creates a PDCMetadata::Resource from a JSONB postgres field
      #  This jsonb_hash can be created by running JSON.parse(pdc_metadata_resource.to_json)
      #   or by loading it from the work.metadata jsonb field
      def new_from_jsonb(jsonb_hash)
        resource = PDCMetadata::Resource.new
        return resource if jsonb_hash.blank?
        set_basics(resource, jsonb_hash)
        set_curator_controlled_metadata(resource, jsonb_hash)
        set_additional_metadata(resource, jsonb_hash)
        set_titles(resource, jsonb_hash)
        set_creators(resource, jsonb_hash)
        set_individual_contributors(resource, jsonb_hash)
        set_organizational_contributors(resource, jsonb_hash)
        set_related_objects(resource, jsonb_hash)
        set_funders(resource, jsonb_hash)

        resource
      end

      def resource_type_general_values
        Datacite::Mapping::ResourceTypeGeneral.map(&:value)
      end

      def default_resource_type_general
        "Dataset"
      end

      private

        def rights(rights_info)
          return if rights_info.nil?
          PDCMetadata::Rights.find(rights_info["identifier"])
        end

        def set_basics(resource, hash)
          resource.description = hash["description"]
          resource.publisher = hash["publisher"]
          resource.publication_year = hash["publication_year"]

          resource.rights_many = (hash["rights_many"] || []).map { |rights_info| rights(rights_info) }.compact
          if resource.rights_many.count == 0 && hash["rights"]
            # Special case to handle works created with a single-value `rights` field
            # instead of the new multi-value `rights_many` field.
            resource.rights_many = [rights(hash["rights"])].compact
          end

          resource.domains = hash["domains"] || []
          resource.migrated = hash["migrated"] || false
        end

        def set_curator_controlled_metadata(resource, hash)
          resource.doi = hash["doi"]
          resource.ark = hash["ark"]
          resource.version_number = hash["version_number"]
          resource.collection_tags = hash["collection_tags"] || []
          resource.resource_type = hash["resource_type"]

          # TODO: Older records have a different format.
          # When we migrate these, then this can be removed.
          resource_type_general = hash["resource_type_general"]
          unless resource_type_general.blank? || Datacite::Mapping::ResourceTypeGeneral.find_by_value(resource_type_general)
            resource_type_general = ::Datacite::Mapping::ResourceTypeGeneral.find do |obj|
              ::PDCMetadata.fuzzy_match(obj, resource_type_general)
            end.value
          end
          resource.resource_type_general = resource_type_general
        end

        def set_additional_metadata(resource, hash)
          resource.keywords = hash["keywords"] || []
          resource.communities = hash["communities"] || []
          resource.subcommunities = hash["subcommunities"] || []
        end

        def set_titles(resource, hash)
          titles = hash["titles"] || []

          titles.each do |title|
            resource.titles << PDCMetadata::Title.new(title: title["title"], title_type: title["title_type"])
          end
        end

        def set_related_objects(resource, hash)
          related_objects = hash["related_objects"] || []

          related_objects.each do |related_object|
            next if related_object["related_identifier"].blank? && related_object["related_identifier_type"].blank?
            resource.related_objects << PDCMetadata::RelatedObject.new(
                                          related_identifier: related_object["related_identifier"],
                                          related_identifier_type: related_object["related_identifier_type"],
                                          relation_type: related_object["relation_type"]
                                        )
          end
        end

        def set_creators(resource, hash)
          creators = hash["creators"] || []

          creators.each do |creator|
            resource.creators << Creator.from_hash(creator)
          end
          resource.creators.sort_by!(&:sequence)
        end

        def set_individual_contributors(resource, hash)
          individual_contributors = hash["contributors"] || []

          individual_contributors.each do |contributor|
            resource.individual_contributors << Creator.individual_contributor_from_hash(contributor)
          end
          resource.individual_contributors.sort_by!(&:sequence)
        end

        def set_organizational_contributors(resource, hash)
          organizational_contributors = hash["organizational_contributors"] || []

          organizational_contributors.each do |contributor|
            resource.organizational_contributors << Creator.organizational_contributor_from_hash(contributor)
          end
        end

        def set_funders(resource, hash)
          funders = hash["funders"] || []

          funders.each do |funder|
            resource.funders << Funder.funder_from_hash(funder)
          end
          # TODO: Make funders reorderable
          # resource.funders.sort_by!(&:sequence)
        end
    end
  end
  # rubocop:enable Metrics/ClassLength
end

1	# frozen_string_literal: true
2	module PDCMetadata	1✔
3	# Represents a PUL Datacite resource
4	# https://support.datacite.org/docs/datacite-metadata-schema-v44-properties-overview
5
6	def self.fuzzy_match(obj, value)	1✔
7	obj.key.to_s == value or obj.value.casecmp(value).zero?	7✔
8	end
9
10	# rubocop:disable Metrics/ClassLength
11	class Resource	1✔
12	attr_accessor :creators, :titles, :publisher, :publication_year, :resource_type, :resource_type_general,	1✔
13	:description, :doi, :ark, :rights_many, :version_number, :collection_tags, :keywords, :related_objects,
14	:funders, :organizational_contributors, :domains, :migrated, :communities, :subcommunities
15
16	# rubocop:disable Metrics/MethodLength
17	def initialize(doi: nil, title: nil, resource_type: nil, resource_type_general: nil, creators: [], description: nil)	1✔
18	@titles = []	221✔
19	@titles << PDCMetadata::Title.new(title:) unless title.nil?	221✔
20	@description = description	221✔
21	@collection_tags = []	221✔
22	@creators = creators	221✔
23	@resource_type = resource_type \|\| "Dataset"	221✔
24	@resource_type_general = resource_type_general \|\| self.class.default_resource_type_general	221✔
25	@publisher = "Princeton University"	221✔
26	@publication_year = Time.zone.today.year	221✔
27	@ark = nil	221✔
28	@doi = doi	221✔
29	@rights_many = []	221✔
30	@version_number = "1"	221✔
31	@related_objects = []	221✔
32	@keywords = []	221✔
33	@contributors = []	221✔
34	@organizational_contributors = []	221✔
35	@funders = []	221✔
36	@domains = []	221✔
37	@communities = []	221✔
38	@subcommunities = []	221✔
39	@migrated = false	221✔
40	end
41	# rubocop:enable Metrics/MethodLength
42
43	def accessors	1✔
44	setters = methods.map(&:to_s).filter { \|s\| s.match?(/\w=$/) }	1,782✔
45	setters.map { \|s\| s.delete("=").to_sym }	242✔
46	end
47
48	def individual_contributors	1✔
49	@contributors	320✔
50	end
51
52	def individual_contributors=(value)	1✔
53	@contributors = value	11✔
54	end
55
56	def identifier	1✔
UNCOV 57	@doi	×
58	end
59
60	def identifier_type	1✔
UNCOV 61	return nil if @doi.nil?	×
UNCOV 62	"DOI"	×
63	end
64
65	def main_title	1✔
66	@titles.find(&:main?)&.title	91✔
67	end
68
69	def other_titles	1✔
70	@titles.select { \|title\| title.main? == false }	61✔
71	end
72
73	def to_xml	1✔
74	xml_declaration = '<?xml version="1.0"?>'	5✔
75	xml_body = datacite_serialization.to_xml	5✔
76	xml_declaration + "\n" + xml_body + "\n"	5✔
77	end
78
79	def datacite_serialization	1✔
80	@datacite_serialization \|\|= PDCSerialization::Datacite.new_from_work_resource(self)	10✔
81	end
82
83	class << self	1✔
84	# Creates a PDCMetadata::Resource from a JSONB postgres field
85	# This jsonb_hash can be created by running JSON.parse(pdc_metadata_resource.to_json)
86	# or by loading it from the work.metadata jsonb field
87	def new_from_jsonb(jsonb_hash)	1✔
88	resource = PDCMetadata::Resource.new	195✔
89	return resource if jsonb_hash.blank?	195✔
90	set_basics(resource, jsonb_hash)	181✔
91	set_curator_controlled_metadata(resource, jsonb_hash)	181✔
92	set_additional_metadata(resource, jsonb_hash)	181✔
93	set_titles(resource, jsonb_hash)	181✔
94	set_creators(resource, jsonb_hash)	181✔
95	set_individual_contributors(resource, jsonb_hash)	181✔
96	set_organizational_contributors(resource, jsonb_hash)	181✔
97	set_related_objects(resource, jsonb_hash)	181✔
98	set_funders(resource, jsonb_hash)	181✔
99
100	resource	181✔
101	end
102
103	def resource_type_general_values	1✔
104	Datacite::Mapping::ResourceTypeGeneral.map(&:value)	20✔
105	end
106
107	def default_resource_type_general	1✔
108	"Dataset"	221✔
109	end
110
111	private	1✔
112
113	def rights(rights_info)	1✔
114	return if rights_info.nil?	153✔
115	PDCMetadata::Rights.find(rights_info["identifier"])	153✔
116	end
117
118	def set_basics(resource, hash)	1✔
119	resource.description = hash["description"]	181✔
120	resource.publisher = hash["publisher"]	181✔
121	resource.publication_year = hash["publication_year"]	181✔
122
123	resource.rights_many = (hash["rights_many"] \|\| []).map { \|rights_info\| rights(rights_info) }.compact	315✔
124	if resource.rights_many.count == 0 && hash["rights"]	181✔
125	# Special case to handle works created with a single-value `rights` field
126	# instead of the new multi-value `rights_many` field.
127	resource.rights_many = [rights(hash["rights"])].compact	19✔
128	end
129
130	resource.domains = hash["domains"] \|\| []	181✔
131	resource.migrated = hash["migrated"] \|\| false	181✔
132	end
133
134	def set_curator_controlled_metadata(resource, hash)	1✔
135	resource.doi = hash["doi"]	181✔
136	resource.ark = hash["ark"]	181✔
137	resource.version_number = hash["version_number"]	181✔
138	resource.collection_tags = hash["collection_tags"] \|\| []	181✔
139	resource.resource_type = hash["resource_type"]	181✔
140
141	# TODO: Older records have a different format.
142	# When we migrate these, then this can be removed.
143	resource_type_general = hash["resource_type_general"]	181✔
144	unless resource_type_general.blank? \|\| Datacite::Mapping::ResourceTypeGeneral.find_by_value(resource_type_general)	181✔
145	resource_type_general = ::Datacite::Mapping::ResourceTypeGeneral.find do \|obj\|	1✔
146	::PDCMetadata.fuzzy_match(obj, resource_type_general)	3✔
147	end.value
148	end
149	resource.resource_type_general = resource_type_general	181✔
150	end
151
152	def set_additional_metadata(resource, hash)	1✔
153	resource.keywords = hash["keywords"] \|\| []	181✔
154	resource.communities = hash["communities"] \|\| []	181✔
155	resource.subcommunities = hash["subcommunities"] \|\| []	181✔
156	end
157
158	def set_titles(resource, hash)	1✔
159	titles = hash["titles"] \|\| []	181✔
160
161	titles.each do \|title\|	181✔
162	resource.titles << PDCMetadata::Title.new(title: title["title"], title_type: title["title_type"])	168✔
163	end
164	end
165
166	def set_related_objects(resource, hash)	1✔
167	related_objects = hash["related_objects"] \|\| []	181✔
168
169	related_objects.each do \|related_object\|	181✔
170	next if related_object["related_identifier"].blank? && related_object["related_identifier_type"].blank?	168✔
171	resource.related_objects << PDCMetadata::RelatedObject.new(	168✔
172	related_identifier: related_object["related_identifier"],
173	related_identifier_type: related_object["related_identifier_type"],
174	relation_type: related_object["relation_type"]
175	)
176	end
177	end
178
179	def set_creators(resource, hash)	1✔
180	creators = hash["creators"] \|\| []	181✔
181
182	creators.each do \|creator\|	181✔
183	resource.creators << Creator.from_hash(creator)	1,232✔
184	end
185	resource.creators.sort_by!(&:sequence)	181✔
186	end
187
188	def set_individual_contributors(resource, hash)	1✔
189	individual_contributors = hash["contributors"] \|\| []	181✔
190
191	individual_contributors.each do \|contributor\|	181✔
192	resource.individual_contributors << Creator.individual_contributor_from_hash(contributor)	42✔
193	end
194	resource.individual_contributors.sort_by!(&:sequence)	181✔
195	end
196
197	def set_organizational_contributors(resource, hash)	1✔
198	organizational_contributors = hash["organizational_contributors"] \|\| []	181✔
199
200	organizational_contributors.each do \|contributor\|	181✔
UNCOV 201	resource.organizational_contributors << Creator.organizational_contributor_from_hash(contributor)	×
202	end
203	end
204
205	def set_funders(resource, hash)	1✔
206	funders = hash["funders"] \|\| []	181✔
207
208	funders.each do \|funder\|	181✔
209	resource.funders << Funder.funder_from_hash(funder)	33✔
210	end
211	# TODO: Make funders reorderable
212	# resource.funders.sort_by!(&:sequence)
213	end
214	end
215	end
216	# rubocop:enable Metrics/ClassLength
217	end

pulibrary / pdc_describe / cace366a-ffad-45f1-9b60-678e607fa527

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous