suma 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e731545f38d062a61abb1972e6967d29a8b1ac15a732425bb0dc95dc598020
-  data.tar.gz: 90e7518fc1d20861c7565e1efe6909bf279974254bd82e9f7d288f41dfcc937c
+  metadata.gz: 89c0461d2c0175902bc3f33f9067db2f98fecd736a24b47847e3e4181f043d37
+  data.tar.gz: 3fe9d75eb97f06b1c296333ed3c0644e99cd90397edc3e89502b1c9ae6939375
 SHA512:
-  metadata.gz: 8b052a8b6032dca39ab5acbd6af00b2343e6da8faa490b4c0c95788a2cc29b7845e0be5dd4ebdc4da6c42cf64afc56e43e3a014a0d18b093ed0deaeec6b86ebe
-  data.tar.gz: 31cfef34ad68ee4ada47e5ad15746c7aae91fd5e90f73f7a68067db1461a61482e8c48d4f7d14b00349674667e719c7fdc4b7c7844051e4182dafb8b7ba47473
+  metadata.gz: e3fbe44771043d03a1ebcb6c8b6615717a624fe81b3f66c83ed5d62f51f5e5e3c2f33fdd8d5b85c7c31f25743a026ef6c6aa50a4812dee266a9ad75ec748b9de
+  data.tar.gz: a4494b710d3308bf02526b1b4cb83d876aeae3991f47ded95dd1c2bfb9f000e88c3c872bfdb0ffe758da3af2bf9fdd37bd48c5a2062a1ccfa3f3f81b05a8f7f3

data/Gemfile

@@ -6,7 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rails"

data/lib/suma/cli.rb

@@ -22,23 +22,33 @@ module Suma
           "`#{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",
-        )
+        run(metanorma_site_manifest, options)
       rescue StandardError => e
-        Utils.log "[ERROR] Error occurred during processing. See details below."
-        Utils.log e
-        Utils.log e.inspect
-        Utils.log e.backtrace.join("\n")
+        log_error(e)
       end
     end
+
+    private
+
+    def run(manifest, options)
+      # Set schemas_all_path to match metanorma_yaml_path
+      schemas_all_path = options[:schemas_all_path] ||
+        manifest.gsub("metanorma", "schemas")
+
+      Processor.run(
+        metanorma_yaml_path: manifest,
+        schemas_all_path: schemas_all_path,
+        compile: options[:compile],
+        output_directory: "_site",
+      )
+    end
+
+    def log_error(error)
+      Utils.log "[ERROR] Error occurred during processing. See details below."
+      Utils.log error
+      Utils.log error.inspect
+      Utils.log error.backtrace.join("\n")
+    end
   end
 end

data/lib/suma/collection_config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "utils"
-require "shale"
+require "lutaml/model"
 require_relative "collection_manifest"
 require "metanorma/cli"
 require "metanorma/cli/collection"

data/lib/suma/collection_manifest.rb

@@ -6,15 +6,15 @@ require "metanorma/collection/collection"
 
 module Suma
   class CollectionManifest < Metanorma::Collection::Config::Manifest
-    attribute :schemas_only, Shale::Type::Boolean
+    attribute :schemas_only, Lutaml::Model::Type::Boolean
     attribute :entry, CollectionManifest, collection: true
-    # attribute :schema_source, Shale::Type::String
+    # attribute :schema_source, Lutaml::Model::Type::String
     attr_accessor :schema_config
 
     yaml do
       map "identifier", to: :identifier
       map "type", to: :type
-      map "level", using: { from: :level_from_yaml, to: :nop_to_yaml }
+      map "level", with: { from: :level_from_yaml, to: :nop_to_yaml }
       map "title", to: :title
       map "url", to: :url
       map "attachment", to: :attachment
@@ -22,12 +22,12 @@ module Suma
       map "schemas-only", to: :schemas_only
       map "index", to: :index
       map "file", to: :file
-      map "fileref", using: { from: :fileref_from_yaml, to: :nop_to_yaml }
+      map "fileref", with: { from: :fileref_from_yaml, to: :nop_to_yaml }
       map "entry", to: :entry
-      map "docref", using: { from: :docref_from_yaml, to: :nop_to_yaml }
-      map "manifest", using: { from: :docref_from_yaml, to: :nop_to_yaml }
-      map "bibdata", using: { from: :bibdata_from_yaml,
-                              to: :bibdata_to_yaml }
+      map "docref", with: { from: :docref_from_yaml, to: :nop_to_yaml }
+      map "manifest", with: { from: :docref_from_yaml, to: :nop_to_yaml }
+      map "bibdata", with: { from: :bibdata_from_yaml,
+                             to: :bibdata_to_yaml }
     end
 
     def docref_from_yaml(model, value)
@@ -67,14 +67,7 @@ module Suma
     def expand_schemas_only(schema_output_path)
       return process_entry(schema_output_path) unless file
 
-      # If there is collection.yml, this is a document collection, we process
-      # schemas.yaml.
-      if File.basename(file) == "collection.yml"
-        schemas_yaml_path = File.join(File.dirname(file), "schemas.yaml")
-        if schemas_yaml_path && File.exist?(schemas_yaml_path)
-          @schema_config = Suma::SchemaConfig::Config.from_file(schemas_yaml_path)
-        end
-      end
+      update_schema_config
 
       return process_entry(schema_output_path) unless schemas_only
 
@@ -82,10 +75,18 @@ module Suma
       # have it showing up in output.
       self.index = false
 
-      doc = CollectionConfig.from_file(file)
-      doc_id = doc.bibdata.id
+      [self, added_collection_manifest]
+    end
 
-      entries = @schema_config.schemas.map do |schema|
+    def remove_schemas_only_sources
+      ret = entry.each_with_object([]) do |e, m|
+        e.schemas_only or m << e
+      end
+      self.entry = ret
+    end
+
+    def entries(schema_output_path)
+      @schema_config.schemas.map do |schema|
         fname = [File.basename(schema.path, ".exp"), ".xml"].join
 
         CollectionManifest.new(
@@ -95,6 +96,11 @@ module Suma
           # schema_source: schema.path
         )
       end
+    end
+
+    def added_collection_manifest
+      doc = CollectionConfig.from_file(file)
+      doc_id = doc.bibdata.id
 
       # we need to separate this file from the following new entries
       added = CollectionManifest.new(
@@ -111,14 +117,18 @@ module Suma
         ),
       ]
 
-      [self, added]
+      added
     end
 
-    def remove_schemas_only_sources
-      ret = entry.each_with_object([]) do |e, m|
-        e.schemas_only or m << e
+    def update_schema_config
+      # If there is collection.yml, this is a document collection, we process
+      # schemas.yaml.
+      if File.basename(file) == "collection.yml"
+        schemas_yaml_path = File.join(File.dirname(file), "schemas.yaml")
+        if schemas_yaml_path && File.exist?(schemas_yaml_path)
+          @schema_config = Suma::SchemaConfig::Config.from_file(schemas_yaml_path)
+        end
       end
-      self.entry = ret
     end
   end
 end

data/lib/suma/processor.rb

@@ -12,10 +12,25 @@ require "metanorma/collection/collection"
 module Suma
   class Processor
     class << self
-      def run(metanorma_yaml_path:, schemas_all_path:, compile:,
-output_directory: "_site")
-        Utils.log "Current directory: #{Dir.getwd}"
+      def run(metanorma_yaml_path:, schemas_all_path:, compile:, output_directory: "_site")
+        Utils.log "Current directory: #{Dir.getwd}, writing #{schemas_all_path}..."
+        collection_config = export_schema_config(metanorma_yaml_path, schemas_all_path)
 
+        unless compile
+          Utils.log "No compile option set. Skipping schema compilation."
+          nil
+        end
+
+        Utils.log "Compiling schema collection..."
+        compile_schema(schemas_all_path, collection_config)
+
+        Utils.log "Compiling complete collection..."
+        compile_collection(collection_config, output_directory)
+      end
+
+      private
+
+      def export_schema_config(metanorma_yaml_path, schemas_all_path)
         # This reads the metanorma.yml file
         site_config = Suma::SiteConfig::Config.from_file(metanorma_yaml_path)
 
@@ -28,12 +43,13 @@ output_directory: "_site")
         exported_schema_config = collection_config.manifest.export_schema_config(schemas_all_path)
         exported_schema_config.path = schemas_all_path
 
-        Utils.log "Writing #{schemas_all_path}..."
         exported_schema_config.to_file
