dm-validations 0.9.11 → 0.10.0

data/{History.txt → History.rdoc}

@@ -1,8 +1,15 @@
-=== 0.9.11 / 2009-03-29
+=== 0.10.0 / 2009-10-15
 
-* 1 bug fix:
+* 3 major enhancements:
+
+  * Major spec refactoring
+  * dm-validations now can be used with a pure Ruby classes, not just DM models
+  * i18n of error messages
+
+* 1 minor enhancement:
+
+  * allow_nil option now uses #blank? instead of #nil? to comply common a use case
 
-  * Updated source file to force binary encoding
 
 === 0.9.10 / 2009-01-19
 

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2007 Guy van den Berg
+Copyright (c) 2008, 2009 DataMapper development team
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -1,53 +1,113 @@
-History.txt
+History.rdoc
 LICENSE
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 TODO
 lib/dm-validations.rb
-lib/dm-validations/absent_field_validator.rb
-lib/dm-validations/acceptance_validator.rb
 lib/dm-validations/auto_validate.rb
-lib/dm-validations/block_validator.rb
-lib/dm-validations/confirmation_validator.rb
 lib/dm-validations/contextual_validators.rb
-lib/dm-validations/custom_validator.rb
-lib/dm-validations/format_validator.rb
+lib/dm-validations/exceptions.rb
 lib/dm-validations/formats/email.rb
 lib/dm-validations/formats/url.rb
-lib/dm-validations/generic_validator.rb
-lib/dm-validations/length_validator.rb
-lib/dm-validations/method_validator.rb
-lib/dm-validations/numeric_validator.rb
-lib/dm-validations/primitive_validator.rb
-lib/dm-validations/required_field_validator.rb
+lib/dm-validations/support/context.rb
 lib/dm-validations/support/object.rb
-lib/dm-validations/uniqueness_validator.rb
 lib/dm-validations/validation_errors.rb
+lib/dm-validations/validators/absent_field_validator.rb
+lib/dm-validations/validators/acceptance_validator.rb
+lib/dm-validations/validators/block_validator.rb
+lib/dm-validations/validators/confirmation_validator.rb
+lib/dm-validations/validators/format_validator.rb
+lib/dm-validations/validators/generic_validator.rb
+lib/dm-validations/validators/length_validator.rb
+lib/dm-validations/validators/method_validator.rb
+lib/dm-validations/validators/numeric_validator.rb
+lib/dm-validations/validators/primitive_validator.rb
+lib/dm-validations/validators/required_field_validator.rb
+lib/dm-validations/validators/uniqueness_validator.rb
+lib/dm-validations/validators/within_validator.rb
 lib/dm-validations/version.rb
