relaton-bib 1.11.7 → 1.12.0

data/grammars/isodoc.rng

@@ -32,6 +32,43 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="admonition">
+      <element name="admonition">
+        <attribute name="type">
+          <ref name="AdmonitionType"/>
+        </attribute>
+        <optional>
+          <attribute name="class"/>
+        </optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="uri">
+            <data type="anyURI"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -79,6 +116,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="suppress_identifier">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <ref name="BibliographicItem"/>
       </element>
     </define>
@@ -245,6 +287,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="ul_li"/>
         </oneOrMore>
@@ -287,6 +332,9 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -323,6 +371,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -657,6 +708,9 @@
       <optional>
         <attribute name="tag"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="multilingual-rendering">
           <ref name="MultilingualRenderingType"/>
@@ -692,6 +746,9 @@
         <optional>
           <attribute name="tag"/>
         </optional>
+        <optional>
+          <attribute name="type"/>
+        </optional>
         <optional>
           <attribute name="multilingual-rendering">
             <ref name="MultilingualRenderingType"/>
@@ -851,6 +908,16 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <choice>
             <ref name="paragraph"/>
@@ -1178,6 +1245,7 @@
       <ref name="concept"/>
       <ref name="add"/>
       <ref name="del"/>
+      <ref name="span"/>
     </choice>
   </define>
   <define name="add">
@@ -1204,6 +1272,14 @@
       </choice>
     </element>
   </define>
+  <define name="span">
+    <element name="span">
+      <attribute name="class"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="concept">
     <element name="concept">
       <optional>
@@ -1994,6 +2070,7 @@
       <value>compare</value>
       <value>contrast</value>
       <value>see</value>
+      <value>seealso</value>
     </choice>
   </define>
   <define name="deprecates">

data/lib/relaton_bib/bib_item_locality.rb

@@ -17,7 +17,7 @@ module RelatonBib
       type_ptrn = %r{section|clause|part|paragraph|chapter|page|whole|table|
         annex|figure|note|list|example|volume|issue|time|
         locality:[a-zA-Z0-9_]+}x
-      unless type.match? type_ptrn
+      unless type&.match? type_ptrn
         warn "[relaton-bib] WARNING: invalid locality type: #{type}"
       end
 

data/lib/relaton_bib/biblio_version.rb

@@ -4,15 +4,12 @@ module RelatonBib
     class Version
       include RelatonBib
 
-      # @return [String, NilClass]
-      attr_reader :revision_date
+      # @return [String, nil]
+      attr_reader :revision_date, :draft
 
-      # @return [Array<String>]
-      attr_reader :draft
-
-      # @param revision_date [String, NilClass]
-      # @param draft [Array<String>]
-      def initialize(revision_date = nil, draft = [])
+      # @param revision_date [String, nil]
+      # @param draft [String, nil]
+      def initialize(revision_date = nil, draft = nil)
         @revision_date = revision_date
         @draft         = draft
       end
@@ -20,8 +17,8 @@ module RelatonBib
       # @param builder [Nokogiri::XML::Builder]
       def to_xml(builder)
         builder.version do
-          builder.send("revision-date", revision_date) if revision_date
-          draft.each { |d| builder.draft d }
+          builder.send(:"revision-date", revision_date) if revision_date
+          builder.draft draft if draft
         end
       end
 
@@ -29,19 +26,19 @@ module RelatonBib
       def to_hash
         hash = {}
         hash["revision_date"] = revision_date if revision_date
-        hash["draft"] = single_element_array(draft) if draft&.any?
+        hash["draft"] = draft if draft
         hash
       end
 
       # @param prefix [String]
       # @return [String]
-      def to_asciibib(prefix = "")
-        pref = prefix.empty? ? prefix : prefix + "."
-        out = ""
+      def to_asciibib(prefix = "", count = 1)
+        pref = prefix.empty? ? prefix : "#{prefix}."
+        out = count > 1 ? "#{prefix}version::\n" : ""
         if revision_date
           out += "#{pref}version.revision_date:: #{revision_date}\n"
         end
-        draft&.each { |d| out += "#{pref}version.draft:: #{d}\n" }
+        out += "#{pref}version.draft:: #{draft}\n" if draft
         out
       end
     end

data/lib/relaton_bib/bibliographic_date.rb

@@ -41,7 +41,8 @@ module RelatonBib
       when :year then parts[0]&.to_i
       when :month then parts[1]&.to_i
       when :day then parts[2]&.to_i
-      else parse_date(d)
+      when :date then parse_date(d)
+      else d
       end
 
       # date.is_a?(Date) ? date.send(part) : date

data/lib/relaton_bib/bibliographic_item.rb

@@ -28,6 +28,7 @@ require "relaton_bib/structured_identifier"
 require "relaton_bib/editorial_group"
 require "relaton_bib/ics"
 require "relaton_bib/bibliographic_size"
+require "relaton_bib/edition"
 
 module RelatonBib
   # Bibliographic item
@@ -41,11 +42,14 @@ module RelatonBib
                webresource dataset archival social_media alert message
                conversation misc].freeze
 
-    # @return [TrueClass, FalseClass, NilClass]
+    # @return [Boolean, nil]
     attr_accessor :all_parts
 
-    # @return [String, NilClass]
-    attr_reader :id, :type, :docnumber, :edition, :doctype, :subdoctype
+    # @return [String, nil]
+    attr_reader :id, :type, :docnumber, :doctype, :subdoctype
+
+    # @return [RelatonBib::Edition, nil] <description>
+    attr_reader :edition
 
     # @!attribute [r] title
     # @return [RelatonBib::TypedTitleStringCollection]
@@ -62,7 +66,7 @@ module RelatonBib
     # @return [Array<RelatonBib::ContributionInfo>]
     attr_reader :contributor
 
-    # @return [RelatonBib::BibliographicItem::Version, NilClass]
+    # @return [Array<RelatonBib::BibliographicItem::Version>]
     attr_reader :version
 
     # @return [RelatonBib::BiblioNoteCollection]
@@ -74,13 +78,13 @@ module RelatonBib
     # @return [Array<String>] script Iso15924 code
     attr_reader :script
 
-    # @return [RelatonBib::FormattedRef, NilClass]
+    # @return [RelatonBib::FormattedRef, nil]
     attr_reader :formattedref
 
     # @!attribute [r] abstract
     #   @return [Array<RelatonBib::FormattedString>]
 
-    # @return [RelatonBib::DocumentStatus, NilClass]
+    # @return [RelatonBib::DocumentStatus, nil]
     attr_reader :status
 
     # @return [Array<RelatonBib::CopyrightAssociation>]
@@ -92,7 +96,7 @@ module RelatonBib
     # @return [Array<RelatonBib::Series>]
     attr_reader :series
 
-    # @return [RelatonBib::Medium, NilClass]
+    # @return [RelatonBib::Medium, nil]
     attr_reader :medium
 
     # @return [Array<RelatonBib::Place>]
@@ -107,7 +111,7 @@ module RelatonBib
     # @return [Array<Relaton::Classification>]
     attr_reader :classification
 
-    # @return [RelatonBib:Validity, NilClass]
+    # @return [RelatonBib:Validity, nil]
     attr_reader :validity
 
     # @return [Date]
@@ -131,18 +135,18 @@ module RelatonBib
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-    # @param id [String, NilClass]
+    # @param id [String, nil]
     # @param title [RelatonBib::TypedTitleStringCollection,
     #   Array<Hash, RelatonBib::TypedTitleString>]
-    # @param formattedref [RelatonBib::FormattedRef, NilClass]
-    # @param type [String, NilClass]
+    # @param formattedref [RelatonBib::FormattedRef, nil]
+    # @param type [String, nil]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
-    # @param docnumber [String, NilClass]
+    # @param docnumber [String, nil]
     # @param language [Arra<String>]
     # @param script [Array<String>]
-    # @param docstatus [RelatonBib::DocumentStatus, NilClass]
-    # @param edition [String, NilClass]
-    # @param version [RelatonBib::BibliographicItem::Version, NilClass]
+    # @param docstatus [RelatonBib::DocumentStatus, nil]
+    # @param edition [RelatonBib::Edition, nil]
+    # @param version [Array<RelatonBib::BibliographicItem::Version>]
     # @param biblionote [RelatonBib::BiblioNoteCollection]
     # @param series [Array<RelatonBib::Series>]
     # @param medium [RelatonBib::Medium, NilClas]
@@ -150,8 +154,8 @@ module RelatonBib
     # @param extent [Array<Relaton::Locality, RelatonBib::LocalityStack>]
     # @param accesslocation [Array<String>]
     # @param classification [Array<RelatonBib::Classification>]
-    # @param validity [RelatonBib:Validity, NilClass]
-    # @param fetched [Date, NilClass] default nil
+    # @param validity [RelatonBib:Validity, nil]
+    # @param fetched [Date, nil] default nil
     # @param keyword [Array<String>]
     # @param doctype [String]
     # @param subdoctype [String]
@@ -163,8 +167,8 @@ module RelatonBib
     # @param copyright [Array<Hash, RelatonBib::CopyrightAssociation>]
     # @option copyright [Array<Hash, RelatonBib::ContributionInfo>] :owner
     # @option copyright [String] :from
-    # @option copyright [String, NilClass] :to
-    # @option copyright [String, NilClass] :scope
+    # @option copyright [String, nil] :to
+    # @option copyright [String, nil] :scope
     #
     # @param date [Array<Hash, RelatonBib::BibliographicDate>]
     # @option date [String] :type
@@ -230,8 +234,12 @@ module RelatonBib
       @id             = args[:id] || makeid(nil, false)
       @type           = args[:type]
       @docnumber      = args[:docnumber]
-      @edition        = args[:edition]
-      @version        = args[:version]
+      @edition        = case args[:edition]
+                        when Hash then Edition.new(**args[:edition])
+                        when String then Edition.new(content: args[:edition])
+                        else args[:edition]
+                        end
+      @version        = args.fetch :version, []
       @biblionote     = args.fetch :biblionote, BiblioNoteCollection.new([])
       @language       = args.fetch :language, []
       @script         = args.fetch :script, []
@@ -321,7 +329,7 @@ module RelatonBib
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [Boolean] :bibdata
-    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [Symbol, nil] :date_format (:short), :full
     # @option opts [String, Symbol] :lang language
     # @return [String] XML
     def to_xml(**opts, &block)
@@ -365,8 +373,8 @@ module RelatonBib
       if contributor&.any?
         hash["contributor"] = single_element_array(contributor)
       end
-      hash["edition"] = edition if edition
-      hash["version"] = version.to_hash if version
+      hash["edition"] = edition.to_hash if edition
+      hash["version"] = version.map &:to_hash if version.any?
       hash["revdate"] = revdate if revdate
       hash["biblionote"] = single_element_array(biblionote) if biblionote&.any?
       hash["language"] = single_element_array(language) if language&.any?
@@ -493,10 +501,10 @@ module RelatonBib
     end
 
     # If revision_date exists then returns it else returns published date or nil
-    # @return [String, NilClass]
+    # @return [String, nil]
     def revdate # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-      @revdate ||= if version&.revision_date
-                     version.revision_date
+      @revdate ||= if (v = version.detect &:revision_date)
+                     v.revision_date
                    else
                      date.detect { |d| d.type == "published" }&.on&.to_s
                    end
