asciidoctor-iso 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb4b3cf95879f9dbc87df7bb4ef5ef0cdd6d8a84d5c025d875686d22fbbccf81
-  data.tar.gz: 72922fb815c364609f29b030aea4349dcb8b1b2e62b2aa8a6cd1e553d077c672
+  metadata.gz: 6ed4e5fbc863973f1ba6574f497bbc29f7e7512f8f3289d508482eb2910da16c
+  data.tar.gz: c3c2fa81e796ca9b7a5476252e1bd8758769390ce56fb269d3aa39d2f71daf7a
 SHA512:
-  metadata.gz: 2598a409d73c5fba6adbe2056428b2ff33c9e3d85ae5bd19a7af1caae42ec8d96716453676c98b50c237a0855108cd79ae4fdf40043f74782b551b504008f1b1
-  data.tar.gz: 006c5953314176be6f126765fb4281ffa268e4c5a8faa46470a5ee4dcafebfc888f0f8af98e4ce03360647e1c7f830e546ab278b966a094b9ecc41fd0dcff591
+  metadata.gz: 2d4c27a6911320c11976fe46f2c2bd20789921534c1617324d7fcad6c804d467540fd1242a5e61ef482f71a1b882ea019838a92ca014dad03ce504c37422fae7
+  data.tar.gz: 44287b9e26b88050045c7b5f03d6e95c8629ad10309eeafe391c18dace5f33bfa2bff626f83e872da415030a384e91240f6c7276a28334f9719474557284db65

data/.rubocop.ribose.yml

@@ -4,6 +4,7 @@ AllCops:
   - "**/Gemfile"
   - "**/*.gemfile"
   - "**/Rakefile"
+  - "**/*.rb"
   Exclude:
   - "vendor/**/*"
   - "db/**/*"

data/.rubocop.yml

@@ -10,6 +10,6 @@ inherit_from:
 AllCops:
   DisplayCopNames: false
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 Rails:
   Enabled: true

data/Gemfile.lock

@@ -15,9 +15,63 @@ GEM
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     asciidoctor (1.5.7.1)
+    asciidoctor-csand (0.3.0)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.9.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.8.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
+    asciidoctor-csd (0.4.0)
+      asciidoctor-iso (>= 0.9.0)
+      isodoc (>= 0.8.0)
+    asciidoctor-gb (0.3.0)
+      asciidoctor-iso (>= 0.9.0)
+      isodoc (>= 0.8.0)
+      twitter_cldr
+    asciidoctor-m3d (0.3.1)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.9.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.8.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
+    asciidoctor-rfc (0.9.0)
+      asciidoctor (~> 1.5.7)
+      htmlentities (~> 4.3.4)
+      nokogiri
+      ruby-jing
+      thread_safe
+    asciidoctor-rsd (0.3.1)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.8.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.7.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
     asciimath (1.0.4)
     ast (2.4.0)
     byebug (9.1.0)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
@@ -52,11 +106,11 @@ GEM
     htmlentities (4.3.4)
     httpclient (2.8.3)
     image_size (2.0.0)
-    iso-bib-item (0.1.6)
+    iso-bib-item (0.1.8)
       duplicate
       isoics (~> 0.1.6)
       nokogiri
-    isobib (0.1.6)
+    isobib (0.1.7)
       algoliasearch
       iso-bib-item (~> 0.1.2)
     isodoc (0.8)
@@ -81,6 +135,15 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
+    metanorma (0.2.2)
+      asciidoctor-csand (>= 0.3.0)
+      asciidoctor-csd (>= 0.4.0)
+      asciidoctor-gb (>= 0.3.0)
+      asciidoctor-iso (>= 0.9.0)
+      asciidoctor-m3d (>= 0.3.1)
+      asciidoctor-rfc (>= 0.9.0)
+      asciidoctor-rsd (>= 0.3.0)
+      isodoc (>= 0.8.0)
     method_source (0.9.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -146,6 +209,12 @@ GEM
     thor (0.20.0)
     thread_safe (0.3.6)
     timecop (0.9.1)
+    twitter_cldr (4.4.3)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.0)
+      tzinfo
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
     uuidtools (2.1.5)
 
