sequel 4.43.0 → 4.44.0

data/lib/sequel/plugins/pg_typecast_on_load.rb

@@ -49,6 +49,13 @@ module Sequel
           super(load_typecast_pg(values))
         end
 
+        # Freeze the typecast on load columns when freezing the model class.
+        def freeze
+          @pg_typecast_on_load_columns.freeze
+
+          super
+        end
+
         # Lookup the conversion proc for the column's oid in the Database
         # object, and use it to convert the value.
         def load_typecast_pg(values)

data/lib/sequel/plugins/prepared_statements.rb

@@ -32,11 +32,11 @@ module Sequel
 
       # Setup the datastructure used to hold the prepared statements in the model.
       def self.apply(model)
-        model.instance_variable_set(:@prepared_statements, :insert=>{}, :insert_select=>{}, :update=>{}, :lookup_sql=>{}, :fixed=>{})
+        model.instance_variable_set(:@prepared_statements, {:insert=>{}, :insert_select=>{}, :update=>{}, :lookup_sql=>{}, :fixed=>{}}.freeze)
       end
 
       module ClassMethods
-        Plugins.inherited_instance_variables(self, :@prepared_statements=>lambda{|v| {:insert=>{}, :insert_select=>{}, :update=>{}, :lookup_sql=>{}, :fixed=>{}}})
+        Plugins.inherited_instance_variables(self, :@prepared_statements=>lambda{|v| {:insert=>{}, :insert_select=>{}, :update=>{}, :lookup_sql=>{}, :fixed=>{}}.freeze})
 
         private
 

data/lib/sequel/plugins/prepared_statements_safe.rb

@@ -38,6 +38,13 @@ module Sequel
         Plugins.inherited_instance_variables(self, :@prepared_statements_column_defaults=>:dup)
         Plugins.after_set_dataset(self, :set_prepared_statements_column_defaults)
 
+        # Freeze the prepared statements column defaults when freezing the model class.
+        def freeze
+          @prepared_statements_column_defaults.freeze if @prepared_statements_column_defaults
+
+          super
+        end
+
         private
 
         # Set the column defaults based on the database schema.  All columns

data/lib/sequel/plugins/serialization.rb

@@ -125,6 +125,15 @@ module Sequel
         attr_accessor :serialization_module
 
         Plugins.inherited_instance_variables(self, :@deserialization_map=>:dup, :@serialization_map=>:dup)
+
+        # Freeze serialization metadata when freezing model class.
+        def freeze
+          @deserialization_map.freeze
+          @serialization_map.freeze
+          @serialization_module.freeze if @serialization_module
+
+          super
+        end
         
         # Create instance level reader that deserializes column values on request,
         # and instance level writer that stores new deserialized values.

data/lib/sequel/plugins/single_table_inheritance.rb

@@ -152,6 +152,18 @@ module Sequel
 
         Plugins.inherited_instance_variables(self, :@sti_dataset=>nil, :@sti_key=>nil, :@sti_key_map=>nil, :@sti_model_map=>nil, :@sti_key_chooser=>nil)
 
+        # Freeze STI information when freezing model class.  Note that
+        # because of how STI works, you should not freeze an STI subclass
+        # until after all subclasses of it have been created.
+        def freeze
+          @sti_dataset.freeze
+          @sti_key_array.freeze if @sti_key_array
+          @sti_key_map.freeze if @sti_key_map.is_a?(Hash)
+          @sti_model_map.freeze if @sti_model_map.is_a?(Hash)
+
+          super
+        end
+
         # Copy the necessary attributes to the subclasses, and filter the
         # subclass's dataset based on the sti_kep_map entry for the class.
         def inherited(subclass)
@@ -159,7 +171,7 @@ module Sequel
           key = Array(sti_key_map[subclass]).dup
           sti_subclass_added(key)
           rp = dataset.row_proc
-          subclass.set_dataset(sti_dataset.where(SQL::QualifiedIdentifier.new(sti_dataset.first_source_alias, sti_key)=>Sequel.delay{key}), :inherited=>true)
+          subclass.set_dataset(sti_dataset.where(SQL::QualifiedIdentifier.new(sti_dataset.first_source_alias, sti_key)=>Sequel.delay{Sequel.synchronize{key}}), :inherited=>true)
           subclass.instance_eval do
             @dataset = @dataset.with_row_proc(rp)
             @sti_key_array = key

data/lib/sequel/plugins/subclasses.rb

@@ -5,7 +5,7 @@ module Sequel
     # The Subclasses plugin keeps track of all subclasses of the
     # current model class.  Direct subclasses are available via the
     # subclasses method, and all descendent classes are available via the
-    # descendents method.
+    # descendents method:
     #
     #   c = Class.new(Sequel::Model)
     #   c.plugin :subclasses
@@ -18,6 +18,14 @@ module Sequel
     #   ssc1.subclasses # []
     #   c.descendents   # [sc1, ssc1, sc2]
     #
+    # You can also finalize the associations and then freeze the classes
+    # in all descendent classes.  Doing so is a recommended practice after
+    # all models have been defined in production and testing, and this makes
+    # it easier that keeping track of the classes to finalize and freeze
+    # manually:
+    #
+    #   c.freeze_descendants
+    #
     # You can provide a block when loading the plugin, and it will be called
     # with each subclass created:
     #
@@ -47,6 +55,12 @@ module Sequel
           Sequel.synchronize{subclasses.dup}.map{|x| [x] + x.send(:descendents)}.flatten
         end
 
+        # Freeze all descendent classes.  This also finalizes the associations for those
+        # classes before freezing.
+        def freeze_descendents
+          descendents.each(&:finalize_associations).each(&:freeze)
+        end
+
         Plugins.inherited_instance_variables(self, :@subclasses=>lambda{|v| []}, :@on_subclass=>nil)
 
         # Add the subclass to this model's current subclasses,

data/lib/sequel/plugins/touch.rb

@@ -63,6 +63,13 @@ module Sequel
 
         Plugins.inherited_instance_variables(self, :@touched_associations=>:dup, :@touch_column=>nil)
 
+        # Freeze the touched associations when freezing the model class.
+        def freeze
+          @touched_associations.freeze
+
+          super
+        end
+
         # Add additional associations to be touched.  See the :association option
         # of the Sequel::Plugin::Touch.configure method for the format of the associations
         # arguments.

data/lib/sequel/plugins/tree.rb

@@ -63,6 +63,13 @@ module Sequel
 
         Plugins.inherited_instance_variables(self, :@parent_column=>nil, :@tree_order=>nil)
 
+        # Should freeze tree order if it is an array when freezing the model class.
+        def freeze
+          @tree_order.freeze if @tree_order.is_a?(Array)
+        
+          super
+        end
+
         # Returns list of all root nodes (those with no parent nodes).
         #
         #   TreeClass.roots # => [root1, root2]

data/lib/sequel/plugins/typecast_on_load.rb

@@ -44,6 +44,13 @@ module Sequel
           super.load_typecast
         end
 
+        # Freeze typecast on load columns when freezing model class.
+        def freeze
+          @typecast_on_load_columns.freeze
+
+          super
+        end
+
         Plugins.inherited_instance_variables(self, :@typecast_on_load_columns=>:dup)
       end
 

data/lib/sequel/plugins/update_refresh.rb

@@ -27,16 +27,36 @@ module Sequel
     # +columns+ option. This can be a performance gain if it
     # would avoid pointlessly comparing many other columns.
     # Note that this option currently only has an effect if the
-    # dataset # supports RETURNING.
+    # dataset supports RETURNING.
     #
     #   # Only include the artist column in RETURNING
     #   Album.plugin :update_refresh, :columns => :artist
     #
     #   # Only include the artist and title columns in RETURNING
     #   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
+          @update_refresh_columns = Array(opts[:columns]) || []
+        end
+      end
+
+      module ClassMethods
+        # The specific columns to refresh when updating, if UPDATE RETURNING is supported.
+        attr_reader :update_refresh_columns
+
+        # Freeze the update refresh columns when freezing the model class.
+        def freeze
+          @update_refresh_columns.freeze
+
+          super
+        end
+      end
+
       module InstanceMethods
