suma 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0cee8119660d33e2592a44875f218ff7cad624c0c5ff89430c5f97eda5f593e
-  data.tar.gz: 9fdc83bc1383b931d0907d9f31e4d94986a7922b55ef4f82ae437b4a52833f08
+  metadata.gz: b3574bcc351316187d71e125e1ba19a8c3c275993b1a87d0c24cd050831507ca
+  data.tar.gz: cc8392459a664fcb6cf2202a8ebdc8346b2db0f4712e24e306cc2b805bd03c60
 SHA512:
-  metadata.gz: d2e87931a5396a1b42245c0d3156345e539b6d1f11bb82b6fcc9537603cec0f1d084e7636705d5eae87b180bc1618a77330e616b714ed1b94ae25f910a7209a6
-  data.tar.gz: 80eebf4ce42b572fb812a8729d6a71e9a96ed08d7d2d2c04b9b9884d721adf70075a6c2ccc6d400bdbc94573edc44f273baec9c9adcb7517134a6473cbabfdf4
+  metadata.gz: f83fdb2f934c410f4f434a98d49d46dc5a9d0ce619496a627c9803ed049e28a62b8a50c3c7eafddbbe2204f8486657927a5a2936a170292473ed939e6b5b471f
+  data.tar.gz: 7c2ed86bc187638f15957e53299b481563ae874e565bd8a92aedfb3cd30a5825dfb77a37122245132bc6feb9d869b67c8d023e0c6a51e29fd66dc069e6316a3d

data/.rubocop.yml

@@ -1,6 +1,7 @@
 # Auto-generated by Cimas: Do not edit it manually!
 # See https://github.com/metanorma/cimas
 inherit_from:
+  - .rubocop_todo.yml
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications

data/.rubocop_todo.yml

@@ -0,0 +1,77 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-10-17 02:50:55 UTC using RuboCop version 1.67.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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/DuplicatedAssignment:
+  Exclude:
+    - 'suma.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'suma.gemspec'
+
+# Offense count: 21
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/suma/cli.rb'
+    - 'lib/suma/collection_manifest.rb'
+    - 'lib/suma/processor.rb'
+    - 'lib/suma/schema_attachment.rb'
+    - 'lib/suma/schema_collection.rb'
+    - 'lib/suma/schema_document.rb'
+    - 'lib/suma/thor_ext.rb'
+    - 'suma.gemspec'
+
+# Offense count: 1
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/suma/express_schema.rb'
+
+# Offense count: 8
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/suma/collection_manifest.rb'
+    - 'lib/suma/processor.rb'
+    - 'lib/suma/schema_attachment.rb'
+    - 'lib/suma/schema_collection.rb'
+    - 'lib/suma/schema_config/config.rb'
+    - 'lib/suma/schema_document.rb'
+    - 'lib/suma/thor_ext.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 33
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/suma/collection_manifest.rb'
+    - 'lib/suma/thor_ext.rb'
+
+# Offense count: 7
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 52
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/suma/schema_collection.rb'

data/lib/suma/cli.rb

@@ -9,8 +9,10 @@ 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"
+    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."
 
@@ -22,14 +24,14 @@ module Suma
 
       # Set schemas_all_path to match metanorma_yaml_path
       schemas_all_path = options[:schemas_all_path] ||
-                         metanorma_site_manifest.gsub("metanorma", "schemas")
+        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"
+          output_directory: "_site",
         )
       rescue StandardError => e
         Utils.log "[ERROR] Error occurred during processing. See details below."

data/lib/suma/collection_manifest.rb

@@ -69,7 +69,7 @@ module Suma
 
       # If there is collection.yml, this is a document collection, we process
       # schemas.yaml.
