stepmod-utils 0.1.5 → 0.2.3

data/exe/stepmod-extract-terms

@@ -1,8 +1,7 @@
-#!/usr/bin/env ruby
-
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
+require 'pry'
 # resolve bin path, ignoring symlinks
 require "pathname"
 bin_file = Pathname.new(__FILE__).realpath
@@ -21,8 +20,9 @@ require 'bundler/setup'
 require 'stepmod/utils/stepmod_definition_converter'
 require 'stepmod/utils/bibdata'
 require 'stepmod/utils/concept'
+require 'ptools'
 
-ReverseAsciidoctor.config.unknown_tags = :bypass
+ReverseAdoc.config.unknown_tags = :bypass
 
 parsed_terms = []
 parsed_bibliography = []
@@ -34,7 +34,22 @@ def log message
   puts "[stepmod-utils] #{message}"
 end
 
-log "STEPmod directory set to #{stepmod_dir}. Detecting paths..."
+stepmod_path = Pathname.new(stepmod_dir).realpath
+
+# If we are using the stepmod CVS repository, provide the revision number per file
+has_cvs = File.which("cvs")
+cvs_mode = has_cvs && Dir.exists?(stepmod_path.join('CVS'))
+
+log "INFO: STEPmod directory set to #{stepmod_dir}."
+
+if cvs_mode
+  log "INFO: STEPmod directory is a CVS repository and will detect revisions."
+  log "INFO: [CVS] Detecting file revisions can be slow, please be patient!"
+else
+  log "INFO: STEPmod directory is not a CVS repository, skipping revision detection."
+end
+
+log "INFO: Detecting paths..."
 
 files = %w(
   resource.xml
@@ -46,19 +61,48 @@ files = %w(
 end.flatten.sort.uniq
 
 files.each do |file_path|
-  log "Processing XML file #{file_path}"
+  file_path = Pathname.new(file_path).realpath
+  fpath = file_path.relative_path_from(stepmod_path)
+
+  log "INFO: Processing XML file #{fpath}"
   current_document = Nokogiri::XML(File.read(file_path)).root
 
   bibdata = nil
   begin
     bibdata = Stepmod::Utils::Bibdata.new(document: current_document)
   rescue
-    log "WARNING: Unknown file #{file_path}, skipped"
+    log "WARNING: Unknown file #{fpath}, 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 "INFO: skipped #{bibdata.docid} as it is not IS, DIS or TS"
     next
   end
 
   if bibdata.part.to_s.empty?
-    log "FATAL: missing `part` attribute: #{file_path}"
+    log "FATAL: missing `part` attribute: #{fpath}"
+    log "INFO: skipped #{bibdata.docid} as it is missing `part` attribute."
+    next
+  end
+
+  revision_string = "\n// CVS: revision not detected"
+  if cvs_mode
+    # Run `cvs status` to find out version
+
+    log "INFO: Detecting CVS revision..."
+    Dir.chdir(stepmod_path) do
+      status = `cvs status #{fpath}`
+
+      unless status.empty?
+        working_rev = status.split(/\n/).grep(/Working revision:/).first.match(/revision:\s+(.+)$/)[1]
+        repo_rev = status.split(/\n/).grep(/Repository revision:/).first.match(/revision:\t(.+)\t/)[1]
+        log "INFO: CVS working rev (#{working_rev}), repo rev (#{repo_rev})"
+        revision_string = "\n// CVS working rev: (#{working_rev}), repo rev (#{repo_rev})\n" +
+          "// CVS: revision #{working_rev == repo_rev ? 'up to date' : 'differs'}"
+      end
+    end
   end
 
   # read definitions
@@ -67,23 +111,28 @@ files.each do |file_path|
     term_id = definition['id']
     unless term_id.nil?
       if encountered_terms[term_id]
-        log "FATAL: Duplicated term with id: #{term_id}, #{file_path}"
+        log "FATAL: Duplicated term with id: #{term_id}, #{fpath}"
       end
       encountered_terms[term_id] = true
     end
 
+    # Assume that definition is located in clause 3 of the ISO document
+    # in order. We really don't have a good reference here.
+    ref_clause = "3.#{index}"
+
     concept = Stepmod::Utils::Concept.parse(
       definition,
       reference_anchor: bibdata.anchor,
-      # Assume that definition is located in clause 3 of the ISO document
-      # in order. We really don't have a good reference here.
-      reference_clause: "3.#{index}"
+      reference_clause: ref_clause,
+      file_path: fpath + revision_string
     )
 
     parsed_terms << concept
     parsed_bibliography << bibdata
   end
 
+  log "INFO: Completed processing XML file #{fpath}"
+
 end
 
 parsed_bibliography.uniq!
@@ -92,10 +141,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"
+log "INFO: 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"
+log "INFO: written to: 991-generated-bibliography.adoc"

data/exe/stepmod-find-express-files

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'nokogiri'
+
+stepmod_dir = ARGV.first || Dir.pwd
+
+index = Nokogiri::XML(File.read(File.join(stepmod_dir, 'repository_index.xml'))).root
+
+files = []
+index.xpath('modules/module').each do |item|
+  files << "#{stepmod_dir}/data/modules/#{item['name']}/arm.exp"
+  files << "#{stepmod_dir}/data/modules/#{item['name']}/mim.exp"
+end
+index.xpath('resources/resource').each do |item|
+  files << "#{stepmod_dir}/data/resources/#{item['name']}/#{item['name']}.exp"
+end
+index.xpath('business_object_models/business_object_model').each do |item|
+  files << "#{stepmod_dir}/data/business_object_models/#{item['name']}/bom.exp"
+  files << "#{stepmod_dir}/data/business_object_models/#{item['name']}/DomainModel.exp"
+end
+
+existing_files = files.filter{|file| File.exists?(file)}
+puts existing_files

data/lib/stepmod/utils/cleaner.rb

@@ -0,0 +1,11 @@
+require 'reverse_adoc/cleaner'
+
+module Stepmod
+  module Utils
+    class Cleaner < ReverseAdoc::Cleaner
+      def tidy(string)
+        super.gsub(/^ +/, '')
+      end
+    end
+  end
+end

data/lib/stepmod/utils/concept.rb

@@ -2,7 +2,17 @@ module Stepmod
   module Utils
 
     class Concept
-      attr_accessor *%w(designation definition reference_anchor reference_clause examples notes synonym converted_definition)
+      attr_accessor *%w(
+        designation
+        definition
+        reference_anchor
+        reference_clause
+        examples
+        notes
+        synonym
+        converted_definition
+        file_path
+      )
 
       def initialize(options)
         options.each_pair do |k, v|
@@ -10,20 +20,23 @@ module Stepmod
         end
       end
 
-      def self.parse(definition_xml, reference_anchor:, reference_clause:)
+      def self.parse(definition_xml, reference_anchor:, reference_clause:, file_path:)
         new(
           converted_definition: Stepmod::Utils::StepmodDefinitionConverter.convert(definition_xml),
           reference_anchor: reference_anchor,
-          reference_clause: reference_clause
+          reference_clause: reference_clause,
+          file_path: file_path
         )
       end
 
       def to_mn_adoc
         <<~TEXT
+          // STEPmod path: #{file_path}
           #{converted_definition}
 
           [.source]
           <<#{reference_anchor},clause=#{reference_clause}>>
+
         TEXT
       end
 

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Stepmod
+  module Utils
+    module Converters
+      class A < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          name  = treat_children(node, state)
+          href  = node['href']
+          title = extract_title(node)
+          id = node['id'] || node['name']
+
+          id = id&.gsub(/\s/, "")&.gsub(/__+/, "_")
+
+          if /^_Toc\d+$|^_GoBack$/.match id
+            ""
+          elsif !id.nil? && !id.empty?
+            "[[#{id}]]"
+          elsif href.to_s.start_with?('#')
+            href = href.sub(/^#/, "").gsub(/\s/, "").gsub(/__+/, "_")
+            if name.empty?
+              "<<#{href}>>"
+            else
+              "<<#{href},#{name}>>"
+            end
+          elsif href.to_s.empty?
+            name
+          else
+            name = title if name.empty?
+            href = "link:#{href}" unless href.to_s =~ URI::DEFAULT_PARSER.make_regexp
+            link = "#{href}[#{name}]"
+            # link.prepend(' ')
+            link = " #{link}"
+            link
+          end
+        end
+
+        private
+
+      end
+
+      ReverseAdoc::Converters.register :a, A.new
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Blockquote < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          id = node['id']
+          anchor = id ? "[[#{id}]]\n" : ""
+          cite = node['cite']
+          attrs = cite ? "[quote, #{cite}]\n" : ""
+          content = treat_children(node, state).strip
+          content = ReverseAdoc.cleaner.remove_newlines(content)
+          #"\n\n> " << content.lines.to_a.join('> ') << "\n\n"
+          "\n\n#{attrs}____\n" << content.lines.to_a.join('') << "\n____\n\n"
+        end
+      end
+
+      ReverseAdoc::Converters.register :blockquote, Blockquote.new
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Br < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          " +\n"
+        end
+      end
+
+      ReverseAdoc::Converters.register :br, Br.new
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Bypass < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          treat_children(node, state)
+        end
+      end
+
+      ReverseAdoc::Converters.register :document, Bypass.new
+      ReverseAdoc::Converters.register :html,     Bypass.new
+      ReverseAdoc::Converters.register :body,     Bypass.new
+      ReverseAdoc::Converters.register :span,     Bypass.new
+      ReverseAdoc::Converters.register :thead,    Bypass.new
+      ReverseAdoc::Converters.register :tbody,    Bypass.new
+      ReverseAdoc::Converters.register :tfoot,    Bypass.new
+      ReverseAdoc::Converters.register :abbr,    Bypass.new
+      ReverseAdoc::Converters.register :acronym,    Bypass.new
+      ReverseAdoc::Converters.register :address,    Bypass.new
+      ReverseAdoc::Converters.register :applet,    Bypass.new
+      ReverseAdoc::Converters.register :map,    Bypass.new
+      ReverseAdoc::Converters.register :area,    Bypass.new
+      ReverseAdoc::Converters.register :bdi,    Bypass.new
+      ReverseAdoc::Converters.register :bdo,    Bypass.new
+      ReverseAdoc::Converters.register :big,    Bypass.new
+      ReverseAdoc::Converters.register :button,    Bypass.new
+      ReverseAdoc::Converters.register :canvas,    Bypass.new
+      ReverseAdoc::Converters.register :data,    Bypass.new
+      ReverseAdoc::Converters.register :datalist,    Bypass.new
+      ReverseAdoc::Converters.register :del,    Bypass.new
+      ReverseAdoc::Converters.register :ins,    Bypass.new
+      ReverseAdoc::Converters.register :dfn,    Bypass.new
+      ReverseAdoc::Converters.register :dialog,    Bypass.new
+      ReverseAdoc::Converters.register :embed,    Bypass.new
+      ReverseAdoc::Converters.register :fieldset,    Bypass.new
+      ReverseAdoc::Converters.register :font,    Bypass.new
+      ReverseAdoc::Converters.register :footer,    Bypass.new
+      ReverseAdoc::Converters.register :form,    Bypass.new
+      ReverseAdoc::Converters.register :frame,    Bypass.new
+      ReverseAdoc::Converters.register :frameset,    Bypass.new
+      ReverseAdoc::Converters.register :header,    Bypass.new
+      ReverseAdoc::Converters.register :iframe,    Bypass.new
+      ReverseAdoc::Converters.register :input,    Bypass.new
+      ReverseAdoc::Converters.register :label,    Bypass.new
+      ReverseAdoc::Converters.register :legend,    Bypass.new
+      ReverseAdoc::Converters.register :main,    Bypass.new
+      ReverseAdoc::Converters.register :menu,    Bypass.new
+      ReverseAdoc::Converters.register :menulist,    Bypass.new
+      ReverseAdoc::Converters.register :meter,    Bypass.new
+      ReverseAdoc::Converters.register :nav,    Bypass.new
+      ReverseAdoc::Converters.register :noframes,    Bypass.new
+      ReverseAdoc::Converters.register :noscript,    Bypass.new
+      ReverseAdoc::Converters.register :object,    Bypass.new
+      ReverseAdoc::Converters.register :optgroup,    Bypass.new
+      ReverseAdoc::Converters.register :option,    Bypass.new
+      ReverseAdoc::Converters.register :output,    Bypass.new
+      ReverseAdoc::Converters.register :param,    Bypass.new
+      ReverseAdoc::Converters.register :picture,    Bypass.new
+      ReverseAdoc::Converters.register :progress,    Bypass.new
+      ReverseAdoc::Converters.register :ruby,    Bypass.new
+      ReverseAdoc::Converters.register :rt,    Bypass.new
+      ReverseAdoc::Converters.register :rp,    Bypass.new
+      ReverseAdoc::Converters.register :s,    Bypass.new
+      ReverseAdoc::Converters.register :select,    Bypass.new
+      ReverseAdoc::Converters.register :small,    Bypass.new
+      ReverseAdoc::Converters.register :span,    Bypass.new
+      ReverseAdoc::Converters.register :strike,    Bypass.new
+      ReverseAdoc::Converters.register :details,    Bypass.new
+      ReverseAdoc::Converters.register :section,    Bypass.new
+      ReverseAdoc::Converters.register :summary,    Bypass.new
+      ReverseAdoc::Converters.register :svg,    Bypass.new
+      ReverseAdoc::Converters.register :template,    Bypass.new
+      ReverseAdoc::Converters.register :textarea,    Bypass.new
+      ReverseAdoc::Converters.register :track,    Bypass.new
+      ReverseAdoc::Converters.register :u,    Bypass.new
+      ReverseAdoc::Converters.register :wbr,    Bypass.new
+    end
+  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/code.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Code < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          "`#{node.text}`"
+        end
+      end
+
+      ReverseAdoc::Converters.register :code, Code.new
+      ReverseAdoc::Converters.register :tt, Code.new
+      ReverseAdoc::Converters.register :kbd, Code.new
+      ReverseAdoc::Converters.register :samp, Code.new
+      ReverseAdoc::Converters.register :var, Code.new
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Comment < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          comment = node.text.strip.split("\n").map{|line| "// #{line}"}.join("\n")
+          "#{comment}\n"
+        end
+      end
+
+      ReverseAdoc::Converters.register :comment, Comment.new
+    end
+  end
+end