suma 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c08dd5c9b1e53371518104f17eaa1b0ae59590069e15239051f2619e3083086
-  data.tar.gz: f4aa885d0259c98ee8f00eefdb21b2fd6d4c2b9ac2e64d6987ce55fe362b5bab
+  metadata.gz: 91d8fb8b814f47412c1374e7c12c9d3fb5368a5275c409355c6cc02a728305b6
+  data.tar.gz: 3cdf5da9b7c251df88f6434222e3a575e6f1cf3839f83ab7cb47091180807510
 SHA512:
-  metadata.gz: a0fcddad0380d5c5e0a714729c0fc59e8195f83f7af1c40fe29caf8fd124cc75fffdaceaeb973b5d4f6cedd0ab526695b7019b5d2391faa94a9b4735267b389f
-  data.tar.gz: 6f667b5a28f8807980351345dc49ab4959a01b35a1d5463a2afb1851fa2718c55d53916248e2f92eca58d8f899466752d2bd51579747e8d74a8391ba43f3309f
+  metadata.gz: 55422c9b98ac260feb77bc8937aff2d45196ba369850a5166b82fec88e7318007c2a6e3d345a441b0ea7e6e3c6df3854432a56ab33012079ababa0fae8a0f6ab
+  data.tar.gz: 50e1425e0bb51cff0866dbb4f7de66c03fc72772660aa253eafa5f25ebcd072e6d7f4c4b5006ad84c78fbd9364eb8cf5494498fc1c6747efe9e2b50a9de8757a

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/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

@@ -27,6 +27,16 @@ module Suma
         require_relative "cli/links"
         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
 end

data/lib/suma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Suma
-  VERSION = "0.1.10"
+  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.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-23 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