-      if File.basename(file) == 'collection.yml'
+      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)
@@ -99,8 +99,8 @@ module Suma
       # we need to separate this file from the following new entries
       added = CollectionManifest.new(
         title: "Collection",
-        type:  "collection",
-        identifier: self.identifier + "_"
+        type: "collection",
+        identifier: "#{identifier}_",
       )
 
       added.entry = [

data/lib/suma/processor.rb

@@ -12,8 +12,8 @@ require "metanorma/collection/collection"
 module Suma
   class Processor
     class << self
-
-      def run(metanorma_yaml_path:, schemas_all_path:, compile:, output_directory: "_site")
+      def run(metanorma_yaml_path:, schemas_all_path:, compile:,
+output_directory: "_site")
         Utils.log "Current directory: #{Dir.getwd}"
 
         # This reads the metanorma.yml file
@@ -52,42 +52,6 @@ module Suma
         collection_config.manifest.remove_schemas_only_sources
         collection_config.to_file(new_collection_config_path)
 
-        # 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..."
 
@@ -105,9 +69,11 @@ module Suma
           }
           metanorma_collection.render(collection_opts)
 
-          # remove xml files
-          Dir.glob(File.join(Dir.getwd, output_directory, "*.xml")).each do |file|
-            File.delete(file)
+          # 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."

data/lib/suma/schema_attachment.rb

@@ -55,7 +55,7 @@ module Suma
       FileUtils.mkdir_p(File.dirname(filename_adoc))
 
       relative_path = Pathname.new(filename_config)
-                              .relative_path_from(Pathname.new(File.dirname(filename_adoc)))
+        .relative_path_from(Pathname.new(File.dirname(filename_adoc)))
 
       # Utils.log "relative_path #{relative_path}"
 
@@ -68,13 +68,14 @@ module Suma
       File.join(@output_path, "schema_#{@schema.id}.yaml")
     end
 
-    def to_config
+    def to_config(path: nil)
       # return @config unless @config
       @config = SchemaConfig::Config.new
       @config.schemas << SchemaConfig::Schema.new(
         id: @schema.id,
-        path: @schema.path
+        path: @schema.path,
       )
+      path and @config.path = path
 
       @config
     end
@@ -83,16 +84,16 @@ module Suma
       relative_path = Pathname.new(filename_config).relative_path_from(Dir.pwd)
       Utils.log "Save schema config: #{relative_path}"
 
+      # Still overwrite even if the file exists
       # 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
+      to_config.save_to_path(filename_config)
     end
 
     # Compile Metanorma adoc per EXPRESS schema
     def compile
+      # TODO: Clean artifacts after compiling
       # I am commenting out because I'm playing with the schemas-only status
       # return self if File.exist?(output_xml_path)
 
@@ -104,7 +105,7 @@ module Suma
       Metanorma::Compile.new.compile(
         filename_adoc,
         agree_to_terms: true,
-        install_fonts: false
+        install_fonts: false,
       )
       Utils.log "Compiling schema (id: #{id}, type: #{self.class}) => #{relative_path}... done!"
 
@@ -124,7 +125,7 @@ module Suma
         filename_adoc,
         filename_adoc("presentation.xml"),
         filename_adoc("adoc.lutaml.log.txt"),
-        filename_adoc("err.html")
+        filename_adoc("err.html"),
       ].each do |filename|
         FileUtils.rm_rf(filename)
       end

data/lib/suma/schema_collection.rb

@@ -9,9 +9,10 @@ require_relative "utils"
 module Suma
   class SchemaCollection
     attr_accessor :config, :schemas, :docs, :output_path_docs, :output_path_schemas,
-      :manifest
+                  :manifest
 
-    def initialize(config: nil, config_yaml: nil, output_path_docs: nil, output_path_schemas: nil, manifest: nil)
+    def initialize(config: nil, config_yaml: nil, output_path_docs: nil,
+output_path_schemas: nil, manifest: nil)
       @schemas = {}
       @docs = {}
       @schema_name_to_docs = {}
@@ -44,12 +45,12 @@ module Suma
         s = ExpressSchema.new(
           id: config_schema.id,
           path: config_schema.path.to_s,
-          output_path: @output_path_schemas.to_s
+          output_path: @output_path_schemas.to_s,
         )
 
         doc = klass.new(
           schema: s,
-          output_path: @output_path_docs.join(s.id)
+          output_path: @output_path_docs.join(s.id),
         )
 
         @docs[s.id] = doc
@@ -74,13 +75,11 @@ module Suma
 
     def compile
       finalize
