stepmod-utils 0.4.14 → 0.6.0

data/lib/stepmod/utils/stepmod_file_annotator.rb

@@ -30,7 +30,8 @@ module Stepmod
       end
 
       def resource_docs_schemas(stepmod_dir)
-        filepath = File.join(stepmod_dir, "data", "resource_docs", "*", "resource.xml")
+        filepath = File.join(stepmod_dir, "data", "resource_docs", "*",
+                             "resource.xml")
 
         schemas = {}
         Dir.glob(filepath).each do |resource_docs_file|
@@ -86,7 +87,8 @@ module Stepmod
             end
 
             schema_base_dir = resource_docs_cache[base_linked]
-            add_images_references(converted_description, schema_base_dir, processed_images_cache)
+            add_images_references(converted_description, schema_base_dir,
+                                  processed_images_cache)
 
             # Add converted description from exact linked path
             if resource_docs_dir && added_resource_descriptions[description["linkend"]].nil?
@@ -97,7 +99,8 @@ module Stepmod
           end
         end
 
-        bib_file_name = extract_bib_file_name(match, resource_docs_cache[@schema_name || ""])
+        bib_file_name = extract_bib_file_name(match,
+                                              resource_docs_cache[@schema_name || ""])
         bib_file = if match
                      File.join(File.dirname(express_file), bib_file_name)
                    else
@@ -135,13 +138,15 @@ module Stepmod
           .gsub(";;", ";")
       end
 
-      def add_images_references(description, schema_base_dir, processed_images_cache)
+      def add_images_references(description, schema_base_dir,
+processed_images_cache)
         referenced_images = description.scan(/image::(.*?)\[\]/).flatten
 
         referenced_images.each do |referenced_image|
           next unless schema_base_dir
 
-          image_file_path = File.join("resource_docs", schema_base_dir, referenced_image)
+          image_file_path = File.join("resource_docs", schema_base_dir,
+                                      referenced_image)
           new_image_file_path = referenced_image
 
           if processed_images_cache[new_image_file_path]
@@ -344,8 +349,10 @@ module Stepmod
         }
       end
 
-      def convert_from_resource_file(resource_docs_dir, stepmod_dir, linked, descriptions_file)
-        resource_docs_file = resource_docs_file_path(stepmod_dir, resource_docs_dir)
+      def convert_from_resource_file(resource_docs_dir, stepmod_dir, linked,
+descriptions_file)
+        resource_docs_file = resource_docs_file_path(stepmod_dir,
+                                                     resource_docs_dir)
 
         resource_docs = Nokogiri::XML(File.read(resource_docs_file)).root
         schema = resource_docs.xpath("schema[@name='#{linked}']")

data/lib/stepmod/utils/term.rb

@@ -9,7 +9,7 @@ module Stepmod
       def to_mn_adoc
         mn_adoc = ["=== #{definition.map(&:content).join}"]
         mn_adoc << "\nalt:[#{acronym}]" if acronym
-        mn_adoc << "\n\n#{designations.map(&:designation).join(", ")}" if designations&.any?
+        mn_adoc << "\n\n#{designations.map(&:designation).join(', ')}" if designations&.any?
 
         mn_adoc.join
       end

data/lib/stepmod/utils/terms_extractor.rb

@@ -67,9 +67,9 @@ module Stepmod
       end
 
       def published_part_numbers
-        docs_xml = Nokogiri::XML(File.read(@stepmod_path.join('library/docs.xml')))
+        docs_xml = Nokogiri::XML(File.read(@stepmod_path.join("library/docs.xml")))
         docs_xml.xpath("//doc").map do |x|
-          x['part']
+          x["part"]
         end.uniq.sort
       end
 
@@ -89,12 +89,12 @@ module Stepmod
 
         # add module paths
         repo_index.xpath("//module").each do |x|
-          unless published_part_nos.include? x['part']
+          unless published_part_nos.include? x["part"]
             log "INFO: skipping module #{x['name']} as part #{x['part']} is not published in `docs.xml`."
             next
           end
 
-          if x['status'] == WITHDRAWN_STATUS
+          if x["status"] == WITHDRAWN_STATUS
             log "INFO: skipping module #{x['name']} as it is withdrawn."
             next
           end
@@ -126,12 +126,12 @@ module Stepmod
 
         # add resource paths
         repo_index.xpath("//resource").each do |x|
-          unless published_part_nos.include? x['part']
+          unless published_part_nos.include? x["part"]
             log "INFO: skipping resource #{x['name']} as part #{x['part']} is not published in `docs.xml`."
             next
           end
 
-          if x['status'] == WITHDRAWN_STATUS
+          if x["status"] == WITHDRAWN_STATUS
             log "INFO: skipping resource #{x['name']} as it is withdrawn."
             next
           end
