suma 0.1.22 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 414cf7549060d821671a08771418a9f3c163ba23af62ef980eb4b12ccd0f5ad4
-  data.tar.gz: 0b30377a2b1db558bf62c765f136c5c505ba905b387a5d76e249fc48fce8c237
+  metadata.gz: 2c9cab2e048b99f3208e2956c0611dd64774a280afbe06cd60fb72474e4a8b4b
+  data.tar.gz: 9b12e455229ec616e08c3cba4d6e7e23adc14193241bfaeb33f605ba29a9ee2e
 SHA512:
-  metadata.gz: 7e899f31a08df29536d7abe1e8d2fc29a0c20038e1bb7dcedda35a7b9fa5d5041046e963d543401b4eaa100fa9d1aff19218b4e1c72457fb2a081a34211072f5
-  data.tar.gz: c764fc1985311dafb09074a498cfc30694427e95c2f29d4d243872fca5ddfa0ab6df3d323d785254b3ef69848cf3114c8b0b44b483ae09b97a1e293b05f82356
+  metadata.gz: e31649ea7c3e8bd144f212f4f3568a017bcf4a85550d9ad17d8210bb8df674163bdee055484f94bab2d41b42281444bfaff9e8d234cf970e71da5e8dd27f5308
+  data.tar.gz: '0281f7449d90c3979507e7a834091970cfb2f380bcc2a9fe8186f0e4cad2315f3a7e82d8279093d4ca721190c63a24a227d70ee87b05931354c37a6a3ffc7972'

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-10-04 11:33:46 UTC using RuboCop version 1.81.1.
+# on 2025-10-05 11:55:30 UTC using RuboCop version 1.81.1.
 # 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
@@ -18,7 +18,7 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'suma.gemspec'
 
-# Offense count: 67
+# Offense count: 70
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -26,6 +26,7 @@ Layout/LineLength:
   Exclude:
     - 'lib/suma/cli.rb'
     - 'lib/suma/cli/build.rb'
+    - 'lib/suma/cli/export.rb'
     - 'lib/suma/cli/validate.rb'
     - 'lib/suma/jsdai/figure.rb'
     - 'lib/suma/jsdai/figure_image.rb'
@@ -50,6 +51,11 @@ Lint/DuplicateMethods:
   Exclude:
     - 'lib/suma/express_schema.rb'
 
+# Offense count: 1
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/suma/cli/export.rb'
+
 # Offense count: 9
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
@@ -68,18 +74,24 @@ Metrics/CyclomaticComplexity:
     - 'lib/suma/jsdai/figure_image.rb'
     - 'lib/suma/thor_ext.rb'
 
+# Offense count: 4
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 13
+
 # Offense count: 1
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
     - 'lib/suma/jsdai/figure_image.rb'
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
 # AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
 Naming/VariableNumber:
   Exclude:
+    - 'spec/suma/cli/export_spec.rb'
     - 'spec/suma/cli/validate_ascii_spec.rb'
 
 # Offense count: 1
@@ -88,11 +100,24 @@ Performance/CollectionLiteralInLoop:
   Exclude:
     - 'spec/suma/cli_spec.rb'
 
-# Offense count: 24
+# Offense count: 1
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/suma/cli/export_spec.rb'
+
+# Offense count: 32
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 44
 
-# Offense count: 21
+# Offense count: 2
+# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/suma/cli/export_spec.rb'
+
+# Offense count: 28
 RSpec/MultipleExpectations:
   Max: 12

data/README.adoc

@@ -548,6 +548,141 @@ Sequential position:: assigned as the numbered href in both SVG and `svgmap`
 list
 
 
