sequel 3.23.0 → 3.24.0

data/lib/sequel/model/base.rb

@@ -271,7 +271,8 @@ module Sequel
           db
           begin
             if self == Model || !@dataset
-              subclass.set_dataset(subclass.implicit_table_name) unless subclass.name.empty?
+              n = subclass.name
+              subclass.set_dataset(subclass.implicit_table_name) unless n.nil? || n.empty?
             elsif @dataset
               subclass.set_dataset(@dataset.clone, :inherited=>true)
             end
@@ -686,10 +687,10 @@ module Sequel
 
     # Sequel::Model instance methods that implement basic model functionality.
     #
-    # * All of the methods in +HOOKS+ create instance methods that are called
+    # * All of the methods in +HOOKS+ and +AROUND_HOOKS+ create instance methods that are called
     #   by Sequel when the appropriate action occurs.  For example, when destroying
-    #   a model object, Sequel will call +before_destroy+, do the destroy,
-    #   and then call +after_destroy+.
+    #   a model object, Sequel will call +around_destory+, which will call +before_destroy+, do
+    #   the destroy, and then call +after_destroy+.
     # * The following instance_methods all call the class method of the same
     #   name: columns, dataset, db, primary_key, db_schema.
     # * All of the methods in +BOOLEAN_SETTINGS+ create attr_writers allowing you
@@ -698,6 +699,7 @@ module Sequel
     #   gets the default value from the class by calling the class method of the same name.
     module InstanceMethods
       HOOKS.each{|h| class_eval("def #{h}; end", __FILE__, __LINE__)}
+      AROUND_HOOKS.each{|h| class_eval("def #{h}; yield end", __FILE__, __LINE__)}
 
       # Define instance method(s) that calls class method(s) of the
       # same name, caching the result in an instance variable.  Define
@@ -750,7 +752,7 @@ module Sequel
           @values = {}
           @new = true
           @modified = true
-          set(values)
+          initialize_set(values)
           changed_columns.clear 
           yield self if block_given?
         end
@@ -1016,7 +1018,7 @@ module Sequel
       #
       # If +save+ fails and either raise_on_save_failure or the
       # :raise_on_failure option is true, it raises ValidationFailed
-      # or BeforeHookFailed. Otherwise it returns nil.
+      # or HookFailed. Otherwise it returns nil.
       #
       # If it succeeds, it returns self.
       #
@@ -1033,9 +1035,11 @@ module Sequel
       #   raise_on_save_failure setting
       def save(*columns)
         opts = columns.last.is_a?(Hash) ? columns.pop : {}
-        if opts[:validate] != false and !valid?(opts)
-          raise(ValidationFailed.new(errors)) if raise_on_failure?(opts)
-          return
+        if opts[:validate] != false
+          unless checked_save_failure(opts){_valid?(true, opts)}
+            raise(ValidationFailed.new(errors)) if raise_on_failure?(opts)
+            return
+          end
         end
         checked_save_failure(opts){checked_transaction(opts){_save(columns, opts)}}
       end
@@ -1185,21 +1189,15 @@ module Sequel
       #   artist(:name=>'Invalid').valid? # => false
       #   artist.errors.full_messages # => ['name cannot be Invalid']
       def valid?(opts = {})
-        errors.clear
-        if before_validation == false
-          raise_hook_failure(:validation) if raise_on_failure?(opts)
-          return false
-        end
-        validate
-        after_validation
-        errors.empty?
+        _valid?(false, opts)
       end
 
       private
       
-      # Actually do the deletion of the object's dataset.
+      # Do the deletion of the object's dataset, and check that the row
+      # was actually deleted.
       def _delete
-        n = _delete_dataset.delete
+        n = _delete_without_checking
         raise(NoExistingObject, "Attempt to delete object did not result in a single row modification (Rows Deleted: #{n}, SQL: #{_delete_dataset.delete_sql})") if require_modification && n != 1
         n
       end
@@ -1210,12 +1208,24 @@ module Sequel
         this
       end
   
+      # Actually do the deletion of the object's dataset.  Return the
+      # number of rows modified.
+      def _delete_without_checking
+        _delete_dataset.delete
+      end
+
       # Internal destroy method, separted from destroy to
       # allow running inside a transaction
       def _destroy(opts)
