stepmod-utils 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e4d599185173c2dc2b664b26f9591511b0184ec1190e3a89ad9b5cde95b106'
-  data.tar.gz: 4bd7e2f8836a9286bd89aa2d41f3d4c79ec7886599cdfb0b11ac7921dea1da59
+  metadata.gz: 0234a977f2b4fe70773fb53f5a213858c45b217a127ac34d6497adee7bbc1324
+  data.tar.gz: 8d9c942f9c36ddca312712fcf4eae5f25b9c3080685d8d559bc19ac059e7c7a9
 SHA512:
-  metadata.gz: 3afb45f12dcd6956168d73d904a1115a03defb34f1d24c902b6032c8d48760a71b6bdbd487ea77d38f2faba7eee5ebc55315359d17c608f65355fdb66c9ffb70
-  data.tar.gz: 67b772b81e21ef50811f04ec7da137b19fe4569fd77f84f149036fc84b03f3d43de68f1bfc7292fae9fce9c07ef020a75b9b0a685c0b0642fc33b03216ad1c54
+  metadata.gz: bacc43cbc1ae0631ddac9e06c08f9ad61e5447acbeb4d55ee46a91203a363073efc96bf207c3c64ea04b4f0108726ff064a8a1e093620c40cd4f5da85d255624
+  data.tar.gz: 6bc94140c41c77370ba94048539fe2eae93cfa760272a3b36af97c40cfac233ec32d55425102ea75a92693a8058e0224e9fdebbe4eee910b45d33e6cfc295860

data/README.adoc

@@ -25,7 +25,11 @@ Or include it in your gemspec.
 
 [source,sh]
 ----
-stepmod-extract-terms {stepmod-data-directory}
+# Extracts from current directory
+$ stepmod-extract-terms
+
+# Extracts from specified stepmod/ or stepmod/data/ directory
+$ stepmod-extract-terms {stepmod-data-directory}
 ----
 
 Then these files will be created:

data/exe/stepmod-extract-terms

@@ -22,37 +22,49 @@ require 'stepmod/utils/stepmod_definition_converter'
 require 'stepmod/utils/bibdata'
 require 'stepmod/utils/concept'
 
-ReverseAsciidoctor.config.unknown_tags = :bypass
+ReverseAdoc.config.unknown_tags = :bypass
 
 parsed_terms = []
 parsed_bibliography = []
 encountered_terms = {}
 
-paths = ARGV.map do |path|
-  path = "../iso-10303-stepmod/data"
-  puts "Searching for #{path}/{resource,module,application_protocol,business_object_model}.xml..."
-  Dir[
-    "#{path}/**/resource.xml",
-    "#{path}/**/application_protocol.xml",
-    "#{path}/**/business_object_model.xml",
-    "#{path}/**/module.xml"
-  ]
+stepmod_dir = ARGV.first || Dir.pwd
+
+def log message
+  puts "[stepmod-utils] #{message}"
+end
+
+log "STEPmod directory set to #{stepmod_dir}. Detecting paths..."
+
+files = %w(
+  resource.xml
+  application_protocol.xml
+  business_object_model.xml
+  module.xml
+  ).inject([]) do |acc, t|
+    acc << Dir["#{stepmod_dir}/**/#{t}"]
 end.flatten.sort.uniq
 
-paths.each do |file_path|
-  puts("Processing XML file #{file_path}")
+files.each do |file_path|
+  log "Processing XML file #{file_path}"
   current_document = Nokogiri::XML(File.read(file_path)).root
 
   bibdata = nil
   begin
     bibdata = Stepmod::Utils::Bibdata.new(document: current_document)
   rescue
-    puts "WARNING: Unknown file #{file_path}, skipped"
+    log "WARNING: Unknown file #{file_path}, skipped"
+    next
+  end
+
+  # TODO: we may want a command line option to override this in the future
+  unless %w(IS DIS TS).include? bibdata.doctype
+    log "WARNING: skipping #{bibdata.docid} as it is not IS, DIS or TS"
     next
   end
 
   if bibdata.part.to_s.empty?
-    puts "FATAL: missing `part` attribute: #{file_path}"
+    log "FATAL: missing `part` attribute: #{file_path}"
   end
 
   # read definitions
@@ -61,7 +73,7 @@ paths.each do |file_path|
     term_id = definition['id']
     unless term_id.nil?
       if encountered_terms[term_id]
-        puts "FATAL: Duplicated term with id: #{term_id}, #{file_path}"
+        log "FATAL: Duplicated term with id: #{term_id}, #{file_path}"
       end
       encountered_terms[term_id] = true
     end
@@ -86,6 +98,10 @@ File.open('031-generated-terms.adoc', 'w') { |file|
   file.puts(parsed_terms.map(&:to_mn_adoc).join("\n"))
 }
 
+log "written to: 031-generated-terms.adoc"
+
 File.open('991-generated-bibliography.adoc', 'w') { |file|
   file.puts(parsed_bibliography.map(&:to_mn_adoc).join("\n"))
 }
+
+log "written to: 991-generated-bibliography.adoc"

data/lib/stepmod/utils/bibdata.rb

@@ -29,7 +29,7 @@ module Stepmod
         @pub_year = document['publication.year'].split('-').first
         @pub_date = document['publication.date']
 
-        puts to_mn_adoc
+        # puts to_mn_adoc
 
         return self
         # <module
@@ -104,14 +104,14 @@ module Stepmod
       end
 
       def anchor
-        docid.gsub('/', '-').gsub(' ', '_')
+        docid.gsub('/', '-').gsub(' ', '_').gsub(':', '_')
       end
 
       def to_mn_adoc
         if title_en
-          "* [[[ISO#{DOCNUMBER}-#{part},#{docid}]]], _#{full_title}_"
+          "* [[[#{anchor},#{docid}]]], _#{full_title}_"
         else
-          "* [[[ISO#{DOCNUMBER}-#{part},#{docid}]]]"
+          "* [[[#{anchor},#{docid}]]]"
         end
       end
 

data/lib/stepmod/utils/converters/clause_ref.rb

@@ -3,7 +3,7 @@
 module Stepmod
   module Utils
     module Converters
-      class ClauseRef < ReverseAsciidoctor::Converters::Base
+      class ClauseRef < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
           " term:[#{normalized_ref(node['linkend'])}] "
         end
@@ -16,7 +16,7 @@ module Stepmod
           ref.to_s.split(':').last.squeeze(' ').strip
         end
       end
-      ReverseAsciidoctor::Converters.register :clause_ref, ClauseRef.new
+      ReverseAdoc::Converters.register :clause_ref, ClauseRef.new
     end
   end
 end

data/lib/stepmod/utils/converters/def.rb

@@ -2,7 +2,7 @@
 module Stepmod
   module Utils
     module Converters
-      class Def < ReverseAsciidoctor::Converters::Base
+      class Def < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           node = node.dup
           "#{additional_block(node)}#{treat_children(node, state)}"
@@ -12,12 +12,7 @@ module Stepmod
 
         def treat_children(node, state)
           converted = node.children.each_with_object({}) do |child, res|
-                        content = treat(child, state)
-                                    .split("\n")
-                                    .map(&:strip)
-                                    .reject(&:empty?)
-                                    .join("\n")
-                                    .strip
+                        content = treat(child, state).strip
                         next if content.empty?
 
                         res[child] = content
@@ -25,7 +20,7 @@ module Stepmod
           previous = nil
           result = ''
           converted.each.with_index do |(child, content), i|
-            if i == 0 || inlinde_tag?(child, previous)
+            if i == 0 || !block_tag?(child, previous)
               result += " #{content}"
             else
               result += "\n\n#{content}"
@@ -35,8 +30,9 @@ module Stepmod
           result.strip
         end
 
-        def inlinde_tag?(child, previous)
-          %w[text sub i clause_ref].include?(child.name) && previous && %w[i sub text clause_ref].include?(previous.name)
+        def block_tag?(child, previous)
+          %w[ul example note alt p].include?(child.name) ||
+            (child.previous && %w[ul example note alt p].include?(child.previous.name))
         end
 
         def additional_block(node)
@@ -44,8 +40,7 @@ module Stepmod
           first_child_tag = node
                               .children
                               .find { |n| n.is_a?(Nokogiri::XML::Element) }
