aequitas 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/aequitas/contextual_rule_set.rb

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
 
 require 'forwardable'
-require 'aequitas/support/equalizable'
+require 'aequitas/support/value_object'
 require 'aequitas/exceptions'
 require 'aequitas/context'
 require 'aequitas/rule_set'
 
 module Aequitas
   class ContextualRuleSet
-    extend Equalizable
+    extend ValueObject
     extend Forwardable
     include Enumerable
 
@@ -16,9 +16,9 @@ module Aequitas
 
     # MessageTransformer to use for transforming Violations on Resources
     # instantiated from the model to which this ContextualRuleSet is bound
-    # 
+    #
     # @api public
-    # attr_accessor :transformer
+    attr_accessor :transformer
 
     # @api private
     attr_reader :rule_sets
@@ -44,7 +44,7 @@ module Aequitas
     end
 
     # Delegate #validate to RuleSet
-    # 
+    #
     # @api public
     def validate(resource, context_name)
       context(context_name).validate(resource)
@@ -56,17 +56,17 @@ module Aequitas
     #   Context name for which to return a RuleSet
     # @return [RuleSet]
     #   RuleSet for the given context
-    # 
+    #
     # @api public
     def context(context_name)
       rule_sets.fetch(context_name)
     end
 
     # Retrieve Rules applicable to a given attribute name
-    # 
+    #
     # @param [Symbol] attribute_name
     #   name of the attribute for which to retrieve applicable Rules
-    # 
+    #
     # @return [Array]
     #   list of Rules applicable to +attribute_name+
     def [](attribute_name)
@@ -75,21 +75,21 @@ module Aequitas
 
     # Create a new rule of the given class for each name in +attribute_names+
     # and add the rules to the RuleSet(s) indicated
-    # 
+    #
     # @param [Aequitas::Rule] rule_class
     #    Rule class, example: Aequitas::Rule::Presence
     #
     # @param [Array<Symbol>] attribute_names
     #    Attribute names given to validation macro, example:
     #    [:first_name, :last_name] in validates_presence_of :first_name, :last_name
-    # 
+    #
     # @param [Hash] options
     #    Options supplied to validation macro, example:
     #    {:context=>:default, :maximum=>50, :allow_nil=>true, :message=>nil}
-    # 
+    #
     # @option [Symbol] :context, :group, :when, :on
     #   the context in which the new rule should be run
-    # 
+    #
     # @return [self]
     def add(rule_class, attribute_names, options = {}, &block)
       context_names = extract_context_names(options)
@@ -104,10 +104,10 @@ module Aequitas
     end
 
     # Assimilate all rules contained in +other+ into the receiver
-    # 
+    #
     # @param [ContextualRuleSet] other
     #   the ContextualRuleSet whose rules are to be assimilated
-    # 
+    #
     # @return [self]
     def concat(other)
       other.rule_sets.each do |context_name, rule_set|
@@ -118,12 +118,12 @@ module Aequitas
     end
 
     # Define a context and append rules to it
-    # 
+    #
     # @param [Symbol] context_name
     #   name of the context to define and append rules to
     # @param [RuleSet, Array] rules
     #   Rules to append to +context_name+
-    # 
+    #
     # @return [self]
     def add_rules_to_context(context_name, rules)
       define_context(context_name)
@@ -144,9 +144,9 @@ module Aequitas
     #   this model, or :default if the context on the stack is invalid for
     #   this model or no context is on the stack and this model has at least
     #   one validation context
-    # 
+    #
     # @api private
-    # 
+    #
     # TODO: this logic behind this method is too complicated.
     #   simplify the semantics of #current_context, #validate
     def current_context
@@ -185,7 +185,7 @@ module Aequitas
     #   raised if the context is not valid for this contextual rule set
     #
     # @api private
-    # 
+    #
     # TODO: is this method actually needed?
     def assert_valid_context(context_name)
       unless valid_context?(context_name)
@@ -198,22 +198,16 @@ module Aequitas
   private
 
     # Allow :context to be aliased to :group, :when & :on
-    # 
+    #
     # @param [Hash] options
     #   the options from which +context_names+ is to be extracted
-    # 
+    #
     # @return [Array(Symbol)]
     #   the context name(s) from +options+
-    # 
+    #
     # @api private
     def extract_context_names(options)
-      context_name = [
-        options.delete(:context),
-        options.delete(:group),
-        options.delete(:when),
-        options.delete(:on)
-      ].compact.first
-
+      context_name = options.values_at(:context, :group, :when, :on).compact.first
       Array(context_name || :default)
     end
 

data/lib/aequitas/macros.rb

@@ -279,6 +279,7 @@ module Aequitas
     #
     def validates_numericalness_of(*attribute_names)
       options = Macros.extract_options(attribute_names)
+      validation_rules.add(Rule::Value,         attribute_names, options)
       validation_rules.add(Rule::Numericalness, attribute_names, options)
     end
 
@@ -341,6 +342,11 @@ module Aequitas
       validation_rules.add(Rule::PrimitiveType, attribute_names, options)
     end
 
+    def validates_value_of(*attribute_names)
+      options = Macros.extract_options(attribute_names)
+      validation_rules.add(Rule::Value, attribute_names, options)
+    end
+
     # Validates that the value of a field is within a range/set.
     #
     # This validation is defined by passing a field along with a :set

data/lib/aequitas/message_transformer.rb

@@ -1,15 +1,23 @@
 # -*- encoding: utf-8 -*-
 
 module Aequitas
+
   # Transforms Violations to error message strings.
   #
   # @abstract
   #   Subclass and override {#transform} to implement a custom message
-  #   transformer. Use {Violation.message_transformer=} to set a new
+  #   transformer. Use {Violation.default_transformer=} to set a new default
   #   message transformer or pass the transformer to {Violation#message}.
   class MessageTransformer
+    # Get the default MessageTransformer for this process
+    #
+    # @return [MessageTransformer]
+    #   default MessageTransformer for this process
+    #
+    # @see {Violation.default_transformer}
+    #
     def self.default
-      defined?(I18n) ? DefaultI18n.new : Default.new
+      defined?(::I18n) ? DefaultI18n.new : DefaultStatic.new
     end
 
     # Transforms the specified Violation to an error message string.
@@ -26,7 +34,7 @@ module Aequitas
       raise NotImplementedError, "#{self.class}#transform has not been implemented"
     end
 
-    class Default < self
+    class DefaultStatic < MessageTransformer
       @error_messages = {
         :nil                      => '%s must not be nil',
         :blank                    => '%s must not be blank',
@@ -50,7 +58,8 @@ module Aequitas
         :less_than_or_equal_to    => '%s must be less than or equal to %s',
         :value_between            => '%s must be between %s and %s',
         :not_unique               => '%s is already taken',
-        :primitive                => '%s must be of type %s'
+        :primitive                => '%s must be of type %s',
+        :unsatisfied_condition    => '%s condition was not satisfied',
       }
 
       class << self
@@ -75,13 +84,17 @@ module Aequitas
 
       def self.error_message(violation_type, attribute_name, violation_values)
         if message = self.error_messages[violation_type]
-          attribute_name = DataMapper::Inflector.humanize(attribute_name)
+          attribute_name = ::DataMapper::Inflector.humanize(attribute_name)
           message % [attribute_name, *violation_values].flatten
         else
           violation_type.to_s
         end
       end
 
+      def initialize
+        require 'dm-core'
+      end
+
       def transform(violation)
         raise ArgumentError, "+violation+ must be specified" if violation.nil?
 
@@ -89,9 +102,9 @@ module Aequitas
 
         self.class.error_message(violation.type, attribute_name, violation.values)
       end
-    end # class Default
+    end # class DefaultStatic
 
