sequel 4.49.0 → 5.3.0

data/lib/sequel/plugins/timestamps.rb

@@ -15,11 +15,11 @@ module Sequel
     #   Sequel::Model.plugin :timestamps
     #
     #   # Timestamp Album instances, with custom column names
-    #   Album.plugin :timestamps, :create=>:created_on, :update=>:updated_on
+    #   Album.plugin :timestamps, create: :created_on, update: :updated_on
     #
     #   # Timestamp Artist instances, forcing an overwrite of the create
     #   # timestamp, and setting the update timestamp when creating
-    #   Album.plugin :timestamps, :force=>true, :update_on_create=>true
+    #   Album.plugin :timestamps, force: true, update_on_create: true
     module Timestamps
       # Configure the plugin by setting the available options.  Note that
       # if this method is run more than once, previous settings are ignored,
@@ -30,7 +30,7 @@ module Sequel
       # :update :: The field to hold the update timestamp (default: :updated_at)
       # :update_on_create :: Whether to set the update timestamp to the create timestamp when creating (default: false)
       def self.configure(model, opts=OPTS)
-        model.instance_eval do
+        model.instance_exec do
           @allow_manual_timestamp_update = opts[:allow_manual_update]||false
           @create_timestamp_field = opts[:create]||:created_at
           @update_timestamp_field = opts[:update]||:updated_at
@@ -58,7 +58,6 @@ module Sequel
           :@set_update_timestamp_on_create=>nil,
           :@update_timestamp_field=>nil)
         
-        
         # Whether to allow manual setting of the update timestamp when creating
         def allow_manual_timestamp_update?
           @allow_manual_timestamp_update
@@ -77,14 +76,14 @@ module Sequel
           super
         end
         
-        private
-        
         # Set the create timestamp when creating
-        def _before_validation
+        def before_validation
           set_create_timestamp if new?
           super
         end
         
+        private
+
         # If the object has accessor methods for the create timestamp field, and
         # the create timestamp value is nil or overwriting it is allowed, set the
         # create timestamp field to the time given or the current time.  If setting

data/lib/sequel/plugins/touch.rb

@@ -22,17 +22,13 @@ module Sequel
     #   Sequel::Model.plugin :touch
     #
     #   # Allow touching of Album instances, with a custom column
-    #   Album.plugin :touch, :column=>:updated_on
+    #   Album.plugin :touch, column: :updated_on
     #
     #   # Allow touching of Artist instances, updating the albums and tags
     #   # associations when touching, touching the +updated_on+ column for
     #   # albums and the +updated_at+ column for tags
-    #   Artist.plugin :touch, :associations=>[{:albums=>:updated_on}, :tags]
+    #   Artist.plugin :touch, associations: [{albums: :updated_on}, :tags]
     module Touch
-      # The default column to update when touching
-      TOUCH_COLUMN_DEFAULT = :updated_at
-      Sequel::Deprecation.deprecate_constant(self, :TOUCH_COLUMN_DEFAULT)
-
       def self.apply(model, opts=OPTS)
         model.instance_variable_set(:@touched_associations, {})
       end
@@ -131,13 +127,13 @@ module Sequel
           model.touched_associations.each do |assoc, column|
             r = model.association_reflection(assoc)
             next unless r.can_have_associated_objects?(self)
-            ds = send(r.dataset_method)
+            ds = public_send(r[:dataset_method])
 
             if ds.send(:joined_dataset?)
               # Can't update all values at once, so update each instance individually.
               # Instead if doing a simple save, update via the instance's dataset,
               # to avoid going into an infinite loop in some cases.
-              send(assoc).each{|x| x.this.update(column=>touch_association_value)}
+              public_send(assoc).each{|x| x.this.update(column=>touch_association_value)}
             else
               # Update all values at once for performance reasons.
               ds.update(column=>touch_association_value)

data/lib/sequel/plugins/tree.rb

@@ -2,7 +2,7 @@
 
 module Sequel
   module Plugins
-    # The Tree plugin adds additional associations and methods that allow you to 
+    # The tree plugin adds additional associations and methods that allow you to 
     # treat a Model as a tree.  
     #
     # A column for holding the parent key is required and is :parent_id by default.  
@@ -21,7 +21,7 @@ module Sequel
     #   end
     #  
     #   class Node < Sequel::Model
-    #     plugin :tree, :key=>:parentid, :order=>:position
+    #     plugin :tree, key: :parentid, order: :position
     #   end
     module Tree
       # Create parent and children associations.  Any options
@@ -33,7 +33,7 @@ module Sequel
         opts = opts.dup
         opts[:class] = model
 
-        model.instance_eval do
+        model.instance_exec do
           @parent_column = (opts[:key] ||= :parent_id)
           @tree_order = opts[:order]
         end

data/lib/sequel/plugins/typecast_on_load.rb

@@ -2,7 +2,7 @@
 
 module Sequel
   module Plugins
-    # The TypecastOnLoad plugin exists because most of Sequel's database adapters don't
+    # The typecast_on_load plugin exists because most of Sequel's database adapters don't
     # have complete control over typecasting, and may return columns that aren't
     # typecast correctly (with correct being defined as how the model object
     # would typecast the same column values).
@@ -23,7 +23,7 @@ module Sequel
     module TypecastOnLoad
       # Call add_typecast_on_load_columns on the passed column arguments.
       def self.configure(model, *columns)
-        model.instance_eval do
+        model.instance_exec do
           @typecast_on_load_columns ||= []
           add_typecast_on_load_columns(*columns)
         end

data/lib/sequel/plugins/unlimited_update.rb

@@ -4,13 +4,7 @@ module Sequel
   module Plugins
     # The unlimited_update plugin is designed to work around a
     # MySQL warning in replicated environments, which occurs if
-    # you issue an UPDATE with a LIMIT clause.  No other
-    # database Sequel supports will create an UPDATE clause with
-    # a LIMIT, and in non-replicated MySQL environments, MySQL
-    # doesn't issue a warning.  Note that even in replicated
-    # environments the MySQL warning is harmless, as Sequel
-    # restricts an update to rows with a matching primary key,
-    # which should be unique.
+    # you issue an UPDATE with a LIMIT clause.
     #
     # Usage:
     #

data/lib/sequel/plugins/update_or_create.rb

@@ -2,21 +2,21 @@
 
 module Sequel
   module Plugins
-    # The update_or_create plugin adds a couple of methods that make it easier
+    # The update_or_create plugin adds methods that make it easier
     # to deal with objects which may or may not yet exist in the database.
     # The first method is update_or_create, which updates an object if it
     # exists in the database, or creates the object if it does not.
     #
     # You can call update_or_create with a block:
     #
-    #   Album.update_or_create(:name=>'Hello') do |album|
+    #   Album.update_or_create(name: 'Hello') do |album|
     #     album.num_copies_sold = 1000
     #   end
     #
     # or provide two hashes, with the second one being the attributes
     # to set.
     #
-    #   Album.update_or_create({:name=>'Hello'}, {:num_copies_sold=>1000})
+    #   Album.update_or_create({name: 'Hello'}, num_copies_sold: 1000)
     #
     # In both cases, this will check the database to find the album with
     # the name "Hello". If such an album exists, it will be updated to set

data/lib/sequel/plugins/update_refresh.rb

@@ -30,15 +30,15 @@ module Sequel
     # dataset supports RETURNING.
     #
     #   # Only include the artist column in RETURNING
-    #   Album.plugin :update_refresh, :columns => :artist
+    #   Album.plugin :update_refresh, columns: :artist
     #
     #   # Only include the artist and title columns in RETURNING
-    #   Album.plugin :update_refresh, :columns => [ :artist, :title ]
+    #   Album.plugin :update_refresh, columns: [:artist, :title]
     module UpdateRefresh
       # Set the specific columns to refresh, if the :columns option
       # is provided.
       def self.configure(model, opts=OPTS)
-        model.instance_eval do
+        model.instance_exec do
           @update_refresh_columns = Array(opts[:columns]) || []
         end
       end

data/lib/sequel/plugins/uuid.rb

@@ -5,10 +5,7 @@ require 'securerandom'
 module Sequel
   module Plugins
     # The uuid plugin creates hooks that automatically create a uuid for every
-    # instance.  Note that this uses SecureRandom.uuid to create UUIDs, and
-    # that method is not defined on ruby 1.8.7.  If you would like to use this
-    # on ruby 1.8.7, you need to override the Model#create_uuid private method
-    # to return a valid uuid.
+    # instance.
     # 
     # Usage:
     #
@@ -17,7 +14,7 @@ module Sequel
     #   Sequel::Model.plugin :uuid
     #
     #   # Uuid Album instances, with custom column name
-    #   Album.plugin :uuid, :field=>my_uuid
+    #   Album.plugin :uuid, field: :my_uuid
     module Uuid
       # Configure the plugin by setting the available options.  Note that
       # if this method is run more than once, previous settings are ignored,
@@ -25,7 +22,7 @@ module Sequel
       # :field :: The field to hold the uuid (default: :uuid)
       # :force :: Whether to overwrite an existing uuid (default: false)
       def self.configure(model, opts=OPTS)
-        model.instance_eval do
+        model.instance_exec do
           @uuid_field = opts[:field]||:uuid
           @uuid_overwrite = opts[:force]||false
         end
@@ -44,17 +41,16 @@ module Sequel
       end
 
       module InstanceMethods
-        private
-        
         # Set the uuid when creating
-        def _before_validation
+        def before_validation
           set_uuid if new?
           super
         end
 
+        private
+        
         # Create a new UUID.  This method can be overridden to use a separate
-        # method for creating UUIDs.  Note that this method does not work on
-        # ruby 1.8.7, you will have to override it if you are using ruby 1.8.7.
+        # method for creating UUIDs.
         def create_uuid
           SecureRandom.uuid
         end

data/lib/sequel/plugins/validation_class_methods.rb

@@ -56,7 +56,7 @@ module Sequel
           # Initializes a new generator.
           def initialize(receiver ,&block)
             @receiver = receiver
-            instance_eval(&block)
+            instance_exec(&block)
           end
       
           # Delegates method calls to the receiver by calling receiver.validates_xxx.
@@ -97,15 +97,16 @@ module Sequel
         #
         #   class MyClass < Sequel::Model
         #     validates do
-        #       length_of :name, :minimum => 6
-        #       length_of :password, :minimum => 8
+        #       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
+        #     validates_length_of :name, minimum: 6
+        #     validates_length_of :password, minimum: 8
         #   end
         def validates(&block)
           Generator.new(self, &block)
@@ -187,7 +188,7 @@ module Sequel
         #                   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)
+        # :if :: A symbol (indicating an instance_method) or proc (which is instance_execed)
         #        skipping this validation if it returns nil or false.
         # :tag :: The tag to use for this validation.
         def validates_each(*atts, &block)
@@ -273,7 +274,7 @@ module Sequel
               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.send(w.respond_to?(:cover?) ? :cover? : :include?, v.size)
+              o.errors.add(a, opts[:message] || opts[:wrong_length]) unless v && w.public_send(w.respond_to?(:cover?) ? :cover? : :include?, v.size)
             end
           end
         end
@@ -335,7 +336,7 @@ module Sequel
           reflect_validation(:inclusion, opts, atts)
           atts << opts
           validates_each(*atts) do |o, a, v|
-            o.errors.add(a, opts[:message]) unless n.send(n.respond_to?(:cover?) ? :cover? : :include?, v)
+            o.errors.add(a, opts[:message]) unless n.public_send(n.respond_to?(:cover?) ? :cover? : :include?, v)
           end
         end
     
@@ -434,7 +435,7 @@ module Sequel
           when Symbol
             o.get_column_value(i)
           when Proc
-            o.instance_eval(&i)
+            o.instance_exec(&i)
           else
             raise(::Sequel::Error, "invalid value for :if validation option")
           end

data/lib/sequel/plugins/validation_contexts.rb

@@ -15,11 +15,11 @@ module Sequel
     #     end
     #   end
     #
-    #   Album.new(:status_id=>1).valid?(:validation_context=>:initial) # => true
-    #   Album.new(:status_id=>2).valid?(:validation_context=>:initial) # => false
+    #   Album.new(status_id: 1).valid?(validation_context: :initial) # => true
+    #   Album.new(status_id: 2).valid?(validation_context: :initial) # => false
     #
-    #   Album.new(:status_id=>1).valid?(:validation_context=>:approve) # => false
-    #   Album.new(:status_id=>2).valid?(:validation_context=>:approve) # => true
+    #   Album.new(status_id: 1).valid?(validation_context: :approve) # => false
+    #   Album.new(status_id: 2).valid?(validation_context: :approve) # => true
     #
     # There is no validation context used by default, so validation_context will be
     # +nil+ if one is not specified.  If you want to differentiate between creating new

data/lib/sequel/plugins/validation_helpers.rb

@@ -38,17 +38,24 @@ module Sequel
     #             that argument is passed as an argument to the proc.
     #
     # The default validation options for all models can be modified by
-    # changing the values of the Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS hash.  You
-    # change change the default options on a per model basis
-    # by overriding a private instance method default_validation_helpers_options.
-    #
+    # overridding the Model#default_validation_helpers_options private method.
     # By changing the default options, you can setup internationalization of the
     # error messages.  For example, you would modify the default options:
     #
-    #   Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
-    #     :exact_length=>{:message=>lambda{|exact| I18n.t("errors.exact_length", :exact => exact)}},
-    #     :integer=>{:message=>lambda{I18n.t("errors.integer")}}
-    #   )
+    #   class Sequel::Model
+    #     private
+    #
+    #     def default_validation_helpers_options(type)
+    #       case type
+    #       when :exact_length
+    #         {message: lambda{|exact| I18n.t("errors.exact_length", exact: exact)}}
+    #       when :integer
+    #         {message: lambda{I18n.t("errors.integer")}}
+    #       else
+    #         super
+    #       end
+    #     end
+    #   end
     #
     # and then use something like this in your yaml translation file:
     #
@@ -61,20 +68,16 @@ module Sequel
     # you need to override the method.  Here's an example:
     #   
     #   class Sequel::Model::Errors
-    #     ATTRIBUTE_JOINER = I18n.t('errors.joiner').freeze
     #     def full_messages
     #       inject([]) do |m, kv|
     #         att, errors = *kv
     #         att.is_a?(Array) ? Array(att).map!{|v| I18n.t("attributes.#{v}")} : att = I18n.t("attributes.#{att}")
-    #         errors.each {|e| m << (e.is_a?(LiteralString) ? e : "#{Array(att).join(ATTRIBUTE_JOINER)} #{e}")}
+    #         errors.each {|e| m << (e.is_a?(LiteralString) ? e : "#{Array(att).join(I18n.t('errors.joiner'))} #{e}")}
     #         m
     #       end
     #     end
     #   end
     module ValidationHelpers
-      # Default validation options used by Sequel.  Can be modified to change the error
-      # messages for all models (e.g. for internationalization), or to set certain
-      # default options for validations (e.g. :allow_nil=>true for all validates_format).
       DEFAULT_OPTIONS = {
         :exact_length=>{:message=>lambda{|exact| "is not #{exact} characters"}},
         :format=>{:message=>lambda{|with| 'is invalid'}},
@@ -89,9 +92,8 @@ module Sequel
         :type=>{:message=>lambda{|klass| klass.is_a?(Array) ? "is not a valid #{klass.join(" or ").downcase}" : "is not a valid #{klass.to_s.downcase}"}},
         :presence=>{:message=>lambda{"is not present"}},
         :unique=>{:message=>lambda{'is already taken'}}
-      }
-      DEFAULT__OPTIONS = DEFAULT_OPTIONS
-      Sequel::Deprecation.deprecate_constant(self, :DEFAULT_OPTIONS)
+      }.freeze
+      DEFAULT_OPTIONS.each_value(&:freeze)
 
       module InstanceMethods 
         # Check that the attribute values are the given exact length.
@@ -106,7 +108,7 @@ module Sequel
     
         # Check attribute value(s) is included in the given set.
         def validates_includes(set, atts, opts=OPTS)
-          validatable_attributes_for_type(:includes, atts, opts){|a,v,m| validation_error_message(m, set) unless set.send(set.respond_to?(:cover?) ? :cover? : :include?, v)}
+          validatable_attributes_for_type(:includes, atts, opts){|a,v,m| validation_error_message(m, set) unless set.public_send(set.respond_to?(:cover?) ? :cover? : :include?, v)}
         end
     
         # Check attribute value(s) string representation is a valid integer.
@@ -123,7 +125,7 @@ module Sequel
 
         # Check that the attribute values length is in the specified range.
         def validates_length_range(range, atts, opts=OPTS)
-          validatable_attributes_for_type(:length_range, atts, opts){|a,v,m| validation_error_message(m, range) if v.nil? || !range.send(range.respond_to?(:cover?) ? :cover? : :include?, v.length)}
+          validatable_attributes_for_type(:length_range, atts, opts){|a,v,m| validation_error_message(m, range) if v.nil? || !range.cover?(v.length)}
         end
     
         # Check that the attribute values are not longer than the given max length.
@@ -165,7 +167,7 @@ module Sequel
         # Check attribute value(s) against a specified value and operation, e.g.
         # validates_operator(:>, 3, :value) validates that value > 3.
         def validates_operator(operator, rhs, atts, opts=OPTS)
-          validatable_attributes_for_type(:operator, atts, opts){|a,v,m| validation_error_message(m, operator, rhs) if v.nil? || !v.send(operator, rhs)}
+          validatable_attributes_for_type(:operator, atts, opts){|a,v,m| validation_error_message(m, operator, rhs) if v.nil? || !v.public_send(operator, rhs)}
         end
 
         # Validates for all of the model columns (or just the given columns)
@@ -223,7 +225,7 @@ module Sequel
         #             model's dataset.
         # :message :: The message to use (default: 'is already taken')
         # :only_if_modified :: Only check the uniqueness if the object is new or
-        #                      one of the columns has been modified.
+        #                      one of the columns has been modified, true by default.
         # :where :: A callable object where call takes three arguments, a dataset,
         #           the current object, and an array of columns, and should return
         #           a modified dataset that is filtered to include only rows with
@@ -232,9 +234,9 @@ module Sequel
         # If you want to do a case insensitive uniqueness validation on a database that
         # is case sensitive by default, you can use:
         #
-        #   validates_unique :column, :where=>(proc do |ds, obj, cols|
+        #   validates_unique :column, where:(lambda do |ds, obj, cols|
         #     ds.where(cols.map do |c|
-        #       v = obj.send(c)
+        #       v = obj.public_send(c)
         #       v = v.downcase if v
         #       [Sequel.function(:lower, c), v]
         #     end)
@@ -250,8 +252,7 @@ module Sequel
           atts.each do |a|
             arr = Array(a)
             next if arr.any?{|x| errors.on(x)}
-            # SEQUEL5: Default only_if_modified to true
-            next if opts[:only_if_modified] && !new? && !arr.any?{|x| changed_columns.include?(x)}
+            next if opts.fetch(:only_if_modified, true) && !new? && !arr.any?{|x| changed_columns.include?(x)}
             ds = opts[:dataset] || model.dataset
             ds = if where
               where.call(ds, self, arr)
@@ -276,7 +277,7 @@ module Sequel
         # The hash return must include a :message option that is either a
         # proc or string.
         def default_validation_helpers_options(type)
-          DEFAULT__OPTIONS[type]
+          DEFAULT_OPTIONS[type]
         end
 
         # Skip validating any attribute that matches one of the allow_* options.

data/lib/sequel/plugins/whitelist_security.rb

@@ -34,12 +34,12 @@ module Sequel
         # setter methods (methods that end in =) that you want to be used during
         # mass assignment, they need to be listed here as well (without the =).
         #
-        # It may be better to use a method such as +set_only+ or +set_fields+ that lets you specify
+        # It may be better to use +set_fields+ which lets you specify
         # the allowed fields per call.
         #
         #   Artist.set_allowed_columns(:name, :hometown)
-        #   Artist.set(:name=>'Bob', :hometown=>'Sactown') # No Error
-        #   Artist.set(:name=>'Bob', :records_sold=>30000) # Error
+        #   Artist.set(name: 'Bob', hometown: 'Sactown') # No Error
+        #   Artist.set(name: 'Bob', records_sold: 30000) # Error
         def set_allowed_columns(*cols)
           clear_setter_methods_cache
           @allowed_columns = cols
@@ -62,7 +62,7 @@ module Sequel
         # allowed_columns in the model.
         #
         #   Artist.set_allowed_columns(:num_albums)
-        #   artist.set_all(:name=>'Jim')
+        #   artist.set_all(name: 'Jim')
         #   artist.name # => 'Jim'
         def set_all(hash)
           set_restricted(hash, :all)
@@ -72,10 +72,10 @@ module Sequel
         # is included in only.  It may be a better idea to use +set_fields+
         # instead of this method.
         #
-        #   artist.set_only({:name=>'Jim'}, :name)
+        #   artist.set_only({name: 'Jim'}, :name)
         #   artist.name # => 'Jim'
         #
-        #   artist.set_only({:hometown=>'LA'}, :name) # Raise Error
+        #   artist.set_only({hometown: 'LA'}, :name) # Raise Error
         def set_only(hash, *only)
           set_restricted(hash, only.flatten)
         end
@@ -84,7 +84,7 @@ module Sequel
         # +allowed_columns+ in the model.
         #
         #   Artist.set_allowed_columns(:num_albums)
-        #   artist.update_all(:name=>'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)
+        #   artist.update_all(name: 'Jim') # UPDATE artists SET name = 'Jim' WHERE (id = 1)
         def update_all(hash)
           update_restricted(hash, :all)
         end
@@ -93,10 +93,10 @@ module Sequel
         # is included in only.  It may be a better idea to use +update_fields+
         # instead of this method.
         #
-        #   artist.update_only({:name=>'Jim'}, :name)
+        #   artist.update_only({name: 'Jim'}, :name)
         #   # UPDATE artists SET name = 'Jim' WHERE (id = 1)
         #
-        #   artist.update_only({:hometown=>'LA'}, :name) # Raise Error
+        #   artist.update_only({hometown: 'LA'}, :name) # Raise Error
         def update_only(hash, *only)
           update_restricted(hash, only.flatten)
         end
@@ -107,6 +107,10 @@ module Sequel
         def setter_methods(type)
           if type == :default && model.allowed_columns
             model.setter_methods
+          elsif type.is_a?(Array)
+            type.map{|x| "#{x}="}
+          elsif type == :all && primary_key && model.restrict_primary_key?
+            super + Array(primary_key).map{|x| "#{x}="}
           else
             super
           end