-      schemas.each_pair do |schema_id, entry|
+      schemas.each_pair do |_schema_id, entry|
         entry.save_exp
       end
 
-      # DISABLING FOLLOWING CODE AS MISCONCEIVED. THE SCHEMA DOCUMENTS
-      # BELONG IN THE MAIN COLLECTION NOT HERE
-      docs.each_pair do |schema_id, entry|
+      docs.each_pair do |_schema_id, entry|
         entry.compile
       end
 

data/lib/suma/schema_config/config.rb

@@ -9,6 +9,7 @@ module Suma
     class Config < Shale::Mapper
       attribute :schemas, Schema, collection: true
       attribute :path, Shale::Type::String
+      attr_accessor :output_path
 
       def initialize(**args)
         @path = path_relative_to_absolute(path) if path
@@ -39,6 +40,7 @@ module Suma
         @path = path_relative_to_absolute(new_path)
         schemas.each do |schema|
           schema.path = path_relative_to_absolute(schema.path)
+          schema.container_path = File.expand_path(@path)
         end
       end
 
@@ -48,17 +50,25 @@ module Suma
         end
       end
 
-      # TODO: I can't get the relative path working. The schemas-*.yaml file is
-      # meant to contain the "path" key, which is a relative path to its
-      # location, then sets the base path to each schema path, which is supposed
-      # to be relative to "path" key. Somehow, the @path variable is always
-      # missing in to_yaml...
       def schemas_to_yaml(model, doc)
-        # puts "^"*30
-        # pp self
-        # pp @path
         doc["schemas"] = model.schemas.sort_by(&:id).to_h do |schema|
-          [schema.id, { "path" => path_absolute_to_relative(schema.path) }]
+          # We are outputting the schemas collection file to the directory where
+          # the collection config is at (assumed to be Dir.pwd), not to the
+          # directory we sourced the manifest from, e.g.
+          # documents/iso-10303-41/schemas.yaml.
+
+          # So the schema.container_path = @config.path is not
+          # in fact needed, as the files are already absolute. This notion of
+          # using @path to create relative paths was misconceived
+          [
+            schema.id,
+            {
+              "path" => path_absolute_to_relative(
+                schema.path,
+                model.output_path || Dir.pwd,
+              ),
+            },
+          ]
         end
       end
 
@@ -69,19 +79,18 @@ module Suma
         # Or based on current working directory?
         return relative_path unless @path
 
+        # ... but if this calculates path, we end up expanding it anyway
+
         Pathname.new(File.dirname(@path)).join(eval_path).expand_path.to_s
       end
 
-      def path_absolute_to_relative(absolute_path)
-        # puts "path_absolute_to_relative 1 #{absolute_path}"
-        # pp self
-        # pp path
-        # pp @hello
-        return absolute_path unless @path
+      def path_absolute_to_relative(absolute_path, container_path)
+        container_path ||= @path
+        return absolute_path unless container_path
 
-        relative_path = Pathname.new(absolute_path).relative_path_from(Pathname.new(@path).dirname).to_s
-        # puts "path_absolute_to_relative x #{relative_path}"
-        relative_path
+        p = Pathname.new(container_path)
+        container = p.directory? ? p.to_s : p.dirname
+        Pathname.new(absolute_path).relative_path_from(container).to_s
       end
 
       def update_path(new_path)
@@ -98,8 +107,8 @@ module Suma
           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
+          # This is the new relative schema_path
+          schema.path = schema_path.relative_path_from(new_base_path)
         end
 
         @path = new_path
@@ -107,7 +116,7 @@ module Suma
 
       def concat(another_config)
         unless another_config.is_a?(self.class)
-          raise StandardError, "Can only concatenate a non SchemaConfig::Config object."
+          raise StandardError, "Can only concat a SchemaConfig::Config object."
         end
 
         # We need to update the relative paths when paths exist
@@ -120,13 +129,15 @@ module Suma
       end
 
       def save_to_path(filename)
-        new_config = dup
-        new_config.path = filename
-        new_config.update_base_path(File.dirname(filename))
+        new_config = dup.tap do |c|
+          c.path = filename
+          c.update_path(File.dirname(filename))
+          c.output_path = filename
+        end
 
         File.open(filename, "w") do |f|
           Utils.log "Writing #{filename}..."
