sequel 5.95.0 → 5.99.0

data/lib/sequel/plugins/deprecated_associations.rb

@@ -0,0 +1,151 @@
+# frozen-string-literal: true
+
+module Sequel
+  module Plugins
+    # The deprecated_associations plugin adds support for
+    # deprecating associations. Attempts to use association
+    # methods and access association metadata for deprecated
+    # associations results in a warning.
+    #
+    #   Album.plugin :deprecated_associations
+    #   Album.many_to_one :artist, deprecated: true
+    #   album = Album[1]
+    #
+    #   # Warnings for all of the following calls
+    #   album.artist
+    #   album.artist_dataset
+    #   album.artist = Artist[2]
+    #   Album.association_reflection(:artist)
+    #   Album.eager(:artist)
+    #   Album.eager_graph(:artist)
+    #   Album.where(artist: Artist[1]).all
+    #
+    # By default, the plugin issues a single warning per
+    # association method or association reflection. See
+    # DeprecatedAssociations.configure for options to make
+    # deprecated association issue warnings for every access,
+    # to include backtraces in warnings, or to raise an
+    # exception instead of warning.
+    #
+    # Note that Model.association_reflections and
+    # Model.all_association_reflections will include deprecated
+    # associations, and accessing the metadata for deprecated
+    # associations through these interfaces not issue warnings.
+    #
+    # Usage:
+    #
+    #   # Make all models support deprecated associations
+    #   # (called before loading subclasses)
+    #   Sequel::Model.plugin :deprecated_associations
+    #
+    #   # Make Album class support deprecated associations
+    #   Album.plugin :deprecated_associations
+    module DeprecatedAssociations
+      # Exception class used for deprecated association use when
+      # raising exceptions instead of emitting warnings.
+      class Access < Sequel::Error; end
+
+      # Configure the deprecated associations plugin. Options:
+      #
+      # backtrace: Print backtrace with warning
+      # deduplicate: Set to false to emit warnings for every
+      #              deprecated association method call/access
+      #              (when not caching associations, this is always false)
+      # raise: Raise Sequel::Plugin::DeprecatedAssociations::Access
+      #        instead of warning
+      def self.configure(model, opts = OPTS)
+        model.instance_exec do
+          (@deprecated_associations_config ||= {}).merge!(opts)
+        end
+      end
+
+      module ClassMethods
+        # Issue a deprecation warning if the association is deprecated.
+        def association_reflection(assoc)
+          ref = super
+          if ref && ref[:deprecated]
+            emit_deprecated_association_warning(ref, nil) do
+              "Access of association reflection for deprecated association: class:#{name} association:#{assoc}"
+            end
+          end
+          ref
+        end
+
+        private
+
+        # Issue a deprecation warning when the defined method is called if the
+        # association is deprecated and the method name does not start with the
+        # underscore (to avoid not warning twice, once for the public association
+        # method and once for the private association method).
+        def association_module_def(name, opts=OPTS, &block)
+          super
+          if opts[:deprecated] && name[0] != "_"
+            deprecated_associations_module.module_exec do
+              define_method(name) do |*a, &b|
+                self.class.send(:emit_deprecated_association_warning, opts, name) do
+                  "Calling deprecated association method: class:#{self.class.name} association:#{opts[:name]} method:#{name}"
+                end
+                super(*a, &b)
+              end
+              alias_method name, name
+            end
+          end
+          nil
+        end
+
+        # Issue a deprecation warning when the defined method is called if the
+        # association is deprecated.
+        def association_module_delegate_def(name, opts, &block)
+          super
+          if opts[:deprecated]
+            deprecated_associations_module.module_exec do
+              define_method(name) do |*a, &b|
+                self.class.send(:emit_deprecated_association_warning, opts, name) do
+                  "Calling deprecated association method: class:#{self.class.name} association:#{opts[:name]} method:#{name}"
+                end
+                super(*a, &b)
+              end
+              # :nocov:
+              ruby2_keywords(name) if respond_to?(:ruby2_keywords, true)
+              # :nocov:
+              alias_method(name, name)
+            end
+          end
+          nil
+        end
+
+        # A module to add deprecated association methods to. These methods
+        # handle issuing the deprecation warnings, and call super to get the
+        # default behavior.
+        def deprecated_associations_module
+          return @deprecated_associations_module if defined?(@deprecated_associations_module)
+          @deprecated_associations_module = Module.new
+          include(@deprecated_associations_module)
+          @deprecated_associations_module
+        end
+
+        # Emit a deprecation warning, or raise an exception if the :raise
+        # plugin option was used.
+        def emit_deprecated_association_warning(ref, method)
+          config = @deprecated_associations_config
+
+          raise Access, yield if config[:raise]
+
+          unless config[:deduplicate] == false
+            emit = false
+            ref.send(:cached_fetch, [:deprecated_associations, method]) do
+              emit = true
+            end
+            return unless emit
+          end
+
+          if config[:backtrace]
+            warn yield, caller(2)
+          else
+            warn yield, :uplevel => 2
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/insert_returning_select.rb

@@ -2,7 +2,7 @@
 
 module Sequel
   module Plugins
-    # If the model's dataset selects explicit columns and the
+    # If the model's dataset selects explicit columns (or table.*) and the
     # database supports it, the insert_returning_select plugin will
     # automatically set the RETURNING clause on the dataset used to
     # insert rows to the columns selected, which allows the default model
@@ -45,6 +45,9 @@ module Sequel
           ret
         end
 
+        RETURN_ALL = [Sequel::Dataset::WILDCARD].freeze
+        private_constant :RETURN_ALL
+
         # Determine the columns to use for the returning clause, or return nil
         # if they can't be determined and a returning clause should not be
         # added automatically.
@@ -52,6 +55,12 @@ module Sequel
           return unless ds.supports_returning?(:insert)
           return unless values = ds.opts[:select]
 
+          # SELECT table.* -> RETURNING *
+          if values.length == 1 && values[0].is_a?(Sequel::SQL::ColumnAll)
+            return RETURN_ALL
+          end
+
+          # SELECT column1, table.column2, ... -> RETURNING column1, column2, ...
           values = values.map{|v| ds.unqualified_column_for(v)}
           if values.all?
             values

data/lib/sequel/plugins/json_serializer.rb

@@ -106,13 +106,7 @@ module Sequel
     # and breaks some aspects of the json_serializer plugin.  You can undo the damage
     # done by active_support/json by doing:
     #
-    #   module ActiveSupportBrokenJSONFix
-    #     def to_json(options = {})
-    #       JSON.generate(self)
-    #     end
-    #   end
-    #   Array.send(:prepend, ActiveSupportBrokenJSONFix)
-    #   Hash.send(:prepend, ActiveSupportBrokenJSONFix)
+    #   ActiveSupport::ToJsonWithActiveSupportEncoder.send(:remove_method, :to_json)
     #
     # Note that this will probably cause active_support/json to no longer work
     # correctly in some cases.

data/lib/sequel/plugins/pg_array_associations.rb

@@ -541,7 +541,7 @@ module Sequel
             if (assoc_pks = obj.get_column_value(key)) && !assoc_pks.empty?
               Sequel[pk=>assoc_pks.to_a]
             end
-          when Array
+          when Array, Set
             if (assoc_pks = obj.map{|o| o.get_column_value(key)}.flatten.compact.uniq) && !assoc_pks.empty?
               Sequel[pk=>assoc_pks]
             end
@@ -563,7 +563,7 @@ module Sequel
             if pkv = obj.get_column_value(ref.primary_key_method)
               Sequel.pg_array_op(key).contains(Sequel.pg_array([pkv], ref.array_type))
             end
-          when Array
+          when Array, Set
             if (pkvs = obj.map{|o| o.get_column_value(ref.primary_key_method)}.compact) && !pkvs.empty?
               Sequel.pg_array(key).overlaps(Sequel.pg_array(pkvs, ref.array_type))
             end

data/lib/sequel/plugins/rcte_tree.rb

@@ -111,7 +111,7 @@ module Sequel
           ancestor_base_case_columns = prkey_array.zip(key_aliases).map{|k, ka_| SQL::AliasedExpression.new(k, ka_)} + c_all
           descendant_base_case_columns = key_array.zip(key_aliases).map{|k, ka_| SQL::AliasedExpression.new(k, ka_)} + c_all
           recursive_case_columns = prkey_array.zip(key_aliases).map{|k, ka_| SQL::QualifiedIdentifier.new(t, ka_)} + c_all
-          extract_key_alias = lambda{|m| key_aliases.map{|ka_| bd_conv[m.values.delete(ka_)]}}
+          extract_key_alias = lambda{|m| key_aliases.map{|ka_| bd_conv[m.remove_key!(ka_)]}}
         else
           key_present = key_conv = lambda{|m| m[key]}
           prkey_conv = lambda{|m| m[prkey]}
@@ -119,7 +119,7 @@ module Sequel
           ancestor_base_case_columns = [SQL::AliasedExpression.new(prkey, ka)] + c_all
           descendant_base_case_columns = [SQL::AliasedExpression.new(key, ka)] + c_all
           recursive_case_columns = [SQL::QualifiedIdentifier.new(t, ka)] + c_all
-          extract_key_alias = lambda{|m| bd_conv[m.values.delete(ka)]}
+          extract_key_alias = lambda{|m| bd_conv[m.remove_key!(ka)]}
         end
         
         parent = opts.merge(opts.fetch(:parent, OPTS)).fetch(:name, :parent)
@@ -200,7 +200,7 @@ module Sequel
           model.eager_load_results(r, eo.merge(:loader=>false, :initialize_rows=>false, :dataset=>ds, :id_map=>nil)) do |obj|
             opk = prkey_conv[obj]
             if idm_obj = parent_map[opk]
-              key_aliases.each{|ka_| idm_obj.values[ka_] = obj.values[ka_]}
+              key_aliases.each{|ka_| idm_obj[ka_] = obj[ka_]}
               obj = idm_obj
             else
               obj.associations[parent] = nil
@@ -307,12 +307,12 @@ 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, :associations=>OPTS)) do |obj|
             if level
-              no_cache = no_cache_level == obj.values.delete(la)
+              no_cache = no_cache_level == obj.remove_key!(la)
             end
             
             opk = prkey_conv[obj]
             if idm_obj = parent_map[opk]
-              key_aliases.each{|ka_| idm_obj.values[ka_] = obj.values[ka_]}
+              key_aliases.each{|ka_| idm_obj[ka_] = obj[ka_]}
               obj = idm_obj
             else
               obj.associations[childrena] = [] unless no_cache

data/lib/sequel/plugins/split_values.rb

@@ -54,6 +54,16 @@ module Sequel
           end
         end
 
+        # Remove the key from noncolumn values if it is present there. If it is not
+        # present there, then use the default behavior of removing it from values.
+        def remove_key!(key)
+          if @noncolumn_values && @noncolumn_values.key?(key)
+            @noncolumn_values.delete(key)
+          else
+            super
+          end
+        end
+
         # Check all entries in the values hash.  If any of the keys are not columns,
         # move the entry into the noncolumn_values hash.
         def split_noncolumn_values

data/lib/sequel/plugins/static_cache.rb

@@ -176,6 +176,19 @@ module Sequel
           h
         end
 
+        # Use the cache instead of a query to get the results.
+        def as_set(column)
+          set = Set.new
+
+          if column.is_a?(Array)
+            @all.each{|r| set.add(r.values.values_at(*column))}
+          else
+            @all.each{|r| set.add(r[column])}
+          end
+
+          set
+        end
+
         # Alias of as_hash for backwards compatibility.
         def to_hash(*a)
           as_hash(*a)

data/lib/sequel/plugins/subset_static_cache.rb

@@ -226,6 +226,21 @@ module Sequel
           h
         end
 
+        # Use the cache instead of a query to get the results.
+        def as_set(column)
+          return super unless all = @cache[:subset_static_cache_all]
+
+          set = Set.new
+
+          if column.is_a?(Array)
+            all.each{|r| set.add(r.values.values_at(*column))}
+          else
+            all.each{|r| set.add(r[column])}
+          end
+
+          set
+        end
+
         # Alias of as_hash for backwards compatibility.
         def to_hash(*a)
           as_hash(*a)

data/lib/sequel/plugins/table_select.rb

@@ -9,6 +9,13 @@ module Sequel
     # in the result sets (and possibly overwrite columns in the
     # current model with the same name).
     #
+    # Note that by default on databases that supporting RETURNING,
+    # using this plugin will cause instance creations
+    # to use two queries (insert and refresh) instead of a single
+    # query using RETURNING.  You can use the insert_returning_select
+    # plugin to automatically use RETURNING for instance creations
+    # for models using this plugin.
+    #
     # Usage:
     #
     #   # Make all model subclasses select table.*

data/lib/sequel/sql.rb

@@ -1108,7 +1108,7 @@ module Sequel
           else
             new(:'=', 1, 1)
           end
-        when ::Array
+        when ::Array, ::Set
           r = r.dup.freeze unless r.frozen?
           new(:IN, l, r)
         when ::String

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 = 95
+  MINOR = 99
 
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel
 version: !ruby/object:Gem::Version
-  version: 5.95.0
+  version: 5.99.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -250,6 +250,7 @@ files:
 - lib/sequel/extensions/pg_array.rb
 - lib/sequel/extensions/pg_array_ops.rb
 - lib/sequel/extensions/pg_auto_parameterize.rb
+- lib/sequel/extensions/pg_auto_parameterize_duplicate_query_detection.rb
 - lib/sequel/extensions/pg_auto_parameterize_in_array.rb
 - lib/sequel/extensions/pg_enum.rb
 - lib/sequel/extensions/pg_extended_date_support.rb
@@ -342,6 +343,7 @@ files:
 - lib/sequel/plugins/def_dataset_method.rb
 - lib/sequel/plugins/defaults_setter.rb
 - lib/sequel/plugins/delay_add_association.rb
+- lib/sequel/plugins/deprecated_associations.rb
 - lib/sequel/plugins/dirty.rb
 - lib/sequel/plugins/eager_each.rb
 - lib/sequel/plugins/eager_graph_eager.rb