expressir 1.4.1-x86_64-linux-gnu → 1.4.3-x86_64-linux-gnu

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea23edf38a9a3e22e36c83322ccec63603b19ea633d1fa41da9d6ab1f3094c2
-  data.tar.gz: e7e02219fc450a0d03ef858e5692a7a47165e426ef9d451b1857dad2fbab6d2a
+  metadata.gz: feb588e03a5268778cf7520e89c4214ab0ac6061b0d3564ba554b6950706e842
+  data.tar.gz: 73c251eb7aa155b76e8260694dc6d50454e9fbe5559da3a13de9796ad5a02f06
 SHA512:
-  metadata.gz: 5336821acc858995c809835ab67c9eb337cd8ae9017e26f305feca145fd241984b40f58627b7e63b80a514e1cae1404e0c9af8ff38d9a0017f861877374f99a8
-  data.tar.gz: b7cbcac51d4b61768cedb767e80409e4bc555b6a9a0c06caa4e3ae33b87f754d5964ef661c14a2ec79caa7783f4d965cd2c028cb2b1831432cd8ffd4cc431a21
+  metadata.gz: aa18aaefecec3e393ddf0037edf9a6fe4b6d8bbb02999a73c02d99f2f7f7ea215639ae3fe8e6f39a738f6b5fb375c471ca3dc4def689cbe352965aa1d78cf3af
+  data.tar.gz: ca554d378ea949bcf90077fe6afef62285cc8b0f429584da7cbb8349cb0130b77af0c0be0dd3c7b1e35021565bae01e7d336d1f6506ef5940467bad8edf78d40

data/README.adoc

@@ -125,6 +125,36 @@ $ gem install expressir
 ----
 
 
+== Usage
+
+=== Filtering out schemas
+
+Use the `select_proc` argument of `to_hash`.
+
+Example:
+
+[source,ruby]
+----
+
+schema_yaml = YAML.load_file('documents/iso-10303-41/schemas.yaml')
+schema_paths = schema_yaml['schemas'].map {|x,y| y['path'].gsub("../../", "")}
+
+repo = Expressir::Express::Parser.from_files(schema_paths)
+
+filtered_schemas = ["action_schema", "date_time_schema"]
+select_proc = Proc.new do |value|
+  if value.is_a?(Expressir::Model::Declarations::Schema)
+    filtered_schemas.include?(value.id)
+  else
+    true
+  end
+end
+
+repo_hash = repo.to_hash(select_proc: select_proc)
+schemas = repo_hash['schemas']
+schemas.map {|s| s["id"] }
+----
+
 == Contributing
 
 First, thank you for contributing! We love pull requests from everyone. By
@@ -148,7 +178,8 @@ Here are a few technical guidelines to follow:
 
 Expressir is distributed under the BSD 2-clause license.
 
-Expressir is built on code originally from the NIST Reeper project.
+Expressir originally contained some code from the NIST Reeper project but
+has been completely rewritten.
 
 The https://www.nist.gov/services-resources/software/reeper[NIST Reeper license]
 is reproduced below:
@@ -169,5 +200,4 @@ ____
 
 == Credits
 
-Expressir is created using the structure and examples provided by
-the NIST Reeper software on https://sourceforge.net/p/reeper/[Sourceforge].
+Copyright Ribose Inc.

data/lib/expressir/cli.rb

@@ -18,14 +18,22 @@ module Expressir
           acc << schema.id unless schema.version&.value
           acc
         end
-      rescue StandardError => e
-        # pp e
+      rescue StandardError
         nil
       end
+
+      def _print_validation_errors(type, array)
+        return if array.empty?
+
+        puts "#{'*' * 20} RESULTS: #{type.to_s.upcase.gsub('_', ' ')} #{'*' * 20}"
+        array.each do |msg|
+          puts msg
+        end
+      end
     end
 
     desc "validate *PATH", "validate EXPRESS schema located at PATH"
-    def validate(*paths)
+    def validate(*paths) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       no_version = []
       no_valid = []
 
@@ -39,30 +47,17 @@ module Expressir
           next
         end
 
-        if ret.size
-          ret.each do |schema_id|
-            no_version << "Missing version string: schema `#{schema_id}` | #{x}"
-          end
+        ret.each do |schema_id|
+          no_version << "Missing version string: schema `#{schema_id}` | #{x}"
         end
       end
 
-      if !no_valid.empty?
-        puts "#{"*" * 20} RESULTS: FAILED TO PARSE #{"*" * 20}"
-        no_valid.each do |msg|
-          puts msg
-        end
-      end
+      _print_validation_errors(:failed_to_parse, no_valid)
+      _print_validation_errors(:missing_version_string, no_version)
 
-      if !no_version.empty?
-        puts "#{"*" * 20} RESULTS: MISSING VERSION STRING #{"*" * 20}"
-        no_version.each do |msg|
-          puts msg
-        end
-      end
+      exit 1 unless [no_valid, no_version].all?(&:empty?)
 
-      if no_valid.size || no_version.size
-        exit 1
-      end
+      puts "Validation passed for all EXPRESS schemas."
     end
 
     desc "version", "Expressir Version"

data/lib/expressir/model/model_element.rb

@@ -94,8 +94,13 @@ module Expressir
       # @param [String] root_path
       # @param [Express::Formatter] formatter
       # @param [Boolean] include_empty
+      # @param [Proc] select_proc
       # @return [Hash]
-      def to_hash(root_path: nil, formatter: nil, include_empty: nil)
+      def to_hash(root_path: nil, formatter: nil, include_empty: nil, select_proc: nil)
+        # Filter out entries
+        has_filter = !select_proc.nil? && select_proc.is_a?(Proc)
+        return nil if has_filter && !select_proc.call(self)
+
         hash = {}
         hash[CLASS_KEY] = self.class.name
 
@@ -106,20 +111,32 @@ module Expressir
           # skip empty values
           next unless !empty or include_empty
 
-          hash[variable.to_s] = case value
-          when Array
-            value.map do |value|
-              if value.is_a? ModelElement
-                value.to_hash(root_path: root_path, formatter: formatter, include_empty: include_empty)
-              else
-                value
-              end
-            end
-          when ModelElement
-            value.to_hash(root_path: root_path, formatter: formatter, include_empty: include_empty)
-          else
-            value
-          end
+          value_hash = case value
+                       when Array
+                         value.map do |v|
+                           if v.is_a? ModelElement
+                             v.to_hash(
+                               root_path: root_path,
+                               formatter: formatter,
+                               include_empty: include_empty,
+                               select_proc: select_proc
+                             )
+                           else
+                             v
+                           end
+                         end.compact
+                       when ModelElement
+                         value.to_hash(
+                           root_path: root_path,
+                           formatter: formatter,
+                           include_empty: include_empty,
+                           select_proc: select_proc
+                         )
+                       else
+                         value
+                       end
+
+          hash[variable.to_s] = value_hash unless value_hash.nil?
         end
 
         if self.is_a? Declarations::Schema and file

data/lib/expressir/version.rb

@@ -1,3 +1,3 @@
 module Expressir
-  VERSION = "1.4.1".freeze
+  VERSION = "1.4.3".freeze
 end

data/spec/expressir/model/model_element_spec.rb

@@ -23,6 +23,31 @@ RSpec.describe Expressir::Model::ModelElement do
       GC.verify_compaction_references
       GC.verify_internal_consistency
     end
+
+    it "exports objects filtered by select_proc (multiple.exp)" do |example|
+      print "\n[#{example.description}] "
+      exp_file = Expressir.root_path.join("spec", "syntax", "multiple.exp")
+
+      repo = Expressir::Express::Parser.from_file(exp_file)
+
+      filtered_schemas = ["multiple_schema2", "multiple_schema3"]
+      select_proc = Proc.new do |value|
+        if value.is_a?(Expressir::Model::Declarations::Schema)
+          filtered_schemas.include?(value.id)
+        else
+          true
+        end
+      end
+
+      result = repo.to_hash(select_proc: select_proc)
+
+      expect(result["schemas"].map { |s| s["id"] }.sort).to eq(filtered_schemas)
+
+      # Validate Object Space
+      GC.start
+      GC.verify_compaction_references
+      GC.verify_internal_consistency
+    end
   end
 
   describe ".from_hash" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expressir
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.3
 platform: x86_64-linux-gnu
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor