relaton-ieee 1.9.1 → 1.10.0

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_ieee/bibxml_parser.rb

@@ -0,0 +1,23 @@
+module RelatonIeee
+  module BibXMLParser
+    extend RelatonBib::BibXMLParser
+    extend BibXMLParser
+
+    # @param attrs [Hash]
+    # @return [RelatonBib::IetfBibliographicItem]
+    def bib_item(**attrs)
+      IeeeBibliographicItem.new(**attrs)
+    end
+
+    #
+    # Return PubID type
+    #
+    # @param [String] _ docidentifier
+    #
+    # @return [String] type
+    #
+    def pubid_type(_)
+      "IEEE"
+    end
+  end
+end

data/lib/relaton_ieee/data_fetcher.rb

@@ -1,5 +1,6 @@
 require "zip"
 require "relaton_ieee/data_parser"
+require "relaton_ieee/rawbib_id_parser"
 
 module RelatonIeee
   class DataFetcher
@@ -27,8 +28,10 @@ module RelatonIeee
     def initialize(output, format)
       @output = output
       @format = format
+      @ext = format.sub(/^bib/, "")
       @crossrefs = {}
       @backrefs = {}
+      # @normtitles = []
     end
 
     #
@@ -63,6 +66,7 @@ module RelatonIeee
         warn e.message
         warn e.backtrace
       end
+      # File.write "normtitles.txt", @normtitles.join("\n")
       update_relations
     end
 
@@ -86,20 +90,33 @@ module RelatonIeee
     # @param [String] xml content
     # @param [String] filename source file
     #
-    def fetch_doc(xml, filename) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def fetch_doc(xml, filename) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       doc = Nokogiri::XML(xml).at("/publication")
       unless doc
         warn "Empty file: #{filename}"
         return
       end
+      stdid = doc.at("./publicationinfo/standard_id").text
+      if stdid == "0"
+        # nt = doc&.at("./normtitle")&.text
+        # ntid = @normtitles.index nt
+        # @normtitles << nt if nt && !ntid
+        warn "Zero standard_id in #{filename}"
+        return
+      end
       bib = DataParser.parse doc, self
+      if bib.docnumber.nil?
+        nt = doc&.at("./normtitle")&.text
+        warn "PubID parse error. Normtitle: #{nt}, file: #{filename}"
+        return
+      end
       amsid = doc.at("./publicationinfo/amsid").text
       if backrefs.value?(bib.docidentifier[0].id) && /updates\.\d+/ !~ filename
         oamsid = backrefs.key bib.docidentifier[0].id
         warn "Document exists ID: \"#{bib.docidentifier[0].id}\" AMSID: "\
              "\"#{amsid}\" source: \"#{filename}\". Other AMSID: \"#{oamsid}\""
-        if bib.docidentifier[0].id.include?(bib.docnumber)
-          save_doc bib # rewrite file if the PubID mathces to the docnumber
+        if bib.docidentifier[0].id.include?(doc.at("./publicationinfo/stdnumber").text)
+          save_doc bib # rewrite file if the PubID matches to the stdnumber
           backrefs[amsid] = bib.docidentifier[0].id
         end
       else
@@ -130,7 +147,11 @@ module RelatonIeee
     # @param [RelatonIeee::IeeeBibliographicItem] bib
     #
     def save_doc(bib)
-      c = @format == "xml" ? bib.to_xml(bibdata: true) : bib.to_hash.to_yaml
+      c = case @format
+          when "xml" then bib.to_xml(bibdata: true)
+          when "yaml" then bib.to_hash.to_yaml
+          else bib.send("to_#{@format}")
+          end
       File.write file_name(bib.docnumber), c, encoding: "UTF-8"
     end
 
@@ -142,8 +163,8 @@ module RelatonIeee
     # @return [String] filename
     #
     def file_name(docnumber)
-      name = docnumber.gsub(/[.\s,:\/]/, "_").squeeze("_").upcase
-      File.join @output, "#{name}.#{@format}"
+      name = docnumber.gsub(/\s-/, "-").gsub(/[\s,:\/]/, "_").squeeze("_").upcase
+      File.join @output, "#{name}.#{@ext}"
     end
 
     #
@@ -198,7 +219,9 @@ module RelatonIeee
     #
     def read_bib(docnumber)
       c = File.read file_name(docnumber), encoding: "UTF-8"
-      if @format == "xml" then XMLParser.from_xml c
+      case @format
+      when "xml" then XMLParser.from_xml c
+      when "bibxml" then BibXMLParser.parse c
       else IeeeBibliographicItem.from_hash YAML.safe_load(c)
       end
     end

data/lib/relaton_ieee/data_parser.rb

@@ -57,11 +57,15 @@ module RelatonIeee
     #
     # Parse title
     #
-    # @return [RelatonBib::TypedTitleStringCollection]
+    # @return [Array<RelatonBib::TypedTitleString>]
     #
     def parse_title
-      t = doc.at("./volume/article/title").text
-      RelatonBib::TypedTitleString.from_string t
+      t = []
+      content = doc.at("./volume/article/title").text
+      if content =~ /\A(.+)\s-\sredline\z/i
+        t << RelatonBib::TypedTitleString.new(content: $1, type: "title-main")
+      end
+      t << RelatonBib::TypedTitleString.new(content: content, type: "main")
     end
 
     #
@@ -110,7 +114,7 @@ module RelatonIeee
     # @return [Array<RelatonBib::DocumentIdentifier>]
     #
     def parse_docid
-      ids = [{ id: doc.at("./title").text, type: "IEEE" }]
+      ids = [{ id: pubid.to_s, type: "IEEE" }]
       isbn = doc.at("./publicationinfo/isbn")
       ids << { id: isbn.text, type: "ISBN" } if isbn
       doi = doc.at("./volume/article/articleinfo/articledoi")
@@ -120,13 +124,20 @@ module RelatonIeee
       end
     end
 
+    def pubid
+      @pubid ||= begin
+        nt = doc.at("./normtitle").text
+        RawbibIdParser.parse(nt)
+      end
+    end
+
     #
     # Parse docnumber
     #
     # @return [String] PubID
     #
     def docnumber
-      @docnumber ||= doc.at("./publicationinfo/stdnumber").text
+      @docnumber ||= pubid&.to_id # doc.at("./publicationinfo/stdnumber").text
     end
 
     #
@@ -223,7 +234,8 @@ module RelatonIeee
         if (ref = fetcher.backrefs[r.text])
           rel = fetcher.create_relation(r[:type], ref)
           rels << rel if rel
-        elsif !/Inactive Date/.match?(r) then fetcher.add_crossref(docnumber, r)
+        elsif !/Inactive Date/.match?(r) && docnumber
+          fetcher.add_crossref(docnumber, r)
         end
       end
       RelatonBib::DocRelationCollection.new rels

data/lib/relaton_ieee/hit_collection.rb

@@ -11,23 +11,27 @@ module RelatonIeee
 
     # rubocop:disable Metrics/AbcSize
 
-    # @param ref [Strig]
+    # @param reference [Strig]
     # @param opts [Hash]
-    def initialize(ref) # rubocop:disable Metrics/MethodLength
+    def initialize(reference) # rubocop:disable Metrics/MethodLength
       super
