relaton-ogc 1.2.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87083ec001e4455f32f366ae2abae1d363fa04a5ebd2e934d0972170cb30e8a1
-  data.tar.gz: 3e2cdc145e63b059b60ff7e4d6f3826646dae21b2bf833f4786e050bd810b35f
+  metadata.gz: 522ba1924795803f2950a72cb2dada90bf6b74a263683bc11e719c974c3ce4f7
+  data.tar.gz: 0513d3f18b61a538d866ddeea0536224effc9a7883ec0d840b84b512b1f27efc
 SHA512:
-  metadata.gz: 9f3b7f2759e1759915979279b9490dc6039950abacb5c1e0862dd8c0dd81d1a45e4e4373ba6c1819658cf326ae8b574501ae037866bf5921cb1144a9802d1cf0
-  data.tar.gz: be6f7d638a6421e6c287496828723c13996c494938b2bb8050c5799b615fe290bd851e1c1f82046112df54544ec19839e03b1b74d463729540fbc934d6be7224
+  metadata.gz: d38dfb0d2cb57c4c64a5cc48ef563687493d2484831dc9cfba7dab9169319d4e4081c9e842e4efed254f694601dc483aba55d4bc86e78d83cd208409cd871e68
+  data.tar.gz: 4b6f6b79ad13ca89c2207139a078387b7c3dd30b6da158208f3eb65e7b3e641639063e2709e353d4e0be7413e8a3fc1fa9f05f5d897a5302f8c7cb0b418895a8

data/.github/workflows/macos.yml

@@ -26,6 +26,8 @@ jobs:
       - name: Update gems
         run: |
           sudo gem install bundler --force
+          ruby -v | grep 2.5 && bundle config set build.debase --with-cflags="-Wno-error=implicit-function-declaration"
+          ruby -v | grep 2.5 && bundle config set build.ruby-debug-ide --with-cflags="-Wno-error=implicit-function-declaration"
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |

data/.github/workflows/ubuntu.yml

@@ -29,4 +29,5 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |
+          unset JAVA_TOOL_OPTIONS
           bundle exec rake

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 Rails:
-  Enabled: true
+  Enabled: false

data/README.adoc

@@ -18,7 +18,7 @@ Add this line to your application's Gemfile:
 
 [source,ruby]
 ----
-gem 'relaton_ogc'
+gem 'relaton-ogc'
 ----
 
 And then execute:
@@ -27,7 +27,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install relaton_ogc
+    $ gem install relaton-ogc
 
 == Usage
 
@@ -35,8 +35,11 @@ Or install it yourself as:
 
 [source,ruby]
 ----
+require 'relaton_ogc'
+=> true
+
 hits = RelatonOgc::OgcBibliography.search("OGC 19-025r1")
-=> [<RelatonOgc::Hit:0x007fcab6b9aab8 @text="OGC 19-025r1" @fetched="false" @fullIdentifier="" @title="">]
+=> <RelatonOgc::HitCollection:0x007fcc8e085ba8 @ref=OGC 19-025r1 @fetched=false>
 
 tem = hits[0].fetch
 => #<RelatonOgc::OgcBibliographicItem:0x007fcab3cb4758
@@ -72,7 +75,10 @@ item.to_xml bibdata: true
       </date>
       ...
       <ext>
-        <doctype>public-engineering-report</doctype>
+        <doctype>engineering-report</doctype>
+        <editorialgroup>
+          <committee>technical</committee>
+        </editorialgroup>
       </ext>
     </bibdata>"
 ----
@@ -81,7 +87,8 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonOgc::OgcBibliography.get "OGC 19-025r1", "2019", {}
-fetching OGC 19-025r1...
+[relaton-ogc] ("OGC 19-025r1") fetching...
+[relaton-ogc] ("OGC 19-025r1") found 19-025r1
 => #<RelatonOgc::OgcBibliographicItem:0x007fc322e9aba0
 ...
 ----

data/grammars/isodoc.rng

@@ -43,7 +43,9 @@
     <define name="xref">
       <element name="xref">
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +63,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +585,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +670,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +716,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -834,6 +863,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +891,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +958,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +1000,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1028,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1050,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1078,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1222,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1492,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1541,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/grammars/ogc.rng

@@ -54,7 +54,7 @@
     <define name="preface">
       <element name="preface">
         <optional>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
         </optional>
         <ref name="foreword"/>
         <optional>
@@ -104,6 +104,13 @@
   </define>
   <define name="ogc-standard">
     <element name="ogc-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/lib/relaton_ogc/editorial_group.rb

@@ -35,6 +35,11 @@ module RelatonOgc
       @workgroup    = subgroup args[:workgroup]
     end
 
+    # @return [true]
+    def presence?
+      true
+    end
+
     # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.editorialgroup do
@@ -52,6 +57,17 @@ module RelatonOgc
       hash
     end
 
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "editorialgroup"
+      out = "#{pref}.committee:: #{committee}\n"
+      out += subcommittee.to_asciibib "#{pref}.subcommittee" if subcommittee
+      out += workgroup.to_asciibib "#{pref}.workgroup" if workgroup
+      out
+    end
+
     private
 
     # @param group [Hash, RelatonIsoBib::IsoSubgroup]