-lib/dm-validations/within_validator.rb
-spec/integration/absent_field_validator_spec.rb
-spec/integration/acceptance_validator_spec.rb
-spec/integration/auto_validate_spec.rb
-spec/integration/block_validator_spec.rb
-spec/integration/confirmation_validator_spec.rb
-spec/integration/contextual_validators_spec.rb
-spec/integration/custom_validator_spec.rb
-spec/integration/format_validator_spec.rb
-spec/integration/generic_validator_spec.rb
+spec/fixtures/barcode.rb
+spec/fixtures/basketball_court.rb
+spec/fixtures/basketball_player.rb
+spec/fixtures/beta_tester_account.rb
+spec/fixtures/bill_of_landing.rb
+spec/fixtures/boat_dock.rb
+spec/fixtures/city.rb
+spec/fixtures/company.rb
+spec/fixtures/corporate_world.rb
+spec/fixtures/country.rb
+spec/fixtures/currency.rb
+spec/fixtures/ethernet_frame.rb
+spec/fixtures/event.rb
+spec/fixtures/g3_concert.rb
+spec/fixtures/jabberwock.rb
+spec/fixtures/kayak.rb
+spec/fixtures/lernean_hydra.rb
+spec/fixtures/mathematical_function.rb
+spec/fixtures/memory_object.rb
+spec/fixtures/mittelschnauzer.rb
+spec/fixtures/motor_launch.rb
+spec/fixtures/page.rb
+spec/fixtures/phone_number.rb
+spec/fixtures/pirogue.rb
+spec/fixtures/programming_language.rb
+spec/fixtures/reservation.rb
+spec/fixtures/scm_operation.rb
+spec/fixtures/sms_message.rb
+spec/fixtures/udp_packet.rb
+spec/integration/absent_field_validator/absent_field_validator_spec.rb
+spec/integration/absent_field_validator/spec_helper.rb
+spec/integration/acceptance_validator/acceptance_validator_spec.rb
+spec/integration/acceptance_validator/spec_helper.rb
+spec/integration/automatic_validation/custom_messages_for_inferred_validation_spec.rb
+spec/integration/automatic_validation/disabling_inferred_validation_spec.rb
+spec/integration/automatic_validation/inferred_boolean_properties_validation_spec.rb
+spec/integration/automatic_validation/inferred_float_property_validation_spec.rb
+spec/integration/automatic_validation/inferred_format_validation_spec.rb
+spec/integration/automatic_validation/inferred_integer_properties_validation_spec.rb
+spec/integration/automatic_validation/inferred_length_validation_spec.rb
+spec/integration/automatic_validation/inferred_presence_validation_spec.rb
+spec/integration/automatic_validation/inferred_primitive_validation_spec.rb
+spec/integration/automatic_validation/inferred_within_validation_spec.rb
+spec/integration/automatic_validation/spec_helper.rb
+spec/integration/block_validator/block_validator_spec.rb
+spec/integration/block_validator/spec_helper.rb
+spec/integration/conditional_validation/if_condition_spec.rb
+spec/integration/conditional_validation/spec_helper.rb
+spec/integration/confirmation_validator/confirmation_validator_spec.rb
+spec/integration/confirmation_validator/spec_helper.rb
+spec/integration/datamapper_models/association_validation_spec.rb
+spec/integration/datamapper_models/inheritance_spec.rb
+spec/integration/duplicated_validations/duplicated_validations_spec.rb
+spec/integration/duplicated_validations/spec_helper.rb
+spec/integration/format_validator/email_format_validator_spec.rb
+spec/integration/format_validator/format_validator_spec.rb
+spec/integration/format_validator/regexp_validator_spec.rb
+spec/integration/format_validator/spec_helper.rb
+spec/integration/format_validator/url_format_validator_spec.rb
+spec/integration/length_validator/default_value_spec.rb
+spec/integration/length_validator/equality_spec.rb
 spec/integration/length_validator/error_message_spec.rb
 spec/integration/length_validator/maximum_spec.rb
 spec/integration/length_validator/minimum_spec.rb
 spec/integration/length_validator/range_spec.rb
 spec/integration/length_validator/spec_helper.rb
-spec/integration/length_validator/valid_objects_spec.rb
-spec/integration/method_validator_spec.rb
+spec/integration/method_validator/method_validator_spec.rb
+spec/integration/method_validator/spec_helper.rb
+spec/integration/numeric_validator/equality_with_float_type_spec.rb
+spec/integration/numeric_validator/equality_with_integer_type_spec.rb
 spec/integration/numeric_validator/float_type_spec.rb
+spec/integration/numeric_validator/gt_with_float_type_spec.rb
+spec/integration/numeric_validator/gte_with_float_type_spec.rb
 spec/integration/numeric_validator/integer_only_true_spec.rb
 spec/integration/numeric_validator/integer_type_spec.rb
+spec/integration/numeric_validator/lt_with_float_type_spec.rb
+spec/integration/numeric_validator/lte_with_float_type_spec.rb
 spec/integration/numeric_validator/spec_helper.rb
