sequel 5.34.0 → 5.39.0

data/lib/sequel/plugins/forbid_lazy_load.rb

@@ -111,7 +111,9 @@ module Sequel
         # an association, allow lazy loading that association, since the
         # lazy association load will use a hash table lookup and not a query.
         def allow_lazy_load_for_static_cache_associations
+          # :nocov:
           if defined?(::Sequel::Plugins::StaticCache::ClassMethods)
+          # :nocov:
             @association_reflections.each_value do |ref|
               if ref.associated_class.is_a?(::Sequel::Plugins::StaticCache::ClassMethods)
                 ref[:forbid_lazy_load] = false

data/lib/sequel/plugins/instance_specific_default.rb

@@ -0,0 +1,113 @@
+# frozen-string-literal: true
+
+module Sequel
+  module Plugins
+    # The instance_specific_default plugin exists to make it easier to use a
+    # global :instance_specific association option, or to warn or raise when Sequel
+    # has to guess which value to use :instance_specific option (Sequel defaults to
+    # guessing true as that is the conservative setting).  It is helpful to
+    # use this plugin, particularly with the :warn or :raise settings, to determine
+    # which associations should have :instance_specific set.  Setting the
+    # :instance_specific to false for associations that are not instance specific
+    # can improve performance.
+    #
+    # Associations are instance-specific if their block calls
+    # a model instance method, or where the value of the block varies
+    # based on runtime state, and the variance is outside of a delayed evaluation.
+    # For example, with the following three associations:
+    #
+    #   Album.one_to_one :first_track, class: :Track do |ds|
+    #     ds.where(number: 1)
+    #   end
+    #
+    #   Album.one_to_one :last_track, class: :Track do |ds|
+    #     ds.where(number: num_tracks)
+    #   end
+    #
+    #   Album.one_to_many :recent_tracks, class: :Track do |ds|
+    #     ds.where{date_updated > Date.today - 10}
+    #   end
+    #
+    # +first_track+ is not instance specific, but +last_track+ and +recent_tracks+ are.
+    # +last_trac+ is because the +num_tracks+ call in the block is calling
+    # <tt>Album#num_tracks</tt>.  +recent_tracks+ is because the value will change over
+    # time. This plugin allows you to find these cases, and set the :instance_specific
+    # option appropriately for them:
+    #
+    #   Album.one_to_one :first_track, class: :Track, instance_specific: false do |ds|
+    #     ds.where(number: 1)
+    #   end
+    #
+    #   Album.one_to_one :last_track, class: :Track, instance_specific: true do |ds|
+    #     ds.where(number: num_tracks)
+    #   end
+    #
+    #   Album.one_to_many :recent_tracks, class: :Track, instance_specific: true do |ds|
+    #     ds.where{date_updated > Date.today - 10}
+    #   end
+    #
+    # For the +recent_tracks+ association, instead of marking it instance_specific, you
+    # could also use a delayed evaluation, since it doesn't actually contain
+    # instance-specific code:
+    #
+    #   Album.one_to_many :recent_tracks, class: :Track, instance_specific: false do |ds|
+    #     ds.where{date_updated > Sequel.delay{Date.today - 10}}
+    #   end
+    #
+    # Possible arguments to provide when loading the plugin:
+    #
+    # true :: Set the :instance_specific option to true
+    # false :: Set the :instance_specific option to false
+    # :default :: Call super to set the :instance_specific option
+    # :warn :: Emit a warning before calling super to set the :instance_specific option
+    # :raise :: Raise a Sequel::Error if an :instance_specific option is not provided and
+    #           an association could be instance-specific.
+    #
+    # Note that this plugin only affects associations which could be instance
+    # specific (those with blocks), where the :instance_specific option was not
+    # specified when the association was created.
+    #
+    # Usage:
+    #
+    #   # Set how to handle associations that could be instance specific
+    #   # but did not specify an :instance_specific option, for all subclasses
+    #   # (set before creating subclasses).
+    #   Sequel::Model.plugin :instance_specific_default, :warn
+    #
+    #   # Set how to handle associations that could be instance specific
+    #   # but did not specify an :instance_specific option, for the Album class
+    #   Album.plugin :instance_specific_default, :warn
+    module InstanceSpecificDefault
+      # Set how to handle associations that could be instance specific but did
+      # not specify an :instance_specific value.
+      def self.configure(model, default)
+        model.instance_variable_set(:@instance_specific_default, default)
+      end
+
+      module ClassMethods
+        Plugins.inherited_instance_variables(self, :@instance_specific_default=>nil)
+
+        private
+
+        # Return the appropriate :instance_specific value, or warn or raise if
+        # configured.
+        def _association_instance_specific_default(name)
+          case @instance_specific_default
+          when true, false
+            return @instance_specific_default
+          when :default
+            # nothing
+          when :warn
+            warn("possibly instance-specific association without :instance_specific option (class: #{self}, association: #{name})", :uplevel => 3)
+          when :raise
+            raise Sequel::Error, "possibly instance-specific association without :instance_specific option (class: #{self}, association: #{name})"
+          else
+            raise Sequel::Error, "invalid value passed to instance_specific_default plugin: #{@instance_specific_default.inspect}"
+          end
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/lazy_attributes.rb

@@ -98,7 +98,7 @@ module Sequel
           end
 
           if retrieved_with
-            raise(Error, "Invalid primary key column for #{model}: #{pkc.inspect}") unless primary_key = model.primary_key
+            primary_key = model.primary_key
             composite_pk = true if primary_key.is_a?(Array)
             id_map = {}
             retrieved_with.each{|o| id_map[o.pk] = o unless o.values.has_key?(a) || o.frozen?}

data/lib/sequel/plugins/pg_array_associations.rb

@@ -341,10 +341,9 @@ module Sequel
             eo[:loader] = false
 
             eager_load_results(opts, eo) do |assoc_record|
-              if pks ||= assoc_record.get_column_value(key)
+              if pks = assoc_record.get_column_value(key)
                 pks.each do |pkv|
-                  next unless objects = id_map[pkv]
-                  objects.each do |object| 
+                  id_map[pkv].each do |object| 
                     object.associations[name].push(assoc_record)
                   end
                 end

data/lib/sequel/plugins/prepared_statements.rb

@@ -41,11 +41,9 @@ module Sequel
         # Create a prepared statement, but modify the SQL used so that the model's columns are explicitly
         # selected instead of using *, assuming that the dataset selects from a single table.
         def prepare_explicit_statement(ds, type, vals=OPTS)
-          f = ds.opts[:from]
-          meth = type == :insert_select ? :returning : :select
-          s = ds.opts[meth]
-          if f && f.length == 1 && !ds.opts[:join] && (!s || s.empty?)
-            ds = ds.public_send(meth, *columns.map{|c| Sequel.identifier(c)})
+          s = ds.opts[:returning]
+          if !s || s.empty?
+            ds = ds.returning(*columns.map{|c| Sequel.identifier(c)})
           end 
           
           prepare_statement(ds, type, vals)
@@ -70,9 +68,7 @@ module Sequel
         # Return a prepared statement that can be used to insert a row using the given columns
         # and return that column values for the row created.
         def prepared_insert_select(cols)
-          if dataset.supports_insert_select?
-            cached_prepared_statement(:insert_select, prepared_columns(cols)){prepare_explicit_statement(naked.clone(:server=>dataset.opts.fetch(:server, :default)), :insert_select, prepared_statement_key_hash(cols))}
-          end
+          cached_prepared_statement(:insert_select, prepared_columns(cols)){prepare_explicit_statement(naked.clone(:server=>dataset.opts.fetch(:server, :default)), :insert_select, prepared_statement_key_hash(cols))}
         end
 
         # Return an array of two element arrays with the column symbol as the first entry and the
@@ -138,9 +134,7 @@ module Sequel
         # and return the new column values.
         def _insert_select_raw(ds)
           if use_prepared_statements_for?(:insert_select)
-            if ps = model.send(:prepared_insert_select, @values.keys)
-              _set_prepared_statement_server(ps).call(@values)
-            end
+            _set_prepared_statement_server(model.send(:prepared_insert_select, @values.keys)).call(@values)
           else
             super
           end

data/lib/sequel/plugins/prepared_statements_safe.rb

@@ -66,9 +66,7 @@ module Sequel
         # Merge the current values into the default values to reduce the number
         # of free columns.
         def before_create
-          if v = model.prepared_statements_column_defaults
-            @values = v.merge(values)
-          end
+          @values = model.prepared_statements_column_defaults.merge(@values)
           super
         end
 

data/lib/sequel/plugins/rcte_tree.rb

@@ -194,21 +194,17 @@ module Sequel
           ds = ds.select_append(ka) unless ds.opts[:select] == nil
           model.eager_load_results(r, eo.merge(:loader=>false, :initialize_rows=>false, :dataset=>ds, :id_map=>nil)) do |obj|
             opk = prkey_conv[obj]
-            if parent_map.has_key?(opk)
-              if idm_obj = parent_map[opk]
-                key_aliases.each{|ka_| idm_obj.values[ka_] = obj.values[ka_]}
-                obj = idm_obj
-              end
+            if idm_obj = parent_map[opk]
+              key_aliases.each{|ka_| idm_obj.values[ka_] = obj.values[ka_]}
+              obj = idm_obj
             else
               obj.associations[parent] = nil
               parent_map[opk] = obj
               (children_map[key_conv[obj]] ||= []) << obj
             end
             
-            if roots = id_map[extract_key_alias[obj]]
-              roots.each do |root|
-                root.associations[ancestors] << obj
-              end
+            id_map[extract_key_alias[obj]].each do |root|
+              root.associations[ancestors] << obj
             end
           end
           parent_map.each do |parent_id, obj|
@@ -306,11 +302,9 @@ module Sequel
             end
             
             opk = prkey_conv[obj]
-            if parent_map.has_key?(opk)
-              if idm_obj = parent_map[opk]
-                key_aliases.each{|ka_| idm_obj.values[ka_] = obj.values[ka_]}
-                obj = idm_obj
-              end
+            if idm_obj = parent_map[opk]
+              key_aliases.each{|ka_| idm_obj.values[ka_] = obj.values[ka_]}
+              obj = idm_obj
             else
               obj.associations[childrena] = [] unless no_cache
               parent_map[opk] = obj

data/lib/sequel/plugins/single_table_inheritance.rb

@@ -250,6 +250,13 @@ module Sequel
           end
           super
         end
+
+        private
+
+        # Don't allow use of prepared statements.
+        def use_prepared_statements_for?(type)
+          false
+        end
       end
     end
   end

data/lib/sequel/plugins/string_stripper.rb

@@ -28,7 +28,7 @@ module Sequel
         model.plugin(:input_transformer, :string_stripper){|v| (v.is_a?(String) && !v.is_a?(SQL::Blob)) ? v.strip : v}
       end
       def self.configure(model)
-        model.instance_exec{set_skipped_string_stripping_columns if @dataset}
+        model.send(:set_skipped_string_stripping_columns)
       end
 
       module ClassMethods

data/lib/sequel/plugins/tree.rb

@@ -45,6 +45,7 @@ module Sequel
 
         model.instance_exec do
           @parent_column = opts[:key]
+          @qualified_parent_column = Sequel.deep_qualify(table_name, opts[:key])
           @tree_order = opts[:order]
           @parent_association_name = parent
           @children_association_name = children
@@ -59,17 +60,21 @@ module Sequel
         # The column symbol or array of column symbols on which to order the tree.
         attr_accessor :tree_order
         
-        # The symbol for the column containing the value pointing to the
-        # parent of the leaf.
+        # The symbol or array of symbols for the column containing the value pointing to the
+        # parent of the node.
         attr_accessor :parent_column
 
+        # The qualified identifier or array of qualified identifiers for the column
+        # containing the value pointing to the parent of the node.
+        attr_accessor :qualified_parent_column
+
         # The association name for the parent association
         attr_reader :parent_association_name
 
         # The association name for the children association
         attr_reader :children_association_name
 
-        Plugins.inherited_instance_variables(self, :@parent_column=>nil, :@tree_order=>nil, :@parent_association_name=>nil, :@children_association_name=>nil)
+        Plugins.inherited_instance_variables(self, :@parent_column=>nil, :@qualified_parent_column=>nil, :@tree_order=>nil, :@parent_association_name=>nil, :@children_association_name=>nil)
         Plugins.def_dataset_methods(self, [:roots, :roots_dataset])
 
         # Should freeze tree order if it is an array when freezing the model class.
@@ -151,7 +156,7 @@ module Sequel
         #
         #   TreeClass.roots_dataset # => Sequel::Dataset instance
         def roots_dataset
-          ds = where(Sequel.or(Array(model.parent_column).zip([])))
+          ds = where(Sequel.or(Array(model.qualified_parent_column).zip([])))
           ds = ds.order(*model.tree_order) if model.tree_order
           ds
         end

data/lib/sequel/plugins/validation_class_methods.rb

@@ -194,7 +194,11 @@ module Sequel
         def validates_each(*atts, &block)
           opts = extract_options!(atts)
           blank_meth = db.method(:blank_object?).to_proc
-          blk = if (i = opts[:if]) || (am = opts[:allow_missing]) || (an = opts[:allow_nil]) || (ab = opts[:allow_blank])
+          i = opts[:if]
+          am = opts[:allow_missing]
+          an = opts[:allow_nil]
+          ab = opts[:allow_blank]
+          blk = if i || am || an || ab
             if i.is_a?(Proc)
               i = Plugins.def_sequel_method(self, "validation_class_methods_if", 0, &i)
             end

data/lib/sequel/timezones.rb

@@ -10,9 +10,14 @@ module Sequel
   Timezones = SequelMethods
   Deprecation.deprecate_constant(self, :Timezones)
   
-  # Sequel doesn't pay much attention to timezones by default, but you can set it
-  # handle timezones if you want.  There are three separate timezone settings, application_timezone,
-  # database_timezone, and typecast_timezone.  All three timezones have getter and setter methods.
+  # Sequel doesn't pay much attention to timezones by default, but you can set it to
+  # handle timezones if you want.  There are three separate timezone settings:
+  #
+  # * application_timezone
+  # * database_timezone
+  # * typecast_timezone
+  #
+  # All three timezones have getter and setter methods.
   # You can set all three timezones to the same value at once via <tt>Sequel.default_timezone=</tt>.
   #
   # The only timezone values that are supported by default are <tt>:utc</tt> (convert to UTC),

data/lib/sequel/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel
 version: !ruby/object:Gem::Version
-  version: 5.34.0
+  version: 5.39.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -147,6 +147,7 @@ extra_rdoc_files:
 - doc/testing.rdoc
 - doc/validations.rdoc
 - doc/transactions.rdoc
+- doc/fork_safety.rdoc
 - doc/release_notes/5.5.0.txt
 - doc/release_notes/5.6.0.txt
 - doc/release_notes/5.0.0.txt
@@ -182,6 +183,11 @@ extra_rdoc_files:
 - doc/release_notes/5.32.0.txt
 - doc/release_notes/5.33.0.txt
 - doc/release_notes/5.34.0.txt
+- doc/release_notes/5.35.0.txt
+- doc/release_notes/5.36.0.txt
+- doc/release_notes/5.37.0.txt
+- doc/release_notes/5.38.0.txt
+- doc/release_notes/5.39.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -196,6 +202,7 @@ files:
 - doc/dataset_basics.rdoc
 - doc/dataset_filtering.rdoc
 - doc/extensions.rdoc
+- doc/fork_safety.rdoc
 - doc/mass_assignment.rdoc
 - doc/migration.rdoc
 - doc/model_dataset_method_design.rdoc
@@ -237,6 +244,11 @@ files:
 - doc/release_notes/5.32.0.txt
 - doc/release_notes/5.33.0.txt
 - doc/release_notes/5.34.0.txt
+- doc/release_notes/5.35.0.txt
+- doc/release_notes/5.36.0.txt
+- doc/release_notes/5.37.0.txt
+- doc/release_notes/5.38.0.txt
+- doc/release_notes/5.39.0.txt
 - doc/release_notes/5.4.0.txt
 - doc/release_notes/5.5.0.txt
 - doc/release_notes/5.6.0.txt
@@ -462,6 +474,7 @@ files:
 - lib/sequel/plugins/insert_returning_select.rb
 - lib/sequel/plugins/instance_filters.rb
 - lib/sequel/plugins/instance_hooks.rb
+- lib/sequel/plugins/instance_specific_default.rb
 - lib/sequel/plugins/inverted_subsets.rb
 - lib/sequel/plugins/json_serializer.rb
 - lib/sequel/plugins/lazy_attributes.rb
@@ -542,7 +555,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The Database Toolkit for Ruby