stepmod-utils 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887612180cfe004fb244d41e7c553858ed441d5e4c60c8d27d06fb7ec3219cd2
-  data.tar.gz: f7f25caa5652593b6eafcb792206614f2b053e56a0dd05801018e2217533b636
+  metadata.gz: e4b01b98d2e819f59adda9b7583eb65e0f3f17c67b57e297d4c63a28587a9c81
+  data.tar.gz: 274c0b90422ffb4f51134c49c4b1f8b9b8d4319b4369fd26baccf6191cf11183
 SHA512:
-  metadata.gz: 41057b14b1c6ab326dff8e402be3a74737e9479212a76577a9ef81738da9f542ab6cbd892723949b004a2a6ff6058525aed5de47b1fbe3859ac139a724028608
-  data.tar.gz: 519d9daa5451c17f60e6e2e764405908bf7e3c9f6b7279dcef9ee2bb554c63a0535b1e63c3aaed178549413a2253e24a3687c86d1ad60c8fa569c65aed756647
+  metadata.gz: 74483e26bbfdbb7dd5827ebf8d1b7270b13cf35765107830a7d5ce29239d4fa865804e6384ba092f7209fdc7ab91387f8841791822deb6da45d97f37d1621e82
+  data.tar.gz: 9d130371dc91aa996896c79c3d3a7ff4be703d258030e9d2aee64212add70b79f8fdc9962c9d3d2d1d309d8e5c771817a22f44ff515f3702c014c859c9013dd0

data/.github/workflows/rake.yml

@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@v2
         with:

data/.github/workflows/release.yml

@@ -9,7 +9,7 @@ on:
         description: |
           Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
-        default: 'patch'
+        default: 'skip'
   push:
     tags: [ v* ]
 
@@ -22,10 +22,11 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.6'
+          bundler-cache: true
 
       - run: gem install gem-release
 
-      - if: ${{ github.event_name == 'workflow_dispatch' }}
+      - if: ${{ github.event_name == 'workflow_dispatch' }} && ${{ github.event.inputs.next_version != 'skip' }}
         run: |
           git config user.name github-actions
           git config user.email github-actions@github.com
@@ -36,7 +37,7 @@ jobs:
           RUBYGEMS_API_KEY: ${{secrets.METANORMA_CI_RUBYGEMS_API_KEY}}
         run: |
           gem install gem-release
-          cat > ~/.gem/credentials << EOF
+          envsubst << 'EOF' > ~/.gem/credentials
           ---
           :rubygems_api_key: ${RUBYGEMS_API_KEY}
           EOF

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.4

data/lib/stepmod/utils/concept.rb

@@ -20,32 +20,87 @@ module Stepmod
         end
       end
 
-      def self.parse(definition_xml, reference_anchor:, reference_clause:, file_path:)
-        converted_definition = Stepmod::Utils::StepmodDefinitionConverter.convert(
-          definition_xml,
+      class << self
+        def parse(definition_xml, reference_anchor:, reference_clause:, file_path:)
+          converted_definition = Stepmod::Utils::StepmodDefinitionConverter.convert(
+            definition_xml,
+            {
+              # We don't want examples and notes
+              no_notes_examples: true,
+              reference_anchor: reference_anchor
+            }
+          )
+
+          return nil if converted_definition.nil? || converted_definition.strip.empty?
+
+          if definition_xml.name == 'ext_description'
+            converted_definition = <<~TEXT
+              #{converted_definition}
+
+              NOTE: This term is incompletely defined in this document.
+              Reference <<#{reference_anchor}>> for the complete definition.
+            TEXT
+          end
+          # https://github.com/metanorma/stepmod-utils/issues/86
+          if definition_xml.name == 'definition'
+            designation = definition_designation(definition_xml)
+            definition = definition_xml_definition(definition_xml, reference_anchor)
+            converted_definition = definition_xml_converted_definition(designation, definition).strip
+          end
+          new(
+            designation: designation,
+            definition: definition,
+            converted_definition: converted_definition,
+            reference_anchor: reference_anchor,
+            reference_clause: reference_clause,
+            file_path: file_path
+          )
+        end
+
+        def definition_designation(definition_xml)
+          alts = definition_xml.xpath('.//def/p').map(&:text)
           {
-            # We don't want examples and notes
-            no_notes_examples: true,
-            reference_anchor: reference_anchor
+            accepted: definition_xml.xpath('.//term').first&.text,
+            alt: alts
           }
-        )
+        end
 
-        return nil if converted_definition.nil? || converted_definition.strip.empty?
+        def definition_xml_definition(definition_xml, reference_anchor)
+          text_nodes = definition_xml
+                        .xpath('.//def')
+                        .first
+                        .children
+                        .reject { |n| n.name == 'p'  }
+          wrapper = "<def>#{text_nodes.map(&:to_s).join}</def>"
+          Stepmod::Utils::Converters::Def
+            .new
+            .convert(
+              Nokogiri::XML(wrapper).root,
+              {
+                # We don't want examples and notes
+                no_notes_examples: true,
+                reference_anchor: reference_anchor
+              })
+        end
 
-        if definition_xml.name == 'ext_description'
-          converted_definition = <<~TEXT
-            #{converted_definition}
+        def definition_xml_converted_definition(designation, definition)
+          if designation[:alt].length.positive?
+            alt_notation = "alt:[#{designation[:alt].map(&:strip).join(',')}]"
+          end
+          result = <<~TEXT
+            === #{designation[:accepted]}
+          TEXT
+          if alt_notation
+            result += <<~TEXT
 
-            NOTE: This term is incompletely defined in this document.
-            Reference <<#{reference_anchor}>> for the complete definition.
+              #{alt_notation}
+            TEXT
+          end
+          <<~TEXT
+            #{result}
+            #{definition}
           TEXT
         end
-        new(
-          converted_definition: converted_definition,
-          reference_anchor: reference_anchor,
-          reference_clause: reference_clause,
-          file_path: file_path
-        )
       end
 
       def to_mn_adoc

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.3.4"
+    VERSION = "0.3.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -98,7 +98,9 @@ files:
 - ".github/workflows/rake.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Makefile
@@ -178,7 +180,7 @@ homepage: https://github.com/metanorma/stepmod-utils
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,8 +195,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Stepmod-utils is a toolkit that works on STEPmod data.
 test_files: []