criteria_operator 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d6ba55f042935bb7b916c270c415c863d305565
-  data.tar.gz: 51e3ace7e81abdddc0f52bfc816d33364d946c26
+  metadata.gz: 1eaabc0ba95046a9d84d5b3232829539f29ce3e6
+  data.tar.gz: c63f6abba970c73c9c61bcd1b912f39f33e3f0fa
 SHA512:
-  metadata.gz: 2f2eed740d9047e1ee324e5261c75f84ed38f37bc3c655a975c611573ad8e8dd2077ccb9322c0d1d1fcdb634fa2ee3f585be988957b111d6f92b4320dceb2228
-  data.tar.gz: 1f49583c147795674709284e630f86428de1a265d07fa4bfefc72cbd842095c3e9f91f9cd387527bf7c31464db26dacc86fcb2fe18249e9f5173e8a05900507d
+  metadata.gz: de96f70089d90c409bc411eabcac52d1f239955fff519125013efd6f483ed27721d08a75f6eb181a3d534a1a74c1b06d24103081d917085eed514559f10a2e29
+  data.tar.gz: 6c40216bfe50a557a4e1e736079ad92690b4a23ed9c1cbe6c6fc44a92db9e3abfe3e3ae42cb7f076b81f59322e9e9d9f72bce241c89287aee5c288850577e10e

data/README.md

@@ -10,7 +10,7 @@
 
 # CriteriaOperator
 
-This gem provides classes to create arbitrary complex conditions, by building an expression tree. ...
+This gem provides classes to create arbitrary complex conditions, by building an expression tree. Currently only basic operations are implemented.
 
 ## Installation
 
@@ -30,7 +30,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+For complete usage information, [read the docs](http://www.rubydoc.info/github/TheFlow0360/criteria_operator/master/frames)!
+
+All relevant classes inherit from `BaseOperator`. Generally, you'll want to have a root node of this type, which will in turn contain the whole expression tree. Currently, there are the following operators:
+
+### BinaryOperator
+
+The `BinaryOperator` is the most commonly used. It represents a binary operation, meaning an operator with a left and right hand side operand, each. The operands can be any `BaseOperator`. The operator has to be one of the following types:
+ - Equal *(default)*
+ - Not Equal
+ - Greater
+ - Greater or Equal
+ - Less
+ - Less or Equal
+ 
+ These types are represented by constants in the module `BinaryOperatorType`.
+ 
+ Usage example:
+ 
+     # checks if the operands op1 and op2 are different
+     operator = CriteriaOperator::BinaryOperator.new op1, op2, CriteriaOperator::BinaryOperatorType::NOT_EQUAL
+
+
+### GroupOperator
+
+The `GroupOperator` is used to connect an amount of conditions (`BaseOperator`s) with either `AND` *(default)* or `OR` (see `GroupOperatorType`).
+
+Usage example:
+
+    # checks if any of the conditions represented by operands op1 through op3 is true
+    operator = CriteriaOperator::GroupOperator.new [op1, op2, op3], CriteriaOperator::GroupOperatorType::OR
+
+
+### UnaryOperator
+
+The `UnaryOperator` is used to perform simple checks or transform a value represented by an operand (`BaseOperator`). It takes on operand as well and has one of the following types:
+ - NOT *(default)*
+ - IS NULL
+ - Plus
+ - Minus
+
+These types can be found in the `UnaryOperatorType` module.
+
+Usage example:
+
+    # invert the sign of the result returned by operand op1
+    operator = CriteriaOperator::UnaryOperator.new op1, CriteriaOperator::UnaryOperatorType::MINUS
+
+
+### OperandProperty
+
+The `OperandProperty` is, as the name implies, an operand. This means, it does not work with any other operands like operators do. If presented as a tree, operands always are leaves. The `OperandProperty` describes a property through it's name.
+
+Usage example:
+
+    # represents a column named 'integer_value' (without quotes)
+    operand = CriteriaOperator::OperandProperty.new 'integer_value'
+
+
+### OperandValue
+
+The `OperandValue` is, just like the `OperandProperty`, an operand. It represents any kind of value.
+
+Usage example:
+
+    # represents the numeric value forty-two
+    operand = CriteriaOperator::OperandValue.new 42
 
 ## Development
 
@@ -42,6 +107,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/TheFlow0360/criteria_operator. 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.
 
+Prerequisite to the acceptance of any pull requests is a successful build (this will be checked automatically) as well as test coverage and complete documentation.  
+
 
 ## License
 

data/lib/criteria_operator/base_operator.rb

@@ -14,10 +14,33 @@ module CriteriaOperator
       raise NotImplementedError
     end
 
+    # Returns a string representation of the operator (including all sub-operators).
+    # YAML is used for serialization.
+    # @return [String] The serialized operator.
+    def serialize
+      BaseOperator.serialize(self)
+    end
+
+    # Returns a string representation of an operator (including all sub-operators).
+    # YAML is used for serialization.
+    # @param [BaseOperator] op The operator to serialize.
+    # @return [String] The serialized operator.
+    def self.serialize(op)
+      YAML.dump(op)
+    end
+
+    # Deserializes an operator from a string.
+    # String must be YAML-serialized.
+    # @param [String] serialized_op The serialized operator.
+    # @return [BaseOperator] The deserialized operator.
+    def self.deserialize(serialized_op)
+      YAML.safe_load(serialized_op, ObjectSpace.each_object(Class).select { |klass| klass < BaseOperator })
+    end
+
     protected
 
     # Clones the passed operator if it isn't nil.
-    # @param [BaseOperator] op the operator to clone
+    # @param [BaseOperator] op The operator to clone.
     # @return [BaseOperator, nil] The cloned base operator, if it exists, or nil, otherwise.
     def clone_or_nil(op)
       return nil if op.nil? || !op.is_a?(BaseOperator)

data/lib/criteria_operator/version.rb

@@ -1,5 +1,5 @@
 module CriteriaOperator
 
   # the gem version used in the gemspec
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: criteria_operator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Florian Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler