datacite-mapping 0.4.1 → 0.6.0

data/lib/datacite/mapping/related_item.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require 'xml/mapping_extensions'
+require 'datacite/mapping/creator'
+require 'datacite/mapping/title'
+require 'datacite/mapping/contributor'
+require 'datacite/mapping/publisher'
+
+module Datacite
+  module Mapping
+
+    class NumberType < TypesafeEnum::Base
+      # @!parse ARTICLE = Article
+      new :ARTICLE, 'Article'
+
+      # @!parse CHAPTER = Chapter
+      new :CHAPTER, 'Chapter'
+
+      # @!parse REPORT = Report
+      new :REPORT, 'Report'
+
+      # @!parse OTHER = Other
+      new :OTHER, 'Other'
+    end
+
+    # @param number_type [identifierType] the type of the related identifier. Cannot be nil.
+    class Number
+      include XML::Mapping
+
+      def initialize(value:, number_type:)
+        self.value = value
+        self.number_type = number_type
+      end
+
+      root_element_name 'number'
+
+      # @!attribute [rw] number_type
+      #   @return [NumberType] the type of the related item’s number, e.g., report number or article number.
+      typesafe_enum_node :number_type, '@numberType', class: NumberType
+
+      # @!attribute [rw] value
+      #   @return [String] the identifier value. Cannot be nil.
+      text_node :value, 'text()'
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+
+    # @param identifier_type [identifierType] the type of the related identifier. Cannot be nil.
+    # @param related_metadata_scheme [String, nil] the name of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+    # @param scheme_uri [URI, nil] the URI of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+    # @param scheme_type [String, nil] the type of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+    class RelatedItemIdentifier
+      include XML::Mapping
+
+      def initialize(value:, identifier_type:, related_metadata_scheme: nil, scheme_uri: nil, scheme_type: nil)
+        self.value = value
+        self.identifier_type = identifier_type
+        self.related_metadata_scheme = related_metadata_scheme
+        self.scheme_uri = scheme_uri
+        self.scheme_type = scheme_type
+      end
+
+      def value=(value)
+        raise ArgumentError, 'Value cannot be empty or nil' unless value && !value.empty?
+
+        @value = value
+      end
+
+      def identifier_type=(value)
+        raise ArgumentError, 'Identifier type cannot be empty or nil' unless value
+
+        @identifier_type = value
+      end
+
+      root_element_name 'relatedItemIdentifier'
+
+      # @!attribute [rw] value
+      #   @return [String] the identifier value. Cannot be nil.
+      text_node :value, 'text()'
+
+      # @!attribute [rw] identifier_type
+      #   @return [RelatedIdentifierType] the type of the related identifier. Cannot be nil.
+      typesafe_enum_node :identifier_type, '@relatedItemIdentifierType', class: RelatedIdentifierType
+
+      # @!attribute [rw] related_metadata_scheme
+      #   @return [String, nil] the name of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      text_node :related_metadata_scheme, '@relatedMetadataScheme', default_value: nil
+
+      # @!attribute [rw] scheme_uri
+      #   @return [URI, nil] the URI of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      uri_node :scheme_uri, '@schemeURI', default_value: nil
+
+      # @!attribute [rw] scheme_type
+      #   @return [String, nil] the type of the metadata scheme. Used only with `HasMetadata`/`IsMetadataFor`. Optional.
+      text_node :scheme_type, '@schemeType', default_value: nil
+    end
+
+    # Information about a resource related to the one being registered.
+    class RelatedItem
+      include XML::Mapping
+
+      attr_writer :related_item_identifier, :creators, :number
+
+      # Initializes a new {RelatedItem}.
+      # @param relation_type [RelationType] the relationship of the {Resource} to the related resource. Cannot be nil.
+      # @param relation_type_information [String] additional information about the selected [RelationType], if appropriate.
+      # @param value [String] the identifier value. Cannot be nil.
+      # @param identifier_type [RelatedItemType] the type of the related identifier. Cannot be nil.
+      def initialize(relation_type:, related_item_type:, titles:, relation_type_information: nil, related_item_identifier: nil, creators: [], publication_year: nil, volume: nil, issue: nil, number: nil, first_page: nil, last_page: nil, edition: nil, publisher: nil, contributors: [])
+        self.relation_type = relation_type
+        self.related_item_type = related_item_type
+        self.relation_type_information = relation_type_information
+        self.related_item_identifier = related_item_identifier
+        self.creators = creators
+        self.titles = titles
+        self.publication_year = publication_year
+        self.volume = volume
+        self.issue = issue
+        self.number = number
+        self.first_page = first_page
+        self.last_page = last_page
+        self.publisher = publisher
+        self.edition = edition
+        self.contributors = contributors
+      end
+
+      def relation_type=(value)
+        raise ArgumentError, 'Relation type cannot be nil' unless value
+
+        @relation_type = value
+      end
+
+      def related_item_type=(value)
+        raise ArgumentError, 'Identifier type cannot be empty or nil' unless value
+
+        @related_item_type = value
+      end
+
+      def titles=(value)
+        raise ArgumentError, 'RelatedItem must have at least one title' unless value && !value.empty?
+
+        @titles = value
+      end
+
+      def publication_year=(value)
+        raise ArgumentError, 'Resource must have a four-digit publication year' if value.present? && !value&.to_i&.between?(1000, 9999)
+
+        @publication_year = value.to_i
+      end
+
+      # publisher can be entered as a string or a Publisher object, but it will be stored
+      # as a Publisher object
+      def publisher=(value)
+        @publisher = if value.is_a?(Publisher)
+                       value
+                     else
+                       Publisher.new(value: value)
+                     end
+      end
+
+      def contributors=(value)
+        @contributors = value || []
+      end
+
+      root_element_name 'relatedItem'
+
+      # @!attribute [rw] related_item_type
+      #    @return [ResourceTypeGeneral] the general resource type
+      typesafe_enum_node :related_item_type, '@relatedItemType', class: ResourceTypeGeneral, default_value: nil
+
+      # @!attribute [rw] relation_type
+      #   @return [RelationType] the relationship of the {Resource} to the related resource. Cannot be nil.
+      typesafe_enum_node :relation_type, '@relationType', class: RelationType
+
+      # @!attribute [rw] relation_type_information
+      #   @return [String, nil] Additional information about the selected relationType, if appropriate. Recommended for use with the relationType Other.
+      text_node :relation_type_information, '@rrelationTypeInformation', default_value: nil
+
+      # @!attribute [rw] related_item_identifier
+      #   @return [RelatedItemIdentifier, nil] the related item identifier
+      object_node :related_item_identifier, 'relatedItemIdentifier', class: RelatedItemIdentifier, default_value: nil
+
+      # @!attribute [rw] creators
+      #   @return [Array<Creator>] the main researchers involved working on the data, or the authors of the publication in priority order.
+      array_node :creators, 'creators', 'creator', class: Creator
+
+      # @!attribute [rw] titles
+      #   @return [Array<Title>] the names or titles by which a resource is known.
+      array_node :titles, 'titles', 'title', class: Title
+
+      # @!attribute [rw] volume
+      #   @return [String] Volume of the related item.
+      text_node :volume, 'volume', default_value: nil
+
+      # @!attribute [rw] issue
+      #   @return [String] Issue number or name of the related item.
+      text_node :issue, 'issue', default_value: nil
+
+      # @!attribute [rw] related_item_identifier
+      #   @return [RelatedItemIdentifier, nil] the related item identifier
+      object_node :number, 'number', class: Number, default_value: nil
+
+      # @!attribute [rw] firstPage
+      #   @return [String] First page of the resource within the related item, e.g., of the chapter, article, or conference paper in proceedings.
+      text_node :first_page, 'firstPage', default_value: nil
+
+      # @!attribute [rw] lastPage
+      #   @return [String] Last page of the resource within the related item, e.g., of the chapter, article, or conference paper in proceedings.
+      text_node :last_page, 'lastPage', default_value: nil
+
+      # @!attribute [rw] publisher
+      #   @return [Publisher] the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
+      object_node :publisher, 'publisher', class: Publisher
+
+      # @!attribute [rw] edition
+      #   @return [String] Edition of the related item.
+      text_node :edition, 'edition', default_value: nil
+
+      # @!attribute [rw] contributors
+      #   @return [Array<Contributor>] institutions or persons responsible for collecting, creating, or otherwise contributing to the developement of the dataset.
+      array_node :contributors, 'contributors', 'contributor', class: Contributor, default_value: []
+    end
+
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/datacite/mapping/resource.rb

