stepmod-utils 0.6.8 → 0.6.10.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1ca04eb804cf7cb565a9b06ad4fbe5ff0296ff98efbc67dc743c2b6880f483f
-  data.tar.gz: c41e79f4e23ead8b393262fc27314834c54648f9e9e94b876528792746b5347a
+  metadata.gz: f8b65cef0a5a325ab2e28a21e5dcd38be81535e4cac5662b2dd4bc4244ce1d40
+  data.tar.gz: 8259f12eb5f6f2e4df159be483c36335e7b715aad8793943ea61a60523e812f8
 SHA512:
-  metadata.gz: c668c4ed4ac6cee1ed1b9a496b6cd0d5a4db58110500fa2250f9adf7b6c6a655a22ee9a449ccf0fd8b99e425203a9ab208b2e4808d68d84a9d010c6dfc95f53f
-  data.tar.gz: c629c54854070a73b5766105efab6d737752b19ba3123b9e514f575124de7ff2561151a8c727650c8324aec2a018fa5c5820681cd829e28ffd9e647e48a711bc
+  metadata.gz: a8b84ea4e01a4c46c105c3be24bac8aedccb38ba41bb1bc0a60f43cd12f53a64895714c70824cc7cec4d82261135e38eef82871bd7e2c0df3c0124730c1b53e7
+  data.tar.gz: f1fabfe7cf7da21378c85563996da2d262a950c951936a530db0d650b32b8188a36f929429f986a90a30c7f43c2267e180bd3cead1450aead8765b921aa8916e

data/.github/workflows/rake.yml

@@ -1,5 +1,7 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
+# Formerly cimas-managed. Now consumer-owned per metanorma/cimas#68
+# (workflow-file conversion from cimas-synced copied stubs to reusable-workflow
+# references). Pins metanorma/ci reusable at @v1 (moving major, three-tier
+# tagging discipline per metanorma/ci#372).
 name: rake
 
 on:
@@ -8,8 +10,11 @@ on:
     tags: [ v* ]
   pull_request:
 
+permissions:
+  contents: write
+
 jobs:
   rake:
-    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@v1
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/test-concept-generation.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1'
+          ruby-version: '3.3'
           bundler-cache: true
 
       - name: Check out iso-10303-stepmod-wg12 repo

data/.rubocop.yml

@@ -10,4 +10,4 @@ Style/MultilineMethodCallIndentation:
   EnforcedStyle: aligned
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.1

data/Gemfile

@@ -5,7 +5,10 @@ source "https://rubygems.org"
 gemspec
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem "concurrent-ruby", "~> 1.1"
+gem "concurrent-ruby"
 gem "pry"
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rails"

data/exe/stepmod-convert-express-description

@@ -11,7 +11,7 @@ $:.unshift File.expand_path("../../lib", bin_file)
 require "bundler/setup"
 require "stepmod/utils/smrl_description_converter"
 
-Coradoc::Input::HTML.config.unknown_tags = :bypass
+Coradoc::Input::Html.config.unknown_tags = :bypass
 
 input_content = ARGF.read
 

data/exe/stepmod-convert-express-resource

@@ -11,7 +11,7 @@ $:.unshift File.expand_path("../../lib", bin_file)
 require "bundler/setup"
 require "stepmod/utils/smrl_resource_converter"
 
-Coradoc::Input::HTML.config.unknown_tags = :bypass
+Coradoc::Input::Html.config.unknown_tags = :bypass
 
 input_content = ARGF.read
 

data/lib/stepmod/utils/cleaner.rb

@@ -2,13 +2,13 @@ require "coradoc/input/html/cleaner"
 
 module Stepmod
   module Utils
-    class Cleaner < Coradoc::Input::HTML::Cleaner
+    class Cleaner < Coradoc::Input::Html::Cleaner
       def tidy(string)
         super
           .gsub(/^ +/, "")
           .gsub(/\*\s([,.])/, '*\1') # remove space between * and comma or dot.
       end
-  
+
       # Find non-asterisk content that is enclosed by two or
       # more asterisks. Ensure that only one whitespace occurs
       # in the border area.
@@ -23,7 +23,8 @@ module Stepmod
         result = string.dup
         patterns.each do |pattern, value|
           result = result.gsub(pattern) do |match|
-            preserve_border_whitespaces(match, default_border: Coradoc::Input::HTML.config.tag_border) do
+            preserve_border_whitespaces(match,
+                                        default_border: Coradoc::Input::Html.config.tag_border) do
               match.strip.sub(" #{value}", value).sub("#{value} ", value)
             end
           end

