ruy 0.2.1 → 0.3.0

data/lib/ruy/outcome.rb

@@ -1,18 +1,43 @@
 module Ruy
-  class Outcome < Rule
+  # Represents a possible result (outcome) of evaluating a rule set
+  #
+  # Additionally, an outcome can be composed of rules. In that case, the outcome will evaluate to
+  # its value if all of them are evaluated successfully.
+  class Outcome
+    include DSL
+
     attr_reader :value
 
+    # @param value The value of this outcome
     def initialize(value)
-      super
       @value = value
+      @rule = Ruy::Rule.new
     end
 
+    # Returns the value of this outcome is all of the conditions succeed.
+    #
+    # It also returns the value when there's no conditions.
+    #
+    # @param [Ruy::Context] ctx
+    #
+    # @return [Object]
+    # @return [nil] If some of the conditions does not succeeds
     def call(ctx)
-      if super(ctx)
+      if @rule.call(ctx)
         @value
       end
     end
 
+    # @return [Array<Ruy::Rule>]
+    def conditions
+      @rule.conditions
+    end
+
+    # @return [Array] An array containing the value of this outcome
+    def params
+      [@value]
+    end
+
     def ==(o)
       o.kind_of?(Outcome) &&
         value == o.value &&

data/lib/ruy/rule.rb

@@ -1,120 +1,16 @@
 module Ruy
   class Rule
+    include DSL
+    include Utils::Printable
+
     attr_reader :conditions
-    attr_reader :vars
 
     def initialize(*args)
-      @conditions = []
-      @vars = {}
       @attrs = {}
+      @conditions = []
       @params = args
     end
 
-    # Adds an All condition.
-    #
-    # @yield Evaluates the given block in the context of the current rule
-    def all(&block)
-      cond = Conditions::All.new
-      cond.instance_exec(&block)
-
-      @conditions << cond
-    end
-
-    # Adds an Any condition.
-    #
-    # @yield Evaluates the given block in the context of the current rule
-    def any(&block)
-      cond = Conditions::Any.new
-      cond.instance_exec(&block)
-
-      @conditions << cond
-    end
-
-    # Adds an Assert condition.
-    #
-    # @param (see Conditions::Assert#initialize)
-    def assert(attr)
-      @conditions << Conditions::Assert.new(attr)
-    end
-
-    # Adds a Between condition.
-    #
-    # @param (see Conditions::Between#initialize)
-    def between(attr, from, to, &block)
-      @conditions << Conditions::Between.new(attr, from, to, &block)
-    end
-
-    # Adds an Eq condition.
-    #
-    # @param (see Conditions::Eq#initialize)
-    def eq(attr, value, &block)
-      @conditions << Conditions::Eq.new(attr, value, &block)
-    end
-
-    # Adds a Cond condition.
-    #
-    # @yield Evaluates the given block in the context of the current rule
-    def cond(&block)
-      cond = Conditions::Cond.new
-      cond.instance_exec(&block)
-
-      @conditions << cond
-    end
-
-    # Adds an Except condition.
-    #
-    # @param (see Conditions::Except#initialize)
-    def except(attr = nil, value = nil, &block)
-      @conditions << Conditions::Except.new(attr, value, &block)
-    end
-
-    # Adds a GreaterThanOrEqual condition.
-    #
-    # @param (see Conditions::GreaterThanOrEqual#initialize)
-    def greater_than_or_equal(attr, value)
-      @conditions << Conditions::GreaterThanOrEqual.new(attr, value)
-    end
-
-    # Adds an Include condition.
-    #
-    # @param (see Conditions::Include#initialize)
-    def include(attr, values, &block)
-      @conditions << Conditions::Include.new(attr, values, &block)
-    end
-
-    # Adds an Included condition.
-    #
-    # @param (see Conditions::Included#initialize)
-    def included(attr, value, &block)
-      @conditions << Conditions::Included.new(attr, value, &block)
-    end
-
-    # Adds a LessOrEqualThan condition.
-    #
-    # @param (see Conditions::LessOrEqualThan#initialize)
-    def less_than_or_equal(attr, value, &block)
-      @conditions << Conditions::LessThanOrEqual.new(attr, value)
-    end
-
-    # Adds a LessThan condition.
-    #
-    # @param (see Conditions::LessThan#initialize)
-    def less_than(attr, value)
-      @conditions << Conditions::LessThan.new(attr, value)
-    end
-
-    # Adds a TZ condition block
-    #
-    # @param [String] tz_identifier String representing IANA's
-    #   time zone identifier. Defaults to UTC if none passed.
-    # @yield Evaluates the given block in the context of the TZ rule
-    def tz(tz_identifier = 'UTC', &block)
-      cond = Conditions::TZ.new(tz_identifier)
-      cond.instance_exec(&block)
-
-      @conditions << cond
-    end
-
     # Gets attribute's value from the given name.
     #
     # @param name
@@ -132,23 +28,6 @@ module Ruy
       @attrs[name] = value
     end
 
-    # Defines a variable.
-    #
-    # If both value and block are given,
-    #   only the block will be taken into account.
-    #
-    # @param name The name of the variable
-    # @param value The value of the variable
-    #
-    # @yield a block that will resolve the variable's value
-    def var(name, value = nil, &block)
-      if block_given?
-        @vars[name] = block
-      else
-        @vars[name] = lambda { value }
-      end
-    end
-
     # Evaluates all conditions.
     #
     # @return [true] When all conditions succeeds
@@ -159,16 +38,18 @@ module Ruy
       end
 
       success.length == @conditions.length
-    rescue NoMethodError
-      false
     end
 
     def ==(o)
       o.kind_of?(Rule) &&
-        conditions == o.conditions &&
-        vars.keys == o.vars.keys
+        conditions == o.conditions
     end
 
+    # Getter method for rules params. It returns all the params without nil objects.
+    #
+    # @return [Array<Object>]
+    def params
+      @params.compact
+    end
   end
-
 end

data/lib/ruy/rule_set.rb

@@ -1,13 +1,23 @@
 module Ruy
-  class RuleSet < Rule
+  class RuleSet
+    include DSL
+
+    attr_reader :lets
     attr_reader :outcomes
-    attr_accessor :metadata
 
     def initialize
       super
+
+      @lets = []
       @outcomes = []
+
       @fallback = nil
-      @metadata = {}
+
+      @rule = Ruy::Rule.new
+    end
+
+    def conditions
+      @rule.conditions
     end
 
     def outcome(value, &block)
@@ -20,30 +30,19 @@ module Ruy
       @fallback = value
     end
 
-    def call(ctx)
-      var_ctx = VariableContext.new(ctx, @vars)
-      if @apply = super(var_ctx)
-        compute_outcome(var_ctx)
+    # @param [Hash] context
+    def call(context)
+      ctx = Context.new(context, @lets)
+      if @rule.call(ctx)
+        compute_outcome(ctx)
       else
         @fallback
       end
     end
 
-    def [](key)
-      @metadata[key]
-    end
-
-    def []=(key, value)
-      @metadata[key] = value
-    end
-
-    def apply?
-      @apply
-    end
-
-    def compute_outcome(var_ctx)
+    def compute_outcome(ctx)
       @outcomes.each do |outcome|
-        result = outcome.call(var_ctx)
+        result = outcome.call(ctx)
         unless result.nil?
           return result
         end
@@ -52,8 +51,33 @@ module Ruy
       nil
     end
 
-    def method_missing(m, *args, &block)
-      super
+    # Defines a memoized value.
+    #
+    # 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, it's value
+    # is stored, so subsequent invocations during the same evaluation will resolve again its value.
+    def let(name)
+      @lets << name
+    end
+
+    def to_s
+      s = lets.map { |name| "let #{name.inspect}" }.join("\n")
+
+      s << "\n\n" unless s == ''
+
+      s << self.conditions.join("\n")
+
+      if @outcomes.any?
+        s << "\n" unless s == ''
+        s << @outcomes.join("\n")
+      end
+
+      if @fallback
+        s << "\n" unless s == ''
+        s << "fallback #{@fallback.inspect}\n"
+      end
+
+      s
     end
 
   end

data/lib/ruy/time_pattern.rb

@@ -32,7 +32,7 @@ module Ruy
       @tz = TZInfo::Timezone.get(@time_zone || tz_identifier)
 
       # Store a Time object with values based on the specified time zone
-      @local = Time.new(year || 0, month, day, hour, min, sec, '+00:00')
+      @local = Time.new(year || 0, month, day, hour, min, sec, 0)
 
       # Store a Time object with values based on UTC
       @utc = @tz.local_to_utc(@local)
@@ -101,7 +101,7 @@ module Ruy
     #
     # @return [String]
     def inspect
-      @pattern
+      @pattern.inspect
     end
 
     # Overrides Ruby's method missing call to redirect calls

data/lib/ruy/utils.rb

@@ -0,0 +1,2 @@
+require_relative 'utils/naming'
+require_relative 'utils/printable'

data/lib/ruy/utils/naming.rb

@@ -0,0 +1,53 @@
+module Ruy
+  module Utils
+    module Naming
+
+      # Returns the simple name of a given module.
+      #
+      # @example
+      #   simple_module_name(Net::HTTP) # => 'HTTP'
+      #
+      # @param [Module] mod
+      #
+      # @return [String]
+      # @return [nil] if given module is an anonymous one.
+      def self.simple_module_name(mod)
+        name = mod.name
+
+        if name
+          name.split('::')[-1]
+        end
+      end
+
+      # Converts a string into a snake case representation.
+      #
+      # It suppports these kinds of strings:
+      #  - camel case
+      #  - all caps
+      #  - camel case mixed with all caps
+      #
+      # @param [String] s
+      #
+      # @return [String]
+      def self.snakecase(s)
+        s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+         .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+         .downcase
+      end
+
+      # Returns the name of a rule object.
+      #
+      # @example
+      #   rule_name(Ruy::Eq.new) # => 'eq'
+      #
+      # @param [Ruy::Rule] rule
+      #
+      # @return [String]
+      def self.rule_name(rule)
+        module_name = simple_module_name(rule.class)
+
+        snakecase(module_name)
+      end
+    end
+  end
+end

data/lib/ruy/utils/printable.rb

@@ -0,0 +1,36 @@
+require 'pp'
+require 'stringio'
+
+module Ruy
+  module Utils
+
+    module Printable
+
+      INDENTATION = ' ' * 2
+
+      def self.indent(level)
+        INDENTATION * level
+      end
+
+      # Adds inspect compatibility on ruby 1.9
+      #
+      # Ruby 1.9 changed the behaviour of #inspect, when not overriden, it uses #to_s method to
+      # generate the string.
+      #
+      # Since Ruby 2.0, the original behaviour was restored.
+      #
+      # @see https://bugs.ruby-lang.org/issues/4453
+      def inspect
+        PP.singleline_pp(self, StringIO.new).string
+      end
+
+      # Adds pretty print compatibility on ruby 1.9
+      #
+      # @see https://bugs.ruby-lang.org/issues/4453
+      def pretty_print(pp)
+        pp.pp_object(self)
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Moove-IT
@@ -14,16 +14,16 @@ dependencies:
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,12 +38,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description: 
-email: 
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: A library for defining a set of conditions, matching them against an
+  input, and finally return an outcome.
+email: ruy@moove-it.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/ruy.rb
 - lib/ruy/conditions.rb
 - lib/ruy/conditions/all.rb
@@ -54,19 +71,25 @@ files:
 - lib/ruy/conditions/day_of_week.rb
 - lib/ruy/conditions/eq.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/tz.rb
 - lib/ruy/context.rb
+- lib/ruy/dsl.rb
 - lib/ruy/outcome.rb
 - lib/ruy/rule.rb
 - lib/ruy/rule_set.rb
 - lib/ruy/time_pattern.rb
-- lib/ruy/variable_context.rb
-homepage: https://github.com/Moove-it/ruy
+- lib/ruy/utils.rb
+- lib/ruy/utils/naming.rb
+- lib/ruy/utils/printable.rb
+homepage: http://moove-it.github.io/ruy/
 licenses:
 - MIT
 metadata: {}