relaton-iec 0.8.0 → 1.1.0

data/grammars/reqt.rng

@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="unnumbered">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="subsequence"/>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="inherit">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/relaton_iec.rb

@@ -1,14 +1,17 @@
 require "relaton_iec/version"
 require "relaton_iec/iec_bibliography"
-
-# if defined? Relaton
-#   require "relaton_iec/processor"
-#   # don't register the gem if it's required form relaton's registry
-#   return if caller.detect { |c| c.include? "register_gems" }
-
-#   Relaton::Registry.instance.register(RelatonIec::Processor)
-# end
+require "relaton_iec/iec_bibliographic_item"
+require "relaton_iec/xml_parser"
+require "relaton_iec/hash_converter"
+require "digest/md5"
 
 module RelatonIec
-  # Your code goes here...
+  # Returns hash of XML reammar
+  # @return [String]
+  def self.grammar_hash
+    gem_path = File.expand_path "..", __dir__
+    grammars_path = File.join gem_path, "grammars", "*"
+    grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+    Digest::MD5.hexdigest grammars
+  end
 end

data/lib/relaton_iec/hash_converter.rb

@@ -0,0 +1,14 @@
+module RelatonIec
+  class HashConverter < RelatonIsoBib::HashConverter
+    class << self
+      #
+      # Ovverides superclass's method
+      #
+      # @param item [Hash]
+      # @retirn [RelatonIec::IecBibliographicItem]
+      def bib_item(item)
+        IecBibliographicItem.new(item)
+      end
+    end
+  end
+end

data/lib/relaton_iec/hit.rb

@@ -2,50 +2,11 @@
 
 module RelatonIec
   # Hit.
-  class Hit
-    # @return [Isobib::HitCollection]
-    attr_reader :hit_collection
-
-    # @return [Array<Hash>]
-    attr_reader :hit
-
-    # @param hit [Hash]
-    # @param hit_collection [Isobib:HitCollection]
-    def initialize(hit, hit_collection = nil)
-      @hit            = hit
-      @hit_collection = hit_collection
-    end
-
+  class Hit < RelatonBib::Hit
     # Parse page.
-    # @return [Isobib::IsoBibliographicItem]
+    # @return [RelatonIec::IecBibliographicItem]
     def fetch
       @fetch ||= Scrapper.parse_page @hit
     end
-
-    # @return [String]
-    def to_s
-      inspect
-    end
-
-    # @return [String]
-    def inspect
-      "<#{self.class}:#{format('%#.14x', object_id << 1)} "\
-      "@text=\"#{@hit_collection&.text}\" "\
-      "@fetched=\"#{!@fetch.nil?}\" "\
-      "@fullIdentifier=\"#{@fetch&.shortref(nil)}\" "\
-      "@title=\"#{@hit[:code]}\">"
-    end
-
-    # @return [String]
-    def to_xml(opts = {})
-      #if builder
-        #fetch.to_xml builder, opts
-      #else
-        builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
-          fetch.to_xml xml, opts
-        end
-        builder.doc.root.to_xml
-      #end
-    end
   end
 end

data/lib/relaton_iec/hit_collection.rb

@@ -5,24 +5,13 @@ require "addressable/uri"
 
 module RelatonIec
   # Page of hit collection.
-  class HitCollection < Array
-
+  class HitCollection < RelatonBib::HitCollection
     DOMAIN = "https://webstore.iec.ch"
 
-    # @return [TrueClass, FalseClass]
-    attr_reader :fetched
-
-    # @return [String]
-    attr_reader :text
-
-    # @return [String]
-    attr_reader :year
-
     # @param ref_nbr [String]
     # @param year [String]
     def initialize(ref_nbr, year = nil) #(text, hit_pages = nil)
-      @text = ref_nbr
-      @year = year
+      super
       from, to = nil
       if year
         from = Date.strptime year, "%Y"
@@ -30,36 +19,13 @@ module RelatonIec
       end
       url  = "#{DOMAIN}/searchkey&RefNbr=#{ref_nbr}&From=#{from}&To=#{to}&start=1"
       doc  = Nokogiri::HTML OpenURI.open_uri(::Addressable::URI.parse(url).normalize)
-      hits = doc.css("ul.search-results > li").map do |h|
+      @array = doc.css("ul.search-results > li").map do |h|
         link  = h.at('a[@href!="#"]')
         code  = link.text.tr [194, 160].pack("c*").force_encoding("UTF-8"), ""
         title = h.xpath("text()").text.gsub(/[\r\n]/, "")
         url   = DOMAIN + link[:href]
         Hit.new({ code: code, title: title, url: url }, self)
       end
-      concat hits
-      @fetched = false
-    end
-
-    # @return [RelatonIec::HitCollection]
-    def fetch
-      workers = RelatonBib::WorkersPool.new 4
-      workers.worker(&:fetch)
-      each do |hit|
-        workers << hit
-      end
-      workers.end
-      workers.result
-      @fetched = true
-      self
-    end
-
-    def to_s
-      inspect
-    end
-
-    def inspect
-      "<#{self.class}:#{format('%#.14x', object_id << 1)} @fetched=#{@fetched}>"
     end
   end
 end

data/lib/relaton_iec/iec_bibliographic_item.rb

@@ -0,0 +1,9 @@
+module RelatonIec
+  class IecBibliographicItem < RelatonIsoBib::IsoBibliographicItem
+    TYPES = %w[
+      international-standard technical-specification technical-report
+      publicly-available-specification international-workshop-agreement
+      guide
+    ].freeze
+  end
+end

