isodoc 0.7.1 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2307d0897bc261ade077a3550818f09a5d008640f2711809d0daf173f57e40c
-  data.tar.gz: 1a26f9322f6277cbc7534b8161d5798777a2e7683b782c402a5c1c8a4825cd6d
+  metadata.gz: a95d693408f9924a873e894eddf95b98fa2f3c1b689f1f2d68e0dc6be5a3ad0f
+  data.tar.gz: 1d5ecf55343cdc70c4e83238ee887446295b02d0c5dcf0d005e7e03f2260a80c
 SHA512:
-  metadata.gz: 322b6d4ea3fbc7aedb90fddbeeae80347058e1a78b55e0b4fb7fea4fbbd4a26251cdd72fb664eb8bd36a082ca70e8bc39ad0e34eaec2143ed6b6ce9b9eed5af9
-  data.tar.gz: cf491aa85b5b08741027d50379be5c1be9a0ad252c20a56380429b828a2a6a6a899747830aaf1cf20bddb6a19ca5fabc7944fde58f11a1c908f9181d2feb095f
+  metadata.gz: bd3033cb703cf7483e99760c5a9b9baf6b13eb98f92f7218aee037b4062ce0a76e1c7f5203c3a784a3c966d54f573268337d99999b358de32146925d9c225994
+  data.tar.gz: 5b4031816ce73f837abf30b421792eb3501f24c8b09c3c59daa2884312b2402a82dffe5d445ebab00630fe75aab323e50043c32374ab9284defc4a5cc1a74e1b

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/riboseinc/html2doc.git
-  revision: f8bd693d8748c622bbe8f24ab30ac142b2543a0a
+  revision: ae15cfc0a4c8ebeb74193a8aa4a7884938a08434
   specs:
     html2doc (0.8.0)
       asciimath
@@ -15,7 +15,7 @@ GIT
 PATH
   remote: .
   specs:
-    isodoc (0.7.0)
+    isodoc (0.7.1)
       asciimath
       html2doc (>= 0.7.1)
       htmlentities (~> 4.3.4)
@@ -58,6 +58,7 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     htmlentities (4.3.4)
     image_size (2.0.0)
+    jaro_winkler (1.5.1)
     json (2.1.0)
     liquid (4.0.0)
     listen (3.1.5)
@@ -71,7 +72,7 @@ GEM
     mime-types-data (3.2016.0521)
     mini_portile2 (2.3.0)
     nenv (0.3.0)
-    nokogiri (1.8.2)
+    nokogiri (1.8.3)
       mini_portile2 (~> 2.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -79,7 +80,7 @@ GEM
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -102,7 +103,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.56.0)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5)
       powerpack (~> 0.1)
@@ -126,7 +128,7 @@ GEM
     thor (0.20.0)
     thread_safe (0.3.6)
     timecop (0.9.1)
-    unicode-display_width (1.3.3)
+    unicode-display_width (1.4.0)
     uuidtools (2.1.5)
 
 PLATFORMS

data/README.adoc

@@ -41,16 +41,16 @@ The conversion takes place with a `convert` method, with three arguments: the fi
 [source,ruby]
 ----
 # generates test.html
-IsoDoc::Iso::Convert.new({}).convert("test.xml")
+IsoDoc::Iso::HtmlConvert.new({}).convert("test.xml")
 
 # generates test.doc, with Chinese font defaults rather than Roman
 IsoDoc::Iso::WordConvert.new({script: "Hans"}).convert("test.xml")
 
 # generates test.html, based on file1.xml
-IsoDoc::Iso::Convert.new({}).convert("test", File.read("file1.xml"))
+IsoDoc::Iso::HtmlConvert.new({}).convert("test", File.read("file1.xml"))
 
 # generates HTML output for the given input string, but does not save it to disk.
-IsoDoc::Iso::Convert.new({}).convert("test", <<~"INPUT", true)
+IsoDoc::Iso::HtmlConvert.new({}).convert("test", <<~"INPUT", true)
   <iso-standard xmlns="http://riboseinc.com/isoxml">
     <preface><foreword>
     <note>

