asciidoctor-iso 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff009fa5a7024c54efd53fc7e8a353559d1ab6a
-  data.tar.gz: 7bd27462cb448bfb0ce0947ebf60a622b9215a95
+  metadata.gz: 7ff84c9af977a9b2adf3922bca65699f511b6d8c
+  data.tar.gz: b947358c67928d815d674c49b6aeed1d813b20f0
 SHA512:
-  metadata.gz: 4f221438783ca673de960d8143f1aa196c8a5748d839cdb048f6ec3d6dd4fe8d0d927f137c8a03e9ac1e7dba47a642ebf77eb643a24a65c148b85c958e83a465
-  data.tar.gz: cd1ae57550314578b6fe0df3d7917c793f273255e248eacb78592f98dc12fb2dc15c06f05c092323230ecf67c360d736953e06fffd9e878a325055a5f23d81df
+  metadata.gz: 3332e2fde234aab645e965644750bc650acfe94b590eb090358fc2ede5683ca54940f8f9bc81dedca11007fe6a6da4abeb57c4b9ed5ef021cbf185af21d60ff0
+  data.tar.gz: 8aba7335bf894058658fb2511812a01d65dd3a0d9a9b0ce7d65ebcaf6b4506f96636a0d22dd5a612cfede9d78117226ec6fcfeb1d1e02d7d61bb3676e20d4145

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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. The project team will review and investigate all complaints, and will respond in a way that it deems 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.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/riboseinc/html2doc.git
-  revision: 9782088aac279f45a4420e977922ea141bc46a24
+  revision: 3b42789ece0ac0bb3de2c208062aca0feca4f797
   specs:
-    html2doc (0.6.7)
+    html2doc (0.6.9)
       asciimath
       htmlentities (~> 4.3.4)
       image_size
@@ -14,9 +14,9 @@ GIT
 
 GIT
   remote: https://github.com/riboseinc/isodoc.git
-  revision: b5db3572f9312f9d54ace3359d22236494584357
+  revision: 99f7eecc594e3763d98b60382588fae8e59fa0c0
   specs:
-    isodoc (0.5.5)
+    isodoc (0.5.7)
       asciimath
       html2doc
       htmlentities (~> 4.3.4)
@@ -32,7 +32,7 @@ GIT
 PATH
   remote: .
   specs:
-    asciidoctor-iso (0.7.1)
+    asciidoctor-iso (0.7.2)
       asciidoctor (~> 1.5.6)
       html2doc
       htmlentities (~> 4.3.4)
@@ -51,7 +51,7 @@ GEM
     byebug (9.1.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    docile (1.1.5)
+    docile (1.3.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
     ffi (1.9.23)
@@ -92,7 +92,7 @@ GEM
       shellany (~> 0.0)
     optout (0.0.2)
     parallel (1.12.1)
-    parser (2.5.0.3)
+    parser (2.5.0.4)
       ast (~> 2.4.0)
     powerpack (0.1.1)
     pry (0.11.3)
@@ -117,7 +117,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.52.1)
+    rubocop (0.53.0)
       parallel (~> 1.10)
       parser (>= 2.5)
       powerpack (~> 0.1)
@@ -130,8 +130,8 @@ GEM
     ruby-xslt (0.9.10)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)

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/lib/asciidoctor/iso/base.rb

@@ -31,15 +31,22 @@ module Asciidoctor
         File.join(File.dirname(__FILE__), File.join("html", file))
       end
 
-      def doc_converter(node)
+      def html_converter(node)
         IsoDoc::Convert.new(
           htmlstylesheet: html_doc_path("htmlstyle.css"),
+          standardstylesheet: html_doc_path("isodoc.css"),
+          htmlcoverpage: html_doc_path("html_iso_titlepage.html"),
+          htmlintropage: html_doc_path("html_iso_intro.html"),
+          i18nyaml: node.attr("i18nyaml"),
+        )
+      end
+
+      def doc_converter(node)
+        IsoDoc::WordConvert.new(
           wordstylesheet:  html_doc_path("wordstyle.css"),
           standardstylesheet: html_doc_path("isodoc.css"),
           header: html_doc_path("header.html"),
-          htmlcoverpage: html_doc_path("html_iso_titlepage.html"),
           wordcoverpage: html_doc_path("word_iso_titlepage.html"),
-          htmlintropage: html_doc_path("html_iso_intro.html"),
           wordintropage: html_doc_path("word_iso_intro.html"),
           i18nyaml: node.attr("i18nyaml"),
           ulstyle: "l3",
@@ -63,6 +70,7 @@ module Asciidoctor
         filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
           gsub(%r{^.*/}, "")
         File.open(filename, "w") { |f| f.write(ret) }
+        html_converter(node).convert filename unless node.attr("nodoc")
         doc_converter(node).convert filename unless node.attr("nodoc")
         ret
       end

data/lib/asciidoctor/iso/front.rb

@@ -39,6 +39,10 @@ module Asciidoctor
             "International Organization for Standardization"].include? orgname
           org.name "International Organization for Standardization"
           org.abbreviation "ISO"
