commonmeta-ruby 3.4.4 → 3.5

data/lib/commonmeta/readers/crossref_xml_reader.rb

@@ -101,6 +101,9 @@ module Commonmeta
         resource_type = resource_type.present? ? resource_type.underscore.camelcase : nil
         type = Commonmeta::Utils::CR_TO_CM_TRANSLATIONS.fetch(resource_type, 'Other')
 
+        contributors = crossref_people(bibmeta, 'author')
+        contributors += crossref_people(bibmeta, 'editor')
+
         titles = if bibmeta['titles'].present?
                    Array.wrap(bibmeta['titles']).map do |r|
                      if r.blank? || (r['title'].blank? && r['original_language_title'].blank?)
@@ -192,8 +195,7 @@ module Commonmeta
           'url' => url,
           'titles' => titles,
           'alternate_identifiers' => alternate_identifiers,
-          'creators' => crossref_people(bibmeta, 'author'),
-          'contributors' => crossref_people(bibmeta, 'editor'),
+          'contributors' =>  contributors,
           'funding_references' => crossref_funding_reference(program_metadata),
           'publisher' => { 'name' => publisher },
           'container' => container,
@@ -296,11 +298,11 @@ module Commonmeta
               'givenName' => given_name,
               'familyName' => family_name,
               'affiliation' => affiliation.presence,
-              'contributorType' => contributor_role == 'editor' ? 'Editor' : nil }.compact
+              'contributorRoles' => contributor_role == 'editor' ? ['Editor'] : ['Author'] }.compact
           else
             { 'type' => 'Organization',
               'name' => a['name'] || a['__content__'],
-              'contributorType' => contributor_role == 'editor' ? 'Editor' : nil }.compact
+              'contributorRoles' => contributor_role == 'editor' ? ['Editor'] : ['Author'] }.compact
           end
         end
       end
@@ -359,7 +361,7 @@ module Commonmeta
           {
             'key' => reference.dig('key'),
             'doi' => doi ? normalize_doi(doi) : nil,
-            'creator' => reference.dig('author'),
+            'contributor' => reference.dig('author'),
             'title' => reference.dig('article_title'),
             'publisher' => reference.dig('publisher'),
             'publicationYear' => reference.dig('cYear'),
@@ -369,7 +371,6 @@ module Commonmeta
             'lastPage' => reference.dig('last_page'),
             'containerTitle' => reference.dig('journal_title'),
             'edition' => nil,
-            'contributor' => nil,
             'unstructured' => doi.nil? ? reference.dig('unstructured') : nil
           }.compact
         end.unwrap

data/lib/commonmeta/readers/csl_reader.rb

@@ -17,12 +17,12 @@ module Commonmeta
         citeproc_type = meta.fetch('type', nil)
         type = Commonmeta::Utils::CSL_TO_CM_TRANSLATIONS.fetch(citeproc_type, 'Other')
 
-        creators = if meta.fetch('author', nil).present?
+        contributors = if meta.fetch('author', nil).present?
                      get_authors(from_csl(Array.wrap(meta.fetch('author', nil))))
                    else
-                     [{ 'type' => 'Organization', 'name' => ':(unav)' }]
+                     [{ 'type' => 'Organization', 'name' => ':(unav)', 'contributorRoles' => ['Author'] }]
                    end
-        contributors = get_authors(from_csl(Array.wrap(meta.fetch('editor', nil))))
+        contributors += get_authors(from_csl(Array.wrap(meta.fetch('editor', nil))))
 
         date = {}
         d = get_date_from_date_parts(meta.fetch('issued', nil))
@@ -62,7 +62,6 @@ module Commonmeta
           'type' => type,
           'url' => normalize_id(meta.fetch('URL', nil)),
           'titles' => [{ 'title' => meta.fetch('title', nil) }],
-          'creators' => creators,
           'contributors' => contributors,
           'container' => container,
           'publisher' => if meta.fetch('publisher', nil)

data/lib/commonmeta/readers/datacite_reader.rb

@@ -53,10 +53,10 @@ module Commonmeta
         titles = Array.wrap(meta.fetch('titles', nil)).map do |title|
           title.compact
         end
-        creators = get_authors(from_datacite(meta.fetch('creators', nil)))
+        contributors = get_authors(from_datacite(meta.fetch('creators', nil)))
+        contributors += get_authors(from_datacite(meta.fetch('contributors', nil)))
         publisher = { 'name' => meta.fetch('publisher', nil) }
 
