sequel 3.45.0 → 3.46.0

data/lib/sequel/dataset/actions.rb

@@ -10,7 +10,7 @@ module Sequel
     # Action methods defined by Sequel that execute code on the database.
     ACTION_METHODS = (<<-METHS).split.map{|x| x.to_sym}
       << [] []= all avg count columns columns! delete each
-      empty? fetch_rows first get import insert insert_multiple interval last
+      empty? fetch_rows first first! get import insert insert_multiple interval last
       map max min multi_insert paged_each range select_hash select_hash_groups select_map select_order_map
       set single_record single_value sum to_csv to_hash to_hash_groups truncate update
     METHS
@@ -176,8 +176,13 @@ module Sequel
     # matching records up to that limit.  If no argument is passed,
     # it returns the first matching record.  If any other type of
     # argument(s) is passed, it is given to filter and the
-    # first matching record is returned. If a block is given, it is used
-    # to filter the dataset before returning anything.  Examples:
+    # first matching record is returned.  If a block is given, it is used
+    # to filter the dataset before returning anything.
+    #
+    # If there are no records in the dataset, returns nil (or an empty
+    # array if an integer argument is given).
+    #
+    # Examples:
     # 
     #   DB[:table].first # SELECT * FROM table LIMIT 1
     #   # => {:id=>7}
@@ -217,6 +222,12 @@ module Sequel
       end
     end
 
+    # Calls first.  If first returns nil (signaling that no
+    # row matches), raise a Sequel::NoMatchingRow exception.
+    def first!(*args, &block)
+      first(*args, &block) || raise(Sequel::NoMatchingRow)
+    end
+
     # Return the column value for the first matching record in the dataset.
     # Raises an error if both an argument and block is given.
     #
@@ -869,21 +880,25 @@ module Sequel
     # Return a plain symbol given a potentially qualified or aliased symbol,
     # specifying the symbol that is likely to be used as the hash key
     # for the column when records are returned.
-    def hash_key_symbol(s)
+    def hash_key_symbol(s, recursing=false)
       case s
       when Symbol
         _, c, a = split_symbol(s)
         (a || c).to_sym
       when SQL::Identifier, SQL::Wrapper
-        hash_key_symbol(s.value)
+        hash_key_symbol(s.value, true)
       when SQL::QualifiedIdentifier
-        hash_key_symbol(s.column)
+        hash_key_symbol(s.column, true)
       when SQL::AliasedExpression
-        hash_key_symbol(s.aliaz)
+        hash_key_symbol(s.aliaz, true)
       when String
-        s.to_sym
+        if recursing
+          s.to_sym
+        else
+          raise(Error, "#{s.inspect} is not supported, should be a Symbol, SQL::Identifier, SQL::QualifiedIdentifier, or SQL::AliasedExpression") 
+        end
       else
-        raise(Error, "#{s.inspect} is not supported, should be a Symbol, String, SQL::Identifier, SQL::QualifiedIdentifier, or SQL::AliasedExpression") 
+        raise(Error, "#{s.inspect} is not supported, should be a Symbol, SQL::Identifier, SQL::QualifiedIdentifier, or SQL::AliasedExpression") 
       end
     end
     

data/lib/sequel/dataset/mutation.rb

@@ -11,6 +11,9 @@ module Sequel
     # Setup mutation (e.g. filter!) methods.  These operate the same as the
     # non-! methods, but replace the options of the current dataset with the
     # options of the resulting dataset.
+    #
+    # Do not call this method with untrusted input, as that can result in
+    # arbitrary code execution.
     def self.def_mutation_method(*meths)
       options = meths.pop if meths.last.is_a?(Hash)
       mod = options[:module] if options
@@ -36,6 +39,23 @@ module Sequel
     # a single hash argument and returns the object you want #each to return.
     attr_accessor :row_proc
     
+    # Load an extension into the receiver.  In addition to requiring the extension file, this
+    # also modifies the dataset to work with the extension (usually extending it with a
+    # module defined in the extension file).  If no related extension file exists or the
+    # extension does not have specific support for Database objects, an Error will be raised.
+    # Returns self.
+    def extension!(*exts)
+      Sequel.extension(*exts)
+      exts.each do |ext|
+        if pr = Sequel.synchronize{EXTENSIONS[ext]}
+          pr.call(self)
+        else
+          raise(Error, "Extension #{ext} does not have specific support handling individual datasets")
+        end
+      end
+      self
+    end
+
     # Avoid self-referential dataset by cloning.
     def from_self!(*args, &block)
       @opts.merge!(clone.from_self(*args, &block).opts)

data/lib/sequel/dataset/query.rb

@@ -161,23 +161,6 @@ module Sequel
       clone.extension!(*exts)
     end
 
-    # Load an extension into the receiver.  In addition to requiring the extension file, this
-    # also modifies the dataset to work with the extension (usually extending it with a
-    # module defined in the extension file).  If no related extension file exists or the
-    # extension does not have specific support for Database objects, an Error will be raised.
-    # Returns self.
-    def extension!(*exts)
-      Sequel.extension(*exts)
-      exts.each do |ext|
-        if pr = Sequel.synchronize{EXTENSIONS[ext]}
-          pr.call(self)
-        else
-          raise(Error, "Extension #{ext} does not have specific support handling individual datasets")
-        end
-      end
-      self
-    end
-
     # Returns a copy of the dataset with the given conditions imposed upon it.  
     # If the query already has a HAVING clause, then the conditions are imposed in the 
     # HAVING clause. If not, then they are imposed in the WHERE clause.

data/lib/sequel/dataset/sql.rb

@@ -326,6 +326,13 @@ module Sequel
       subselect_sql
       table_ref
     END
+
+    # For each of the methods in the given array, define a method with
+    # that name that returns a string with the SQL fragment that the
+    # related *_append method would add.
+    #
+    # Do not call this method with untrusted input, as that can result in
+    # arbitrary code execution.
     def self.def_append_methods(meths)
       meths.each do |meth|
         class_eval(<<-END, __FILE__, __LINE__ + 1)

data/lib/sequel/exceptions.rb

@@ -7,8 +7,8 @@ module Sequel
     attr_accessor :wrapped_exception
   end  
     
-  # Raised when the adapter requested doesn't exist or can't be loaded.
-  class AdapterNotFound < Error ; end
+  # Error raised when the adapter requested doesn't exist or can't be loaded.
+  class AdapterNotFound < Error; end
 
   # Generic error raised by the database adapters, indicating a
   # problem originating from the database server.  Usually raised
@@ -48,19 +48,23 @@ module Sequel
   class InvalidOperation < Error; end
 
   # Error raised when attempting an invalid type conversion.
-  class InvalidValue < Error ; end
+  class InvalidValue < Error; end
+
+  # Error raised when the user requests a record via the first! or similar
+  # method, and the dataset does not yield any rows.
+  class NoMatchingRow < Error; end
 
   # Error raised when the adapter adapter hasn't implemented a method such as +tables+:
   class NotImplemented < Error; end
 
   # Error raised when the connection pool cannot acquire a database connection
   # before the timeout.
-  class PoolTimeout < Error ; end
+  class PoolTimeout < Error; end
 
-  # Exception that you should raise to signal a rollback of the current transaction.
+  # Error that you should raise to signal a rollback of the current transaction.
   # The transaction block will catch this exception, rollback the current transaction,
   # and won't reraise it (unless a reraise is requested).
-  class Rollback < Error ; end
+  class Rollback < Error; end
 
   # Error raised when unbinding a dataset that has multiple different values
   # for a given variable.

data/lib/sequel/extensions/_pretty_table.rb

@@ -39,12 +39,12 @@ module Sequel
       sizes = Hash.new {0}
       columns.each do |c|
         s = c.to_s.size
-        sizes[c.to_sym] = s if s > sizes[c.to_sym]
+        sizes[c] = s if s > sizes[c]
       end
       records.each do |r|
         columns.each do |c|
           s = r[c].to_s.size
-          sizes[c.to_sym] = s if s > sizes[c.to_sym]
+          sizes[c] = s if s > sizes[c]
         end
       end
       sizes

data/lib/sequel/extensions/looser_typecasting.rb

@@ -15,6 +15,16 @@ module Sequel
     def typecast_value_integer(value)
       value.to_i
     end
+
+    # Typecast the value to a BigDecimal, without checking if strings
+    # have a valid format.
+    def typecast_value_decimal(value)
+      if value.is_a?(String)
+        BigDecimal.new(value)
+      else
+        super
+      end
+    end
   end
 
   Database.register_extension(:looser_typecasting, LooserTypecasting)

data/lib/sequel/extensions/migration.rb

@@ -241,11 +241,14 @@ module Sequel
       @actions << [:drop_constraint, args.first]
     end
 
-    def add_foreign_key(*args)
+    def add_foreign_key(key, table, *args)
+      @actions << [:drop_foreign_key, key, *args]
+    end
+
+    def add_primary_key(*args)
       raise if args.first.is_a?(Array)
       @actions << [:drop_column, args.first]
     end
-    alias add_primary_key add_foreign_key
 
     def add_index(*args)
       @actions << [:drop_index, *args]

data/lib/sequel/model.rb

@@ -72,7 +72,7 @@ module Sequel
 
     # Class methods added to model that call the method of the same name on the dataset
     DATASET_METHODS = (Dataset::ACTION_METHODS + Dataset::QUERY_METHODS +
-      [:eager, :eager_graph, :each_page, :each_server, :print]) - [:and, :or, :[], :[]=, :columns, :columns!]
+      [:each_page, :each_server, :print]) - [:and, :or, :[], :[]=, :columns, :columns!]
     
     # Class instance variables to set to nil when a subclass is created, for -w compliance
     EMPTY_INSTANCE_VARIABLES = [:@overridable_methods_module, :@db]

data/lib/sequel/model/associations.rb

@@ -1438,6 +1438,12 @@ module Sequel
           super
         end
       
+        # Clear the associations cache when refreshing
+        def set_values(hash)
+          @associations.clear if @associations
+          super
+        end
+
         # Formally used internally by the associations code, like pk but doesn't raise
         # an Error if the model has no primary key.  Not used any longer, deprecated.
         def pk_or_nil
@@ -1510,12 +1516,6 @@ module Sequel
           end
         end
         
-        # Clear the associations cache when refreshing
-        def _refresh(dataset)
-          associations.clear
-          super
-        end
-
         # Add the given associated object to the given association
         def add_associated_object(opts, o, *args)
           klass = opts.associated_class
@@ -1833,13 +1833,14 @@ module Sequel
           opt = opt ? opt.dup : {}
           associations.flatten.each do |association|
             case association
-              when Symbol
-                check_association(model, association)
-                opt[association] = nil
-              when Hash
-                association.keys.each{|assoc| check_association(model, assoc)}
-                opt.merge!(association)
-              else raise(Sequel::Error, 'Associations must be in the form of a symbol or hash')
+            when Symbol
+              check_association(model, association)
+              opt[association] = nil
+            when Hash
+              association.keys.each{|assoc| check_association(model, assoc)}
+              opt.merge!(association)
+            else
+              raise(Sequel::Error, 'Associations must be in the form of a symbol or hash')
             end
           end
           clone(:eager=>opt)
@@ -1956,7 +1957,8 @@ module Sequel
                 ds = ds.eager_graph_association(ds, model, ta, requirements, eager_graph_check_association(model, assoc), assoc_assocs)
               end
               ds
-            else raise(Sequel::Error, 'Associations must be in the form of a symbol or hash')
+            else
+              raise(Sequel::Error, 'Associations must be in the form of a symbol or hash')
             end
           end
           ds

data/lib/sequel/model/base.rb

@@ -869,6 +869,9 @@ module Sequel
       # Define instance method(s) that calls class method(s) of the
       # same name, caching the result in an instance variable.  Define
       # standard attr_writer method for modifying that instance variable.
+      #
+      # Do not call this method with untrusted input, as that can result in
+      # arbitrary code execution.
       def self.class_attr_overridable(*meths) # :nodoc:
         meths.each{|meth| class_eval("def #{meth}; !defined?(@#{meth}) ? (frozen? ? self.class.#{meth} : (@#{meth} = self.class.#{meth})) : @#{meth} end", __FILE__, __LINE__)}
         attr_writer(*meths) 
@@ -878,6 +881,9 @@ module Sequel
       # same name. Replaces the construct:
       #   
       #   define_method(meth){self.class.send(meth)}
+      #
+      # Do not call this method with untrusted input, as that can result in
+      # arbitrary code execution.
       def self.class_attr_reader(*meths) # :nodoc:
         meths.each{|meth| class_eval("def #{meth}; self.class.#{meth} end", __FILE__, __LINE__)}
       end
@@ -1187,7 +1193,7 @@ module Sequel
         end
       end
       
-      # Returns a hash identifying mapping the receivers primary key column(s) to their values.
+      # Returns a hash mapping the receivers primary key column(s) to their values.
       # 
       #   Artist[1].pk_hash # => {:id=>1}
       #   Artist[[1, 2]].pk_hash # => {:id1=>1, :id2=>2}
@@ -1983,7 +1989,7 @@ module Sequel
       end
 
       # Given a primary key value, return the first record in the dataset with that primary key
-      # value.
+      # value.  If no records matches, returns nil.
       #
       #   # Single primary key
       #   Artist.dataset.with_pk(1) # SELECT * FROM artists WHERE (id = 1) LIMIT 1
@@ -1994,6 +2000,12 @@ module Sequel
       def with_pk(pk)
         first(model.qualified_primary_key_hash(pk))
       end
+
+      # Same as with_pk, but raises NoMatchingRow instead of returning nil if no
+      # row matches.
+      def with_pk!(pk)
+        with_pk(pk) || raise(NoMatchingRow)
+      end
     end
 
     extend ClassMethods

data/lib/sequel/plugins/composition.rb

@@ -148,10 +148,10 @@ module Sequel
       end
 
       module InstanceMethods
-        # Clear the cached compositions when refreshing.
-        def _refresh(ds)
+        # Clear the cached compositions when setting values.
+        def set_values(hash)
+          @compositions.clear if @compositions
           super
-          compositions.clear
         end
 
         # For each composition, set the columns in the model class based

data/lib/sequel/plugins/dirty.rb

@@ -115,6 +115,12 @@ module Sequel
           end
         end
 
+        # Reset the initial values when setting values.
+        def set_values(hash)
+          reset_initial_values
+          super
+        end
+
         # Manually specify that a column will change.  This should only be used
         # if you plan to modify a column value in place, which is not recommended.
         #
@@ -157,12 +163,6 @@ module Sequel
           @previous_changes = column_changes
         end
 
-        # Reset the initial values when refreshing.
-        def _refresh(dataset)
-          super
-          reset_initial_values
-        end
-
         # When changing the column value, save the initial column value.  If the column
         # value is changed back to the initial value, update changed columns to remove
         # the column.

data/lib/sequel/plugins/hook_class_methods.rb

@@ -69,6 +69,9 @@ module Sequel
         #     # 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)
           Model::HOOKS.concat(hooks)
           hooks.each do |hook|

data/lib/sequel/plugins/serialization.rb

@@ -168,35 +168,25 @@ module Sequel
       end
 
       module InstanceMethods
-        # Hash of deserialized values, used as a cache.
-        attr_reader :deserialized_values
-
-        # Set @deserialized_values to the empty hash
-        def initialize_set(values)
-          @deserialized_values = {}
-          super
-        end
-
         # Serialize deserialized values before saving
         def before_save
           serialize_deserialized_values
           super
         end
         
-        # Initialization the deserialized values for objects retrieved from the database.
-        def set_values(*)
+        # Hash of deserialized values, used as a cache.
+        def deserialized_values
           @deserialized_values ||= {}
-          super
         end
 
-        private
-
-        # Empty the deserialized values when refreshing.
-        def _refresh(*)
-          @deserialized_values = {}
+        # Initialization the deserialized values for objects retrieved from the database.
+        def set_values(hash)
+          @deserialized_values.clear if @deserialized_values
           super
         end
 
+        private
+
         # Deserialize the column value.  Called when the model column accessor is called to
         # return a deserialized value.
         def deserialize_value(column, v)

data/lib/sequel/plugins/string_stripper.rb

@@ -37,8 +37,9 @@ module Sequel
 
         # Set blob columns as skipping stripping when plugin is loaded.
         def set_dataset(*)
-          super
+          res = super
           set_skipped_string_stripping_columns
+          res
         end
 
         # Skip stripping for the given columns.