sequel 4.44.0 → 4.45.0

data/lib/sequel/model/base.rb

@@ -24,6 +24,9 @@ module Sequel
       # with all of these modules.
       attr_reader :dataset_method_modules
 
+      # The Module subclass to use for dataset_module blocks.
+      attr_reader :dataset_module_class
+
       # The default options to use for Model#set_fields.  These are merged with
       # the options given to set_fields.
       attr_accessor :default_set_fields_options
@@ -82,7 +85,7 @@ module Sequel
       #
       # or:
       #
-      #   Foo = Sequel::Model()
+      #   Foo = Class.new(Sequel::Model)
       #   Foo.set_dataset :my_foo
       attr_accessor :require_valid_table
 
@@ -116,7 +119,7 @@ module Sequel
       # Whether to enable the after_commit and after_rollback hooks when saving/destroying
       # instances.  On by default, can be turned off for performance reasons or when using
       # prepared transactions (which aren't compatible with after commit/rollback).
-      attr_accessor :use_after_commit_rollback
+      attr_accessor :use_after_commit_rollback # SEQUEL5: Deprecate after release
   
       # Whether to use a transaction by default when saving/deleting records (default: true).
       # If you are sending database queries in before_* or after_* hooks, you shouldn't change
@@ -167,7 +170,9 @@ module Sequel
       # The purpose of this method is to set the dataset/database automatically
       # for a model class, if the table name doesn't match the implicit
       # name.  This is neater than using set_dataset inside the class,
-      # doesn't require a bogus query for the schema.
+      # doesn't require a bogus query for the schema, and works when using
+      # +require_valid_table+, or with plugins that assume a model's dataset
+      # is valid.
       #
       # When creating subclasses of Sequel::Model itself, this method is usually
       # called on Sequel itself, using <tt>Sequel::Model(:something)</tt>.
@@ -188,10 +193,8 @@ module Sequel
       #   end
       def Model(source)
         if cache_anonymous_models
-          mutex = @Model_mutex
-          cache = mutex.synchronize{@Model_cache ||= {}}
-
-          if klass = mutex.synchronize{cache[source]}
+          cache = Sequel.synchronize{@Model_cache ||= {}}
+          if klass = Sequel.synchronize{cache[source]}
             return klass
           end
         end
@@ -205,12 +208,24 @@ module Sequel
         end
 
         if cache_anonymous_models
-          mutex.synchronize{cache[source] = klass}
+          Sequel.synchronize{cache[source] = klass}
         end
 
         klass
       end
   
+      def initialize_copy(_)
+        Sequel::Deprecation.deprecate("Model.clone", "Create a subclass of the model instead of cloning it.")
+        # raise(Error, "cannot dup/clone a Sequel::Model class") # SEQUEL5
+        super
+      end
+      def dup
+        Sequel::Deprecation.deprecate("Model.dup", "Create a subclass of the model instead of duping it.")
+        # raise(Error, "cannot dup/clone a Sequel::Model class") # SEQUEL5
+        super
+      end
+
+
       # Returns the first record from the database matching the conditions.
       # If a hash is given, it is used as the conditions.  If another
       # object is given, it finds the first record whose primary key(s) match
@@ -338,13 +353,13 @@ module Sequel
           dataset_extend(mod)
           mod
         else
-          @dataset_module ||= DatasetModule.new(self)
+          @dataset_module ||= dataset_module_class.new(self)
           @dataset_module.module_eval(&Proc.new) if block_given?
           dataset_extend(@dataset_module)
           @dataset_module
         end
       end
-    
+
       # Returns the database associated with the Model class.
       # If this model doesn't have a database associated with it,
       # assumes the superclass's database, or the first object in
@@ -835,17 +850,27 @@ module Sequel
       # database with the table name given. Other arguments raise an +Error+.
       # Returns self.
       #
-      # This changes the row_proc of the dataset to return
-      # model objects and extends the dataset with the dataset_method_modules.
       # It also attempts to determine the database schema for the model,
       # based on the given dataset.
       #
-      #   Artist.set_dataset(:tbl_artists)
-      #   Artist.set_dataset(DB[:artists])
-      #
       # Note that you should not use this to change the model's dataset
       # at runtime.  If you have that need, you should look into Sequel's
       # sharding support.
+      #
+      # You should avoid calling this method directly.  Instead of doing:
+      #
+      #   class Artist < Sequel::Model
+      #     set_dataset :tbl_artists
+      #   end
+      #
+      # You should use:
+      #
+      #   class Artist < Sequel::Model(:tbl_artists)
+      #   end
+      #
+      # This ensures the class never uses an invalid dataset.  Calling +set_dataset+
+      # after creating a class can create a class with initial invalid dataset, which
+      # will break when +require_valid_table+ or certain plugins are used.
       def set_dataset(ds, opts=OPTS)
         inherited = opts[:inherited]
         @dataset = convert_input_dataset(ds)
@@ -895,7 +920,6 @@ module Sequel
       # Cache of setter methods to allow by default, in order to speed up new/set/update instance methods.
       def setter_methods
         return @setter_methods if @setter_methods
-        raise if frozen?
         @setter_methods = get_setter_methods
       end
 
@@ -937,7 +961,7 @@ module Sequel
       #
       #   Artist.table_name # => :artists
       #   Sequel::Model(:foo).table_name # => :foo
-      #   Sequel::Model(:foo___bar).table_name # => :bar
+      #   Sequel::Model(Sequel[:foo].as(:bar)).table_name # => :bar
       def table_name
         dataset.first_source_alias
       end
@@ -1253,7 +1277,7 @@ module Sequel
       # should be used whenever the model's dataset is modified.
       def reset_instance_dataset
         Sequel.synchronize{@finders.clear if @finders}
-        @instance_dataset = @dataset.limit(1).naked if @dataset
+        @instance_dataset = @dataset.limit(1).naked.skip_limit_check if @dataset
       end
   
       # Set the columns for this model and create accessor methods for each column.
@@ -1736,8 +1760,8 @@ module Sequel
         raise Sequel::Error, "can't save frozen object" if frozen?
         set_server(opts[:server]) if opts[:server] 
         _before_validation
-        if opts[:validate] != false
-          unless checked_save_failure(opts){_valid?(true, opts)}
+        if opts[:validate] != false # SEQUEL5: Remove if
+          unless checked_save_failure(opts){_valid?(opts)}
             raise(ValidationFailed.new(self)) if raise_on_failure?(opts)
             return
           end
@@ -1931,12 +1955,16 @@ module Sequel
 
       # Validates the object and returns true if no errors are reported.
       #
-      #   artist(:name=>'Valid').valid? # => true
-      #   artist(:name=>'Invalid').valid? # => false
+      #   artist.set(:name=>'Valid').valid? # => true
+      #   artist.set(:name=>'Invalid').valid? # => false
       #   artist.errors.full_messages # => ['name cannot be Invalid']
       def valid?(opts = OPTS)
         _before_validation
-        _valid?(false, opts)
+        begin
+          _valid?(opts)
+        rescue HookFailed
+          false
+        end
       end
 
       private
@@ -1944,6 +1972,7 @@ module Sequel
       # Run code directly after the INSERT query, before after_create.
       # This is only a temporary API, it should not be overridden by external code.
       def _after_create(pk)
+        # SEQUEL5: Remove
         @this = nil
         @new = false
         @was_new = true
@@ -1952,6 +1981,7 @@ module Sequel
       # Run code after around_save returns, before calling after_commit.
       # This is only a temporary API, it should not be overridden by external code.
       def _after_save(pk)
+        # SEQUEL5: Remove
         if @was_new
           @was_new = nil
           pk ? _save_refresh : changed_columns.clear
@@ -1964,6 +1994,7 @@ module Sequel
       # Run code directly after the UPDATE query, before after_update.
       # This is only a temporary API, it should not be overridden by external code.
       def _after_update
+        # SEQUEL5: Remove
         @this = nil
       end
 
@@ -2008,17 +2039,26 @@ module Sequel
       def _destroy(opts)
         sh = {:server=>this_server}
         uacr = use_after_commit_rollback
-        db.after_rollback(sh){after_destroy_rollback} if uacr.nil? ? (method(:after_destroy_rollback).owner != InstanceMethods) : uacr
+        if uacr.nil? ? (method(:after_destroy_rollback).owner != InstanceMethods) : uacr
+          Sequel::Deprecation.deprecate("Model#after_destroy_rollback", "Instead, call db.after_rollback in Model#before_destroy")
+          db.after_rollback(sh){after_destroy_rollback}
+        end
         called = false
         around_destroy do
           called = true
-          raise_hook_failure(:before_destroy) if before_destroy == false
+          if before_destroy == false
+            Sequel::Deprecation.deprecate("Having before_destroy return false to cancel the destroy", "Instead, call cancel_action inside before_destroy")
+            raise_hook_failure(:before_destroy)
+          end
           _destroy_delete
           after_destroy
           true
         end
         raise_hook_failure(:around_destroy) unless called