-        contributors = get_authors(from_datacite(meta.fetch('contributors', nil)))
         container = meta.fetch('container', nil)
         funding_references = meta.fetch('funding_references', nil)
 
@@ -98,7 +98,6 @@ module Commonmeta
           'additional_type' => resource_type == type ? nil : resource_type,
           'url' => url,
           'titles' => titles,
-          'creators' => creators,
           'contributors' => contributors,
           'container' => container,
           'publisher' => publisher,
@@ -150,7 +149,7 @@ module Commonmeta
           'key' => key,
           'doi' => doi,
           'url' => url,
-          'creator' => reference.dig('author'),
+          'contributor' => reference.dig('author'),
           'title' => reference.dig('article-title'),
           'publisher' => reference.dig('publisher'),
           'publicationYear' => reference.dig('year'),
@@ -160,7 +159,6 @@ module Commonmeta
           'lastPage' => reference.dig('last-page'),
           'containerTitle' => reference.dig('journal-title'),
           'edition' => nil,
-          'contributor' => nil,
           'unstructured' => doi.nil? ? reference.dig('unstructured') : nil
         }.compact
       end

data/lib/commonmeta/readers/json_feed_reader.rb

@@ -25,7 +25,7 @@ module Commonmeta
         id = url if id.blank? && url.present?
 
         type = "Article"
-        creators = if meta.fetch("authors", nil).present?
+        contributors = if meta.fetch("authors", nil).present?
             get_authors(from_json_feed(Array.wrap(meta.fetch("authors"))))
           else
             [{ "type" => "Organization", "name" => ":(unav)" }]
@@ -70,7 +70,7 @@ module Commonmeta
           "type" => type,
           "url" => url,
           "titles" => titles,
-          "creators" => creators,
+          "contributors" => contributors,
           "publisher" => publisher,
           "container" => container,
           "date" => date,
@@ -109,7 +109,7 @@ module Commonmeta
 
       def get_related_identifiers(meta)
         # check that relationships resolve and has a supported type
-        supported_types = %w[IsIdenticalTo isPreprintOf isTranslationOf]
+        supported_types = %w[IsIdenticalTo IsPreprintOf IsTranslationOf]
         Array.wrap(meta["relationships"]).reduce([]) do |sum, relationship|
           begin
             if supported_types.include?(relationship["type"]) && [200, 301, 302].include?(HTTP.head(relationship["url"]).status)

data/lib/commonmeta/readers/npm_reader.rb

@@ -26,7 +26,7 @@ module Commonmeta
 
         type = 'Software'
 
-        creators = get_authors(Array.wrap(meta.fetch('author', nil)))
+        contributors = get_authors(Array.wrap(meta.fetch('author', nil)))
         license = hsh_to_spdx('rightsIdentifier' => meta.fetch('license', nil))
 
         # container = if meta.fetch("container-title", nil).present?
@@ -71,7 +71,7 @@ module Commonmeta
           # "doi" => doi_from_url(doi),
           # "url" => normalize_id(meta.fetch("URL", nil)),
           'titles' => [{ 'title' => meta.fetch('name', nil) }],
-          'creators' => creators,
+          'contributors' => contributors,
           # "contributors" => contributors,
           # "container" => container,
           # "publisher" => meta.fetch("publisher", nil),

data/lib/commonmeta/readers/ris_reader.rb

@@ -41,7 +41,7 @@ module Commonmeta
           'type' => type,
           'url' => meta.fetch('UR', nil),
           'titles' => meta.fetch('T1', nil).present? ? [{ 'title' => meta.fetch('T1', nil) }] : nil,
-          'creators' => get_authors(author),
+          'contributors' => get_authors(author),
           'publisher' => { 'name' => meta.fetch('PB', '(:unav)') },
           'container' => container,
           'date' => date,

data/lib/commonmeta/readers/schema_org_reader.rb

@@ -106,8 +106,9 @@ module Commonmeta
         additional_type = meta.fetch('additionalType', nil)
         authors = meta.fetch('author', nil) || meta.fetch('creator', nil)
         # Authors should be an object, if it's just a plain string don't try and parse it.
-        creators = get_authors(from_schema_org(Array.wrap(authors))) unless authors.is_a?(String)
-        contributors = get_authors(from_schema_org(Array.wrap(meta.fetch('editor', nil))))
+        contributors = get_authors(from_schema_org(Array.wrap(authors))) unless authors.is_a?(String)
+        contributors = [] if contributors.nil?
+        contributors += get_authors(from_schema_org(Array.wrap(meta.fetch('editor', nil))))
         publisher = parse_attributes(meta.fetch('publisher', nil), content: 'name', first: true)
 
         ct = schema_org == 'Dataset' ? 'includedInDataCatalog' : 'Periodical'