@@ -515,10 +523,10 @@ module RelatonBib
         out += di.to_asciibib prefix, docidentifier.size
       end
       out += "#{pref}docnumber:: #{docnumber}\n" if docnumber
-      out += "#{pref}edition:: #{edition}\n" if edition
+      out += edition.to_asciibib(prefix) if edition
       language.each { |l| out += "#{pref}language:: #{l}\n" }
       script.each { |s| out += "#{pref}script:: #{s}\n" }
-      out += version.to_asciibib prefix if version
+      version.each { |v| out += v.to_asciibib prefix, version.size }
       biblionote&.each { |b| out += b.to_asciibib prefix, biblionote.size }
       out += status.to_asciibib prefix if status
       date.each { |d| out += d.to_asciibib prefix, date.size }
@@ -565,7 +573,7 @@ module RelatonBib
       item.type = bibtex_type
       item.key = id
       title.to_bibtex item
-      item.edition = edition if edition
+      item.edition = edition.content if edition
       bibtex_author item
       bibtex_contributor item
       item.address = place.first.name if place.any?
@@ -719,7 +727,7 @@ module RelatonBib
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [Boolean] bibdata
-    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [Symbol, nil] :date_format (:short), :full
     # @option opts [String] :lang language
     def render_xml(**opts)
       root = opts[:bibdata] ? :bibdata : :bibitem
@@ -737,8 +745,8 @@ module RelatonBib
             c.to_xml(**opts)
           end
         end
-        builder.edition edition if edition
-        version&.to_xml builder
+        edition&.to_xml builder
+        version.each { |v| v.to_xml builder }
         biblionote.to_xml(**opts)
         opts[:note]&.each do |n|
           builder.note(n[:text], format: "text/plain", type: n[:type])
@@ -790,7 +798,8 @@ module RelatonBib
     def render_bibxml(builder, include_keywords)
       target = link.detect { |l| l.type.casecmp("src").zero? } ||
         link.detect { |l| l.type.casecmp("doi").zero? }
-      bxml = if docnumber&.match(/^BCP/) || docidentifier[0].id.include?("BCP")
+      bxml = if docnumber&.match(/^BCP/) || (docidentifier.detect(&:primary)&.id ||
+                  docidentifier[0].id).include?("BCP")
                render_bibxml_refgroup(builder, include_keywords)
              else
                render_bibxml_ref(builder, include_keywords)
@@ -820,13 +829,17 @@ module RelatonBib
     #
     def render_bibxml_ref(builder, include_keywords)
       builder.reference(**ref_attrs) do |xml|
-        xml.front do
-          xml.title title[0].title.content if title.any?
-          render_authors xml
-          render_date xml
-          render_workgroup xml
-          render_keyword xml if include_keywords
-          render_abstract xml
+        if title.any? || contributor.any? || date.any? || abstract.any? ||
+            editorialgroup&.technical_committee&.any? ||
+            (include_keywords && keyword.any?)
+          xml.front do
+            xml.title title[0].title.content if title.any?
+            render_authors xml
+            render_date xml
+            render_workgroup xml
+            render_keyword xml if include_keywords
+            render_abstract xml
+          end
         end
         render_seriesinfo xml
         render_format xml

data/lib/relaton_bib/bibxml_parser.rb

@@ -12,6 +12,16 @@ module RelatonBib
       "3GPP" => "3rd Generation Partnership Project",
     }.freeze
 
+    #
+    # Parse BibXML content
+    #
+    # @param [String] bibxml content
+    # @param [String, nil] url source URL
+    # @param [Boolean] is_relation true if the content is relation item
+    # @param [String, nil] ver version
+    #
+    # @return [<Type>] <description>
+    #
     def parse(bibxml, url: nil, is_relation: false, ver: nil)
       doc = Nokogiri::XML bibxml
       fetch_rfc doc.at("/referencegroup", "/reference"), url: url, is_relation: is_relation, ver: ver