+        # If the dataset does not support UPDATE RETURNING, then refresh after an update.
         def after_update
           super
           unless this.supports_returning?(:update)
@@ -46,6 +66,8 @@ module Sequel
 
         private
 
+        # If the dataset supports UPDATE RETURNING, use it to do the refresh in the same
+        # query as the update.
         def _update_without_checking(columns)
           ds = _update_dataset
           if ds.supports_returning?(:update)
@@ -61,17 +83,6 @@ module Sequel
           end
         end
       end
-
-      module ClassMethods
-        attr_reader :update_refresh_columns
-      end
-
-      def self.configure(model, opts=OPTS)
-        model.instance_eval do
-          @update_refresh_columns = Array(opts[:columns]) || []
-        end
-      end
-
     end
   end
 end

data/lib/sequel/plugins/validation_class_methods.rb

@@ -39,6 +39,19 @@ module Sequel
         # options.
         attr_reader :validation_reflections
 
+        # Freeze validation metadata when freezing model class.
+        def freeze
+          @validations.freeze.each_value(&:freeze)
+          @validation_reflections.freeze.each_value do |vs|
+            vs.freeze.each do |v|
+              v.freeze
+              v.last.freeze
+            end
+          end
+
+          super
+        end
+
         # The Generator class is used to generate validation definitions using 
         # the validates {} idiom.
         class Generator

data/lib/sequel/sql.rb

@@ -62,6 +62,11 @@ module Sequel
       end
     end
 
+    # Show that this is an SQLTime, and the time represented
+    def inspect
+     "#<#{self.class} #{to_s}>"
+    end
+
     # Return a string in HH:MM:SS format representing the time.
     def to_s(*args)
       if args.empty?
@@ -1054,6 +1059,20 @@ module Sequel
       def lit(*args)
         args.empty? ? LiteralString.new(self) : SQL::PlaceholderLiteralString.new(self, args)
       end
+
+      # Return a string showing that this is a blob, the size, and the some or all of the content,
+      # depending on the size.
+      def inspect
+        size = length
+
+        content = if size > 20
+          "start=#{self[0...10].to_s.inspect} end=#{self[-10..-1].to_s.inspect}"
+        else
+          "content=#{super}"
+        end
+
+        "#<#{self.class}:0x#{"%x" % object_id} bytes=#{size} #{content}>"
+      end
       
       # Returns +self+, since it is already a blob.
       def to_sequel_blob
@@ -1801,6 +1820,10 @@ module Sequel
     # ruby array of two element arrays as an SQL value list instead of an ordered
     # hash-like conditions specifier.
     class ValueList < ::Array
+      # Show that this is a value list and not just an array
+      def inspect
+        "#<#{self.class} #{super}>"
+      end
     end
 
     # The purpose of the +VirtualRow+ class is to allow the easy creation of SQL identifiers and functions
@@ -1990,6 +2013,11 @@ module Sequel
     include SQL::InequalityMethods
     include SQL::AliasMethods
     include SQL::CastMethods
+
+    # Show that the current string is a literal string in addition to the output.
+    def inspect
+      "#<#{self.class} #{super}>"
+    end
       
     # Return self if no args are given, otherwise return a SQL::PlaceholderLiteralString
     # with the current string and the given args.

data/lib/sequel/version.rb

@@ -5,7 +5,7 @@ module Sequel
   MAJOR = 4
   # The minor version of Sequel.  Bumped for every non-patch level
   # release, generally around once a month.
-  MINOR = 43
+  MINOR = 44
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.
   TINY  = 0

data/spec/adapters/postgres_spec.rb

@@ -2,6 +2,9 @@ SEQUEL_ADAPTER_TEST = :postgres
 
 require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
+uses_pg = Sequel::Postgres::USES_PG if DB.adapter_scheme == :postgres
+uses_pg_or_jdbc = uses_pg || DB.adapter_scheme == :jdbc
+
 def DB.sqls
   (@sqls ||= [])
 end
@@ -361,7 +364,7 @@ describe "A PostgreSQL database" do
     a = nil
     Sequel.connect(DB.opts.merge(:notice_receiver=>proc{|r| a = r.result_error_message})){|db| db.do("BEGIN\nRAISE WARNING 'foo';\nEND;")}
     a.must_equal "WARNING:  foo\n"
-  end if DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG && DB.server_version >= 90000
+  end if uses_pg && DB.server_version >= 90000
 
   # These only test the SQL created, because a true test using file_fdw or postgres_fdw
   # requires superuser permissions, and you should not be running the tests as a superuser.
@@ -524,7 +527,7 @@ describe "A PostgreSQL dataset" do
     info[:constraint].must_be_nil
     info[:column].must_equal 't2'
     info[:type].must_be_nil
-  end if DB.server_version >= 90300 && DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG && Object.const_defined?(:PG) && ::PG.const_defined?(:Constants) && ::PG::Constants.const_defined?(:PG_DIAG_SCHEMA_NAME)
+  end if DB.server_version >= 90300 && uses_pg && Object.const_defined?(:PG) && ::PG.const_defined?(:Constants) && ::PG::Constants.const_defined?(:PG_DIAG_SCHEMA_NAME)
 
   it "should support Database#do for executing anonymous code blocks" do
     @db.drop_table?(:btest)
@@ -1776,7 +1779,7 @@ if DB.adapter_scheme == :postgres
   end
 end
 
-if ((DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc) && DB.server_version >= 90000
+if uses_pg_or_jdbc && DB.server_version >= 90000
   describe "Postgres::Database#copy_into" do
     before(:all) do
       @db = DB
@@ -1928,7 +1931,7 @@ if ((DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_sc
   end
 end
 
-if DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG && DB.server_version >= 90000
+if uses_pg && DB.server_version >= 90000
   describe "Postgres::Database LISTEN/NOTIFY" do
     before(:all) do
       @db = DB
@@ -2416,7 +2419,7 @@ describe 'PostgreSQL array handling' do
     @ds.get(:i).must_equal a
     @ds.filter(:i=>:$i).call(:first, :i=>a).must_equal(:i=>a)
     @ds.filter(:i=>:$i).call(:first, :i=>Sequel.pg_array([Sequel.blob("b\0")], 'bytea')).must_be_nil
-  end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+  end if uses_pg_or_jdbc
 
   it 'with models' do
     @db.create_table!(:items) do
@@ -2604,7 +2607,7 @@ describe 'PostgreSQL hstore handling' do
     @ds.get(:i).must_equal @h
     @ds.filter(:i=>:$i).call(:first, :i=>@h).must_equal(:i=>@h)
     @ds.filter(:i=>:$i).call(:first, :i=>{}).must_be_nil
-  end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+  end if uses_pg_or_jdbc
 
   it 'with models and associations' do
     @db.create_table!(:items) do
@@ -2877,7 +2880,7 @@ describe 'PostgreSQL json type' do
       j = Sequel.pg_array([pg_json.call('a'=>1), pg_json.call(['b', 2])], json_type)
       @ds.call(:insert, {:i=>j}, {:i=>:$i})
       @ds.get(:i).must_equal j
-    end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+    end if uses_pg_or_jdbc
 
     it 'operations/functions with pg_json_ops' do
       Sequel.extension :pg_json_ops
@@ -3072,7 +3075,7 @@ describe 'PostgreSQL inet/cidr types' do
     @ds.filter(:i=>:$i, :c=>:$c, :m=>:$m).call(:first, :i=>[@ipv4], :c=>[@ipv4nm], :m=>['12:34:56:78:90:ab']).must_equal(:i=>[@ipv4], :c=>[@ipv4nm], :m=>['12:34:56:78:90:ab'])
     @ds.filter(:i=>:$i, :c=>:$c, :m=>:$m).call(:first, :i=>[], :c=>[], :m=>[]).must_be_nil
     @ds.filter(:i=>:$i, :c=>:$c, :m=>:$m).call(:delete, :i=>[@ipv4], :c=>[@ipv4nm], :m=>['12:34:56:78:90:ab']).must_equal 1
-  end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+  end if uses_pg_or_jdbc
 
   it 'with models' do
     @db.create_table!(:items) do
@@ -3235,7 +3238,7 @@ describe 'PostgreSQL range types' do
     @ds.filter(h).call(:first, @pgra).each{|k, v| v.must_be :==, @ra[k].to_a}
     @ds.filter(h).call(:first, r2).must_be_nil
     @ds.filter(h).call(:delete, @ra).must_equal 1
-  end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+  end if uses_pg_or_jdbc
 
   it 'with models' do
     @db.create_table!(:items){primary_key :id; int4range :i4; int8range :i8; numrange :n; daterange :d; tsrange :t; tstzrange :tz}
@@ -3416,7 +3419,7 @@ describe 'PostgreSQL interval types' do
     @ds.filter(:i=>:$i).call(:first, :i=>[d]).must_equal(:i=>[d])
     @ds.filter(:i=>:$i).call(:first, :i=>[]).must_be_nil
     @ds.filter(:i=>:$i).call(:delete, :i=>[d]).must_equal 1
-  end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+  end if uses_pg_or_jdbc
 
   it 'with models' do
     @db.create_table!(:items) do
@@ -3533,7 +3536,7 @@ describe 'PostgreSQL row-valued/composite types' do
     @ds.delete
     @ds.call(:insert, {:address=>Sequel.pg_row([nil, nil, nil])}, {:address=>:$address, :id=>1})
     @ds.get(:address).must_equal(:street=>nil, :city=>nil, :zip=>nil)
-  end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+  end if uses_pg_or_jdbc
 
   it 'use arrays of row types in bound variables' do
     @ds = @db[:company]
@@ -3545,7 +3548,7 @@ describe 'PostgreSQL row-valued/composite types' do
     @ds.delete
     @ds.call(:insert, {:employees=>Sequel.pg_array([@db.row_type(:person, [1, Sequel.pg_row([nil, nil, nil])])])}, {:employees=>:$employees, :id=>1})
     @ds.get(:employees).must_equal [{:address=>{:city=>nil, :zip=>nil, :street=>nil}, :id=>1}]
-  end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+  end if uses_pg_or_jdbc
 
   it 'operations/functions with pg_row_ops' do
     @ds.insert(:id=>1, :address=>Sequel.pg_row(['123 Sesame St', 'Somewhere', '12345']))
@@ -3671,7 +3674,7 @@ describe 'PostgreSQL row-valued/composite types' do
       @ds.get(:address).must_equal @a
       @ds.filter(:address=>Sequel.cast(:$address, :address)).call(:first, :address=>@a)[:id].must_equal 1
       @ds.filter(:address=>Sequel.cast(:$address, :address)).call(:first, :address=>Address.new(:street=>'123 Sesame St', :city=>'Somewhere', :zip=>'12356')).must_be_nil
-    end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+    end if uses_pg_or_jdbc
 
     it 'use arrays of model objects in bound variables' do
       @ds = @db[:company]
@@ -3679,7 +3682,7 @@ describe 'PostgreSQL row-valued/composite types' do
       @ds.get(:company).must_equal Company.new(:id=>1, :employees=>@es)
       @ds.filter(:employees=>Sequel.cast(:$employees, 'person[]')).call(:first, :employees=>@es)[:id].must_equal 1
       @ds.filter(:employees=>Sequel.cast(:$employees, 'person[]')).call(:first, :employees=>Sequel.pg_array([@db.row_type(:person, [1, Sequel.pg_row(['123 Sesame St', 'Somewhere', '12356'])])])).must_be_nil
-    end if (DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG) || DB.adapter_scheme == :jdbc
+    end if uses_pg_or_jdbc
 
     it 'model typecasting' do
       Person.plugin :pg_typecast_on_load, :address unless @native
@@ -3744,7 +3747,7 @@ describe 'pg_static_cache_updater extension' do
     q1.push(proc{throw :stop})
     q.pop
   end
-end if DB.adapter_scheme == :postgres && SEQUEL_POSTGRES_USES_PG && DB.server_version >= 90000
+end if uses_pg && DB.server_version >= 90000
 
 describe 'PostgreSQL enum types' do
   before do