-    class DefaultI18n < self
+    class DefaultI18n < MessageTransformer
       def initialize
         require 'i18n'
       end
@@ -100,6 +113,8 @@ module Aequitas
         raise ArgumentError, "+violation+ must be specified" if violation.nil?
 
         resource       = violation.resource
+        # TODO: resource#model and Model#model_name are assumptions from DM
+        #   Figure out a more flexible way to lookup error messages in I18n
         model_name     = resource.model.model_name
         attribute_name = violation.attribute_name
         # TODO: Include attribute value in Violation; it may have changed by now
@@ -109,7 +124,7 @@ module Aequitas
           :model     => ::I18n.translate("models.#{model_name}"),
           :attribute => ::I18n.translate("attributes.#{model_name}.#{attribute_name}"),
           # TODO: Include attribute value in Violation; it may have changed by now
-          :value     => resource.validation_attribute_value(attribute_name)
+          :value     => resource.validation_attribute_value(attribute_name),
         }.merge(violation.info)
 
         ::I18n.translate("#{i18n_namespace}.#{violation.type}", options)

data/lib/aequitas/rule.rb

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
 
 require 'aequitas/support/blank'
-require 'aequitas/support/equalizable'
+require 'aequitas/support/value_object'
 require 'aequitas/rule/guard'
 require 'aequitas/rule/skip_condition'
 require 'aequitas/violation'
 
 module Aequitas
   class Rule
-    extend Equalizable
+    extend ValueObject
 
     equalize_on :attribute_name, :custom_message, :guard, :skip_condition
 
@@ -123,27 +123,6 @@ module Aequitas
 
   private
 
-    # def allow_nil!
-    #   @allow_nil = true
-    # end
-
-    # def allow_blank!
-    #   @allow_blank = true
-    # end
-
-    # Get the corresponding Resource property, if it exists.
-    #
-    # Note: DataMapper validations can be used on non-DataMapper resources.
-    # In such cases, the return value will be nil.
-    # 
-    # @api private
-    def get_resource_property(resource, property_name)
-      model = resource.model if resource.respond_to?(:model)
-      repository = resource.repository               if model
-      properties = model.properties(repository.name) if model
-      properties[property_name]                      if properties
-    end
-
     def assert_kind_of(name, value, *klasses)
       klasses.each { |k| return if value.kind_of?(k) }
       raise ArgumentError, "+#{name}+ should be #{klasses.map { |k| k.name } * ' or '}, but was #{value.class.name}", caller(2)

data/lib/aequitas/rule/block.rb

@@ -16,6 +16,7 @@ module Aequitas
         super
 
         @block = block
+        @violation_type = options.fetch(:violation_type, :unsatisfied_condition)
       end
 
       def validate(resource)
@@ -28,6 +29,10 @@ module Aequitas
         end
       end
 
+      def violation_type(resource)
+        @violation_type
+      end
+
     end # class Block
   end # class Rule
 end # module Aequitas

data/lib/aequitas/rule/format.rb

@@ -3,17 +3,11 @@
 require 'aequitas/rule'
 require 'aequitas/exceptions'
 
-require 'aequitas/rule/formats/email'
-require 'aequitas/rule/formats/url'
-
 module Aequitas
   class Rule
-    module Format
+    class Format < Rule
 
-      FORMATS = {
-        :email_address => Formats::EmailAddress,
-        :url           => Formats::Url
-      }
+      FORMATS = {}
       # TODO: evaluate re-implementing custom error messages per format type
       # previously these strings were wrapped in lambdas, which were, at one
       # point, invoked with #try_call with the humanized attribute name and value
@@ -22,32 +16,31 @@ module Aequitas
         :url           => '%s is not a valid URL',
       }
 