data/lib/relaton_bib/document_identifier.rb

@@ -4,21 +4,24 @@ module RelatonBib
     # @return [String]
     attr_reader :id
 
-    # @return [String, NilClass]
-    attr_reader :type, :scope
+    # @return [String, nil]
+    attr_reader :type, :scope, :language, :script
 
     # @param type [Boolean, nil]
     attr_reader :primary
 
     # @param id [String]
-    # @param type [String, NilClass]
-    # @param scope [String, NilClass]
-    # @param priority [Bolean]
-    def initialize(id:, type: nil, scope: nil, primary: false)
-      @id    = id
-      @type  = type
-      @scope = scope
-      @primary = primary
+    # @param type [String, nil]
+    # @param scope [String, nil]
+    # @param primary [Bolean, nil]
+    # @param language [String, nil]
+    def initialize(**args)
+      @id       = args[:id]
+      @type     = args[:type]
+      @scope    = args[:scope]
+      @primary  = args[:primary]
+      @language = args[:language]
+      @script   = args[:script]
     end
 
     # in docid manipulations, assume ISO as the default: id-part:year
@@ -53,7 +56,7 @@ module RelatonBib
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [String] :lang language
-    def to_xml(**opts) # rubocop:disable Metrics/AbcSize
+    def to_xml(**opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       lid = if type == "URN" && opts[:lang]
               id.sub %r{(?<=:)(?:\w{2},)*?(#{opts[:lang]})(?:,\w{2})*}, '\1'
             else id
@@ -62,14 +65,18 @@ module RelatonBib
       element[:type] = type if type
       element[:scope] = scope if scope
       element[:primary] = primary if primary
+      element[:language] = language if language
+      element[:script] = script if script
     end
 
     # @return [Hash]
-    def to_hash
+    def to_hash # rubocop:disable Metrics/AbcSize
       hash = { "id" => id }
       hash["type"] = type if type
       hash["scope"] = scope if scope
       hash["primary"] = primary if primary
+      hash["language"] = language if language
+      hash["script"] = script if script
       hash
     end
 
@@ -84,6 +91,8 @@ module RelatonBib
       out += "#{pref}docid.type:: #{type}\n" if type
       out += "#{pref}docid.scope:: #{scope}\n" if scope
       out += "#{pref}docid.primary:: #{primary}\n" if primary
+      out += "#{pref}docid.language:: #{language}\n" if language
+      out += "#{pref}docid.script:: #{script}\n" if script
       out + "#{pref}docid.id:: #{id}\n"
     end
 

data/lib/relaton_bib/edition.rb

@@ -0,0 +1,55 @@
+module RelatonBib
+  class Edition
+    # @return [String] edition
+    attr_reader :content
+
+    # @return [String, nil] number
+    attr_reader :number
+
+    #
+    # Initialize edition.
+    #
+    # @param [String] content edition
+    # @param [String, nil] number number
+    #
+    def initialize(content:, number: nil)
+      @content = content
+      @number = number
+    end
+
+    #
+    # Render edition as XML.
+    #
+    # @param [Nokogiri::XML::Builder] builder XML builder
+    #
+    def to_xml(builder)
+      node = builder.edition(content)
+      node[:number] = number if number
+    end
+
+    #
+    # Return edition as hash.
+    #
+    # @return [Hash] edition as hash.
+    #
+    def to_hash
+      hash = { "content" => content }
+      hash["number"] = number if number
+      hash
+    end
+
+    #
+    # Render edition as AsciiBib.
+    #
+    # @param [String] prefix prefix
+    #
+    # @return [String] edition as AsciiBib.
+    #
+    def to_asciibib(prefix = "")
+      pref = prefix.empty? ? "edition" : "#{prefix}.edition"
+      out = "#{pref}.content:: #{content}\n"
+      out += "#{pref}.number:: #{number}\n" if number
+      out
+    end
+  end
+end