suma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8560abb88a9afd280a88d4671dc2aa2e674279765c5909ddba83df1e47c695c
+  data.tar.gz: 8aff2c39d4d9d380a5f685ac49823afd195a6862d16921301fc43a24448b820a
+SHA512:
+  metadata.gz: 9e920d236b6df4c74fd6c52ae3c4d24403575d10f14b41f893560962d1531c5bb6ff6798efaa7d010c5fd346cf2e820e120eafbe8cea3d6b15a80f53d9f14030
+  data.tar.gz: fdb19a5151df97eba81e0c23382f9c5c6f7ee082bb1d7b447a25e927626f47391c658f1afd32ac20ecc66fb5064af12f3e3f1263a65daadb59962ae8ccf7533c

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.2.2'
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ronald.tse@ribose.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in suma.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/README.adoc

@@ -0,0 +1,83 @@
+= Suma: utility for the STEP Unified Model-driven Architecture
+
+== Purpose
+
+SUMA, the "STEP Unified Model-Based Standards Architecture", is a authoring and
+publication system developed for the management of EXPRESS schemas and its
+documentation.
+
+This utility is used by the
+https://github.com/metanorma/iso-10303[ISO 10303 collection]
+to build the following artifacts:
+
+* the STEP Resource Library (SRL)
+
+
+== Install
+
+[source,sh]
+----
+$ gem install suma
+----
+
+== Usage
+
+=== General
+
+[source,sh]
+----
+# Defaults to `suma help`
+$ suma
+Commands:
+  suma build METANORMA_SITE_MANIFEST  # Build collection specified in site manifest (`metanorma*.yml`)
+  suma help [COMMAND]                 # Describe available commands or one specific command
+----
+
+Where:
+
+`METANORMA_SITE_MANIFEST`:: This is the path to the Metanorma site manifest,
+typically `metanorma.yml`.
+
+
+=== Compilation
+
+.To compile SRL subset test collection
+[source,sh]
+----
+$ bundle exec suma build metanorma-test.yml
+----
+
+.To build SRL collection
+[source,sh]
+----
+$ bundle exec suma build metanorma-srl.yml
+----
+
+// .To compile all STEPmod migrated docs (without detached) individually
+// [source,sh]
+// ----
+// $ bundle exec metanorma site generate
+// ----
+
+
+=== Generating full schema listing files
+
+We generate the full schema collection listing using the `--no-compile`
+option in the `suma` command.
+
+The generated `schemas-*.yaml` file name is derived from the input file name
+with the word `metanorma` replaced with `schemas`.
+
+[source,sh]
+----
+$ bundle exec suma build --no-compile metanorma-srl.yml
+# => generates schemas-srl.yml
+----
+
+All documents need to have a `schemas.yaml` in their document root that lists
+out which schemas the document includes.
+
+
+== License
+
+Copyright Ribose. BSD 2-clause license.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "suma"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/suma

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "suma/cli"
+
+Suma::Cli.start(ARGV)

data/lib/suma/cli.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "thor_ext"
+require_relative "processor"
+require_relative "utils"
+
+module Suma
+  class Cli < Thor
+    extend ThorExt::Start
+
+    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 build(metanorma_site_manifest)
+      unless File.exist?(metanorma_site_manifest)
+        raise Errno::ENOENT, "Specified Metanorma site manifest file " \
+          "`#{metanorma_site_manifest}` not found."
+      end
+
+      # Set schemas_all_path to match metanorma_yaml_path
+      schemas_all_path = options[:schemas_all_path] ||
+                         metanorma_site_manifest.gsub("metanorma", "schemas")
+
+      begin
+        Processor.run(
+          metanorma_yaml_path: metanorma_site_manifest,
+          schemas_all_path: schemas_all_path,
+          compile: options[:compile],
+          output_directory: "_site"
+        )
+      rescue StandardError => e
+        Utils.log "[ERROR] Error occurred during processing. See details below."
+        Utils.log e
+        Utils.log e.inspect
+        Utils.log e.backtrace
+      end
+    end
+  end
+end

data/lib/suma/express_schema.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+require "fileutils"
+require "expressir"
+
+module Suma
+  class ExpressSchema
+    attr_accessor :path, :id, :parsed, :output_path
+
+    def initialize(path:, output_path:)
+      @path = Pathname.new(path).expand_path
+      @parsed = Expressir::Express::Parser.from_file(@path.to_s)
+      Utils.log "Loaded EXPRESS schema: #{path}"
+
+      @id = @parsed.schemas.first.id
+      @output_path = output_path
+    end
+
+    def type
+      case @path.to_s
+      when %r{.*/resources/.*}
+        "resources"
+      when %r{.*/modules/.*}
+        "modules"
+      else
+        "unknown_type"
+      end
+    end
+
+    def to_plain
+      @parsed.to_s(no_remarks: true)
+    end
+
+    def filename_plain
+      File.join(@output_path, type, id, "#{id}.exp")
+    end
+
+    def save_exp
+      relative_path = Pathname.new(filename_plain).relative_path_from(Dir.pwd)
+      Utils.log "Save plain schema: #{relative_path}"
+
+      # return if File.exist?(filename_plain)
+      FileUtils.mkdir_p(File.dirname(filename_plain))
+
+      File.open(filename_plain, "w") do |file|
+        file.write(to_plain)
+      end
+    end
+  end
+end
+
+# col = Suma::SchemaCollection.new(
+#         config_yaml: 'suma-schemas.yaml',
+#         output_path_docs: 'schema_docs',
+#         output_path_schemas: 'plain_schemas'
+#       )
+
+# docs = col.compile
+
+# paths = col.schemas.map do |schema|
+#   {
+#     plain_schema_path: schema.filename_plain,
+#     schema_doc_path: col.doc_from_schema_name(schema.id).output_xml_path
+#   }
+# end
+
+# Utils.log "COMPILED FILES ARE AT:"
+# pp paths

