predicator 0.3.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6f75523bd14777d85c7d52472823bad7eafa31f
-  data.tar.gz: cbf63f511abaccbac93ed564256d5d0caea7da87
+SHA256:
+  metadata.gz: d3d6163b7499f9afc436a5b7f11ac3b38e128f6e2f8eb6a37fc6fe6521080e1d
+  data.tar.gz: b2647db6156463d1d06317a3cd82305cd2cf29a464484017e920e653d9db7dcc
 SHA512:
-  metadata.gz: 7c0c9e0fa3737b4c6f1ec27a20254197fbe0a52825f37cb2978c02c829473d3fd3777f5e5937cb08c754783acc0c1a9188f8e31054a4ab4eb1dfab325873c68a
-  data.tar.gz: af32c18e7d32ccf7047f02d7bafaa71fbb7d3fa0b7383d47f78854440fdb1ef45884d832f37e1ff364ca19a5ff90783fe6715b4e33c9b7e247ff6cb169a80444
+  metadata.gz: e4233d02d68f77beec56049b8ab6bb13c93b114b003d57a903b945f29f9caace9dd9e835b0e9bf7baf9a60dd581b8aceadc2b3f3151e49539d1fbce6ebc8c7d9
+  data.tar.gz: a93c002f76da05a95d1d426a8a94db8107b59627217ccf2a4d559a381c941b6d7ea7c1a1ede8e5063aa3c8d2d52b4ce3d8397e77e014dc4b7aeb4626a8f6905f

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /test/reports/
 /tmp/
+.ruby-gemset
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisabledByDefault: true
+  Exclude:
+    - "lib/predicator/parser.rb" #generated file
+    - "lib/predicator/lexer.rex.rb" #generated file
+
+Bundler/DuplicatedGem:
+  Enabled: true
+Lint:
+  Enabled: true
+Performance:
+  Enabled: true
+Security:
+  Enabled: true
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Seattle style
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+# Allow regex argument in Seattle style
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+# Allow block argument in Seattle style
+Lint/AmbiguousOperator:
+  Enabled: false
+
+# No long classes
+Style/ClassLength:
+  Enabled: true
+  Exclude:
+    - "test/**/*.rb"
+    - "lib/predicator/visitors/instructions.rb"
+    - "lib/predicator/evaluator.rb"
+
+Lint/HandleExceptions:
+  Exclude:
+    - lib/tasks/**/*.rake

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
-before_install: gem install bundler
+  - 2.0
+  - 2.1
+  - 2.2

data/HISTORY.md

@@ -1,3 +1,34 @@
+### 1.2.1 / 2020-08-04
+
+* Moves project to riddler/predicator
+
+### 1.2.0 / 2018-09-13
+
+* Adds type casting to comparisons
+* Adds date type and predicates
+* Adds "from now" and "ago" relative dates
+* Adds "present" and "blank" predicates
+* Adds "starts with" and "ends with" string comparisons
+
+### 1.1.0 / 2017-12-06
+
+* Rescues errors when comparing invalid types
+
+### 1.0.0 / 2017-09-22
+
+* Adds new lexer
+* Introduces the stack machine and instructions
+* Adds LessThan predicate
+* Adds Between predicate
+* Adds In and Not In predicates (with arrays)
+* Adds BooleanVariable predicate
+
+### 0.4.0 / 2016-06-09
+
+* Adds double dispatch for relation predicates
+* Adds method predicate (.blank? and .present?)
+* Adds Context#eval
+
 ### 0.3.0 / 2016-03-11
 
 * Adds more relation predicates (GT, LT, GTE, LTE, NEQ)

data/README.md

@@ -1,25 +1,47 @@
 [![Gem Version](https://badge.fury.io/rb/predicator.svg)](http://badge.fury.io/rb/predicator)
-[![Build Status](https://travis-ci.org/johnnyt/predicator.svg?branch=master)](https://travis-ci.org/johnnyt/predicator)
-[![Dependency Status](https://img.shields.io/gemnasium/johnnyt/predicator.svg)](https://gemnasium.com/johnnyt/predicator)
-[![Coverage Status](https://coveralls.io/repos/github/johnnyt/predicator/badge.svg?branch=master)](https://coveralls.io/github/johnnyt/predicator?branch=master)
+[![Build Status](https://travis-ci.org/predicator/predicator.svg?branch=master)](https://travis-ci.org/predicator/predicator)
+[![Coverage Status](https://coveralls.io/repos/github/predicator/predicator/badge.svg?branch=master)](https://coveralls.io/github/predicator/predicator?branch=master)
 
 # Predicator
 
-Predicator is a predicate engine
+Predicator is a safe (does not eval code), admin or business user facing predicate engine. It turns a string predicate like `"score > 600 or (score > 580 and monthly_income > 9000)"` along with a supplied context into a `true` or `false`. This predicate can be stored as an attribute of a model (ex: an Offer model could store a predicate indicating if it is available to a customer).
 
 ## Usage
 
-Example usage:
+Simple usage:
 
 ```ruby
 require "predicator"
 
-pred = Predicator.parse "a.b = 5"
+Predicator.evaluate "score > 600 or (score > 580 and income > 9000)", score: 590 # false
 
-context = Predicator::Context.new
-context[:a] = {b:5}
+Predicator.evaluate "score > 600 or (score > 580 and income > 9000)", score: 590, income: 9500 # true
+```
+
+Example usage with a model:
 
-pred.satisfied? context
+```ruby
+class Customer
+  ...
+  def to_hash
+    {
+      ...
+      score: score,
+      income: income,
+      ...
+    }
+  end
+end
+
+class Offer
+  attr_accessor :available_predicate
+  
+  ...
+  
+  def available_to? customer
+    Predicator.evaluate available_predicate, customer.to_hash
+  end
+end
 ```
 
 ## Installation
@@ -41,14 +63,13 @@ Or install it yourself as:
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Then, run `rake test` (or just `rake`) to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/johnnyt/predicator.
+Bug reports and pull requests are welcome on GitHub at https://github.com/predicator/predicator.
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 

data/Rakefile

@@ -1,15 +1,24 @@
+require "rubygems"
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "oedipus_lex"
+
+Rake.application.rake_require "oedipus_lex"
 
 Rake::TestTask.new :test do |t|
   t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
 end
 
-task :default => :test
+desc "Generate the lexer"
+task lexer: "lib/predicator/lexer.rex.rb"
 
 desc "Compile and generate the parser"
-task :compile do
-  sh "racc lib/predicator/parser.y -o lib/predicator/generated_parser.rb"
+task parser: :lexer do
+  sh "racc -l -o lib/predicator/parser.rb lib/predicator/parser.y"
 end
+
+task test: :parser
+
+task default: :test

data/lib/predicator.rb

@@ -1,10 +1,24 @@
 require "predicator/context"
-require "predicator/lexer"
+require "predicator/evaluator"
 require "predicator/parser"
-require "predicator/version"
 
 module Predicator
-  def self.parse string
-    Predicator::Parser.new.parse string
+  def self.parse source
+    Predicator::Parser.new.parse source
+  end
+
+  def self.compile source
+    ast = parse source
+    ast.to_instructions
+  end
+
+  def self.evaluate source, context={}
+    instructions = compile source
+    evaluate_instructions instructions, context
+  end
+
+  def self.evaluate_instructions instructions, context={}
+    evaluator = Evaluator.new instructions, context
+    evaluator.result
   end
 end

data/lib/predicator/ast.rb

@@ -0,0 +1,190 @@
+module Predicator
+  module AST
+    class Node
+      include Enumerable
+
+      attr_accessor :left
+
+      def initialize left
+        @left = left
+      end
+
+      def each &block
+        Visitors::Each.new(block).accept self
+      end
+
+      def to_dot
+        Visitors::Dot.new.accept self
+      end
+
+      def to_instructions
+        Visitors::Instructions.new.accept self
+      end
+
+      def to_s
+        Visitors::String.new.accept self
+      end
+
+      def type
+        raise NotImplementedError
+      end
+
+      def variable?; false; end
+      def literal?; false; end
+    end
+
+    class Terminal < Node
+      alias :symbol :left
+    end
+
+    class Literal < Terminal
+      def type; :LITERAL; end
+      def literal?; true; end
+    end
+
+    class Variable < Terminal
+      def type; :VARIABLE; end
+      def variable?; true; end
+    end
+
+    %w[ True False Integer String Date Duration Blank Present ].each do |t|
+      class_eval <<-eoruby, __FILE__, __LINE__ + 1
+        class #{t} < Literal;
+          def type; :#{t.upcase}; end
+        end
+      eoruby
+    end
+
+    class Unary < Node
+      def children; [left] end
+    end
+
+    class IntegerArray < Unary
+      def type; :INTARRAY; end
+    end
+
+    class StringArray < Unary
+      def type; :STRARRAY; end
+    end
+
+    class Not < Unary
+      def type; :NOT; end
+    end
+
+    class Group < Unary
+      def type; :GROUP; end
+    end
+
+    class DateFromNow < Unary
+      def type; :DATEFROMNOW; end
+    end
+
+    class DateAgo < Unary
+      def type; :DATEAGO; end
+    end
+
+    class Binary < Node
+      attr_accessor :right
+
+      def initialize left, right
+        super left
+        @right = right
+      end
+
+      def children; [left, right] end
+    end
+
+    class IntegerEqual < Binary
+      def type; :INTEQ; end
+    end
+
+    class StringEqual < Binary
+      def type; :STREQ; end
+    end
+
+    class DateEqual < Binary
+      def type; :DATEQ; end
+    end
+
+    class IntegerGreaterThan < Binary
+      def type; :INTGT; end
+    end
+
+    class StringGreaterThan < Binary
+      def type; :STRGT; end
+    end
+
+    class DateGreaterThan < Binary
+      def type; :DATGT; end
+    end
+
+    class IntegerLessThan < Binary
+      def type; :INTLT; end
+    end
+
+    class StringLessThan < Binary
+      def type; :STRLT; end
+    end
+
+    class DateLessThan < Binary
+      def type; :DATLT; end
+    end
+
+    class IntegerIn < Binary
+      def type; :INTIN; end
+    end
+
+    class StringIn < Binary
+      def type; :STRIN; end
+    end
+
+    class IntegerNotIn < Binary
+      def type; :INTNOTIN; end
+    end
+
+    class StringNotIn < Binary
+      def type; :STRNOTIN; end
+    end
+
+    class StringStartsWith < Binary
+      def type; :STRSTARTSWITH; end
+    end
+
+    class StringEndsWith < Binary
+      def type; :STRENDSWITH; end
+    end
+
+    class And < Binary
+      def type; :AND; end
+    end
+
+    class Or < Binary
+      def type; :OR; end
+    end
+
+    class Ternary < Node
+      attr_accessor :middle, :right
+
+      def initialize left, middle, right
+        super left
+        @middle = middle
+        @right = right
+      end
+
+      def children; [left, middle, right] end
+    end
+
+    class IntegerBetween < Ternary
+      def type; :INTBETWEEN; end
+    end
+
+    class DateBetween < Ternary
+      def type; :DATBETWEEN; end
+    end
+
+    class BooleanVariable < Unary
+      def type; :BOOL; end
+    end
+
+  end
+end

data/lib/predicator/context.rb

@@ -1,23 +1,18 @@
-require "ostruct"
-
 module Predicator
   class Context
-    attr_reader :bindings
-
-    def initialize
+    def initialize params={}
       @bindings = {}
+      params.each{ |key,value| bind key, value }
     end
 
     def bind name, value
-      value = OpenStruct.new(value) if value.kind_of? Hash
-      bindings[name.to_s] = value
+      @bindings[name.to_s] = value
     end
+    alias :[]= :bind
 
-    def value_for input
-      return input unless input.kind_of? Predicator::Variable
-
-      input.value_in self
+    def binding_for name
+      @bindings[name.to_s]
     end
-    alias :[] :value_for
+    alias :[] :binding_for
   end
 end