briard 2.4.1 → 2.6.0

data/lib/briard/writers/cff_writer.rb

@@ -7,48 +7,55 @@ module Briard
         return nil unless valid? || show_errors
 
         # only use CFF for software
-        return nil unless %w(Software Collection).include?(types["resourceTypeGeneral"])
+        return nil unless %w[Software Collection].include?(types['resourceTypeGeneral'])
+
+        title = parse_attributes(titles, content: 'title', first: true)
 
-        title = parse_attributes(titles, content: "title", first: true)
-        
         hsh = {
-          "cff-version" => "1.2.0",
-          "message" => "If you use #{title} in your work, please cite it using the following metadata",
-          "doi" => normalize_doi(doi),
-          "repository-code" => url,
-          "title" => parse_attributes(titles, content: "title", first: true),
-          "authors" => write_cff_creators(creators),
-          "abstract" => parse_attributes(descriptions, content: "description", first: true),
-          "version" => version_info,
-          "keywords" => subjects.present? ? Array.wrap(subjects).map { |k| parse_attributes(k, content: "subject", first: true) } : nil,
-          "date-released" => get_date(dates, "Issued") || publication_year,
-          "license" => Array.wrap(rights_list).map { |l| l["rightsIdentifier"] }.compact.unwrap,
-          "references" => write_references(related_identifiers)
+          'cff-version' => '1.2.0',
+          'message' => "If you use #{title} in your work, please cite it using the following metadata",
+          'doi' => normalize_doi(doi),
+          'repository-code' => url,
+          'title' => parse_attributes(titles, content: 'title', first: true),
+          'authors' => write_cff_creators(creators),
+          'abstract' => parse_attributes(descriptions, content: 'description', first: true),
+          'version' => version_info,
+          'keywords' => if subjects.present?
+                          Array.wrap(subjects).map do |k|
+                            parse_attributes(k, content: 'subject', first: true)
+                          end
+                        end,
+          'date-released' => get_date(dates, 'Issued') || publication_year,
+          'license' => Array.wrap(rights_list).map { |l| l['rightsIdentifier'] }.compact.unwrap,
+          'references' => write_references(related_identifiers)
         }.compact
         hsh.to_yaml
       end
 
       def write_cff_creators(creators)
         Array.wrap(creators).map do |a|
-          if a["givenName"].present? || a["nameIdentifiers"].present?
-            { "given-names" => a["givenName"],
-              "family-names" => a["familyName"],
-              "orcid" => parse_attributes(a["nameIdentifiers"], content: "nameIdentifier", first: true),
-              "affiliation" => parse_attributes(a["affiliation"], content: "name", first: true) }.compact
+          if a['givenName'].present? || a['nameIdentifiers'].present?
+            { 'given-names' => a['givenName'],
+              'family-names' => a['familyName'],
+              'orcid' => parse_attributes(a['nameIdentifiers'], content: 'nameIdentifier',
+                                                                first: true),
+              'affiliation' => parse_attributes(a['affiliation'], content: 'name',
+                                                                  first: true) }.compact
           else
-            { "name" => a["name"] }
+            { 'name' => a['name'] }
           end
         end
       end
 
       def write_references(related_identifiers)
         return nil if related_identifiers.blank?
-        
-        { "identifiers" => 
+
+        { 'identifiers' =>
         Array.wrap(related_identifiers).map do |r|
-          { 
-            "type" => r["relatedIdentifierType"].downcase,
-            "value" => r["relatedIdentifierType"] == "DOI" ? doi_from_url(r["relatedIdentifier"]) : r["relatedIdentifier"] }
+          {
+            'type' => r['relatedIdentifierType'].downcase,
+            'value' => r['relatedIdentifierType'] == 'DOI' ? doi_from_url(r['relatedIdentifier']) : r['relatedIdentifier']
+          }
         end }
       end
     end

data/lib/briard/writers/codemeta_writer.rb

@@ -5,22 +5,26 @@ module Briard
     module CodemetaWriter
       def codemeta
         return nil unless valid? || show_errors
-        
+
         hsh = {
-          "@context" => id.present? ? "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld" : nil,
-          "@type" => types.present? ? types["schemaOrg"] : nil,
-          "@id" => normalize_doi(doi),
-          "identifier" => to_schema_org_identifiers(identifiers),
-          "codeRepository" => url,
-          "name" => parse_attributes(titles, content: "title", first: true),
-          "authors" => creators,
-          "description" => parse_attributes(descriptions, content: "description", first: true),
-          "version" => version_info,
-          "tags" => subjects.present? ? Array.wrap(subjects).map { |k| parse_attributes(k, content: "subject", first: true) } : nil,
-          "datePublished" => get_date(dates, "Issued") || publication_year,
-          "dateModified" => get_date(dates, "Updated"),
-          "publisher" => publisher,
-          "license" => Array.wrap(rights_list).map { |l| l["rightsUri"] }.compact.unwrap,
+          '@context' => id.present? ? 'https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld' : nil,
+          '@type' => types.present? ? types['schemaOrg'] : nil,
+          '@id' => normalize_doi(doi),
+          'identifier' => to_schema_org_identifiers(identifiers),
+          'codeRepository' => url,
+          'name' => parse_attributes(titles, content: 'title', first: true),
+          'authors' => creators,
+          'description' => parse_attributes(descriptions, content: 'description', first: true),
+          'version' => version_info,
+          'tags' => if subjects.present?
+                      Array.wrap(subjects).map do |k|
+                        parse_attributes(k, content: 'subject', first: true)
+                      end
+                    end,
+          'datePublished' => get_date(dates, 'Issued') || publication_year,
+          'dateModified' => get_date(dates, 'Updated'),
+          'publisher' => publisher,
+          'license' => Array.wrap(rights_list).map { |l| l['rightsUri'] }.compact.unwrap
         }.compact
         JSON.pretty_generate hsh.presence
       end

data/lib/briard/writers/csv_writer.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Briard
   module Writers
     module CsvWriter
-      require "csv"
+      require 'csv'
 
       def csv
         return nil unless valid?
@@ -11,9 +13,9 @@ module Briard
           url: url,
           registered: get_iso8601_date(date_registered),
           state: state,
-          resource_type_general: types["resourceTypeGeneral"],
-          resource_type: types["resourceType"],
-          title: parse_attributes(titles, content: "title", first: true),
+          resource_type_general: types['resourceTypeGeneral'],
+          resource_type: types['resourceType'],
+          title: parse_attributes(titles, content: 'title', first: true),
           author: authors_as_string(creators),
           publisher: publisher,
           publication_year: publication_year

data/lib/briard/writers/datacite_json_writer.rb

@@ -1,10 +1,16 @@
+# frozen_string_literal: true
+
 module Briard
   # frozen_string_literal: true
-  
+
   module Writers
     module DataciteJsonWriter
       def datacite_json
-        JSON.pretty_generate crosscite_hsh.transform_keys! { |key| key.camelcase(uppercase_first_letter = :lower) } if crosscite_hsh.present?
+        if crosscite_hsh.present?
+          JSON.pretty_generate crosscite_hsh.transform_keys! { |key|
+                                 key.camelcase(uppercase_first_letter = :lower)
+                               }
+        end
       end
     end
   end

data/lib/briard/writers/jats_writer.rb

@@ -4,8 +4,8 @@ module Briard
   module Writers
     module JatsWriter
       def jats
-        @jats ||= Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
-          xml.send("element-citation", publication_type) do
+        @jats ||= Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml.send(:'element-citation', publication_type) do
             insert_citation(xml)
           end
         end.to_xml
@@ -18,29 +18,29 @@ module Briard
         insert_source(xml)
         insert_publisher_name(xml) if publisher.present? && !is_data?
         insert_publication_date(xml)
-        insert_volume(xml) if container.to_h["volume"].present?
-        insert_issue(xml) if container.to_h["issue"].present?
-        insert_fpage(xml) if container.to_h["firstPage"].present?
-        insert_lpage(xml) if container.to_h["lastPage"].present?
+        insert_volume(xml) if container.to_h['volume'].present?
+        insert_issue(xml) if container.to_h['issue'].present?
+        insert_fpage(xml) if container.to_h['firstPage'].present?
+        insert_lpage(xml) if container.to_h['lastPage'].present?
         insert_version(xml) if version_info.present?
         insert_pub_id(xml)
       end
 
       def is_article?
-        publication_type.fetch('publication-type', nil) == "journal"
+        publication_type.fetch('publication-type', nil) == 'journal'
       end
 
       def is_data?
-        publication_type.fetch('publication-type', nil) == "data"
+        publication_type.fetch('publication-type', nil) == 'data'
       end
 
       def is_chapter?
-        publication_type.fetch('publication-type', nil) == "chapter"
+        publication_type.fetch('publication-type', nil) == 'chapter'
       end
 
       def insert_authors(xml)
         if creators.present?
-          xml.send("person-group", "person-group-type" => "author") do
+          xml.send(:'person-group', 'person-group-type' => 'author') do
             Array.wrap(creators).each do |au|
               xml.name do
                 insert_contributor(xml, au)
@@ -52,7 +52,7 @@ module Briard
 
       def insert_editors(xml)
         if contributors.present?
-          xml.send("person-group", "person-group-type" => "editor") do
+          xml.send(:'person-group', 'person-group-type' => 'editor') do
             Array.wrap(contributors).each do |con|
               xml.name do
                 insert_contributor(xml, con)
@@ -63,15 +63,18 @@ module Briard
       end
 
       def insert_contributor(xml, person)
-        xml.surname(person["familyName"]) if person["familyName"].present?
-        xml.send("given-names", person["givenName"]) if person["givenName"].present?
+        xml.surname(person['familyName']) if person['familyName'].present?
+        xml.send(:'given-names', person['givenName']) if person['givenName'].present?
       end
 
       def insert_citation_title(xml)
         case publication_type.fetch('publication-type', nil)
-        when "data" then xml.send("data-title", parse_attributes(titles, content: "title", first: true))
-        when "journal" then xml.send("article-title", parse_attributes(titles, content: "title", first: true))
-        when "chapter" then xml.send("chapter-title", parse_attributes(titles, content: "title", first: true))
+        when 'data' then xml.send(:'data-title',
+                                  parse_attributes(titles, content: 'title', first: true))
+        when 'journal' then xml.send(:'article-title',
+                                     parse_attributes(titles, content: 'title', first: true))
+        when 'chapter' then xml.send(:'chapter-title',
+                                     parse_attributes(titles, content: 'title', first: true))
         end
       end
 
@@ -79,38 +82,39 @@ module Briard
         if is_chapter?
           xml.source(publisher)
         elsif is_article? || is_data?
-          xml.source(container && container["title"] || publisher)
+          xml.source((container && container['title']) || publisher)
         else
-          xml.source(parse_attributes(titles, content: "title", first: true))
+          xml.source(parse_attributes(titles, content: 'title', first: true))
         end
       end
 
       def insert_publisher_name(xml)
-        xml.send("publisher-name", publisher)
+        xml.send(:'publisher-name', publisher)
       end
 
       def insert_publication_date(xml)
-        year, month, day = get_date_parts(get_date(dates, "Issued")).to_h.fetch("date-parts", []).first
+        year, month, day = get_date_parts(get_date(dates, 'Issued')).to_h.fetch('date-parts',
+                                                                                []).first
 
-        xml.year(year, "iso-8601-date" => get_date(dates, "Issued"))
+        xml.year(year, 'iso-8601-date' => get_date(dates, 'Issued'))
         xml.month(month.to_s.rjust(2, '0')) if month.present?
         xml.day(day.to_s.rjust(2, '0')) if day.present?
       end
 
       def insert_volume(xml)
-        xml.volume(container["volume"])
+        xml.volume(container['volume'])
       end
 
       def insert_issue(xml)
-        xml.issue(container["issue"])
+        xml.issue(container['issue'])
       end
 
       def insert_fpage(xml)
-        xml.fpage(container["firstPage"])
+        xml.fpage(container['firstPage'])
       end
 
       def insert_lpage(xml)
-        xml.lpage(container["lastPage"])
+        xml.lpage(container['lastPage'])
       end
 
       def insert_version(xml)
@@ -119,15 +123,16 @@ module Briard
 
       def insert_pub_id(xml)
         return nil unless doi.present?
-        xml.send("pub-id", doi, "pub-id-type" => "doi")
+
+        xml.send(:'pub-id', doi, 'pub-id-type' => 'doi')
       end
 
       def date
-        get_date(dates, "Issued") ? get_date_parts(get_date(dates, "Issued")) : get_date_parts(publication_year)
+        get_date_parts(get_date(dates, 'Issued') || publication_year)
       end
 
       def publication_type
-        { 'publication-type' => Briard::Utils::CR_TO_JATS_TRANSLATIONS[types["resourceType"]] || Briard::Utils::SO_TO_JATS_TRANSLATIONS[types["schemaOrg"]] }.compact
+        { 'publication-type' => Briard::Utils::CR_TO_JATS_TRANSLATIONS[types['resourceType']] || Briard::Utils::SO_TO_JATS_TRANSLATIONS[types['schemaOrg']] }.compact
       end
     end
   end

data/lib/briard/writers/rdf_xml_writer.rb

@@ -4,7 +4,7 @@ module Briard
   module Writers
     module RdfXmlWriter
       def rdf_xml
-        graph.dump(:rdfxml, prefixes: { schema: "http://schema.org/" })
+        graph.dump(:rdfxml, prefixes: { schema: 'http://schema.org/' })
       end
     end
   end

data/lib/briard/writers/ris_writer.rb

@@ -5,24 +5,36 @@ module Briard
     module RisWriter
       def ris
         {
-          "TY" => types["ris"],
-          "T1" => parse_attributes(titles, content: "title", first: true),
-          "T2" => container && container["title"],
-          "AU" => to_ris(creators),
-          "DO" => doi,
-          "UR" => url,
-          "AB" => parse_attributes(descriptions, content: "description", first: true),
-          "KW" => Array.wrap(subjects).map { |k| parse_attributes(k, content: "subject", first: true) }.presence,
-          "PY" => publication_year,
-          "PB" => publisher,
-          "LA" => language,
-          "VL" => container.to_h["volume"],
-          "IS" => container.to_h["issue"],
-          "SP" => container.to_h["firstPage"],
-          "EP" => container.to_h["lastPage"],
-          "SN" => Array.wrap(related_identifiers).find { |ri| ri["relationType"] == "IsPartOf" }.to_h.fetch("relatedIdentifier", nil),
-          "ER" => ""
-        }.compact.map { |k, v| v.is_a?(Array) ? v.map { |vi| "#{k}  - #{vi}" }.join("\r\n") : "#{k}  - #{v}" }.join("\r\n")
+          'TY' => types['ris'],
+          'T1' => parse_attributes(titles, content: 'title', first: true),
+          'T2' => container && container['title'],
+          'AU' => to_ris(creators),
+          'DO' => doi,
+          'UR' => url,
+          'AB' => parse_attributes(descriptions, content: 'description', first: true),
+          'KW' => Array.wrap(subjects).map do |k|
+                    parse_attributes(k, content: 'subject', first: true)
+                  end.presence,
+          'PY' => publication_year,
+          'PB' => publisher,
+          'LA' => language,
+          'VL' => container.to_h['volume'],
+          'IS' => container.to_h['issue'],
+          'SP' => container.to_h['firstPage'],
+          'EP' => container.to_h['lastPage'],
+          'SN' => Array.wrap(related_identifiers).find do |ri|
+                    ri['relationType'] == 'IsPartOf'
+                  end.to_h.fetch('relatedIdentifier', nil),
+          'ER' => ''
+        }.compact.map do |k, v|
+          if v.is_a?(Array)
+            v.map do |vi|
+              "#{k}  - #{vi}"
+            end.join("\r\n")
+          else
+            "#{k}  - #{v}"
+          end
+        end.join("\r\n")
       end
     end
   end