@@ -217,7 +217,7 @@ module Stepmod
 
           begin
             bibdata = Stepmod::Utils::ExpressBibdata.new(schema: schema)
-          rescue => e
+          rescue StandardError => e
             log e
             log "ERROR: while processing bibdata for `#{schema_name}`"
 
@@ -238,7 +238,7 @@ module Stepmod
 
           case type
           when "module_arm"
-            arm_concepts = parse_annotated_module(
+            parse_annotated_module(
               schema: schema,
               bibdata: bibdata,
               # See: metanorma/iso-10303-2#90
@@ -246,7 +246,7 @@ module Stepmod
               schema_type: type,
             )
           when "module_mim"
-            mim_concepts = parse_annotated_module(
+            parse_annotated_module(
               schema: schema,
               bibdata: bibdata,
               # See: metanorma/iso-10303-2#90
@@ -270,7 +270,8 @@ module Stepmod
         }[match.captures[0]] || "resource"
       end
 
-      def parse_annotated_module(schema:, bibdata:, domain_prefix:, schema_type:)
+      def parse_annotated_module(schema:, bibdata:, domain_prefix:,
+schema_type:)
         log "INFO: parse_annotated_module: " \
             "Processing modules schema #{schema.file}"
 
@@ -287,7 +288,7 @@ module Stepmod
               "name" => schema.id,
               "type" => "module",
               "path" => extract_file_path(entity.parent.file),
-              "schema_type" => schema_type
+              "schema_type" => schema_type,
             },
             document: {
               "type" => "module",
@@ -333,7 +334,7 @@ module Stepmod
               "name" => schema.id,
               "type" => "resource",
               "path" => extract_file_path(entity.parent.file),
-              "schema_type" => "resource"
+              "schema_type" => "resource",
             },
             document: {
               "type" => "resource",
@@ -365,7 +366,8 @@ module Stepmod
       end
 
       # rubocop:disable Metrics/MethodLength
-      def generate_concept_from_entity(entity:, schema:, domain:, bibdata:, document:)
+      def generate_concept_from_entity(entity:, schema:, domain:, bibdata:,
+document:)
         old_definition = trim_definition(entity.remarks.first)
         schema_type = schema["schema_type"]
         definition = generate_entity_definition(entity, domain, schema_type)
@@ -429,21 +431,21 @@ module Stepmod
         end
 
         # If full_paragraph ends with a period, this is the last.
-        if full_paragraph =~ /\.\s*\Z/
+        if /\.\s*\Z/.match?(full_paragraph)
           # puts "CONDITION 2"
           return full_paragraph
         end
 
         # If next_paragraph is a list
-        if next_paragraph.match(/\A\*/)
+        if next_paragraph.start_with?("*")
           # puts "CONDITION 3"
-          return full_paragraph + "\n\n" + next_paragraph
+          return "#{full_paragraph}\n\n#{next_paragraph}"
         end
 
         # If next_paragraph is a continuation of a list
-        if next_paragraph.match(/\Awhich/) || next_paragraph.match(/\Athat/)
+        if next_paragraph.start_with?("which", "that")
           # puts "CONDITION 4"
-          return full_paragraph + "\n\n" + next_paragraph
+          return "#{full_paragraph}\n\n#{next_paragraph}"
         end
 
         # puts "CONDITION 5"
@@ -501,7 +503,7 @@ module Stepmod
       def express_reference_to_mention(description)
         # TODO: Use Expressir to check whether the "entity" is really an
         # EXPRESS ENTITY. If not, skip the mention.
-        description.gsub(/<<express:([^,]+),([^>]+)>>/) do |match|
+        description.gsub(/<<express:([^,]+),([^>]+)>>/) do |_match|
           "{{#{Regexp.last_match[1].split('.').last},#{Regexp.last_match[2]}}}"
         end
       end
@@ -520,22 +522,22 @@ module Stepmod
       # end
 
       # rubocop:disable Layout/LineLength
-      def generate_entity_definition(entity, domain, schema_type)
+      def generate_entity_definition(entity, _domain, schema_type)
         return "" if entity.nil?
 
         # See: metanorma/iso-10303-2#90
         entity_type = case schema_type
-        when "module_arm"
-          "{{application object}}"
-        when "module_mim"
-          "{{entity data type}}"
-        when "resource", "business_object_model"
-          "{{entity data type}}"
-        else
-          raise Error.new("[stepmod-utils] encountered unsupported schema_type")
-        end
-
-        if entity.subtype_of.size.zero?
+                      when "module_arm"
+                        "{{application object}}"
+                      when "module_mim"
+                        "{{entity data type}}"
+                      when "resource", "business_object_model"
+                        "{{entity data type}}"
+                      else
+                        raise Error.new("[stepmod-utils] encountered unsupported schema_type")
+                      end
+
+        if entity.subtype_of.empty?
           "#{entity_type} " \
             "that represents the " \
             "#{entity_name_to_text(entity.id)} {{entity}}"

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.4.14".freeze
+    VERSION = "0.6.0".freeze
   end
 end

data/stepmod-utils.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -32,15 +32,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "concurrent-ruby"
+  spec.add_runtime_dependency "down"
   spec.add_runtime_dependency "expressir"
   spec.add_runtime_dependency "glossarist", "~> 2.0"
   spec.add_runtime_dependency "indefinite_article"
+  spec.add_runtime_dependency "octokit"
   spec.add_runtime_dependency "plurimath"
   spec.add_runtime_dependency "ptools"
   spec.add_runtime_dependency "pubid-iso"
-  spec.add_runtime_dependency "octokit"
-  spec.add_runtime_dependency "down"
   spec.add_runtime_dependency "reverse_adoc", ">= 0.3"
+  spec.add_runtime_dependency "shale"
   spec.add_runtime_dependency "thor", ">= 0.20"
   spec.add_runtime_dependency "unitsml"
   spec.add_development_dependency "rubocop"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 0.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: expressir
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: plurimath
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ptools
+  name: plurimath
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pubid-iso
+  name: ptools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: pubid-iso
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,33 +137,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: down
+  name: reverse_adoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: reverse_adoc
+  name: shale
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -324,6 +338,55 @@ files:
 - lib/stepmod/utils/equation_logger.rb
 - lib/stepmod/utils/express_bibdata.rb
 - lib/stepmod/utils/html_to_asciimath.rb
+- lib/stepmod/utils/parsers.rb
+- lib/stepmod/utils/parsers/mapping_table_parser.rb
+- lib/stepmod/utils/parsers/models.rb
+- lib/stepmod/utils/parsers/models/a.rb
+- lib/stepmod/utils/parsers/models/aa.rb
+- lib/stepmod/utils/parsers/models/ae.rb
+- lib/stepmod/utils/parsers/models/aimelt.rb
+- lib/stepmod/utils/parsers/models/alt.rb
+- lib/stepmod/utils/parsers/models/alt_map.rb
+- lib/stepmod/utils/parsers/models/alt_scmap.rb
+- lib/stepmod/utils/parsers/models/b.rb
+- lib/stepmod/utils/parsers/models/bigeqn.rb
+- lib/stepmod/utils/parsers/models/bold.rb
+- lib/stepmod/utils/parsers/models/bom_ref.rb
+- lib/stepmod/utils/parsers/models/constraint.rb
+- lib/stepmod/utils/parsers/models/dd.rb
+- lib/stepmod/utils/parsers/models/description.rb
+- lib/stepmod/utils/parsers/models/dl.rb
+- lib/stepmod/utils/parsers/models/dt.rb
+- lib/stepmod/utils/parsers/models/eqn.rb
+- lib/stepmod/utils/parsers/models/example.rb
+- lib/stepmod/utils/parsers/models/express_extref.rb
+- lib/stepmod/utils/parsers/models/express_ref.rb
+- lib/stepmod/utils/parsers/models/figure.rb
+- lib/stepmod/utils/parsers/models/i.rb
+- lib/stepmod/utils/parsers/models/img.rb
+- lib/stepmod/utils/parsers/models/imgarea.rb
+- lib/stepmod/utils/parsers/models/li.rb
+- lib/stepmod/utils/parsers/models/mapping_table.rb
+- lib/stepmod/utils/parsers/models/module_ref.rb
+- lib/stepmod/utils/parsers/models/note.rb
+- lib/stepmod/utils/parsers/models/ol.rb
+- lib/stepmod/utils/parsers/models/p.rb
+- lib/stepmod/utils/parsers/models/refpath.rb
+- lib/stepmod/utils/parsers/models/refpath_extend.rb
+- lib/stepmod/utils/parsers/models/rules.rb
+- lib/stepmod/utils/parsers/models/sc.rb
+- lib/stepmod/utils/parsers/models/screen.rb
+- lib/stepmod/utils/parsers/models/source.rb
+- lib/stepmod/utils/parsers/models/sub.rb
+- lib/stepmod/utils/parsers/models/sup.rb
+- lib/stepmod/utils/parsers/models/table.rb
+- lib/stepmod/utils/parsers/models/td.rb
+- lib/stepmod/utils/parsers/models/th.rb
+- lib/stepmod/utils/parsers/models/title.rb
+- lib/stepmod/utils/parsers/models/tr.rb
+- lib/stepmod/utils/parsers/models/tt.rb
+- lib/stepmod/utils/parsers/models/ul.rb
+- lib/stepmod/utils/parsers/types/string_without_indent.rb
 - lib/stepmod/utils/smrl_description_converter.rb
 - lib/stepmod/utils/smrl_resource_converter.rb
 - lib/stepmod/utils/stepmod_definition_converter.rb
@@ -345,7 +408,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="