data/lib/suma/processor.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require_relative "schema_config"
+require_relative "schema_collection"
+require_relative "utils"
+require_relative "to_replace/collection_config"
+require_relative "to_replace/site_config"
+require "metanorma/cli"
+require "metanorma/cli/collection"
+require "metanorma/collection/collection"
+
+module Suma
+  class Processor
+    class << self
+      # Can move to schema_config.rb
+      def write_all_schemas(schemas_all_path, document_paths)
+        all_schemas = Suma::SchemaConfig::Config.new(path: schemas_all_path)
+
+        document_paths.each do |path|
+          schemas_yaml = File.join(File.dirname(path), "schemas.yaml")
+          next unless File.exist?(schemas_yaml)
+
+          schemas_config = Suma::SchemaConfig::Config.from_file(schemas_yaml)
+          all_schemas.concat(schemas_config)
+        end
+
+        Utils.log "Writing #{schemas_all_path}..."
+        all_schemas.to_file
+        Utils.log "Done."
+      end
+
+      def run(metanorma_yaml_path:, schemas_all_path:, compile:, output_directory: "_site")
+        Utils.log "Current directory: #{Dir.getwd}"
+
+        # This reads the metanorma.yml file
+        site_config = Suma::ToReplace::SiteConfig::Config.from_file(metanorma_yaml_path)
+
+        # TODO: only reading the first file, which is a collection.yml, which is a hack...
+        collection_config_path = site_config.metanorma.source.files.first
+        collection_config = Suma::ToReplace::CollectionConfig::Config.from_file(collection_config_path)
+        collection_config.path = collection_config_path
+
+        # Gather all the inner (per-document) collection.yml files
+        document_paths = collection_config.manifest.docref.map(&:file)
+
+        write_all_schemas(schemas_all_path, document_paths)
+
+        col = Suma::SchemaCollection.new(
+          config_yaml: schemas_all_path,
+          output_path_docs: "schema_docs",
+          output_path_schemas: "plain_schemas"
+        )
+
+        if compile
+          Utils.log "Compiling schema collection..."
+          col.compile
+        else
+          Utils.log "No compile option set. Skipping schema compilation."
+        end
+
+        # TODO: Do we still need this?
+        # Define Proc to resolve fileref
+        my_fileref_proc = proc do |ref_folder, fileref|
+          # move schemas to modified_schemas
+          if File.extname(fileref) == ".exp"
+            fileref.gsub!(
+              "../../schemas",
+              "modified_schemas"
+            )
+          end
+          File.join(ref_folder, fileref)
+        end
+
+        # TODO: Do we still need this?
+        # Define Proc to resolve identifier
+        my_identifier_proc = proc do |identifier|
+          case identifier
+          when %r{^documents/}
+            identifier.gsub("documents/", "")
+          else
+            identifier
+          end
+        end
+
+        # TODO: Do we still need this?
+        # Define Proc to handle the compilation of express schemas
+        express_schemas_renderer = proc do |collection_model|
+        end
+
+        # TODO: Do we still need this?
+        Metanorma::Collection.tap do |mn|
+          mn.set_identifier_resolver(&my_identifier_proc)
+          mn.set_fileref_resolver(&my_fileref_proc)
+          mn.set_pre_parse_model(&express_schemas_renderer)
+        end
+
+        if compile
+          Utils.log "Compiling complete collection..."
+
+          metanorma_collection = Metanorma::Collection.parse(collection_config_path)
+
+          # TODO: Somehow this is no longer used
+          collection_opts = {
+            format: [:html],
+            output_folder: output_directory,
+            compile: {
+              no_install_fonts: true
+            },
+            coverpage: "cover.html"
+          }
+          metanorma_collection.render(collection_opts)
+
+          # remove xml files
+          Dir.glob(File.join(Dir.getwd, output_directory, "*.xml")).each do |file|
+            File.delete(file)
+          end
+        else
+          Utils.log "No compile option set. Skipping collection compilation."
+        end
+      end
+    end
+  end
+end

data/lib/suma/schema_collection.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "express_schema"
+require_relative "schema_doc"
+require_relative "schema_config"
+require_relative "utils"
+
+module Suma
+  class SchemaCollection
+    attr_accessor :config, :schemas, :docs, :output_path_docs, :output_path_schemas
+
+    def initialize(config: nil, config_yaml: nil, output_path_docs: nil, output_path_schemas: nil)
+      @schemas = []
+      @docs = []
+      @schema_name_to_docs = {}
+      @output_path_docs = if output_path_docs
+                            Pathname.new(output_path_docs).expand_path
+                          else
+                            Pathname.new(Dir.pwd)
+                          end
+      @output_path_schemas = if output_path_schemas
+                               Pathname.new(output_path_schemas).expand_path
+                             else
+                               Pathname.new(Dir.pwd)
+                             end
+
+      @config = if config
+                  config
+                elsif config_yaml
+                  SchemaConfig::Config.from_file(config_yaml)
+                end
+
+      return self unless @config
+
+      @config.schemas.each do |config_schema|
+        s = ExpressSchema.new(
+          path: config_schema.path,
+          output_path: @output_path_schemas
+        )
+        doc = SchemaDoc.new(
+          schema: s,
+          output_path: @output_path_docs.join(s.id)
+        )
+        @docs << doc
+        @schemas << s
+        @schema_name_to_docs[s.id] = doc
+      end
+    end
+
+    def doc_from_schema_name(schema_name)
+      @schema_name_to_docs[schema_name]
+    end
+
+    def compile
+      schemas.map(&:save_exp)
+
+      docs.each(&:compile)
+
+      # TODO: make this parallel
+      # puts "Starting Ractor processing"
+      # pool = Ractor.new do
+      #   loop do
+      #     Ractor.yield(Ractor.receive)
+      #   end
+      # end
+      # workers = (1..4).map do |i|
+      #   Ractor.new(pool, name: "r#{i}") do |p|
+      #     loop do
+      #       input = p.take
+      #       puts "compiling in ractor for #{input.filename_adoc}"
+      #       output_value = input.compile
+      #       Ractor.yield(output_value)
+      #     end
+      #   end
+      # end
+      # docs.each do |doc|
+      #   pool.send(doc)
+      # end
+      # results = []
+      # docs.size.times do
+      #   results << Ractor.select(*workers)
+      # end
+      # pp results
+    end
+  end
+end

