briard 2.0 → 2.2

data/spec/readers/cff_reader_spec.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Briard::Metadata, vcr: true do
+  let(:input) { "https://github.com/citation-file-format/ruby-cff/blob/main/CITATION.cff" }
+
+  subject { Briard::Metadata.new(input: input) }
+
+  context "get cff metadata" do
+    it "ruby-cff" do
+      expect(subject.valid?).to be true
+      expect(subject.id).to eq("https://doi.org/10.5281/zenodo.1184077")
+      expect(subject.url).to eq("https://github.com/citation-file-format/ruby-cff")
+      expect(subject.types).to eq("bibtex"=>"misc", "citeproc"=>"article-journal", "resourceTypeGeneral"=>"Software", "ris"=>"COMP", "schemaOrg"=>"SoftwareSourceCode")
+      expect(subject.creators).to eq([{"affiliation"=>[{"name"=>"The University of Manchester, UK"}], "familyName"=>"Haines", "givenName"=>"Robert", "name"=>"Haines, Robert", "nameIdentifiers"=>
+        [{"nameIdentifier"=>"https://orcid.org/0000-0002-9538-7919",
+          "nameIdentifierScheme"=>"ORCID",
+          "schemeUri"=>"https://orcid.org"}], "nameType"=>"Personal"}, {"name"=>"The Ruby Citation File Format Developers", "nameType"=>"Organizational"}])
+      expect(subject.titles).to eq([{"title"=>"Ruby CFF Library"}])
+      expect(subject.descriptions.first["description"]).to start_with("This library provides a Ruby interface to manipulate Citation File Format files")
+      expect(subject.subjects).to eq([{"subject"=>"ruby"},
+        {"subject"=>"credit"},
+        {"subject"=>"software citation"},
+        {"subject"=>"research software"},
+        {"subject"=>"software sustainability"},
+        {"subject"=>"metadata"},
+        {"subject"=>"citation file format"},
+        {"subject"=>"CFF"}])
+      expect(subject.version_info).to eq("0.9.0")
+      expect(subject.dates).to eq([{"date"=>"2021-08-18", "dateType"=>"Issued"}])
+      expect(subject.publication_year).to eq("2021")
+      expect(subject.publisher).to eq("GitHub")
+      expect(subject.rights_list).to eq([{"rights"=>"Apache License 2.0",
+        "rightsIdentifier"=>"apache-2.0",
+        "rightsIdentifierScheme"=>"SPDX",
+        "rightsUri"=>"http://www.apache.org/licenses/LICENSE-2.0",
+        "schemeUri"=>"https://spdx.org/licenses/"}])
+    end
+
+    it "cff-converter-python" do
+      input = "https://github.com/citation-file-format/cff-converter-python/blob/main/CITATION.cff"
+      subject = Briard::Metadata.new(input: input)
+      expect(subject.id).to eq("https://doi.org/10.5281/zenodo.1162057")
+      expect(subject.url).to eq("https://github.com/citation-file-format/cff-converter-python")
+      expect(subject.types).to eq("bibtex"=>"misc", "citeproc"=>"article-journal", "resourceTypeGeneral"=>"Software", "ris"=>"COMP", "schemaOrg"=>"SoftwareSourceCode")
+      expect(subject.creators).to eq([{"affiliation"=>[{"name"=>"Netherlands eScience Center"}],
+        "familyName"=>"Spaaks",
+        "givenName"=>"Jurriaan H.",
+        "name"=>"Spaaks, Jurriaan H.",
+        "nameIdentifiers"=>
+          [{"nameIdentifier"=>"https://orcid.org/0000-0002-7064-4069",
+            "nameIdentifierScheme"=>"ORCID",
+            "schemeUri"=>"https://orcid.org"}],
+        "nameType"=>"Personal"},
+       {"affiliation"=>[{"name"=>"Netherlands eScience Center"}],
+        "familyName"=>"Klaver",
+        "givenName"=>"Tom",
+        "name"=>"Klaver, Tom",
+        "nameType"=>"Personal"},
+      {"affiliation"=>[{"name"=>"Netherlands eScience Center"}],
+        "familyName"=>"Verhoeven",
+        "givenName"=>"Stefan",
+        "name"=>"Verhoeven, Stefan",
+        "nameIdentifiers"=>
+          [{"nameIdentifier"=>"https://orcid.org/0000-0002-5821-2060",
+            "nameIdentifierScheme"=>"ORCID",
+            "schemeUri"=>"https://orcid.org"}],
+        "nameType"=>"Personal"},
+       {"affiliation"=>[{"name"=>"Humboldt-Universit??t zu Berlin"}],
+        "familyName"=>"Druskat",
+        "givenName"=>"Stephan",
+        "name"=>"Druskat, Stephan",
+        "nameIdentifiers"=>
+          [{"nameIdentifier"=>"https://orcid.org/0000-0003-4925-7248",
+            "nameIdentifierScheme"=>"ORCID",
+            "schemeUri"=>"https://orcid.org"}],
+        "nameType"=>"Personal"},
+       {"affiliation"=>[{"name"=>"University of Oslo"}],
+        "familyName"=>"Leoncio",
+        "givenName"=>"Waldir",
+        "name"=>"Leoncio, Waldir",
+        "nameType"=>"Personal"}])
+      expect(subject.titles).to eq([{"title"=>"cffconvert"}])
+      expect(subject.descriptions.first["description"]).to start_with("Command line program to validate and convert CITATION.cff files")
+      expect(subject.subjects).to eq([{"subject"=>"bibliography"},
+        {"subject"=>"BibTeX"},
+        {"subject"=>"cff"},
+        {"subject"=>"citation"},
+        {"subject"=>"CITATION.cff"},
+        {"subject"=>"CodeMeta"},
+        {"subject"=>"EndNote"},
+        {"subject"=>"RIS"},
+        {"subject"=>"Citation File Format"}])
+      expect(subject.version_info).to eq("2.0.0")
+      expect(subject.dates).to eq([{"date"=>"2021-09-22", "dateType"=>"Issued"}])
+      expect(subject.publication_year).to eq("2021")
+      expect(subject.publisher).to eq("GitHub")
+      expect(subject.rights_list).to eq([{"rights"=>"Apache License 2.0",
+        "rightsIdentifier"=>"apache-2.0",
+        "rightsIdentifierScheme"=>"SPDX",
+        "rightsUri"=>"http://www.apache.org/licenses/LICENSE-2.0",
+        "schemeUri"=>"https://spdx.org/licenses/"}])
+    end
+
+    it "ruby-cff" do
+      expect(subject.valid?).to be true
+      expect(subject.id).to eq("https://doi.org/10.5281/zenodo.1184077")
+      expect(subject.url).to eq("https://github.com/citation-file-format/ruby-cff")
+      expect(subject.types).to eq("bibtex"=>"misc", "citeproc"=>"article-journal", "resourceTypeGeneral"=>"Software", "ris"=>"COMP", "schemaOrg"=>"SoftwareSourceCode")
+      expect(subject.creators).to eq([{"affiliation"=>[{"name"=>"The University of Manchester, UK"}], "familyName"=>"Haines", "givenName"=>"Robert", "name"=>"Haines, Robert", "nameIdentifiers"=>
+        [{"nameIdentifier"=>"https://orcid.org/0000-0002-9538-7919",
+          "nameIdentifierScheme"=>"ORCID",
+          "schemeUri"=>"https://orcid.org"}], "nameType"=>"Personal"}, {"name"=>"The Ruby Citation File Format Developers", "nameType"=>"Organizational"}])
+      expect(subject.titles).to eq([{"title"=>"Ruby CFF Library"}])
+      expect(subject.descriptions.first["description"]).to start_with("This library provides a Ruby interface to manipulate Citation File Format files")
+      expect(subject.subjects).to eq([{"subject"=>"ruby"},
+        {"subject"=>"credit"},
+        {"subject"=>"software citation"},
+        {"subject"=>"research software"},
+        {"subject"=>"software sustainability"},
+        {"subject"=>"metadata"},
+        {"subject"=>"citation file format"},
+        {"subject"=>"CFF"}])
+      expect(subject.version_info).to eq("0.9.0")
+      expect(subject.dates).to eq([{"date"=>"2021-08-18", "dateType"=>"Issued"}])
+      expect(subject.publication_year).to eq("2021")
+      expect(subject.publisher).to eq("GitHub")
+      expect(subject.rights_list).to eq([{"rights"=>"Apache License 2.0",
+        "rightsIdentifier"=>"apache-2.0",
+        "rightsIdentifierScheme"=>"SPDX",
+        "rightsUri"=>"http://www.apache.org/licenses/LICENSE-2.0",
+        "schemeUri"=>"https://spdx.org/licenses/"}])
+    end
+
+    it "ruby-cff repository url" do
+      input = "https://github.com/citation-file-format/ruby-cff"
+      subject = Briard::Metadata.new(input: input)
+      expect(subject.valid?).to be true
+      expect(subject.id).to eq("https://doi.org/10.5281/zenodo.1184077")
+      expect(subject.url).to eq("https://github.com/citation-file-format/ruby-cff")
+      expect(subject.types).to eq("bibtex"=>"misc", "citeproc"=>"article-journal", "resourceTypeGeneral"=>"Software", "ris"=>"COMP", "schemaOrg"=>"SoftwareSourceCode")
+      expect(subject.creators).to eq([{"affiliation"=>[{"name"=>"The University of Manchester, UK"}], "familyName"=>"Haines", "givenName"=>"Robert", "name"=>"Haines, Robert", "nameIdentifiers"=>
+        [{"nameIdentifier"=>"https://orcid.org/0000-0002-9538-7919",
+          "nameIdentifierScheme"=>"ORCID",
+          "schemeUri"=>"https://orcid.org"}], "nameType"=>"Personal"}, {"name"=>"The Ruby Citation File Format Developers", "nameType"=>"Organizational"}])
+      expect(subject.titles).to eq([{"title"=>"Ruby CFF Library"}])
+      expect(subject.descriptions.first["description"]).to start_with("This library provides a Ruby interface to manipulate Citation File Format files")
+      expect(subject.subjects).to eq([{"subject"=>"ruby"},
+        {"subject"=>"credit"},
+        {"subject"=>"software citation"},
+        {"subject"=>"research software"},
+        {"subject"=>"software sustainability"},
+        {"subject"=>"metadata"},
+        {"subject"=>"citation file format"},
+        {"subject"=>"CFF"}])
+      expect(subject.version_info).to eq("0.9.0")
+      expect(subject.dates).to eq([{"date"=>"2021-08-18", "dateType"=>"Issued"}])
+      expect(subject.publication_year).to eq("2021")
+      expect(subject.publisher).to eq("GitHub")
+      expect(subject.rights_list).to eq([{"rights"=>"Apache License 2.0",
+        "rightsIdentifier"=>"apache-2.0",
+        "rightsIdentifierScheme"=>"SPDX",
+        "rightsUri"=>"http://www.apache.org/licenses/LICENSE-2.0",
+        "schemeUri"=>"https://spdx.org/licenses/"}])
+    end
+  end
+end

data/spec/readers/codemeta_reader_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Briard::Metadata, vcr: true do
-  let(:input) { "https://github.com/datacite/maremma" }
+  let(:input) { "https://github.com/datacite/maremma/blob/master/codemeta.json" }
 
   subject { Briard::Metadata.new(input: input) }
 

data/spec/utils_spec.rb

@@ -507,12 +507,24 @@ describe Briard::Metadata, vcr: true do
       expect(response).to eq(:owner=>"datacite", :repo=>"metadata-reports", :release=>"master", :path=>"software/codemeta.json")
     end
 
+    it "github_from_url cff file" do
+      url = "https://github.com/citation-file-format/ruby-cff/blob/main/CITATION.cff"
+      response = subject.github_from_url(url)
+      expect(response).to eq(:owner=>"citation-file-format", :path=>"CITATION.cff", :release=>"main", :repo=>"ruby-cff")
+    end
+
     it "github_as_codemeta_url" do
       url = "https://github.com/datacite/bolognese"
       response = subject.github_as_codemeta_url(url)
       expect(response).to eq("https://raw.githubusercontent.com/datacite/bolognese/master/codemeta.json")
     end
 
+    it "github_as_cff_url" do
+      url = "https://github.com/citation-file-format/ruby-cff"
+      response = subject.github_as_cff_url(url)
+      expect(response).to eq("https://raw.githubusercontent.com/citation-file-format/ruby-cff/main/CITATION.cff")
+    end
+
     it "github_from_url file" do
       url = "https://github.com/datacite/metadata-reports/blob/master/software/codemeta.json"
       response = subject.github_as_codemeta_url(url)