+        elsif ["IEC", 
+                 "International Electrotechnical Commission"].include? orgname
+          org.name "International Electrotechnical Commission"
+          org.abbreviation "IEC"
         else
           org.name orgname
         end

data/lib/asciidoctor/iso/inline.rb

@@ -1,5 +1,5 @@
 require "asciidoctor/extensions"
-require "HTMLEntities"
+require "htmlentities"
 
 module Asciidoctor
   module ISO

data/lib/asciidoctor/iso/validate.rb

@@ -43,7 +43,8 @@ module Asciidoctor
       def title_subpart_validate(root)
         subpart = root.at("//bibdata/docidentifier/project-number[@subpart]")
         iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
-                      "organization[name = 'IEC']")
+                      "organization[abbreviation = 'IEC' or "\
+                      "name = 'International Electrotechnical Commission']")
         warn("Subpart defined on non-IEC document!") if subpart && !iec
       end
 
@@ -67,139 +68,139 @@ module Asciidoctor
             subtitle = ss.at("./title")
             !subtitle.nil? && !subtitle&.text&.empty? ||
               warn("#{title}: each first-level subclause must have a title")
-          end
-        end
       end
+    end
+  end
 
-      def title_all_siblings(xpath, label)
-        notitle = false
-        withtitle = false
-        xpath.each do |s|
-          title_all_siblings(s.xpath("./subsection | ./terms"),
-                             s&.at("./title")&.text || s["id"])
-          subtitle = s.at("./title")
-          notitle = notitle || (!subtitle || subtitle.text.empty?)
-          withtitle = withtitle || !subtitle&.text&.empty?
-        end
-        notitle && withtitle &&
-          warn("#{label}: all subclauses must have a title, or none")
-      end
+  def title_all_siblings(xpath, label)
+    notitle = false
+    withtitle = false
+    xpath.each do |s|
+      title_all_siblings(s.xpath("./subsection | ./terms"),
+                         s&.at("./title")&.text || s["id"])
+      subtitle = s.at("./title")
+      notitle = notitle || (!subtitle || subtitle.text.empty?)
+      withtitle = withtitle || !subtitle&.text&.empty?
+    end
+    notitle && withtitle &&
+      warn("#{label}: all subclauses must have a title, or none")
+  end
 
-      def title_validate(root)
-        title_intro_validate(root)
-        title_main_validate(root)
-        title_part_validate(root)
-        title_subpart_validate(root)
-        title_names_type_validate(root)
-        title_first_level_validate(root)
-        title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
-      end
+  def title_validate(root)
+    title_intro_validate(root)
+    title_main_validate(root)
+    title_part_validate(root)
+    title_subpart_validate(root)
+    title_names_type_validate(root)
+    title_first_level_validate(root)
+    title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
+  end
 
-      def onlychild_clause_validate(root)
-        root.xpath("//subsection").each do |c|
-          next unless c.xpath("../subsection").size == 1
-          title = c.at("./title")
-          location = c["id"] || c.text[0..60] + "..."
-          location += ":#{title.text}" if c["id"] && !title.nil?
-          warn "ISO style: #{location}: subsection is only child"
-        end
-      end
+  def onlychild_clause_validate(root)
+    root.xpath("//subsection").each do |c|
+      next unless c.xpath("../subsection").size == 1
+      title = c.at("./title")
+      location = c["id"] || c.text[0..60] + "..."
+      location += ":#{title.text}" if c["id"] && !title.nil?
+      warn "ISO style: #{location}: subsection is only child"
+    end
+  end
 
-      def isosubgroup_validate(root)
-        root.xpath("//technical-committee/@type").each do |t|
-          unless %w{TC PC JTC JPC}.include? t.text
-            warn "ISO: invalid technical committee type #{t}"
-          end
-        end
-        root.xpath("//subcommittee/@type").each do |t|
-          unless %w{SC JSC}.include? t.text
-            warn "ISO: invalid subcommittee type #{t}"
-          end
-        end
+  def isosubgroup_validate(root)
+    root.xpath("//technical-committee/@type").each do |t|
+      unless %w{TC PC JTC JPC}.include? t.text
+        warn "ISO: invalid technical committee type #{t}"
       end
-
-      def see_xrefs_validate(root)
-        root.xpath("//xref").each do |t|
-          # does not deal with preceding text marked up
-          preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\bsee\s*$/mi.match?(preceding)
-          (target = root.at("//*[@id = '#{t['target']}']")) || next
-          if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
-            warn "ISO: 'see #{t['target']}' is pointing to a normative section"
-          end
-        end
+    end
+    root.xpath("//subcommittee/@type").each do |t|
+      unless %w{SC JSC}.include? t.text
+        warn "ISO: invalid subcommittee type #{t}"
       end
+    end
+  end
 
-      def see_erefs_validate(root)
-        root.xpath("//eref").each do |t|
-          preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\bsee\s*$/mi.match?(preceding)
-          target = root.at("//*[@id = '#{t['bibitemid']}']")
-          if target.at("./ancestor::references"\
-              "[title = 'Normative References']")
-            warn "ISO: 'see #{t}' is pointing to a normative reference"
-          end
-        end
+  def see_xrefs_validate(root)
+    root.xpath("//xref").each do |t|
+      # does not deal with preceding text marked up
+      preceding = t.at("./preceding-sibling::text()[last()]")
+      next unless !preceding.nil? && /\bsee\s*$/mi.match?(preceding)
+      (target = root.at("//*[@id = '#{t['target']}']")) || next
+      if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
+        warn "ISO: 'see #{t['target']}' is pointing to a normative section"
       end
+    end
+  end
 
-      def termdef_warn(text, re, term, msg)
-        re.match?(text) && warn("ISO style: #{term}: #{msg}")
+  def see_erefs_validate(root)
+    root.xpath("//eref").each do |t|
+      preceding = t.at("./preceding-sibling::text()[last()]")
+      next unless !preceding.nil? && /\bsee\s*$/mi.match?(preceding)
+      target = root.at("//*[@id = '#{t['bibitemid']}']")
+      if target.at("./ancestor::references"\
+          "[title = 'Normative References']")
+        warn "ISO: 'see #{t}' is pointing to a normative reference"
       end
+    end
+  end
 
-      def termdef_style(xmldoc)
-        xmldoc.xpath("//term").each do |t|
-          para = t.at("./definition") || return
-          term = t.at("./preferred").text
-          termdef_warn(para.text, /^(the|a)\b/i, term,
-                       "term definition starts with article")
-          termdef_warn(para.text, /\.$/i, term,
-                       "term definition ends with period")
-        end
-      end
+  def termdef_warn(text, re, term, msg)
+    re.match?(text) && warn("ISO style: #{term}: #{msg}")
+  end
 
-      def content_validate(doc)
-        title_validate(doc.root)
-        isosubgroup_validate(doc.root)
-        section_validate(doc)
-        onlychild_clause_validate(doc.root)
-        termdef_style(doc.root)
-        see_xrefs_validate(doc.root)
-        see_erefs_validate(doc.root)
-      end
+  def termdef_style(xmldoc)
+    xmldoc.xpath("//term").each do |t|
+      para = t.at("./definition") || return
+      term = t.at("./preferred").text
+      termdef_warn(para.text, /^(the|a)\b/i, term,
+                   "term definition starts with article")
+      termdef_warn(para.text, /\.$/i, term,
+                   "term definition ends with period")
+    end
+  end
 
-      def schema_validate(doc, filename)
-        File.open(".tmp.xml", "w") { |f| f.write(doc.to_xml) }
-        begin
-          errors = Jing.new(filename).validate(".tmp.xml")
-        rescue Jing::Error => e
-          abort "what what what #{e}"
-        end
-        warn "Valid!" if errors.none?
-        errors.each do |error|
-          warn "#{error[:message]} @ #{error[:line]}:#{error[:column]}"
-        end
-      end
+  def content_validate(doc)
+    title_validate(doc.root)
+    isosubgroup_validate(doc.root)
+    section_validate(doc)
+    onlychild_clause_validate(doc.root)
+    termdef_style(doc.root)
+    see_xrefs_validate(doc.root)
+    see_erefs_validate(doc.root)
+  end
 
-      # RelaxNG cannot cope well with wildcard attributes. So we strip
-      # any attributes from FormattedString instances (which can contain
-      # xs:any markup, and are signalled with @format) before validation.
-      def formattedstr_strip(doc)
-        doc.xpath("//*[@format]").each do |n|
-          n.elements.each do |e|
-            e.traverse do |e1|
-              next unless e1.element?
-              e1.each { |k, _v| e.delete(k) }
-            end
-          end
-        end
-        doc
-      end
+  def schema_validate(doc, filename)
+    File.open(".tmp.xml", "w") { |f| f.write(doc.to_xml) }
+    begin
+      errors = Jing.new(filename).validate(".tmp.xml")
+    rescue Jing::Error => e
+      abort "what what what #{e}"
+    end
+    warn "Valid!" if errors.none?
+    errors.each do |error|
+      warn "#{error[:message]} @ #{error[:line]}:#{error[:column]}"
+    end
+  end
 
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "isostandard.rng"))
+  # RelaxNG cannot cope well with wildcard attributes. So we strip
+  # any attributes from FormattedString instances (which can contain
+  # xs:any markup, and are signalled with @format) before validation.
+  def formattedstr_strip(doc)
+    doc.xpath("//*[@format]").each do |n|
+      n.elements.each do |e|
+        e.traverse do |e1|
+          next unless e1.element?
+          e1.each { |k, _v| e.delete(k) }
+        end
       end
     end
+    doc
+  end
+
+  def validate(doc)
+    content_validate(doc)
+    schema_validate(formattedstr_strip(doc.dup),
+                    File.join(File.dirname(__FILE__), "isostandard.rng"))
+  end
+end
   end
 end