sequel 5.85.0 → 5.93.0

data/lib/sequel/plugins/pg_auto_validate_enums.rb

@@ -0,0 +1,88 @@
+# frozen-string-literal: true
+
+module Sequel
+  module Plugins
+    # The pg_auto_validate_enums plugin implements automatic validations for
+    # enum columns, ensuring that enum columns have a valid value.  With this
+    # plugin, trying to save with an invalid enum value results in
+    # Sequel::ValidationFailed before saving, instead of Sequel::DatabaseError
+    # (wrapping PG::InvalidTextRepresentation or similar exception) during saving.
+    # 
+    #   class Person < Sequel::Model
+    #     # assume state enum column with allowed values active and inactive
+    #     plugin :pg_auto_validate_enums
+    #   end
+    #   p = Person.new(state: "active").valid? # => true
+    #   p = Person.new(state: "inactive").valid? # => true
+    #   p = Person.new(state: "other").valid? # => false
+    #
+    # While you can load this into individual model classes, typical use would
+    # be to load it into Sequel::Model or the appropriate model base class,
+    # and have all models that inherit from that class automatically pick it up.
+    #
+    # This plugin depends on the validation_helpers plugin.
+    module PgAutoValidateEnums
+      # Load the validation_helpers plugin.
+      def self.apply(model, opts=OPTS)
+        model.plugin(:validation_helpers)
+      end
+
+      # Load the pg_enum extension into the database, and reload the schema
+      # if it is already loaded. The opts given are used for the validates_includes
+      # validations (with allow_nil: true and from: :values enabled by default,
+      # to avoid issues with nullable enum columns and cases where the column
+      # method has been overridden.
+      def self.configure(model, opts=OPTS)
+        model.instance_exec do
+          db.extension(:pg_enum) unless @db.instance_variable_get(:@enum_labels)
+          if @db_schema
+            get_db_schema(true)
+            _get_pg_pg_auto_validate_enums_metadata
+          end
+          @pg_auto_validate_enums_opts = {allow_nil: true, from: :values}.merge!(opts).freeze
+        end
+      end
+
+      module ClassMethods
+        # Hash with enum column symbol values and arrays of valid string values.
+        attr_reader :pg_auto_validate_enums_metadata
+
+        # Options to pass to the validates_includes calls used by the plugin.
+        attr_reader :pg_auto_validate_enums_opts
+
+        Plugins.after_set_dataset(self, :_get_pg_pg_auto_validate_enums_metadata)
+
+        Plugins.inherited_instance_variables(self,
+          :@pg_auto_validate_enums_metadata=>nil,
+          :@pg_auto_validate_enums_opts=>nil)
+
+        private
+
+        # Parse the column schema to find columns with :enum_values entries,
+        # which will be used to setup validations.
+        def _get_pg_pg_auto_validate_enums_metadata
+          metadata = {}
+          @db_schema.each do |key, sch|
+            if enum_values = sch[:enum_values]
+              metadata[key] = enum_values
+            end
+          end
+          @pg_auto_validate_enums_metadata = metadata.freeze
+        end
+      end
+
+      module InstanceMethods
+        # Validate that all of the model's enum columns have valid values.
+        def validate
+          super
+
+          klass = self.class
+          opts = klass.pg_auto_validate_enums_opts
+          klass.pg_auto_validate_enums_metadata.each do |column, values|
+            validates_includes(values, column, opts)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/pg_eager_any_typed_array.rb

@@ -0,0 +1,95 @@
+# frozen-string-literal: true
+
+module Sequel
+  module Plugins
+    # The pg_eager_any_typed_array plugin automatically converts
+    # the predicate expressions used for eager loading from:
+    #
+    #   table.column IN (value_list)
+    #
+    # to:
+    #
+    #   table.column = ANY(array_expr::type[])
+    #
+    # This makes it easier to use the pg_auto_parameterize_in_array
+    # extension with the :treat_string_list_as_text_array option,
+    # when using foreign keys with non-text database types that are represented
+    # by Ruby strings, such as enum and uuid types.
+    #
+    # Most association types that ship with Sequel have their predicate
+    # expressions converted by this plugin.  Here are the exceptions:
+    #
+    # * associations using composite predicate keys
+    # * many_to_pg_array associations
+    # * many_to_many/one_through_one associations using :join_table_db option
+    # * many_through_many/one_through_many associations using
+    #   :separate_table_per_query option
+    #
+    # To avoid predicate conversion for particular associations, set the
+    # :eager_loading_predicate_transform association option to nil/false.
+    #
+    # This plugin loads the pg_array extension into the model's Database.
+    module PgEagerAnyTypedArray
+      # Add the pg_array extension to the database
+      def self.apply(model)
+        model.db.extension(:pg_array)
+      end
+
+      module ClassMethods
+        TRANSFORM = proc do |values, ref|
+          type = ref.send(:cached_fetch, :_pg_eager_any_typed_array_type) do
+            key = ref.predicate_key
+            next if key.is_a?(Array)
+
+            while key.is_a?(SQL::QualifiedIdentifier)
+              key = key.column
+            end
+
+            # :nocov:
+            # many_to_pg_array association type does not need changes, as it
+            # already converts the values to a typed postgres array, it does
+            # not call the code that uses :eager_loading_predicate_transform.
+            #
+            # No association type that ships with Sequel can reach this code
+            # unless it is one of these types, but external association types
+            # could potentially reach it.
+            sch = case ref[:type]
+            # :nocov:
+            when :many_to_one, :one_to_one, :one_to_many, :pg_array_to_many
+              ref.associated_class.db_schema
+            when :many_to_many, :one_through_one
+              # Not compatible with the :join_table_db option, but that option
+              # does not call into this code.
+              Hash[ref.associated_class.db.schema(ref.join_table_source)]
+            when :many_through_many, :one_through_many
+              # Not compatible with the :separate_query_per_table option, but
+              # that option does not call into this code.
+              Hash[ref.associated_class.db.schema(ref[:through][0][:table])]
+            end
+
+            if sch && (sch = sch[key])
+              sch[:db_type]
+            end
+          end
+
+          if type
+            Sequel.function(:ANY, Sequel.pg_array(values, type))
+          else
+            values
+          end
+        end
+
+        # Set the :eager_loading_predicate_transform option if not already set
+        def associate(type, name, opts = OPTS, &block)
+          res = super
+
+          unless res.has_key?(:eager_loading_predicate_transform)
+            res[:eager_loading_predicate_transform] = TRANSFORM
+          end
+
+          res
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/rcte_tree.rb

@@ -81,7 +81,7 @@ module Sequel
 
         opts = opts.dup
         opts[:class] = model
-        opts[:methods_module] = Module.new
+        opts[:methods_module] = Sequel.set_temp_name(Module.new){"#{model.name}::_rcte_tree[:methods_module]"}
         opts[:union_all] = opts[:union_all].nil? ? true : opts[:union_all]
         model.send(:include, opts[:methods_module])
         

data/lib/sequel/plugins/serialization.rb

@@ -37,7 +37,8 @@ module Sequel
     #
     #   # Register custom serializer/deserializer pair, if desired
     #   require 'sequel/plugins/serialization'
-    #   Sequel::Plugins::Serialization.register_format(:reverse, :reverse.to_proc, :reverse.to_proc)
+    #   require 'base64'
+    #   Sequel::Plugins::Serialization.register_format(:base64, Base64.method(:encode64), Base64.method(:decode64))
     #
     #   class User < Sequel::Model
     #     # Built-in format support when loading the plugin
@@ -48,10 +49,10 @@ module Sequel
     #     serialize_attributes :marshal, :permissions
     #
     #     # Use custom registered serialization format just like built-in format
-    #     serialize_attributes :reverse, :password
+    #     serialize_attributes :base64, :password
     #
     #     # Use a custom serializer/deserializer pair without registering
-    #     serialize_attributes [:reverse.to_proc, :reverse.to_proc], :password
+    #     serialize_attributes [ Base64.method(:encode64), Base64.method(:decode64)], :password
     #   end
     #   user = User.create
     #   user.permissions = {global: 'read-only'}
@@ -123,7 +124,12 @@ module Sequel
         end
         
         # Create instance level reader that deserializes column values on request,
-        # and instance level writer that stores new deserialized values.
+        # and instance level writer that stores new deserialized values. If +format+
+        # is a symbol, it should correspond to a previously-registered format using +register_format+.
+        # Otherwise, +format+ is expected to be a 2-element array of callables,
+        # with the first element being the serializer, used to convert the value used by the application
+        # to the value that will be stored in the database, and the second element being the deserializer,
+        # used to convert the value stored the database to the value used by the application.
         def serialize_attributes(format, *columns)
           if format.is_a?(Symbol)
             unless format = Sequel.synchronize{REGISTERED_FORMATS[format]}
@@ -140,7 +146,7 @@ module Sequel
         # Add serializated attribute acessor methods to the serialization_module
         def define_serialized_attribute_accessor(serializer, deserializer, *columns)
           m = self
-          include(@serialization_module ||= Module.new) unless @serialization_module
+          include(@serialization_module ||= Sequel.set_temp_name(Module.new){"#{name}::@serialization_module"}) unless @serialization_module
           @serialization_module.class_eval do
             columns.each do |column|
               m.serialization_map[column] = serializer

data/lib/sequel/plugins/sql_comments.rb

@@ -40,7 +40,8 @@ module Sequel
     #   Album.sql_comments_dataset_methods :to_csv # csv_serializer plugin
     #
     # In order for the sql_comments plugin to work, the sql_comments
-    # Database extension must be loaded into the model's database.
+    # Database extension must be loaded into the model's database, so
+    # loading the plugin does this automatically.
     #
     # Note that in order to make sure SQL comments are included, some
     # optimizations are disabled if this plugin is loaded.
@@ -67,6 +68,10 @@ module Sequel
         # :nocov:
       end
 
+      def self.apply(model)
+        model.db.extension(:sql_comments)
+      end
+
       def self.configure(model)
         model.send(:reset_fast_pk_lookup_sql)
       end
@@ -85,7 +90,7 @@ module Sequel
         # Use automatic SQL comments for the given dataset methods.
         def sql_comments_dataset_methods(*meths)
           unless @_sql_comments_dataset_module
-            dataset_module(@_sql_comments_dataset_module = Module.new)
+            dataset_module(@_sql_comments_dataset_module = Sequel.set_temp_name(Module.new){"#{name}::@_sql_comments_dataset_module"})
           end
           _sql_comments_methods(@_sql_comments_dataset_module, :dataset, meths)
         end

data/lib/sequel/plugins/static_cache_cache.rb

@@ -2,11 +2,11 @@
 
 module Sequel
   module Plugins
-    # The static_cache_cache plugin allows for caching the row content for subclasses
-    # that use the static cache plugin (or just the current class).  Using this plugin
-    # can avoid the need to query the database every time loading the plugin into a
-    # model, which can save time when you have a lot of models using the static_cache
-    # plugin.
+    # The static_cache_cache plugin allows for caching the row content for the current
+    # class and subclasses that use the static_cache or subset_static_cache plugins.
+    # Using this plugin can avoid the need to query the database every time loading
+    # the static_cache plugin into a model (static_cache plugin) or using the
+    # cache_subset method (subset_static_cache plugin).
     #
     # Usage:
     #
@@ -26,11 +26,7 @@ module Sequel
       module ClassMethods
         # Dump the in-memory cached rows to the cache file.
         def dump_static_cache_cache
-          static_cache_cache = {}
-          @static_cache_cache.sort.each do |k, v|
-            static_cache_cache[k] = v
-          end
-          File.open(@static_cache_cache_file, 'wb'){|f| f.write(Marshal.dump(static_cache_cache))}
+          File.open(@static_cache_cache_file, 'wb'){|f| f.write(Marshal.dump(sort_static_cache_hash(@static_cache_cache)))}
           nil
         end
 
@@ -38,16 +34,57 @@ module Sequel
 
         private
 
+        # Sort the given static cache hash in a deterministic way, so that 
+        # the same static cache values will result in the same marshal file.
+        def sort_static_cache_hash(cache)
+          cache = cache.sort do |a, b|
+            a, = a
+            b, = b
+            if a.is_a?(Array)
+              if b.is_a?(Array)
+                a_name, a_meth = a
+                b_name, b_meth = b
+                x = a_name <=> b_name
+                if x.zero?
+                  x = a_meth <=> b_meth
+                end
+                x
+              else
+                1
+              end
+            elsif b.is_a?(Array)
+              -1
+            else
+              a <=> b
+            end
+          end
+          Hash[cache]
+        end
+
         # Load the rows for the model from the cache if available.
         # If not available, load the rows from the database, and
         # then update the cache with the raw rows.
         def load_static_cache_rows
-          if rows = Sequel.synchronize{@static_cache_cache[name]}
+          _load_static_cache_rows(dataset, name)
+        end
+
+        # Load the rows for the subset from the cache if available.
+        # If not available, load the rows from the database, and
+        # then update the cache with the raw rows.
+        def load_subset_static_cache_rows(ds, meth)
+          _load_static_cache_rows(ds, [name, meth].freeze)
+        end
+
+        # Check the cache first for the key, and return rows without a database
+        # query if present.  Otherwise, get all records in the provided dataset,
+        # and update the cache with them.
+        def _load_static_cache_rows(ds, key)
+          if rows = Sequel.synchronize{@static_cache_cache[key]}
             rows.map{|row| call(row)}.freeze
           else
-            rows = dataset.all.freeze
+            rows = ds.all.freeze
             raw_rows = rows.map(&:values)
-            Sequel.synchronize{@static_cache_cache[name] = raw_rows}
+            Sequel.synchronize{@static_cache_cache[key] = raw_rows}
             rows
           end
         end

data/lib/sequel/plugins/subset_conditions.rb

@@ -3,18 +3,31 @@
 module Sequel
   module Plugins
     # The subset_conditions plugin creates an additional *_conditions method
-    # for every subset created, which returns the filter conditions the subset
-    # uses.  This can be useful if you want to use the conditions for a separate
-    # filter or combine them with OR.
+    # for every `subset`, `where`, and `exclude` method call in a dataset_module
+    # block. This method returns the filter conditions, which can be useful if
+    # you want to use the conditions for a separate filter or combine them with OR.
+    # It also supports where_all and where_any dataset_module methods for
+    # combining multiple dataset method filters with AND or OR.
     #
     # Usage:
     #
     #   # Add subset_conditions in the Album class
     #   Album.plugin :subset_conditions
     #
-    #   # This will now create a published_conditions method
     #   Album.dataset_module do
-    #     subset :published, published: true
+    #     # This will now create a published_conditions method
+    #     where :published, published: true
+    #
+    #     # This will now create a not_bad_conditions method
+    #     exclude :not_bad, :bad
+    #
+    #     # This will create good_and_available and
+    #     # good_and_available_conditions methods
+    #     where_all :good_and_available, :published, :not_bad
+    #
+    #     # This will create good_or_available and
+    #     # good_or_available_conditions methods
+    #     where_any :good_or_available, :published, :not_bad
     #   end
     #
     #   Album.where(Album.published_conditions).sql
@@ -25,10 +38,17 @@ module Sequel
     #
     #   Album.where(Album.published_conditions | {ready: true}).sql
     #   # SELECT * FROM albums WHERE ((published IS TRUE) OR (ready IS TRUE))
+    #
+    #   Album.good_and_available.sql
+    #   SELECT * FROM albums WHERE ((published IS TRUE) AND NOT bad)
+    #
+    #   Album.good_or_available.sql
+    #   SELECT * FROM albums WHERE ((published IS TRUE) OR NOT bad)
     module SubsetConditions
       def self.apply(model, &block)
         model.instance_exec do
           @dataset_module_class = Class.new(@dataset_module_class) do
+            Sequel.set_temp_name(self){"#{model.name}::@dataset_module_class(SubsetConditions)"}
             include DatasetModuleMethods
           end
         end
@@ -42,6 +62,66 @@ module Sequel
           cond = cond.first if cond.size == 1
           define_method(:"#{name}_conditions"){filter_expr(cond, &block)}
         end
+
+        # Also create a method that returns the conditions the filter uses.
+        def exclude(name, *args, &block)
+          super
+          cond = args
+          cond = cond.first if cond.size == 1
+          define_method(:"#{name}_conditions"){Sequel.~(filter_expr(cond, &block))}
+        end
+
+        # Create a method that combines filters from already registered
+        # dataset methods, and filters for rows where all of the conditions
+        # are satisfied.
+        #
+        #   Employee.dataset_module do
+        #     where :active, active: true
+        #     where :started, Sequel::CURRENT_DATE <= :start_date
+        #     where_all(:active_and_started, :active, :started)
+        #   end
+        #
+        #   Employee.active_and_started.sql
+        #   # SELECT * FROM employees WHERE ((active IS TRUE) AND (CURRENT_DATE <= start_date))
+        def where_all(name, *args)
+          _where_any_all(:&, name, args)
+        end
+
+        # Create a method that combines filters from already registered
+        # dataset methods, and filters for rows where any of the conditions
+        # are satisfied.
+        #
+        #   Employee.dataset_module do
+        #     where :active, active: true
+        #     where :started, Sequel::CURRENT_DATE <= :start_date
+        #     where_any(:active_or_started, :active, :started)
+        #   end
+        #
+        #   Employee.active_or_started.sql
+        #   # SELECT * FROM employees WHERE ((active IS TRUE) OR (CURRENT_DATE <= start_date))
+        def where_any(name, *args)
+          _where_any_all(:|, name, args)
+        end
+
+        private
+
+        if RUBY_VERSION >= '2'
+          # Backbone of #where_any and #where_all
+          def _where_any_all(meth, name, args)
+            ds = model.dataset
+            # #bind used here because the dataset module may not yet be included in the model's dataset
+            where(name, Sequel.send(meth, *args.map{|a| self.instance_method(:"#{a}_conditions").bind(ds).call}))
+          end
+        else
+          # Cannot bind module method to arbitrary objects in Ruby 1.9.
+          # :nocov:
+          def _where_any_all(meth, name, args)
+            ds = model.dataset.clone
+            ds.extend(self)
+            where(name, Sequel.send(meth, *args.map{|a| ds.send(:"#{a}_conditions")}))
+          end
+          # :nocov:
+        end
       end
     end
   end