@@ -13,6 +13,7 @@ require 'datacite/mapping/alternate_identifier'
 require 'datacite/mapping/rights'
 require 'datacite/mapping/geo_location'
 require 'datacite/mapping/read_only_nodes'
+require 'datacite/mapping/related_item'
 
 module Datacite
   module Mapping
@@ -76,6 +77,7 @@ module Datacite
         self.resource_type = resource_type
         self.alternate_identifiers = alternate_identifiers
         self.related_identifiers = related_identifiers
+        self.related_items = related_items
         self.sizes = sizes
         self.formats = formats
         self.version = version
@@ -129,7 +131,7 @@ module Datacite
       end
 
       def subjects=(value)
-        @subjects = (value&.select(&:value)) || []
+        @subjects = value&.select(&:value) || []
       end
 
       def contributors=(value)
@@ -152,6 +154,10 @@ module Datacite
         @related_identifiers = value || []
       end
 
+      def related_items=(value)
+        @related_items = value || []
+      end
+
       def sizes=(value)
         @sizes = value || []
       end
@@ -170,11 +176,11 @@ module Datacite
       end
 
       def descriptions=(value)
-        @descriptions = (value&.select(&:value)) || []
+        @descriptions = value&.select(&:value) || []
       end
 
       def geo_locations=(value)
-        @geo_locations = (value&.select(&:location?)) || []
+        @geo_locations = value&.select(&:location?) || []
       end
 
       # @!attribute [rw] identifier
@@ -233,6 +239,10 @@ module Datacite
       #   @return [Array<RelatedIdentifier>] identifiers of related resources.
       array_node :related_identifiers, 'relatedIdentifiers', 'relatedIdentifier', class: RelatedIdentifier, default_value: []
 
+      # @!attribute [rw] related_items
+      #   @return [Array<RelatedItems>] descriptions of related resources.
+      array_node :related_items, 'relatedItems', 'relatedItem', class: RelatedItem, default_value: []
+
       # @!attribute [rw] sizes
       #   @return [Array<String>] unstructured size information about the resource.
       array_node :sizes, 'sizes', 'size', class: String, default_value: []
@@ -305,6 +315,8 @@ module Datacite
 
       read_only_array_node :funding_references, 'fundingReferences', 'fundingReference', class: FundingReference, default_value: [], warn_reason: '<fundingReferences/> not supported in Datacite 3'
 
+      read_only_array_node :related_items, 'relatedItems', 'relatedItem', class: RelatedItem, default_value: [], warn_reason: '<relatedItems/> not supported in Datacite 3'
+
       fallback_mapping :datacite_3, :_default
     end
 

data/lib/datacite/mapping/resource_type.rb

@@ -10,30 +10,81 @@ module Datacite
       # @!parse AUDIOVISUAL = Audiovisual
       new :AUDIOVISUAL, 'Audiovisual'
 
+      # @!parse AWARD = Award
+      new :AWARD, 'Award'
+
+      # @!parse BOOK = Book
+      new :BOOK, 'Book'
+
+      # @!parse BOOK_CHAPTER = BookChapter
+      new :BOOK_CHAPTER, 'BookChapter'
+
       # @!parse COLLECTION = Collection
       new :COLLECTION, 'Collection'
 
+      # @!parse COMPUTATIONAL_NOTEBOOK = ComputationalNotebook
+      new :COMPUTATIONAL_NOTEBOOK, 'ComputationalNotebook'
+
+      # @!parse CONFERENCE_PAPER = ConferencePaper
+      new :CONFERENCE_PAPER, 'ConferencePaper'
+
+      # @!parse CONFERENCE_PROCEEDING = ConferenceProceeding
+      new :CONFERENCE_PROCEEDING, 'ConferenceProceeding'
+
       # @!parse DATASET = Dataset
       new :DATASET, 'Dataset'
 
       # @!parse DATA_PAPER = DataPaper
       new :DATA_PAPER, 'DataPaper'
 
+      # @!parse DISSERTATION = Dissertation
+      new :DISSERTATION, 'Dissertation'
+
       # @!parse EVENT = Event
       new :EVENT, 'Event'
 
       # @!parse IMAGE = Image
       new :IMAGE, 'Image'
 
