relaton-iec 0.10.0 → 1.0.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

@@ -4,7 +4,7 @@ module RelatonIec
   # Hit.
   class Hit < RelatonBib::Hit
     # Parse page.
-    # @return [Isobib::IsoBibliographicItem]
+    # @return [RelatonIec::IecBibliographicItem]
     def fetch
       @fetch ||= Scrapper.parse_page @hit
     end

data/lib/relaton_iec/hit_collection.rb

@@ -6,7 +6,6 @@ require "addressable/uri"
 module RelatonIec
   # Page of hit collection.
   class HitCollection < RelatonBib::HitCollection
-
     DOMAIN = "https://webstore.iec.ch"
 
     # @param ref_nbr [String]

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?
@@ -72,7 +67,7 @@ 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)

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

data/lib/relaton_iec/scrapper.rb

@@ -56,7 +56,7 @@ module RelatonIec
 
         status, relations = fetch_status_relations hit_data[:url]
 
-        RelatonIsoBib::IsoBibliographicItem.new(
+        IecBibliographicItem.new(
           fetched: Date.today.to_s,
           docid: [RelatonBib::DocumentIdentifier.new(id: hit_data[:code], type: "IEC")],
           structuredidentifier: fetch_structuredidentifier(doc),
@@ -246,7 +246,7 @@ module RelatonIec
         doc.xpath('//ROW[STATUS[.!="PREPARING"]][STATUS[.!="PUBLISHED"]]').map do |r|
           r_type = r.at("STATUS").text.downcase
           type = case r_type
-                #  when 'published' then 'obsoletes' # Valid
+                 # when 'published' then 'obsoletes' # Valid
                  when "revised", "replaced" then "updates"
                  when "withdrawn" then "obsoletes"
                  else r_type
@@ -255,9 +255,7 @@ module RelatonIec
           fref = RelatonBib::FormattedRef.new(
             content: r.at("FULL_NAME").text, format: "text/plain",
           )
-          bibitem = RelatonIsoBib::IsoBibliographicItem.new(
-            formattedref: fref,
-          )
+          bibitem = IecBibliographicItem.new(formattedref: fref)
           { type: type, bibitem: bibitem }
         end
       end

data/lib/relaton_iec/version.rb

@@ -1,3 +1,3 @@
 module RelatonIec
-  VERSION = "0.10.0".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/relaton_iec/xml_parser.rb

@@ -0,0 +1,14 @@
+module RelatonIec
+  class XMLParser < RelatonIsoBib::XMLParser
+    class << self
+      private
+
+      # override RelatonIsoBib::IsoBibliographicItem.bib_item method
+      # @param item_hash [Hash]
+      # @return [RelatonIec::IecBibliographicItem]
+      def bib_item(item_hash)
+        IecBibliographicItem.new item_hash
+      end
+    end
+  end
+end

data/relaton_iec.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = "RelatonIec: retrieve IEC Standards for bibliographic use "\
-                       "using the IsoBibliographicItem model"
-  spec.description   = "RelatonIec: retrieve IEC Standards for bibliographic use "\
-                       "using the IsoBibliographicItem model"
+  spec.summary       = "RelatonIec: retrieve IEC Standards for bibliographic "\
+                       "use using the IecBibliographicItem model"
+  spec.description   = "RelatonIec: retrieve IEC Standards for bibliographic "\
+                       "use using the IecBibliographicItem model"
   spec.homepage      = "https://github.com/metanorma/relaton-iec"
   spec.license       = "MIT"
 
@@ -29,10 +29,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "ruby-debug-ide"
+  spec.add_development_dependency "ruby-jing"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "addressable"
-  spec.add_dependency "relaton-iso-bib", "~> 0.9.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iec
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2020-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-jing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -156,15 +170,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
-description: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IsoBibliographicItem
+        version: 1.0.0
+description: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IecBibliographicItem
   model'
 email:
 - open.source@ribose.com
@@ -184,15 +198,23 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- grammars
+- grammars/basicdoc.rng
+- grammars/biblio.rng
+- grammars/iec.rng
+- grammars/isodoc.rng
+- grammars/isostandard.rng
+- grammars/reqt.rng
 - lib/relaton_iec.rb
+- lib/relaton_iec/hash_converter.rb
 - lib/relaton_iec/hit.rb
 - lib/relaton_iec/hit_collection.rb
+- lib/relaton_iec/iec_bibliographic_item.rb
 - lib/relaton_iec/iec_bibliography.rb
 - lib/relaton_iec/processor.rb
 - lib/relaton_iec/scrapper.rb
 - lib/relaton_iec/statuses.yml
 - lib/relaton_iec/version.rb
+- lib/relaton_iec/xml_parser.rb
 - relaton_iec.gemspec
 homepage: https://github.com/metanorma/relaton-iec
 licenses:
@@ -216,6 +238,6 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IsoBibliographicItem
+summary: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IecBibliographicItem
   model'
 test_files: []