suma 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52f25d69f23dba6c3d0c420c241279354bc8e838ac1f1e58d32e1392408da68e
-  data.tar.gz: 5cfa1b2e128694c04c75a0ca3eda31be63c90e2c5759ee564230525529edf07c
+  metadata.gz: 91d8fb8b814f47412c1374e7c12c9d3fb5368a5275c409355c6cc02a728305b6
+  data.tar.gz: 3cdf5da9b7c251df88f6434222e3a575e6f1cf3839f83ab7cb47091180807510
 SHA512:
-  metadata.gz: 7db5c9725523372171efb9d4234cbf9e7819c0ac0093128e92dcaa737cf34653d33573df97816c9253645d0f6abce7e9e96d4ca503f787336ec4dd3824641db8
-  data.tar.gz: 8095d98452ac83ab609466df69ee064b9202342d9dfd1842262a2edf571002b2e76f1855b47582cda228f7f321904b1927a46d6b14b7ff2318f0e11cf4e2afa5
+  metadata.gz: 55422c9b98ac260feb77bc8937aff2d45196ba369850a5166b82fec88e7318007c2a6e3d345a441b0ea7e6e3c6df3854432a56ab33012079ababa0fae8a0f6ab
+  data.tar.gz: 50e1425e0bb51cff0866dbb4f7de66c03fc72772660aa253eafa5f25ebcd072e6d7f4c4b5006ad84c78fbd9364eb8cf5494498fc1c6747efe9e2b50a9de8757a

data/.rubocop.yml

@@ -1,8 +1,8 @@
 inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
   - .rubocop_todo.yml
 
-require:
+plugins:
 - rubocop-performance
 - rubocop-rake
 - rubocop-rspec

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-03-21 11:43:08 UTC using RuboCop version 1.74.0.
+# on 2025-03-23 10:59:23 UTC using RuboCop version 1.74.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,47 +13,6 @@ Gemspec/DuplicatedAssignment:
   Exclude:
     - 'suma.gemspec'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: outdent, indent
-Layout/AccessModifierIndentation:
-  Exclude:
-    - 'lib/suma/cli/build.rb'
-    - 'lib/suma/cli/links.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: with_first_argument, with_fixed_indentation
-Layout/ArgumentAlignment:
-  Exclude:
-    - 'lib/suma/cli/links.rb'
-
-# Offense count: 19
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowForAlignment.
-Layout/CommentIndentation:
-  Exclude:
-    - 'lib/suma/cli/build.rb'
-    - 'lib/suma/cli/links.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleAlignWith, Severity.
-# SupportedStylesAlignWith: keyword, variable, start_of_line
-Layout/EndAlignment:
-  Exclude:
-    - 'lib/suma/cli/build.rb'
-
-# Offense count: 28
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/suma/cli/build.rb'
-    - 'lib/suma/cli/links.rb'
-
 # Offense count: 43
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
@@ -71,18 +30,19 @@ Layout/LineLength:
     - 'lib/suma/thor_ext.rb'
     - 'suma.gemspec'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/suma/cli/links.rb'
-
 # Offense count: 1
 Lint/DuplicateMethods:
   Exclude:
     - 'lib/suma/express_schema.rb'
 
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/suma/cli.rb'
+
 # Offense count: 11
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
@@ -127,14 +87,6 @@ Performance/CollectionLiteralInLoop:
   Exclude:
     - 'spec/suma/cli_spec.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, each, example
-RSpec/HookArgument:
-  Exclude:
-    - 'spec/suma/cli_spec.rb'
-
 # Offense count: 1
 RSpec/MultipleExpectations:
   Max: 2

data/README.adoc

@@ -130,6 +130,42 @@ This command:
 * Provides progress bars to track schema loading and link validation
 
 
+=== Reformat command
+
+==== General
+
+The `reformat` command provides utilities for reformatting EXPRESS files.
+
+[source,sh]
+----
+$ suma reformat EXPRESS_FILE_PATH [options]
+----
+
+Parameters:
+
+`EXPRESS_FILE_PATH`:: Path to an EXPRESS file or a folder containing EXPRESS
+files
+
+Options:
+
+`--[no-]recursive`:: Select EXPRESS files recursively based on the specified
+folder path (default: false)
+
+[example]
+====
+.To reformat all EXPRESS files under the current directory recursively
+[source,sh]
+----
+$ bundle exec suma reformat `pwd` -r
+----
+====
+
+This command:
+
+* Loads the EXPRESS files specified in the `EXPRESS_FILE_PATH`
+* Reformats and saves the loaded EXPRESS files
+
+
 == Usage: Ruby
 
 === General

data/lib/suma/cli/build.rb

@@ -7,21 +7,14 @@ module Suma
   module Cli
     # Build command for building collections
     class Build < Thor
-      # Return true to exit with non-zero status on errors
-      def self.exit_on_failure?
-        true
-      end
-
-      default_command :default_build
-
-      desc "default_build METANORMA_SITE_MANIFEST",
+      desc "build METANORMA_SITE_MANIFEST",
            "Build collection specified in site manifest (`metanorma*.yml`)"
       option :compile, type: :boolean, default: true,
                        desc: "Compile or skip compile of collection"
       option :schemas_all_path, type: :string, aliases: "-s",
                                 desc: "Generate file that contains all schemas in the collection."
 
-      def default_build(metanorma_site_manifest)
+      def build(metanorma_site_manifest)
         # Lazy-load dependencies only when this command is actually used
         require_relative "../processor"
         require_relative "../utils"

data/lib/suma/cli/reformat.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "../thor_ext"
+
+module Suma
+  module Cli
+    # Reformat command for reformatting EXPRESS files
+    class Reformat < Thor
+      desc "reformat EXPRESS_FILE_PATH",
+           "Reformat EXPRESS files"
+      option :recursive, type: :boolean, default: false, aliases: "-r",
+                         desc: "Reformat EXPRESS files under the specified " \
+                               "path recursively"
+
+      def reformat(express_file_path) # rubocop:disable Metrics/AbcSize
+        if File.file?(express_file_path)
+          unless File.exist?(express_file_path)
+            raise Errno::ENOENT, "Specified EXPRESS file " \
+                                 "`#{express_file_path}` not found."
+          end
+
+          if File.extname(express_file_path) != ".exp"
+            raise ArgumentError, "Specified file `#{express_file_path}` is " \
+                                 "not an EXPRESS file."
+          end
+
+          exp_files = [express_file_path]
+        elsif options[:recursive]
+          exp_files = Dir.glob("#{express_file_path}/**/*.exp")
+        else
+          exp_files = Dir.glob("#{express_file_path}/*.exp")
+        end
+
+        if exp_files.empty?
+          raise Errno::ENOENT, "No EXPRESS files found in " \
+                               "`#{express_file_path}`."
+        end
+
+        run(exp_files)
+      end
+
+      private
+
+      def run(exp_files)
+        exp_files.each do |exp_file|
+          reformat_exp(exp_file)
+        end
+      end
+
+      def reformat_exp(file) # rubocop:disable Metrics/AbcSize
+        # Read the file content
+        file_content = File.read(file)
+
+        # Extract all comments between '(*"' and '\n*)'
+        # Avoid incorrect selection of some comment blocks
+        # containing '(*text*)' inside
+        comments = file_content.scan(/\(\*"(.*?)\n\*\)/m).map(&:first)
+
+        if comments.count.positive?
+          content_without_comments = file_content.gsub(/\(\*".*?\n\*\)/m, "")
+
+          # remove extra newlines
+          new_content = content_without_comments.gsub(/(\n\n+)/, "\n\n")
+          # Add '(*"' and '\n*)' to enclose the comment block
+          new_comments = comments.map { |c| "(*\"#{c}\n*)" }.join("\n\n")
+          # Append the comments to the end of the file
+          new_content = "#{new_content}\n\n#{new_comments}\n"
+
+          # Compare the changes between the original content with the modified
+          # content, if the changes are just whitespaces, skip modifying the
+          # file
+          if file_content.gsub(/(\n+)/, "\n") == new_content.gsub(/(\n+)/, "\n")
+            puts "No changes made to #{file}"
+            return
+          end
+
+          update_exp(file, new_content)
+        end
+      end
+
+      def update_exp(file, content)
+        # Write the modified content to a new file
+        File.write(file, content)
+        puts "Reformatted EXPRESS file and saved to #{file}"
+      end
+    end
+  end
+end

data/lib/suma/cli.rb

@@ -11,17 +11,31 @@ module Suma
 
       desc "build METANORMA_SITE_MANIFEST",
            "Build collection specified in site manifest (`metanorma*.yml`)"
-      def build(*args)
-        # If no arguments, add an empty array to ensure the default command is triggered
-        args = [] if args.empty?
+      option :compile, type: :boolean, default: true,
+                       desc: "Compile or skip compile of collection"
+      option :schemas_all_path, type: :string, aliases: "-s",
+                                desc: "Generate file that contains all schemas in the collection."
+      def build(_site_manifest)
+        # # If no arguments, add an empty array to ensure the default command is triggered
+        # args = [] if args.empty?
         require_relative "cli/build"
-        Cli::Build.start(args)
+        Cli::Build.start
       end
 
       desc "links SUBCOMMAND ...ARGS", "Manage EXPRESS links"
-      def links(*args)
+      def links(*_args)
         require_relative "cli/links"
-        Cli::Links.start(args)
+        Cli::Links.start
+      end
+
+      desc "reformat EXPRESS_FILE_PATH",
+           "Reformat EXPRESS files"
+      option :recursive, type: :boolean, default: false, aliases: "-r",
+                         desc: "Reformat EXPRESS files under the specified " \
+                               "path recursively"
+      def reformat(_express_file_path)
+        require_relative "cli/reformat"
+        Cli::Reformat.start
       end
     end
   end

data/lib/suma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Suma
-  VERSION = "0.1.9"
+  VERSION = "0.1.11"
 end

data/suma.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "expressir", "~> 2.1.16"
+  spec.add_dependency "expressir", "~> 2.1"
   spec.add_dependency "lutaml-model", "~> 0.7"
   spec.add_dependency "metanorma-cli"
   spec.add_dependency "ruby-progressbar"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suma
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expressir
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.16
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.16
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: lutaml-model
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,7 @@ files:
 - lib/suma/cli.rb
 - lib/suma/cli/build.rb
 - lib/suma/cli/links.rb
+- lib/suma/cli/reformat.rb
 - lib/suma/collection_config.rb
 - lib/suma/collection_manifest.rb
 - lib/suma/express_schema.rb