+      # @!parse INSTRUMENT = Instrument
+      new :INSTRUMENT, 'Instrument'
+
+      # @!parse JOURNAL = Journal
+      new :JOURNAL, 'Journal'
+
+      # @!parse JOURNAL_ARTICLE = JournalArticle
+      new :JOURNAL_ARTICLE, 'JournalArticle'
+
       # @!parse INTERACTIVE_RESOURCE = InteractiveResource
       new :INTERACTIVE_RESOURCE, 'InteractiveResource'
 
       # @!parse MODEL = Model
       new :MODEL, 'Model'
 
+      # @!parse OUTPUT_MANAGEMENT_PLAN = OutputManagementPlan
+      new :OUTPUT_MANAGEMENT_PLAN, 'OutputManagementPlan'
+
+      # @!parse PEER_REVIEW = PeerReview
+      new :PEER_REVIEW, 'PeerReview'
+
       # @!parse PHYSICAL_OBJECT = PhysicalObject
       new :PHYSICAL_OBJECT, 'PhysicalObject'
 
+      # @!parse POSTER = Poster
+      new :POSTER, 'Poster'
+
+      # @!parse PREPRINT = Preprint
+      new :PREPRINT, 'Preprint'
+
+      # @!parse PRESENTATION = Presentation
+      new :PRESENTATION, 'Presentation'
+
+      # @!parse PROJECT = Project
+      new :PROJECT, 'Project'
+
+      # @!parse REPORT = Report
+      new :REPORT, 'Report'
+
       # @!parse SERVICE = Service
       new :SERVICE, 'Service'
 
@@ -43,6 +94,12 @@ module Datacite
       # @!parse SOUND = Sound
       new :SOUND, 'Sound'
 
+      # @!parse STANDARD = Standard
+      new :STANDARD, 'Standard'
+
+      # @!parse STUDY_REGISTRATION = StudyRegistration
+      new :STUDY_REGISTRATION, 'StudyRegistration'
+
       # @!parse TEXT = Text
       new :TEXT, 'Text'
 

data/lib/datacite/mapping/subject.rb

@@ -14,7 +14,7 @@ module Datacite
       # @param scheme_uri [URI, nil] the URI of the subject scheme or classification code or authority if one is used. Optional.
       # @param language [String, nil] an IETF BCP 47, ISO 639-1 language code identifying the language.
       # @param value [String] the subject itself.
-      def initialize(scheme: nil, scheme_uri: nil, language: nil, value:)
+      def initialize(value:, scheme: nil, scheme_uri: nil, language: nil)
         self.scheme = scheme
         self.scheme_uri = scheme_uri
         self.language = language
@@ -44,6 +44,10 @@ module Datacite
       #   @return [String, nil] an IETF BCP 47, ISO 639-1 language code identifying the language.
       text_node :language, '@xml:lang', default_value: nil
 
+      # @!attribute [rw] classification_code
+      #   @return [String, nil] the classification code used for the subject term in the subject scheme.
+      text_node :classification_code, '@classificationCode', default_value: nil
+
       # @!attribute [rw] value
       #   @return [String] the subject itself.
       text_node :value, 'text()'

data/lib/datacite/mapping/title.rb

@@ -26,7 +26,7 @@ module Datacite
       # @param language [String, nil] an IETF BCP 47, ISO 639-1 language code identifying the language.
       # @param value [String] the title itself.
       # @param type [TitleType, nil] the title type. Optional.
-      def initialize(language: nil, value:, type: nil)
+      def initialize(value:, language: nil, type: nil)
         self.language = language
         self.type = type
         self.value = value

data/spec/spec_helper.rb

@@ -12,7 +12,7 @@ if ENV['COVERAGE']
     add_filter '/spec/'
     SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
       SimpleCov::Formatter::HTMLFormatter,
-      SimpleCov::Formatter::Console,
+      SimpleCov::Formatter::Console
     ]
   end
 end

data/spec/unit/datacite/mapping/date_value_spec.rb

@@ -20,7 +20,7 @@ module Datacite
           iso8601_secs: '1914-08-04T11:01:06+01:00',
           iso8601_frac: '1914-08-04T11:01:06.0123+01:00'
         }
-        @dates = values.map { |format, v| [format, DateValue.new(v)] }.to_h
+        @dates = values.transform_values { |v| DateValue.new(v) }
       end
 
       describe '#initialize' do