sequel 5.60.1 → 5.62.0

data/lib/sequel/plugins/class_table_inheritance.rb

@@ -104,7 +104,7 @@ module Sequel
     # should reference the subquery alias (and qualified identifiers should not be needed
     # unless joining to another table):
     #
-    #   a = Executive.where(:id=>1).first # works
+    #   a = Executive.where(id: 1).first # works
     #   a = Executive.where{{employees[:id]=>1}}.first # works
     #   a = Executive.where{{executives[:id]=>1}}.first # doesn't work
     #
@@ -115,7 +115,7 @@ module Sequel
     #
     #   pks = Executive.where{num_staff < 10}.select_map(:id)
     #   Executive.cti_tables.reverse_each do |table|
-    #     DB.from(table).where(:id=>pks).delete
+    #     DB.from(table).where(id: pks).delete
     #   end
     #
     # = Usage

data/lib/sequel/plugins/composition.rb

@@ -39,8 +39,8 @@ module Sequel
     # also be implemented as:
     #
     #   Album.composition :date,
-    #     :composer=>proc{Date.new(year, month, day) if year || month || day},
-    #     :decomposer=>(proc do
+    #     composer: proc{Date.new(year, month, day) if year || month || day},
+    #     decomposer: (proc do
     #       if d = compositions[:date]
     #         self.year = d.year
     #         self.month = d.month

data/lib/sequel/plugins/concurrent_eager_loading.rb

@@ -50,10 +50,10 @@ module Sequel
     # support concurrent eager loading.  Taking this example from the
     # {Advanced Associations guide}[rdoc-ref:doc/advanced_associations.rdoc]
     #
-    #   Album.many_to_one :artist, :eager_loader=>(proc do |eo_opts|
+    #   Album.many_to_one :artist, eager_loader: (proc do |eo_opts|
     #     eo_opts[:rows].each{|album| album.associations[:artist] = nil}
     #     id_map = eo_opts[:id_map]
-    #     Artist.where(:id=>id_map.keys).all do |artist|
+    #     Artist.where(id: id_map.keys).all do |artist|
     #       if albums = id_map[artist.id]
     #         albums.each do |album|
     #           album.associations[:artist] = artist
@@ -74,12 +74,12 @@ module Sequel
     # the code that loads the objects, since that will prevent concurrent loading.
     # So after the changes, the custom eager loader would look like this:
     #
-    #   Album.many_to_one :artist, :eager_loader=>(proc do |eo_opts|
+    #   Album.many_to_one :artist, eager_loader: (proc do |eo_opts|
     #     Sequel.synchronize_with(eo[:mutex]) do
     #       eo_opts[:rows].each{|album| album.associations[:artist] = nil}
     #     end
     #     id_map = eo_opts[:id_map]
-    #     rows = Artist.where(:id=>id_map.keys).all
+    #     rows = Artist.where(id: id_map.keys).all
     #     Sequel.synchronize_with(eo[:mutex]) do
     #       rows.each do |artist|
     #         if albums = id_map[artist.id]

data/lib/sequel/plugins/dirty.rb

@@ -37,7 +37,7 @@ module Sequel
     #
     # It also saves the previously changed values after an update:
     #
-    #   artist.update(:name=>'Bar')
+    #   artist.update(name: 'Bar')
     #   artist.column_changes        # => {}
     #   artist.previous_changes      # => {:name=>['Foo', 'Bar']}
     #

data/lib/sequel/plugins/finder.rb

@@ -97,7 +97,9 @@ module Sequel
         #   Artist.first_by_name(nil)
         #   # WHERE (name IS NULL)
         #
-        # See Dataset::PlaceholderLiteralizer for additional caveats.
+        # See Dataset::PlaceholderLiteralizer for additional caveats. Note that if the model's
+        # dataset does not support placeholder literalizers, you will not be able to use this
+        # method.
         def finder(meth=OPTS, opts=OPTS, &block)
           if block
             raise Error, "cannot pass both a method name argument and a block of Model.finder" unless meth.is_a?(Hash)

data/lib/sequel/plugins/nested_attributes.rb

@@ -33,7 +33,7 @@ module Sequel
     # objects.  You just need to make sure that the primary key field is filled in for the
     # associated object:
     #
-    #   a.update(:albums_attributes => [{id: 1, name: 'T'}])
+    #   a.update(albums_attributes: [{id: 1, name: 'T'}])
     #
     # Since the primary key field is filled in, the plugin will update the album with id 1 instead
     # of creating a new album.
@@ -42,14 +42,14 @@ module Sequel
     # entry to the hash, and also pass the :destroy option when calling +nested_attributes+:
     #
     #   Artist.nested_attributes :albums, destroy: true
-    #   a.update(:albums_attributes => [{id: 1, _delete: true}])
+    #   a.update(albums_attributes: [{id: 1, _delete: true}])
     #
     # This will delete the related associated object from the database.  If you want to leave the
     # associated object in the database, but just remove it from the association, add a _remove
     # entry in the hash, and also pass the :remove option when calling +nested_attributes+:
     #
     #   Artist.nested_attributes :albums, remove: true
-    #   a.update(:albums_attributes => [{id: 1, _remove: true}])
+    #   a.update(albums_attributes: [{id: 1, _remove: true}])
     #
     # The above example was for a one_to_many association, but the plugin also works similarly
     # for other association types.  For one_to_one and many_to_one associations, you need to
@@ -84,7 +84,7 @@ module Sequel
     # nested attributes options for that association.  This is useful for per-call filtering
     # of the allowed fields:
     #
-    #   a.set_nested_attributes(:albums, params['artist'], :fields=>%w'name')
+    #   a.set_nested_attributes(:albums, params['artist'], fields: %w'name')
     module NestedAttributes
       # Depend on the validate_associated plugin.
       def self.apply(model)

data/lib/sequel/plugins/pg_auto_constraint_validations.rb

@@ -32,7 +32,7 @@ module Sequel
     #
     # Example:
     #
-    #   album = Album.new(:artist_id=>1) # Assume no such artist exists
+    #   album = Album.new(artist_id: 1) # Assume no such artist exists
     #   begin
     #     album.save
     #   rescue Sequel::ValidationFailed

data/lib/sequel/plugins/primary_key_lookup_check_values.rb