data/lib/stepmod/utils/concept.rb

@@ -3,16 +3,17 @@ require "glossarist"
 module Stepmod
   module Utils
     class Concept < Glossarist::LocalizedConcept
-      attr_accessor *%w(
+      CUSTOM_ATTRIBUTES = %w(
         reference_clause
         reference_anchor
         converted_definition
         file_path
         schema
         part
-        domain
         document
-      )
+      ).freeze
+
+      attr_accessor(*CUSTOM_ATTRIBUTES)
 
       # TODO: converted_definition is not supposed to be an attribute, it is
       # supposed to be a method!
@@ -45,14 +46,20 @@ file_path:, language_code: "eng")
           # TODO: `designations:` should include the `alt:[...]` terms here,
           # they are now only included in definition_xml_converted_definition.
           new(
-            designations: designation,
-            definition: [definition],
+            data: Glossarist::ConceptData.new(
+              {
+                terms: designation,
+                definition: [
+                  Glossarist::DetailedDefinition.new({ content: definition }),
+                ],
+                language_code: language_code,
+              },
+            ),
             converted_definition: converted_definition,
             id: "#{reference_anchor}.#{reference_clause}",
             reference_anchor: reference_anchor,
             reference_clause: reference_clause,
             file_path: file_path,
-            language_code: language_code,
           )
         end
 
@@ -80,7 +87,9 @@ file_path:, language_code: "eng")
             designations << { "designation" => alt, "type" => "expression" }
           end
 
-          designations
+          designations.map do |des|
+            Glossarist::Designation::Base.from_yaml(des.to_yaml)
+          end
         end
 
         def definition_xml_definition(definition_xml, reference_anchor)
@@ -106,24 +115,19 @@ file_path:, language_code: "eng")
         end
 
         def definition_xml_converted_definition(designation, definition)
-          accepted_designation = designation.select do |des|
-            des["normative_status"] == "preferred"
-          end
-
-          alt_designations = designation.reject do |des|
-            des["normative_status"] == "preferred"
-          end
+          accepted_designation = designation.select(&:preferred?)
+          alt_designations = designation.reject(&:preferred?)
 
           if alt_designations.length.positive?
             alt_designations_text = alt_designations.map do |d|
-              d["designation"].strip
+              d.designation.strip
             end.join(",")
 
             alt_notation = "alt:[#{alt_designations_text}]"
           end
 
           result = <<~TEXT
-            === #{accepted_designation.map { |d| d['designation'].strip }.join(',')}
+            === #{accepted_designation.map { |d| d.designation.strip }.join(',')}
           TEXT
 
           if alt_notation
@@ -140,6 +144,14 @@ file_path:, language_code: "eng")
         end
       end
 
+      def initialize(hash = {})
+        super(hash)
+
+        CUSTOM_ATTRIBUTES.each do |attr|
+          public_send("#{attr}=", hash[attr] || hash[attr.to_sym])
+        end
+      end
+
       def to_h
         super.merge({
           "domain" => domain,
@@ -149,9 +161,13 @@ file_path:, language_code: "eng")
         }.compact)
       end
 
+      def domain
+        data.domain
+      end
+
       def to_mn_adoc
         <<~TEXT
-          // STEPmod path:#{file_path.empty? ? '' : " #{file_path}"}
+          // STEPmod path:#{file_path.to_s.empty? ? '' : " #{file_path}"}
           #{converted_definition}
 
           [.source]

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

@@ -41,7 +41,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :a, A.new
+      Coradoc::Input::Html::Converters.register :a, A.new
     end
   end
 end

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

@@ -16,7 +16,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :arm, Arm.new
+      Coradoc::Input::Html::Converters.register :arm, Arm.new
     end
   end
 end

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

@@ -1,10 +1,10 @@
-require 'coradoc'
-require 'coradoc/input/html'
+require "coradoc"
+require "coradoc/input/html"
 
 module Stepmod
   module Utils
     module Converters
-      class Base < Coradoc::Input::HTML::Converters::Base
+      class Base < Coradoc::Input::Html::Converters::Base
       end
     end
   end

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

@@ -16,7 +16,7 @@ module Stepmod
           ref.to_s.split(":").last.squeeze(" ").strip
         end
       end
-      Coradoc::Input::HTML::Converters.register :clause_ref, ClauseRef.new
+      Coradoc::Input::Html::Converters.register :clause_ref, ClauseRef.new
     end
   end
 end

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

@@ -12,7 +12,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :comment, Comment.new
+      Coradoc::Input::Html::Converters.register :comment, Comment.new
     end
   end
 end

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

@@ -8,7 +8,7 @@ module Stepmod
           "#{node.text}\n"
         end
 
-        Coradoc::Input::HTML::Converters.register :dd, Dd.new
+        Coradoc::Input::Html::Converters.register :dd, Dd.new
       end
     end
   end

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

@@ -78,8 +78,8 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :def, Def.new
-      Coradoc::Input::HTML::Converters.register :description, Def.new
+      Coradoc::Input::Html::Converters.register :def, Def.new
+      Coradoc::Input::Html::Converters.register :description, Def.new
     end
   end
 end

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

@@ -16,7 +16,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :definition, Definition.new
+      Coradoc::Input::Html::Converters.register :definition, Definition.new
     end
   end
 end

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

@@ -16,7 +16,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :description, Description.new
+      Coradoc::Input::Html::Converters.register :description, Description.new
     end
   end
 end

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

@@ -24,7 +24,7 @@ module Stepmod
           node
         end
 
-        Coradoc::Input::HTML::Converters.register :dl, Dl.new
+        Coradoc::Input::Html::Converters.register :dl, Dl.new
       end
     end
   end

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

@@ -10,7 +10,7 @@ module Stepmod
           "\n\n#{node.text}:: "
         end
 
-        Coradoc::Input::HTML::Converters.register :dt, Dt.new
+        Coradoc::Input::Html::Converters.register :dt, Dt.new
       end
     end
   end

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

@@ -14,8 +14,8 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :em, Em.new
-      Coradoc::Input::HTML::Converters.register :cite, Em.new
+      Coradoc::Input::Html::Converters.register :em, Em.new
+      Coradoc::Input::Html::Converters.register :cite, Em.new
     end
   end
 end

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

@@ -8,6 +8,10 @@ module Stepmod
           italic_converted(node, state)
         end
 
+        def to_coradoc(node, state = {})
+          italic_converted(node, state)
+        end
+
         private
 
         def italic_converted(node, state)
@@ -44,7 +48,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :i,  Em.new
+      Coradoc::Input::Html::Converters.register :i, Em.new
     end
   end
 end

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

@@ -123,8 +123,8 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :eqn, Eqn.new
-      Coradoc::Input::HTML::Converters.register :bigeqn, Eqn.new
+      Coradoc::Input::Html::Converters.register :eqn, Eqn.new
+      Coradoc::Input::Html::Converters.register :bigeqn, Eqn.new
     end
   end
 end

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

@@ -19,7 +19,7 @@ module Stepmod
           TEMPLATE
         end
       end
-      Coradoc::Input::HTML::Converters.register :example, Example.new
+      Coradoc::Input::Html::Converters.register :example, Example.new
     end
   end
 end

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

@@ -19,7 +19,8 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :express_figure, ExpressFigure.new
+      Coradoc::Input::Html::Converters.register :express_figure,
+                                                ExpressFigure.new
     end
   end
 end

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

@@ -49,7 +49,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register "express-g", ExpressG.new
+      Coradoc::Input::Html::Converters.register "express-g", ExpressG.new
     end
   end
 end

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

@@ -14,7 +14,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :express_note, ExpressNote.new
+      Coradoc::Input::Html::Converters.register :express_note, ExpressNote.new
     end
   end
 end

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

@@ -8,7 +8,7 @@ module Stepmod
           " *#{node['linkend'].to_s.split('.').last}* "
         end
       end
-      Coradoc::Input::HTML::Converters.register :express_ref, ExpressRef.new
+      Coradoc::Input::Html::Converters.register :express_ref, ExpressRef.new
     end
   end
 end

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

@@ -7,7 +7,8 @@ module Stepmod
           "<<express:#{parts.join('.').strip},#{parts.last.strip}>>"
         end
       end
-      Coradoc::Input::HTML::Converters.register :express_ref, ExpressRefExpressDescription.new
+      Coradoc::Input::Html::Converters.register :express_ref,
+                                                ExpressRefExpressDescription.new
     end
   end
 end

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

@@ -14,7 +14,8 @@ module Stepmod
           TEMPLATE
         end
       end
-      Coradoc::Input::HTML::Converters.register :ext_description, ExtDescription.new
+      Coradoc::Input::Html::Converters.register :ext_description,
+                                                ExtDescription.new
     end
   end
 end

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

@@ -8,7 +8,8 @@ module Stepmod
           treat_children(node, state)
         end
       end
-      Coradoc::Input::HTML::Converters.register :ext_descriptions, ExtDescriptions.new
+      Coradoc::Input::Html::Converters.register :ext_descriptions,
+                                                ExtDescriptions.new
     end
   end
 end

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

