relaton-bib 1.20.7 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a7ca942458eaadfc3b1b7c6d9e3b3356c87212fe784dec2b3f23e13bd0d893d
-  data.tar.gz: ed788c72a1a8e37ec1712e6bd0b4f1f41926f8a13bd4f8445f299344006ff2e4
+  metadata.gz: 926f3fc5e7c7087fdb474ef99b675f180a83aa3d6ceb33bae1be4bfe35809af8
+  data.tar.gz: 8f9320d9910d88ae20f20883087251a11cd2f192751709574d509cfb79f79918
 SHA512:
-  metadata.gz: 520644a6bc2b97c2c4642f0b291f22c15f724357b29e0102fd12008cd6430572e4a428d3fa7ddc04c5b7c04699f04f1a1675732849b49a125e989efbbcf62830
-  data.tar.gz: cfff6dcb24f1915cc1c0158e993c48b1d9354a944d6982847faac5925c84f3b90d640c50b0b9acd71ba556c7e8267fa52c2e3ecf0291c35dee8d866cfcc6ee24
+  metadata.gz: d4276b3adfde5ba25a78e1de55c5ed6fea48358076ed5c3f18b6e1f4b5afb517b144145429ffe05127ba1fdf6670c91c0b8b4a8f5ebecc739a7f89edbcb8b339
+  data.tar.gz: a67e4932c74fcd648d2b2c4bebfacf8534684d0525909a9fa4c96626890b475593264faa3bc864d6a1a5c2786c99d26a5f71e7b0dd49f404530f5763d154832e

data/.rubocop.yml

@@ -7,6 +7,6 @@ require: rubocop-rails
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
 Rails:
   Enabled: false

data/README.adoc

@@ -1,4 +1,4 @@
-= RelatonBib
+= Relaton::Bib
 
 image:https://img.shields.io/gem/v/relaton-bib.svg["Gem Version", link="https://rubygems.org/gems/relaton-bib"]
 image:https://github.com/relaton/relaton-bib/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/relaton-bib/actions?workflow=rake"]
@@ -6,7 +6,7 @@ image:https://codeclimate.com/github/relaton/relaton-bib/badges/gpa.svg["Code Cl
 image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-bib.svg["Pull Requests", link="https://github.com/relaton/relaton-bib/pulls"]
 image:https://img.shields.io/github/commits-since/relaton/relaton-bib/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-bib/releases"]
 
-RelatonBib is a Ruby gem that implements the https://github.com/metanorma/relaton-models#bibliography-uml-models[BibliographicItem model].
+Relaton::Bib is a Ruby gem that implements the https://github.com/metanorma/relaton-models#bibliography-uml-models[BibliographicItem model].
 
 == Installation
 
@@ -27,78 +27,93 @@ Or install it yourself as:
 
 == Usage
 
-=== Create bibliographic item
-
 [source,ruby]
 ----
-require 'relaton_bib'
+require 'relaton/bib'
 => true
+----
 
-hash = YAML.load_file "spec/examples/bib_item.yml"
-=> {"id"=>"ISOTC211",
-"fetched"=>"2022-05-02",
- "title"=>["Geographic information", {"content"=>"Information géographique", "language"=>"fr", "script"=>"Latn"}],
- ...
+=== Create bibliographic item
 
-item = RelatonBib::BibliographicItem.from_hash(hash)
-=> #<RelatonBib::BibliographicItem:0x00007f962f030710
- @abstract=
-  [#<RelatonBib::FormattedString:0x00007f962f02acc0
-...
+[source,ruby]
+----
+yaml = File.read 'spec/fixtures/item.yaml'
+ => "id: ISO1231994\ntype: standard\nschema_version: 1.0.0\nfetched: \"2022-05-02\"\nformattedref: ISO 123:1994\ntitle..."
+
+item = Relaton::Bib::Item.from_yaml yaml
+ => #<Relaton::Bib::ItemData:0x000000012838bfc0 ...
 ----
 
-=== BibliographicItem Typed Title Strings
+=== Title
 
 [source,ruby]
 ----
 item.title
-=> #<RelatonBib::TypedTitleStringCollection:0x00007fea821ec6b0
- @array=
-  [#<RelatonBib::TypedTitleString:0x00007fea821ecb60
-    @title=#<RelatonBib::FormattedString:0x00007fea821eca70 @content="Geographic information", @format="text/plain", @language=nil, @script=nil>,
-    @type="title-main">,
-   #<RelatonBib::TypedTitleString:0x00007fea821ec8b8
-    @title=#<RelatonBib::FormattedString:0x00007fea821ec818 @content="Geographic information", @format="text/plain", @language=nil, @script=nil>,
-    @type="main">,
-   #<RelatonBib::TypedTitleString:0x00007fea821ec610
-    @title=
-     #<RelatonBib::FormattedString:0x00007fea821ec570 @content="Information géographique", @format="text/plain", @language=["fr"], @script=["Latn"]>,
-    @type=nil>]>
-
-item.title lang: "fr"
-=> #<RelatonBib::TypedTitleStringCollection:0x00007fea8222d908
- @array=
-  [#<RelatonBib::TypedTitleString:0x00007fea821ec610
-    @title=#<RelatonBib::FormattedString:0x00007fea821ec570 @content="Information géographique", @format="text/plain", @language=["fr"], @script=["Latn"]>,
-    @type=nil>]>
-----
-
-=== BibliographicItem Formatted Strings
+ => [#<Relaton::Bib::Title:0x00000001270a6810
+  @content="Geographic information -- Metadata",
+  @format=nil,
+  @language="en",
+  @locale="en-US",
+  @script="Latn",
+  @type=nil>,
+ #<Relaton::Bib::Title:0x00000001270a5cd0
+  @content="Information géographique -- Métadonnées",
+  @format=nil,
+  @language="fr",
+  @locale="fr-FR",
+  @script="Latn",
+  @type=nil>]
+
+item.title "fr"
+ => [#<Relaton::Bib::Title:0x00000001270a5cd0
+  @content="Information géographique -- Métadonnées",
+  @format=nil,
+  @language="fr",
+  @locale="fr-FR",
+  @script="Latn",
+  @type=nil>]
+----
+
+=== Abstract
 
 [source,ruby]
 ----
 item.abstract
-=> [#<RelatonBib::FormattedString:0x00007fea82236828
-  @content="<p>ISO 19115-1:2014 defines the schema required for ...</p>",
-  @format="text/html",
-  @language=["en"],
-  @script=["Latn"]>,
- #<RelatonBib::FormattedString:0x00007fea82236670
-  @content="L'ISO 19115-1:2014 définit le schéma requis pour ...",
-  @format="text/plain",
-  @language=["fr"],
-  @script=["Latn"]>]
+ => [#<Relaton::Bib::LocalizedMarkedUpString:0x0000000126c05748
+  @content="This is an abstract. <em>This is emphasized</em>",
+  @language="en",
+  @locale="en-US",
+  @script="Latn">]
 
-item.abstract(lang: "en").to_s
-=> "<p>ISO 19115-1:2014 defines the schema required for ...</p>"
+item.abstract("en")
+ => [#<Relaton::Bib::LocalizedMarkedUpString:0x0000000126c05748
+  @content="This is an abstract. <em>This is emphasized</em>",
+  @language="en",
+  @locale="en-US",
+  @script="Latn">]
 ----
 
-=== BibliographicItem references
+=== Document identifier
 
 [source,ruby]
 ----
-item.shortref item.docidentifier.first
-=> "ISOTC211:2014"
+item.docidentifier
+ => [#<Relaton::Bib::Docidentifier:0x00000001270a4b00
+  @content="ISO 123:1994",
+  @language="en",
+  @locale="en-US",
+  @primary=true,
+  @scope="global",
+  @script="Latn",
+  @type="ISO">,
+ #<Relaton::Bib::Docidentifier:0x00000001270a46a0
+  @content="10.1007/978-3-319-99155-2_1",
+  @language=nil,
+  @locale=nil,
+  @primary=nil,
+  @scope=nil,
+  @script=nil,
+  @type="DOI">]
 ----
 
 === XML serialization
@@ -106,11 +121,13 @@ item.shortref item.docidentifier.first
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="ISOTC211" type="standard" schema-version="v1.2.1">
+=> "<bibitem id="ISO1231994" type="standard" schema-version="1.0.0">
       <fetched>2022-05-02</fetched>
-      <title type="title-main" format="text/plain">Geographic information</title>
-      <title type="main" format="text/plain">Geographic information</title>
-      <title format="text/plain" language="fr" script="Latn">Information géographique</title>
+      <formattedref>ISO 123:1994</formattedref>
+      <title language="en" locale="en-US" script="Latn">Geographic information -- Metadata</title>
+      <title language="fr" locale="fr-FR" script="Latn">Information géographique -- Métadonnées</title>
+      <uri type="src">https://www.iso.org/standard/22722.html</uri>
+      <uri type="doi">10.1007/978-3-319-99155-2_1</uri>
       ...
     </bibitem>"
 ----
@@ -120,116 +137,88 @@ The default root element is `bibitem`. With argument `bibdata: true` the XML wra
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata type="standard" schema-version="v1.2.1">
+=> "<bibdata type="standard" schema-version="1.0.0">
       <fetched>2022-05-02</fetched>
-      <title type="title-main" format="text/plain">Geographic information</title>
+      <formattedref>ISO 123:1994</formattedref>
+      <title language="en" locale="en-US" script="Latn">Geographic information -- Metadata</title>
       ...
-        <ext>
-          <doctype>document</doctype>
-          <subdoctype>subdocument</subdoctype>
-          ...
-        </ext>
+      <ext schema-version="1.0.0">
+        <doctype abbreviation="std">Standard</doctype>
+        <subdoctype>Technical Report</subdoctype>
+        ...
+      </ext>
     </bibdata>"
 ----
 
-==== Date format
-
-By default date elements are formatted as a year (yyyy). Option `:date_format` allows to output date elements in `:short` (yyyy-mm) and `:full` (yyyy-mm-dd) additional formats.
+==== Adding notes
 
 [source,ruby]
 ----
-item.to_xml date_format: :short
-=> "<bibitem id="ISOTC211" type="standard" schema-version="v1.2.1">
-      <fetched>2022-05-02</fetched>
-      <title type="title-main" format="text/plain">Geographic information</title>
+item.to_xml note: [{ content: "Note", type: "note" }]
+=> "<bibitem id="ISO1231994" type="standard" schema-version="1.0.0">
       ...
-      <date type="issued">
-        <on>2014-01</on>
-      </date>
-      <date type="published">
-        <on>2014-04</on>
-      </date>
-      <date type="accessed">
-        <on>2015-05</on>
-      </date>
-      ...
-    </bibitem>"
-
-item.to_xml date_format: :full
-=> "<bibitem id="ISOTC211" type="standard" schema-version="v1.2.1">
-      ...
-      <date type="issued">
-        <on>2014-01-01</on>
-      </date>
-      <date type="published">
-        <on>2014-04-01</on>
-      </date>
-      <date type="accessed">
-        <on>2015-05-20</on>
-      </date>
+      <note type="note">Note</note>
       ...
     </bibitem>"
 ----
 
-==== Adding notes
+=== Create bibliographic item form YAML
 
 [source,ruby]
 ----
-item.to_xml note: [{ text: "Note", type: "note" }]
-=> "<bibitem id="ISOTC211" type="standard" schema-version="v1.2.1">
-      ...
-      <note format="text/plain" type="note">Note</note>
-      ...
-    </bibitem>"
+yaml = File.read 'spec/fixtures/item.yaml'
+ => "id: ISO1231994\ntype: standard\nschema_version: 1.0.0\nfetched: \"2022-05-02\"\nformattedref: ISO 123:1994\ntitle..."
+
+Relaton::Bib::Item.from_yaml yaml
+ => #<Relaton::Bib::ItemData:0x000000011dc9e118 ...
 ----
 
-=== Create bibliographic item form YAML
+=== Create bibliographic item from RFC XML
 
 [source,ruby]
 ----
-hash = YAML.load_file 'spec/examples/bib_item.yml'
-=> {"id"=>"ISOTC211"
-...
+xml = File.read 'spec/fixtures/rfc.xml'
+ => "<reference anchor=\"RFC1\" target=\"10.17487/RFC0001\">\n  <front>\n    <title>Title RFC1</title>\n    <seriesInf..."
 
-RelatonBib::BibliographicItem.from_hash hash
-=> #<RelatonBib::BibliographicItem:0x007ff1524f8c88
-...
+Relaton::Bib::Parser::RfcReference.from_xml xml
+ => #<Relaton::Bib::ItemData:0x000000011dc9fc98 ...
 ----
 
-=== Create bibliographic item from BibXML
-
+=== Create bibliographic item from XML
 [source,ruby]
 ----
-bibxml = File.read "spec/examples/rfc.xml"
-=> <reference anchor=...
+xml = File.read 'spec/fixtures/bibitem.xml'
+=> "<bibitem id=\"ISO1231994\" type=\"standard\" schema-version=\"1.0.0\">\n  <fetched>2022-05-02</fetched>\n  <forma..."
 
-RelatonBib::BibXMLParser.parse bibxml
-=> #<RelatonBib::BibliographicItem:0x00007f9d0c75b268
-...
+item = Relaton::Bib::Bibitem.from_xml xml
+ => #<Relaton::Bib::ItemData:0x000000011d4b7580 ...
+
+xml = File.read 'spec/fixtures/bibdata.xml'
+item = Relaton::Bib::Bibdata.from_xml xml
+ => #<Relaton::Bib::ItemData:0x000000011d4daa08 ...
 ----
 
-=== Export bibliographic item to Hash
+=== Create bibliographic item from BibTeX (@TODO: add support for BibTeX)
 
 [source,ruby]
 ----
-item.to_hash
-=> {"schema-version"=>"v1.2.1",
-    "id"=>"ISOTC211",
-    "title"=>
-      [{"content"=>"Geographic information", "format"=>"text/plain", "type"=>"title-main"},
-      {"content"=>"Geographic information", "format"=>"text/plain", "type"=>"main"},
-      {"content"=>"Information géographique", "language"=>["fr"], "script"=>["Latn"], "format"=>"text/plain"}],
-      ...
+Relaton::Bib::BibtexParser.from_bibtex File.read('spec/examples/techreport.bib')
+=> {"ISOTC211"=>
+  #<Relaton::Bib::Item:0x007fedee0a2ab0
+  ...
 ----
 
-=== Create bibliographic item from BibTeX
+=== Export bibliographic item to YAML
 
 [source,ruby]
 ----
-RelatonBib::BibtexParser.from_bibtex File.read('spec/examples/techreport.bib')
-=> {"ISOTC211"=>
-  #<RelatonBib::BibliographicItem:0x007fedee0a2ab0
-  ...
+item.to_yaml
+---
+type: standard
+schema_version: 1.0.0
+fetched: '2022-05-02'
+formattedref: ISO 123:1994
+...
 ----
 
 === Export bibliographic item to BibTeX
@@ -237,14 +226,24 @@ RelatonBib::BibtexParser.from_bibtex File.read('spec/examples/techreport.bib')
 [source,ruby]
 ----
 item.to_bibtex
-=> @misc{ISOTC211,
-    title = {Geographic information},
-    edition = {Edition 1},
-    author = {Bierman, A. and Bierman, Arnold and Bierman, Arnold B},
-    ...
-----
-
-=== Export bibliographic item to Citeproc
+@misc{doe1994a,
+  title = {Geographic information -- Metadata},
+  author = {Doe, John},
+  edition = {First edition},
+  publisher = {International Organization for Standardization},
+  year = {1994},
+  month = {jan},
+  address = {Geneva, Switzerland, Geneva, Geneva},
+  pages = {1--10},
+  keywords = {information},
+  timestamp = {2022-05-02},
+  url = {https://www.iso.org/standard/22722.html},
+  doi = {10.1007/978-3-319-99155-2_1},
+  month_numeric = {1}
+}
+----
+
+=== Export bibliographic item to Citeproc (@TODO: add support for Citeproc)
 
 [source,ruby]
 ----
@@ -257,7 +256,7 @@ item.to_citeproc
      ...
 ----
 
-=== Exporting bibliographic item to AsciiBib
+=== Exporting bibliographic item to AsciiBib (@TODO: add support for AsciiBib)
 
 [source,ruby]
 ----
@@ -273,24 +272,54 @@ item.to_asciibib
    ...
 ----
 
-=== Export bibliographic item to BibXML (RFC)
+=== Export bibliographic item to RFC XML
 
 [source,ruby]
 ----
-item.to_bibxml
-=> "<reference anchor="ISO.TC.211" target="https://www.iso.org/standard/53798.html">
-      <front>
-        <title>Geographic information</title>
-        <author>
-          <organization abbrev="ISO">International Organization for Standardization</organization>
-        </author>
-        ..
-      </front>
-      <seriesInfo name="DOI" value="10.17487/rfc1149"/>
-      <seriesInfo name="Internet-Draft" value="draft-ietf-somewg-someprotocol-07"/>
-      <seriesInfo name="ISO/IEC FDIS 10118-3" value="serie1234"/>
-      ...
-    </reference>"
+item.to_rfcxml
+<reference anchor="ISO 123:1994" target="https://www.iso.org/standard/22722.html">
+  <front>
+    <title>Geographic information -- Metadata</title>
+    <seriesInfo name="DOI" value="10.1007/978-3-319-99155-2_1"/>
+    <seriesInfo name="ISO 123" value="1"/>
+    <author initials="J.D." surname="Doe" fullname="Prof. John Doe PhD">
+      <organization>International Organization for Standardization</organization>
+      <address>
+        <postal>
+          <street>1, rue de Varembé</street>
+          <city>Geneva</city>
+          <code>1211</code>
+          <country>Switzerland</country>
+          <postalLine>1, rue de Varembé,&lt;br/&gt;Geneva, Switzerland, 1211</postalLine>
+        </postal>
+        <phone>+41 22 749 01 11</phone>
+        <email>jdoe@email.org</email>
+        <uri>https://orcid.org/0000-0002-1825-0097</uri>
+      </address>
+    </author>
+    <author>
+      <organization abbrev="ISO">International Organization for Standardization</organization>
+      <address>
+        <postal>
+          <street>1, rue de Varembé</street>
+          <city>Geneva</city>
+          <code>1211</code>
+          <country>Switzerland</country>
+          <postalLine>1, rue de Varembé,&lt;br/&gt;Geneva, Switzerland, 1211</postalLine>
+        </postal>
+        <phone>+41 22 749 01 11</phone>
+        <email>office@iso.org</email>
+        <uri>https://www.iso.org</uri>
+      </address>
+    </author>
+    <date day="01" month="January" year="1994"></date>
+    <workgroup>Geographic information</workgroup>
+    <keyword>information</keyword>
+    <abstract>
+      <t>This is an abstract. &lt;em&gt;This is emphasized&lt;/em&gt;</t>
+    </abstract>
+  </front>
+</reference>
 ----
 
 === Logging

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "relaton_bib"
+require "relaton/bib"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.