-          return unless first_child_tag&.name == 'p' &&
-                          defined?(Stepmod::Utils::Converters::Synonym)
+          return unless can_transform_to_alt?(first_child_tag)
 
           result = Stepmod::Utils::Converters::Synonym
                     .new
@@ -53,9 +48,22 @@ module Stepmod
           first_child_tag.remove
           "#{result}\n\n"
         end
+
+        # metanorma/stepmod-utils#18 when para is the only text doe snot transform it
+        def can_transform_to_alt?(first_child_tag)
+          return false unless first_child_tag&.name == 'p' &&
+                                defined?(Stepmod::Utils::Converters::Synonym)
+
+          next_sibling = first_child_tag.next
+          while next_sibling
+            return true if !next_sibling.text.to_s.strip.empty? && %w[p text].include?(next_sibling.name)
+            next_sibling = next_sibling.next
+          end
+          false
+        end
       end
 
-      ReverseAsciidoctor::Converters.register :def, Def.new
+      ReverseAdoc::Converters.register :def, Def.new
     end
   end
 end

data/lib/stepmod/utils/converters/definition.rb

@@ -3,7 +3,7 @@
 module Stepmod
   module Utils
     module Converters
-      class Definition < ReverseAsciidoctor::Converters::Base
+      class Definition < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           treat_children(node, state)
         end
@@ -16,7 +16,7 @@ module Stepmod
         end
       end
 
-      ReverseAsciidoctor::Converters.register :definition, Definition.new
+      ReverseAdoc::Converters.register :definition, Definition.new
     end
   end
 end

data/lib/stepmod/utils/converters/em.rb

@@ -3,7 +3,7 @@
 module Stepmod
   module Utils
     module Converters
-      class Em < ReverseAsciidoctor::Converters::Base
+      class Em < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           content = treat_children(node, state.merge(already_italic: true))
           if content.strip.empty? || state[:already_italic]
@@ -14,8 +14,8 @@ module Stepmod
         end
       end
 
-      ReverseAsciidoctor::Converters.register :em, Em.new
-      ReverseAsciidoctor::Converters.register :cite,  Em.new
+      ReverseAdoc::Converters.register :em, Em.new
+      ReverseAdoc::Converters.register :cite,  Em.new
     end
   end
 end

data/lib/stepmod/utils/converters/example.rb

@@ -3,7 +3,7 @@
 module Stepmod
   module Utils
     module Converters
-      class Example < ReverseAsciidoctor::Converters::Base
+      class Example < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           <<~TEMPLATE
             [example]
@@ -13,7 +13,7 @@ module Stepmod
           TEMPLATE
         end
       end
-      ReverseAsciidoctor::Converters.register :example, Example.new
+      ReverseAdoc::Converters.register :example, Example.new
     end
   end
 end

data/lib/stepmod/utils/converters/express_ref.rb

@@ -3,12 +3,12 @@
 module Stepmod
   module Utils
     module Converters
-      class ExpressRef < ReverseAsciidoctor::Converters::Base
+      class ExpressRef < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
           "*#{node['linkend'].to_s.split('.').last}*"
         end
       end
-      ReverseAsciidoctor::Converters.register :express_ref, ExpressRef.new
+      ReverseAdoc::Converters.register :express_ref, ExpressRef.new
     end
   end
 end

data/lib/stepmod/utils/converters/module_ref.rb

@@ -3,12 +3,31 @@
 module Stepmod
   module Utils
     module Converters
-      class ModuleRef < ReverseAsciidoctor::Converters::Base
+      class ModuleRef < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
-          " term:[#{node['linkend']}] "
+          ref = node['linkend']
+          # #23:
+          # In this case when we see this:
+
+          # <module_ref linkend="product_as_individual:3_definition">individual products</module_ref>
+          # We take the text value of the element and convert to this:
+
+          # term:[individual products]
+          if node['linkend'].split(':').length > 1
+            ref = node.text
+          end
+          " term:[#{normalized_ref(ref)}] "
+        end
+
+        private
+
+        def normalized_ref(ref)
+          return unless ref || ref.empty?
+
+          ref.squeeze(' ').strip
         end
       end
-      ReverseAsciidoctor::Converters.register :module_ref, ModuleRef.new
+      ReverseAdoc::Converters.register :module_ref, ModuleRef.new
     end
   end
 end

data/lib/stepmod/utils/converters/note.rb

@@ -3,7 +3,7 @@
 module Stepmod
   module Utils
     module Converters
-      class Note < ReverseAsciidoctor::Converters::Base
+      class Note < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           <<~TEMPLATE
             [NOTE]
@@ -13,7 +13,7 @@ module Stepmod
           TEMPLATE
         end
       end
-      ReverseAsciidoctor::Converters.register :note, Note.new
+      ReverseAdoc::Converters.register :note, Note.new
     end
   end
 end

data/lib/stepmod/utils/converters/ol.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Ol < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          id = node['id']
+          anchor = id ? "[[#{id}]]\n" : ""
+          ol_count = state.fetch(:ol_count, 0) + 1
+          attrs = ol_attrs(node)
+          res = "\n#{anchor}#{attrs}#{treat_children(node, state.merge(ol_count: ol_count))}"
+          res = "\n" + res if node.parent && node.parent.name == 'note'
+          res
+        end
+
+        def number_style(node)
+          style = case node["style"]
+                  when "1" then "arabic"
+                  when "A" then "upperalpha"
+                  when "a" then "loweralpha"
+                  when "I" then "upperroman"
+                  when "i" then "lowerroman"
+                  else
+                    nil
+                  end
+        end
+
+        def ol_attrs(node)
+          style = number_style(node)
+          reversed = "%reversed" if node["reversed"]
+          start = "start=#{node['start']}" if node["start"]
+          type = "type=#{node['type']}" if node["type"]
+          attrs = []
+          attrs << style if style
+          attrs << reversed if reversed
+          attrs << start if start
+          attrs << type if type
+          if attrs.empty?
+            ""
+          else
+            "[#{attrs.join(',')}]\n"
+          end
+        end
+      end
+
+      ReverseAdoc::Converters.register :ol, Ol.new
+      ReverseAdoc::Converters.register :ul, Ol.new
+      ReverseAdoc::Converters.register :dir, Ol.new
+    end
+  end
+end

data/lib/stepmod/utils/converters/stem.rb

@@ -5,7 +5,7 @@ require 'stepmod/utils/converters/em'
 module Stepmod
   module Utils
     module Converters
-      class Stem < ReverseAsciidoctor::Converters::Base
+      class Stem < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           return Em.new.convert(node, state) if node.text.strip.length > 8
 
@@ -13,7 +13,7 @@ module Stepmod
         end
       end
 
-      ReverseAsciidoctor::Converters.register :i, Stem.new
+      ReverseAdoc::Converters.register :i, Stem.new
     end
   end
 end

data/lib/stepmod/utils/converters/synonym.rb

@@ -3,13 +3,13 @@
 module Stepmod
   module Utils
     module Converters
-      class Synonym < ReverseAsciidoctor::Converters::Base
+      class Synonym < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           "alt:[#{node.text.strip}]"
         end
       end
 
-      ReverseAsciidoctor::Converters.register :synonym, Synonym.new
+      ReverseAdoc::Converters.register :synonym, Synonym.new
     end
   end
 end

data/lib/stepmod/utils/converters/term.rb

@@ -1,15 +1,29 @@
 # frozen_string_literal: true
 
+require 'stepmod/utils/converters/synonym'
+
 module Stepmod
   module Utils
     module Converters
-      class Term < ReverseAsciidoctor::Converters::Base
+      class Term < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          "=== #{treat_children(node, state).strip}"
+          first_child = node.children.find do |child|
+                          child.name == 'text' && !child.text.to_s.strip.empty?
+                        end
+          unless first_child &&
+                  node.text.split(';').length == 2 &&
+                  defined?(Stepmod::Utils::Converters::Synonym)
+            return "=== #{treat_children(node, state).strip}"
+          end
+
+          term_def, alt = node.text.split(';')
+          alt_xml = Nokogiri::XML::Text.new(alt, Nokogiri::XML::Document.new)
+          converted_alt = Stepmod::Utils::Converters::Synonym.new.convert(alt_xml)
+          "=== #{term_def}\n\n#{converted_alt}"
         end
       end
 
-      ReverseAsciidoctor::Converters.register :term, Term.new
+      ReverseAdoc::Converters.register :term, Term.new
     end
   end
 end

data/lib/stepmod/utils/stepmod_definition_converter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'reverse_asciidoctor'
+require 'reverse_adoc'
 require 'stepmod/utils/converters/clause_ref'
 require 'stepmod/utils/converters/express_ref'
 require 'stepmod/utils/converters/module_ref'
@@ -9,28 +9,28 @@ require 'stepmod/utils/converters/definition'
 require 'stepmod/utils/converters/em'
 require 'stepmod/utils/converters/example'
 require 'stepmod/utils/converters/note'
+require 'stepmod/utils/converters/ol'
 require 'stepmod/utils/converters/stem'
 require 'stepmod/utils/converters/term'
 require 'stepmod/utils/converters/synonym'
 
-require 'reverse_asciidoctor/converters/a'
-require 'reverse_asciidoctor/converters/blockquote'
-require 'reverse_asciidoctor/converters/bypass'
-require 'reverse_asciidoctor/converters/br'
-require 'reverse_asciidoctor/converters/code'
-require 'reverse_asciidoctor/converters/drop'
-require 'reverse_asciidoctor/converters/head'
-require 'reverse_asciidoctor/converters/hr'
-require 'reverse_asciidoctor/converters/ignore'
-require 'reverse_asciidoctor/converters/li'
-require 'reverse_asciidoctor/converters/ol'
-require 'reverse_asciidoctor/converters/p'
-require 'reverse_asciidoctor/converters/pass_through'
-require 'reverse_asciidoctor/converters/q'
-require 'reverse_asciidoctor/converters/strong'
-require 'reverse_asciidoctor/converters/sup'
-require 'reverse_asciidoctor/converters/sub'
-require 'reverse_asciidoctor/converters/text'
+require 'reverse_adoc/converters/a'
+require 'reverse_adoc/converters/blockquote'
+require 'reverse_adoc/converters/bypass'
+require 'reverse_adoc/converters/br'
+require 'reverse_adoc/converters/code'
+require 'reverse_adoc/converters/drop'
+require 'reverse_adoc/converters/head'
+require 'reverse_adoc/converters/hr'
+require 'reverse_adoc/converters/ignore'
+require 'reverse_adoc/converters/li'
+require 'reverse_adoc/converters/p'
+require 'reverse_adoc/converters/pass_through'
+require 'reverse_adoc/converters/q'
+require 'reverse_adoc/converters/strong'
+require 'reverse_adoc/converters/sup'
+require 'reverse_adoc/converters/sub'
+require 'reverse_adoc/converters/text'
 
 
 module Stepmod
@@ -47,9 +47,9 @@ module Stepmod
 
         root || (return '')
 
-        ReverseAsciidoctor.config.with(options) do
-          result = ReverseAsciidoctor::Converters.lookup(root.name).convert(root)
-          ReverseAsciidoctor.cleaner.tidy(result)
+        ReverseAdoc.config.with(options) do
+          result = ReverseAdoc::Converters.lookup(root.name).convert(root)
+          ReverseAdoc.cleaner.tidy(result)
         end
       end
     end

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.1.2"
+    VERSION = "0.1.7"
   end
 end

data/stepmod-utils.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "thor", "~> 1.0"
-  spec.add_runtime_dependency "reverse_adoc", "~> 0.2"
+  spec.add_runtime_dependency "thor", ">= 0.20.3"
+  spec.add_runtime_dependency "reverse_adoc", ">= 0.2.9"
   spec.add_development_dependency "byebug", "~> 11.1"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.20.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.20.3
 - !ruby/object:Gem::Dependency
   name: reverse_adoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.9
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - lib/stepmod/utils/converters/express_ref.rb
 - lib/stepmod/utils/converters/module_ref.rb
 - lib/stepmod/utils/converters/note.rb
+- lib/stepmod/utils/converters/ol.rb
 - lib/stepmod/utils/converters/stem.rb
 - lib/stepmod/utils/converters/synonym.rb
 - lib/stepmod/utils/converters/term.rb