-        raise_hook_failure(:destroy) if before_destroy == false
-        _destroy_delete
-        after_destroy
+        called = false
+        around_destroy do
+          called = true
+          raise_hook_failure(:destroy) if before_destroy == false
+          _destroy_delete
+          after_destroy
+          true
+        end
+        raise_hook_failure(:destroy) unless called
         self
       end
       
@@ -1230,11 +1240,11 @@ module Sequel
       # the record should be refreshed from the database.
       def _insert
         ds = _insert_dataset
-        if !ds.opts[:select] and ds.respond_to?(:insert_select) and h = ds.insert_select(@values)
+        if !ds.opts[:select] and ds.supports_insert_select? and h = _insert_select_raw(ds)
           @values = h
           nil
         else
-          iid = ds.insert(@values)
+          iid = _insert_raw(ds)
           # if we have a regular primary key and it's not set in @values,
           # we assume it's the last inserted id
           if (pk = autoincrementing_primary_key) && pk.is_a?(Symbol) && !@values[pk]
@@ -1243,52 +1253,89 @@ module Sequel
           pk
         end
       end
-      
+
       # The dataset to use when inserting a new object.   The same as the model's
       # dataset by default.
       def _insert_dataset
         model.dataset
       end
   
+      # Insert into the given dataset and return the primary key created (if any).
+      def _insert_raw(ds)
+        ds.insert(@values)
+      end
+
+      # Insert into the given dataset and return the hash of column values.
+      def _insert_select_raw(ds)
+        ds.insert_select(@values)
+      end
+      
       # Refresh using a particular dataset, used inside save to make sure the same server
       # is used for reading newly inserted values from the database
       def _refresh(dataset)
-        set_values(dataset.first || raise(Error, "Record not found"))
+        set_values(_refresh_get(dataset) || raise(Error, "Record not found"))
         changed_columns.clear
         self
       end
+
+      # Get the row of column data from the database.
+      def _refresh_get(dataset)
+        dataset.first
+      end
       
       # Internal version of save, split from save to allow running inside
       # it's own transaction.
       def _save(columns, opts)
-        raise_hook_failure(:save) if before_save == false
-        if new?
-          raise_hook_failure(:create) if before_create == false
-          pk = _insert
-          @this = nil
-          @new = false
-          @was_new = true
-          after_create
+        was_new = false
+        pk = nil
+        called_save = false
+        called_cu = false
+        around_save do
+          called_save = true
+          raise_hook_failure(:save) if before_save == false
+          if new?
+            was_new = true
+            around_create do
+              called_cu = true
+              raise_hook_failure(:create) if before_create == false
+              pk = _insert
+              @this = nil
+              @new = false
+              @was_new = true
+              after_create
+              true
+            end
+            raise_hook_failure(:create) unless called_cu
+          else
+            around_update do
+              called_cu = true
+              raise_hook_failure(:update) if before_update == false
+              if columns.empty?
+                @columns_updated = if opts[:changed]
+                  @values.reject{|k,v| !changed_columns.include?(k)}
+                else
+                  _save_update_all_columns_hash
+                end
+                changed_columns.clear
+              else # update only the specified columns
+                @columns_updated = @values.reject{|k, v| !columns.include?(k)}
+                changed_columns.reject!{|c| columns.include?(c)}
+              end
+              _update_columns(@columns_updated)
+              @this = nil
+              after_update
+              true
+            end
+            raise_hook_failure(:update) unless called_cu
+          end
           after_save
+          true
+        end
+        raise_hook_failure(:save) unless called_save
+        if was_new
           @was_new = nil
           pk ? _save_refresh : changed_columns.clear
         else
-          raise_hook_failure(:update) if before_update == false
-          if columns.empty?
-            @columns_updated = if opts[:changed]
-              @values.reject{|k,v| !changed_columns.include?(k)}
-            else
-              _save_update_all_columns_hash
-            end
-            changed_columns.clear
-          else # update only the specified columns
-            @columns_updated = @values.reject{|k, v| !columns.include?(k)}
-            changed_columns.reject!{|c| columns.include?(c)}
-          end
-          _update_columns(@columns_updated)
-          @this = nil
-          after_update
-          after_save
           @columns_updated = nil
         end
         @modified = false
@@ -1321,9 +1368,10 @@ module Sequel
         _update(columns) unless columns.empty?
       end
 
-      # Update this instance's dataset with the supplied column hash.
+      # Update this instance's dataset with the supplied column hash,
+      # checking that only a single row was modified.
       def _update(columns)
-        n = _update_dataset.update(columns)
+        n = _update_without_checking(columns)
         raise(NoExistingObject, "Attempt to update object did not result in a single row modification (SQL: #{_update_dataset.update_sql(columns)})") if require_modification && n != 1
         n
       end
@@ -1334,7 +1382,46 @@ module Sequel
         this
       end
 
-      # If not raising on failure, check for BeforeHookFailed
+      # Update this instances dataset with the supplied column hash.
+      def _update_without_checking(columns)
+        _update_dataset.update(columns)
+      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)
+        errors.clear
+        called = false
+        error = false
+        around_validation do
+          called = true
+          if before_validation == false
+            if raise_errors
+              raise_hook_failure(:validation)
+            else
+              error = true
+            end
+            false
+          else
+            validate
+            after_validation
+            errors.empty?
+          end
+        end
+        error = true unless called
+        if error
+          if raise_errors
+            raise_hook_failure(:validation)
+          else
+            false
+          end
+        else
+          errors.empty?
+        end
+      end
+
+      # If not raising on failure, check for HookFailed
       # being raised by yielding and swallow it.
       def checked_save_failure(opts)
         if raise_on_failure?(opts)
@@ -1342,7 +1429,7 @@ module Sequel
         else
           begin
             yield
-          rescue BeforeHookFailed 
+          rescue HookFailed 
             nil
           end
         end
@@ -1353,6 +1440,13 @@ module Sequel
         use_transaction?(opts) ? db.transaction(opts){yield} : yield
       end
 
+      # Set the columns with the given hash.  By default, the same as +set+, but
+      # exists so it can be overridden.  This is called only for new records, before
+      # changed_columns is cleared.
+      def initialize_set(h)
+        set(h)
+      end
+
       # Default inspection output for the values hash, overwrite to change what #inspect displays.
       def inspect_values
         @values.inspect
@@ -1369,7 +1463,7 @@ module Sequel
       # Raise an error appropriate to the hook type. May be swallowed by
       # checked_save_failure depending on the raise_on_failure? setting.
       def raise_hook_failure(type)
-        raise BeforeHookFailed, "one of the before_#{type} hooks returned false"
+        raise HookFailed, "one of the before_#{type} hooks returned false"
       end
   
       # Set the columns, filtered by the only and except arrays.
@@ -1461,6 +1555,18 @@ module Sequel
       #   Artist.dataset.model # => Artist
       attr_accessor :model
 
+      # Assume if a single integer is given that it is a lookup by primary
+      # key, and call with_pk with the argument.
+      #
+      #   Artist.dataset[1] # SELECT * FROM artists WHERE (id = 1) LIMIT 1
+      def [](*args)
+        if args.length == 1 && (i = args.at(0)) && i.is_a?(Integer)
+          with_pk(i)
+        else
+          super
+        end
+      end
+
       # Destroy each row in the dataset by instantiating it and then calling
       # destroy on the resulting model object.  This isn't as fast as deleting
       # the dataset, which does a single SQL call, but this runs any destroy
@@ -1491,6 +1597,27 @@ module Sequel
           super(pk, value_column) 
         end
       end
+
+      # Given a primary key value, return the first record in the dataset with that primary key
+      # value.
+      #
+      #   # Single primary key
+      #   Artist.dataset.with_pk(1) # SELECT * FROM artists WHERE (id = 1) LIMIT 1
+      #
+      #   # Composite primary key
+      #   Artist.dataset.with_pk([1, 2]) # SELECT * FROM artists
+      #                                  # WHERE ((id1 = 1) AND (id2 = 2)) LIMIT 1
+      def with_pk(pk)
+        case primary_key = model.primary_key
+        when Array
+          raise(Error, "single primary key given (#{pk.inspect}) when a composite primary key is expected (#{primary_key.inspect})") unless pk.is_a?(Array)
+          raise(Error, "composite primary key given (#{pk.inspect}) does not match composite primary key length (#{primary_key.inspect})") if pk.length != primary_key.length
+          first(primary_key.zip(pk))
+        else
+          raise(Error, "composite primary key given (#{pk.inspect}) when a single primary key is expected (#{primary_key.inspect})") if pk.is_a?(Array)
+          first(primary_key=>pk)
+        end
+      end
     end
 
     extend ClassMethods

data/lib/sequel/model/exceptions.rb

@@ -1,6 +1,8 @@
 module Sequel
   # Exception class raised when +raise_on_save_failure+ is set and a before hook returns false
-  class BeforeHookFailed < Error; end
+  # or an around hook doesn't call super or yield.
+  class HookFailed < Error; end
+  BeforeHookFailed = HookFailed
   
   # Exception class raised when +require_modification+ is set and an UPDATE or DELETE statement to modify the dataset doesn't
   # modify a single row.

data/lib/sequel/plugins/association_pks.rb

@@ -14,7 +14,7 @@ module Sequel
     #
     # Note that it uses the singular form of the association name. Also note
     # that the setter both associates to new primary keys not in the assocation
-    # and disassociated from primary keys not provided to the method.
+    # and disassociates from primary keys not provided to the method.
     #
     # This plugin makes modifications directly to the underlying tables,
     # it does not create or return any model objects, and therefore does
@@ -71,13 +71,15 @@ module Sequel
           super
           return if opts[:type] == :one_to_one
           def_association_pks_getter(opts) do
-            send(opts.dataset_method).select_map(opts[:primary_key])
+            send(opts.dataset_method).select_map(opts.associated_class.primary_key)
           end
           def_association_pks_setter(opts) do |pks|
             checked_transaction do
               ds = send(opts.dataset_method)
-              ds.unfiltered.filter(opts[:primary_key]=>pks).update(opts[:key]=>pk)
-              ds.exclude(opts[:primary_key]=>pks).update(opts[:key]=>nil)
+              primary_key = opts.associated_class.primary_key
+              key = opts[:key]
+              ds.unfiltered.filter(primary_key=>pks).update(key=>pk)
+              ds.exclude(primary_key=>pks).update(key=>nil)
             end
           end
         end

data/lib/sequel/plugins/defaults_setter.rb

@@ -0,0 +1,58 @@
+module Sequel
+  module Plugins
+    # DefaultsSetter is a simple plugin that sets non-nil/NULL default values upon
+    # initialize:
+    #
+    #   # column a default NULL
+    #   # column b default 2
+    #   album = Album.new.values # {:b => 2}
+    #   album = Album.new(:a=>1, :b=>3).values # {:a => 1, :b => 3}
+    # 
+    # Usage:
+    #
+    #   # Make all model subclass instances set defaults (called before loading subclasses)
+    #   Sequel::Model.plugin :defaults_setter
+    #
+    #   # Make the Album class set defaults 
+    #   Album.plugin :defaults_setter
+    module DefaultsSetter
+      # Set the default values based on the model schema
+      def self.configure(model)
+        model.send(:set_default_values)
+      end
+
+      module ClassMethods
+        # The default values to set in initialize for this model.  A hash with column symbol
+        # keys and default values.  If the default values respond to +call+, it will be called
+        # to get the value, otherwise the value will be used directly.  You can manually modify
+        # this hash to set specific default values, by default the ones will be parsed from the database.
+        attr_reader :default_values
+        
+        # Set the default values when loading the dataset.
+        def set_dataset(*)
+          x = super
+          set_default_values
+          x
+        end
+
+        private
+
+        def set_default_values
+          h = {}
+          @db_schema.each{|k, v| h[k] = v[:ruby_default] if v[:ruby_default]} if @db_schema
+          @default_values = h
+        end
+      end
+
+      module InstanceMethods
+        private
+
+        # Set default values if they are not already set by the hash provided to initialize.
+        def initialize_set(h)
+          super
+          model.default_values.each{|k,v| self[k] = (v.respond_to?(:call) ? v.call : v) unless values.has_key?(k)}
+        end
+      end
+    end
+  end
+end