relaton-bib 1.9.23 → 1.10.3

data/grammars/reqt.rng

@@ -58,15 +58,23 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>
     <optional>
       <ref name="label"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="subject"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="reqinherit"/>
     </zeroOrMore>
@@ -80,6 +88,7 @@
         <ref name="verification"/>
         <ref name="import"/>
         <ref name="description"/>
+        <ref name="component"/>
       </choice>
     </zeroOrMore>
     <optional>
@@ -100,17 +109,23 @@
   </define>
   <define name="label">
     <element name="label">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="subject">
     <element name="subject">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="reqinherit">
     <element name="inherit">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="measurementtarget">
@@ -138,6 +153,12 @@
       <ref name="RequirementSubpart"/>
     </element>
   </define>
+  <define name="component">
+    <element name="component">
+      <attribute name="class"/>
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
   <define name="reqt_references">
     <element name="references">
       <oneOrMore>
@@ -164,6 +185,14 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/relaton_bib/bibliographic_item.rb

@@ -809,9 +809,21 @@ module RelatonBib
           render_abstract xml
         end
         render_seriesinfo xml
+        render_format xml
       end
     end
 
+    def render_format(builder)
+      link.select { |l| l.type == "TXT" }.each do |l|
+        builder.format type: l.type, target: l.content
+      end
+    end
+
+    #
+    # Create reference attributes
+    #
+    # @return [Hash<Symbol=>String>] attributes
+    #
     def ref_attrs
       discopes = %w[anchor docName number]
       attrs = docidentifier.each_with_object({}) do |di, h|
@@ -826,24 +838,42 @@ module RelatonBib
       end
     end
 
+    #
+    # Render keyword
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    #
     def render_keyword(builder)
       keyword.each { |kw| builder.keyword kw.content }
     end
 
+    #
+    # Render workgroup
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    #
     def render_workgroup(builder)
       editorialgroup&.technical_committee&.each do |tc|
         builder.workgroup tc.workgroup.name
       end
     end
 
-    # @param [Nokogiri::XML::Builder] builder
+    #
+    # Render abstract
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    #
     def render_abstract(builder)
       return unless abstract.any?
 
       builder.abstract { |xml| xml << abstract[0].content.gsub(/(<\/?)p(>)/, '\1t\2') }
     end
 
-    # @param [Nokogiri::XML::Builder] builder
+    #
+    # Render date
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    #
     def render_date(builder)
       dt = date.detect { |d| d.type == "published" }
       return unless dt
@@ -860,7 +890,11 @@ module RelatonBib
       # end
     end
 
-    # @param [Nokogiri::XML::Builder] builder
+    #
+    # Render seriesinfo
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    #
     def render_seriesinfo(builder)
       docidentifier.each do |di|
         if BibXMLParser::SERIESINFONAMES.include? di.type
@@ -877,7 +911,11 @@ module RelatonBib
       end
     end
 
-    # @param [Nokogiri::XML::Builder] builder
+    #
+    # Render authors
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    #
     def render_authors(builder)
       contributor.each do |c|
         builder.author do |xml|
@@ -890,8 +928,12 @@ module RelatonBib
       end
     end
 
-    # @param [Nokogiri::XML::Builder] builder
-    # @param [RelatonBib::ContributionInfo] contrib
+    #
+    # Render address
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    # @param [RelatonBib::ContributionInfo] contrib contributor
+    #
     def render_address(builder, contrib)
       # addr = contrib.entity.contact.reject do |cn|
       #   cn.is_a?(Address) && cn.postcode.nil?
@@ -913,8 +955,12 @@ module RelatonBib
       end
     end
 
-    # @param [Nokogiri::XML::Builder] builder
-    # @param [Array<RelatonBib::Address, RelatonBib::Contact>] addr
+    #
+    # Render contact
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    # @param [Array<RelatonBib::Address, RelatonBib::Contact>] addr contact
+    #
     def render_contact(builder, addr)
       %w[phone email uri].each do |type|
         cont = addr.detect { |cn| cn.is_a?(Contact) && cn.type == type }
@@ -922,8 +968,12 @@ module RelatonBib
       end
     end
 
-    # @param [Nokogiri::XML::Builder] builder
-    # @param [RelatonBib::Person] person
+    #
+    # Render person
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    # @param [RelatonBib::Person] person person
+    #
     def render_person(builder, person)
       render_organization builder, person.affiliation.first&.organization
       if person.name.completename
@@ -946,8 +996,12 @@ module RelatonBib
       end
     end
 
-    # @param [Nokogiri::XML::Builder] builder
-    # @param [RelatonBib::Organization] org
+    #
+    # Render organization
+    #
+    # @param [Nokogiri::XML::Builder] builder xml builder
+    # @param [RelatonBib::Organization] org organization
+    #
     def render_organization(builder, org)
       # return unless org
 

data/lib/relaton_bib/bibxml_parser.rb

@@ -8,6 +8,7 @@ module RelatonBib
     ORGNAMES = {
       "IEEE" => "Istitute of Electrical and Electronics Engineers",
       "W3C" => "World Wide Web Consortium",
+      "3GPP" => "3rd Generation Partnership Project",
     }.freeze
 
     def parse(bibxml, url: nil, is_relation: false, ver: nil)
@@ -74,39 +75,18 @@ module RelatonBib
     #
     def docids(reference, ver) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize
       ret = []
-      # sfid = reference.at("./seriesInfo[@name='#{self::FLAVOR}']",
-      #                     "./front/seriesInfo[@name='#{self::FLAVOR}']")
-      # if sfid
-      #   type = sfid[:name]
-      #   id = sfid[:value]
-      #   # scope = "series"
-      # else # if self::FLAVOR
-        # id, scope = if reference[:anchor] then [reference[:anchor], "anchor"]
-        #             elsif reference[:docName] then [reference[:docName], "docName"]
-        #             elsif reference[:number] then [reference[:number], "number"]
-        #             end
       id = reference["anchor"] || reference["docName"] || reference["number"]
-      type_match = id&.match(/^(3GPP|W3C|[A-Z]{2,})(?:\.(?=[A-Z])|(?=\d))/)
-      type = self::FLAVOR || (type_match && type_match[1])
       if id
         /^(?<pref>I-D|3GPP|W3C|[A-Z]{2,})[._]?(?<num>.+)/ =~ id
         num.sub!(/^-?0+/, "") if %w[RFC BCP FYI STD].include?(pref)
         pid = pref ? "#{pref} #{num}" : id
-        ret << DocumentIdentifier.new(type: type, id: pid)
+        ret << DocumentIdentifier.new(type: pubid_type(id), id: pid, primary: true)
       end
       %w[anchor docName number].each do |atr|
         if reference[atr]
-          ret << DocumentIdentifier.new(id: reference[atr], type: type, scope: atr)
+          ret << DocumentIdentifier.new(id: reference[atr], type: pubid_type(id), scope: atr)
         end
       end
-      # end
-      # if id
-      #   ret << DocumentIdentifier.new(type: type, id: id)
-      #   ret << DocumentIdentifier.new(type: type, id: id, scope: scope) if scope
-      # end
-      # if (id = reference[:anchor])
-      #   ret << DocumentIdentifier.new(type: "rfc-anchor", id: id)
-      # end
       ret + reference.xpath("./seriesInfo", "./front/seriesInfo").map do |si|
         next unless SERIESINFONAMES.include? si[:name]
 
@@ -116,6 +96,18 @@ module RelatonBib
       end.compact
     end
 
+    #
+    # Extract document identifier type from identifier
+    #
+    # @param [String] id identifier
+    #
+    # @return [String]
+    #
+    def pubid_type(id)
+      type_match = id&.match(/^(3GPP|W3C|[A-Z]{2,})(?:\.(?=[A-Z])|(?=\d))/)
+      type_match && type_match[1]
+    end
+
     #
     # extract status
     # @param reference [Nokogiri::XML::Element]
@@ -346,7 +338,7 @@ module RelatonBib
       # return 1 if !mon || mon.empty?
       return mon if /^\d+$/.match? mon
 
-      Date::MONTHNAMES.index(mon).to_s.rjust 2, "0"
+      Date::MONTHNAMES.index { |m| m&.include? mon }.to_s.rjust 2, "0"
     end
 
     #

data/lib/relaton_bib/copyright_association.rb

@@ -33,7 +33,7 @@ module RelatonBib
         o.is_a?(Hash) ? ContributionInfo.new(entity: Organization.new(**o)) : o
       end
 
-      @from  = Date.strptime(from.to_s, "%Y") if from.to_s.match? /\d{4}/
+      @from  = Date.strptime(from.to_s, "%Y") if from.to_s.match?(/\d{4}/)
       @to    = Date.strptime(to.to_s, "%Y") unless to.to_s.empty?
       @scope = scope
     end
@@ -45,7 +45,7 @@ module RelatonBib
       opts[:builder].copyright do |builder|
         builder.from from ? from.year : "unknown"
         builder.to to.year if to
-        owner.each { |o| builder.owner { o.to_xml **opts } }
+        owner.each { |o| builder.owner { o.to_xml(**opts) } }
         builder.scope scope if scope
       end
     end

data/lib/relaton_bib/document_identifier.rb

@@ -7,13 +7,18 @@ module RelatonBib
     # @return [String, NilClass]
     attr_reader :type, :scope
 
+    # @param type [Boolean, nil]
+    attr_reader :primary
+
     # @param id [String]
     # @param type [String, NilClass]
     # @param scope [String, NilClass]
-    def initialize(id:, type: nil, scope: nil)
+    # @param priority [Bolean]
+    def initialize(id:, type: nil, scope: nil, primary: false)
       @id    = id
       @type  = type
       @scope = scope
+      @primary = primary
     end
 
     # in docid manipulations, assume ISO as the default: id-part:year
@@ -56,6 +61,7 @@ module RelatonBib
       element = opts[:builder].docidentifier lid
       element[:type] = type if type
       element[:scope] = scope if scope
+      element[:primary] = primary if primary
     end
 
     # @return [Hash]
@@ -63,19 +69,21 @@ module RelatonBib
       hash = { "id" => id }
       hash["type"] = type if type
       hash["scope"] = scope if scope
+      hash["primary"] = primary if primary
       hash
     end
 
     # @param prefix [String]
     # @param count [Integer] number of docids
     # @return [String]
-    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/CyclomaticComplexity
+    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
       pref = prefix.empty? ? prefix : "#{prefix}."
       return "#{pref}docid:: #{id}\n" unless type || scope
 
       out = count > 1 ? "#{pref}docid::\n" : ""
       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.id:: #{id}\n"
     end
 

data/lib/relaton_bib/document_relation.rb

@@ -42,7 +42,7 @@ module RelatonBib
     # @param locality [Array<RelatonBib::Locality, RelatonBib::LocalityStack>]
     # @param source_locality [Array<RelatonBib::SourceLocality,
     #   RelatonBib::SourceLocalityStack>]
-    def initialize(type:, description: nil, bibitem:, locality: [],
+    def initialize(type:, bibitem:, description: nil, locality: [],
                    source_locality: [])
       type = "obsoletes" if type == "Now withdrawn"
       unless self.class::TYPES.include? type

data/lib/relaton_bib/hash_converter.rb

@@ -126,8 +126,9 @@ module RelatonBib
         ret[:docid] = array(ret[:docid])
         ret[:docid]&.each_with_index do |id, i|
           type = id[:type] || id[:id].match(/^\w+(?=\s)/)&.to_s
-          ret[:docid][i] = DocumentIdentifier.new(id: id[:id], type: type,
-                                                  scope: id[:scope])
+          ret[:docid][i] = DocumentIdentifier.new(
+            id: id[:id], type: type, scope: id[:scope], primary: id[:primary],
+          )
         end
       end
 

data/lib/relaton_bib/localized_string.rb

@@ -73,7 +73,7 @@ module RelatonBib
         hash["language"] = single_element_array(language) if language&.any?
         hash["script"] = single_element_array(script) if script&.any?
         hash
-      else content.map &:to_hash
+      else content&.map &:to_hash
       end
     end
 

data/lib/relaton_bib/person.rb

@@ -13,8 +13,8 @@ module RelatonBib
     # @return [Array<RelatonBib::LocalizedString>]
     attr_accessor :initial
 
-    # @return [RelatonBib::LocalizedString]
-    attr_accessor :surname
+    # @return [RelatonBib::LocalizedString, nil]
+    attr_accessor :surname, :completename
 
     # @return [Array<RelatonBib::LocalizedString>]
     attr_accessor :addition
@@ -22,15 +22,14 @@ module RelatonBib
     # @return [Array<RelatonBib::LocalizedString>]
     attr_accessor :prefix
 
-    # @return [RelatonBib::LocalizedString]
-    attr_reader :completename
-
-    # @param surname [RelatonBib::LocalizedString]
+    # @param surname [RelatonBib::LocalizedString, nil] surname or completename
+    #   should be present
     # @param forename [Array<RelatonBib::LocalizedString>]
     # @param initial [Array<RelatonBib::LocalizedString>]
     # @param addition [Array<RelatonBib::LocalizedString>]
     # @param prefix [Array<RelatonBib::LocalizedString>]
-    # @param completename [RelatonBib::LocalizedString]
+    # @param completename [RelatonBib::LocalizedString, nil] completename or
+    #   surname should be present
     def initialize(**args)
       unless args[:surname] || args[:completename]
         raise ArgumentError, "Should be given :surname or :completename"

data/lib/relaton_bib/validity.rb

@@ -1,6 +1,6 @@
 module RelatonBib
   class Validity
-    FORMAT = "%Y-%m-%d %H:%M"
+    FORMAT = "%Y-%m-%d %H:%M".freeze
 
     # @return [Time, NilClass]
     attr_reader :begins
@@ -41,7 +41,7 @@ module RelatonBib
     # @param prefix [String]
     # @return [String]
     def to_asciibib(prefix = "")
-      pref = prefix.empty? ? "validity." : prefix + ".validity."
+      pref = prefix.empty? ? "validity." : "#{prefix}.validity."
       out = ""
       out += "#{pref}begins:: #{begins.strftime(FORMAT)}\n" if begins
       out += "#{pref}ends:: #{ends.strftime(FORMAT)}\n" if ends

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.9.23".freeze
+  VERSION = "1.10.3".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -161,8 +161,9 @@ module RelatonBib
       # @return [Array<RelatonBib::DocumentIdentifier>]
       def fetch_docid(item)
         item.xpath("./docidentifier").map do |did|
+          primary = true if did[:primary] == "true"
           DocumentIdentifier.new(id: did.text, type: did[:type],
-                                 scope: did[:scope])
+                                 scope: did[:scope], primary: primary)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.9.23
+  version: 1.10.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug