sequel 4.49.0 → 5.0.0

data/lib/sequel/plugins/constraint_validations.rb

@@ -19,7 +19,7 @@ module Sequel
     #
     # Then when you went to save an album that uses this plugin:
     #
-    #   Album.create(:name=>'abc')
+    #   Album.create(name: 'abc')
     #   # raises Sequel::ValidationFailed: name is shorter than 5 characters
     # 
     # Usage:
@@ -39,7 +39,7 @@ module Sequel
 
       # Automatically load the validation_helpers plugin to run the actual validations.
       def self.apply(model, opts=OPTS)
-        model.instance_eval do
+        model.instance_exec do
           plugin :validation_helpers
           @constraint_validations_table = DEFAULT_CONSTRAINT_VALIDATIONS_TABLE
           @constraint_validation_options = {}
@@ -56,7 +56,7 @@ module Sequel
       #                        :presence) and values should be hashes of options specific
       #                        to that validation type.
       def self.configure(model, opts=OPTS)
-        model.instance_eval do
+        model.instance_exec do
           if table = opts[:constraint_validations_table]
             @constraint_validations_table = table
           end
@@ -240,6 +240,7 @@ module Sequel
         def validate
           super
           model.constraint_validations.each do |v|
+            # Allow calling private validation methods
             send(*v)
           end
         end

data/lib/sequel/plugins/csv_serializer.rb

@@ -1,42 +1,35 @@
 # frozen-string-literal: true
 
-if RUBY_VERSION < "1.9"
-  # :nocov:
-  require 'fastercsv'
-  # :nocov:
-else
-  require 'csv'
-end
+require 'csv'
 
 module Sequel
   module Plugins
     # csv_serializer handles serializing entire Sequel::Model objects to CSV,
     # as well as support for deserializing CSV directly into Sequel::Model
-    # objects.  It requires either the csv standard library when usnig ruby 1.9+,
-    # or the fastercsv gem when using ruby 1.8.
+    # objects.  It requires the csv standard library.
     #
     # Basic Example:
     #
     #   album = Album[1]
-    #   album.to_csv(:write_headers=>true)
+    #   album.to_csv(write_headers: true)
     #   # => "id,name,artist_id\n1,RF,2\n"
     #
     # You can provide options to control the CSV output:
     #
-    #   album.to_csv(:only=>:name)
-    #   album.to_csv(:except=>[:id, :artist_id])
+    #   album.to_csv(only: :name)
+    #   album.to_csv(except: [:id, :artist_id])
     #   # => "RF\n"
     #
     # +to_csv+ also exists as a class and dataset method, both of which return
     # all objects in the dataset:
     #
     #   Album.to_csv
-    #   Album.where(:artist_id=>1).to_csv
+    #   Album.where(artist_id: 1).to_csv
     #
-    # If you have an existing array of model instance you want to convert to
+    # If you have an existing array of model instances you want to convert to
     # CSV, you can call the class to_csv method with the :array option:
     #
-    #   Album.to_csv(:array=>[Album[1], Album[2]])
+    #   Album.to_csv(array: [Album[1], Album[2]])
     #
     # In addition to creating CSV, this plugin also enables Sequel::Model
     # classes to create instances directly from CSV using the from_csv class
@@ -48,7 +41,7 @@ module Sequel
     # The array_from_csv class method exists to parse arrays of model instances
     # from CSV:
     #
-    #   csv = Album.where(:artist_id=>1).to_csv
+    #   csv = Album.where(artist_id: 1).to_csv
     #   albums = Album.array_from_csv(csv)
     #
     # These do not necessarily round trip, since doing so would let users
@@ -56,7 +49,7 @@ module Sequel
     # call set with the values in the hash.  If you want to specify the allowed
     # fields, you can use the :headers option.
     #
-    #   Album.from_csv(album.to_csv, :headers=>%w'id name')
+    #   Album.from_csv(album.to_csv, headers: %w'id name')
     #
     # If you want to update an existing instance, you can use the from_csv
     # instance method:
@@ -77,7 +70,7 @@ module Sequel
       # Set up the column readers to do deserialization and the column writers
       # to save the value in deserialized_values
       def self.configure(model, opts = OPTS)
-        model.instance_eval do
+        model.instance_exec do
           @csv_serializer_opts = (@csv_serializer_opts || OPTS).merge(opts)
         end
       end
@@ -155,7 +148,7 @@ module Sequel
           opts = model.process_csv_serializer_opts(opts)
 
           CSV.generate(opts) do |csv|
-            csv << opts[:headers].map{|k| send(k)}
+            csv << opts[:headers].map{|k| public_send(k)}
           end
         end
       end
@@ -174,7 +167,7 @@ module Sequel
 
           CSV.generate(opts) do |csv|
             items.each do |object|
-              csv << opts[:headers].map{|header| object.send(header) }
+              csv << opts[:headers].map{|header| object.public_send(header) }
             end
           end
         end

data/lib/sequel/plugins/dataset_associations.rb

@@ -12,7 +12,7 @@ module Sequel
     #     plugin :dataset_associations
     #     one_to_many :albums
     #   end
-    #   Artist.where(id=>1..100).albums
+    #   Artist.where(id: 1..100).albums
     #   # SELECT * FROM albums
     #   # WHERE (albums.artist_id IN (
     #   #   SELECT id FROM artists
@@ -27,7 +27,7 @@ module Sequel
     # As the dataset methods return datasets, you can easily chain the
     # methods to get associated datasets of associated datasets:
     #
-    #   Artist.where(id=>1..100).albums.where{name < 'M'}.tags
+    #   Artist.where(id: 1..100).albums.where{name < 'M'}.tags
     #   # SELECT tags.* FROM tags
     #   # WHERE (tags.id IN (
     #   #   SELECT albums_tags.tag_id FROM albums

data/lib/sequel/plugins/def_dataset_method.rb

@@ -6,7 +6,7 @@ module Sequel
     # for defining dataset methods:
     #
     #   Album.def_dataset_method(:by_name) do |name|
-    #     where(:name=>name)
+    #     where(name: name)
     #   end
     #
     # Additionally, this adds support for Model.subset, which can also
@@ -41,8 +41,8 @@ module Sequel
         #
         #   # Add new dataset method and class method that calls it
         #   Artist.def_dataset_method(:by_name){order(:name)}
-        #   Artist.where(:name.like('A%')).by_name
-        #   Artist.by_name.where(:name.like('A%'))
+        #   Artist.where(Sequel[:name].like('A%')).by_name
+        #   Artist.by_name.where(Sequel[:name].like('A%'))
         #
         #   # Just add a class method that calls an existing dataset method
         #   Artist.def_dataset_method(:paginate)
@@ -63,7 +63,7 @@ module Sequel
         # they can be chained.
         # For example:
         #
-        #   Topic.subset(:joes, :username.like('%joe%'))
+        #   Topic.subset(:joes, Sequel[:username].like('%joe%'))
         #   Topic.subset(:popular){num_posts > 100}
         #   Topic.subset(:recent){created_on > Date.today - 7}
         #
@@ -75,7 +75,7 @@ module Sequel
         # have more than 100 posts and were created less than
         # 7 days ago.
         #
-        # Both the args given and the block are passed to <tt>Dataset#filter</tt>.
+        # Both the args given and the block are passed to <tt>Dataset#where</tt>.
         #
         # This method creates dataset methods that do not accept arguments.  To create
         # dataset methods that accept arguments, you should use define a

data/lib/sequel/plugins/defaults_setter.rb

@@ -10,7 +10,7 @@ module Sequel
     #   album = Album.new
     #   album.a # => nil
     #   album.b # => 2
-    #   album = Album.new(:a=>1, :b=>3)
+    #   album = Album.new(a: 1, b: 3)
     #   album.a # => 1
     #   album.b # => 3
     #

data/lib/sequel/plugins/delay_add_association.rb

@@ -40,7 +40,7 @@ module Sequel
           if opts.dataset_need_primary_key? && new?
             o = make_add_associated_object(opts, o)
             delay_validate_associated_object(opts, o)
-            send(opts[:name]) << o
+            public_send(opts[:name]) << o
             after_create_hook{super(opts, o, *args)}
             o
           else

data/lib/sequel/plugins/finder.rb

@@ -7,7 +7,7 @@ module Sequel
     # that represents a model class method that returns a dataset:
     #
     #   def Artist.by_name(name)
-    #     where(:name=>name)
+    #     where(name: name)
     #   end
     #
     #   Artist.finder :by_name
@@ -18,7 +18,7 @@ module Sequel
     #
     # The alternative way to use this to pass your own block:
     #
-    #   Artist.finder(:name=>:first_by_name){|pl, ds| ds.where(:name=>pl.arg).limit(1)}
+    #   Artist.finder(name: :first_by_name){|pl, ds| ds.where(name: pl.arg).limit(1)}
     #
     # Additionally, there is a Model.prepared_finder method.  This works similarly
     # to Model.finder, but uses a prepared statement.  This limits the types of
@@ -50,7 +50,7 @@ module Sequel
         # that represents a model class method that returns a dataset:
         #
         #   def Artist.by_name(name)
-        #     where(:name=>name)
+        #     where(name: name)
         #   end
         #
         #   Artist.finder :by_name
@@ -61,7 +61,7 @@ module Sequel
         #
         # The alternative way to use this to pass your own block:
         #
-        #   Artist.finder(:name=>:first_by_name){|pl, ds| ds.where(:name=>pl.arg).limit(1)}
+        #   Artist.finder(name: :first_by_name){|pl, ds| ds.where(name: pl.arg).limit(1)}
         #
         # Note that if you pass your own block, you are responsible for manually setting
         # limits if necessary (as shown above).
@@ -86,7 +86,7 @@ module Sequel
         # This doesn't handle all possible cases.  For example, if you have a method such as:
         #
         #   def Artist.by_name(name)
-        #     name ? where(:name=>name) : exclude(:name=>nil)
+        #     name ? where(name: name) : exclude(name: nil)
         #   end
         #
         # Then calling a finder without an argument will not work as you expect.
@@ -128,7 +128,7 @@ module Sequel
               ds = if block
                 model.instance_exec(*args, &block)
               else
-                model.send(meth, *args)
+                model.public_send(meth, *args)
               end
               ds = ds.limit(1) if limit1
               model_name = model.name
@@ -144,7 +144,7 @@ module Sequel
               n = argn.call(model)
               block ||= lambda do |pl, model2|
                 args = (0...n).map{pl.arg}
-                ds = model2.send(meth, *args)
+                ds = model2.public_send(meth, *args)
                 ds = ds.limit(1) if limit1
                 ds
               end
@@ -154,7 +154,7 @@ module Sequel
           end
 
           @finder_loaders[meth_name] = loader_proc
-          mod = opts[:mod] || (class << self; self; end)
+          mod = opts[:mod] || singleton_class
           if prepare
             def_prepare_method(mod, meth_name)
           else
@@ -190,14 +190,14 @@ module Sequel
           finder(meth, opts, &block)
         end
 
-        Plugins.inherited_instance_variables(self, :@finders=>:dup, :@autoreloading_associations=>:hash_dup, :@default_association_options=>:dup, :@cache_associations=>nil, :@default_eager_limit_strategy=>nil)
+        Plugins.inherited_instance_variables(self, :@finders=>:dup, :@finder_loaders=>:dup)
 
         private
 
         # Define a finder method in the given module with the given method name that
         # load rows using the finder with the given name.
         def def_finder_method(mod, meth, type)
