metanorma-jis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 389469990940f3daa6877a9bfd6f3903ef3705e4a3bc0446de19e2d2c1a52930
+  data.tar.gz: b0cbac18b0e1cf0223d52ebe4cce6d2c7956a7a79a70e974369cf8d556c8bf9a
+SHA512:
+  metadata.gz: c14b13c90635a211a98d25a65850166c7d515aa49857ba99394664a571cee113f3c91db7e32c5ad523a51676b6a83536aec9fe8ccd0908c277bc1f748768e906
+  data.tar.gz: 5b6e900e60f71d0f4f4fb363269ef974fbdfa99690bc1a4292b8d05c20f195b7afe8878433368adbc95c5177a7b6f929f3d29cfb42c9da0a49f0bd690e5d189f

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gemspec
+gemspec
+
+if File.exist? "Gemfile.devel"
+  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
+end
+

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,81 @@
+= metanorma-JIS: Metanorma processor for Japanese Industrial Standards
+
+image:https://img.shields.io/gem/v/metanorma-jis.svg["Gem Version", link="https://rubygems.org/gems/metanorma-jis"]
+image:https://github.com/metanorma/metanorma-jis/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-jis/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/metanorma-jis/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-jis"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-jis.svg["Pull Requests", link="https://github.com/metanorma/metanorma-jis/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-jis/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-jis/releases"]
+
+== Functionality
+
+This gem processes https://www.metanorma.com[Metanorma documents] following
+the Metanorma model for generating JIS standards.
+
+The gem is basically the https://github.com/metanorma/metanorma-iso gem, with some tweaking of rendering to meet the particular requirements of the JIS.
+
+It provides the following functions:
+
+. Compiles Metanorma input into the Metanorma-JIS XML format (which is identical to Metanorma-ISO, since the two standards share the same document model)
+. Validates XML output against the Metanorma-JIS 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.
+. Metanorma-JIS XML is then converted into desired output formats.
+
+The following outputs are supported:
+
+* Primary: the canonical Metanorma-JIS XML representation (`.xml`).
+* Secondary: the Metanorma-JIS XML representation is processed to generate the following outputs
+as end deliverable JIS documents.
+** HTML (`.html`)
+** Word (`.doc`)
+** PDF (`.pdf`)
+
+== Structure
+
+This gem inherits from the https://github.com/metanorma/metanorma-iso
+gem, and aligns closely to it.
+
+
+=== Quickstart
+
+Please see https://www.metanorma.com for instructions to get started.
+
+You will need to setup your Git credentials for bundler or for HTTPS in order
+to fetch the software. Please refer to the following articles for details:
+
+* https://depfu.com/blog/2017/08/02/bundler-and-private-dependencies[Setting up bundler for private dependencies]
+* https://bundler.io/v1.16/bundle_config.html#CREDENTIALS-FOR-GEM-SOURCES[Bundler credentials for gem sources]
+* https://help.github.com/articles/caching-your-github-password-in-git[GitHub - Caching your GitHub credentials in Git]
+
+
+== Usage
+
+Using the `metanorma` CLI:
+
+[source,console]
+----
+$ metanorma --type jis a.adoc                   # output HTML
+$ metanorma --type jis --extensions html a.adoc # output just HTML
+$ metanorma --type jis --extensions xml a.adoc  # output Metanorma XML
+----
+
+
+== Authoring
+
+Please refer to the Metanorma-ISO documentation for general documentation.
+
+* Metanorma-ISO general documentation: https://www.metanorma.com/software/metanorma-iso/
+
+* Metanorma-ISO guidance: https://www.metanorma.com/software/metanorma-iso/docs/guidance/
+
+
+== Documentation
+
+See https://www.metanorma.com/author/iso/[Write ISO documents with Metanorma]
+
+== Examples
+
+* Example documents are avalable at the https://github.com/metanorma/mn-samples-jis[mn-samples-jis] repository.
+* Document templates are available at the https://github.com/metanorma/mn-templates-jis[mn-templates-jis] repository.
+