@@ -5,7 +5,7 @@ require "coradoc/input/html/converters/figure"
 module Stepmod
   module Utils
     module Converters
-      class Figure < Coradoc::Input::HTML::Converters::Figure
+      class Figure < Coradoc::Input::Html::Converters::Figure
         def self.pattern(state, id)
           if state[:schema_and_entity].nil?
             raise StandardError.new("[figure]: no state given, #{id}")
@@ -43,7 +43,7 @@ module Stepmod
       end
 
       # This replaces the converter
-      Coradoc::Input::HTML::Converters.register :figure, Figure.new
+      Coradoc::Input::Html::Converters.register :figure, Figure.new
     end
   end
 end

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

@@ -15,7 +15,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :fund_cons, FundCons.new
+      Coradoc::Input::Html::Converters.register :fund_cons, FundCons.new
     end
   end
 end

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

@@ -9,7 +9,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :introduction, Introduction.new
+      Coradoc::Input::Html::Converters.register :introduction, Introduction.new
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module Stepmod
   module Utils
     module Converters
-      class Li < Coradoc::Input::HTML::Converters::Li
+      class Li < Coradoc::Input::Html::Converters::Li
         def to_coradoc(node, state = {})
           li = super
           li.content = li.content.map do |content|
@@ -14,7 +14,7 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :li, Li.new
+      Coradoc::Input::Html::Converters.register :li, Li.new
     end
   end
 end

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

@@ -86,7 +86,7 @@ module Stepmod
           /.*?\s*\(?\d+\)?/.match(text)
         end
       end
-      Coradoc::Input::HTML::Converters.register :module_ref, ModuleRef.new
+      Coradoc::Input::Html::Converters.register :module_ref, ModuleRef.new
     end
   end
 end

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

@@ -45,8 +45,8 @@ module Stepmod
           # puts "[module_ref] #{result}"
         end
       end
-      Coradoc::Input::HTML::Converters.register :module_ref,
-                                       ModuleRefExpressDescription.new
+      Coradoc::Input::Html::Converters.register :module_ref,
+                                                ModuleRefExpressDescription.new
     end
   end
 end

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

@@ -19,7 +19,7 @@ module Stepmod
           TEMPLATE
         end
       end
-      Coradoc::Input::HTML::Converters.register :note, Note.new
+      Coradoc::Input::Html::Converters.register :note, Note.new
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module Stepmod
   module Utils
     module Converters
-      class Ol < Coradoc::Input::HTML::Converters::Ol
+      class Ol < Coradoc::Input::Html::Converters::Ol
         LIST_TAGS = ["ol", "ul", "dir"].freeze
 
         def to_coradoc(node, state = {})
@@ -15,7 +15,7 @@ module Stepmod
       end
 
       Ol::LIST_TAGS.each do |tag|
-        Coradoc::Input::HTML::Converters.register tag.to_sym, Ol.new
+        Coradoc::Input::Html::Converters.register tag.to_sym, Ol.new
       end
     end
   end

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

@@ -8,7 +8,7 @@ module Stepmod
           treat_children(node, state)
         end
       end
-      Coradoc::Input::HTML::Converters.register :resource, Resource.new
+      Coradoc::Input::Html::Converters.register :resource, Resource.new
     end
   end
 end

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

@@ -13,7 +13,7 @@ module Stepmod
           TEMPLATE
         end
       end
-      Coradoc::Input::HTML::Converters.register :schema, Schema.new
+      Coradoc::Input::Html::Converters.register :schema, Schema.new
     end
   end
 end

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

@@ -8,7 +8,7 @@ module Stepmod
           treat_children(node, state).strip
         end
       end
-      Coradoc::Input::HTML::Converters.register :schema_diag, SchemaDiag.new
+      Coradoc::Input::Html::Converters.register :schema_diag, SchemaDiag.new
     end
   end
 end

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

@@ -57,7 +57,8 @@ module Stepmod
           TEMPLATE
         end
       end
-      Coradoc::Input::HTML::Converters.register :ext_description, StepmodExtDescription.new
+      Coradoc::Input::Html::Converters.register :ext_description,
+                                                StepmodExtDescription.new
     end
   end
 end

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

@@ -66,8 +66,8 @@ module Stepmod
         end
       end
 
-      Coradoc::Input::HTML::Converters.register :strong, Strong.new
-      Coradoc::Input::HTML::Converters.register :b,      Strong.new
+      Coradoc::Input::Html::Converters.register :strong, Strong.new
+      Coradoc::Input::Html::Converters.register :b,      Strong.new
     end
   end
 end