@@ -159,6 +228,7 @@ DEPENDENCIES
   equivalent-xml (~> 0.6)
   guard (~> 2.14)
   guard-rspec (~> 4.7)
+  metanorma
   rake (~> 12.0)
   rspec (~> 3.6)
   rubocop (~> 0.50)

data/README.adoc

@@ -41,29 +41,51 @@ gives a summary overview.
 
 == Usage
 
+The preferred way to invoke this gem is via the `metanorma` script:
+
 [source,console]
 ----
-$ asciidoctor a.adoc  # HTML output of Asciidoc file
-$ asciidoctor -b iso -r 'asciidoctor-iso' a.adoc  # ISO XML output, 
+$ metanorma --type iso a.adoc                   # output HTML and DOC
+$ metanorma --type csd --extensions html a.adoc # output just HTML
+$ metanorma --type csd --extensions doc a.adoc  # output just DOC
+$ metanorma --type csd --extensions xml a.adoc  # output CSD XML
 ----
 
-The initial step is optional, and can be used as a preview of what the gem
-will do; it generates a `{filename}.html` file.
+The gem translates the document into ISO XML format, and then
+validates its output against the ISO XML document model; errors are
+reported to console against the XML, and are intended for users to
+check that they have provided all necessary components of the
+document.
 
-When invoked within Asciidoctor, the gem translates the document into 
-ISO XML format, and then validates its
-output against the ISO XML document model; errors are reported to console
-against the XML, and are intended for users to check that they have provided
-all necessary components of the document.
+The gem then converts the XML into HTML and DOC.
 
-The gem then converts the XML to Micosoft Word (`{filename}.doc`), HTML (`{filename}.html`), 
-and PDF (forthcoming).
+The gem can also be invoked directly within asciidoctor, though this is deprecated:
 
-In the process of generating the Microsoft Word document, the associated
-https://github.com/riboseinc/isodoc[IsoDoc] gem generates temporary files:
-`{filename}.htm` contains the Microsoft Word-specific HTML for inclusion in that file,
-and the `{filename}_files` folder contains any images and headers for the Word
-document.
+[source,console]
+----
+$ asciidoctor -b iso -r 'asciidoctor-iso' a.adoc  
+----
+
+If you do not invoke the `iso` backend explicitly, the AsciiISO source will be
+treated as generic Asciidoc markup, and will output an HTML preview that 
+ignores the ISO-specific modifications to the markup:
+
+[source,console]
+----
+$ asciidoctor a.adoc  
+----
+
+=== Installation
+
+If you are using a Mac, the https://github.com/riboseinc/metanorma-macos-setup
+repository has instructions on setting up your machine to run Metanorma
+scripts such as this one. You need only run the following in a Terminal console:
+
+[source,console]
+----
+$ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
+$ gem install asciidoctor-iso
+----
 
 
 === Content Warnings

data/asciidoctor-iso.gemspec

@@ -43,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~> 0.50"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "metanorma"
 end

data/lib/asciidoctor/iso/ref.rb

@@ -80,120 +80,6 @@ module Asciidoctor
         end
       end
 
