jquery_query_builder-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee785e1ac307e057202ab3528d8c5fc3127cd981
-  data.tar.gz: 40c5c765ae70e7219a075ad646ce1a1357999999
+  metadata.gz: 21eabfc82ba1b10f2f86fc1b5a373fce3b787a25
+  data.tar.gz: 242467b72d023ec7574792f90711cc59b695f7fe
 SHA512:
-  metadata.gz: 5c4a7726931819dbd397d3a2230b713b1a32966a7bd7f43458f89216ae7dfec471ad7b3d05e5d9e01d5bbd33df32c2c82c54d0e3144fc377ccdfb2cbdee91d5e
-  data.tar.gz: ee20cd90062921090e1f6bc6e224df97c0fafcb4fcc55e5934041e5fc5129b4f9a35dc1a44fba0415e704f3e58b4aa5c16dc42e047e9481af4cdedd2c5bd1c85
+  metadata.gz: bf8fc6b0d04145a56c2c15fc0decec875f4c8b179fe1a37581b81a6d89cb56cf5326d384f19e8020acf321c2613948c3e122251ce7653eb5d182461c4207df02
+  data.tar.gz: 9647417717b125078c313f76bf58db43cd200c62ae78f5a78688335b26984b5ca1166f86ac39d20b0f60041219ee4ed10a837d30194db2cd889e18a09d62c67d

data/README.md

@@ -1,5 +1,11 @@
 # jQuery QueryBuilder - rails
 
+This gem has 2 parts.
+- [Assets needed for the jquery-query-builder plugin for the rails asset pipeline](#asset-pipeline-part)
+- [Ruby evaluator for the json rule output from jquery-query-builder](#ruby-rule-evaluator)
+
+# Asset Pipeline Part
+
 jquery_query_builer-rails wraps the [query-builder.js](http://querybuilder.js.org//) library
 and some of its dependencies in a rails engine for simple use with the asset pipeline provided by Rails 3.1 and higher.
 
@@ -51,6 +57,68 @@ After that you can use the QueryBuilder to any \<div\> you want.
 Read more here:
 [jQuery QueryBuilder](http://querybuilder.js.org//)
 
-Coming Soon:
+# Ruby Rule Evaluator
+
+You can use the evaluator to check if objects match the json rules produced by the jQuery plugin.
+
+Objects are hashes or other objects that can be accessed with hash-like bracket functionality e.g. object['test'].
+
+## Example Usage
+```ruby
+rule_json = %|{
+  "condition": "AND",
+  "rules": [{
+    "id": "Integer_Question",
+    "field": "Integer_Question",
+    "type": "integer",
+    "input": "text",
+    "operator": "equal",
+    "value": "5"
+  }]
+}|
+
+object_1 = {'Integer_Question' => 5}
+object_2 = {'Integer_Question' => 15}
+objects = [object_1, object_2]
+
+evaluator = JqueryQueryBuilder::Evaluator.new(rule_json)
+evaluator.object_matches_rules?(object_1) #=> true
+evaluator.object_matches_rules?(object_2) #=> false
+
+evaluator.get_matching_objects(objects) #=> [object_1]
+```
+
+Note: For the constructor, you can pass in a JSON string or an already parsed object.
+
+## Operators
+
+All the default operators have been implemented.
+
+If you need to extend the operators with custom ones you have, just create a class for the operator.
+The class name should be the camelized version of the underscored operator.
+
+e.g. For the operator "equals_five" the class name should be "EqualsFive".
+
+The class must have an evaluate(input, value), even if a value is not required.
+
+e.g.
+```ruby
+# config/intializers/jquery_query_builder_operators.rb
+module JqueryQueryBuilder
+  module Operators
+    class EqualsFive
+      def evaluate(input, ignored_value)
+        input == 5
+      end
+    end
+  end
+end
+```
+
+## Contributing
 
-Ruby evaluator for the json output.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/jquery_query_builder-rails.rb

@@ -1,9 +1,8 @@
 require "jquery_query_builder/rails/version"
+require "jquery_query_builder/evaluator"
 
 module JqueryQueryBuilder
   module Rails
-    class Engine < ::Rails::Engine
-      # Get rails to add app, lib, vendor to load path
-    end
+    require 'jquery_query_builder/rails/engine' if defined?(::Rails)
   end
 end

data/lib/jquery_query_builder/evaluator.rb

@@ -0,0 +1,100 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+require 'jquery_query_builder/operator'
+require 'jquery_query_builder/rule_group'
+require 'jquery_query_builder/rule'
+require 'json'
+
+module JqueryQueryBuilder
+  class Evaluator
+    attr_accessor :parsed_rule_set
+    def initialize(rule_set)
+      if rule_set.is_a? String
+        #assuming the json was passed in
+        self.parsed_rule_set = JSON.parse(rule_set)
+      else
+        self.parsed_rule_set = rule_set
+      end
+    end
+
+    def get_matching_objects(objects)
+      objects.select{|o| object_matches_rules?(o)}
+    end
+
+    def object_matches_rules?(object)
+      RuleGroup.new(parsed_rule_set).evaluate(object)
+    end
+  end
+end
+
+
+__END__
+Example rules:
+
+{
+  "condition": "AND",
+  "rules": [{
+    "id": "Decimal_Question",
+    "field": "Decimal_Question",
+    "type": "double",
+    "input": "text",
+    "operator": "equal",
+    "value": "1.2"
+  }, {
+    "condition": "AND",
+    "rules": [{
+      "id": "Date_Question",
+      "field": "Date_Question",
+      "type": "date",
+      "input": "text",
+      "operator": "greater",
+      "value": "2016-07-19"
+    }, {
+      "id": "Yes_No_Question",
+      "field": "Yes_No_Question",
+      "type": "boolean",
+      "input": "select",
+      "operator": "equal",
+      "value": "true"
+    }]
+  }, {
+    "condition": "OR",
+    "rules": [{
+      "id": "Select_Question",
+      "field": "Select_Question",
+      "type": "string",
+      "input": "select",
+      "operator": "equal",
+      "value": "First Option"
+    }, {
+      "id": "Password_Question",
+      "field": "Password_Question",
+      "type": "string",
+      "input": "text",
+      "operator": "equal",
+      "value": "asd"
+    }]
+  }, {
+    "id": "Subform.Free_Text_Question",
+    "field": "Subform.Free_Text_Question",
+    "type": "string",
+    "input": "text",
+    "operator": "is_not_empty",
+    "value": null
+  }]
+}
+
+------------
+
+{
+  "condition": "AND",
+  "rules": [{
+    "id": "Integer_Question",
+    "field": "Integer_Question",
+    "type": "integer",
+    "input": "text",
+    "operator": "equal",
+    "value": "5"
+  }]
+}

data/lib/jquery_query_builder/operator.rb

@@ -0,0 +1,48 @@
+#require all the operators
+Dir[File.join(File.dirname(__FILE__) + '/operators', "**/*.rb")].each do |f|
+  require f
+end
+
+module JqueryQueryBuilder
+  class Operator
+    SPECIAL_CASE_MAP = {
+    }
+
+    def self.get_operator_class(operator)
+      operator_class = SPECIAL_CASE_MAP[operator] || operator.camelize
+
+      begin
+        operator_class = "#{operator_module}::#{operator_class}".constantize
+      rescue NameError
+        raise "Unknown operator #{operator} used."
+      end
+    end
+
+    def self.operator_module
+      "JqueryQueryBuilder::Operators"
+    end
+  end
+end
+
+__END__
+
+equal
+not_equal
+in
+not_in
+less
+less_or_equal
+greater
+greater_or_equal
+between
+not_between
+begins_with
+not_begins_with
+contains
+not_contains
+ends_with
+not_ends_with
+is_empty
+is_not_empty
+is_null
+is_not_null

data/lib/jquery_query_builder/operators/begins_with.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class BeginsWith
+      def evaluate(left, right)
+        left.start_with?(right)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/between.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class Between
+      def evaluate(input, bounds)
+        input > bounds[0] && input < bounds[1]
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/contains.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class Contains
+      def evaluate(left, right)
+        left.include?(right)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/ends_with.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class EndsWith
+      def evaluate(left, right)
+        left.end_with?(right)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/equal.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class Equal
+      def evaluate(left, right)
+        left == right
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/greater.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class Greater
+      def evaluate(left, right)
+        left > right
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/greater_or_equal.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class GreaterOrEqual
+      def evaluate(left, right)
+        left >= right
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/in.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class In
+      def evaluate(left, right)
+        right.include?(left)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/is_empty.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class IsEmpty
+      def evaluate(input, value)
+        input.blank?
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/is_not_empty.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class IsNotEmpty
+      def evaluate(input, value)
+        input.present?
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/is_not_null.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class IsNotNull
+      def evaluate(input, value)
+        !input.nil?
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/is_null.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class IsNull
+      def evaluate(input, value)
+        input.nil?
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/less.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class Less
+      def evaluate(left, right)
+        left < right
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/less_or_equal.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class LessOrEqual
+      def evaluate(left, right)
+        left <= right
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/not_begins_with.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class NotBeginsWith
+      def evaluate(left, right)
+        !left.start_with?(right)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/not_between.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class NotBetween
+      def evaluate(input, bounds)
+        input <= bounds[0] || input >= bounds[1]
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/not_contains.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class NotContains
+      def evaluate(left, right)
+        !left.include?(right)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/not_ends_with.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class NotEndsWith
+      def evaluate(left, right)
+        !left.end_with?(right)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/not_equal.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class NotEqual
+      def evaluate(left, right)
+        left != right
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/operators/not_in.rb

@@ -0,0 +1,9 @@
+module JqueryQueryBuilder
+  module Operators
+    class NotIn
+      def evaluate(left, right)
+        !right.include?(left)
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/rails/engine.rb

@@ -0,0 +1,7 @@
+module JqueryQueryBuilder
+  module Rails
+    class Engine < ::Rails::Engine
+      # Get rails to add app, lib, vendor to load path
+    end
+  end
+end

data/lib/jquery_query_builder/rails/version.rb

@@ -1,5 +1,5 @@
 module JqueryQueryBuilder
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/jquery_query_builder/rule.rb

@@ -0,0 +1,64 @@
+module JqueryQueryBuilder
+  class Rule
+    attr_accessor :id, :field, :type, :input, :operator, :value
+    def initialize(rule_hash)
+      self.id = rule_hash['id']
+      self.field = rule_hash['field']
+      self.type = rule_hash['type']
+      self.input = rule_hash['input']
+      self.operator = rule_hash['operator']
+      self.value = rule_hash['value']
+    end
+
+    def evaluate(object)
+      get_operator.evaluate(get_input(object), get_value)
+    end
+
+    def get_operator
+      JqueryQueryBuilder::Operator.get_operator_class(operator).new
+    end
+
+    def get_input(object)
+      fields = field.split('.')
+      result = object
+      fields.each do |field|
+        result = object[field]
+        break if result.nil?
+      end
+      if result.is_a? Array
+        result.map{|v| typecast_value(v)}
+      else
+        typecast_value(result)
+      end
+    end
+
+    def get_value
+      if value.is_a? Array
+        value.map{|v| typecast_value(v)}
+      else
+        typecast_value(value)
+      end
+    end
+
+    def typecast_value(value_to_cast)
+      case type
+        when 'string'
+          value_to_cast.to_s
+        when 'integer'
+          value_to_cast.to_i
+        when 'double'
+          value_to_cast.to_f
+        when 'date'
+          value_to_cast.is_a?(String) ? Date.parse(value_to_cast) : value_to_cast
+        when 'time'
+          value_to_cast.is_a?(String) ? Time.parse(value_to_cast) : value_to_cast
+        when 'datetime'
+          value_to_cast.is_a?(String) ? DateTime.parse(value_to_cast) : value_to_cast
+        when 'boolean'
+          value_to_cast == 'Yes' || value_to_cast == 'yes' || value_to_cast == 'True' || value_to_cast == 'true' || value_to_cast == true
+        else
+          value_to_cast
+      end
+    end
+  end
+end

data/lib/jquery_query_builder/rule_group.rb

@@ -0,0 +1,26 @@
+module JqueryQueryBuilder
+  class RuleGroup
+    attr_accessor :condition, :rules
+    def initialize(rule_group_hash)
+      self.condition = rule_group_hash['condition']
+      self.rules = rule_group_hash['rules']
+    end
+
+    def evaluate(object)
+      case condition
+      when "AND"
+        rules.all?{|rule| get_rule_object(rule).evaluate(object) }
+      when "OR"
+        rules.any?{|rule| get_rule_object(rule).evaluate(object) }
+      end
+    end
+
+    def get_rule_object(rule)
+      if rule['rules'].present?
+        RuleGroup.new(rule)
+      else
+        Rule.new(rule)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jquery_query_builder-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Hirst
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: 
 email:
 - hirst.mat@gmail.com
@@ -91,7 +133,32 @@ files:
 - LICENSE.txt
 - README.md
 - lib/jquery_query_builder-rails.rb
+- lib/jquery_query_builder/evaluator.rb
+- lib/jquery_query_builder/operator.rb
+- lib/jquery_query_builder/operators/begins_with.rb
+- lib/jquery_query_builder/operators/between.rb
+- lib/jquery_query_builder/operators/contains.rb
+- lib/jquery_query_builder/operators/ends_with.rb
+- lib/jquery_query_builder/operators/equal.rb
+- lib/jquery_query_builder/operators/greater.rb
+- lib/jquery_query_builder/operators/greater_or_equal.rb
+- lib/jquery_query_builder/operators/in.rb
+- lib/jquery_query_builder/operators/is_empty.rb
+- lib/jquery_query_builder/operators/is_not_empty.rb
+- lib/jquery_query_builder/operators/is_not_null.rb
+- lib/jquery_query_builder/operators/is_null.rb
+- lib/jquery_query_builder/operators/less.rb
+- lib/jquery_query_builder/operators/less_or_equal.rb
+- lib/jquery_query_builder/operators/not_begins_with.rb
+- lib/jquery_query_builder/operators/not_between.rb
+- lib/jquery_query_builder/operators/not_contains.rb
+- lib/jquery_query_builder/operators/not_ends_with.rb
+- lib/jquery_query_builder/operators/not_equal.rb
+- lib/jquery_query_builder/operators/not_in.rb
+- lib/jquery_query_builder/rails/engine.rb
 - lib/jquery_query_builder/rails/version.rb
+- lib/jquery_query_builder/rule.rb
+- lib/jquery_query_builder/rule_group.rb
 - vendor/assets/javascripts/doT.js
 - vendor/assets/javascripts/jquery.extendext.js
 - vendor/assets/javascripts/query-builder.js
@@ -120,6 +187,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: The jQuery Query Builder JavaScript library + Dependencies ready for the
-  Rails Asset Pipeline.
+summary: The jQuery Query Builder Rule Evaluator and JavaScript library + Dependencies
+  ready for the Rails Asset Pipeline.
 test_files: []