datacite-mapping 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c79053989c440d5710c31da54a67e010273171e4
-  data.tar.gz: 20c42a0f8f6a37acd2993b30c7b56902e51af652
+  metadata.gz: da1834970ac385ee240fbba08999da8c893b193f
+  data.tar.gz: 39da8961ce303ecb524b558fb497d47ee47b164f
 SHA512:
-  metadata.gz: 3bc96db87aaf5b26b8ea9059633b0d50ec811678ef4a95be3940775e68955363418c2f062fc265d1ff7bc28ea9f93205186087d47a3347a0de0d0e2cebc8cb08
-  data.tar.gz: 2ee12cf0fc5d0d5b1cf93e3ec461992870a389d368830944c45bb3ee6911cabb3444305d41a48260a3c9e903297c7b8ec8ff216ee4f68703d179d077c5d6454c
+  metadata.gz: a7944af00561ea278f711f9aec4247f07fb69777e110fa4abe2f83b949e7dde2482b7acf3faa548603cd7f960b287433c8e879ddf03e001fd2a3b5e1e99196b7
+  data.tar.gz: 5232bb98d5f5447d04e007b912686e4bd9e4de547bc450b22b576bb47aa58cccf3ba6c64114fb91d22c5a695495cf11eff22bec1d169b063797aae812b8c19ce

data/CHANGES.md

@@ -1,4 +1,12 @@
-## 0.1.8 (Next)
+## 0.1.9 (19 April 2016)
+
+- Added convenience methods to directly access creator names and affiliations
+- Added convenience methods to directly access funder attributes
+
+## 0.1.8 (7 April 2016)
+
+- Add convenience method `Identifier.from_doi()` to parse DOI strings in various formats (`doi:`,
+  `http://dx.doi.org/`, etc.)
 
 ## 0.1.7 (28 March 2016)
 

data/lib/datacite/mapping/identifier.rb

@@ -2,6 +2,8 @@ require 'xml/mapping'
 
 module Datacite
   module Mapping
+    DOI_PATTERN = %r{10\..+/.+}
+
     # The persistent identifier that identifies the resource.
     #
     # @!attribute [r] identifier_type
@@ -20,7 +22,7 @@ module Datacite
       end
 
       def value=(v)
-        fail ArgumentError, "Identifier value '#{v}' is not a valid DOI" unless v.match(%r{10\..+/.+})
+        fail ArgumentError, "Identifier value '#{v}' is not a valid DOI" unless v.match(DOI_PATTERN)
         @value = v
       end
 
@@ -32,6 +34,14 @@ module Datacite
         @identifier_type = v
       end
 
+      # Converts a string DOI value to an `Identifier`.
+      # @param doi_string [String]
+      def self.from_doi(doi_string)
+        match = doi_string.match(DOI_PATTERN)
+        fail ArgumentError, "'#{doi_string}' does not appear to contain a valid DOI" unless match
+        Identifier.new(value: match[0])
+      end
+
       text_node :identifier_type, '@identifierType'
       text_node :value, 'text()'
     end

data/lib/datacite/mapping/module_info.rb

@@ -4,7 +4,7 @@ module Datacite
     NAME = 'datacite-mapping'
 
     # The version of this gem
-    VERSION = '0.1.7'
+    VERSION = '0.1.9'
 
     # The copyright notice for this gem
     COPYRIGHT = 'Copyright (c) 2016 The Regents of the University of California'

data/lib/datacite/mapping/resource.rb

@@ -175,6 +175,43 @@ module Datacite
       #   @return [Array<GeoLocations>] spatial region or named place where the data was gathered or about which the data is focused.
       array_node :geo_locations, 'geoLocations', 'geoLocation', class: GeoLocation, default_value: []
 