-      code = ref.sub(/^IEEE\s(Std\s)?/, "")
-      search = CGI.escape({ data: { searchTerm: code } }.to_json)
-      url = "#{DOMAIN}/bin/standards/search?data=#{search}"
-      resp = Faraday.get url
-      resp_json = JSON.parse resp.body
-      json = JSON.parse resp_json["message"]
-      @array = json["response"]["searchResults"]["resultsMapList"]
-        .reduce([]) do |s, hit|
-          /^(?:\w+\s)?(?<id>[A-Z\d.]+)(?:-(?<year>\d{4}))?/ =~ hit["record"]["recordTitle"]
-          next s unless id && code =~ %r{^#{id}}
+      code1 = reference.sub(/^IEEE\s(Std\s)?/, "")
+      url = "#{DOMAIN}/wp-admin/admin-ajax.php"
+      query = reference.gsub("/", " ")
+      resp = Faraday.post url, { action: "ieee_cloudsearch", q: query }
+      json = JSON.parse resp.body
+      html = Nokogiri::HTML json["html"]
+      # @array = json["results"]["hits"]["hit"].reduce([]) do |s, hit|
+      @array = html.xpath("//h4/a").reduce([]) do |s, hit|
+        # fields = hit["fields"]
+        # ref = html.at("//h4/a[@href='#{fields['doc_id_l']}']").text.strip
+        ref = hit.text.strip
+        /^(?:\w+\s)?(?<code2>[A-Z\d.]+)(?:-(?<year>\d{4}))?/ =~ ref
+        next s unless code2 && code1 =~ %r{^#{code2}}
 
-          s << Hit.new(hit["record"].merge(code: id, year: year.to_i), self)
-        end.sort_by { |h| h.hit[:year].to_s + h.hit["recordURL"] }.reverse
+        hit_data = { ref: ref, year: year.to_i, url: hit[:href] }
+        s << Hit.new(hit_data, self)
+      end.sort_by { |h| h.hit[:year].to_s + h.hit[:url] }.reverse
     end
     # rubocop:enable Metrics/AbcSize
   end

data/lib/relaton_ieee/ieee_bibliography.rb

@@ -15,7 +15,7 @@ module RelatonIeee
       #
       # @return [Hash, NilClass] returns { ret: RelatonBib::BibliographicItem }
       #   if document is found else returns NilClass
-      def get(code, year = nil, _opts = {})
+      def get(code, year = nil, _opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         warn "[relaton-ieee] (\"#{code}\") fetching..."
         result = search(code) || (return nil)
         year ||= code.match(/(?<=-)\d{4}/)&.to_s
@@ -42,11 +42,11 @@ module RelatonIeee
       # @param opts [Hash] options
       #
       # @return [Hash]
-      def bib_results_filter(result, ref, year)
+      def bib_results_filter(result, ref, year) # rubocop:disable Metrics/AbcSize
         rp1 = ref_parts ref
         missed_years = []
         result.each do |hit|
-          rp2 = ref_parts hit.hit["recordTitle"]
+          rp2 = ref_parts hit.hit[:ref]
           next if rp1[:code] != rp2[:code] || rp1[:corr] != rp2[:corr]
 
           return { ret: hit } if !year

data/lib/relaton_ieee/pub_id.rb

@@ -0,0 +1,149 @@
+module RelatonIeee
+  class PubId
+    class Id
+      # @return [String]
+      attr_reader :number
+
+      # @return [String, nil]
+      attr_reader :publisher, :stage, :part, :status, :approval, :edition,
+                  :draft, :rev, :corr, :amd, :redline, :year, :month
+
+      #
+      # PubId constructor
+      #
+      # @param [String] number
+      # @param [<Hash>] **args
+      # @option args [String] :number
+      # @option args [String] :publisher
+      # @option args [String] :stage
+      # @option args [String] :part
+      # @option args [String] :status
+      # @option args [String] :approval
+      # @option args [String] :edition
+      # @option args [String] :draft
+      # @option args [String] :rev
+      # @option args [String] :corr
+      # @option args [String] :amd
+      # @option args [Boolean] :redline
+      # @option args [String] :year
+      # @option args [String] :month
+      #
+      def initialize(number:, **args) # rubocop:disable Metrics/MethodLength
+        @publisher = args[:publisher]
+        @stage = args[:stage]
+        @number = number
+        @part = args[:part]
+        @status = args[:status]
+        @approval = args[:approval]
+        @edition = args[:edition]
+        @draft = args[:draft]
+        @rev = args[:rev]
+        @corr = args[:corr]
+        @amd = args[:amd]
+        @year = args[:year]
+        @month = args[:month]
+        @redline = args[:redline]
+      end
+
+      #
+      # PubId string representation
+      #
+      # @return [String]
+      #
+      def to_s # rubocop:disable Metrics/AbcSize
+        out = number
+        out = "#{stage} #{out}" if stage
+        out = "#{approval} #{out}" if approval
+        out = "#{status} #{out}" if status
+        out = "#{publisher} #{out}" if publisher
+        out += "-#{part}" if part
+        out += edition_to_s + draft_to_s + rev_to_s + corr_to_s + amd_to_s
+        out + year_to_s + month_to_s + redline_to_s
+      end
+
+      def edition_to_s
+        edition ? "/E-#{edition}" : ""
+      end
+
+      def draft_to_s
+        draft ? "/D-#{draft}" : ""
+      end
+
+      def rev_to_s
+        rev ? "/R-#{rev}" : ""
+      end
+
+      def corr_to_s
+        corr ? "/Cor#{corr}" : ""
+      end
+
+      def amd_to_s
+        amd ? "/Amd#{amd}" : ""
+      end
+
+      def year_to_s
+        year ? ".#{year}" : ""
+      end
+
+      def month_to_s
+        month ? "-#{month}" : ""
+      end
+
+      def redline_to_s
+        redline ? " Redline" : ""
+      end
+    end
+
+    # @return [Array<RelatonIeee::PubId::Id>]
+    attr_reader :pubid
+
+    #
+    # IEEE publication id
+    #
+    # @param [Array<Hash>, Hash] pubid
+    #
+    def initialize(pubid)
+      @pubid = array(pubid).map { |id| Id.new(**id) }
+    end
+
+    #
+    # Convert to array
+    #
+    # @param [Array<Hash>, Hash] pid
+    #
+    # @return [Array<Hash>]
+    #
+    def array(pid)
+      pid.is_a?(Array) ? pid : [pid]
+    end
+
+    #
+    # PubId string representation
+    #
+    # @return [String]
+    #
+    def to_s
+      pubid.map(&:to_s).join("/")
+    end
+
+    #
+    # Generate ID without publisher and second number
+    #
+    # @return [String]
+    #
+    def to_id # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      out = pubid[0].to_s
+      if pubid.size > 1
+        out += pubid[1].edition_to_s if pubid[0].edition.nil?
+        out += pubid[1].draft_to_s if pubid[0].draft.nil?
+        out += pubid[1].rev_to_s if pubid[0].rev.nil?
+        out += pubid[1].corr_to_s if pubid[0].corr.nil?
+        out += pubid[1].amd_to_s if pubid[0].amd.nil?
+        out += pubid[1].year_to_s if pubid[0].year.nil?
+        out += pubid[1].month_to_s if pubid[0].month.nil?
+        out += pubid[1].redline_to_s unless pubid[0].redline
+      end
+      out
+    end
+  end
+end