data/lib/relaton_ogc/hash_converter.rb

@@ -12,7 +12,7 @@ module RelatonOgc
           committee: eg[:committee],
           subcommittee: eg[:subcommittee],
           workgroup: eg[:workgroup],
-          secretariat: eg[:secretariat],
+          secretariat: eg[:secretariat]
         )
       end
     end

data/lib/relaton_ogc/hit_collection.rb

@@ -52,10 +52,13 @@ module RelatonOgc
     #
     # fetch data form server and save it to file.
     #
-    def fetch_data
+    def fetch_data # rubocop:disable Metrics/AbcSize
       resp = Faraday.new(ENDPOINT, headers: { "If-None-Match" => etag }).get
       # return if there aren't any changes since last fetching
-      raise RelatonBib::RequestError, "Could not access #{ENDPOINT}" unless resp.status == 200
+      return if resp.status == 304
+      unless resp.status == 200
+        raise RelatonBib::RequestError, "Could not access #{ENDPOINT}"
+      end
 
       FileUtils.mkdir_p DATADIR unless Dir.exist? DATADIR
       self.etag = resp[:etag]

data/lib/relaton_ogc/ogc_bibliographic_item.rb

@@ -20,12 +20,13 @@ module RelatonOgc
     # @param docsubtype [String]
     def initialize(**args)
       if args[:docsubtype] && !SUBTYPES.include?(args[:docsubtype])
-        warn "[relaton-ogc] WARNING: invalid document subtype: #{args[:docsubtype]}"
+        warn "[relaton-ogc] WARNING: invalid document "\
+        "subtype: #{args[:docsubtype]}"
       end
 
       @docsubtype = args.delete :docsubtype
+      # @doctype = args.delete :doctype
       super
-      # @doctype = args[:doctype]
     end
 
     # @return [Hash]
@@ -35,11 +36,14 @@ module RelatonOgc
       hash
     end
 
-    # @param builder [Nokogiri::XML::Builder]
     # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [Boolean] :bibdata
-    def to_xml(builder = nil, **opts)
-      super do |b|
+    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [String, Symbol] :lang language
+    # @return [String] XML
+    def to_xml(**opts)
+      super **opts do |b|
         b.ext do
           b.doctype doctype if doctype
           b.docsubtype docsubtype if docsubtype
@@ -48,5 +52,14 @@ module RelatonOgc
         end
       end
     end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "")
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = super
+      out += "#{pref}docsubtype:: #{docsubtype}\n" if docsubtype
+      out
+    end
   end
 end

data/lib/relaton_ogc/ogc_bibliography.rb

@@ -3,10 +3,10 @@ module RelatonOgc
     class << self
       # @param text [String]
       # @return [RelatonOgc::HitCollection]
-      def search(text, year = nil, opts = {})
+      def search(text, year = nil, _opts = {})
         HitCollection.new text, year
       rescue Faraday::ConnectionFailed
-        raise RelatonBib::RequestError, "Could not access https://www.nist.gov"
+        raise RelatonBib::RequestError, HitCollection::ENDPOINT
       end
 
       # @param code [String] the OGC standard Code to look up (e..g "8200")

data/lib/relaton_ogc/version.rb

@@ -1,3 +1,3 @@
 module RelatonOgc
-  VERSION = "1.2.0".freeze
+  VERSION = "1.5.1".freeze
 end

data/lib/relaton_ogc/xml_parser.rb

@@ -3,19 +3,6 @@ require "nokogiri"
 module RelatonOgc
   class XMLParser < RelatonIsoBib::XMLParser
     class << self
-      # Override RelatonIsoBib::XMLParser.form_xml method.
-      # @param xml [String]
-      # @return [RelatonOgc::OgcBibliographicItem]
-      # def from_xml(xml)
-      #   doc = Nokogiri::XML(xml)
-      #   item = doc.at "/bibitem|/bibdata"
-      #   if item
-      #     OgcBibliographicItem.new item_data(item)
-      #   else
-      #     warn "[relaton-ogc] can't find bibitem or bibdata element in the XML"
-      #   end
-      # end
-
       private
 
       # override RelatonIsoBib::IsoBibliographicItem.bib_item method
@@ -48,7 +35,7 @@ module RelatonOgc
         sc = iso_subgroup eg&.at("subcommittee")
         wg = iso_subgroup eg&.at("workgroup")
         EditorialGroup.new(
-          committee: committe, subcommittee: sc, workgroup: wg,
+          committee: committe, subcommittee: sc, workgroup: wg
         )
       end
     end

data/relaton_ogc.gemspec

@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "faraday", "~> 1.0.0"
-  spec.add_dependency "relaton-iso-bib", "~> 1.2.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ogc
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.0
 description: 'RelatonOgc: retrieve OGC Standards for bibliographic use using the OgcBibliographicItem
   model'
 email:
@@ -219,7 +219,7 @@ homepage: https://github.com/relaton/relaton-ogc
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonOgc: retrieve OGC Standards for bibliographic use using the OgcBibliographicItem
   model'