ruy 1.0.0 → 2.0.0

data/lib/ruy/rule.rb

@@ -14,61 +14,67 @@ module Ruy
       @outcomes = []
     end
 
-    # Gets attribute's value from the given name.
+    # Gets attribute's value from the given name
     #
     # @param name
     #
-    # @return The attribute's value.
+    # @return the attribute's value
     def get(name)
       @attrs[name]
     end
 
-    # Sets a custom attribute.
+    # Sets a custom attribute
     #
-    # @param name Attribute's name
-    # @param value Attribute's value
+    # @param name
+    # @param value
     def set(name, value)
       @attrs[name] = value
     end
 
-    # Evaluates rule conditions return the corresponding outcome or fallback depending on whether
-    # the conditions matched or not.
+    # Evaluates that rule conditions return the corresponding outcome
+    # or fallback depending on whether the conditions matched or not
     #
-    # @param [Hash] context
+    # @param context [Hash]
     #
-    # @return [Object] outcome or fallback
+    # @return outcome or fallback values
     def call(context)
       ctx = Context.new(context, @lets)
 
       if Ruy::Utils::Rules.evaluate_conditions(@conditions, ctx)
         Ruy::Utils::Rules.compute_outcome(@outcomes, ctx)
-
       else
         @fallback
       end
     end
 
-    # TODO document
-    def fallback(value)
-      @fallback = value
-    end
-
-    # Defines a memoized value.
+    # Stores the name of a lazy variable whose block will be defined
+    # in the evaluated context
     #
-    # The value will be resolved upon the context during evaluation. Let is lazy evaluated, it is
-    # not evaluated until the first condition referencing it is invoked. Once evaluated, its value
-    # is stored, so subsequent invocations during the same evaluation will resolve again its value.
+    # @param name [Symbol]
     def let(name)
       @lets << name
     end
 
-    # TODO document
+    # Defines the fallback value to be returned when conditions are not met
+    #
+    # @param value
+    def fallback(value)
+      @fallback = value
+    end
+
+    # Defines the outcome value to be returned when conditions are met
+    #
+    # @param value
+    # @yield value
     def outcome(value, &block)
       outcome = Outcome.new(value)
       outcome.instance_exec(&block) if block_given?
       @outcomes << outcome
     end
 
+    # Outputs a DSL-compliant description of the rule
+    #
+    # @return [String]
     def to_s
       s = @attrs.map { |name, value| "set #{name.inspect}, #{value.inspect}" }.join("\n")
       s << "\n\n" if @attrs.any?

data/lib/ruy/time_pattern.rb

@@ -9,9 +9,9 @@ module Ruy
     attr_reader :year, :month, :day, :hour, :min, :sec, :time_zone, :tz, :local,
       :utc, :utc_offset
 
-    # @param [String] pattern String representing a Ruy's
+    # @param pattern [String] String representing a Ruy's
     #   well-formed timestamp pattern
-    # @param [String] tz_identifier String representing IANA's
+    # @param tz_identifier [String] String representing IANA's
     #   time zone identifier. Defaults to UTC if none passed.
     def initialize(pattern, tz_identifier = 'UTC')
       unless match_data = pattern.match(WELL_FORMED_TS_EXP)
@@ -39,12 +39,6 @@ module Ruy
       @utc_offset = @tz.current_period.utc_total_offset
     end
 
-    # Implements Ruby's spaceship operator to work with Time objects.
-    #   Uses Object's spaceship operator if passed object
-    #   does not respond to #to_time.
-    #
-    # @param [#to_time]
-    # @return [Fixnum]
     def <=>(o)
       if o.respond_to?(:to_time)
         time = o.to_time
@@ -67,12 +61,6 @@ module Ruy
       end
     end
 
-    # Overrides Object equal operator and uses Comparable equality
-    #   for Time objects.
-    #   Uses identity comparison if passed object does not respond to #to_time.
-    #
-    # @param [#to_time]
-    # @return [Boolean]
     def ==(o)
       if o.is_a?(self.class)
         return year == o.year &&
@@ -90,25 +78,20 @@ module Ruy
     end
 
     # Returns a well-formed Ruy timestamp with IANA time zone identifier
-    #   representing the current TimePattern object.
+    # representing the current TimePattern object.
     #
-    # @return [String]
     def to_s
       @pattern
     end
 
-    # Returns a representation of the time pattern
-    #
-    # @return [String]
     def inspect
       @pattern.inspect
     end
 
-    # Overrides Ruby's method missing call to redirect calls
-    #   to the stored Time object in case it responds to the missing method.
-    #   Will call to super in case it doesn't.
+    protected
+
+    # Redirects missing methods to the UTC Time object stored in the instance
     #
-    # @param (see BasicObject#method_missing)
     def method_missing(method, *args)
       @utc.respond_to?(method) ? @utc.send(method, *args) : super
     end

data/lib/ruy/utils/naming.rb

@@ -7,7 +7,7 @@ module Ruy
       # @example
       #   simple_module_name(Net::HTTP) # => 'HTTP'
       #
-      # @param [Module] mod
+      # @param mod [Module]
       #
       # @return [String]
       # @return [nil] if given module is an anonymous one.
@@ -26,7 +26,7 @@ module Ruy
       #  - all caps
       #  - camel case mixed with all caps
       #
-      # @param [String] s
+      # @param s [String]
       #
       # @return [String]
       def self.snakecase(s)
@@ -40,7 +40,7 @@ module Ruy
       # @example
       #   rule_name(Ruy::Eq.new) # => 'eq'
       #
-      # @param [Ruy::Rule] rule
+      # @param rule [Ruy::Rule]
       #
       # @return [String]
       def self.rule_name(rule)

data/lib/ruy/utils/rules.rb

@@ -6,8 +6,8 @@ module Ruy
       #
       # Returns true when all the conditions match, false otherwise.
       #
-      # @param [Array<Condition>] conditions
-      # @param [Hash] ctx
+      # @param conditions [Array<Condition>]
+      # @param ctx [Context]
       #
       # @return [Boolean]
       def self.evaluate_conditions(conditions, ctx)
@@ -20,7 +20,7 @@ module Ruy
 
       # Returns the value of the first outcome that matches
       #
-      # @param [Ruy::Context] ctx
+      # @param ctx [Ruy::Context]
       #
       # @return [Object] The value of the first matching outcome
       # @return [nil] when no outcome matches

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: ruy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Moove-IT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
@@ -71,16 +71,18 @@ files:
 - lib/ruy/conditions/cond.rb
 - lib/ruy/conditions/condition.rb
 - lib/ruy/conditions/day_of_week.rb
+- lib/ruy/conditions/dig.rb
 - lib/ruy/conditions/eq.rb
+- lib/ruy/conditions/every.rb
 - lib/ruy/conditions/except.rb
 - lib/ruy/conditions/greater_than.rb
 - lib/ruy/conditions/greater_than_or_equal.rb
 - lib/ruy/conditions/in.rb
 - lib/ruy/conditions/in_cyclic_order.rb
 - lib/ruy/conditions/include.rb
-- lib/ruy/conditions/included.rb
 - lib/ruy/conditions/less_than.rb
 - lib/ruy/conditions/less_than_or_equal.rb
+- lib/ruy/conditions/some.rb
 - lib/ruy/conditions/tz.rb
 - lib/ruy/context.rb
 - lib/ruy/dsl.rb
@@ -101,17 +103,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Rules Engine for Ruby

data/lib/ruy/conditions/included.rb

@@ -1,28 +0,0 @@
-module Ruy
-  module Conditions
-
-    # Expects that a value is included in a set of values from the context attribute.
-    class Included < Condition
-      attr_reader :attr, :value
-
-      # @param attr Context attribute's name
-      # @param value Expected set of values
-      # @yield a block in the context of the current rule
-      def initialize(attr, value, &block)
-        super
-        @attr = attr
-        @value = value
-      end
-
-      def call(ctx)
-        ctx.resolve(self.attr).include?(self.value)
-      end
-
-      def ==(o)
-        o.kind_of?(Included) &&
-          self.attr == o.attr &&
-          self.value == o.value
-      end
-    end
-  end
-end