+      # Convenience method to get the creators' names.
+      # @return [[Array[String]] An array of the creators' names.
+      def creator_names
+        creators.map(&:name)
+      end
+
+      # Convenience method to get the creators' affiliations. (Bear in mind that each creator
+      # can have multiple affiliations.)
+      # @return [Array[Array[String]]] An array containing each creator's array of affiliations.
+      def creator_affiliations
+        creators.map(&:affiliations)
+      end
+
+      # Convenience method to get the funding contributor.
+      # @return [Contributor, nil] the contributor of type FUNDER, if any.
+      def funder_contrib
+        @funder_contrib ||= contributors.find { |c| c.type == ContributorType::FUNDER }
+      end
+
+      # Convenience method to get the name of the funding contributor.
+      # @return [String, nil] the name of the funding contributor, if any.
+      def funder_name
+        funder_contrib.name if funder_contrib
+      end
+
+      # Convenience method to get the funding contributor identifier.
+      # @return [NameIdentifier, nil] the identifier of the funding contributor, if any.
+      def funder_id
+        funder_contrib.identifier if funder_contrib
+      end
+
+      # Convenience method to get the funding contributor identifier as a string.
+      # @return [String, nil] the string value of the funding contributor's identifier, if any.
+      def funder_id_value
+        funder_id.value if funder_id
+      end
+
     end
   end
 end

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

@@ -30,6 +30,50 @@ module Datacite
         end
       end
 
+      describe '#from_doi' do
+        it 'creates an identifier from a doi: string' do
+          doi_value = '10.1594/WDCC/CCSRNIES_SRES_B2'
+          doi_string = "doi:#{doi_value}"
+          id = Identifier.from_doi(doi_string)
+          expect(id).to be_an(Identifier)
+          expect(id.value).to eq(doi_value)
+          expect(id.identifier_type).to eq('DOI')
+        end
+
+        it 'creates an identifier from a plain DOI value' do
+          doi_value = '10.1594/WDCC/CCSRNIES_SRES_B2'
+          id = Identifier.from_doi(doi_value)
+          expect(id).to be_an(Identifier)
+          expect(id.value).to eq(doi_value)
+          expect(id.identifier_type).to eq('DOI')
+        end
+
+        it 'creates an identifier from a DOI in URL format' do
+          doi_value = '10.1594/WDCC/CCSRNIES_SRES_B2'
+          doi_string = "http://dx.doi.org/#{doi_value}"
+          id = Identifier.from_doi(doi_string)
+          expect(id).to be_an(Identifier)
+          expect(id.value).to eq(doi_value)
+          expect(id.identifier_type).to eq('DOI')
+        end
+
+        it 'raises ArgumentError if it is passed a bad DOI' do
+          bad_dois = %w(
+            20.14749/1407399495
+            11.14749/1407399495
+            10./1407399495
+            10.14749\1407399495
+            10.14749/
+          )
+          bad_dois.each do |doi|
+            expect { Identifier.from_doi(doi) }.to raise_error do |e|
+              expect(e).to be_an(ArgumentError)
+              expect(e.message).to include(doi)
+            end
+          end
+        end
+      end
+
       describe '#value=' do
         it 'sets the value' do
           id = Identifier.allocate

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

@@ -770,6 +770,60 @@ module Datacite
           expect(resource.save_to_xml).to be_xml(xml_text)
         end
       end
+
+      describe 'convenience accessors' do
+
+        before :each do
+          xml_text = File.read('spec/data/resource.xml')
+          @resource = Resource.parse_xml(xml_text)
+
+          @funder = Contributor.new(
+            name: 'The Ministry of Magic',
+            identifier: NameIdentifier.new(
+              scheme: 'IATI',
+              scheme_uri: URI('http://iatistandard.org/201/codelists/OrganisationIdentifier/'),
+              value: 'GR-9¾'
+            ),
+            type: ContributorType::FUNDER)
+          @resource.contributors << @funder
+        end
+
+        describe 'creator_names' do
+          it 'extracts the creator names' do
+            expect(@resource.creator_names).to eq(['Miller, Elizabeth'])
+          end
+        end
+
+        describe 'creator_affiliations' do
+          it 'extracts the creator affiliations' do
+            expect(@resource.creator_affiliations).to eq([['DataCite']])
+          end
+        end
+
+        describe 'funder_contrib' do
+          it 'extracts the funder contrib' do
+            expect(@resource.funder_contrib).to eq(@funder)
+          end
+        end
+
+        describe 'funder_name' do
+          it 'extracts the funder name' do
+            expect(@resource.funder_name).to eq(@funder.name)
+          end
+        end
+
+        describe 'funder_id' do
+          it 'extracts the funder id' do
+            expect(@resource.funder_id).to eq(@funder.identifier)
+          end
+        end
+
+        describe 'funder_id_value' do
+          it 'extracts the funder id value' do
+            expect(@resource.funder_id_value).to eq(@funder.identifier.value)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datacite-mapping
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typesafe_enum