-spec/integration/numeric_validator_spec.rb
-spec/integration/primitive_validator_spec.rb
+spec/integration/primitive_validator/primitive_validator_spec.rb
+spec/integration/primitive_validator/spec_helper.rb
+spec/integration/pure_ruby_objects/plain_old_ruby_object_validation_spec.rb
 spec/integration/required_field_validator/association_spec.rb
 spec/integration/required_field_validator/boolean_type_value_spec.rb
 spec/integration/required_field_validator/date_type_value_spec.rb
@@ -59,11 +119,21 @@ spec/integration/required_field_validator/shared_examples.rb
 spec/integration/required_field_validator/spec_helper.rb
 spec/integration/required_field_validator/string_type_value_spec.rb
 spec/integration/required_field_validator/text_type_value_spec.rb
-spec/integration/uniqueness_validator_spec.rb
-spec/integration/validation_errors_spec.rb
-spec/integration/validation_spec.rb
-spec/integration/within_validator_spec.rb
+spec/integration/shared/default_validation_context.rb
+spec/integration/shared/valid_and_invalid_model.rb
+spec/integration/uniqueness_validator/spec_helper.rb
+spec/integration/uniqueness_validator/uniqueness_validator_spec.rb
+spec/integration/within_validator/spec_helper.rb
+spec/integration/within_validator/within_validator_spec.rb
+spec/public/resource_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
+spec/unit/contextual_validators/emptiness_spec.rb
+spec/unit/contextual_validators/execution_spec.rb
+spec/unit/contextual_validators/spec_helper.rb
+spec/unit/generic_validator/equality_operator_spec.rb
+spec/unit/validation_errors/adding_spec.rb
+spec/unit/validation_errors/emptiness_spec.rb
+spec/unit/validation_errors/enumerable_spec.rb
 tasks/install.rb
 tasks/spec.rb

data/README.rdoc

@@ -0,0 +1,172 @@
+This is a DataMapper plugin that provides validations for DataMapper model
+classes.
+
+== Setup
+DataMapper validation capabilities are automatically available for DataMapper
+resources when you require dm-validations' into your application. For
+pure Ruby classes, require 'dm-validations' and then include DataMapper::Validate
+module like so:
+
+class ProgrammingLanguage
+  #
+  # Behaviors
+  #
+
+  include ::DataMapper::Validate
+
+  #
+  # Accessors
+  #
+
+  attr_accessor :name, :allows_manual_memory_management, :allows_optional_parentheses
+
+  #
+  # Validations
+  #
+
+  validates_present :name
+  validates_with_method :ensure_allows_optional_parentheses,     :when => [:implementing_a_dsl]
+  validates_with_method :ensure_allows_manual_memory_management, :when => [:doing_system_programming]
+end
+
+
+== Specifying Model Validations
+There are two primary ways to implement validations for your models:
+
+1) Placing validation methods with properties as params in your class
+   definitions like:
+   - validates_length :name
+   - validates_length [:name, :description]
+
+2) Using auto-validations, please see DataMapper::Validate::AutoValidate
+
+An example class with validations declared:
+
+  require 'dm-validations'
+
+  class Account
+    include DataMapper::Resource
+
+    property :name, String
+    validates_length :name
+  end
+
+See all of the DataMapper::Validate module's XYZValidator(s) to learn about the
+complete collections of validators available to you.
+
+== Validating
+DataMapper validations, when included, alter the default save/create/update
+process for a model.  Unless you specify a context the resource must be
+valid in the :default context before saving.
+
+You may manually validate a resource using the valid? method, which will
+return true if the resource is valid, and false if it is invalid.
+
+In addition to the valid? method, there is also an all_valid? method that
+recursively walks both the current object and its associated objects and returns
+its true/false result for the entire walk.
+
+== Working with Validation Errors
+If your validators find errors in your model, they will populate the
+DataMapper::Validate::ValidationErrors object that is available through each of
+your models via calls to your model's errors method.
+
+For example:
+
+  my_account = Account.new(:name => "Jose")
+  if my_account.save
+    # my_account is valid and has been saved
+  else
+    my_account.errors.each do |e|
+      puts e
+    end
+  end
+
+See DataMapper::Validate::ValidationErrors for all you can do with your model's
+errors method.
+
+== Contextual Validations
+
+DataMapper Validations also provide a means of grouping your validations into
+contexts. This enables you to run different sets of validations when you
+need it. For instance, the same model may not only behave differently
+when initially saved or saved on update, but also require special validation sets
+for publishing, exporting, importing and so on.
+
+Again, using our example for pure Ruby class validations:
+
+class ProgrammingLanguage
+  #
+  # Behaviors
+  #
+
+  include ::DataMapper::Validate
+
+  #
+  # Accessors
+  #
+
+  attr_accessor :name, :allows_manual_memory_management, :allows_optional_parentheses
+
+  #
+  # Validations
+  #
+
+  validates_present :name
+  validates_with_method :ensure_allows_optional_parentheses,     :when => [:implementing_a_dsl]
+  validates_with_method :ensure_allows_manual_memory_management, :when => [:doing_system_programming]
+end
+
+ProgrammingLanguage instance now use #valid? method with one of two context symbols:
+
+@ruby.valid?(:implementing_a_dsl)       # => true
+@ruby.valid?(:doing_system_programming) # => false
+
+@c.valid?(:implementing_a_dsl)       # => false
+@c.valid?(:doing_system_programming) # => true
+
+Each context causes different set of validations to be triggered. If you don't
+specify a context using :when, :on or :group options (they are all aliases and do
+the same thing), default context name is :default. When you do model.valid? (without
+specifying context explicitly), again, :default context is used. One validation
+can be used in two, three or five contexts if you like:
+
+class Book
+
+  #
+  # Behaviors
+  #
+
+  # this time it is a DM model
+  include ::DataMapper::Resource
+
+  #
+  # Accessors
+  #
+
+  property :id,           Serial
+  property :name,         String
+
+  property :agreed_title, String
+  property :finished_toc, Boolean
+
+  #
+  # Validations
+  #
+
+  # used in all contexts, including default
+  validates_present :name,         :when => [:default, :sending_to_print]
+  validates_present :agreed_title, :when => [:sending_to_print]
+
+  validates_with_block :toc, :when => [:sending_to_print] do
+    if self.finished_toc
+      [true]
+    else
+      [false, "TOC must be finalized before you send a book to print"]
+    end
+  end
+end
+
+In the example above, name is validated for presence in both :default context and
+:sending_to_print context, while TOC related block validation and title presence validation
+only take place in :sending_to_print context.

data/Rakefile

@@ -1,5 +1,4 @@
 require 'pathname'
-require 'rubygems'
 
 ROOT    = Pathname(__FILE__).dirname.expand_path
 JRUBY   = RUBY_PLATFORM =~ /java/
@@ -8,17 +7,17 @@ SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
 
 require ROOT + 'lib/dm-validations/version'
 
-AUTHOR = 'Guy van den Berg'
+AUTHOR = 'Guy van den Berg, DataMapper development team'
 EMAIL  = 'vandenberg.guy [a] gmail [d] com'
 GEM_NAME = 'dm-validations'
 GEM_VERSION = DataMapper::Validations::VERSION
 GEM_DEPENDENCIES = [['dm-core', GEM_VERSION]]
 GEM_CLEAN = %w[ log pkg coverage ]
-GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.rdoc LICENSE TODO History.rdoc ] }
 
 PROJECT_NAME = 'datamapper'
-PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/#{GEM_NAME}"
-PROJECT_DESCRIPTION = PROJECT_SUMMARY = 'DataMapper plugin for performing validations on data models'
+PROJECT_URL  = "http://github.com/datamapper/dm-more/tree/master/#{GEM_NAME}"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = 'Library for performing validations on DM models and pure Ruby object'
 
 [ ROOT, ROOT.parent ].each do |dir|
   Pathname.glob(dir.join('tasks/**/*.rb').to_s).each { |f| require f }

data/lib/dm-validations.rb

@@ -1,75 +1,71 @@
-require 'rubygems'
-require 'pathname'
-
-gem 'dm-core', '0.9.11'
-require 'dm-core'
-
-dir = Pathname(__FILE__).dirname.expand_path / 'dm-validations'
-
-require dir / 'validation_errors'
-require dir / 'contextual_validators'
-require dir / 'auto_validate'
-
-require dir / 'generic_validator'
-require dir / 'required_field_validator'
-require dir / 'primitive_validator'
-require dir / 'absent_field_validator'
-require dir / 'confirmation_validator'
-require dir / 'format_validator'
-require dir / 'length_validator'
-require dir / 'within_validator'
-require dir / 'numeric_validator'
-require dir / 'method_validator'
-require dir / 'block_validator'
-require dir / 'uniqueness_validator'
-require dir / 'acceptance_validator'
-require dir / 'custom_validator'
-
-require dir / 'support' / 'object'
+require 'dm-validations/exceptions'
+require 'dm-validations/validation_errors'
+require 'dm-validations/contextual_validators'
+require 'dm-validations/auto_validate'
+
+require 'dm-validations/validators/generic_validator'
+require 'dm-validations/validators/required_field_validator'
+require 'dm-validations/validators/primitive_validator'
+require 'dm-validations/validators/absent_field_validator'
+require 'dm-validations/validators/confirmation_validator'
+require 'dm-validations/validators/format_validator'
+require 'dm-validations/validators/length_validator'
+require 'dm-validations/validators/within_validator'
+require 'dm-validations/validators/numeric_validator'
+require 'dm-validations/validators/method_validator'
+require 'dm-validations/validators/block_validator'
+require 'dm-validations/validators/uniqueness_validator'
+require 'dm-validations/validators/acceptance_validator'
+
+require 'dm-validations/support/context'
+require 'dm-validations/support/object'
 
 module DataMapper
   module Validate
+    Model.append_inclusions self
+
+    extend Chainable
 
     def self.included(model)
-      model.class_eval <<-EOS, __FILE__, __LINE__
-        if method_defined?(:save)
-          before :save, :check_validations
+      model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.create(attributes = {}, *args)
+          resource = new(attributes)
+          resource.save(*args)
+          resource
         end
+      RUBY
 
-        class << self
-          def create(attributes = {}, context = :default)
-            resource = new(attributes)
-            return resource unless resource.valid?(context)
-            resource.save!
-            resource
-          end
-
-          def create!(attributes = {})
-            resource = new(attributes)
-            resource.save!
-            resource
-          end
-        end
-      EOS
+      # models that are non DM resources must get .validators
+      # and other methods, too
+      model.extend ClassMethods
     end
 
     # Ensures the object is valid for the context provided, and otherwise
     # throws :halt and returns false.
     #
-    def check_validations(context = :default)
-      throw(:halt, false) unless context.nil? || valid?(context)
+    chainable do
+      def save(context = default_validation_context)
+        validation_context(context) { super() }
+      end
     end
 
-    # Calls save with a context of nil, thus skipping validations.
-    #
-    def save!
-      save(nil)
+    chainable do
+      def save_self(*)
+        return false unless validation_context_stack.empty? || valid?(current_validation_context)
+        super
+      end
+    end
+
+    chainable do
+      def update(attributes = {}, context = default_validation_context)
+        validation_context(context) { super(attributes) }
+      end
     end
 
     # Return the ValidationErrors
     #
     def errors
-      @errors ||= ValidationErrors.new
+      @errors ||= ValidationErrors.new(self)
     end
 
     # Mark this resource as validatable. When we validate associations of a
@@ -89,7 +85,8 @@ module DataMapper
     # Check if a resource is valid in a given context
     #
     def valid?(context = :default)