data/spec/writers/cff_writer_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Briard::Metadata, vcr: true do
+  context "write metadata as cff" do
+    it "SoftwareSourceCode Zenodo" do
+      input = "https://doi.org/10.5281/zenodo.10164"
+      subject = Briard::Metadata.new(input: input, from: "datacite")
+      expect(subject.valid?).to be true
+      json = Psych.safe_load(subject.cff, permitted_classes: [Date])
+      expect(json["doi"]).to eq("https://doi.org/10.5281/zenodo.10164")
+      expect(json["authors"]).to eq([{"affiliation"=>[{"name"=>"Juelich Supercomputing Centre, Jülich, Germany"}],
+        "familyName"=>"Klatt",
+        "givenName"=>"Torbjörn",
+        "name"=>"Klatt, Torbjörn"},
+       {"affiliation"=>[{"name"=>"Juelich Supercomputing Centre, Jülich, Germany"}],
+        "familyName"=>"Moser",
+        "givenName"=>"Dieter",
+        "name"=>"Moser, Dieter"},
+       {"affiliation"=>[{"name"=>"Juelich Supercomputing Centre, Jülich, Germany"}],
+        "familyName"=>"Speck",
+        "givenName"=>"Robert",
+        "name"=>"Speck, Robert"}])
+      expect(json["title"]).to eq("Pypint -- Python Framework For Parallel-In-Time Methods")
+      expect(json["abstract"]).to eq("<em>PyPinT</em> is a framework for Parallel-in-Time integration routines. The main purpose of <em>PyPinT</em> is to provide a framework for educational use and prototyping new parallel-in-time algorithms. As well it will aid in developing a high-performance C++ implementation for massively parallel computers providing the benefits of parallel-in-time routines to a zoo of time integrators in various applications.")
+      expect(json["date-released"]).to eq("2014-05-27")
+      expect(json["repository-code"]).to eq("https://zenodo.org/record/10164")
+      expect(json["keywords"]).to eq(["Parallel-in-Time Integration", "Spectral Deferred Corrections", "Multigrid", "Multi-Level Spectral Deferred Corrections", "Python Framework"])
+      expect(json["license"]).to eq(["http://www.opensource.org/licenses/MIT", "info:eu-repo/semantics/openAccess"])
+    end
+
+    it "SoftwareSourceCode also Zenodo" do
+      input = "https://doi.org/10.5281/zenodo.15497"
+      subject = Briard::Metadata.new(input: input, from: "datacite")
+      expect(subject.valid?).to be true
+      json = Psych.safe_load(subject.cff, permitted_classes: [Date])
+      expect(json["doi"]).to eq("https://doi.org/10.5281/zenodo.15497")
+      expect(json["authors"]).to eq([{"affiliation"=>
+        [{"name"=>
+          "Instituut voor Kern- en Stralingsfysica, KU Leuven, 3001 Leuven, België"}],
+          "familyName"=>"Gins",
+          "givenName"=>"Wouter",
+          "name"=>"Gins, Wouter"},
+         {"affiliation"=>
+        [{"name"=>
+          "Instituut voor Kern- en Stralingsfysica, KU Leuven, 3001 Leuven, België"}],
+          "familyName"=>"de Groote",
+          "givenName"=>"Ruben",
+          "name"=>"de Groote, Ruben"},
+         {"affiliation"=>
+        [{"name"=>
+          "Instituut voor Kern- en Stralingsfysica, KU Leuven, 3001 Leuven, België"}],
+          "familyName"=>"Heylen",
+          "givenName"=>"Hanne",
+          "name"=>"Heylen, Hanne"}])
+      expect(json["title"]).to eq("Satlas: Simulation And Analysis Toolbox For Laser Spectroscopy And Nmr Experiments")
+      expect(json["abstract"]).to eq("Initial release of the satlas Python package for the analysis and simulation for laser spectroscopy experiments. For the documentation, see http://woutergins.github.io/satlas/")
+      expect(json["date-released"]).to eq("2015-02-18")
+      expect(json["repository-code"]).to eq("https://zenodo.org/record/15497")
+      expect(json["keywords"]).to be_nil
+      expect(json["license"]).to eq(["http://www.opensource.org/licenses/MIT", "info:eu-repo/semantics/openAccess"])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: briard
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '2.2'
 platform: ruby
 authors:
 - Martin Fenner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: maremma
@@ -585,7 +585,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.0
 description: Ruby gem and command-line utility for conversion of DOI metadata from
-  and to different metadata formats, including schema.org. Fork of bolognese gem.
+  and to different metadata formats, including schema.org. Fork of version 1.19.12
+  of the bolognese gem.
 email: martin@front-matter.io
 executables:
 - briard
@@ -598,8 +599,10 @@ files:
 - ".github/workflows/release.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CITATION
+- CITATION.cff
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
@@ -619,6 +622,7 @@ files:
 - lib/briard/metadata_utils.rb
 - lib/briard/pubmed.rb
 - lib/briard/readers/bibtex_reader.rb
+- lib/briard/readers/cff_reader.rb
 - lib/briard/readers/citeproc_reader.rb
 - lib/briard/readers/codemeta_reader.rb
 - lib/briard/readers/crosscite_reader.rb
@@ -633,6 +637,7 @@ files:
 - lib/briard/version.rb
 - lib/briard/whitelist_scrubber.rb
 - lib/briard/writers/bibtex_writer.rb
+- lib/briard/writers/cff_writer.rb
 - lib/briard/writers/citation_writer.rb
 - lib/briard/writers/citeproc_writer.rb
 - lib/briard/writers/codemeta_writer.rb
@@ -799,6 +804,7 @@ files:
 - spec/datacite_utils_spec.rb
 - spec/doi_utils_spec.rb
 - spec/find_from_format_spec.rb