data/lib/relaton_iec/iec_bibliography.rb

@@ -17,15 +17,10 @@ module RelatonIec
         raise RelatonBib::RequestError, "Could not access http://www.iec.ch"
       end
 
-      # @param text [String]
-      # @return [Array<IsoBibliographicItem>]
-      # def search_and_fetch(text, year = nil)
-      #   Scrapper.get(text, year)
-      # end
-
       # @param code [String] the ISO standard Code to look up (e..g "ISO 9000")
       # @param year [String] the year the standard was published (optional)
-      # @param opts [Hash] options; restricted to :all_parts if all-parts reference is required
+      # @param opts [Hash] options; restricted to :all_parts if all-parts
+      #   reference is required
       # @return [String] Relaton XML serialisation of reference
       def get(code, year = nil, opts = {})
         if year.nil?
@@ -43,8 +38,8 @@ module RelatonIec
         ret = iecbib_get1(code, year, opts)
         return nil if ret.nil?
 
-        ret.to_most_recent_reference unless year || opts[:keep_year]
-        ret.to_all_parts if opts[:all_parts]
+        ret = ret.to_most_recent_reference unless year || opts[:keep_year]
+        ret = ret.to_all_parts if opts[:all_parts]
         ret
       end
 
@@ -52,15 +47,15 @@ module RelatonIec
 
       def fetch_ref_err(code, year, missed_years)
         id = year ? "#{code}:#{year}" : code
-        warn "WARNING: no match found online for #{id}. "\
+        warn "[relaton-iec] WARNING: no match found online for #{id}. "\
           "The code must be exactly like it is on the standards website."
-        warn "(There was no match for #{year}, though there were matches "\
+        warn "[relaton-iec] (There was no match for #{year}, though there were matches "\
           "found for #{missed_years.join(', ')}.)" unless missed_years.empty?
         if /\d-\d/ =~ code
-          warn "The provided document part may not exist, or the document "\
+          warn "[relaton-iec] The provided document part may not exist, or the document "\
             "may no longer be published in parts."
         else
-          warn "If you wanted to cite all document parts for the reference, "\
+          warn "[relaton-iec] If you wanted to cite all document parts for the reference, "\
             "use \"#{code} (all parts)\".\nIf the document is not a standard, "\
             "use its document type abbreviation (TS, TR, PAS, Guide)."
         end
@@ -72,13 +67,13 @@ module RelatonIec
         workers.worker { |w| { i: w[:i], hit: w[:hit].fetch } }
         s.each_with_index { |hit, i| workers << { i: i, hit: hit } }
         workers.end
-        workers.result.sort { |x, y| x[:i] <=> y[:i] }.map { |x| x[:hit] }
+        workers.result.sort_by { |a| a[:i] }.map { |x| x[:hit] }
       end
 
       def isobib_search_filter(code)
         docidrx = %r{^(ISO|IEC)[^0-9]*\s[0-9-]+}
         corrigrx = %r{^(ISO|IEC)[^0-9]*\s[0-9-]+:[0-9]+/}
-        warn "fetching #{code}..."
+        warn "[relaton-iec] (\"#{code}\") fetching..."
         result = search(code)
         result.select do |i|
           i.hit[:code] &&
@@ -147,9 +142,12 @@ module RelatonIec
 
         result = isobib_search_filter(code) || return
         ret = isobib_results_filter(result, year)
-        return ret[:ret] if ret[:ret]
-
-        fetch_ref_err(code, year, ret[:years])
+        if ret[:ret]
+          warn "[relaton-iec] (\"#{code}\") found #{ret[:ret].docidentifier.first.id}"
+          ret[:ret]
+        else
+          fetch_ref_err(code, year, ret[:years])
+        end
       end
     end
   end

data/lib/relaton_iec/processor.rb

@@ -12,28 +12,28 @@ module RelatonIec
     # @param code [String]
     # @param date [String, NilClass] year
     # @param opts [Hash]
-    # @return [RelatonIsoBib::IsoBibliographicItem]
+    # @return [RelatonIsoBib::IecBibliographicItem]
     def get(code, date, opts)
       ::RelatonIec::IecBibliography.get(code, date, opts)
     end
 
     # @param xml [String]
-    # @return [RelatonIsoBib::IsoBibliographicItem]
+    # @return [RelatonIsoBib::IecBibliographicItem]
     def from_xml(xml)
-      RelatonIsoBib::XMLParser.from_xml xml
+      RelatonIec::XMLParser.from_xml xml
     end
 
     # @param hash [Hash]
-    # @return [RelatonIsoBib::IsoBibliographicItem]
+    # @return [RelatonIsoBib::IecBibliographicItem]
     def hash_to_bib(hash)
-      item_hash = ::RelatonIsoBib::HashConverter.hash_to_bib(hash)
-      ::RelatonIsoBib::IsoBibliographicItem.new item_hash
+      item_hash = ::RelatonIec::HashConverter.hash_to_bib(hash)
+      ::RelatonIec::IecBibliographicItem.new item_hash
     end
 
     # Returns hash of XML grammar
     # @return [String]
     def grammar_hash
-      @grammar_hash ||= ::RelatonIsoBib.grammar_hash
+      @grammar_hash ||= ::RelatonIec.grammar_hash
     end
   end
 end