@@ -0,0 +1,154 @@
+# frozen-string-literal: true
+
+module Sequel
+  module Plugins
+    # The primary_key_lookup_check_values plugin typecasts given primary key
+    # values before performing a lookup by primary key. If the given primary
+    # key value cannot be typecasted correctly, the lookup returns nil
+    # without issuing a query.  If the schema for the primary key column
+    # includes minimum and maximum values, this also checks the given value
+    # is not outside the range.  If the given value is outside the allowed
+    # range, the lookup returns nil without issuing a query.
+    #
+    # This affects the following Model methods:
+    #
+    # * Model.[] (when called with non-Hash)
+    # * Model.with_pk
+    # * Model.with_pk!
+    #
+    # It also affects the following Model dataset methods:
+    #
+    # * Dataset#[] (when called with Integer)
+    # * Dataset#with_pk
+    # * dataset#with_pk!
+    # 
+    # Note that this can break working code.  The above methods accept
+    # any filter condition by default, not just primary key values.  The
+    # plugin will handle Symbol, Sequel::SQL::Expression, and
+    # Sequel::LiteralString objects, but code such as the following will break:
+    #
+    #   # Return first Album where primary key is one of the given values
+    #   Album.dataset.with_pk([1, 2, 3])
+    #
+    # Usage:
+    #
+    #   # Make all model subclasses support checking primary key values before
+    #   # lookup # (called before loading subclasses)
+    #   Sequel::Model.plugin :primary_key_lookup_check_values
+    #
+    #   # Make the Album class support checking primary key values before lookup
+    #   Album.plugin :primary_key_lookup_check_values
+    module PrimaryKeyLookupCheckValues
+      def self.configure(model)
+        model.instance_exec do
+          setup_primary_key_lookup_check_values if @dataset
+        end
+      end
+
+      module ClassMethods
+        Plugins.after_set_dataset(self, :setup_primary_key_lookup_check_values)
+
+        Plugins.inherited_instance_variables(self,
+          :@primary_key_type=>nil,
+          :@primary_key_value_range=>nil)
+
+        private
+
+        # Check the given primary key value.  Typecast it to the appropriate
+        # database type if the database type is known.  If it cannot be
+        # typecasted, or the typecasted value is outside the range of column
+        # values, return nil.
+        def _check_pk_lookup_value(pk)
+          return if nil == pk
+          case pk
+          when SQL::Expression, LiteralString, Symbol
+            return pk
+          end
+          return pk unless pk_type = @primary_key_type
+
+          if pk_type.is_a?(Array)
+            return unless pk.is_a?(Array)
+            return unless pk.size == pk_type.size
+            return if pk.any?(&:nil?)
+
+            pk_value_range = @primary_key_value_range
+            i = 0
+            pk.map do |v|
+              if type = pk_type[i]
+                v = _typecast_pk_lookup_value(v, type)
+                return if nil == v
+                if pk_value_range
+                  min, max = pk_value_range[i]
+                  return if min && v < min
+                  return if max && v > max
+                end
+              end
+              i += 1
+              v
+            end
+          elsif pk.is_a?(Array)
+            return
+          elsif nil != (pk = _typecast_pk_lookup_value(pk, pk_type))
+            min, max = @primary_key_value_range
+            return if min && pk < min
+            return if max && pk > max
+            pk
+          end
+        end
+
+        # Typecast the value to the appropriate type,
+        # returning nil if it cannot be typecasted.
+        def _typecast_pk_lookup_value(value, type)
+          db.typecast_value(type, value)
+        rescue InvalidValue
+          nil
+        end
+
+        # Skip the primary key lookup if the typecasted and checked
+        # primary key value is nil.
+        def primary_key_lookup(pk)
+          unless nil == (pk = _check_pk_lookup_value(pk))
+            super
+          end
+        end
+
+        # Setup the primary key type and value range used for checking
+        # primary key values during lookup.
+        def setup_primary_key_lookup_check_values
+          if primary_key.is_a?(Array)
+            types = []
+            value_ranges = []
+            primary_key.each do |pk|
+              type, min, max = _type_min_max_values_for_column(pk)
+              types << type
+              value_ranges << ([min, max].freeze if min || max)
+            end
+            @primary_key_type = (types.freeze if types.any?)
+            @primary_key_value_range = (value_ranges.freeze if @primary_key_type && value_ranges.any?)
+          else
+            @primary_key_type, min, max = _type_min_max_values_for_column(primary_key)
+            @primary_key_value_range = ([min, max].freeze if @primary_key_type && (min || max))
+          end
+        end
+
+        # Return the type, min_value, and max_value schema entries
+        # for the column, if they exist.
+        def _type_min_max_values_for_column(column)
+          if schema = db_schema[column]
+            schema.values_at(:type, :min_value, :max_value)
+          end
+        end
+      end
+
+      module DatasetMethods
+        # Skip the primary key lookup if the typecasted and checked
+        # primary key value is nil.
+        def with_pk(pk)
+          unless nil == (pk = model.send(:_check_pk_lookup_value, pk))
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/sql_comments.rb

@@ -12,7 +12,7 @@ module Sequel
     #   # SELECT * FROM albums WHERE (id = 1) LIMIT 1
     #   # -- model:Album,method_type:class,method:[]
     #
-    #   album.update(:name=>'A')
+    #   album.update(name: 'A')
     #   # UPDATE albums SET name = 'baz' WHERE (id = 1)
     #   # -- model:Album,method_type:instance,method:update
     #

data/lib/sequel/plugins/validation_helpers.rb

@@ -83,7 +83,9 @@ module Sequel
         :integer=>{:message=>lambda{"is not a number"}},
         :length_range=>{:message=>lambda{|range| "is too short or too long"}},
         :max_length=>{:message=>lambda{|max| "is longer than #{max} characters"}, :nil_message=>lambda{"is not present"}},
+        :max_value=>{:message=>lambda{|max| "is greater than maximum allowed value"}},
         :min_length=>{:message=>lambda{|min| "is shorter than #{min} characters"}},
+        :min_value=>{:message=>lambda{|min| "is less than minimum allowed value"}},
         :not_null=>{:message=>lambda{"is not present"}},
         :no_null_byte=>{:message=>lambda{"contains a null byte"}},
         :numeric=>{:message=>lambda{"is not a number"}},
@@ -141,11 +143,29 @@ module Sequel
           end
         end
 
+        # Check that the attribute values are not greater that the given maximum value.
+        # Does not perform validation if attribute value is nil.
+        # You should only call this if you have checked the attribute value has the expected type.
+        def validates_max_value(max, atts, opts=OPTS)
+          validatable_attributes_for_type(:max_value, atts, opts) do |a,v,m|
+            validation_error_message(m, max) if !v.nil? && v > max
+          end
+        end
+
         # Check that the attribute values are not shorter than the given min length.
         def validates_min_length(min, atts, opts=OPTS)
           validatable_attributes_for_type(:min_length, atts, opts){|a,v,m| validation_error_message(m, min) if v.nil? || v.length < min}
         end
 
+        # Check that the attribute values are not less that the given minimum value.
+        # Does not perform validation if attribute value is nil.
+        # You should only call this if you have checked the attribute value has the expected type.
+        def validates_min_value(min, atts, opts=OPTS)
+          validatable_attributes_for_type(:min_value, atts, opts) do |a,v,m|
+            validation_error_message(m, min) if !v.nil? && v < min
+          end
+        end
+
         # Check attribute value(s) are not NULL/nil.
         def validates_not_null(atts, opts=OPTS)
           validatable_attributes_for_type(:not_null, atts, opts){|a,v,m| validation_error_message(m) if v.nil?}

data/lib/sequel/version.rb

@@ -6,11 +6,11 @@ module Sequel
 
   # The minor version of Sequel.  Bumped for every non-patch level
   # release, generally around once a month.
-  MINOR = 60
+  MINOR = 62
 
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.
-  TINY  = 1
+  TINY  = 0
   
   # The version of Sequel you are using, as a string (e.g. "2.11.0")
   VERSION = [MAJOR, MINOR, TINY].join('.').freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel
 version: !ruby/object:Gem::Version
-  version: 5.60.1
+  version: 5.62.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -192,6 +192,8 @@ extra_rdoc_files:
 - doc/release_notes/5.59.0.txt
 - doc/release_notes/5.6.0.txt
 - doc/release_notes/5.60.0.txt
+- doc/release_notes/5.61.0.txt
+- doc/release_notes/5.62.0.txt
 - doc/release_notes/5.7.0.txt
 - doc/release_notes/5.8.0.txt
 - doc/release_notes/5.9.0.txt
@@ -280,6 +282,8 @@ files:
 - doc/release_notes/5.59.0.txt
 - doc/release_notes/5.6.0.txt
 - doc/release_notes/5.60.0.txt
+- doc/release_notes/5.61.0.txt
+- doc/release_notes/5.62.0.txt
 - doc/release_notes/5.7.0.txt
 - doc/release_notes/5.8.0.txt
 - doc/release_notes/5.9.0.txt
@@ -418,8 +422,10 @@ files:
 - lib/sequel/extensions/pagination.rb
 - lib/sequel/extensions/pg_array.rb
 - lib/sequel/extensions/pg_array_ops.rb
+- lib/sequel/extensions/pg_auto_parameterize.rb
 - lib/sequel/extensions/pg_enum.rb
 - lib/sequel/extensions/pg_extended_date_support.rb
+- lib/sequel/extensions/pg_extended_integer_support.rb
 - lib/sequel/extensions/pg_hstore.rb
 - lib/sequel/extensions/pg_hstore_ops.rb
 - lib/sequel/extensions/pg_inet.rb
@@ -530,6 +536,7 @@ files:
 - lib/sequel/plugins/pg_row.rb
 - lib/sequel/plugins/prepared_statements.rb
 - lib/sequel/plugins/prepared_statements_safe.rb
+- lib/sequel/plugins/primary_key_lookup_check_values.rb
 - lib/sequel/plugins/rcte_tree.rb
 - lib/sequel/plugins/require_valid_schema.rb
 - lib/sequel/plugins/serialization.rb
@@ -577,7 +584,7 @@ metadata:
   documentation_uri: https://sequel.jeremyevans.net/documentation.html
   mailing_list_uri: https://github.com/jeremyevans/sequel/discussions
   source_code_uri: https://github.com/jeremyevans/sequel
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--quiet"
 - "--line-numbers"
@@ -600,7 +607,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: The Database Toolkit for Ruby
 test_files: []