@@ -230,7 +231,6 @@ module Commonmeta
                       else
                         [{ 'title' => meta.fetch('headline', nil) }]
                       end,
-          'creators' => creators,
           'contributors' => contributors,
           'publisher' => { 'name' => publisher },
           'provider' => parse_attributes(meta.fetch('provider', nil), content: 'name', first: true),

data/lib/commonmeta/schema_utils.rb

@@ -5,7 +5,7 @@ require "pathname"
 
 module Commonmeta
   module SchemaUtils
-    COMMONMETA = File.read(File.expand_path("../../resources/commonmeta_v0.9.3.json",
+    COMMONMETA = File.read(File.expand_path("../../resources/commonmeta_v0.10.json",
                                             __dir__))
 
     def json_schema_errors

data/lib/commonmeta/utils.rb

@@ -869,7 +869,7 @@ module Commonmeta
     end
 
     def map_hash_keys(element: nil, mapping: nil)
-      Array.wrap(element).map do |a|
+      a = Array.wrap(element).map do |a|
         a.map { |k, v| [mapping.fetch(k, k), v] }.reduce({}) do |hsh, (k, v)|
           if k == "affiliation" && v.is_a?(Array)
             hsh[k] = v.map do |affiliation|
@@ -883,6 +883,8 @@ module Commonmeta
           elsif k == "type" && v.is_a?(String)
             hsh[k] = v.capitalize
             hsh
+          elsif k == "contributorRoles"
+            hsh
           elsif v.is_a?(Hash)
             hsh[k] = to_schema_org(v)
             hsh
@@ -930,7 +932,7 @@ module Commonmeta
         a["given"] = a["givenName"]
         a["literal"] = a["name"] unless a["familyName"].present?
         a.except("nameType", "type", "@type", "id", "@id", "name", "familyName", "givenName",
-                 "affiliation", "contributorType").compact
+                 "affiliation", "contributorRoles").compact
       end.presence
     end
 

data/lib/commonmeta/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commonmeta
-  VERSION = '3.4.4'
+  VERSION = '3.5'
 end

data/lib/commonmeta/writers/bibtex_writer.rb

@@ -13,7 +13,7 @@ module Commonmeta
           bibtex_key: normalize_id(id),
           doi: doi_from_url(id),
           url: url,
-          author: authors_as_string(creators),
+          author: authors_as_string(contributors),
           keywords: if subjects.present?
                       Array.wrap(subjects).map do |k|
                         parse_attributes(k, content: 'subject', first: true)

data/lib/commonmeta/writers/cff_writer.rb

@@ -10,14 +10,15 @@ module Commonmeta
         return nil unless %w[Software Collection].include?(type)
 
         title = parse_attributes(titles, content: 'title', first: true)
-
+        authors = Array.wrap(contributors).select { |c| c['contributorRoles'] == ['Author'] }
+      
         hsh = {
           'cff-version' => '1.2.0',
           'message' => "If you use #{title} in your research, please cite it using the following metadata",
           'doi' => normalize_doi(id),
           'repository-code' => url,
           'title' => title,
-          'authors' => write_cff_creators(creators),
+          'authors' => write_cff_contributors(authors),
           'abstract' => parse_attributes(descriptions, content: 'description', first: true),
           'version' => version,
           'keywords' => if subjects.present?
@@ -34,8 +35,8 @@ module Commonmeta
         hsh.to_yaml
       end
 
-      def write_cff_creators(creators)
-        Array.wrap(creators).map do |a|
+      def write_cff_contributors(contributors)
+        Array.wrap(contributors).map do |a|
           if a['givenName'].present? || a['id'].present?
             { 'given-names' => a['givenName'],
               'family-names' => a['familyName'],

data/lib/commonmeta/writers/codemeta_writer.rb

@@ -5,7 +5,9 @@ module Commonmeta
     module CodemetaWriter
       def codemeta
         return nil unless valid? || show_errors
-
+        
+        authors = Array.wrap(contributors).select { |c| c['contributorRoles'] == ['Author'] }
+        
         hsh = {
           '@context' => id.present? ? 'https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld' : nil,
           '@type' => Commonmeta::Utils::CM_TO_SO_TRANSLATIONS.fetch(type, 'SoftwareSourceCode'),
@@ -13,7 +15,7 @@ module Commonmeta
           'identifier' => to_schema_org_identifiers(alternate_identifiers),
           'codeRepository' => url,
           'name' => parse_attributes(titles, content: 'title', first: true),
-          'authors' => creators,
+          'authors' => to_schema_org(authors),
           'description' => parse_attributes(descriptions, content: 'description', first: true),
           'version' => version,
           'tags' => if subjects.present?

data/lib/commonmeta/writers/csv_writer.rb

@@ -7,7 +7,9 @@ module Commonmeta
 
       def csv
         return nil unless valid?
-
+        
+        authors = contributors.select { |c| c['contributorRoles'] == ['Author'] }
+ 
         bib = {
           doi: doi_from_url(id),
           url: url,
@@ -15,7 +17,7 @@ module Commonmeta
           state: state,
           type: Commonmeta::Utils::CM_TO_BIB_TRANSLATIONS.fetch(type, 'misc'),
           title: parse_attributes(titles, content: 'title', first: true),
-          author: authors_as_string(creators),
+          author: authors_as_string(authors),
           publisher: publisher['name']
         }.values
 

data/lib/commonmeta/writers/datacite_writer.rb

@@ -22,7 +22,7 @@ module Commonmeta
           'doi' => doi_from_url(id),
           'url' => url,
           'types' => types,
-          'creators' => Array.wrap(creators).map { |c| datacite_contributor(c) },
+          'creators' => Array.wrap(contributors).map { |c| datacite_contributor(c) },
           'titles' => titles,
           'publisher' => publisher.to_h['name'],
           'container' => container,

data/lib/commonmeta/writers/jats_writer.rb

@@ -39,10 +39,12 @@ module Commonmeta
       end
 
       def insert_authors(xml)
-        return unless creators.present?
-
+        authors = contributors.select { |c| c['contributorRoles'] == ['Author'] }
+ 
+        return unless authors.present?
+        
         xml.send(:'person-group', 'person-group-type' => 'author') do
-          Array.wrap(creators).each do |au|
+          Array.wrap(authors).each do |au|
             xml.name do
               insert_contributor(xml, au)
             end
@@ -51,10 +53,12 @@ module Commonmeta
       end
 
       def insert_editors(xml)
-        return unless contributors.present?
+        editors = contributors.select { |c| c['contributorRoles'] == ['Editor'] }
+ 
+        return unless editors.present?
 
         xml.send(:'person-group', 'person-group-type' => 'editor') do
-          Array.wrap(contributors).each do |con|
+          Array.wrap(editors).each do |con|
             xml.name do
               insert_contributor(xml, con)
             end

data/lib/commonmeta/writers/ris_writer.rb

@@ -4,13 +4,14 @@ module Commonmeta
   module Writers
     module RisWriter
       def ris
+        authors = contributors.select { |c| c['contributorRoles'] == ['Author'] }
         sn = container.to_h['identifier']
         sn = sn.downcase if sn.present? && container.to_h['identifierType'] == 'DOI'
         {
           'TY' => Commonmeta::Utils::CM_TO_RIS_TRANSLATIONS.fetch(type, 'GEN'),
           'T1' => parse_attributes(titles, content: 'title', first: true),
           'T2' => container.to_h['title'],
-          'AU' => to_ris(creators),
+          'AU' => to_ris(authors),
           'DO' => doi_from_url(id),
           'UR' => url,
           'AB' => parse_attributes(descriptions, content: 'description', first: true),

data/lib/commonmeta/writers/schema_org_writer.rb

@@ -2,8 +2,11 @@
 
 module Commonmeta
   module Writers
-    module SchemaOrgWriter
+    module SchemaOrgWriter 
       def schema_hsh
+        authors = contributors.select { |c| c['contributorRoles'] == ['Author'] }
+        editors = contributors.select { |c| c['contributorRoles'] == ['Editor'] }
+
         { '@context' => 'http://schema.org',
           '@type' => Commonmeta::Utils::CM_TO_SO_TRANSLATIONS.fetch(type, 'CreativeWork'),
           '@id' => id,
@@ -11,8 +14,8 @@ module Commonmeta
           'url' => url,
           'additionalType' => additional_type,
           'name' => parse_attributes(titles, content: 'title', first: true),
-          'author' => to_schema_org(creators),
-          'editor' => to_schema_org(contributors),
+          'author' => to_schema_org(authors),
+          'editor' => to_schema_org(editors),
           'description' => parse_attributes(descriptions, content: 'description', first: true),
           'license' => license.to_h['url'],
           'version' => version,

data/resources/{commonmeta_v0.9.3.json → commonmeta_v0.10.json}

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://commonmeta.org/commonmeta_v0.9.3.json",
-  "title": "Commonmeta v0.9.3",
+  "$id": "https://commonmeta.org/commonmeta_v0.10.json",
+  "title": "Commonmeta v0.10",
   "description": "JSON representation of the Commonmeta schema.",
   "additionalProperties": false,
   "definitions": {
@@ -24,6 +24,38 @@
       },
       "uniqueItems": true
     },
+    "contributorRole": {
+      "description": "The type of contribution made by a contributor",
+      "enum": [
+        "Author",
+        "Editor",
+        "Chair",
+        "Reviewer",
+        "ReviewAssistant",
+        "StatsReviewer",
+        "ReviewerExternal",
+        "Reader",
+        "Translator",
+        "ContactPerson",
+        "Maintainer",
+        "Conceptualization",
+        "DataCuration",
+        "FormalAnalysis",
+        "FundingAcquisition",
+        "Investigation",
+        "Methodology",
+        "ProjectAdministration",
+        "Resources",
+        "Software",
+        "Supervision",
+        "Validation",
+        "Visualization",
+        "WritingOriginalDraft",
+        "WritingReviewEditing",
+        "Other"
+      ],
+      "type": "string"
+    },
     "latitude": {
       "type": "number",
       "minimum": -90,
@@ -91,36 +123,52 @@
       "type": "string",
       "format": "uri"
     },
-    "creators": {
-      "description": "The creators of the resource.",
+    "contributors": {
+      "description": "The contributors to the resource.",
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
           "id": {
-            "description": "The unique identifier for the creator.",
-            "type": "string",
-            "format": "uri"
+            "description": "The unique identifier for the contributor.",
+            "type": "string"
           },
           "type": {
-            "description": "The type of the creator.",
+            "description": "The type of the contributor.",
             "type": "string",
             "enum": ["Organization", "Person"]
           },
+          "contributorRoles": {
+            "description": "List of roles assumed by the contributor when working on the resource.",
+            "items": {
+              "$ref": "#/definitions/contributorRole"
+            },
+            "type": "array",
+            "uniqueItems": true
+          },
           "name": {
-            "description": "The name of the creator.",
+            "description": "The name of the contributor.",
             "type": "string"
           },
           "givenName": {
-            "description": "The given name of the creator.",
+            "description": "The given name of the contributor.",
             "type": "string"
           },
           "familyName": {
-            "description": "The family name of the creator.",
+            "description": "The family name of the contributor.",
             "type": "string"
           },
           "affiliation": { "$ref": "#/definitions/affiliations" }
-        }
+        },
+        "anyOf": [
+          {
+            "required": ["familyName"]
+          },
+          {
+            "required": ["name"]
+          }
+        ],
+        "required": ["type", "contributorRoles"]
       },
       "minItems": 1,
       "uniqueItems": true
@@ -190,37 +238,6 @@
         }
       }
     },
-    "contributors": {
-      "description": "The contributors to the resource.",
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "description": "The unique identifier for the contributor.",
-            "type": "string"
-          },
-          "type": {
-            "description": "The type of the contributor.",
-            "type": "string",
-            "enum": ["Organization", "Person"]
-          },
-          "name": {
-            "description": "The name of the contributor.",
-            "type": "string"
-          },
-          "givenName": {
-            "description": "The given name of the contributor.",
-            "type": "string"
-          },
-          "familyName": {
-            "description": "The family name of the contributor.",
-            "type": "string"
-          },
-          "affiliation": { "$ref": "#/definitions/affiliations" }
-        }
-      }
-    },
     "subjects": {
       "type": "array",
       "items": {
@@ -271,7 +288,7 @@
         "properties": {
           "key": { "type": "string" },
           "doi": { "type": "string" },
-          "creator": { "type": "string" },
+          "contributor": { "type": "string" },
           "title": { "type": "string" },
           "publisher": { "type": "string" },
           "publicationYear": { "type": "string" },
@@ -281,7 +298,6 @@
           "lastPage": { "type": "string" },
           "containerTitle": { "type": "string" },
           "edition": { "type": "string" },
-          "contributor": { "type": "string" },
           "unstructured": { "type": "string" }
         },
         "required": ["key"]
@@ -443,5 +459,5 @@
       "enum": ["findable", "not_found"]
     }
   },
-  "required": ["id", "type", "url", "creators", "titles", "publisher", "date"]
+  "required": ["id", "type", "url", "contributors", "titles", "publisher", "date"]
 }