data/lib/isodoc.rb

@@ -1,5 +1,3 @@
-module IsoDoc
-
 require_relative "isodoc/version"
 
 require "nokogiri"
@@ -11,10 +9,19 @@ require "mime/types"
 require "image_size"
 require "set"
 require "pp"
+require "uuidtools"
+require "html2doc"
+require "liquid"
+require "htmlentities"
+
+require "isodoc/common"
 require "isodoc/convert"
 require "isodoc/metadata"
-require "isodoc/htmlconvert/convert"
-require "isodoc/wordconvert/convert"
-require "isodoc/iso/convert"
-require "isodoc/iso/wordconvert"
+require "isodoc/html_convert"
+require "isodoc/word_convert"
+require "isodoc/iso/html_convert"
+require "isodoc/iso/word_convert"
+
+module IsoDoc
+
 end

data/lib/isodoc/class_utils.rb

@@ -0,0 +1,24 @@
+
+module IsoDoc
+  module ClassUtils
+
+    def date_range(date)
+      from = date.at(ns("./from"))
+      to = date.at(ns("./to"))
+      on = date.at(ns("./on"))
+      return on.text if on
+      ret = "#{from.text}–"
+      ret += to.text if to
+      ret
+    end
+
+    def ns(xpath)
+      xpath.gsub(%r{/([a-zA-z])}, "/xmlns:\\1").
+        gsub(%r{::([a-zA-z])}, "::xmlns:\\1").
+        gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1").
+        gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
+    end
+
+  end
+
+end

data/lib/isodoc/common.rb

@@ -0,0 +1,34 @@
+require_relative "./function/blocks"
+require_relative "./function/cleanup"
+require_relative "./function/i18n"
+require_relative "./function/inline"
+require_relative "./function/lists"
+require_relative "./function/references"
+require_relative "./function/section"
+require_relative "./function/table"
+require_relative "./function/terms"
+require_relative "./function/to_word_html"
+require_relative "./function/utils"
+require_relative "./function/xref_gen"
+require_relative "./function/xref_sect_gen"
+require_relative "./class_utils"
+
+module IsoDoc
+  class Common
+    include Function::Blocks
+    include Function::Cleanup
+    include Function::I18n
+    include Function::Inline
+    include Function::Lists
+    include Function::References
+    include Function::Section
+    include Function::Table
+    include Function::Terms
+    include Function::ToWordHtml
+    include Function::Utils
+    include Function::XrefGen
+    include Function::XrefSectGen
+
+    extend ::IsoDoc::ClassUtils
+  end
+end

data/lib/isodoc/convert.rb

@@ -1,21 +1,8 @@
-require "isodoc/iso2wordhtml"
-require "isodoc/cleanup"
-require "isodoc/utils"
-require "isodoc/metadata"
-require "isodoc/section"
-require "isodoc/references"
-require "isodoc/terms"
-require "isodoc/blocks"
-require "isodoc/lists"
-require "isodoc/table"
-require "isodoc/inline"
-require "isodoc/xref_gen"
-require "isodoc/xref_sect_gen"
-require "isodoc/i18n"
+require "isodoc/common"
 require "sass"
 
 module IsoDoc
-  class Common
+  class Convert < ::IsoDoc::Common
 
     # htmlstylesheet: Generic stylesheet for HTML
     # wordstylesheet: Generic stylesheet for Word
@@ -87,7 +74,7 @@ module IsoDoc
     end
 
     def metadata_init(lang, script, labels)
-            @meta = Metadata.new(lang, script, labels)
+      @meta = Metadata.new(lang, script, labels)
     end
 
     def convert_init(file, filename, debug)

data/lib/isodoc/function.rb

@@ -0,0 +1,4 @@
+module IsoDoc
+  module Function
+  end
+end

data/lib/isodoc/{blocks.rb → function/blocks.rb}

@@ -1,5 +1,5 @@
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module Blocks
     @annotation = false
 
     def note_label(node)

data/lib/isodoc/{cleanup.rb → function/cleanup.rb}

@@ -1,10 +1,5 @@
-require "html2doc"
-require "htmlentities"
-require "nokogiri"
-require "pp"
-
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module Cleanup
     def cleanup(docxml)
       comment_cleanup(docxml)
       footnote_cleanup(docxml)
@@ -134,7 +129,7 @@ module IsoDoc
       t.at(".//tr").xpath("./td | ./th").each do |td|
         cols += (td["colspan"] ? td["colspan"].to_i : 1)
       end
-      style = %{border-top:0pt;border-bottom:#{SW} 1.5pt;}
+      style = %{border-top:0pt;border-bottom:#{IsoDoc::Function::Table::SW} 1.5pt;}
       tfoot.add_child("<tr><td colspan='#{cols}' style='#{style}'/></tr>")
       tfoot.xpath(".//td").last
     end
@@ -161,7 +156,7 @@ module IsoDoc
       docxml
     end
 
-    # We assume AsciiMath is being used in the terms & definitions. 
+    # We assume AsciiMath is being used in the terms & definitions.
     # Indices sort after letter but before any following
     # letter (x, x_m, x_1, xa); we use colon to force that sort order.
     # Numbers sort *after* letters; we use thorn to force that sort order.

data/lib/isodoc/{i18n.rb → function/i18n.rb}

@@ -1,21 +1,22 @@
 require "yaml"
 
-module IsoDoc
-  class Common
+# TODO: Cleanup and generalize
+module IsoDoc::Function
+  module I18n
     def i18n_init(lang, script)
       @lang = lang
       @script = script
       y = if @i18nyaml
             YAML.load_file(@i18nyaml)
           elsif lang == "en"
-            YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            YAML.load_file(File.join(File.dirname(__FILE__), "../../isodoc-yaml/i18n-en.yaml"))
           elsif lang == "fr"
-            YAML.load_file(File.join(File.dirname(__FILE__), "i18n-fr.yaml"))
+            YAML.load_file(File.join(File.dirname(__FILE__), "../../isodoc-yaml/i18n-fr.yaml"))
           elsif lang == "zh" && script == "Hans"
             YAML.load_file(File.join(File.dirname(__FILE__),
-                                     "i18n-zh-Hans.yaml"))
+                                     "../../isodoc-yaml/i18n-zh-Hans.yaml"))
           else
-            YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            YAML.load_file(File.join(File.dirname(__FILE__), "../../isodoc-yaml/i18n-en.yaml"))
           end
       @term_def_boilerplate = y["term_def_boilerplate"]
       @scope_lbl = y["scope"]
@@ -64,6 +65,7 @@ module IsoDoc
       @labels["script"] = @script
     end
 
+    # TODO: move to localization file
     def eref_localities1_zh(type, from, to)
       ret = ", 第#{from.text}" if from
       ret += "–#{to}" if to
@@ -71,6 +73,7 @@ module IsoDoc
       ret
     end
 
+    # TODO: move to localization file
     def eref_localities1(type, from, to, lang = "en")
       subsection = from&.text&.match?(/\./)
       return l10n(eref_localities1_zh(type, from, to)) if lang == "zh"
@@ -82,9 +85,10 @@ module IsoDoc
       l10n(ret)
     end
 
+    # TODO: move to localization file
     # function localising spaces and punctuation.
     # Not clear if period needs to be localised for zh
-    def self.l10n(x, lang, script)
+    def l10n(x, lang = @lang, script = @script)
       if lang == "zh" && script == "Hans"
         x.gsub(/ /, "").gsub(/:/, "：").gsub(/,/, "、").
           gsub(/\(/, "（").gsub(/\)/, "）").
@@ -95,8 +99,7 @@ module IsoDoc
       end
     end
 