-        db.after_commit(sh){after_destroy_commit} if uacr.nil? ? (method(:after_destroy_commit).owner != InstanceMethods) : uacr
+        if uacr.nil? ? (method(:after_destroy_commit).owner != InstanceMethods) : uacr
+          Sequel::Deprecation.deprecate("Model#after_destroy_commit", "Instead, call db.after_commit in Model#after_destroy")
+          db.after_commit(sh){after_destroy_commit}
+        end
         self
       end
       
@@ -2095,19 +2135,34 @@ module Sequel
       def _save(opts)
         sh = {:server=>this_server}
         uacr = use_after_commit_rollback
-        db.after_rollback(sh){after_rollback} if uacr.nil? ? (method(:after_rollback).owner != InstanceMethods) : uacr
+        if uacr.nil? ? (method(:after_rollback).owner != InstanceMethods) : uacr
+          Sequel::Deprecation.deprecate("Model#after_rollback", "Instead, call db.after_rollback in Model#before_save.")
+          db.after_rollback(sh){after_rollback}
+        end
         pk = nil
         called_save = false
         called_cu = false
         around_save do
           called_save = true
-          raise_hook_failure(:before_save) if before_save == false
+          if before_save == false
+            Sequel::Deprecation.deprecate("Having before_save return false to cancel the save", "Instead, call cancel_action inside before_save")
+            raise_hook_failure(:before_save)
+          end
+
           if new?
             around_create do
               called_cu = true
-              raise_hook_failure(:before_create) if before_create == false
+              if before_create == false
+                Sequel::Deprecation.deprecate("Having before_create return false to cancel the create", "Instead, call cancel_action inside before_create")
+                raise_hook_failure(:before_create)
+              end
               pk = _insert
-              _after_create(pk)
+              _after_create(pk) # SEQUEL5: Remove
+              # SEQUEL5
+              # @this = nil
+              # @new = false
+              # @modified = false
+              # pk ? _save_refresh : changed_columns.clear
               after_create
               true
             end
@@ -2115,10 +2170,13 @@ module Sequel
           else
             around_update do
               called_cu = true
-              raise_hook_failure(:before_update) if before_update == false
+              if before_update == false
+                Sequel::Deprecation.deprecate("Having before_update return false to cancel the update", "Instead, call cancel_action inside before_update")
+                raise_hook_failure(:before_update)
+              end
               columns = opts[:columns]
               if columns.nil?
-                @columns_updated = if opts[:changed]
+                columns_updated = if opts[:changed] # SEQUEL5: Use local variable instead of instance variable
                   @values.reject{|k,v| !changed_columns.include?(k)}
                 else
                   _save_update_all_columns_hash
@@ -2126,11 +2184,14 @@ module Sequel
                 changed_columns.clear
               else # update only the specified columns
                 columns = Array(columns)
-                @columns_updated = @values.reject{|k, v| !columns.include?(k)}
+                columns_updated = @values.reject{|k, v| !columns.include?(k)}
                 changed_columns.reject!{|c| columns.include?(c)}
               end
-              _update_columns(@columns_updated)
-              _after_update
+              _update_columns(columns_updated)
+              _after_update # SEQUEL5: Remove
+              # SEQUEL5
+              # @this = nil
+              # @modified = false
               after_update
               true
             end
@@ -2140,11 +2201,14 @@ module Sequel
           true
         end
         raise_hook_failure(:around_save) unless called_save
-        _after_save(pk)
-        db.after_commit(sh){after_commit} if uacr.nil? ? (method(:after_commit).owner != InstanceMethods) : uacr
+        _after_save(pk) # SEQUEL5: Remove
+        if uacr.nil? ? (method(:after_commit).owner != InstanceMethods) : uacr
+          Sequel::Deprecation.deprecate("Model#after_commit", "Instead, call db.after_commit in Model#after_save.")
+          db.after_commit(sh){after_commit}
+        end
         self
       end
-      
+
       # Refresh the object after saving it, used to get
       # default values of all columns.  Separated from _save so it
       # can be overridden to avoid the refresh.
@@ -2175,6 +2239,7 @@ module Sequel
       # Plugins can override this method in order to update with
       # additional columns, even when the column hash is initially empty.
       def _update_columns(columns)
+        @columns_updated ||= DeprecatedColumnsUpdated.new(columns) # SEQUEL5: Remove
         _update(columns) unless columns.empty?
       end
 
@@ -2202,38 +2267,27 @@ module Sequel
         (!ds.opts[:select] || ds.opts[:returning]) && ds.supports_insert_select? 
       end
 
-      # Internal validation method.  If +raise_errors+ is +true+, hook
-      # failures will be raised as HookFailure exceptions.  If it is
-      # +false+, +false+ will be returned instead.
-      def _valid?(raise_errors, opts)
+      # Internal validation method, running validation hooks.
+      def _valid?(opts)
         return errors.empty? if frozen?
         errors.clear
         called = false
-        error = false
+        # skip_validate = opts[:validate] == false # SEQUEL5
         around_validation do
           called = true
           if before_validation == false
-            if raise_errors
-              raise_hook_failure(:before_validation)
-            else
-              error = true
-            end
-            false
+            Sequel::Deprecation.deprecate("Having before_validation return false to mark the object as invalid", "Instead, call cancel_action inside before_validation")
+            raise_hook_failure(:before_validation)
           else
-            validate
+            validate # unless skip_validate # SEQUEL5
             after_validation
-            errors.empty?
           end
         end
-        error = true unless called
-        if error
-          if raise_errors
-            raise_hook_failure(:around_validation)
-          else
-            false
-          end
-        else
+        # return true if skip_validate # SEQUEL5
+        if called
           errors.empty?
+        else
+          raise_hook_failure(:around_validation)
         end
       end
 
@@ -2433,8 +2487,7 @@ module Sequel
       end
     end
 
-    # Dataset methods are methods that the model class extends its dataset with in
-    # the call to set_dataset.
+    # DatasetMethods contains methods that all model datasets have.
     module DatasetMethods
       Dataset.def_deprecated_opts_setter(self, :model)
 
@@ -2618,7 +2671,7 @@ module Sequel
       #   Artist.dataset.with_pk([1, 2])
       #   # SELECT * FROM artists WHERE ((artists.id1 = 1) AND (artists.id2 = 2)) LIMIT 1
       def with_pk(pk)
-        if loader = _with_pk_loader
+        if pk && (loader = _with_pk_loader)
           loader.first(*pk)
         else
           first(model.qualified_primary_key_hash(pk))

data/lib/sequel/model/dataset_module.rb

@@ -39,13 +39,14 @@ module Sequel
       end
 
       meths = (<<-METHS).split.map(&:to_sym)
-        distinct eager grep group group_and_count group_append 
+        distinct grep group group_and_count group_append 
         limit offset order order_append order_prepend 
         select select_all select_append select_group server
       METHS
 
-      meths.each do |meth|
-        define_method(meth) do |name, *args, &block|
+      # Define a method in the module
+      def self.def_dataset_caching_method(mod, meth)
+        mod.send(:define_method, meth) do |name, *args, &block|
           if block
             @model.def_dataset_method(name){send(meth, *args, &block)}
           else
@@ -57,6 +58,10 @@ module Sequel
         end
       end
 
+      meths.each do |meth|
+        def_dataset_caching_method(self, meth)
+      end
+
       private
 
       # Add a class method to the related model that
@@ -65,5 +70,7 @@ module Sequel
         @model.send(:def_model_dataset_method, meth)
       end
     end
+
+    @dataset_module_class = DatasetModule
   end
 end

data/lib/sequel/model/exceptions.rb

@@ -15,17 +15,24 @@ module Sequel
 
   # Alias for HookFailed, kept for backwards compatibility
   BeforeHookFailed = HookFailed
+  Sequel::Deprecation.deprecate_constant(self, :BeforeHookFailed)
   
+  (
   # Exception class raised when +require_modification+ is set and an UPDATE or DELETE statement to modify the dataset doesn't
   # modify a single row.
   NoExistingObject = Class.new(Error)
+  ).name
   
+  (
   # Raised when an undefined association is used when eager loading.
   UndefinedAssociation = Class.new(Error)
+  ).name
 
+  (
   # Raised when a mass assignment method is called in strict mode with either a restricted column
   # or a column without a setter method.
   MassAssignmentRestriction = Class.new(Error)
+  ).name
   
   # Exception class raised when +raise_on_save_failure+ is set and validation fails
   class ValidationFailed < Error
@@ -49,9 +56,4 @@ module Sequel
       end
     end
   end
-
-  # Call name on each class to set the name for the class, so it gets cached.
-  constants.map{|c| const_get(c)}.each do |c|
-    Class === c && c.name
-  end
 end