data/lib/suma/schema_config/config.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "shale"
+require_relative "schema"
+require_relative "../utils"
+
+module Suma
+  module SchemaConfig
+    class Config < Shale::Mapper
+      attribute :schemas, Schema, collection: true
+      attr_accessor :base_path, :path
+
+      def initialize(path: nil, **args)
+        @path = path
+        super(**args)
+      end
+
+      def base_path
+        File.dirname(@path)
+      end
+
+      yaml do
+        map "schemas", using: { from: :schemas_from_yaml, to: :schemas_to_yaml }
+      end
+
+      def self.from_file(path)
+        from_yaml(File.read(path)).tap do |x|
+          x.path = path
+        end
+      end
+
+      def to_file(to_path = path)
+        File.open(to_path, "w") do |f|
+          f.write(to_yaml)
+        end
+      end
+
+      def schemas_from_yaml(model, value)
+        model.schemas = value.map do |k, v|
+          Schema.new(id: k, path: v["path"])
+        end
+      end
+
+      def schemas_to_yaml(model, doc)
+        doc["schemas"] = model.schemas.sort_by(&:id).to_h do |schema|
+          [schema.id, { "path" => schema.path }]
+        end
+      end
+
+      def update_path(new_path)
+        old_base_path = File.dirname(@path)
+        new_base_path = File.dirname(new_path)
+
+        schemas.each do |schema|
+          schema_path = Pathname.new(schema.path)
+          next if schema_path.absolute?
+
+          schema_path = (Pathname.new(old_base_path) + schema_path).cleanpath
+          new_relative_schema_path = schema_path.relative_path_from(new_base_path)
+          schema.path = new_relative_schema_path
+        end
+
+        @path = new_path
+      end
+
+      def concat(another_config)
+        unless another_config.is_a?(self.class)
+          raise StandardError, "Can only concatenate a non SchemaConfig::Config object."
+        end
+
+        # We need to update the relative paths
+        if path != another_config.path
+          new_config = another_config.dup
+          new_config.update_path(path)
+        end
+
+        schemas.concat(another_config.schemas)
+      end
+
+      def save_to_path(filename)
+        new_config = dup
+        new_config.path = filename
+        new_config.update_base_path(File.dirname(filename))
+
+        File.open(filename, "w") do |f|
+          Utils.log "Writing #{filename}..."
+          f.write(to_yaml)
+          Utils.log "Done."
+        end
+      end
+    end
+  end
+end

data/lib/suma/schema_config/schema.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Suma
+  module SchemaConfig
+    class Schema < Shale::Mapper
+      attribute :id, Shale::Type::String
+      attribute :path, Shale::Type::String
+    end
+  end
+end

data/lib/suma/schema_config.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "schema_config/schema"
+require_relative "schema_config/config"

data/lib/suma/schema_doc.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require "fileutils"
+# require "metanorma/cli"
+require_relative "schema_config"
+
+module Suma
+  class SchemaDoc
+    attr_accessor :schema, :output_path, :config
+
+    def initialize(schema:, output_path:)
+      @schema = schema
+      @output_path = output_path
+    end
+
+    def to_adoc(path_to_schema_yaml)
+      <<~HEREDOC
+        = #{@schema.id}
+        :lutaml-express-index: schemas; #{path_to_schema_yaml};
+        :bare: true
+        :mn-document-class: iso
+        :mn-output-extensions: xml,html
+
+        [lutaml,schemas,context]
+        ----
+        {% for schema in context.schemas %}
+
+        [%unnumbered]
+        == #{@schema.id}
+
+        [source%unnumbered]
+        --
+        {{ schema.formatted }}
+        --
+        {% endfor %}
+        ----
+
+      HEREDOC
+    end
+
+    def filename_adoc(ext = "adoc")
+      File.join(@output_path, "doc_#{@schema.id}.#{ext}")
+    end
+
+    def save_adoc
+      relative_path = Pathname.new(filename_adoc).relative_path_from(Dir.pwd)
+      Utils.log "Save EXPRESS adoc: #{relative_path}"
+
+      # return if File.exist?(filename_adoc)
+      FileUtils.mkdir_p(File.dirname(filename_adoc))
+
+      relative_path = Pathname.new(filename_config)
+                              .relative_path_from(Pathname.new(File.dirname(filename_adoc)))
+
+      # Utils.log "relative_path #{relative_path}"
+
+      File.open(filename_adoc, "w") do |file|
+        file.write(to_adoc(relative_path))
+      end
+    end
+
+    def filename_config
+      File.join(@output_path, "schema_#{@schema.id}.yaml")
+    end
+
+    def to_config
+      # return @config unless @config
+      @config = SchemaConfig::Config.new
+      @config.schemas << SchemaConfig::Schema.new(
+        id: @schema.id,
+        path: @schema.path
+      )
+
+      @config
+    end
+
+    def save_config
+      relative_path = Pathname.new(filename_config).relative_path_from(Dir.pwd)
+      Utils.log "Save schema config: #{relative_path}"
+
+      # return if File.exist?(filename_config)
+      FileUtils.mkdir_p(File.dirname(filename_config))
+
+      File.open(filename_config, "w") do |file|
+        file.write(to_config.to_yaml)
+      end
+    end
+
+    # Compile Metanorma adoc per EXPRESS schema
+    def compile
+      return self if File.exist?(output_xml_path)
+
+      save_config
+      save_adoc
+
+      relative_path = Pathname.new(filename_adoc).relative_path_from(Dir.pwd)
+      Utils.log "Compiling schema #{relative_path}..."
+      Metanorma::Compile.new.compile(
+        filename_adoc,
+        agree_to_terms: true,
+        no_install_fonts: true
+      )
+      Utils.log "Compiling schema #{filename_adoc}...done!"
+
+      # clean_artifacts
+
+      # filename_adoc('xml')
+      self
+    end
+
+    def output_xml_path
+      filename_adoc("xml")
+    end
+
+    def clean_artifacts
+      [
+        filename_config,
+        filename_adoc,
+        filename_adoc("presentation.xml"),
+        filename_adoc("adoc.lutaml.log.txt"),
+        filename_adoc("err.html")
+      ].each do |filename|
+        FileUtils.rm_rf(filename)
+      end
+    end
+
+    def output_folder; end
+  end
+end