data/lib/html2doc/lists.rb

@@ -0,0 +1,166 @@
+class Html2Doc
+  class JIS < ::Html2Doc
+    def list2para(list)
+      return if list.xpath("./li").empty?
+
+      list.xpath("./li").each do |l|
+        list2para_level(l, list)
+      end
+    end
+
+    def style_list(elem, level, liststyle, listnumber)
+      return unless liststyle
+      elem["level"] = level
+      super
+    end
+
+    def list2para_level(item, list)
+      level = item["level"]
+      item.delete("level")
+      item.name = "p"
+      list2para_nest(item, level, list) if level
+    end
+
+    def list2para_nest(item, level, list)
+      item["class"] = list2para_style(list.name, level)
+      item.xpath("./p").each do |p|
+        p["class"] = list2para_style(list.name, level)
+        p["style"] = item["style"]
+        p["id"] = item["id"]
+      end
+      item.at("./p") or return
+      item.replace(item.children)
+=begin
+      prev = p1.xpath("./preceding-sibling::* | ./preceding-sibling::text()")
+      if prev[-1].name == "span" && prev[-1]["style"] == "mso-tab-count:1" &&
+          prev.size == 2
+        p1.children.first.previous = prev[1]
+        p1.children.first.previous = prev[0]
+      end
+=end
+    end
+
+    def list2para_unnest_para(para, first_p, last_p)
+      return if last_p.xpath("./following-sibling::* | ./following-sibling::text()")
+        .any? do |x|
+                  !x.text.strip.empty?
+                end
+
+      prev = first_p.xpath("./preceding-sibling::* | " \
+                           "./preceding-sibling::text()[normalize-space()]")
+      # bullet, tab, paragraph: ignore bullet, tab
+      if prev.empty? then para.replace(para.children)
+      elsif prev.size == 2 && prev[-1].name == "span" &&
+          prev[-1]["style"] == "mso-tab-count:1"
+        first_p.replace(first_p.children)
+      end
+    end
+
+    def list2para_style(listtype, depth)
+      case listtype
+      when "ul", "ol"
+        case depth
+        when "1" then "MsoList"
+        when "2", "3", "4", "5" then "MsoList#{depth}"
+        else "MsoList6"
+        end
+      end
+    end
+
+    def lists(docxml, liststyles)
+      super
+      docxml.xpath("//p[ol | ul]").each do |p|
+        list2para_unnest_para(p, p.at("./ol | ./ul"),
+                              p.at("./*[name() = 'ul' or name() = 'ol'][last()]"))
+      end
+      docxml.xpath("//ol | //ul").each do |u|
+        u.replace(u.children)
+      end
+      unnest_list_paras(docxml)
+      indent_lists(docxml)
+    end
+
+    def unnest_list_paras(docxml)
+      docxml.xpath("//p[@class = 'ListContinue1' or @class = 'ListNumber1']" \
+                   "[.//p]").each do |p|
+                     p.at("./p") and
+                       list2para_unnest_para(p, p.at("./p"),
+                                             p.at("./p[last()]"))
+                     p.xpath(".//p[p]").each do |p1|
+                       list2para_unnest_para(p1, p1.at("./p"),
+                                             p1.at("./p[last()]"))
+                     end
+                   end
+    end
+
+    def indent_lists(docxml)
+      docxml.xpath("//div[@class = 'Note' or @class = 'Example' or " \
+                   "@class = 'Quote']").each do |d|
+        d.xpath(".//p").each do |p|
+          indent_lists1(p)
+        end
+      end
+    end
+
+    def indent_lists1(para)
+      m = /^(ListContinue|ListNumber|MsoListContinue|MsoListNumber)(\d)$/
+        .match(para["class"]) or return
+      base = m[1].sub(/^Mso/, "")
+      level = m[2].to_i + 1
+      level = 5 if level > 5
+      para["class"] = "#{base}#{level}-"
+    end
+
+    def list_add(xpath, liststyles, listtype, level)
+      xpath.each do |l|
+        level == 1 and l["seen"] = true and @listnumber += 1
+        l["seen"] = true if level == 1
+        l["id"] ||= UUIDTools::UUID.random_create
+        list_add_number(l, liststyles, listtype, level)
+        list_add_tail(l, liststyles, listtype, level)
+      end
+    end
+
+    def list_add_number(list, liststyles, listtype, level)
+      i = list["start"] and @listnumber = list["start"].to_i - 1
+      (list.xpath(".//li") - list.xpath(".//ol//li | .//ul//li")).each do |li|
+        style_list(li, level, liststyles[listtype], @listnumber)
+        list_add1(li, liststyles, listtype, level)
+      end
+    end
+
+    def list_add_tail(list, liststyles, listtype, level)
+      list.xpath(".//ul[not(ancestor::li/ancestor::*/@id = '#{list['id']}')] | " \
+                 ".//ol[not(ancestor::li/ancestor::*/@id = '#{list['id']}')]")
+        .each do |li|
+        list_add1(li.parent, liststyles, listtype, level - 1)
+      end
+    end
+
+    def listlabel(listtype, idx, level)
+      case listtype
+      when :ul then "&#x2014;"
+      when :ol then "#{listidx(idx, level)})"
+      end
+    end
+
+    def listidx(idx, level)
+      case level
+      when "a" then (96 + idx).chr.to_s
+      when "1" then idx.to_s
+      when "i" then RomanNumerals.to_roman(idx).downcase
+      when "A" then (64 + idx).chr.to_s
+      when "I" then RomanNumerals.to_roman(idx).upcase
+      end
+    end
+
+    def cleanup(docxml)
+      super
+      docxml.xpath("//div[@class = 'Quote' or @class = 'Example' or " \
+                   "@class = 'Note']").each do |d|
+        d.delete("class")
+      end
+      docxml
+    end
+  end
+end

data/lib/isodoc/jis/base_convert.rb

@@ -0,0 +1,41 @@
+require "isodoc"
+require "metanorma-iso"
+
+module IsoDoc
+  module JIS
+    module BaseConvert
+      def middle_title(_isoxml, out)
+        middle_title_main(out)
+        middle_subtitle_main(out)
+        # middle_title_amd(out)
+      end
+
+      def middle_title_main(out)
+        out.p(class: "zzSTDTitle1") do |p|
+          p << @meta.get[:doctitleintro]
+          p << " &#x2014; " if @meta.get[:doctitleintro] && @meta.get[:doctitlemain]
+          p << @meta.get[:doctitlemain]
+          p << " &#x2014; " if @meta.get[:doctitlemain] && @meta.get[:doctitlepart]
+        end
+        a = @meta.get[:doctitlepart] and out.p(class: "zzSTDTitle1") do |p|
+          b = @meta.get[:doctitlepartlabel] and p << "#{b}: "
+          p << "<br/><b>#{a}</b>"
+        end
+      end
+
+      def middle_subtitle_main(out)
+        @meta.get[:docsubtitlemain] or return
+        out.p(class: "zzSTDTitle2") do |p|
+          p << @meta.get[:docsubtitleintro]
+          p << " &#x2014; " if @meta.get[:docsubtitleintro] && @meta.get[:docsubtitlemain]
+          p << @meta.get[:doctitlemain]
+          p << " &#x2014; " if @meta.get[:docsubtitlemain] && @meta.get[:docsubtitlepart]
+        end
+        a = @meta.get[:docsubtitlepart] and out.p(class: "zzSTDTitle2") do |p|
+          b = @meta.get[:docsubtitlepartlabel] and p << "#{b}: "
+          p << "<br/><b>#{a}</b>"
+        end
+      end
+    end
+  end
+end