asciidoctor-iso 0.7.9 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 355ac496fa1884cb8267d3c92d91131898ef9d1c
-  data.tar.gz: 6a6ddf721d8ac3166b7c99ed4d65271615a95f3f
+SHA256:
+  metadata.gz: 6fb0392613b100f479a723613c0b25ed4980b398a5f34a1a751a2a80eea285ee
+  data.tar.gz: 5f4dbd854ae36b9669081ed1a5dbcd4bb64f7fc269bdf4e263d5a3a8cecd2622
 SHA512:
-  metadata.gz: 5798a56948f8731274adce9a0942b422958fbd6b776a45d6243e0c1c4be48f83f1f570692dd03a7b3131f3869310ecc78d153aaea4e135ad0c42c16341e54fb2
-  data.tar.gz: 471c24e1688fd6ca6aec9f1f3b55d113f0838ac54f6c1891cf28a2775c0370d7a7d1f0722d4c786d3ac43aba423fa18dca7d184e9b70a413bbbd7a2c03713865
+  metadata.gz: ca833b27a34c5781824ed6b4ac849fd90330224f1d469889708c38f676e8567f7dab9fa3ee078ef08317f9f120141b8a0290e450b1c32dd09742d320e9696160
+  data.tar.gz: 14d7e8590882582d857b3db1a6335850170bb42dee5d2c16b91929b32f258e7d3a41cda87c6c89e71204a99c6183cb1448d07faf7cb0491eb84767afcfabe2f9

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    asciidoctor-iso (0.7.8)
+    asciidoctor-iso (0.8.0)
       asciidoctor (~> 1.5.7)
-      html2doc
       isobib (~> 0.1.4)
       isodoc (~> 0.6.2)
       ruby-jing
@@ -23,7 +22,7 @@ GEM
     docile (1.3.1)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    ffi (1.9.23)
+    ffi (1.9.24)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)
@@ -39,7 +38,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    html2doc (0.7.1)
+    html2doc (0.8.0)
       asciimath
       htmlentities (~> 4.3.4)
       image_size

data/README.adoc

@@ -516,6 +516,18 @@ any item label prefixed with `ISO` on the ISO web site. The full bibliographic d
 of the item are screenscraped from the ISO site and inserted into the XML file 
 (although only the title of the reference is used in rendering).
 
+[[cache]]
+The results of all `isobib` searches done to date, across all documents,
+are cached in the global cache file `~/.relaton-bib.json`, 
+so they do not need to be re-fetched each time a document is processed. 
+(The web query takes a few seconds per reference.)
+
+The results of all `isobib` searches done to date for the current document
+(`filename.adoc`) are stored in the same directory as the current document,
+in the file `filename`.relaton.json. The local cache overrides entries in
+the global cache, and can be manually edited. The local cache is only used
+if the `:local-cache:` document attribute is set.
+
 == Document Attributes
 
 The gem relies on Asciidoctor document attributes to provide necessary
@@ -527,6 +539,12 @@ Can be used as a command-line option (like all other document attributes):
 
 `:novalid:`:: Suppress validation.
 
+`:flush-caches:`:: If set, delete and reinitialise the <<cache,cache>> of `isobib` searches
+for ISO references from the ISO web site.
+
+`:local-cache:`:: Use the local isobib search cache to override the global isobib search
+cache.
+
 `:i18nyaml:`:: Name of YAML file of internationalisation text, to use instead
 of the built-in English, French or Chinese text used to label parts of the document
 (e.g. "Table", "Foreword", boilerplate text for Normative References, etc.)

data/asciidoctor-iso.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 1.5.7"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "html2doc"
   spec.add_dependency "isodoc", "~> 0.6.2"
   spec.add_dependency "isobib", "~> 0.1.4"
 

data/lib/asciidoctor/iso/base.rb

@@ -82,7 +82,10 @@ module Asciidoctor
         @novalid = node.attr("novalid")
         @fontheader = default_fonts(node)
         @files_to_delete = []
-        @bibliodb = open_cache_biblio(node)
+        @filename = node.attr("docfile").gsub(/\.adoc$/, "").gsub(%r{^.*/}, "")
+        @bibliodb = open_cache_biblio(node, true)
+        @local_bibliodb = node.attr("local-cache") ?
+          open_cache_biblio(node, false) : nil
       end
 
       def default_fonts(node)
@@ -100,12 +103,11 @@ module Asciidoctor
         init(node)
         ret = makexml(node).to_xml(indent: 2)
         unless node.attr("nodoc") || !node.attr("docfile")
-          filename = node.attr("docfile").gsub(/\.adoc$/, "").gsub(%r{^.*/}, "")
-          File.open(filename + ".xml", "w") { |f| f.write(ret) }
-          html_converter_alt(node).convert(filename + ".xml")
-          system "mv #{filename}.html #{filename}_alt.html"
-          html_converter(node).convert(filename + ".xml")
-          doc_converter(node).convert(filename + ".xml")
+          File.open(@filename + ".xml", "w") { |f| f.write(ret) }
+          html_converter_alt(node).convert(@filename + ".xml")
+          system "mv #{@filename}.html #{@filename}_alt.html"
+          html_converter(node).convert(@filename + ".xml")
+          doc_converter(node).convert(@filename + ".xml")
         end
         @files_to_delete.each { |f| system "rm #{f}" }
         ret
