nodepile 0.1.1 → 0.1.2

data/lib/nodepile/rule_eval.rb

@@ -0,0 +1,155 @@
+
+module Nodepile
+
+# Represents a single rule record as represernted by a KeyedArrayAccessor object.
+# Note that this class does not rely on metadata of the KeyedArrayAccessor and doesn't
+# even verify that the object it represents actually contains any formulas.
+#
+# Generally speaking, any field whose first character is a question mark is considered
+# to have a calculation/formula in it.  Formulas (not counting the question mark) are simply
+# ruby expressions.  The formulas in the id fields ('_id', '_links_to', and '_links_from')
+# are given special treatment as described below.
+#
+# Dynamic calculations must start with the question mark character '?'.  They
+# will use the Ruby language itself with a tightly constrained binding that
+# defines one primary object simply named "v" (standing for values).  That object
+# only supports a handful of operations including:
+#      v['fielaname']  to evaluate a field
+#      v.include?('fieldname')  to determine whether the field exists
+#      v[:this] to evaluate this field without having to explicitly name it
+# of fields.  Note that blank "fields" will often return nil and also non-existent
+# fields will be nil.
+#
+# Note, that some exceptional calculation rules may be triggered if this
+# calculation is for an id field.  See the #uses_id_calcs?() method.
+class RuleRecordEvaluator
+    EDGE_ID_FIELDS = ['_links_from','_links_to'].freeze
+    NODE_ID_FIELDS = ['_id'].freeze
+    ID_FIELD_NAMES = (NODE_ID_FIELDS + EDGE_ID_FIELDS).freeze
+    
+    # @param rule_record_kaa [KeyedArrayAccessor] This ia a rule record that
+    #           contains one or more formulas in its fields as indicated
+    #           by a leading question mark in either _id, _links_from, or _links_to
+    def initialize(rule_record_kaa)
+        @kaa = rule_record_kaa
+        @match_fields = @kaa['_id'].nil? ? EDGE_ID_FIELDS : NODE_ID_FIELDS  # assuming it's well formed
+        @match_type = nil
+    end
+    
+    # Confirm that this particular rule applies to the given node or edge
+    # @param otr [KeyedArrayAccessor] confirms that 
+    # @return [Boolean] true if the identifying fields match. For node entities
+    #             the '_id' field is the key.  For edges, the '_links_from'
+    #             and '_links_to' fields are the identifying fields.
+    def match_record?(otr)
+        return @match_fields.all?{|key|
+                myval = @kaa[key]
+                if myval.start_with?('?')
+                    self.class.eval_calc(myval,key,otr) 
+                else
+                    myval == otr[key]
+                end
+               }
+    end
+    
+    # Returns true if the calculation used by #match_record?() uses complex
+    # calculation logic 
+    def uses_dynamic_match?
+        @match_type ||= @match_fields.any?{|k|
+                                           @kaa[k].then{|v| v.start_with?('?') && v.include?('v[')}
+                                          } ? :dynamic : :static
+        return @match_type == :dynamic
+    end
+    
+    # Calculates the "value" of the rule when applied to a specific record
+    # NOTE: this does not test for #match_record?() which you probably want
+    # to do first. Note that the three id fields are ALWAYS left as nil after this
+    # method.  Calculated values will be coerced to string via #to_s  so if the
+    # default behavior isn't the right one for you, you should convert to string yourself
+    # This also doesn't test whether the records conform.
+    #
+    # @param otr [KeyedArrayAccessor] Rules must be calculated against a given
+    #              record
+    # @return [KeyedArrayAccessor] Calculates an appropriate overlay from the rule
+    def calculate_rule(otr)
+        kaa = @kaa.dup
+        kaa.kv_map!{|k,v|   
+            if v.nil?
+                #no-op
+            elsif ID_FIELD_NAMES.include?(k)
+                nil  # we never overlay key fields
+            elsif v.start_with?('?')
+                self.class.eval_calc(v,k,otr)&.to_s 
+            else
+                v # leave field unaltered by calculation logic
+            end
+           }
+        return kaa
+    end
+    
+    # Evaluate a calculation using standard logic.  Formulas may use syntax to
+    # reference the values of the eval_against_key_value_map object.  For example
+    # "?v['column X'].to_f > 17.2 ? 'red' : 'black'"     calcs based on 'column X' contents 
+    def self.eval_calc(rule_field_defn,this_field_name,eval_against_key_value_map)
+        return rule_field_defn unless rule_field_defn.start_with?('?')
+        begin
+            ruby_code = rule_field_defn.dup.tap{|s| s[0] = ' '} # get rid of leading question mark
+            val = EvalFrame.evaluate(ruby_code,this_field_name,eval_against_key_value_map)
+        rescue StandardError => e
+            #TODO: Probably will need to remove this and replace with more fault
+            # tolerant strategy that fails gracefully (perhaps by nil-valuing the field)
+            raise "Error attempting to evaluate this formula { #{rule_field_defn} } : #{e.message}"
+        end
+        case val
+            when true,false,nil
+                #no-op
+            when Regexp
+                if /^?\s*\//.match?(rule_field_defn) && ID_FIELD_NAMES.include?(this_field_name)
+                    val = val.match?(eval_against_key_value_map[this_field_name])
+                else
+                    raise "Rule should evaluate to a 'boolean' except when triggering Regex/glob matching on an id field."
+                end
+            when String
+                if /^?\s*['"]/.match?(rule_field_defn) && ID_FIELD_NAMES.include?(this_field_name)
+                    val = File.fnmatch?(val,eval_against_key_value_map[this_field_name])
+                else
+                    #no-op... returning a string is a good behavior for calculations
+                end
+            else
+                raise "For field [#{this_field_name}] the rule expression must evaluate to true, false, or nil except when triggering regex/glob matching on an id field."
+        end #case
+        return val
+    end
+
+    private
+
+    # Utility class
+    class HashMask
+        def initialize(hashlike,this_key) 
+            @h = hashlike
+            @tk = this_key
+        end
+        
+        def include?(k) = @h.include?(k)
+        def [](k)
+            raise "Unable to use v[:this] because :this was not set" if k == :this && @tk.nil?
+            @h[k == :this ? @tk : k]
+        end
+    end #class HashMask
+    
+    # Utility class
+    class EvalFrame
+        def initialize(test_hashlike) = @__hm = test_hashlike
+        def v = @__hm
+            
+        def self.evaluate(defn,this_fieldname,test_hashlike)
+            frame = new(HashMask.new(test_hashlike,this_fieldname)) #restrict access as tightly as reasonable
+            frame.instance_eval(defn) # return the result
+        end
+    end #class EvalFrame
+    
+        
+    
+end #class RuleRecordEvaluator
+
+end # module Nodepile

data/lib/nodepile/version.rb

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

data/nodepile.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "lib/nodepile/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "nodepile"
+  spec.version = Nodepile::VERSION
+  spec.authors = ["David Foster"]
+  spec.email = ["david.t.foster.01@gmail.com"]
+
+  spec.summary = "Translate flat text file data into connected graph specs suitable for graphviz.  NOT WORKING CODE."
+  spec.description = "NOT WORKING CODE. Designed to make it easy to take a spreadsheet or other tabular data and use it to generate, manipulate, and style connected graphs.  Can be used from the command line or as an object model.  This gem does not itself perform any rendering, although it contains facilities to drive the Graphviz familly of open source tools to generate images (e.g. gif, jpg, svm)."
+  spec.required_ruby_version = ">= 3.2.2"
+  spec.homepage = "https://rubygems.org/gems/nodepile"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/fosterd42/nodepile.git"
+  spec.license = "MIT"
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) } 
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'ruby-graphviz', "~> 1.2.5"
+  
+  # DEVELOPMENT DEPENDENCIES BELOW
+  spec.add_development_dependency "rake" , ">= 13.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency 'rspec-debug', ">= 0.2.0"
+  spec.add_development_dependency "rubocop", ">= 1.21"
+  
+  spec.add_development_dependency 'codecov','>= 0.6.0'
+  spec.add_development_dependency 'dotenv','>= 2.8.1'
+  spec.add_development_dependency 'simplecov', '>= 0.15', '< 0.22'
+  spec.add_development_dependency 'yard', '>= 0.9.34'
+  spec.add_development_dependency 'webrick', ">= 1.3.1"
+  
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/tmp/.gitignore

@@ -0,0 +1 @@
+*

metadata

@@ -1,62 +1,166 @@
 --- !ruby/object:Gem::Specification
 name: nodepile
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Foster
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.21'
-description: Designed to make it easy to take a spreadsheet or other tabular data
-  and use it to generate, manipulate, and style connected graphs.  Can be used from
-  the command line or as an object model.  This gem does not itself perform any rendering,
-  although it contains facilities to drive the Graphviz familly of open source tools
-  to generate images (e.g. gif, jpg, svm).
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: NOT WORKING CODE. Designed to make it easy to take a spreadsheet or other
+  tabular data and use it to generate, manipulate, and style connected graphs.  Can
+  be used from the command line or as an object model.  This gem does not itself perform
+  any rendering, although it contains facilities to drive the Graphviz familly of
+  open source tools to generate images (e.g. gif, jpg, svm).
 email:
 - david.t.foster.01@gmail.com
 executables: []
@@ -65,20 +169,32 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- BACKLOG.md
 - CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - lib/nodepile.rb
+- lib/nodepile/base_structs.rb
+- lib/nodepile/colspecs.rb
+- lib/nodepile/gross_actions.rb
+- lib/nodepile/gviz.rb
+- lib/nodepile/keyed_array.rb
+- lib/nodepile/pile_organizer.rb
+- lib/nodepile/pragmas.rb
+- lib/nodepile/rec_source.rb
+- lib/nodepile/rule_eval.rb
 - lib/nodepile/version.rb
+- nodepile.gemspec
 - sig/nodepile.rbs
+- tmp/.gitignore
 homepage: https://rubygems.org/gems/nodepile
 licenses:
 - MIT
 metadata:
   homepage_uri: https://rubygems.org/gems/nodepile
   source_code_uri: https://gitlab.com/fosterd42/nodepile.git
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -86,15 +202,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
-summary: Translate flat text file data into connected graph specs suitable for graphviz.
+summary: Translate flat text file data into connected graph specs suitable for graphviz.  NOT
+  WORKING CODE.
 test_files: []