-      self.class.validators.execute(context, self)
+      klass = respond_to?(:model) ? model : self.class
+      klass.validators.execute(context, self)
     end
 
     # Begin a recursive walk of the model checking validity
@@ -117,9 +114,8 @@ module DataMapper
       return valid && target.valid?
     end
 
-
     def validation_property_value(name)
-      self.respond_to?(name, true) ? self.send(name) : nil
+      respond_to?(name, true) ? send(name) : nil
     end
 
     # Get the corresponding Resource property, if it exists.
@@ -127,7 +123,7 @@ module DataMapper
     # Note: DataMapper validations can be used on non-DataMapper resources.
     # In such cases, the return value will be nil.
     def validation_property(field_name)
-      if respond_to?(:model) && (properties = model.properties(self.repository.name)) && properties.has_property?(field_name)
+      if respond_to?(:model) && (properties = model.properties(repository.name)) && properties.named?(field_name)
         properties[field_name]
       end
     end
@@ -171,13 +167,9 @@ module DataMapper
       #
       def opts_from_validator_args(args, defaults = nil)
         opts = args.last.kind_of?(Hash) ? args.pop : {}
-        context = :default
-        context = opts[:context] if opts.has_key?(:context)
-        context = opts.delete(:on) if opts.has_key?(:on)
-        context = opts.delete(:when) if opts.has_key?(:when)
-        context = opts.delete(:group) if opts.has_key?(:group)
+        context = opts.delete(:group) || opts.delete(:on) || opts.delete(:when) || opts.delete(:context) || :default
         opts[:context] = context
-        opts.mergs!(defaults) unless defaults.nil?
+        opts.merge!(defaults) unless defaults.nil?
         opts
       end
 
@@ -187,30 +179,39 @@ module DataMapper
       #
       def create_context_instance_methods(context)
         name = "valid_for_#{context.to_s}?"           # valid_for_signup?
-        if !self.instance_methods.include?(name)
-          class_eval <<-EOS, __FILE__, __LINE__
+        if !instance_methods.include?(name)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{name}                               # def valid_for_signup?
-              valid?('#{context.to_s}'.to_sym)        #   valid?('signup'.to_sym)
+              valid?(#{context.to_sym.inspect})       #   valid?(:signup)
             end                                       # end
-          EOS
+          RUBY
         end
 
         all = "all_valid_for_#{context.to_s}?"        # all_valid_for_signup?
-        if !self.instance_methods.include?(all)
-          class_eval <<-EOS, __FILE__, __LINE__
+        if !instance_methods.include?(all)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{all}                                # def all_valid_for_signup?
-              all_valid?('#{context.to_s}'.to_sym)    #   all_valid?('signup'.to_sym)
+              all_valid?(#{context.to_sym.inspect})   #   all_valid?(:signup)
             end                                       # end
-          EOS
+          RUBY
         end
       end
 
       # Create a new validator of the given klazz and push it onto the
       # requested context for each of the attributes in the fields list
+      # @param [Hash]          opts
+      #    Options supplied to validation macro, example:
+      #    {:context=>:default, :maximum=>50, :allow_nil=>true, :message=>nil}
+      #
+      # @param [Array<Symbol>] fields
+      #    Fields given to validation macro, example:
+      #    [:first_name, :last_name] in validates_present :first_name, :last_name
       #
+      # @param [Class] klazz
+      #    Validator class, example: DataMapper::Validate::LengthValidator
       def add_validator_to_context(opts, fields, klazz)
         fields.each do |field|
-          validator = klazz.new(field, opts)
+          validator = klazz.new(field, opts.dup)
           if opts[:context].is_a?(Symbol)
             unless validators.context(opts[:context]).include?(validator)
               validators.context(opts[:context]) << validator
@@ -228,7 +229,4 @@ module DataMapper
       end
     end # module ClassMethods
   end # module Validate
-
-  Resource.append_inclusions Validate
-  Model.append_extensions Validate::ClassMethods
 end # module DataMapper