expressir 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c715677941cba222f7a4021ab2e392272e39646afb83c739350a845e0d7f0918
-  data.tar.gz: eb8de33aa98749b1518305b4b34c0f49a685829739ddc79f784b0b2d4d4a68a8
+  metadata.gz: 434661a5d98c3059709affda882949399b24868d326954e14f42b9f6a7c78d54
+  data.tar.gz: ef74b7fe719b2127f3db44993fd3c4e52d4d234f5748d2f8b2955c6bb94408b4
 SHA512:
-  metadata.gz: '0349a84ac72ce995d67070fd27a9f2b543ca0b4f6e10ae5e4f47606287575261b3e76540b55b3517a6273882b6b1a2f94ee2771a9382e7e49c3b584b0cd56146'
-  data.tar.gz: 592ec3ace51fd074f297fd8381ccf9fb0fbaf1d0fa6dfbf7327c28778ef92b07222ae70b93b8ca2e64504815ebdb06d66cf68e32c656b8c5611bb471aa81d9bb
+  metadata.gz: 328680ef39bc8f759967acede480c8527b9f8d026f8814d9edd4ead7501466190c9bed79d76273cb2416e9d94a8385817b9c38f0e007533de97ef9da7c081cb9
+  data.tar.gz: c80adcc20661c47560731b8340eabd97a624f0babecacc9490bcb42ccb4ec480f3f5994f184c97871eed4f10e658da1f518b14a6662955d2006daf208706a69f

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

@@ -11,6 +11,54 @@ module Expressir
       end
     end
 
+    no_commands do
+      def _validate_schema(path)
+        repository = Expressir::Express::Parser.from_file(path)
+        repository.schemas.inject([]) do |acc, schema|
+          acc << schema.id unless schema.version&.value
+          acc
+        end
+      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) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      no_version = no_valid = []
+
+      paths.each do |path|
+        x = Pathname.new(path).realpath.relative_path_from(Dir.pwd)
+        puts "Validating #{x}"
+        ret = _validate_schema(path)
+
+        if ret.nil?
+          no_valid << "Failed to parse: #{x}"
+          next
+        end
+
+        ret.each do |schema_id|
+          no_version << "Missing version string: schema `#{schema_id}` | #{x}"
+        end
+      end
+
+      _print_validation_errors(:failed_to_parse, no_valid)
+      _print_validation_errors(:missing_version_string, no_version)
+
+      exit 1 unless [no_valid, no_version].all?(&:empty?)
+
+      puts "Validation passed for all EXPRESS schemas."
+    end
+
     desc "version", "Expressir Version"
     def version
       say(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.0".freeze
+  VERSION = "1.4.2".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.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
@@ -742,7 +742,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: ISO EXPRESS parser and tools in Ruby.