-# --- ISOBIB
-      def fetch_ref_err(code, year, missed_years)
-        id = year ? "#{code}:#{year}" : code
-        warn "WARNING: no match found on the ISO website for #{id}. "\
-          "The code must be exactly like it is on the website."
-        warn "(There was no match for #{year}, though there were matches "\
-          "found for #{missed_years.join(', ')}.)" unless missed_years.empty?
-        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)\".\nIf the document is not a standard, "\
-            "use its document type abbreviation (TS, TR, PAS, Guide)."
-        end
-        nil
-      end
-
-      def fetch_pages(s, n)
-        workers = WorkersPool.new n
-        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] }
-      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}..."
-        result = Isobib::IsoBibliography.search(code)
-        result.first.select do |i| 
-          i.hit["title"] &&
-          i.hit["title"].match(docidrx).to_s == code &&
-            !corrigrx.match?(i.hit["title"])
-        end 
-      end
-
-      def iev
-        Nokogiri::XML.fragment(<<~"END")
-          <bibitem type="international-standard" id="IEV">
-  <title format="text/plain" language="en" script="Latn">Electropedia: 
-  The World's Online Electrotechnical Vocabulary</title>
-  <source type="src">http://www.electropedia.org</source>
-  <docidentifier>IEV</docidentifier>
-  <date type="published"> <on>#{Date.today.year}</on> </date>
-  <contributor>
-    <role type="publisher"/>
-    <organization>
-      <name>International Electrotechnical Commission</name>
-      <abbreviation>IEC</abbreviation>
-      <uri>www.iec.ch</uri>
-    </organization>
-  </contributor>
-  <language>en</language> <language>fr</language>
-  <script>Latn</script>
-  <copyright>
-    <from>#{Date.today.year}</from>
-    <owner>
-      <organization>
-      <name>International Electrotechnical Commission</name>
-      <abbreviation>IEC</abbreviation>
-      <uri>www.iec.ch</uri>
-      </organization>
-    </owner>
-  </copyright>
-  <relation type="updates">
-    <bibitem>
-      <formattedref>IEC 60050</formattedref>
-    </bibitem>
-  </relation>
-</bibitem>
-        END
-      end
-
-      # Sort through the results from Isobib, fetching them three at a time,
-      # and return the first result that matches the code,
-      # matches the year (if provided), and which # has a title (amendments do not).
-      # Only expects the first page of results to be populated.
-      # Does not match corrigenda etc (e.g. ISO 3166-1:2006/Cor 1:2007)
-      # If no match, returns any years which caused mismatch, for error reporting
-      def isobib_results_filter(result, year)
-        missed_years = []
-        result.each_slice(3) do |s| # ISO website only allows 3 connections
-          fetch_pages(s, 3).each_with_index do |r, i|
-            return { ret: r } if !year
-            r.dates.select { |d| d.type == "published" }.each do |d|
-              return { ret: r } if year.to_i == d.on.year
-              missed_years << d.on.year
-            end
-          end
-        end
-        { years: missed_years }
-      end
-
-      def isobib_get1(code, year, opts)
-        return iev if code.casecmp? "IEV"
-        result = isobib_search_filter(code) or return nil
-        ret = isobib_results_filter(result, year)
-        return ret[:ret] if ret[:ret]
-        fetch_ref_err(code, year, ret[:years])
-      end
-
-      def isobib_get(code, year, opts)
-        code += "-1" if opts[:all_parts]
-        ret = isobib_get1(code, year, opts)
-        return nil if ret.nil?
-        ret.to_most_recent_reference if !year
-        ret.to_all_parts if opts[:all_parts]
-        ret.to_xml
-      end
-
-      # --- ISOBIB
-
       def iso_id(code, year, all_parts)
         ret = code
         ret += ":#{year}" if year
@@ -204,7 +90,7 @@ module Asciidoctor
       def fetch_ref1(code, year, opts)
         id = iso_id(code, year, opts[:all_parts])
         return nil if @bibliodb.nil? # signals we will not be using isobib
-        @bibliodb[id] = isobib_get(code, year, opts) unless @bibliodb[id]
+        @bibliodb[id] = Isobib::IsoBibliography.isobib_get(code, year, opts) unless @bibliodb[id]
         @local_bibliodb[id] = @bibliodb[id] if !@local_bibliodb.nil? &&
           !@local_bibliodb[id]
         return @local_bibliodb[id] unless @local_bibliodb.nil?

data/lib/asciidoctor/iso/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module ISO
-    VERSION = "0.9.0".freeze
+    VERSION = "0.9.1".freeze
   end
 end

data/lib/metanorma/iso/processor.rb

@@ -18,6 +18,10 @@ module Metanorma
         }
       end
 
+      def version
+        "Asciidoctor::ISO #{Asciidoctor::ISO::VERSION}/IsoDoc #{IsoDoc::VERSION}"
+      end
+
       def input_to_isodoc(file)
         Metanorma::Input::Asciidoc.new.process(file, @asciidoctor_backend)
       end
@@ -35,4 +39,4 @@ module Metanorma
 
     end
   end
-end
+end

data/spec/asciidoctor-iso/refs_spec.rb

@@ -123,7 +123,7 @@ RSpec.describe Asciidoctor::ISO do
           <text>Latex and raw rubber</text>
         </ics>
         <relation type="instance">
-  <bibitem type="international-standard" id="ISO123">
+  <bibitem type="international-standard">
     <title format="text/plain" language="en" script="Latn">Rubber latex -- Sampling</title>
         <title format="text/plain" language="fr" script="Latn">Latex de caoutchouc -- Échantillonnage</title>
     <source type="src">https://www.iso.org/standard/23281.html</source>

data/spec/metanorma/processor_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+require "metanorma"
+
+#RSpec.describe Asciidoctor::Gb do
+RSpec.describe Metanorma::Iso::Processor do
+
+  registry = Metanorma::Registry.instance
+  registry.register(Metanorma::Iso::Processor)
+  processor = registry.find_processor(:iso)
+
+  it "registers against metanorma" do
+    expect(processor).not_to be nil
+  end
+
+  it "registers output formats against metanorma" do
+    expect(processor.output_formats.sort.to_s).to be_equivalent_to <<~"OUTPUT"
+    [[:doc, "doc"], [:html, "html"], [:html_alt, "alt.html"]]
+    OUTPUT
+  end
+
+  it "registers version against metanorma" do
+    expect(processor.version.to_s).to match(%r{^Asciidoctor::ISO })
+    expect(processor.version.to_s).to match(%r{/IsoDoc })
+  end
+
+  it "generates IsoDoc XML from a blank document" do
+    expect(processor.input_to_isodoc(<<~"INPUT")).to be_equivalent_to <<~"OUTPUT"
+    #{ASCIIDOC_BLANK_HDR}
+    INPUT
+    #{BLANK_HDR}
+<sections/>
+</iso-standard>
+    OUTPUT
+  end
+
+  it "generates HTML from IsoDoc XML" do
+    system "rm -f test.xml"
+    processor.output(<<~"INPUT", "test.html", :html)
+               <iso-standard xmlns="http://riboseinc.com/isoxml">
+       <sections>
+       <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
+         <term id="J">
+         <preferred>Term2</preferred>
+       </term>
+        </terms>
+        </sections>
+        </iso-standard>
+    INPUT
+    expect(File.read("test.html", encoding: "utf-8").gsub(%r{^.*<main}m, "<main").gsub(%r{</main>.*}m, "</main>")).to be_equivalent_to <<~"OUTPUT"
+           <main class="main-section"><button onclick="topFunction()" id="myBtn" title="Go to top">Top</button>
+             <p class="zzSTDTitle1"></p>
+             <div id="H"><h1>1.&#xA0; Terms and definitions</h1><p>For the purposes of this document,
+           the following terms and definitions apply.</p>
+       <p>ISO and IEC maintain terminological databases for use in
+       standardization at the following addresses:</p>
+
+       <ul>
+       <li> <p>ISO Online browsing platform: available at
+         <a href="http://www.iso.org/obp">http://www.iso.org/obp</a></p> </li>
+       <li> <p>IEC Electropedia: available at
+         <a href="http://www.electropedia.org">http://www.electropedia.org</a>
+       </p> </li> </ul>
+       <h2 class="TermNum" id="J">1.1</h2>
+         <p class="Terms" style="text-align:left;">Term2</p>
+       </div>
+           </main>
+    OUTPUT
+  end
+
+end

data/spec/spec_helper.rb

@@ -8,6 +8,8 @@ require "asciidoctor"
 require "asciidoctor-iso"
 require "rspec/matchers"
 require "equivalent-xml"
+require "metanorma"
+require "metanorma/iso"
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-iso
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: metanorma
+  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'
 description: |
   asciidoctor-iso lets you write ISO standards in AsciiDoc syntax.
 
@@ -301,6 +315,7 @@ files:
 - spec/examples/rice_images/rice_image3_1.png
 - spec/examples/rice_images/rice_image3_2.png
 - spec/examples/rice_images/rice_image3_3.png
+- spec/metanorma/processor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/riboseinc/asciidoctor-iso
 licenses:
@@ -322,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: asciidoctor-iso lets you write ISO standards in AsciiDoc.