sequel 5.67.0 → 5.68.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff5af191af88ca381359503cfd9601ec8f18a9d782b68a3de4a8c9dac080eddc
-  data.tar.gz: 786d20f7eac9325748c259130951643856e34051e64b02aa17493f6d0283eb52
+  metadata.gz: e682467c455e044847fffb313b6d8a669e0dc89ca8ea330468841de642b84227
+  data.tar.gz: cd0687fd059a6b6d38cb31279d5cdacccd4a0a309f1155171f12551d43eacb0b
 SHA512:
-  metadata.gz: db251488ea0739af5ecf6db332a1cff729cffbf31dfabfc7235f3c27f807366bc9feddf147797e4dd5980348fda6a640cc5ceef7e6255cddcd317acb7172be90
-  data.tar.gz: 45b0e24847ccb365f1d7d06d35c85f05718802375877ab3d0315deb952f72171e26b5676861c25cf1e840f831d216f99eaddcbb717fc752d75077f19ae13980c
+  metadata.gz: 3c16f027251aa67e04cab0973a57da21682e083c7362f37bdbf84937266ca6878e200fb7c44a0583b8ac6fab62d1fd4b55744929760fc63a9d1f850452db5df6
+  data.tar.gz: 60eee01297c47ee9c18ae76b6974b6eb3e492e58c7f408ee9c32476f1ae0ae5848ffc47cb80889f7070b02088e7e66509b64e460a1ef61c90ffb5a59da6a3c09

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 5.68.0 (2023-05-01)
+
+* Add validation_helpers_generic_type_messages plugin for more useful type validation failure messages (jeremyevans) (#2028)
+
+* Make constraint_validations plugin not validate missing columns that have a default value (jeremyevans) (#2023)
+
+* Skip normal type name parsing for enum/array/composite/range/multirange types on PostgreSQL (jeremyevans) (#2019)
+
+* Fix corner case where pg_extended_date_support did not work correctly when using the jdbc/postgresql adapter (jeremyevans)
+
+* Include :min_value and :max_value schema entries for date/timestamp/timestamptz columns on PostgreSQL 9.6+ (jeremyevans)
+
 === 5.67.0 (2023-04-01)
 
 * Fix dumping of string column sizes in the schema dumper on MSSQL (jeremyevans) (#2013)

data/doc/advanced_associations.rdoc

@@ -670,8 +670,10 @@ polymorphic associations in Sequel about as easy as it is in ActiveRecord.  Howe
 here's how they can be done using Sequel's custom associations (the sequel_polymorphic
 external plugin is just a generic version of this code):
 
+  Sequel.extension :inflector # for attachable_type.constantize
+
   class Asset < Sequel::Model
-    many_to_one :attachable, reciprocal: :assets,
+    many_to_one :attachable, reciprocal: :assets, reciprocal_type: :one_to_many,
       setter: (lambda do |attachable|
         self[:attachable_id] = (attachable.pk if attachable)
         self[:attachable_type] = (attachable.class.name if attachable)

data/doc/release_notes/5.68.0.txt

@@ -0,0 +1,61 @@
+= New Features
+
+* On PostgreSQL 9.6+, date, timestamp, and timestamptz columns now
+  have min_value and max_value column schema entries, allowing the
+  auto_validations plugin to automatically enforce minimum and
+  maximum values for these column types, raising a validation error
+  before saving, instead of database error when the query is sent
+  to the database.
+
+* A validation_helpers_generic_type_messages plugin has been added,
+  which improves the default type validation error messages in
+  validation_helpers.  This change was not made directly to
+  validation_helpers for backwards compatibility reasons, but will
+  probably become the default behavior in Sequel 6.  Some examples
+  of the improvements:
+
+    # :blob type
+    # validation_helpers default: "value is not a valid sequel::sql::blob"
+    # with this plugin: "value is not a blob"
+
+    # :boolean type
+    # validation_helpers default: "value is not a valid trueclass or falseclass"
+    # with this plugin: "value is not true or false"
+
+    # :datetime type
+    # validation_helpers default: "value is not a valid time or datetime"
+    # with this plugin: "value is not a valid timestamp"
+
+    # custom/database-specific types
+    # validation_helpers default: "value is not a valid sequel::class_name"
+    # with this plugin: "value is not the expected type"
+
+= Improvements
+
+* The constraint_validations plugin no longer raises validation
+  errors for missing columns that have a default value. If a column
+  is missing but has a default value, we can assume the default
+  value is valid.  Additionally, the constraint validations are now
+  based on the underlying column value and not any deserialized
+  value, so that the validation matches the constraint.
+
+* On PostgreSQL, normal type name parsing is skipped for enum,
+  array, composite, range, and multirange types, ensuring that
+  such types will not be treated incorrectly based on their
+  type name.
+
+* The pg_extended_date_support extension now works correctly with
+  the jdbc/postgresql adapter if there is already an entry in the
+  oid_convertor_map for the timestamp and timestamptz types.
+
+= Backwards Compatibility
+
+* Database#schema_column_type is no longer called for all columns
+  on PostgreSQL when parsing schema. Enum, array, composite, range,
+  and multirange types each have their own separate type parsing
+  method.  So if you were overriding Database#schema_column_type to
+  implement custom column schema parsing, you may need to adjust
+  your code.
+
+* The Sequel::Postgres::ExtendedDateSupport::DATE_YEAR_1 constant
+  has been removed.

data/lib/sequel/adapters/shared/postgres.rb

@@ -1007,11 +1007,15 @@ module Sequel
               SQL::Function.new(:format_type, pg_type[:oid], pg_attribute[:atttypmod]).as(:db_type),
               SQL::Function.new(:pg_get_expr, pg_attrdef[:adbin], pg_class[:oid]).as(:default),
               SQL::BooleanExpression.new(:NOT, pg_attribute[:attnotnull]).as(:allow_null),
-              SQL::Function.new(:COALESCE, SQL::BooleanExpression.from_value_pairs(pg_attribute[:attnum] => SQL::Function.new(:ANY, pg_index[:indkey])), false).as(:primary_key)]}.
+              SQL::Function.new(:COALESCE, SQL::BooleanExpression.from_value_pairs(pg_attribute[:attnum] => SQL::Function.new(:ANY, pg_index[:indkey])), false).as(:primary_key),
+              Sequel[:pg_type][:typtype],
+              (~Sequel[Sequel[:elementtype][:oid]=>nil]).as(:is_array),
+            ]}.
             from(:pg_class).
             join(:pg_attribute, :attrelid=>:oid).
             join(:pg_type, :oid=>:atttypid).
             left_outer_join(Sequel[:pg_type].as(:basetype), :oid=>:typbasetype).
+            left_outer_join(Sequel[:pg_type].as(:elementtype), :typarray=>Sequel[:pg_type][:oid]).
             left_outer_join(:pg_attrdef, :adrelid=>Sequel[:pg_class][:oid], :adnum=>Sequel[:pg_attribute][:attnum]).
             left_outer_join(:pg_index, :indrelid=>Sequel[:pg_class][:oid], :indisprimary=>true).
             where{{pg_attribute[:attisdropped]=>false}}.
@@ -1538,11 +1542,12 @@ module Sequel
       end
 
       # SQL DDL statement for renaming a table. PostgreSQL doesn't allow you to change a table's schema in
-      # a rename table operation, so speciying a new schema in new_name will not have an effect.
+      # a rename table operation, so specifying a new schema in new_name will not have an effect.
       def rename_table_sql(name, new_name)
         "ALTER TABLE #{quote_schema_table(name)} RENAME TO #{quote_identifier(schema_and_table(new_name).last)}"
       end
 
+      # Handle interval and citext types.
       def schema_column_type(db_type)
         case db_type
         when /\Ainterval\z/io
@@ -1554,6 +1559,43 @@ module Sequel
         end
       end
 
+      # The schema :type entry to use for array types.
+      def schema_array_type(db_type)
+        :array
+      end
+
+      # The schema :type entry to use for row/composite types.
+      def schema_composite_type(db_type)
+        :composite
+      end
+
+      # The schema :type entry to use for enum types.
+      def schema_enum_type(db_type)
+        :enum
+      end
+
+      # The schema :type entry to use for range types.
+      def schema_range_type(db_type)
+        :range
+      end
+
+      # The schema :type entry to use for multirange types.
+      def schema_multirange_type(db_type)
+        :multirange
+      end
+
+      MIN_DATE = Date.new(-4713, 11, 24)
+      MAX_DATE = Date.new(5874897, 12, 31)
+      MIN_TIMESTAMP = Time.utc(-4713, 11, 24).freeze
+      MAX_TIMESTAMP = (Time.utc(294277) - Rational(1, 1000000)).freeze
+      TYPTYPE_METHOD_MAP = {
+        'c' => :schema_composite_type,
+        'e' => :schema_enum_type,
+        'r' => :schema_range_type,
+        'm' => :schema_multirange_type,
+      }
+      TYPTYPE_METHOD_MAP.default = :schema_column_type
+      TYPTYPE_METHOD_MAP.freeze
       # The dataset used for parsing table schemas, using the pg_* system catalogs.
       def schema_parse_table(table_name, opts)
         m = output_identifier_meth(opts[:dataset])
@@ -1569,11 +1611,33 @@ module Sequel
             row.delete(:base_oid)
             row.delete(:db_base_type)
           end
-          row[:type] = schema_column_type(row[:db_type])
+
+          db_type = row[:db_type]
+          row[:type] = if row.delete(:is_array)
+            schema_array_type(db_type)
+          else
+            send(TYPTYPE_METHOD_MAP[row.delete(:typtype)], db_type)
+          end
           identity = row.delete(:attidentity)
           if row[:primary_key]
             row[:auto_increment] = !!(row[:default] =~ /\A(?:nextval)/i) || identity == 'a' || identity == 'd'
           end
+
+          # :nocov:
+          if server_version >= 90600
+          # :nocov:
+            case row[:oid]
+            when 1082
+              row[:min_value] = MIN_DATE
+              row[:max_value] = MAX_DATE
+            when 1184, 1114
+              if Sequel.datetime_class == Time
+                row[:min_value] = MIN_TIMESTAMP
+                row[:max_value] = MAX_TIMESTAMP
+              end
+            end
+          end
+
           [m.call(row.delete(:name)), row]
         end
       end

data/lib/sequel/database/schema_methods.rb

@@ -900,7 +900,7 @@ module Sequel
     #
     # Any other object given is just converted to a string, with "_" converted to " " and upcased.
     def on_delete_clause(action)
-      action.to_s.gsub("_", " ").upcase
+      action.to_s.tr("_", " ").upcase
     end
 
     # Alias of #on_delete_clause, since the two usually behave the same.

data/lib/sequel/extensions/pg_array.rb

@@ -257,7 +257,7 @@ module Sequel
         end
 
         # Make the column type detection handle registered array types.
-        def schema_column_type(db_type)
+        def schema_array_type(db_type)
           if (db_type =~ /\A([^(]+)(?:\([^(]+\))?\[\]\z/io) && (type = pg_array_schema_type($1))
             type
           else

data/lib/sequel/extensions/pg_enum.rb

@@ -166,8 +166,7 @@ module Sequel
       def schema_post_process(_)
         super.each do |_, s|
           oid = s[:oid]
-          if values = Sequel.synchronize{@enum_labels[oid]}
-            s[:type] = :enum
+          if s[:type] == :enum && (values = Sequel.synchronize{@enum_labels[oid]})
             s[:enum_values] = values
           end
         end

data/lib/sequel/extensions/pg_extended_date_support.rb

@@ -22,7 +22,6 @@
 module Sequel
   module Postgres
     module ExtendedDateSupport
-      DATE_YEAR_1 = Date.new(1)
       DATETIME_YEAR_1 = DateTime.new(1)
       TIME_YEAR_1 = Time.at(-62135596800).utc
       INFINITE_TIMESTAMP_STRINGS = ['infinity'.freeze, '-infinity'.freeze].freeze
@@ -38,6 +37,15 @@ module Sequel
         procs = db.conversion_procs
         procs[1082] = ::Sequel.method(:string_to_date)
         procs[1184] = procs[1114] = db.method(:to_application_timestamp)
+        if ocps = db.instance_variable_get(:@oid_convertor_map)
+          # Clear the oid convertor map entries for timestamps if they
+          # exist, so it will regenerate new ones that use this extension.
+          # This is only taken when using the jdbc adapter.
+          Sequel.synchronize do
+            ocps.delete(1184)
+            ocps.delete(1114)
+          end
+        end
       end
 
       # Handle BC dates and times in bound variables. This is necessary for Date values
@@ -181,7 +189,7 @@ module Sequel
 
         # Handle BC Date objects.
         def literal_date(date)
-          if date < DATE_YEAR_1
+          if date.year < 1
             date <<= ((date.year) * 24 - 12)
             date.strftime("'%Y-%m-%d BC'")
           else

data/lib/sequel/extensions/pg_multirange.rb

@@ -221,7 +221,7 @@ module Sequel
         private
 
         # Recognize the registered database multirange types.
-        def schema_column_type(db_type)
+        def schema_multirange_type(db_type)
           @pg_multirange_schema_types[db_type] || super
         end
 

data/lib/sequel/extensions/pg_range.rb

@@ -234,7 +234,7 @@ module Sequel
         private
 
         # Recognize the registered database range types.
-        def schema_column_type(db_type)
+        def schema_range_type(db_type)
           @pg_range_schema_types[db_type] || super
         end
 

data/lib/sequel/extensions/pg_row.rb

@@ -538,12 +538,8 @@ module Sequel
         private
 
         # Make the column type detection handle registered row types.
-        def schema_column_type(db_type)
-          if type = @row_schema_types[db_type]
-            type
-          else
-            super
-          end
+        def schema_composite_type(db_type)
+          @row_schema_types[db_type] || super
         end
       end
     end

data/lib/sequel/plugins/constraint_validations.rb

@@ -125,14 +125,15 @@ module Sequel
             ds = @dataset.with_quote_identifiers(false)
             table_name = ds.literal(ds.first_source_table)
             reflections = {}
-            @constraint_validations = (Sequel.synchronize{hash[table_name]} || []).map{|r| constraint_validation_array(r, reflections)}
+            allow_missing_columns = db_schema.select{|col, sch| sch[:allow_null] == false && nil != sch[:default]}.map(&:first)
+            @constraint_validations = (Sequel.synchronize{hash[table_name]} || []).map{|r| constraint_validation_array(r, reflections, allow_missing_columns)}
             @constraint_validation_reflections = reflections
           end
         end
 
         # Given a specific database constraint validation metadata row hash, transform
         # it in an validation method call array suitable for splatting to send.
-        def constraint_validation_array(r, reflections)
+        def constraint_validation_array(r, reflections, allow_missing_columns=EMPTY_ARRAY)
           opts = {}
           opts[:message] = r[:message] if r[:message]
           opts[:allow_nil] = true if db.typecast_value(:boolean, r[:allow_nil])
@@ -191,11 +192,13 @@ module Sequel
             reflection_opts[:argument] = arg
           end 
 
-          a << column
-          unless opts.empty?
-            a << opts
+          opts[:from] = :values
+          if column.is_a?(Symbol) && allow_missing_columns.include?(column)
+            opts[:allow_missing] = true
           end
 
+          a << column << opts
+
           if column.is_a?(Array) && column.length == 1
             column = column.first
           end

data/lib/sequel/plugins/pg_auto_constraint_validations.rb

@@ -28,7 +28,9 @@ module Sequel
     #
     # This plugin only works on the postgres adapter when using the pg 0.16+ driver,
     # PostgreSQL 9.3+ server, and PostgreSQL 9.3+ client library (libpq). In other cases
-    # it will be a no-op.
+    # it will be a no-op. Additionally, the plugin only handles models that select
+    # from tables.  It does not handle models that select from subqueries, such as
+    # subclasses of models using the class_table_inheritance plugin.
     #
     # Example:
     #

data/lib/sequel/plugins/validation_helpers.rb

@@ -75,6 +75,10 @@ module Sequel
     #       "#{Array(attribute).join(I18n.t('errors.joiner'))} #{error_msg}"
     #     end
     #   end
+    #
+    # It is recommended that users of this plugin that use validates_schema_types also use
+    # the validation_helpers_generic_type_messages plugin for more useful type validation
+    # failure messages.
     module ValidationHelpers
       DEFAULT_OPTIONS = {
         :exact_length=>{:message=>lambda{|exact| "is not #{exact} characters"}},
@@ -211,7 +215,7 @@ module Sequel
           klass = klass.to_s.constantize if klass.is_a?(String) || klass.is_a?(Symbol)
           validatable_attributes_for_type(:type, atts, opts) do |a,v,m|
             if klass.is_a?(Array) ? !klass.any?{|kls| v.is_a?(kls)} : !v.is_a?(klass)
-              validation_error_message(m, klass)
+              validates_type_error_message(m, klass)
             end
           end
         end
@@ -338,6 +342,9 @@ module Sequel
         def validation_error_message(message, *args)
           message.is_a?(Proc) ? message.call(*args) : message
         end
+
+        # The validation error message for type validations, for the given class.
+        alias validates_type_error_message validation_error_message
       end
     end
   end

data/lib/sequel/plugins/validation_helpers_generic_type_messages.rb

@@ -0,0 +1,73 @@
+# frozen-string-literal: true
+
+require_relative 'validation_helpers'
+
+module Sequel
+  module Plugins
+    # The validation_helpers_generic_type_messages plugin overrides the default
+    # type validation failure messages in the validation_helpers plugin to be
+    # more generic and understandable by the average user, instead of always
+    # be based on the names of the allowed classes for the type.  For example:
+    #
+    #   # :blob type
+    #   # validation_helpers default: "value is not a valid sequel::sql::blob"
+    #   # with this plugin: "value is not a blob"
+    #
+    #   # :boolean type
+    #   # validation_helpers default: "value is not a valid trueclass or falseclass"
+    #   # with this plugin: "value is not true or false"
+    #
+    #   # :datetime type
+    #   # validation_helpers default: "value is not a valid time or datetime"
+    #   # with this plugin: "value is not a valid timestamp"
+    #
+    #   # custom/database-specific types
+    #   # validation_helpers default: "value is not a valid sequel::class_name"
+    #   # with this plugin: "value is not the expected type"
+    #
+    # It is expected that this plugin will become the default behavior of
+    # validation_helpers in Sequel 6.
+    #
+    # To enable this the use of generic type messages for all models, load this
+    # plugin into Sequel::Model.
+    #
+    #   Sequel::Model.plugin :validation_helpers_generic_type_messages
+    module ValidationHelpersGenericTypeMessages
+      OVERRIDE_PROC = ValidationHelpers::DEFAULT_OPTIONS[:type][:message]
+      private_constant :OVERRIDE_PROC
+
+      TYPE_ERROR_STRINGS = {
+        String => 'is not a string'.freeze,
+        Integer => 'is not an integer'.freeze,
+        Date => 'is not a valid date'.freeze,
+        [Time, DateTime].freeze => 'is not a valid timestamp'.freeze,
+        Sequel::SQLTime => 'is not a valid time'.freeze,
+        [TrueClass, FalseClass].freeze => 'is not true or false'.freeze,
+        Float => 'is not a number'.freeze,
+        BigDecimal => 'is not a number'.freeze,
+        Sequel::SQL::Blob => 'is not a blob'.freeze,
+      }
+      TYPE_ERROR_STRINGS.default = "is not the expected type".freeze
+      TYPE_ERROR_STRINGS.freeze
+      private_constant :TYPE_ERROR_STRINGS
+
+      def self.apply(mod)
+        mod.plugin :validation_helpers
+      end
+
+      module InstanceMethods 
+        private
+
+        # Use a generic error message for type validations.
+        def validates_type_error_message(m, klass)
+          # SEQUEL6: Make this the default behavior in validation_helpers
+          if OVERRIDE_PROC.equal?(m)
+            TYPE_ERROR_STRINGS[klass]
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

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 = 67
+  MINOR = 68
 
   # 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.67.0
+  version: 5.68.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -199,6 +199,7 @@ extra_rdoc_files:
 - doc/release_notes/5.65.0.txt
 - doc/release_notes/5.66.0.txt
 - doc/release_notes/5.67.0.txt
+- doc/release_notes/5.68.0.txt
 - doc/release_notes/5.7.0.txt
 - doc/release_notes/5.8.0.txt
 - doc/release_notes/5.9.0.txt
@@ -294,6 +295,7 @@ files:
 - doc/release_notes/5.65.0.txt
 - doc/release_notes/5.66.0.txt
 - doc/release_notes/5.67.0.txt
+- doc/release_notes/5.68.0.txt
 - doc/release_notes/5.7.0.txt
 - doc/release_notes/5.8.0.txt
 - doc/release_notes/5.9.0.txt
@@ -583,6 +585,7 @@ files:
 - lib/sequel/plugins/validation_class_methods.rb
 - lib/sequel/plugins/validation_contexts.rb
 - lib/sequel/plugins/validation_helpers.rb
+- lib/sequel/plugins/validation_helpers_generic_type_messages.rb
 - lib/sequel/plugins/whitelist_security.rb
 - lib/sequel/plugins/xml_serializer.rb
 - lib/sequel/sql.rb