-          mod.send(:define_method, meth){|*args, &block| finder_for(meth).send(type, *args, &block)}
+          mod.send(:define_method, meth){|*args, &block| finder_for(meth).public_send(type, *args, &block)}
         end
 
         # Define a prepared_finder method in the given module that will call the associated prepared
@@ -234,6 +234,12 @@ module Sequel
             s
           end
         end
+
+        # Clear any finders when reseting the instance dataset
+        def reset_instance_dataset
+          Sequel.synchronize{@finders.clear} if @finders && !@finders.frozen?
+          super
+        end
       end
     end
   end

data/lib/sequel/plugins/force_encoding.rb

@@ -1,9 +1,8 @@
 # frozen-string-literal: true
 
-if RUBY_VERSION >= '1.9.0'
 module Sequel
   module Plugins
-    # The ForceEncoding plugin allows you force specific encodings for all
+    # The force_encoding plugin allows you force specific encodings for all
     # strings that are used by the model.  When model instances are loaded
     # from the database, all values in the hash that are strings are
     # forced to the given encoding.  Whenever you update a model column
@@ -77,8 +76,3 @@ module Sequel
     end
   end
 end
-else
-# :nocov:
-  raise LoadError, 'ForceEncoding plugin only works on Ruby 1.9+'
-# :nocov:
-end

data/lib/sequel/plugins/hook_class_methods.rb

@@ -31,14 +31,6 @@ module Sequel
     #   # Allow the use of hook class methods in the Album class
     #   Album.plugin :hook_class_methods
     module HookClassMethods
-      # SEQUEL5: Remove
-      DEPRECATION_REPLACEMENTS = {
-        :after_commit=>"Use after_save{db.after_commit{}} instead",
-        :after_destroy_commit=>"Use after_destroy{db.after_commit{}} instead",
-        :after_destroy_rollback=>"Use before_destroy{db.after_rollback{}} instead",
-        :after_rollback=>"Use before_save{db.after_rollback{}} instead"
-      }.freeze
-
       # Set up the hooks instance variable in the model.
       def self.apply(model)
         hooks = model.instance_variable_set(:@hooks, {})
@@ -49,52 +41,11 @@ module Sequel
         Model::HOOKS.each do |h|
           class_eval(<<-END, __FILE__, __LINE__ + 1)
             def #{h}(method = nil, &block)
