lutaml 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e98f32430c5e68002bab47d845cb50bf8bddb3c7fb47313b16b3e90a0488786
-  data.tar.gz: 39843ef90934f8425b092cf1a3b312f8d1257d0a4cf18f4c7286c435c0545f20
+  metadata.gz: 98c639beedce6095e724dd236e5dc3037d74b58cf1624ff7c6c8d262a32c6e98
+  data.tar.gz: 3e51d0cef9b57a0e7f22922e6de07cdecef034ab03dd8fa9869f8aa35fc36c7e
 SHA512:
-  metadata.gz: 68ab2ddac51f434300e1ffab94c441799b9cf053e7aab4e8e1b2811d22462077969fa2f66f1a48dce0e1f09ac68edb6a1cb87dfda96bf189712ac0b91ba335f2
-  data.tar.gz: af15335cecd82f6be6f5dc4138b82f829459b39f8f4033ee0baeb001b5eeab73a0e87dd80dc31d34a241726231661d755fad20aa99161862299ecd505280f672
+  metadata.gz: 023b5fe40356139612aa5426c76cd72971a7763f182bb1d6c4e13e8d718e2a875352b1fbfcd0d03b126fc3313e359c8ade3fb03d681e03db735ec344f7876050
+  data.tar.gz: ff7e1f727d0709a88e3d88b41cd89d544c7f0a38ed145b0791c7aa15b0bca7446da485ec85adb2180a5c1108cd056265c6e5b47826ebbf77061ab01a3eaa326f

data/.github/workflows/rake.yml

@@ -1,5 +1,3 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: rake
 
 on:
@@ -7,6 +5,7 @@ on:
     branches: [ master, main ]
     tags: [ v* ]
   pull_request:
+  workflow_dispatch:
 
 jobs:
   rake:

data/Gemfile

@@ -1,6 +1,4 @@
 source "https://rubygems.org"
 
-gem "expressir"
-
 # Specify your gem's dependencies in lutaml.gemspec
 gemspec

data/README.adoc

@@ -1,74 +1,105 @@
-= Lutaml
+= LutaML: Ruby library for accessing data models
 
-== Functionality
+== Purpose
 
-Entry point for lutaml extensions.
+LutaML aims to be a universal data model accessor that allows parsing
+data models in multiple languages, including:
 
-=== Installation
+* EXPRESS (https://www.expresslang.org[EXPRESS Language Foundation], ISO 10303-11)
+* XMI (from OMG)
+* UML in LutaML format
 
-With bundler:
+
+== Install
+
+With bundler, in `Gemfile`:
 
 [source,ruby]
 ----
-# Gemfile
 gem "lutaml"
 ----
 
-Then in console:
+Directly:
 
 [source,console]
 ----
-$ bundle
+$ gem install lutaml
 ----
 
-With RubyGems:
+== Usage
 
-[source,console]
-----
-$ gem install lutaml
-----
+=== Parsing
 
-=== Usage
+The `Lutaml::Parser.parse` method provides a single point of entry for parsing
+data model files.
 
-== From ruby
+The return object is always a `Lutaml::LutamlPath::DocumentWrapper` object,
+where `#original_document` returns the native parsed models.
 
-In order to parse files supported by lutaml extensions, use Lutaml::Parser.parse method.
+[source,ruby]
+----
+# example.exp is an EXPRESS schema file
+wrapper = Lutaml::Parser.parse([File.new("example.exp")])
+# => returns a Lutaml::LutamlPath::DocumentWrapper object
+wrapper.original_document
+# => returns the original Expressir::Repository object
+----
 
 [source,ruby]
 ----
-# example.exp is an EXPRESS repository file
-Lutaml::Parser.parse([File.new("example.exp")]) # will produce Lutaml::LutamlPath::DocumentWrapper object with serialized express repository
-# example.yaml is an EXPRESS cache file
-Lutaml::Parser.parse([File.new("example.yaml")], ::Lutaml::Parser::EXPRESS_CACHE_PARSE_TYPE)
+# example.exp.yaml is an EXPRESS cache file created with Expressir
+wrapper = Lutaml::Parser.parse([File.new("example.exp.yaml")], ::Lutaml::Parser::EXPRESS_CACHE_PARSE_TYPE)
+# => returns the DocumentWrapper but with the repository loaded from the Expressir cache file
 ----
 
-== With cli tool
 
-There is a cli tool available for parsing lutaml/exp files(also yaml datastruct files are supported).
+=== Selecting EXPRESS schemas
 
-[source,bash]
-----
-# Will generate `test.dot` file in the current directory
-$: lutaml -o . test.lutaml
+LutaML supports the `ModelElement#to_hash(..., select_proc:)` functionality
+of Expressir, allowing Expressir to only call `to_hash` on schemas that
+fit a dynamic criteria.
 
-# Will generate `test.png` file in the `assets` directory
-$: lutaml -o assets -t png test.lutaml
+The criteria is set via a Ruby `Proc` object, as follows.
+
+[source,ruby]
+----
+# Sets the filter
+filtered_schemas = ["action_schema", "date_time_schema"]
+
+# Sets the Proc
+wrapper.select_proc = Proc.new do |value|
+  if value.is_a?(Expressir::Model::Declarations::Schema)
+    filtered_schemas.include?(value.id)
+  else
+    true
+  end
+end
+
+serialized = wrapper.to_liquid
+# => returns the filtered to_hash method
 ----
 
-For additional info refer to `lutaml --help output`
 
+=== CLI
 
-== Development
+There is a command-line interface available for parsing supported data model files.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* EXPRESS `*.exp`
+* LutaML UML `*.lutaml`
+* LutaML YAML datastruct files
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+[source,bash]
+----
+# Will generate `test.dot` file in the current directory
+$ lutaml -o . test.lutaml
 
-## Contributing
+# Will generate `test.png` file in the `assets` directory
+$ lutaml -o assets -t png test.lutaml
+----
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lutaml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lutaml/blob/master/CODE_OF_CONDUCT.md).
+For additional info refer to `lutaml --help output`.
 
 
-== Code of Conduct
+== Copyright and license
 
-Everyone interacting in the Lutaml::Uml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml/blob/master/CODE_OF_CONDUCT.md).
+Copyright Ribose. BSD-3 License.

data/exe/lutaml

@@ -12,11 +12,13 @@ $:.unshift File.expand_path("../../lib", bin_file)
 # Fixes https://github.com/rubygems/rubygems/issues/1420
 require "rubygems/specification"
 
-class Gem::Specification
-  def this; self; end
+module Gem
+  class Specification
+    def this; self; end
+  end
 end
 
 require "lutaml"
 require "lutaml/command_line"
 
-Lutaml::CommandLine.run(ARGV.dup, STDOUT)
+Lutaml::CommandLine.run(ARGV.dup, $stdout)

data/lib/lutaml/command_line.rb

@@ -21,7 +21,7 @@ module Lutaml
       new(attributes, out_object).run(args)
     end
 
-    def initialize(attributes = {}, out_object = STDOUT)
+    def initialize(attributes = {}, out_object = $stdout)
       @formatter = ::Lutaml::Formatter::Graphviz.new
       @verbose = false
       @option_parser = OptionParser.new
@@ -70,11 +70,15 @@ module Lutaml
 
     def run(original_args)
       args = original_args.dup
-      if args.length.zero? || args.first.strip == "help"
+      if args.empty? || args.first.strip == "help"
         print_help
         exit
       end
-      @option_parser.parse!(args) rescue nil
+      begin
+        @option_parser.parse!(args)
+      rescue StandardError
+        nil
+      end
       @paths = args
       @formatter.type = @type
 

data/lib/lutaml/express/lutaml_path/document_wrapper.rb

@@ -5,11 +5,16 @@ module Lutaml
   module Express
     module LutamlPath
       class DocumentWrapper < ::Lutaml::LutamlPath::DocumentWrapper
+        attr_accessor :select_proc
+
         protected
 
         def serialize_document(repository)
-          repository
-            .to_hash(formatter: Formatter, include_empty: true)
+          repository.to_hash(
+            formatter: Formatter,
+            include_empty: true,
+            select_proc: select_proc,
+          )
         end
       end
     end

data/lib/lutaml/express/lutaml_path/formatter.rb

@@ -11,4 +11,4 @@ module Lutaml
       end
     end
   end
-end
+end

data/lib/lutaml/formatter/base.rb

@@ -44,7 +44,7 @@ module Lutaml
         when ::Lutaml::Uml::Node::Method then format_method(node)
         when ::Lutaml::Uml::Node::Relationship then format_relationship(node)
         when ::Lutaml::Uml::Node::ClassRelationship
-          then format_class_relationship(node)
+          format_class_relationship(node)
         when ::Lutaml::Uml::Node::ClassNode then format_class(node)
         when Lutaml::Uml::Document then format_document(node)
         end

data/lib/lutaml/formatter/graphviz.rb

@@ -17,11 +17,11 @@ module Lutaml
       end
 
       ACCESS_SYMBOLS = {
-        "public"    => "+",
+        "public" => "+",
         "protected" => "#",
-        "private"   => "-",
+        "private" => "-",
       }.freeze
-      DEFAULT_CLASS_FONT = "Helvetica".freeze
+      DEFAULT_CLASS_FONT = "Helvetica"
 
       VALID_TYPES = %i[
         dot
@@ -65,9 +65,7 @@ module Lutaml
         @type = :dot
       end
 
-      attr_reader :graph
-      attr_reader :edge
-      attr_reader :node
+      attr_reader :graph, :edge, :node
 
       def type=(value)
         super
@@ -147,13 +145,13 @@ module Lutaml
         if node.owner_end_attribute_name
           attributes["headlabel"] = format_label(
             node.owner_end_attribute_name,
-            node.owner_end_cardinality
+            node.owner_end_cardinality,
           )
         end
         if node.member_end_attribute_name
           attributes["taillabel"] = format_label(
             node.member_end_attribute_name,
-            node.member_end_cardinality
+            node.member_end_cardinality,
           )
         end
 

data/lib/lutaml/lutaml_path/document_wrapper.rb

@@ -5,11 +5,10 @@ module Lutaml
 
       def initialize(document)
         @original_document = document
-        @serialized_document = serialize_document(document)
       end
 
       def to_liquid
-        serialized_document
+        @serialized_document ||= serialize_document(@original_document)
       end
 
       protected
@@ -27,7 +26,8 @@ module Lutaml
       end
 
       def serialize_to_hash(object)
-        return object if [String, Integer, Float, FalseClass, TrueClass, Symbol, NilClass, Hash].include?(object.class)
+        return object if [String, Integer, Float, FalseClass, TrueClass,
+                          Symbol, NilClass, Hash].include?(object.class)
 
         object.instance_variables.each_with_object({}) do |var, res|
           variable = object.instance_variable_get(var)
@@ -35,12 +35,10 @@ module Lutaml
                                           variable.map do |n|
                                             serialize_to_hash(n)
                                           end
+                                        elsif [String, Integer, Float, FalseClass, TrueClass, Symbol, NilClass, Hash].include?(variable.class) || var == :@parent
+                                          variable
                                         else
-                                          if [String, Integer, Float, FalseClass, TrueClass, Symbol, NilClass, Hash].include?(variable.class) || var == :@parent
-                                            variable
-                                          else
-                                            serialize_to_hash(variable)
-                                          end
+                                          serialize_to_hash(variable)
                                         end
         end
       end

data/lib/lutaml/parser.rb

@@ -24,13 +24,14 @@ module Lutaml
     end
 
     def initialize(file_list, input_type)
-      @parse_type = input_type ? input_type : File.extname(file_list.first.path)[1..-1]
+      @parse_type = input_type || File.extname(file_list.first.path)[1..-1]
       @file_list = file_list
     end
 
     def parse
       documents = parse_into_document
-      return document_wrapper(documents) if ["exp", EXPRESS_CACHE_PARSE_TYPE].include?(parse_type)
+      return document_wrapper(documents) if ["exp",
+                                             EXPRESS_CACHE_PARSE_TYPE].include?(parse_type)
 
       documents.map { |doc| document_wrapper(doc) }
     end
@@ -41,7 +42,7 @@ module Lutaml
         Expressir::Express::Parser.from_files(file_list.map(&:path))
       when EXPRESS_CACHE_PARSE_TYPE
         Expressir::Express::Cache.from_file(file_list.first.path)
-      when 'xmi'
+      when "xmi"
         file_list.map { |file| Lutaml::XMI::Parsers::XML.parse(file) }
       when "lutaml"
         file_list.map { |file| Lutaml::Uml::Parsers::Dsl.parse(file) }

data/lib/lutaml/version.rb

@@ -1,3 +1,3 @@
 module Lutaml
-  VERSION = "0.7.5".freeze
+  VERSION = "0.7.6".freeze
 end

data/lutaml.gemspec

@@ -27,16 +27,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_runtime_dependency "expressir", "~> 1.3"
   spec.add_runtime_dependency "lutaml-express"
   spec.add_runtime_dependency "lutaml-uml"
   spec.add_runtime_dependency "lutaml-xmi"
-  spec.add_runtime_dependency "thor", "~> 1.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.10"
+  spec.add_runtime_dependency "thor", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "byebug"
   spec.add_development_dependency "pry", "~> 0.12.2"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.54.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rubocop", "~> 1.58"
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: lutaml-express
+  name: expressir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: lutaml-uml
+  name: lutaml-express
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lutaml-xmi
+  name: lutaml-uml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: lutaml-xmi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -81,33 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -128,42 +114,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '1.58'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '1.58'
 description: 'LutaML: data models in textual form'
 email:
 - open.source@ribose.com'
@@ -178,7 +164,6 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.adoc
@@ -215,14 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: 'LutaML: data models in textual form'

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 2.1.4