+=== Export schemas command
+
+==== General
+
+The `suma export` command exports EXPRESS schemas from a manifest file to a
+specified output directory. This command is useful for extracting plain or
+annotated EXPRESS schemas for distribution or further processing.
+
+[source,sh]
+----
+$ suma export MANIFEST_FILE [options]
+----
+
+Parameters:
+
+`MANIFEST_FILE`:: Path to the EXPRESS schema manifest file (e.g., "schemas-srl.yml")
+
+Options:
+
+`--output=PATH`, `-o PATH`:: (required) Output directory path
+
+`--additional=PATH`, `-a PATH`:: Additional schemas manifest file to merge
+
+`--[no-]annotations`:: Include annotations (remarks/comments) in exported schemas (default: false)
+
+`--[no-]zip`:: Create ZIP archive of exported schemas (default: false)
+
+==== Behavior
+
+The command exports schemas while preserving the directory structure from the
+manifest file paths:
+
+* Schemas under `resources/` are exported to `OUTPUT/resources/`
+* Schemas under `modules/` are exported to `OUTPUT/modules/`
+* Other categories (`business_object_models/`, `core_model/`) follow the same pattern
+
+By default, schemas are exported without annotations (plain EXPRESS). Use the
+`--annotations` flag to include remarks and comments.
+
+The `--zip` flag creates a ZIP archive in addition to the directory output,
+named `OUTPUT.zip`.
+
+[example]
+.To export schemas without annotations
+[source,sh]
+----
+$ bundle exec suma export -o express-files schemas-srl.yml
+# => generates express-files/ directory with plain EXPRESS schemas
+----
+
+[example]
+.To export schemas with annotations
+[source,sh]
+----
+$ bundle exec suma export -o express-files --annotations schemas-srl.yml
+# => generates express-files/ directory with annotated EXPRESS schemas
+----
+
+[example]
+.To export and create ZIP archive
+[source,sh]
+----
+$ bundle exec suma export -o express-files --zip schemas-srl.yml
+# => generates both:
+#    - express-files/ directory
+#    - express-files.zip archive
+----
+
+[example]
+.To merge additional schemas and export
+[source,sh]
+----
+$ bundle exec suma export -o express-files \
+    -a additional-schemas.yml \
+    schemas-srl.yml
+# => exports schemas from both manifest files
+----
+
+[example]
+.To merge multiple additional schemas
+[source,sh]
+----
+$ bundle exec suma export -o express-files \
+    -a additional-schemas-1.yml \
+    -a additional-schemas-2.yml \
+    schemas-srl.yml
+# => exports schemas from primary manifest and all additional manifests
+----
+
+[example]
+.To export with all options
+[source,sh]
+----
+$ bundle exec suma export -o express-files \
+    -a additional-schemas.yml \
+    schemas-srl.yml
+# => exports schemas from both manifest files
+----
+
+[example]
+.To export with all options
+[source,sh]
+----
+$ bundle exec suma export -o express-files \
+    --annotations \
+    --zip \
+    -a additional-schemas.yml \
+    schemas-srl.yml
+# => generates annotated schemas in both directory and ZIP format,
+#    including schemas from both manifest files
+----
+
+==== Output structure
+
+The exported directory structure mirrors the schema paths in the manifest:
+
+[source]
+----
+express-files/
+├── resources/
+│   ├── action_schema/
+│   │   └── action_schema.exp
+│   └── ...
+├── modules/
+│   ├── activity/
+│   │   ├── arm.exp
+│   │   └── mim.exp
+│   └── ...
+├── business_object_models/
+│   └── ...
+└── core_model/
+    └── ...
+----
+
+
 == Usage: Ruby
 
 === General

data/lib/suma/cli/export.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "../thor_ext"
+
+module Suma
+  module Cli
+    # Export command for exporting EXPRESS schemas from a manifest
+    class Export < Thor
+      desc "export MANIFEST_FILE",
+           "Export EXPRESS schemas from manifest"
+      option :output, type: :string, aliases: "-o", required: true,
+                      desc: "Output directory path"
+      option :additional, type: :array, aliases: "-a",
+                          desc: "Additional schemas manifest files to merge (can be specified multiple times)"
+      option :annotations, type: :boolean, default: false,
+                           desc: "Include annotations (remarks/comments)"
+      option :zip, type: :boolean, default: false,
+                   desc: "Create ZIP archive of exported schemas"
+
+      def export(manifest_file)
+        require_relative "../schema_exporter"
+        require_relative "../utils"
+        require "expressir"
+
+        unless File.exist?(manifest_file)
+          raise Errno::ENOENT, "Specified manifest file " \
+                               "`#{manifest_file}` not found."
+        end
+
+        run(manifest_file, options)
+      end
+
+      private
+
+      def run(manifest_file, options)
+        config = load_and_merge_configs(manifest_file, options[:additional])
+
+        exporter = SchemaExporter.new(
+          config: config,
+          output_path: options[:output],
+          options: {
+            annotations: options[:annotations],
+            create_zip: options[:zip],
+          },
+        )
+
+        exporter.export
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def load_and_merge_configs(primary_path, additional_paths)
+        primary_config = Expressir::SchemaManifest.from_file(primary_path)
+        return primary_config unless additional_paths && !additional_paths.empty?
+
+        # Load all additional manifests
+        additional_configs = additional_paths.map do |path|
+          unless File.exist?(path)
+            raise Errno::ENOENT, "Specified additional manifest file " \
+                                 "`#{path}` not found."
+          end
+          Expressir::SchemaManifest.from_file(path)
+        end
+
+        # Merge all configs into the primary
+        merge_all_configs(primary_config, additional_configs)
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def merge_all_configs(primary, additional_configs)
+        # Collect all schemas from primary and all additional manifests
+        all_schemas = primary.schemas.dup
+
+        additional_configs.each do |config|
+          all_schemas += config.schemas
+        end
+
+        Expressir::SchemaManifest.new(
+          path: primary.path,
+          schemas: all_schemas,
+        )
+      end
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/suma/cli.rb

@@ -60,6 +60,21 @@ module Suma
         Cli::ConvertJsdai.start
       end
 
+      desc "export MANIFEST_FILE",
+           "Export EXPRESS schemas from manifest"
+      option :output, type: :string, aliases: "-o", required: true,
+                      desc: "Output directory path"
+      option :additional, type: :array, aliases: "-a",
+                          desc: "Additional schemas manifest files to merge (can be specified multiple times)"
+      option :annotations, type: :boolean, default: false,
+                           desc: "Include annotations (remarks/comments)"
+      option :zip, type: :boolean, default: false,
+                   desc: "Create ZIP archive of exported schemas"
+      def export(_manifest_file)
+        require_relative "cli/export"
+        Cli::Export.start
+      end
+
       desc "validate SUBCOMMAND ...ARGS", "Validate express documents"
       subcommand "validate", Cli::Validate
 

data/lib/suma/express_schema.rb

@@ -42,14 +42,16 @@ module Suma
       File.join(@output_path, type, id, File.basename(@path))
     end
 
-    def save_exp
+    def save_exp(with_annotations: false)
       relative_path = Pathname.new(filename_plain).relative_path_from(Dir.pwd)
-      Utils.log "Save plain schema: #{relative_path}"
+      schema_type = with_annotations ? "annotated" : "plain"
+      Utils.log "Save #{schema_type} schema: #{relative_path}"
 
       # return if File.exist?(filename_plain)
       FileUtils.mkdir_p(File.dirname(filename_plain))
 
-      File.write(filename_plain, to_plain)
+      content = with_annotations ? parsed.to_s(no_remarks: false) : to_plain
+      File.write(filename_plain, content)
     end
   end
 end

data/lib/suma/schema_collection.rb

@@ -3,6 +3,7 @@
 require_relative "express_schema"
 require_relative "schema_attachment"
 require_relative "schema_document"
+require_relative "schema_exporter"
 require "expressir"
 require_relative "utils"
 
@@ -62,11 +63,17 @@ module Suma
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def compile
       finalize