-              #{"Sequel::Deprecation.deprecate('Sequel::Model.#{h} in the hook_class_methods plugin', #{DEPRECATION_REPLACEMENTS[h].inspect})" if DEPRECATION_REPLACEMENTS[h]}
               add_hook(:#{h}, method, &block)
             end
           END
         end
 
-        # This adds a new hook type. It will define both a class
-        # method that you can use to add hooks, as well as an instance method
-        # that you can use to call all hooks of that type.  The class method
-        # can be called with a symbol or a block or both.  If a block is given and
-        # and symbol is not, it adds the hook block to the hook type.  If a block
-        # and symbol are both given, it replaces the hook block associated with
-        # that symbol for a given hook type, or adds it if there is no hook block
-        # with that symbol for that hook type.  If no block is given, it assumes
-        # the symbol specifies an instance method to call and adds it to the hook
-        # type.
-        #
-        # If any before hook block returns false, the instance method will return false
-        # immediately without running the rest of the hooks of that type.
-        #
-        # It is recommended that you always provide a symbol to this method,
-        # for descriptive purposes.  It's only necessary to do so when you 
-        # are using a system that reloads code.
-        # 
-        # Example of usage:
-        #
-        #  class MyModel
-        #   add_hook_type :before_move_to
-        #   before_move_to(:check_move_allowed, &:allow_move?)
-        #   def move_to(there)
-        #     return if before_move_to == false
-        #     # move MyModel object to there
-        #   end
-        #  end
-        #
-        # Do not call this method with untrusted input, as that can result in
-        # arbitrary code execution.
-        def add_hook_type(*hooks)
-          Sequel::Deprecation.deprecate("Sequel::Model.add_hook_type", "You should add your own hook types manually")
-          hooks.each do |hook|
-            @hooks[hook] = []
-            instance_eval("def #{hook}(method = nil, &block); add_hook(:#{hook}, method, &block) end", __FILE__, __LINE__)
-            class_eval("def #{hook}; model.hook_blocks(:#{hook}){|b| return false if instance_eval(&b) == false} end", __FILE__, __LINE__)
-          end
-        end
-
         # Freeze hooks when freezing model class.
         def freeze
           @hooks.freeze.each_value(&:freeze)
@@ -121,7 +72,8 @@ module Sequel
         def add_hook(hook, tag, &block)
           unless block
             (raise Error, 'No hook method specified') unless tag
-            block = proc {send tag}
+            # Allow calling private hook methods
+            block = proc {send(tag)}
           end
           h = @hooks[hook]
           if tag && (old = h.find{|x| x[0] == tag})
@@ -137,63 +89,9 @@ module Sequel
       end
 
       module InstanceMethods
-        # SEQUEL5: Make :before_save, :before_destroy, :after_save, :after_destroy hooks use metaprogramming instead of specific definitions
-        [:before_create, :before_update, :before_validation].each do |h|
-          class_eval(<<-END, __FILE__, __LINE__+1)
-            def #{h}
-              model.hook_blocks(:#{h}) do |b|
-                if instance_eval(&b) == false
-                  Sequel::Deprecation.deprecate("Having #{h} hook block return false to stop evaluation of further #{h} hook blocks", "Instead, call cancel_action inside #{h} hook block")
-                  return false
-                end
-              end
-              super
-            end
-          END
-        end
-        [:after_create, :after_update, :after_validation].each{|h| class_eval("def #{h}; super; model.hook_blocks(:#{h}){|b| instance_eval(&b)}; end", __FILE__, __LINE__)}
-
-        def after_destroy
-          super
-          model.hook_blocks(:after_destroy){|b| instance_eval(&b)}
-          if model.has_hooks?(:after_destroy_commit)
-            db.after_commit{model.hook_blocks(:after_destroy_commit){|b| instance_eval(&b)}}
-          end
-        end
-
-        def after_save
-          super
-          model.hook_blocks(:after_save){|b| instance_eval(&b)}
-          if model.has_hooks?(:after_commit)
-            db.after_commit{model.hook_blocks(:after_commit){|b| instance_eval(&b)}}
-          end
-        end
+        [:before_create, :before_update, :before_validation, :before_save, :before_destroy].each{|h| class_eval("def #{h}; model.hook_blocks(:#{h}){|b| instance_exec(&b)}; super end", __FILE__, __LINE__)}
 
-        def before_destroy
-          model.hook_blocks(:before_destroy) do |b|
-            if instance_eval(&b) == false
-              Sequel::Deprecation.deprecate("Having before_destory hook block return false to stop evaluation of further before_destroy hook blocks", "Instead, call cancel_action inside before_destroy hook block")
-              return false
-            end
-          end
-          super
-          if model.has_hooks?(:after_destroy_rollback)
-            db.after_rollback{model.hook_blocks(:after_destroy_rollback){|b| instance_eval(&b)}}
-          end
-        end
-
-        def before_save
-          model.hook_blocks(:before_save) do |b|
-            if instance_eval(&b) == false
-              Sequel::Deprecation.deprecate("Having before_save hook block return false to stop evaluation of further before_save hook blocks", "Instead, call cancel_action inside before_save hook block")
-              return false
-            end
-          end
-          super
-          if model.has_hooks?(:after_rollback)
-            db.after_rollback{model.hook_blocks(:after_rollback){|b| instance_eval(&b)}}
-          end
-        end
+        [:after_create, :after_update, :after_validation, :after_save, :after_destroy].each{|h| class_eval("def #{h}; super; model.hook_blocks(:#{h}){|b| instance_exec(&b)}; end", __FILE__, __LINE__)}
       end
     end
   end