+- spec/fixtures/CITATION.cff
 - spec/fixtures/aida.json
 - spec/fixtures/cgimp_package.json
 - spec/fixtures/cit_package.json
@@ -959,6 +965,10 @@ files:
 - spec/fixtures/vcr_cassettes/Briard_Metadata/from_schema_org/with_id.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/from_schema_org_creators/with_affiliation.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/from_schema_org_creators/without_affiliation.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/get_cff_metadata/cff-converter-python.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/get_cff_metadata/pidgraph-notebooks-python.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/get_cff_metadata/ruby-cff.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/get_cff_metadata/ruby-cff_repository_url.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/get_codemeta_metadata/maremma.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/get_codemeta_metadata/metadata_reports.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/get_crossref_metadata/DOI_with_ORCID_ID.yml
@@ -1074,8 +1084,10 @@ files:
 - spec/fixtures/vcr_cassettes/Briard_Metadata/get_series_information/title_and_pages.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/get_series_information/title_volume_and_pages.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/get_series_information/title_volume_issue_and_pages.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/github/github_as_cff_url.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/github/github_as_codemeta_url.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/github/github_from_url.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/github/github_from_url_cff_file.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/github/github_from_url_file.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/handle_input/DOI_RA_not_Crossref_or_DataCite.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/handle_input/unknown_DOI_prefix.yml
@@ -1200,6 +1212,9 @@ files:
 - spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_bibtex/text.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_bibtex/with_data_citation.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_bibtex/with_pages.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_cff/SoftwareSourceCode_DataCite.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_cff/SoftwareSourceCode_Zenodo.yml
+- spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_cff/SoftwareSourceCode_also_Zenodo.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_citation/Dataset.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_citation/Journal_article.yml
 - spec/fixtures/vcr_cassettes/Briard_Metadata/write_metadata_as_citation/Journal_article_vancouver_style.yml
@@ -1296,6 +1311,7 @@ files:
 - spec/fixtures/vivli.xml
 - spec/metadata_spec.rb
 - spec/readers/bibtex_reader_spec.rb
+- spec/readers/cff_reader_spec.rb
 - spec/readers/citeproc_reader_spec.rb
 - spec/readers/codemeta_reader_spec.rb
 - spec/readers/crosscite_reader_spec.rb
@@ -1308,6 +1324,7 @@ files:
 - spec/spec_helper.rb
 - spec/utils_spec.rb
 - spec/writers/bibtex_writer_spec.rb
+- spec/writers/cff_writer_spec.rb
 - spec/writers/citation_writer_spec.rb
 - spec/writers/citeproc_writer_spec.rb
 - spec/writers/codemeta_writer_spec.rb