-      schemas.each_pair do |_schema_id, entry|
-        entry.save_exp
-      end
+
+      # Use SchemaExporter for schema export
+      exporter = SchemaExporter.new(
+        config: @config,
+        output_path: @output_path_schemas,
+        options: { annotations: false },
+      )
+      exporter.export
 
       docs.each_pair do |_schema_id, entry|
         entry.compile
@@ -98,5 +105,6 @@ module Suma
       # end
       # pp results
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/suma/schema_exporter.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative "express_schema"
+require_relative "utils"
+require "fileutils"
+
+module Suma
+  # SchemaExporter exports EXPRESS schemas from a manifest
+  # with configurable options for annotations and ZIP packaging
+  class SchemaExporter
+    attr_reader :config, :output_path, :options
+
+    def initialize(config:, output_path:, options: {})
+      @config = config
+      @output_path = Pathname.new(output_path).expand_path
+      @options = default_options.merge(options)
+    end
+
+    def export
+      Utils.log "Exporting schemas to: #{output_path}"
+
+      schemas = config.schemas
+      export_to_directory(schemas)
+      create_zip_archive if options[:create_zip]
+
+      Utils.log "Export complete!"
+    end
+
+    private
+
+    def default_options
+      {
+        annotations: false,
+        create_zip: false,
+        structure: :preserve,
+      }
+    end
+
+    def export_to_directory(schemas)
+      schemas.each do |schema|
+        export_single_schema(schema)
+      end
+    end
+
+    def export_single_schema(schema)
+      category = categorize_schema(schema)
+      schema_output_path = output_path.join(category).to_s
+
+      express_schema = ExpressSchema.new(
+        id: schema.id,
+        path: schema.path.to_s,
+        output_path: schema_output_path,
+      )
+
+      express_schema.save_exp(with_annotations: options[:annotations])
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def categorize_schema(schema)
+      path = schema.path.to_s
+
+      case path
+      when %r{/resources/}
+        "resources"
+      when %r{/modules/}
+        "modules"
+      when %r{/business_object_models/}
+        "business_object_models"
+      when %r{/core_model/}
+        "core_model"
+      else
+        "other"
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # rubocop:disable Metrics/MethodLength
+    def create_zip_archive
+      require "zip"
+
+      zip_path = "#{output_path}.zip"
+      Utils.log "Creating ZIP archive: #{zip_path}"
+
+      Zip::File.open(zip_path, Zip::File::CREATE) do |zipfile|
+        Dir.glob("#{output_path}/**/*").each do |file|
+          next if File.directory?(file)
+
+          relative_path = file.sub("#{output_path}/", "")
+          zipfile.add(relative_path, file)
+        end
+      end
+
+      Utils.log "ZIP archive created: #{zip_path}"
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/suma/version.rb

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

data/suma.gemspec

@@ -39,6 +39,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_dependency "metanorma-cli"
   spec.add_dependency "plurimath"
   spec.add_dependency "ruby-progressbar"
+  spec.add_dependency "rubyzip", "~> 2.3"
   spec.add_dependency "table_tennis"
   spec.add_dependency "thor", ">= 0.20"
   spec.metadata["rubygems_mfa_required"] = "true"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suma
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.1.23
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-05 00:00:00.000000000 Z
+date: 2025-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expressir
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: table_tennis
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +163,7 @@ files:
 - lib/suma/cli.rb
 - lib/suma/cli/build.rb
 - lib/suma/cli/convert_jsdai.rb
+- lib/suma/cli/export.rb
 - lib/suma/cli/extract_terms.rb
 - lib/suma/cli/generate_schemas.rb
 - lib/suma/cli/reformat.rb
@@ -166,6 +181,7 @@ files:
 - lib/suma/schema_attachment.rb
 - lib/suma/schema_collection.rb
 - lib/suma/schema_document.rb
+- lib/suma/schema_exporter.rb
 - lib/suma/site_config.rb
 - lib/suma/thor_ext.rb
 - lib/suma/utils.rb