@@ -116,7 +118,8 @@ module Asciidoctor
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</iso-standard>"
-        save_cache_biblio(@bibliodb)
+        save_cache_biblio(@bibliodb, true)
+        save_cache_biblio(@local_bibliodb, false)
         textcleanup(result.flatten * "\n")
       end
 

data/lib/asciidoctor/iso/ref.rb

@@ -35,7 +35,7 @@ module Asciidoctor
       end
 
       def use_my_anchor(ref, id)
-        ref.parent["id"] = id
+        ref.parent.children.last["id"] = id
         ref
       end
 
@@ -82,28 +82,46 @@ module Asciidoctor
       def fetch_year_check(hit, code, year, opts)
         ret =nil
         if year.nil? || year.to_i == hit.hit["year"]
-            ret = hit.to_xml opts
-            @bibliodb[code] = ret
-          else
-            warn "WARNING: cited year #{year} does not match year "\
+          ret = hit.to_xml opts
+          @bibliodb[code] = ret if @bibliodb
+          @local_bibliodb[code] = ret if @local_bibliodb
+        else
+          warn "WARNING: cited year #{year} does not match year "\
             "#{hit.hit['year']} found on the ISO website for #{code}"
-          end
+        end
         ret
       end
 
+      def first_with_title(result)
+        result.first.each do |x|
+          next unless x.hit["title"]
+          return x
+        end
+        return nil
+      end
+
       def first_year_match_hit(result, code, year)
-        return result&.first&.first if year.nil?
+        return first_with_title(result) if year.nil?
         return nil unless result.first && result.first.is_a?(Array)
         coderegex = %r{^(ISO|IEC)[^0-9]*\s[0-9-]+}
         result.first.each do |x|
-          return x if x.hit["title"]&.match(coderegex)&.to_s == code &&
+          next unless x.hit["title"]
+          return x if x.hit["title"].match(coderegex).to_s == code &&
             year.to_i == x.hit["year"]
         end
-        return result&.first&.first
+        return first_with_title(result)
       end
 
-      def fetch_ref1(code, year, opts)
-        return @bibliodb[code] if @bibliodb[code]
+      def fetch_ref_err(code)
+        warn "WARNING: no match found on the ISO website for #{code}."
+        if /\d-\d/.match? code
+          warn "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, use #{code}:All Parts"
+        end
+      end
+
+      def fetch_ref2(code, year, opts)
         result = Isobib::IsoBibliography.search(code)
         ret = nil
         hit = first_year_match_hit(result, code, year)
@@ -111,11 +129,20 @@ module Asciidoctor
         if hit && hit.hit["title"]&.match(coderegex)&.to_s == code
           ret = fetch_year_check(hit, code, year, opts)
         else
-          warn "WARNING: no match found on the ISO website for #{code}"
+          fetch_ref_err(code)
         end
         ret
       end
 
+      def fetch_ref1(code, year, opts)
+        return nil if @bibliodb.nil? # signals we will not be using isobib
+        @bibliodb[code] = fetch_ref2(code, year, opts) unless @bibliodb[code]
+        @local_bibliodb[code] = @bibliodb[code] if !@local_bibliodb.nil? &&
+          !@local_bibliodb[code]
+        return @local_bibliodb[code] unless @local_bibliodb.nil?
+        @bibliodb[code]
+      end
+
       def fetch_ref(xml, code, year, **opts)
         warn "fetching #{code}..."
         hit = fetch_ref1(code, year, opts)
@@ -201,12 +228,15 @@ module Asciidoctor
         end.join("\n")
       end
 
-      def bibliocache_name()
-        "#{Dir.home}/.asciidoc-iso-biblio-cache.json"
+      def bibliocache_name(global)
+        global ?  "#{Dir.home}/.relaton-bib.json" :
+          "#{@filename}.relaton.json"
       end
 
-      def open_cache_biblio(node)
-        filename = bibliocache_name()
+      # if returns nil, then biblio caching is disabled, and so is use of isobib
+      def open_cache_biblio(node, global)
+        return nil # disabling for now
+        filename = bibliocache_name(global)
         system("rm -f #{filename}") if node.attr("flush-caches") == "true"
         biblio = {}
         if Pathname.new(filename).file?
@@ -217,8 +247,9 @@ module Asciidoctor
         biblio
       end
 
-      def save_cache_biblio(biblio)
-        filename = bibliocache_name()
+      def save_cache_biblio(biblio, global)
+        return if biblio.nil?
+        filename = bibliocache_name(global)
         File.open(filename, "w") do |b|
           b << biblio.to_json
         end

data/lib/asciidoctor/iso/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module ISO
-    VERSION = "0.7.9".freeze
+    VERSION = "0.8.0".freeze
   end
 end

data/spec/examples/rice.adoc

@@ -32,6 +32,7 @@
 :section-refsig: Clause
 :table-caption: Table
 :example-caption: Figure
+:local-cache:
 
 [[foreword]]
 .Foreword 

data/spec/examples/rice.preview.html

@@ -1854,7 +1854,7 @@ end</code></pre>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2018-06-01 23:15:41 AEST
+Last updated 2018-06-02 22:16:39 AEST
 </div>
 </div>
 <script type="text/x-mathjax-config">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-iso
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.8.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-02 00:00:00.000000000 Z
+date: 2018-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: html2doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
@@ -330,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: asciidoctor-iso lets you write ISO standards in AsciiDoc.