-          f.write(to_yaml)
+          f.write(new_config.to_yaml)
           Utils.log "Done."
         end
       end

data/lib/suma/schema_config/schema.rb

@@ -8,6 +8,12 @@ module Suma
       attribute :id, Shale::Type::String
       attribute :path, Shale::Type::String
       # attribute :schemas_only, Shale::Type::Boolean
+
+      # container_path is a copy of Suma::SchemaConfig::Config.path,
+      # used to resolve the path of each schema within
+      # Suma::SchemaConfig::Config.schemas,
+      # when Suma::SchemaConfig::Config.schemas is recursively flattened
+      attr_accessor :container_path
     end
   end
 end

data/lib/suma/schema_document.rb

@@ -16,23 +16,23 @@ module Suma
 
         // _constants.liquid
         {% if schema.constants.size > 0 %}
-        #{bookmark("constants")}
+        #{bookmark('constants')}
         {% for thing in schema.constants %}
-        #{bookmark("{{thing.id}}")}
+        #{bookmark('{{thing.id}}')}
         {% endfor %}
         {% endif %}
 
         // _types.liquid
         {% if schema.types.size > 0 %}
-        #{bookmark("types")}
+        #{bookmark('types')}
         // _type.liquid
         {% for thing in schema.types %}
-        #{bookmark("{{thing.id}}")}
+        #{bookmark('{{thing.id}}')}
         {% if thing.items.size > 0 %}
         // _type_items.liquid
-        #{bookmark("{{thing.id}}.items")}
+        #{bookmark('{{thing.id}}.items')}
         {% for item in thing.items %}
-        #{bookmark("{{thing.id}}.items.{{item.id}}")}
+        #{bookmark('{{thing.id}}.items.{{item.id}}')}
         {% endfor %}
         {% endif %}
         {% endfor %}
@@ -40,10 +40,46 @@ module Suma
 
         // _entities.liquid
         {% if schema.entities.size > 0 %}
-        #{bookmark("entities")}
+        #{bookmark('entities')}
         {% for thing in schema.entities %}
         // _entity.liquid
-        #{bookmark("{{thing.id}}")}
+        #{bookmark('{{thing.id}}')}
+        {% endfor %}
+        {% endif %}
+
+        // _subtype_constraints.liquid
+        {% if schema.subtype_constraints.size > 0 %}
+        #{bookmark('subtype_constraints')}
+        // _subtype_constraint.liquid
+        {% for thing in schema.subtype_constraints %}
+        #{bookmark('{{thing.id}}')}
+        {% endfor %}
+        {% endif %}
+
+        // _functions.liquid
+        {% if schema.functions.size > 0 %}
+        #{bookmark('functions')}
+        // _function.liquid
+        {% for thing in schema.functions %}
+        #{bookmark('{{thing.id}}')}
+        {% endfor %}
+        {% endif %}
+
+        // _procedures.liquid
+        {% if schema.procedures.size > 0 %}
+        #{bookmark('procedures')}
+        // _procedure.liquid
+        {% for thing in schema.procedures %}
+        #{bookmark('{{thing.id}}')}
+        {% endfor %}
+        {% endif %}
+
+        // _rules.liquid
+        {% if schema.rules.size > 0 %}
+        #{bookmark('rules')}
+        // _rule.liquid
+        {% for thing in schema.rules %}
+        #{bookmark('{{thing.id}}')}
         {% endfor %}
         {% endif %}
       HEREDOC
@@ -81,7 +117,7 @@ module Suma
 
         [[#{@id}]]
         [%unnumbered,type=express]
-        == #{@id} #{schema_anchors.gsub(%r{//[^\r\n]+}, "").gsub(/[\n\r]+/, "").gsub(/^[\n\r]/, "")}
+        == #{@id} #{schema_anchors.gsub(%r{//[^\r\n]+}, '').gsub(/[\n\r]+/, '').gsub(/^[\n\r]/, '')}
 
         [source%unnumbered]
         --

data/lib/suma/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suma
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expressir
@@ -123,6 +123,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.adoc