data/lib/suma/thor_ext.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Suma
+  module ThorExt
+    # Configures Thor to behave more like a typical CLI, with better help and error handling.
+    #
+    # - Passing -h or --help to a command will show help for that command.
+    # - Unrecognized options will be treated as errors (instead of being silently ignored).
+    # - Error messages will be printed in red to stderr, without stack trace.
+    # - Full stack traces can be enabled by setting the VERBOSE environment variable.
+    # - Errors will cause Thor to exit with a non-zero status.
+    #
+    # To take advantage of this behavior, your CLI should subclass Thor and extend this module.
+    #
+    #   class CLI < Thor
+    #     extend ThorExt::Start
+    #   end
+    #
+    # Start your CLI with:
+    #
+    #   CLI.start
+    #
+    # In tests, prevent Kernel.exit from being called when an error occurs, like this:
+    #
+    #   CLI.start(args, exit_on_failure: false)
+    #
+    module Start
+      def self.extended(base)
+        super
+        base.check_unknown_options!
+      end
+
+      def start(given_args = ARGV, config = {})
+        config[:shell] ||= Thor::Base.shell.new
+        handle_help_switches(given_args) do |args|
+          dispatch(nil, args, nil, config)
+        end
+      rescue StandardError => e
+        handle_exception_on_start(e, config)
+      end
+
+      private
+
+      def handle_help_switches(given_args)
+        yield(given_args.dup)
+      rescue Thor::UnknownArgumentError => e
+        retry_with_args = []
+
+        if given_args.first == "help"
+          retry_with_args = ["help"] if given_args.length > 1
+        elsif e.unknown.intersect?(%w[-h --help])
+          retry_with_args = ["help", (given_args - e.unknown).first]
+        end
+        raise unless retry_with_args.any?
+
+        yield(retry_with_args)
+      end
+
+      def handle_exception_on_start(error, config)
+        return if error.is_a?(Errno::EPIPE)
+        raise if ENV["VERBOSE"] || !config.fetch(:exit_on_failure, true)
+
+        message = error.message.to_s
+        message.prepend("[#{error.class}] ") if message.empty? || !error.is_a?(Thor::Error)
+
+        config[:shell]&.say_error(message, :red)
+        exit(false)
+      end
+    end
+  end
+end

data/lib/suma/to_replace/collection_config.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative "../utils"
+require "shale"
+
+module Suma
+  module ToReplace
+    module CollectionConfig
+      class CompileOptions < Shale::Mapper
+        attribute :no_install_fonts, Shale::Type::Boolean, default: -> { true }
+        attribute :agree_to_terms, Shale::Type::Boolean, default: -> { true }
+      end
+
+      class BibdataTitle < Shale::Mapper
+        attribute :language, Shale::Type::String
+        attribute :content, Shale::Type::String
+      end
+
+      class BibdataDocid < Shale::Mapper
+        attribute :type, Shale::Type::String
+        attribute :id, Shale::Type::String
+      end
+
+      class BibdataContributor < Shale::Mapper
+        attribute :name, Shale::Type::String
+        attribute :abbreviation, Shale::Type::String
+      end
+
+      class BibdataCopyright < Shale::Mapper
+        attribute :owner, BibdataContributor
+        attribute :from, Shale::Type::String
+      end
+
+      class Bibdata < Shale::Mapper
+        attribute :title, BibdataTitle, collection: true
+        attribute :type, Shale::Type::String
+        attribute :docid, BibdataDocid
+        attribute :edition, Shale::Type::Integer
+        attribute :copyright, BibdataCopyright
+      end
+
+      class ManifestItem < Shale::Mapper
+        attribute :identifier, Shale::Type::String
+        attribute :level, Shale::Type::String
+        attribute :title, Shale::Type::String
+        attribute :attachment, Shale::Type::Boolean
+        attribute :sectionsplit, Shale::Type::Boolean
+        attribute :file, Shale::Type::String
+        attribute :docref, ManifestItem, collection: true
+
+        yaml do
+          map "identifier", to: :identifier
+          map "level", to: :level
+          map "title", to: :title
+          map "attachment", to: :attachment
+          map "sectionsplit", to: :sectionsplit
+          map "file", to: :file
+          map "fileref", to: :fileref
+          map "docref", to: :docref
+          map "fileref", using: { from: :fileref_from_yaml, to: :fileref_to_yaml }
+        end
+
+        def fileref_from_yaml(model, value)
+          # Utils.log "model #{model}, value #{value}"
+          # file_from_yaml(model, value)
+          model.file ||= value
+        end
+
+        def fileref_to_yaml(_model, _doc)
+          nil
+        end
+      end
+
+      class Manifest < Shale::Mapper
+        attribute :level, Shale::Type::String
+        attribute :title, Shale::Type::String
+        attribute :sectionsplit, Shale::Type::Boolean
+        attribute :docref, ManifestItem, collection: true
+
+        def attachments
+          docref.detect do |ref|
+            ref.level == "attachments"
+          end&.docref
+        end
+
+        def documents
+          docref.detect do |ref|
+            ref.level == "document"
+          end&.docref
+        end
+      end
+
+      class Config < Shale::Mapper
+        attr_accessor :path
+
+        attribute :directives, Shale::Type::String, collection: true
+        attribute :bibdata, Bibdata
+        attribute :manifest, Manifest
+        attribute :format, Shale::Type::String, collection: true, default: -> { [:html] }
+        attribute :output_folder, Shale::Type::String
+        attribute :coverpage, Shale::Type::String, default: -> { "cover.html" }
+        attribute :compile, CompileOptions
+        attribute :prefatory_content, Shale::Type::String
+        attribute :final_content, Shale::Type::String
+
+        def self.from_file(path)
+          from_yaml(File.read(path))
+        end
+      end
+    end
+  end
+end

