sequel 2.11.0 → 2.12.0

data/lib/sequel/plugins/single_table_inheritance.rb

@@ -0,0 +1,63 @@
+module Sequel
+  module Plugins
+    # Sequel's built in Single Table Inheritance plugin makes subclasses
+    # of this model only load rows where the given key field matches the
+    # subclass's name.  If the key given has a NULL value or there are
+    # any problems looking up the class, uses the current class.
+    #   
+    # You should only use this in the parent class, not in the subclasses.
+    #   
+    # You shouldn't call set_dataset in the model after applying this
+    # plugin, otherwise subclasses might use the wrong dataset.
+    #   
+    # The filters and row_proc that sti_key sets up in subclasses may not work correctly if
+    # those subclasses have further subclasses.  For those middle subclasses,
+    # you may need to call set_dataset manually with the correct filter and
+    # row_proc.
+    module SingleTableInheritance
+      # Set the sti_key and sti_dataset for the model, and change the
+      # dataset's row_proc so that the dataset yields objects of varying classes,
+      # where the class used has the same name as the key field.
+      def self.apply(model, key)
+        m = model.method(:constantize)
+        model.instance_eval do
+          @sti_key = key 
+          @sti_dataset = dataset
+          dataset.row_proc = lambda{|r| (m.call(r[key]) rescue model).load(r)}
+        end
+      end
+
+      module ClassMethods
+        # The base dataset for STI, to which filters are added to get
+        # only the models for the specific STI subclass.
+        attr_reader :sti_dataset
+
+        # The column name holding the STI key for this model
+        attr_reader :sti_key
+
+        # Copy the sti_key and sti_dataset to the subclasses, and filter the
+        # subclass's dataset so it is restricted to rows where the key column
+        # matches the subclass's name.
+        def inherited(subclass)
+          super
+          sk = sti_key
+          sd = sti_dataset
+          subclass.set_dataset(sd.filter(sk=>subclass.name.to_s), :inherited=>true)
+          subclass.instance_eval do
+            @sti_key = sk
+            @sti_dataset = sd
+            @simple_table = nil
+          end
+        end
+      end
+
+      module InstanceMethods
+        # Set the sti_key column to the name of the model.
+        def before_create
+          return false if super == false
+          send("#{model.sti_key}=", model.name.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/validation_class_methods.rb

@@ -0,0 +1,384 @@
+module Sequel
+  require 'extensions/blank'
+
+  module Plugins
+    module ValidationClassMethods
+      module ClassMethods
+        # The Generator class is used to generate validation definitions using 
+        # the validates {} idiom.
+        class Generator
+          # Initializes a new generator.
+          def initialize(receiver ,&block)
+            @receiver = receiver
+            instance_eval(&block)
+          end
+      
+          # Delegates method calls to the receiver by calling receiver.validates_xxx.
+          def method_missing(m, *args, &block)
+            @receiver.send(:"validates_#{m}", *args, &block)
+          end
+        end
+    
+        # Returns true if validations are defined.
+        def has_validations?
+          !validations.empty?
+        end
+    
+        # Instructs the model to skip validations defined in superclasses
+        def skip_superclass_validations
+          @skip_superclass_validations = true
+        end
+        
+        # Instructs the model to skip validations defined in superclasses
+        def skip_superclass_validations?
+          defined?(@skip_superclass_validations) && @skip_superclass_validations
+        end
+
+        # Defines validations by converting a longhand block into a series of 
+        # shorthand definitions. For example:
+        #
+        #   class MyClass < Sequel::Model
+        #     validates do
+        #       length_of :name, :minimum => 6
+        #       length_of :password, :minimum => 8
+        #     end
+        #   end
+        #
+        # is equivalent to:
+        #   class MyClass < Sequel::Model
+        #     validates_length_of :name, :minimum => 6
+        #     validates_length_of :password, :minimum => 8
+        #   end
+        def validates(&block)
+          Generator.new(self, &block)
+        end
+    
+        # Validates the given instance.
+        def validate(o)
+          superclass.validate(o) if superclass.respond_to?(:validate) && !skip_superclass_validations?
+          validations.each do |att, procs|
+            v = case att
+            when Array
+              att.collect{|a| o.send(a)}
+            else
+              o.send(att)
+            end
+            procs.each {|tag, p| p.call(o, att, v)}
+          end
+        end
+        
+        # Validates acceptance of an attribute.  Just checks that the value
+        # is equal to the :accept option. This method is unique in that
+        # :allow_nil is assumed to be true instead of false.
+        #
+        # Possible Options:
+        # * :accept - The value required for the object to be valid (default: '1')
+        # * :message - The message to use (default: 'is not accepted')
+        def validates_acceptance_of(*atts)
+          opts = {
+            :message => 'is not accepted',
+            :allow_nil => true,
+            :accept => '1',
+            :tag => :acceptance,
+          }.merge!(extract_options!(atts))
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            o.errors.add(a, opts[:message]) unless v == opts[:accept]
+          end
+        end
+    
+        # Validates confirmation of an attribute. Checks that the object has
+        # a _confirmation value matching the current value.  For example:
+        #
+        #   validates_confirmation_of :blah
+        #
+        # Just makes sure that object.blah = object.blah_confirmation.  Often used for passwords
+        # or email addresses on web forms.
+        #
+        # Possible Options:
+        # * :message - The message to use (default: 'is not confirmed')
+        def validates_confirmation_of(*atts)
+          opts = {
+            :message => 'is not confirmed',
+            :tag => :confirmation,
+          }.merge!(extract_options!(atts))
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            o.errors.add(a, opts[:message]) unless v == o.send(:"#{a}_confirmation")
+          end
+        end
+    
+        # Adds a validation for each of the given attributes using the supplied
+        # block. The block must accept three arguments: instance, attribute and 
+        # value, e.g.:
+        #
+        #   validates_each :name, :password do |object, attribute, value|
+        #     object.errors.add(attribute, 'is not nice') unless value.nice?
+        #   end
+        #
+        # Possible Options:
+        # * :allow_blank - Whether to skip the validation if the value is blank. 
+        # * :allow_missing - Whether to skip the validation if the attribute isn't a key in the
+        #   values hash.  This is different from allow_nil, because Sequel only sends the attributes
+        #   in the values when doing an insert or update.  If the attribute is not present, Sequel
+        #   doesn't specify it, so the database will use the table's default value.  This is different
+        #   from having an attribute in values with a value of nil, which Sequel will send as NULL.
+        #   If your database table has a non NULL default, this may be a good option to use.  You
+        #   don't want to use allow_nil, because if the attribute is in values but has a value nil,
+        #   Sequel will attempt to insert a NULL value into the database, instead of using the
+        #   database's default.
+        # * :allow_nil - Whether to skip the validation if the value is nil.
+        # * :if - A symbol (indicating an instance_method) or proc (which is instance_evaled)
+        #   skipping this validation if it returns nil or false.
+        # * :tag - The tag to use for this validation.
+        def validates_each(*atts, &block)
+          opts = extract_options!(atts)
+          blk = if (i = opts[:if]) || (am = opts[:allow_missing]) || (an = opts[:allow_nil]) || (ab = opts[:allow_blank])
+            proc do |o,a,v|
+              next if i && !validation_if_proc(o, i)
+              next if an && Array(v).all?{|x| x.nil?}
+              next if ab && Array(v).all?{|x| x.blank?}
+              next if am && Array(a).all?{|x| !o.values.has_key?(x)}
+              block.call(o,a,v)
+            end
+          else
+            block
+          end
+          tag = opts[:tag]
+          atts.each do |a| 
+            a_vals = validations[a]
+            if tag && (old = a_vals.find{|x| x[0] == tag})
+              old[1] = blk
+            else
+              a_vals << [tag, blk]
+            end
+          end
+        end
+    
+        # Validates the format of an attribute, checking the string representation of the
+        # value against the regular expression provided by the :with option.
+        #
+        # Possible Options:
+        # * :message - The message to use (default: 'is invalid')
+        # * :with - The regular expression to validate the value with (required).
+        def validates_format_of(*atts)
+          opts = {
+            :message => 'is invalid',
+            :tag => :format,
+          }.merge!(extract_options!(atts))
+          
+          unless opts[:with].is_a?(Regexp)
+            raise ArgumentError, "A regular expression must be supplied as the :with option of the options hash"
+          end
+          
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            o.errors.add(a, opts[:message]) unless v.to_s =~ opts[:with]
+          end
+        end
+    
+        # Validates the length of an attribute.
+        #
+        # Possible Options:
+        # * :is - The exact size required for the value to be valid (no default)
+        # * :maximum - The maximum size allowed for the value (no default)
+        # * :message - The message to use (no default, overrides :too_long, :too_short, and :wrong_length
+        #   options if present)
+        # * :minimum - The minimum size allowed for the value (no default)
+        # * :too_long - The message to use use if it the value is too long (default: 'is too long')
+        # * :too_short - The message to use use if it the value is too short (default: 'is too short')
+        # * :within - The array/range that must include the size of the value for it to be valid (no default)
+        # * :wrong_length - The message to use use if it the value is not valid (default: 'is the wrong length')
+        def validates_length_of(*atts)
+          opts = {
+            :too_long     => 'is too long',
+            :too_short    => 'is too short',
+            :wrong_length => 'is the wrong length'
+          }.merge!(extract_options!(atts))
+          
+          opts[:tag] ||= ([:length] + [:maximum, :minimum, :is, :within].reject{|x| !opts.include?(x)}).join('-').to_sym
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            if m = opts[:maximum]
+              o.errors.add(a, opts[:message] || opts[:too_long]) unless v && v.size <= m
+            end
+            if m = opts[:minimum]
+              o.errors.add(a, opts[:message] || opts[:too_short]) unless v && v.size >= m
+            end
+            if i = opts[:is]
+              o.errors.add(a, opts[:message] || opts[:wrong_length]) unless v && v.size == i
+            end
+            if w = opts[:within]
+              o.errors.add(a, opts[:message] || opts[:wrong_length]) unless v && w.include?(v.size)
+            end
+          end
+        end
+    
+        # Validates whether an attribute is not a string.  This is generally useful
+        # in conjunction with raise_on_typecast_failure = false, where you are
+        # passing in string values for non-string attributes (such as numbers and dates).
+        # If typecasting fails (invalid number or date), the value of the attribute will
+        # be a string in an invalid format, and if typecasting succeeds, the value will
+        # not be a string.
+        #
+        # Possible Options:
+        # * :message - The message to use (default: 'is a string' or 'is not a valid (integer|datetime|etc.)' if the type is known)
+        def validates_not_string(*atts)
+          opts = {
+            :tag => :not_string,
+          }.merge!(extract_options!(atts))
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            if v.is_a?(String)
+              unless message = opts[:message]
+                message = if sch = o.db_schema[a] and typ = sch[:type]
+                  "is not a valid #{typ}"
+                else
+                  "is a string"
+                end
+              end
+              o.errors.add(a, message)
+            end
+          end
+        end
+    
+        # Validates whether an attribute is a number.
+        #
+        # Possible Options:
+        # * :message - The message to use (default: 'is not a number')
+        # * :only_integer - Whether only integers are valid values (default: false)
+        def validates_numericality_of(*atts)
+          opts = {
+            :message => 'is not a number',
+            :tag => :numericality,
+          }.merge!(extract_options!(atts))
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            begin
+              if opts[:only_integer]
+                Kernel.Integer(v.to_s)
+              else
+                Kernel.Float(v.to_s)
+              end
+            rescue
+              o.errors.add(a, opts[:message])
+            end
+          end
+        end
+    
+        # Validates the presence of an attribute.  Requires the value not be blank,
+        # with false considered present instead of absent.
+        #
+        # Possible Options:
+        # * :message - The message to use (default: 'is not present')
+        def validates_presence_of(*atts)
+          opts = {
+            :message => 'is not present',
+            :tag => :presence,
+          }.merge!(extract_options!(atts))
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            o.errors.add(a, opts[:message]) if v.blank? && v != false
+          end
+        end
+        
+        # Validates that an attribute is within a specified range or set of values.
+        #
+        # Possible Options:
+        # * :in - An array or range of values to check for validity (required)
+        # * :message - The message to use (default: 'is not in range or set: <specified range>')
+        def validates_inclusion_of(*atts)
+          opts = extract_options!(atts)
+          unless opts[:in] && opts[:in].respond_to?(:include?) 
+            raise ArgumentError, "The :in parameter is required, and respond to include?"
+          end
+          opts[:message] ||= "is not in range or set: #{opts[:in].inspect}"
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            o.errors.add(a, opts[:message]) unless opts[:in].include?(v)
+          end
+        end
+    
+        # Validates only if the fields in the model (specified by atts) are
+        # unique in the database.  Pass an array of fields instead of multiple
+        # fields to specify that the combination of fields must be unique,
+        # instead of that each field should have a unique value.
+        #
+        # This means that the code:
+        #   validates_uniqueness_of([:column1, :column2])
+        # validates the grouping of column1 and column2 while
+        #   validates_uniqueness_of(:column1, :column2)
+        # validates them separately.
+        #
+        # You should also add a unique index in the
+        # database, as this suffers from a fairly obvious race condition.
+        #
+        # Possible Options:
+        # * :message - The message to use (default: 'is already taken')
+        def validates_uniqueness_of(*atts)
+          opts = {
+            :message => 'is already taken',
+            :tag => :uniqueness,
+          }.merge!(extract_options!(atts))
+    
+          atts << opts
+          validates_each(*atts) do |o, a, v|
+            error_field = a
+            a = Array(a)
+            v = Array(v)
+            ds = o.class.filter(a.zip(v))
+            num_dups = ds.count
+            allow = if num_dups == 0
+              # No unique value in the database
+              true
+            elsif num_dups > 1
+              # Multiple "unique" values in the database!!
+              # Someone didn't add a unique index
+              false
+            elsif o.new?
+              # New record, but unique value already exists in the database
+              false
+            elsif ds.first === o
+              # Unique value exists in database, but for the same record, so the update won't cause a duplicate record
+              true
+            else
+              false
+            end
+            o.errors.add(error_field, opts[:message]) unless allow
+          end
+        end
+    
+        # Returns the validations hash for the class.
+        def validations
+          @validations ||= Hash.new {|h, k| h[k] = []}
+        end
+        
+        private
+    
+        # Removes and returns the last member of the array if it is a hash. Otherwise,
+        # an empty hash is returned This method is useful when writing methods that
+        # take an options hash as the last parameter.
+        def extract_options!(array)
+          array.last.is_a?(Hash) ? array.pop : {}
+        end
+
+        # Handle the :if option for validations
+        def validation_if_proc(o, i)
+          case i
+          when Symbol then o.send(i)
+          when Proc then o.instance_eval(&i)
+          when nil then true
+          else raise(::Sequel::Error, "invalid value for :if validation option")
+          end
+        end
+      end
+    
+      module InstanceMethods
+        # Validates the object.
+        def validate
+          model.validate(self)
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/validation_helpers.rb

@@ -0,0 +1,150 @@
+module Sequel
+  module Plugins
+    module ValidationHelpers
+      # ValidationHelpers contains instance method equivalents for most of the previous
+      # default validations.  The names and APIs have changed, though.  
+      #
+      # The validates_unique validation has a unique API, but the other validations have
+      # the API explained here:
+      #
+      # Arguments:
+      # * atts - Single attribute symbol or an array of attribute symbols specifying the
+      #   attribute(s) to validate.
+      # Options:
+      # * :allow_blank - Whether to skip the validation if the value is blank.  You should
+      #   make sure all objects respond to blank if you use this option, which you can do by
+      #   requiring 'sequel/extensions/blank'
+      # * :allow_missing - Whether to skip the validation if the attribute isn't a key in the
+      #   values hash.  This is different from allow_nil, because Sequel only sends the attributes
+      #   in the values when doing an insert or update.  If the attribute is not present, Sequel
+      #   doesn't specify it, so the database will use the table's default value.  This is different
+      #   from having an attribute in values with a value of nil, which Sequel will send as NULL.
+      #   If your database table has a non NULL default, this may be a good option to use.  You
+      #   don't want to use allow_nil, because if the attribute is in values but has a value nil,
+      #   Sequel will attempt to insert a NULL value into the database, instead of using the
+      #   database's default.
+      # * :allow_nil - Whether to skip the validation if the value is nil.
+      # * :message - The message to use
+      module InstanceMethods 
+        # Check that the attribute values are the given exact length.
+        def validates_exact_length(exact, atts, opts={})
+          validatable_attributes(atts, opts){|a,v,m| (m || "is not #{exact} characters") unless v && v.length == exact}
+        end
+
+        # Check the string representation of the attribute value(s) against the regular expression with.
+        def validates_format(with, atts, opts={})
+          validatable_attributes(atts, opts){|a,v,m| (m || 'is invalid') unless v.to_s =~ with}
+        end
+    
+        # Check attribute value(s) is included in the given set.
+        def validates_includes(set, atts, opts={})
+          validatable_attributes(atts, opts){|a,v,m| (m || "is not in range or set: #{set.inspect}") unless set.include?(v)}
+        end
+    
+        # Check attribute value(s) string representation is a valid integer.
+        def validates_integer(atts, opts={})
+          validatable_attributes(atts, opts) do |a,v,m|
+            begin
+              Kernel.Integer(v.to_s)
+              nil
+            rescue
+              m || 'is not a number'
+            end
+          end
+        end
+
+        # Check that the attribute values length is in the specified range.
+        def validates_length_range(range, atts, opts={})
+          validatable_attributes(atts, opts){|a,v,m| (m || "is outside the allowed range") unless v && range.include?(v.length)}
+        end
+    
+        # Check that the attribute values are not longer than the given max length.
+        def validates_max_length(max, atts, opts={})
+          validatable_attributes(atts, opts){|a,v,m| (m || "is longer than #{max} characters") unless v && v.length <= max}
+        end
+
+        # Check that the attribute values are not shorter than the given min length.
+        def validates_min_length(min, atts, opts={})
+          validatable_attributes(atts, opts){|a,v,m| (m || "is shorter than #{min} characters") unless v && v.length >= min}
+        end
+
+        # Check that the attribute value(s) is not a string.  This is generally useful
+        # in conjunction with raise_on_typecast_failure = false, where you are
+        # passing in string values for non-string attributes (such as numbers and dates).
+        # If typecasting fails (invalid number or date), the value of the attribute will
+        # be a string in an invalid format, and if typecasting succeeds, the value will
+        # not be a string.
+        def validates_not_string(atts, opts={})
+          validatable_attributes(atts, opts) do |a,v,m|
+            next unless v.is_a?(String)
+            next m if m
+            (sch = db_schema[a] and typ = sch[:type]) ?  "is not a valid #{typ}" : "is a string"
+          end
+        end
+    
+        # Check attribute value(s) string representation is a valid float.
+        def validates_numeric(atts, opts={})
+          validatable_attributes(atts, opts) do |a,v,m|
+            begin
+              Kernel.Float(v.to_s)
+              nil
+            rescue
+              m || 'is not a number'
+            end
+          end
+        end
+    
+        # Check attribute value(s) is not considered blank by the database, but allow false values.
+        def validates_presence(atts, opts={})
+          validatable_attributes(atts, opts){|a,v,m| (m || "is not present") if model.db.send(:blank_object?, v) && v != false}
+        end
+        
+        # Checks that there are no duplicate values in the database for the given
+        # attributes.  Pass an array of fields instead of multiple
+        # fields to specify that the combination of fields must be unique,
+        # instead of that each field should have a unique value.
+        #
+        # This means that the code:
+        #   validates_unique([:column1, :column2])
+        # validates the grouping of column1 and column2 while
+        #   validates_unique(:column1, :column2)
+        # validates them separately.
+        #
+        # You should also add a unique index in the
+        # database, as this suffers from a fairly obvious race condition.
+        #
+        # This validation does not respect the :allow_* options that the other validations accept,
+        # since it can deals with multiple attributes at once.
+        #
+        # Possible Options:
+        # * :message - The message to use (default: 'is already taken')
+        def validates_unique(*atts)
+          message = (atts.pop[:message] if atts.last.is_a?(Hash)) || 'is already taken'
+          atts.each do |a|
+            ds = model.filter(Array(a).map{|x| [x, send(x)]})
+            errors.add(a, message) unless (new? ? ds : ds.exclude(pk_hash)).count == 0
+          end
+        end
+        
+        private
+
+        # Skip validating any attribute that matches one of the allow_* options.
+        # Otherwise, yield the attribute, value, and passed option :message to
+        # the block.  If the block returns anything except nil or false, add it as
+        # an error message for that attributes.
+        def validatable_attributes(atts, opts)
+          am, an, ab, m = opts.values_at(:allow_missing, :allow_nil, :allow_blank, :message)
+          Array(atts).each do |a|
+            next if am && !values.has_key?(a)
+            v = send(a)
+            next if an && v.nil?
+            next if ab && v.respond_to?(:blank?) && v.blank?
+            if message = yield(a, v, m)
+              errors.add(a, message)
+            end
+          end
+        end
+      end
+    end
+  end
+end