relaton-bib 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfbf62a35f1d2fc87694f7e749f4a511dd6ec1962316857059e977ffe5e0ea88
-  data.tar.gz: 627c561a83b8e2cf1dbb14351383feb91ba6803dee8821a4e7d73ce1c3b96855
+  metadata.gz: bd9ee52233758a976f5f9d4e549c61c899a643afddf3486215b219b868041d76
+  data.tar.gz: dc9878b905a4412fe8237f71a422f23252a7f9933e882e1d502333890e00ba1d
 SHA512:
-  metadata.gz: 41107e963fa76a4dad2ebdff5d1fefd5d6c48ac61692027359489643c4b6e3f2185f0bc3ecbaa77462cd4b7c033cbe48e008255ae9ff072b403ada4146374870
-  data.tar.gz: 0d2a5739b3fe5f18aa9b17e7dbb87e00bc6a012a0e6f13831f9d06871992dbd7d9aa0f859621039fbbac6cf02a45eae859fa686c67ade23817431241110073d4
+  metadata.gz: 07d38211e4b0e19152e0c92341902f3a93482795c4cd1b019e67b33dd95edfba630cd9c474f8b3c930bf36dee99f346f8142f49252e296a2867580ffb53082ba
+  data.tar.gz: 3a070a16d70d30bc72750325d314ab548938d224e58aa584748572be85b4e5e66d94b8ca204583faa40231adacd86a0eec1ea4d40c4d4261ab2dbc484492d7db

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/bibliographic_item.rb

@@ -268,6 +268,9 @@ module RelatonBib
       end
     end
 
+    # @param id [RelatonBib::DocumentIdentifier]
+    # @param attribute [boolean, nil]
+    # @return [String]
     def makeid(id, attribute)
       return nil if attribute && !@id_attribute
 
@@ -282,8 +285,12 @@ module RelatonBib
       idstr.strip
     end
 
+    # @param identifier [RelatonBib::DocumentIdentifier]
+    # @param options [Hash]
+    # @option options [boolean, nil] :no_year
+    # @option options [boolean, nil] :all_parts
     # @return [String]
-    def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity
+    def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
       pubdate = date.select { |d| d.type == "published" }
       year = if opts[:no_year] || pubdate.empty? then ""
              else ":" + pubdate&.first&.on&.year.to_s
@@ -344,7 +351,9 @@ module RelatonBib
       hash["keyword"] = single_element_array(keyword) if keyword&.any?
       hash["license"] = single_element_array(license) if license&.any?
       hash["doctype"] = doctype if doctype
-      hash["editorialgroup"] = editorialgroup.to_hash if editorialgroup
+      if editorialgroup&.presence?
+        hash["editorialgroup"] = editorialgroup.to_hash
+      end
       hash["ics"] = single_element_array ics if ics.any?
       if structuredidentifier&.presence?
         hash["structuredidentifier"] = structuredidentifier.to_hash
@@ -406,7 +415,7 @@ module RelatonBib
     end
 
     # remove title part components and abstract
-    def to_all_parts # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def to_all_parts # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength,Metrics/PerceivedComplexity
       me = deep_clone
       me.disable_id_attribute
       me.relation << DocumentRelation.new(type: "instance", bibitem: self)
@@ -449,7 +458,7 @@ module RelatonBib
 
     # If revision_date exists then returns it else returns published date or nil
     # @return [String, NilClass]
-    def revdate # rubocop:disable Metrics/CyclomaticComplexity
+    def revdate # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       @revdate ||= if version&.revision_date
                      version.revision_date
                    else
@@ -526,7 +535,7 @@ module RelatonBib
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_author(item) # rubocop:disable Metrics/CyclomaticComplexity
+    def bibtex_author(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       authors = contributor.select do |c|
         c.entity.is_a?(Person) && c.role.map(&:type).include?("author")
       end.map &:entity
@@ -560,7 +569,7 @@ module RelatonBib
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_note(item) # rubocop:disable Metrics/CyclomaticComplexity
+    def bibtex_note(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
       biblionote.each do |n|
         case n.type
         when "annote" then item.annote = n.content
@@ -677,6 +686,9 @@ module RelatonBib
         builder.edition edition if edition
         version&.to_xml builder
         biblionote.each { |n| n.to_xml builder }
+        opts[:note]&.each do |n|
+          builder.note(n[:text], format: "text/plain", type: n[:type])
+        end
         language.each { |l| builder.language l }
         script.each { |s| builder.script s }
         abstract.each { |a| builder.abstract { a.to_xml(builder) } }

data/lib/relaton_bib/document_identifier.rb

@@ -20,21 +20,26 @@ module RelatonBib
     def remove_part
       case @type
       when "Chinese Standard" then @id.sub!(/\.\d+/, "")
-      else
-        @id.sub!(/-\d+/, "")
+      when "ISO", "IEC" then @id.sub!(/-[^:]+/, "")
+      when "URN" then remove_urn_part
       end
     end
 
     def remove_date
       case @type
       when "Chinese Standard" then @id.sub!(/-[12]\d\d\d/, "")
-      else
-        @id.sub!(/:[12]\d\d\d/, "")
+      when "ISO", "IEC" then @id.sub!(/:[12]\d\d\d/, "")
+      when "URN"
+        @id.sub!(/^(urn:iec:std:[^:]+:[^:]+:)[^:]*/, '\1')
       end
     end
 
     def all_parts
-      @id += " (all parts)"
+      if type == "URN"
+        @id.sub!(%r{^(urn:iec:std(?::[^:]*){4}).*}, '\1:ser')
+      else
+        @id += " (all parts)"
+      end
     end
 
     #
@@ -67,5 +72,24 @@ module RelatonBib
       out += "#{pref}docid.id:: #{id}\n"
       out
     end
+
+    private
+
+    def remove_urn_part # rubocop:disable Metrics/MethodLength
+      @id.sub!(%r{^
+        (urn:iso:std:[^:]+ # ISO prefix and originator
+          (?::(?:data|guide|isp|iwa|pas|r|tr|ts|tta)) # type
+          ?:\d+) # docnumber
+        (?::-[^:]+)? # partnumber
+        (?::(draft|cancelled|stage-[^:]+))? # status
+        (?::ed-\d+)?(?::v[^:]+)? # edition and version
+        (?::\w{2}(?:,\w{2})*)? # langauge
+      }x, '\1') # remove partnumber, status, version, and language
+      @id.sub!(%r{^
+        (urn:iec:std:[^:]+ # IEC prefix and originator
+          :\d+) # docnumber
+        (?:-[^:]+)? # partnumber
+      }x, '\1') # remove partnumber
+    end
   end
 end

data/lib/relaton_bib/editorial_group.rb

@@ -32,5 +32,10 @@ module RelatonBib
         tc.to_asciibib pref, technical_committee.size
       end.join
     end
+
+    # @return [true]
+    def presence?
+      true
+    end
   end
 end

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.3.1".freeze
+  VERSION = "1.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug