relaton-bib 1.3.0 → 1.5.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d2e73e228a1e3d0b56ec177f3fa39a721dbd76ff99fd3f18e38c331672aca43
-  data.tar.gz: c9dab886bcffafd638735157419c904b88da2363048178fb8c458399d9a74909
+  metadata.gz: 1c135ae20e6dedad964161c4688f955bc1f6ff9945e36dcfbb4aaed73bf6d6bf
+  data.tar.gz: 7e1775460d12c0c2b8e4014cced56a7dbd84abf215c0882e34a11c198977d28c
 SHA512:
-  metadata.gz: 62292ca68783b8f5817807ca4b014ec0c782a81c3724ff7860562f7d4529cd3eac9e1f1dccddae7149d6bb56dbb114dd1bcd7393cbc797cb91b7beb02a3de953
-  data.tar.gz: ff58d4ed2c0bb448bca70e62e8a6d9252ffa02865bfcbbc31f0bf360e009f372e8bc292c59ee7c970f891e0ab496cf4e81df3241f967dbbde1968cebdccf8952
+  metadata.gz: f6ca89938617badf59e7e92503e1b08a87428ea0cadca42af71e93c9e528a5d2f9fd1a2f7c1a90893233db16cad05c46295561f42962c3fcdb8402cbf331e723
+  data.tar.gz: 82204e17e4ce3dc1df5555eea3f7817b1cbfa4d1f1bd2de22ef3499ea84539dbce1ef114e651a303367ae35b1a78823b043dc954d907f1717b3305662d692312

data/README.adoc

@@ -136,10 +136,13 @@ item = RelatonBib::BibliographicItem.new(
     },
     { entity: { name: "Institution" }, role: [type: "sponsor"] }
   ],
-  copyright: { owner: {
-    name: "International Organization for Standardization",
-    abbreviation: "ISO", url: "www.iso.org"
-  }, from: "2014", to: "2020" },
+  copyright: [{
+      owner: [{
+          name: "International Organization for Standardization",
+          abbreviation: "ISO", url: "www.iso.org"
+        }],
+      from: "2014", to: "2020" 
+  }],
   link: [
     { type: "src", content: "https://www.iso.org/standard/53798.html" },
     { type: "obp",
@@ -232,6 +235,10 @@ item = RelatonBib::BibliographicItem.new(
     revision: Time.new(2011, 3, 4, 9, 0),
   )
 )
+
+=> #<RelatonBib::BibliographicItem:0x007fc8b6c796c0
+ @abstract=
+  [#<RelatonBib::FormattedString:0x007fc8b6c726b8 @content="ISO 19115-1:2014 defines the schema required for ...", @format="text/plain", @language=["en"], @script=["Latn"]>,
 ----
 
 === BibliographicItem Typed Title Strings
@@ -245,6 +252,11 @@ item.title
  #<RelatonBib::TypedTitleString:0x007fa49a35bf38
   @title=#<RelatonBib::FormattedString:0x007fa49a35bdd0 @content="Information géographique", @format=nil, @language=["fr"], @script=["Latn"]>,
   @type=nil>]
+
+item.title lang: "fr"
+=> [#<RelatonBib::TypedTitleString:0x007fa49a35bf38
+  @title=#<RelatonBib::FormattedString:0x007fa49a35bdd0 @content="Information géographique", @format=nil, @language=["fr"], @script=["Latn"]>,
+  @type=nil>]
 ----
 
 === BibliographicItem Formatted Strings
@@ -252,8 +264,8 @@ item.title
 [source,ruby]
 ----
 item.abstract
-=> [#<RelatonBib::FormattedString:0x007fa49a35aed0 @content="ISO 19115-1:2014 defines the schema required for ...", @format="text/plain", @language=["en"], @script=["Latn"]>,
- #<RelatonBib::FormattedString:0x007fa49a35ae08 @content="L'ISO 19115-1:2014 définit le schéma requis pour ...", @format="text/plain", @language=["fr"], @script=["Latn"]>]
+=> [#<RelatonBib::FormattedString:0x007fc8b6c726b8 @content="ISO 19115-1:2014 defines the schema required for ...", @format="text/plain", @language=["en"], @script=["Latn"]>,
+ #<RelatonBib::FormattedString:0x007fc8b6c725f0 @content="L'ISO 19115-1:2014 définit le schéma requis pour ...", @format="text/plain", @language=["fr"], @script=["Latn"]>]
 
 item.abstract(lang: "en").to_s
 => "ISO 19115-1:2014 defines the schema required for ..."
@@ -263,8 +275,8 @@ item.abstract(lang: "en").to_s
 
 [source,ruby]
 ----
-item.shortref item
-=> "ISO/TC211:2014"
+item.shortref item.docidentifier.first
+=> "TC211:2014"
 ----
 
 === XML serialization
@@ -272,10 +284,10 @@ item.shortref item
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id=\"ISO/TC211\" type=\"standard\">
+=> "<bibitem id="ISO/TC211" type="standard">
       <fetched>2019-04-30</fetched>
-      <title type=\"main\" language=\"en\" script=\"Latn\">Geographic information</title>
-      <title language=\"fr\" script=\"Latn\">Information géographique</title>
+      <title type="main" language="en" script="Latn">Geographic information</title>
+      <title language="fr" script="Latn">Information géographique</title>
       ...
     </bibitem>"
 ----
@@ -285,9 +297,9 @@ Default root element is `bibitem`. With argument `bibdata: true` the XML wrapped
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata type=\"standard\">
+=> "<bibdata type="standard">
       <fetched>2019-04-30</fetched>
-      <title type=\"main\" language=\"en\" script=\"Latn\">Geographic information</title>
+      <title type="main" language="en" script="Latn">Geographic information</title>
       ...
     </bibdata>"
 ----
@@ -296,12 +308,12 @@ item.to_xml bibdata: true
 
 By default date elements are formatted as year (yyyy). Option `:date_format` allows to output date elements in `:short` (yyyy-mm) and `:full` (yyyy-mm-dd) additiona formats.
 
-[surce,ruby]
+[source,ruby]
 ----
 item.to_xml date_format: :short
-=> "<bibitem id=\"ISO/TC211\" type=\"standard\">
+=> "<bibitem id="ISO/TC211" type="standard">
       <fetched>2019-04-30</fetched>
-      <title type=\"main\" language=\"en\" script=\"Latn\">Geographic information</title>
+      <title type="main" language="en" script="Latn">Geographic information</title>
       ...
       <date type="issued">
         <on>2014-01</on>
@@ -313,9 +325,10 @@ item.to_xml date_format: :short
         <on>2015-05</on>
       </date>
       ...
+    </bibitem>"
 
 item.to_xml date_format: :full
-=> "<bibitem id=\"ISO/TC211\" type=\"standard\">
+=> "<bibitem id="ISO/TC211" type="standard">
       ...
       <date type="issued">
         <on>2014-01-01</on>
@@ -327,6 +340,19 @@ item.to_xml date_format: :full
         <on>2015-05-20</on>
       </date>
       ...
+    </bibitem>"
+----
+
+==== Adding notes
+
+[source,ruby]
+----
+item.to_xml note: [{ text: "Note", type: "note" }]
+=>"<bibitem id="ISO19115-1-2014">
+  ...
+  <note format="text/plain" type="note">Note</note>
+  ...
+</bibitem>"
 ----
 
 === Create bibliographic item form YAML
@@ -362,7 +388,7 @@ item.to_hash
 
 [source,ruby]
 ----
-RelatonBib::BibtexParser.from_bibtex File.read('spec/examples/bibitem.bib')
+RelatonBib::BibtexParser.from_bibtex File.read('spec/examples/techreport.bib')
 => {"ISOTC211"=>
   #<RelatonBib::BibliographicItem:0x007fedee0a2ab0
   ...

data/grammars/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +64,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +586,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +671,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +717,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -855,7 +885,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +952,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +994,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1022,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1044,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1072,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1216,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1486,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1535,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/grammars/reqt.rng

@@ -39,12 +39,6 @@
     <optional>
       <attribute name="filename"/>
     </optional>
-    <optional>
-      <attribute name="model"/>
-    </optional>
-    <optional>
-      <attribute name="type"/>
-    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>
@@ -54,9 +48,9 @@
     <optional>
       <ref name="subject"/>
     </optional>
-    <zeroOrMore>
+    <optional>
       <ref name="reqinherit"/>
-    </zeroOrMore>
+    </optional>
     <zeroOrMore>
       <ref name="classification"/>
     </zeroOrMore>

data/lib/relaton_bib.rb

@@ -1,5 +1,7 @@
+require "forwardable"
 require "relaton_bib/version"
 require "relaton_bib/deep_dup"
+require "relaton_bib/localized_string"
 require "relaton_bib/bibliographic_item"
 require "relaton_bib/hit_collection"
 require "relaton_bib/hit"
@@ -34,7 +36,7 @@ module RelatonBib
 
   # @param array [Array]
   # @return [Array<String>, String]
-  def single_element_array(array) # rubocop:disable Metrics/CyclomaticComplexity
+  def single_element_array(array) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
     if array.size > 1
       array.map { |e| e.is_a?(String) ? e : e.to_hash }
     else

data/lib/relaton_bib/biblio_note.rb

@@ -1,4 +1,31 @@
 module RelatonBib
+  class BiblioNoteCollection
+    extend Forwardable
+
+    def_delegators :@array, :[], :first, :last, :empty?, :any?, :size,
+                   :each, :map, :detect, :length
+
+    def initialize(notes)
+      @array = notes
+    end
+
+    # @param bibnote [RelatonBib::BiblioNote]
+    # @return [self]
+    def <<(bibnote)
+      @array << bibnote
+      self
+    end
+
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] XML builder
+    # @option opts [String] :lang language
+    def to_xml(**opts)
+      bnc = @array.select { |bn| bn.language&.include? opts[:lang] }
+      bnc = @array unless bnc.any?
+      bnc.each { |bn| bn.to_xml opts[:builder] }
+    end
+  end
+
   class BiblioNote < FormattedString
     # @return [String, NilClass]
     attr_reader :type