-
-      def self.rules_for(attribute_name, options)
-        Array(new(attribute_name, options))
-      end
+      equalize_on *superclass.equalizer.keys + [:format]
 
       # @raise [UnknownValidationFormat]
       #   if the :as (or :with) option is a Symbol that is not a key in FORMATS,
       #   or if the provided format is not a Regexp, Symbol or Proc
-      def self.new(attribute_name, options)
-        format = options.delete(:as) || options.delete(:with)
-
-        case format
-        when Symbol
-          regexp = FORMATS.fetch(format) do
-            raise UnknownValidationFormat, "No such predefined format '#{format}'"
+      def self.rules_for(attribute_name, options)
+        format = options.values_at(:as, :with).compact.first
+
+        rule =
+          case format
+          when Symbol
+            regexp = FORMATS.fetch(format) do
+              raise UnknownValidationFormat, "No such predefined format '#{format}'"
+            end
+            self::Regexp.new(attribute_name, options.merge(:format => regexp, :format_name => format))
+          when ::Regexp
+            self::Regexp.new(attribute_name, options.merge(:format => format))
+          when ::Proc
+            self::Proc.new(attribute_name, options.merge(:format => format))
+          else
+            raise UnknownValidationFormat, "Expected a Regexp, Symbol, or Proc format. Got: #{format.inspect}"
           end
-          self::Regexp.new(attribute_name, options.merge(:format => regexp, :format_name => format))
-        when ::Regexp
-          self::Regexp.new(attribute_name, options.merge(:format => format))
-        when ::Proc
-          self::Proc.new(attribute_name, options.merge(:format => format))
-        else
-          raise UnknownValidationFormat, "Expected a Regexp, Symbol, or Proc format. Got: #{format.inspect}"
-        end
-      end
 
+        Array(rule)
+      end
 
       attr_reader :format
 
@@ -77,5 +70,8 @@ module Aequitas
   end # class Rule
 end # module Aequitas
 
+require 'aequitas/rule/format/email_address'
+require 'aequitas/rule/format/url'
+
 require 'aequitas/rule/format/proc'
 require 'aequitas/rule/format/regexp'

data/lib/aequitas/rule/{formats/email.rb → format/email_address.rb}

@@ -1,15 +1,17 @@
 # encoding: UTF-8
 
+require 'aequitas/rule/format'
+
 module Aequitas
   class Rule
-    module Formats
+    class Format
 
       # Almost RFC2822 (No attribution reference available).
       #
       # This differs in that it does not allow local domains (test@localhost).
       # 99% of the time you do not want to allow these email addresses
       # in a public web application.
-      EmailAddress = begin
+      EMAIL_ADDRESS = begin
         if (RUBY_VERSION == '1.9.2' && RUBY_ENGINE == 'jruby' && JRUBY_VERSION <= '1.6.3') || RUBY_VERSION == '1.9.3'
           # There is an obscure bug in jruby 1.6 that prevents matching
           # on unicode properties here. Remove this logic branch once
@@ -47,6 +49,8 @@ module Aequitas
         pattern        = /\A#{addr_spec}\z/u
       end
 
-    end # module Formats
+      Format::FORMATS[:email_address] = EMAIL_ADDRESS
+
+    end # class Format
   end # class Rule
 end # module Aequitas

data/lib/aequitas/rule/format/proc.rb

@@ -4,25 +4,19 @@ require 'aequitas/rule/format'
 
 module Aequitas
   class Rule
-    module Format
-      class Proc < Rule
-
-        include Format
-
-        equalize_on *(superclass.equalizer.keys + [:format])
-
+    class Format
+      class Proc < Format
 
         def valid?(resource)
           value = attribute_value(resource)
-          return true if skip?(value)
 
-          self.format.call(value)
+          skip?(value) || format.call(value)
         # rescue ::Encoding::CompatibilityError
         #   # This is to work around a bug in jruby - see formats/email.rb
         #   false
         end
 
       end # class Proc
-    end # module Format
+    end # class Format
   end # class Rule
 end # module Aequitas