data/lib/suma/to_replace/site_config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "shale"
+
+module Suma
+  module ToReplace
+    module SiteConfig
+      class SiteInfo < Shale::Mapper
+        attribute :organization, Shale::Type::String
+        attribute :name, Shale::Type::String
+      end
+
+      class Sources < Shale::Mapper
+        attribute :files, Shale::Type::String, collection: true
+      end
+
+      class Base < Shale::Mapper
+        attribute :source, Sources
+        attribute :collection, SiteInfo
+      end
+
+      class Config < Shale::Mapper
+        attribute :metanorma, Base
+
+        def self.from_file(path)
+          from_yaml(File.read(path))
+        end
+      end
+    end
+  end
+end

data/lib/suma/utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Suma
+  module Utils
+    class << self
+      def log(message)
+        puts "[suma] #{message}"
+      end
+    end
+  end
+end

data/lib/suma/version.rb

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

data/lib/suma.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "suma/version"
+require_relative "suma/processor"
+
+module Suma
+  class Error < StandardError; end
+
+  # Your code goes here...
+end

data/sig/suma.rbs

@@ -0,0 +1,4 @@
+module Suma
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/suma.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/suma/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "suma"
+  spec.version = Suma::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "Utility for SUMA " \
+  "(STEP Unified Model-Based Standards Architecture)"
+  spec.description = <<~DESCRIPTION
+    Utility for SUMA (STEP Unified Model-Based Standards Architecture)
+  DESCRIPTION
+
+  spec.homepage = "https://github.com/metanorma/suma"
+  spec.license = "BSD-2-Clause"
+
+  spec.bindir = "bin"
+  spec.require_paths = ["lib"]
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- {spec}/*`.split("\n")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "expressir"
+  spec.add_runtime_dependency "metanorma-cli"
+  spec.add_runtime_dependency "shale"
+  spec.add_runtime_dependency "thor", ">= 0.20"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: suma
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: expressir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: metanorma-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shale
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Utility for SUMA (STEP Unified Model-Based Standards Architecture)
+
+  '
+email:
+- open.source@ribose.com
+executables:
+- suma
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- exe/suma
+- lib/suma.rb
+- lib/suma/cli.rb
+- lib/suma/express_schema.rb
+- lib/suma/processor.rb
+- lib/suma/schema_collection.rb
+- lib/suma/schema_config.rb
+- lib/suma/schema_config/config.rb
+- lib/suma/schema_config/schema.rb
+- lib/suma/schema_doc.rb
+- lib/suma/thor_ext.rb
+- lib/suma/to_replace/collection_config.rb
+- lib/suma/to_replace/site_config.rb
+- lib/suma/utils.rb
+- lib/suma/version.rb
+- sig/suma.rbs
+- suma.gemspec
+homepage: https://github.com/metanorma/suma
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Utility for SUMA (STEP Unified Model-Based Standards Architecture)
+test_files: []