data/lib/briard/writers/turtle_writer.rb

@@ -4,7 +4,7 @@ module Briard
   module Writers
     module TurtleWriter
       def turtle
-        graph.dump(:ttl, prefixes: { schema: "http://schema.org/" })
+        graph.dump(:ttl, prefixes: { schema: 'http://schema.org/' })
       end
     end
   end

data/lib/briard.rb

@@ -22,11 +22,11 @@ require 'csl/styles'
 require 'edtf'
 require 'base32/url'
 
-require "briard/version"
-require "briard/metadata"
-require "briard/cli"
-require "briard/string"
-require "briard/array"
-require "briard/whitelist_scrubber"
+require 'briard/version'
+require 'briard/metadata'
+require 'briard/cli'
+require 'briard/string'
+require 'briard/array'
+require 'briard/whitelist_scrubber'
 
 ENV['USER_AGENT'] ||= "Mozilla/5.0 (compatible; Maremma/#{Maremma::VERSION}; mailto:info@front-matter.io)"

data/spec/array_spec.rb

@@ -3,20 +3,20 @@
 require 'spec_helper'
 
 describe Array do
-  describe "unwrap" do
-    it "to array" do
+  describe 'unwrap' do
+    it 'to array' do
       arr = [1, 2, 3]
       expect(arr.unwrap).to eq(arr)
     end
 
-    it "to integer" do
+    it 'to integer' do
       arr = [1]
       expect(arr.unwrap).to eq(1)
     end
 
-    it "to nil" do
+    it 'to nil' do
       arr = []
-      expect(arr.unwrap).to be_nil
+      expect(arr.unwrap.nil?).to be(true)
     end
   end
 end