-        Utils.log "Done."
 
-        # now get rid of the source documents for schema sources
+        collection_config
+      end
 
+      def compile_schema(schemas_all_path, collection_config)
+        # now get rid of the source documents for schema sources
         col = Suma::SchemaCollection.new(
           config_yaml: schemas_all_path,
           manifest: collection_config.manifest,
@@ -41,40 +57,35 @@ output_directory: "_site")
           output_path_schemas: "plain_schemas",
         )
 
-        if compile
-          Utils.log "Compiling schema collection..."
-          col.compile
-        else
-          Utils.log "No compile option set. Skipping schema compilation."
+        col.compile
+      end
+
+      def compile_collection(collection_config, output_directory)
+        metanorma_collection, collection_opts = build_collection(collection_config, output_directory)
+
+        metanorma_collection.render(collection_opts)
+
+        # TODO: Temporarily disable removal of XML files
+        Dir.glob(File.join(Dir.getwd, output_directory,
+                           "*.xml")).each do |file|
+          puts "NOT DELETING ANY FILE #{file.inspect}"
+          # File.delete(file)
         end
+      end
 
+      def build_collection(collection_config, output_directory)
         new_collection_config_path = "collection-output.yaml"
         collection_config.manifest.remove_schemas_only_sources
         collection_config.to_file(new_collection_config_path)
 
-        if compile
-          Utils.log "Compiling complete collection..."
-
-          metanorma_collection = Metanorma::Collection.parse(new_collection_config_path)
-
-          collection_opts = {
-            output_folder: output_directory,
-            compile: {
-              install_fonts: false,
-            },
-            coverpage: "cover.html",
-          }
-          metanorma_collection.render(collection_opts)
-
-          # TODO: Temporarily disable removal of XML files
-          Dir.glob(File.join(Dir.getwd, output_directory,
-                             "*.xml")).each do |file|
-            puts "NOT DELETING ANY FILE #{file.inspect}"
-            # File.delete(file)
-          end
-        else
-          Utils.log "No compile option set. Skipping collection compilation."
-        end
+        collection = Metanorma::Collection.parse(new_collection_config_path)
+
+        collection_opts = {
+          output_folder: output_directory,
+          compile: { install_fonts: false },
+          coverpage: "cover.html",
+        }
+        [collection, collection_opts]
       end
     end
   end

data/lib/suma/schema_attachment.rb

@@ -102,11 +102,7 @@ module Suma
 
       relative_path = Pathname.new(filename_adoc).relative_path_from(Dir.pwd)
       Utils.log "Compiling schema (id: #{id}, type: #{self.class}) => #{relative_path}"
-      Metanorma::Compile.new.compile(
-        filename_adoc,
-        agree_to_terms: true,
-        install_fonts: false,
-      )
+      Metanorma::Compile.new.compile(filename_adoc, agree_to_terms: true, install_fonts: false)
       Utils.log "Compiling schema (id: #{id}, type: #{self.class}) => #{relative_path}... done!"
 
       # clean_artifacts

data/lib/suma/schema_collection.rb

@@ -12,27 +12,14 @@ module Suma
                   :manifest
 
     def initialize(config: nil, config_yaml: nil, output_path_docs: nil,
-output_path_schemas: nil, manifest: nil)
+                   output_path_schemas: nil, manifest: 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
-
+      @output_path_docs = Pathname.new(output_path_docs || Dir.pwd).expand_path
+      @output_path_schemas = Pathname.new(output_path_schemas || Dir.pwd).expand_path
+      @config = config
+      @config ||= config_yaml && SchemaConfig::Config.from_file(config_yaml)
       @manifest = manifest
     end
 
@@ -42,21 +29,23 @@ output_path_schemas: nil, manifest: nil)
 
     def process_schemas(schemas, klass)
       schemas.each do |config_schema|
-        s = ExpressSchema.new(
-          id: config_schema.id,
-          path: config_schema.path.to_s,
-          output_path: @output_path_schemas.to_s,
-        )
+        process_schema(config_schema, klass)
+      end
+    end
 
-        doc = klass.new(
-          schema: s,
-          output_path: @output_path_docs.join(s.id),
-        )
+    def process_schema(config_schema, klass)
+      s = ExpressSchema.new(
+        id: config_schema.id, path: config_schema.path.to_s,
+        output_path: @output_path_schemas.to_s
+      )
 
