suma 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d5ebe81c947831dfcd9c94b3eeea2a34f33d29c548a59a55347b35adecaecc7
-  data.tar.gz: '085a461362248532759fe4d47ce5e0e7ff510147a97537c17e039878ae2e503a'
+  metadata.gz: 22e731545f38d062a61abb1972e6967d29a8b1ac15a732425bb0dc95dc598020
+  data.tar.gz: 90e7518fc1d20861c7565e1efe6909bf279974254bd82e9f7d288f41dfcc937c
 SHA512:
-  metadata.gz: df8f83de715f1dfe7bff547a539717841f0595f02c003caa69a2b09f24e50c02d9a7c1372dce6f7cfe4055e0c05ecd023b8b3033b966dd4e1016f4768bbf5b0c
-  data.tar.gz: 323215a01e582ad8d223bf76916454ca8ee23dd8d2a8f4bde78c1f57631b50da65cf05d83b6c94e9f94052fed943dfed73bfd05434a94f70414e1054652bc722
+  metadata.gz: 8b052a8b6032dca39ab5acbd6af00b2343e6da8faa490b4c0c95788a2cc29b7845e0be5dd4ebdc4da6c42cf64afc56e43e3a014a0d18b093ed0deaeec6b86ebe
+  data.tar.gz: 31cfef34ad68ee4ada47e5ad15746c7aae91fd5e90f73f7a68067db1461a61482e8c48d4f7d14b00349674667e719c7fdc4b7c7844051e4182dafb8b7ba47473

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,20 +24,20 @@ 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."
         Utils.log e
         Utils.log e.inspect
-        Utils.log e.backtrace
+        Utils.log e.backtrace.join("\n")
       end
     end
   end

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,51 +52,12 @@ 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..."
 
-          # TODO: Why will defining a collection immediately compile??
           metanorma_collection = Metanorma::Collection.parse(new_collection_config_path)
 
-          # TODO: Somehow this is no longer used
           collection_opts = {
-            format: [:html],
             output_folder: output_directory,
             compile: {
               install_fonts: false,
@@ -105,9 +66,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}"
 

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,11 +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
 
-      docs.each_pair do |schema_id, entry|
+      docs.each_pair do |_schema_id, entry|
         entry.compile
       end
 

data/lib/suma/schema_config/config.rb

@@ -78,6 +78,7 @@ 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

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.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suma
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-22 00:00:00.000000000 Z
+date: 2024-10-19 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