-    def l10n(x, lang = @lang, script = @script)
-      Common::l10n(x, lang, script)
-    end
+    module_function :l10n
+
   end
 end

data/lib/isodoc/{inline.rb → function/inline.rb}

@@ -1,7 +1,5 @@
-require "uuidtools"
-
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module Inline
     def section_break(body)
       body.br
     end

data/lib/isodoc/{lists.rb → function/lists.rb}

@@ -1,5 +1,6 @@
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module Lists
+
     def ul_parse(node, out)
       out.ul do |ul|
         node.children.each { |n| parse(n, ul) }
@@ -21,8 +22,8 @@ module IsoDoc
 
     # We don't really want users to specify type of ordered list;
     # we will use a fixed hierarchy as practiced by ISO (though not
-    # fully spelled out): a) 1) i) A) I) 
-   
+    # fully spelled out): a) 1) i) A) I)
+
     def ol_depth(node)
       depth = node.ancestors("ul, ol").size + 1
       type = :alphabet

data/lib/isodoc/{references.rb → function/references.rb}

@@ -1,5 +1,6 @@
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module References
+
     def docid_l10n(x)
       return x if x.nil?
       x.gsub(/All Parts/, @all_parts_lbl)
@@ -65,7 +66,7 @@ module IsoDoc
     end
 
     def reference_format(b, r)
-      title = b.at(ns("./formattedref")) || 
+      title = b.at(ns("./formattedref")) ||
         b.at(ns("./title[@language = '#{@language}']")) || b.at(ns("./title"))
       title&.children&.each { |n| parse(n, r) }
     end

data/lib/isodoc/{section.rb → function/section.rb}

@@ -1,5 +1,6 @@
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module Section
+
     def inline_header_title(out, node, c1)
       out.span **{ class: "zzMoveToFollowing" } do |s|
         s.b do |b|
@@ -43,7 +44,7 @@ module IsoDoc
       div.parent.at(".//h1")
     end
 
-    MIDDLE_CLAUSE = 
+    MIDDLE_CLAUSE =
       "//clause[parent::sections][not(xmlns:title = 'Scope')]"\
       "[not(descendant::terms)]".freeze
 

data/lib/isodoc/{table.rb → function/table.rb}

@@ -1,5 +1,6 @@
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module Table
+
     def table_title_parse(node, out)
       name = node.at(ns("./name"))
       out.p **{ class: "TableTitle", align: "center" } do |p|

data/lib/isodoc/{terms.rb → function/terms.rb}

@@ -1,5 +1,6 @@
-module IsoDoc
-  class Common
+module IsoDoc::Function
+  module Terms
+
     def definition_parse(node, out)
       node.children.each { |n| parse(n, out) }
     end

data/lib/isodoc/{iso2wordhtml.rb → function/to_word_html.rb}

@@ -1,7 +1,6 @@
-require "pp"
+module IsoDoc::Function
+  module ToWordHtml
 
-module IsoDoc
-  class Common
     def set_termdomain(termdomain)
       @termdomain = termdomain
     end

data/lib/isodoc/{utils.rb → function/utils.rb}

@@ -1,28 +1,12 @@
-module IsoDoc
-  class Common
-    def self.ns(xpath)
-      xpath.gsub(%r{/([a-zA-z])}, "/xmlns:\\1").
-        gsub(%r{::([a-zA-z])}, "::xmlns:\\1").
-        gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1").
-        gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
-    end
-
-    def ns(xpath)
-      Common::ns(xpath)
-    end
+module IsoDoc::Function
+  module Utils
 
-    def self.date_range(date)
-      from = date.at(ns("./from"))
-      to = date.at(ns("./to"))
-      on = date.at(ns("./on"))
-      return on.text if on
-      ret = "#{from.text}–"
-      ret += to.text if to
-      ret
+    def date_range(date)
+      self.class.date_range(date)
     end
 
-    def date_range(date)
-      Common::date_range(date)
+    def ns(xpath)
+      self.class.ns(xpath)
     end
 
     def insert_tab(out, n)