-        @docs[s.id] = doc
-        @schemas[s.id] = s
-        @schema_name_to_docs[s.id] = doc
-      end
+      doc = klass.new(
+        schema: s, output_path: @output_path_docs.join(s.id),
+      )
+
+      @docs[s.id] = doc
+      @schemas[s.id] = s
+      @schema_name_to_docs[s.id] = doc
     end
 
     def finalize

data/lib/suma/schema_config/config.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 require_relative "schema"
 require_relative "../utils"
 
 module Suma
   module SchemaConfig
-    class Config < Shale::Mapper
+    class Config < Lutaml::Model::Serializable
       attribute :schemas, Schema, collection: true
-      attribute :path, Shale::Type::String
+      attribute :path, Lutaml::Model::Type::String
       attr_accessor :output_path
 
       def initialize(**args)
@@ -21,7 +21,7 @@ module Suma
       end
 
       yaml do
-        map "schemas", using: { from: :schemas_from_yaml, to: :schemas_to_yaml }
+        map "schemas", with: { from: :schemas_from_yaml, to: :schemas_to_yaml }
       end
 
       def self.from_file(path)
@@ -101,15 +101,7 @@ module Suma
 
         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
-          # This is the new relative schema_path
-          schema.path = schema_path.relative_path_from(new_base_path)
-        end
+        update_schema_path(old_base_path, new_base_path)
 
         @path = new_path
       end
@@ -141,6 +133,17 @@ module Suma
           Utils.log "Done."
         end
       end
+
+      def update_schema_path(old_base_path, new_base_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
+          # This is the new relative schema_path
+          schema.path = schema_path.relative_path_from(new_base_path)
+        end
+      end
     end
   end
 end

data/lib/suma/schema_config/schema.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 module Suma
   module SchemaConfig
-    class Schema < Shale::Mapper
-      attribute :id, Shale::Type::String
-      attribute :path, Shale::Type::String
-      # attribute :schemas_only, Shale::Type::Boolean
+    class Schema < Lutaml::Model::Serializable
+      attribute :id, Lutaml::Model::Type::String
+      attribute :path, Lutaml::Model::Type::String
+      # attribute :schemas_only, Lutaml::Model::Type::Boolean
 
       # container_path is a copy of Suma::SchemaConfig::Config.path,
       # used to resolve the path of each schema within

data/lib/suma/site_config.rb

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-require "shale"
+require "lutaml/model"
 
 module Suma
   module SiteConfig
-    class SiteInfo < Shale::Mapper
-      attribute :organization, Shale::Type::String
-      attribute :name, Shale::Type::String
+    class SiteInfo < Lutaml::Model::Serializable
+      attribute :organization, Lutaml::Model::Type::String
+      attribute :name, Lutaml::Model::Type::String
     end
 
-    class Sources < Shale::Mapper
-      attribute :files, Shale::Type::String, collection: true
+    class Sources < Lutaml::Model::Serializable
+      attribute :files, Lutaml::Model::Type::String, collection: true
     end
 
-    class Base < Shale::Mapper
+    class Base < Lutaml::Model::Serializable
       attribute :source, Sources
       attribute :collection, SiteInfo
     end
 
-    class Config < Shale::Mapper
+    class Config < Lutaml::Model::Serializable
       attribute :metanorma, Base
 
       def self.from_file(path)

data/lib/suma/version.rb

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

data/suma.gemspec

@@ -2,7 +2,7 @@
 
 require_relative "lib/suma/version"
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name = "suma"
   spec.version = Suma::VERSION
   spec.authors = ["Ribose Inc."]
@@ -34,11 +34,8 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_dependency "expressir"
+  spec.add_dependency "lutaml-model"
+  spec.add_dependency "metanorma-cli"
+  spec.add_dependency "thor", ">= 0.20"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suma
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expressir
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: metanorma-cli
+  name: lutaml-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shale
+  name: metanorma-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,48 +66,6 @@ dependencies:
     - - ">="
       - !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)
 
   '
@@ -153,7 +111,7 @@ homepage: https://github.com/metanorma/suma
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Utility for SUMA (STEP Unified Model-Based Standards Architecture)
 test_files: []