sequel 5.106.0 → 5.109.0

data/lib/sequel/dataset/query.rb

@@ -98,7 +98,7 @@ module Sequel
         c.freeze
       end
     else
-      # :nocov:
+      # simplecov:disable
       def clone(opts = OPTS) # :nodoc:
         c = super()
         c.opts.merge!(opts)
@@ -108,7 +108,7 @@ module Sequel
         c.opts.freeze
         c
       end
-      # :nocov:
+      # simplecov:enable
     end
 
     # Returns a copy of the dataset with the SQL DISTINCT clause. The DISTINCT
@@ -213,13 +213,13 @@ module Sequel
         end
       end
     else
-      # :nocov:
+      # simplecov:disable
       def extension(*exts) # :nodoc:
         c = clone
         c.send(:_extension!, exts)
         c
       end
-      # :nocov:
+      # simplecov:enable
     end
 
     # Alias for where.
@@ -1250,14 +1250,14 @@ module Sequel
         o.freeze
       end
     else
-      # :nocov:
+      # simplecov:disable
       def with_extend(*mods, &block) # :nodoc:
         c = clone
         c.extend(*mods) unless mods.empty?
         c.extend(DatasetModule.new(&block)) if block
         c
       end
-      # :nocov:
+      # simplecov:enable
     end
 
     # Returns a cloned dataset with the given row_proc.
@@ -1354,7 +1354,7 @@ module Sequel
 
     private
 
-    # :nocov:
+    # simplecov:disable
     unless TRUE_FREEZE
       # Load the extensions into the receiver, without checking if the receiver is frozen.
       def _extension!(exts)
@@ -1373,7 +1373,7 @@ module Sequel
         self
       end
     end
-    # :nocov:
+    # simplecov:enable
 
     # A frozen array for the currently selected columns.
     def _current_select(allow_plain_wildcard)

data/lib/sequel/dataset/sql.rb

@@ -1022,11 +1022,19 @@ module Sequel
     # order if not. Also removes the row_proc, which isn't needed
     # for aggregate calculations.
     def aggregate_dataset
-      (aggreate_dataset_use_from_self? ? from_self : unordered).naked
+      (aggregate_dataset_use_from_self? ? from_self : unordered).naked
+    end
+
+    def aggreate_dataset_use_from_self? # :nodoc:
+      # SEQUEL6: Remove
+      # simplecov:disable
+      Sequel::Deprecation.deprecate("Dataset#aggreate_dataset_use_from_self", "Use #aggregate_dataset_use_from_self? instead")
+      aggregate_dataset_use_from_self?
+      # simplecov:enable
     end
 
     # Whether to use from_self for an aggregate dataset.
-    def aggreate_dataset_use_from_self?
+    def aggregate_dataset_use_from_self?
       options_overlap(COUNT_FROM_SELF_OPTS)
     end
 
@@ -1120,9 +1128,9 @@ module Sequel
     # operators unsupported by some databases. Used by adapters for databases
     # that don't support the operators natively.
     def complex_expression_emulate_append(sql, op, args)
-      # :nocov:
+      # simplecov:disable
       case op
-      # :nocov:
+      # simplecov:enable
       when :%
         complex_expression_arg_pairs_append(sql, args){|a, b| Sequel.function(:MOD, a, b)}
       when :>>
@@ -1204,7 +1212,7 @@ module Sequel
       end
     end
 
-    # Append literalization of array of grouping elements to SQL string, seperating them with commas.
+    # Append literalization of array of grouping elements to SQL string, separating them with commas.
     def grouping_element_list_append(sql, columns)
       c = false
       co = ', '
@@ -1229,7 +1237,7 @@ module Sequel
       db.from_application_timestamp(v).strftime(default_timestamp_format)
     end
     
-    # :nocov:
+    # simplecov:disable
 
     # Return the SQL timestamp fragment to use for the fractional time part.
     # Should start with the decimal point.  Uses 6 decimal places by default.
@@ -1240,7 +1248,7 @@ module Sequel
       end
       sprintf(".%0#{ts}d", usec)
     end
-    # :nocov:
+    # simplecov:enable
 
     # Append literalization of identifier to SQL string, considering regular strings
     # as SQL identifiers instead of SQL strings.
@@ -1338,10 +1346,21 @@ module Sequel
     alias delete_returning_sql insert_returning_sql
     alias update_returning_sql insert_returning_sql
 
-    # SQL fragment specifying a JOIN type, converts underscores to
-    # spaces and upcases.
+    JOIN_TYPE_SQL = {}
+    (CONDITIONED_JOIN_TYPES + UNCONDITIONED_JOIN_TYPES + %i[natural_inner natural_left_outer natural_right_outer natural_full_outer]).each do |join_type|
+      JOIN_TYPE_SQL[join_type] = "#{join_type.to_s.tr('_', ' ').upcase} JOIN".freeze
+    end
+    JOIN_TYPE_SQL[nil] = "JOIN"
+    JOIN_TYPE_SQL.freeze
+    private_constant :JOIN_TYPE_SQL
+
+    # SQL fragment for join type
     def join_type_sql(join_type)
-      "#{join_type.to_s.tr('_', ' ').upcase} JOIN"
+      JOIN_TYPE_SQL.fetch(join_type) do
+        # SEQUEL6: Raise error
+        Sequel::Deprecation.deprecate("Unrecognized join type used: #{join_type.inspect}. This will raise an error starting in Sequel 6.")
+        "#{join_type.to_s.tr('_', ' ').upcase} JOIN"
+      end
     end
 
     # Append USING clause for JOIN USING
@@ -1372,7 +1391,7 @@ module Sequel
       literal_string_append(sql, v)
     end
 
-    # Append literalization of dataset to SQL string.  Does a subselect inside parantheses.
+    # Append literalization of dataset to SQL string.  Does a subselect inside parentheses.
     def literal_dataset_append(sql, v)
       sql << 'LATERAL ' if v.opts[:lateral]
       sql << '('
@@ -1438,7 +1457,7 @@ module Sequel
     # Append a literalization of the object to the given SQL string.
     # Calls +sql_literal_append+ if object responds to it, otherwise
     # calls +sql_literal+ if object responds to it, otherwise raises an error.
-    # If a database specific type is allowed, this should be overriden in a subclass.
+    # If a database specific type is allowed, this should be overridden in a subclass.
     def literal_other_append(sql, v)
       if v.respond_to?(:sql_literal_append)
         v.sql_literal_append(self, sql)
@@ -1559,7 +1578,7 @@ module Sequel
     end
 
     # Modify the sql to add a dataset to the via an EXCEPT, INTERSECT, or UNION clause.
-    # This uses a subselect for the compound datasets used, because using parantheses doesn't
+    # This uses a subselect for the compound datasets used, because using parentheses doesn't
     # work on all databases.
     def select_compounds_sql(sql)
       return unless c = @opts[:compounds]

data/lib/sequel/dataset.rb

@@ -54,7 +54,7 @@ module Sequel
   require_relative "dataset/placeholder_literalizer"
   require_relative "dataset/dataset_module"
 
-  # :nocov:
+  # simplecov:disable
   require_relative "dataset/deprecated_singleton_class_methods" if Dataset::TRUE_FREEZE
-  # :nocov:
+  # simplecov:enable
 end

data/lib/sequel/deprecated.rb

@@ -60,9 +60,9 @@ module Sequel
     # If using ruby 2.3+, use Module#deprecate_constant to deprecate the constant,
     # otherwise do nothing as the ruby implementation does not support constant deprecation.
     def self.deprecate_constant(mod, constant)
-      # :nocov:
+      # simplecov:disable
       if RUBY_VERSION > '2.3'
-      # :nocov:
+      # simplecov:enable
         mod.deprecate_constant(constant)
       end
     end

data/lib/sequel/exceptions.rb

@@ -8,9 +8,9 @@ module Sequel
     # exception is held here.
     attr_accessor :wrapped_exception
 
-    # :nocov:
+    # simplecov:disable
     if RUBY_VERSION >= '2.1'
-    # :nocov:
+    # simplecov:enable
       # Returned the wrapped exception if one exists, otherwise use
       # ruby's default behavior.
       def cause

data/lib/sequel/extensions/_pretty_table.rb

@@ -74,7 +74,7 @@ module Sequel
       String.new << '|' << columns.map {|c| "%-#{sizes[c]}s" % c.to_s}.join('|') << '|'
     end
 
-    # String for separtor line
+    # String for separator line
     def self.separator_line(columns, sizes) # :nodoc:
       String.new << '+' << columns.map {|c| '-' * sizes[c]}.join('+') << '+'
     end

data/lib/sequel/extensions/async_thread_pool.rb

@@ -78,7 +78,7 @@
 #
 #   # ...
 #   if result 
-#     # will always execute this banch, since result is a proxy object
+#     # will always execute this branch, since result is a proxy object
 #   end
 #
 # In this case, you can call the +__value+ method to return the actual
@@ -244,9 +244,9 @@ module Sequel
       def method_missing(*args, &block)
         __value.public_send(*args, &block)
       end
-      # :nocov:
+      # simplecov:disable
       ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
-      # :nocov:
+      # simplecov:enable
 
       # Delegate respond_to? calls to the returned result.
       def respond_to_missing?(*args)

data/lib/sequel/extensions/auto_cast_date_and_time.rb

@@ -45,7 +45,7 @@
 #
 module Sequel
   module AutoCastDateAndTime
-    # :nocov:
+    # simplecov:disable
 
     # Mark the datasets as requiring sql standard date times.  This is only needed
     # for backwards compatibility.  
@@ -53,7 +53,7 @@ module Sequel
       # SEQUEL6: Remove
       true
     end
-    # :nocov:
+    # simplecov:enable
 
     private
 

data/lib/sequel/extensions/blank.rb

@@ -7,11 +7,11 @@
 #   Sequel.extension :blank
 
 [FalseClass, Object, NilClass, Numeric, String, TrueClass].each do |klass|
-  # :nocov:
+  # simplecov:disable
   if klass.method_defined?(:blank?)
     klass.send(:alias_method, :blank?, :blank?)
   end
-  # :nocov:
+  # simplecov:enable
 end
 
 class FalseClass

data/lib/sequel/extensions/constraint_validations.rb

@@ -95,7 +95,7 @@
 #   integers, and a range of integers.
 # * There are like and ilike validations, which are similar to the format
 #   validation but use a case sensitive or case insensitive LIKE pattern. LIKE
-#   patters are very simple, so many regexp patterns cannot be expressed by
+#   patterns are very simple, so many regexp patterns cannot be expressed by
 #   them, but only a couple databases (PostgreSQL and MySQL) support regexp
 #   patterns.
 # * The operator validation only supports >, >=, <, and <= operators, and the

data/lib/sequel/extensions/core_refinements.rb

@@ -10,14 +10,11 @@
 #
 #   using Sequel::CoreRefinements
 
-# :nocov:
-raise(Sequel::Error, "Refinements require ruby 2.0.0 or greater") unless RUBY_VERSION >= '2.0.0'
-# :nocov:
-
+#
 module Sequel::CoreRefinements
-  # :nocov:
+  # simplecov:disable
   include_meth = RUBY_VERSION >= '3.1' ? :import_methods : :include
-  # :nocov:
+  # simplecov:enable
   INCLUDE_METH = include_meth
   private_constant :INCLUDE_METH
 
@@ -201,16 +198,16 @@ module Sequel::CoreRefinements
     send include_meth, Sequel::SQL::BooleanMethods
     send include_meth, Sequel::SQL::NumericMethods
 
-    # :nocov:
+    # simplecov:disable
     remove_method :* if RUBY_VERSION >= '3.1'
-    # :nocov:
+    # simplecov:enable
 
     send include_meth, Sequel::SQL::QualifyingMethods
     send include_meth, Sequel::SQL::StringMethods
     send include_meth, Sequel::SQL::SubscriptMethods
     send include_meth, Sequel::SQL::ComplexExpressionMethods
 
-    # :nocov:
+    # simplecov:disable
     if RUBY_VERSION >= '3.1'
       remove_method :*
       def *(ce=(arg=false;nil))
@@ -222,7 +219,7 @@ module Sequel::CoreRefinements
       end
 
     end
-    # :nocov:
+    # simplecov:enable
 
     # Returns receiver wrapped in an <tt>Sequel::SQL::Identifier</tt>.
     #

data/lib/sequel/extensions/date_arithmetic.rb

@@ -1,7 +1,7 @@
 # frozen-string-literal: true
 #
 # The date_arithmetic extension adds the ability to perform database-independent
-# addition/substraction of intervals to/from dates and timestamps.
+# addition/subtraction of intervals to/from dates and timestamps.
 #
 # First, you need to load the extension into the database:
 #

data/lib/sequel/extensions/datetime_parse_to_time.rb

@@ -20,10 +20,10 @@ module Sequel::DateTimeParseToTime
   # be in UTC and there is no offset information in the string.
   def convert_input_timestamp(v, input_timezone)
     if v.is_a?(String) && datetime_class == Time && input_timezone == :utc && !_date_parse(v).has_key?(:offset)
-      # :nocov:
+      # simplecov:disable
       # Whether this is fully branch covered depends on the order in which the specs are run.
       v = handle_date_parse_input(v) if respond_to?(:handle_date_parse_input, true)
-      # :nocov:
+      # simplecov:enable
       t = DateTime.parse(v).to_time
       case application_timezone
       when nil, :local

data/lib/sequel/extensions/duplicate_columns_handler.rb

@@ -40,9 +40,7 @@
 
 module Sequel
   module DuplicateColumnsHandler
-    # :nocov:
-    CALLER_ARGS = (RUBY_VERSION >= '2.0' ? [0,1] : [0]).freeze
-    # :nocov:
+    CALLER_ARGS = [0,1].freeze
 
     # Customize handling of duplicate columns for this dataset.
     def on_duplicate_columns(handler = (raise Error, "Must provide either an argument or a block to on_duplicate_columns" unless defined?(yield); nil), &block)

data/lib/sequel/extensions/graph_each.rb

@@ -43,7 +43,7 @@ module Sequel
     private
 
     # Fetch the rows, split them into component table parts,
-    # tranform and run the row_proc on each part (if applicable),
+    # transform and run the row_proc on each part (if applicable),
     # and yield a hash of the parts.
     def graph_each(sql=select_sql)
       # Reject tables with nil datasets, as they are excluded from

data/lib/sequel/extensions/index_caching.rb

@@ -14,7 +14,7 @@
 #
 #   # load model files
 #
-# Then, whenever database indicies are modified, write a new cached
+# Then, whenever database indices are modified, write a new cached
 # file.  You can do that with <tt>bin/sequel</tt>'s -X option:
 #
 #   bin/sequel -X /path/to/index_cache.dump postgres://...

data/lib/sequel/extensions/inflector.rb

@@ -31,7 +31,7 @@ class String
     @plurals, @singulars, @uncountables = [], [], []
 
     class << self
-      # Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
+      # Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for pluralization.
       attr_reader :plurals
 
       # Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
@@ -107,11 +107,11 @@ class String
   end
   
   %w'classify constantize dasherize demodulize foreign_key humanize pluralize singularize tableize underscore'.each do |m|
-    # :nocov:
+    # simplecov:disable
     if method_defined?(m)
       alias_method(m, m)
     end
-    # :nocov:
+    # simplecov:enable
   end
 
   # By default, camelize converts the string to UpperCamelCase. If the argument to camelize
@@ -212,8 +212,8 @@ class String
   # Examples
   #   "posts".singularize #=> "post"
   #   "octopi".singularize #=> "octopus"
-  #   "sheep".singluarize #=> "sheep"
-  #   "word".singluarize #=> "word"
+  #   "sheep".singularize #=> "sheep"
+  #   "word".singularize #=> "word"
   #   "the blue mailmen".singularize #=> "the blue mailman"
   #   "CamelOctopi".singularize #=> "CamelOctopus"
   def singularize

data/lib/sequel/extensions/is_distinct_from.rb

@@ -124,7 +124,7 @@ module Sequel
   Dataset.register_extension(:is_distinct_from, SQL::IsDistinctFrom::DatasetMethods)
 end
 
-# :nocov:
+# simplecov:disable
 if Sequel.core_extensions?
   class Symbol
     include Sequel::SQL::IsDistinctFrom::Methods
@@ -138,4 +138,4 @@ if defined?(Sequel::CoreRefinements)
     end
   end
 end
-# :nocov:
+# simplecov:enable

data/lib/sequel/extensions/lit_require_frozen.rb

@@ -46,16 +46,16 @@ module Sequel
   class LiteralString
     # The string used when creating the literal string (first argument to
     # Sequel::LiteralString.new). This may be nil if no string was provided,
-    # or if the litral string was created before this extension was required.
+    # or if the literal string was created before this extension was required.
     attr_reader :source
 
     def initialize(*a)
       @source = a.first
       super
     end
-    # :nocov:
+    # simplecov:disable
     ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
-    # :nocov:
+    # simplecov:enable
   end
 
   module LitRequireFrozen
@@ -63,6 +63,20 @@ module Sequel
     class Error < Sequel::Error
     end
 
+    module BooleanExpressionClassMethods
+      private
+
+      # Do not freeze literal strings in value pairs, so they don't skip
+      # the frozen checks.
+      def from_value_pair(l, r)
+        if LiteralString === r
+          new(:'=', l, r)
+        else
+          super
+        end
+      end
+    end
+
     module DatabaseMethods
       def self.extended(db)
         db.extend_datasets(DatasetMethods)
@@ -105,7 +119,7 @@ module Sequel
       def _check_unfrozen_literal_string(str)
         return if !str.is_a?(String) || str.frozen?
 
-        if str.is_a?(LiteralString)
+        if str.is_a?(LiteralString) && str == str.source
           _check_unfrozen_literal_string(str.source)
         else
           raise Error, "cannot treat unfrozen string as literal SQL: #{str.inspect}"
@@ -126,6 +140,8 @@ module Sequel
     end
   end
 
+  SQL::BooleanExpression.extend(LitRequireFrozen::BooleanExpressionClassMethods)
+
   Dataset.register_extension(:lit_require_frozen, LitRequireFrozen::DatasetMethods)
   Database.register_extension(:lit_require_frozen, LitRequireFrozen::DatabaseMethods)
 end

data/lib/sequel/extensions/migration.rb

@@ -68,9 +68,9 @@ module Sequel
       # Allow calling private methods for backwards compatibility
       @db.send(method_sym, *args, &block)
     end
-    # :nocov:
+    # simplecov:disable
     ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
-    # :nocov:
+    # simplecov:enable
 
     # This object responds to all methods the database responds to.
     def respond_to_missing?(meth, include_private)
@@ -410,6 +410,11 @@ module Sequel
     private_constant :MIGRATION_ADVISORY_LOCK_ID
 
     # Migrates the supplied database using the migration files in the specified directory. Options:
+    # :allow_migration_number :: Set to check each migration number. If set, calls the
+    #                            <tt>===</tt> method on the object with the migration number,
+    #                            allowing it to work with both ranges and procs. If the
+    #                            <tt>===</tt> method returns false, an exception is raised
+    #                            (TimestampMigrator only).
     # :allow_missing_migration_files :: Don't raise an error if there are missing migration files.
     #                                   It is very risky to use this option, since it can result in
     #                                   the database schema version number not matching the expected
@@ -699,6 +704,7 @@ module Sequel
 
     # Set up all state for the migrator instance
     def initialize(db, directory, opts=OPTS)
+      @allow_migration_number = opts[:allow_migration_number]
       super
       @target = opts[:target]
       @applied_migrations = get_applied_migrations
@@ -788,20 +794,28 @@ module Sequel
     # Returns any migration files found in the migrator's directory.
     def get_migration_files
       files = []
+      allow_migration_number = @allow_migration_number
+
       Dir.new(directory).each do |file|
         next unless MIGRATION_FILE_PATTERN.match(file)
         files << File.join(directory, file)
       end
-      files.sort! do |a, b|
-        a_ver, a_name = split_migration_filename(a)
-        b_ver, b_name = split_migration_filename(b)
+
+      files.map! do |f|
+        ver, = split = split_migration_filename(f)
+        if allow_migration_number && !(allow_migration_number === ver)
+          raise Error, "Migration filename uses version number that is not allowed: #{f}"
+        end
+        [f, *split]
+      end.sort! do |a, b|
+        _, a_ver, a_name = a
+        _, b_ver, b_name = b
         x = a_ver <=> b_ver
         if x.zero?
           x = a_name <=> b_name
         end
         x
-      end
-      files
+      end.map!(&:first)
     end
 
     # Return an integer and name (without extension) for the given path.

data/lib/sequel/extensions/named_timezones.rb

@@ -69,7 +69,7 @@ module Sequel
     
     if RUBY_VERSION >= '2.6'
       # Whether Time.at with :nsec and :in is broken.  True on JRuby < 9.3.9.0.
-      BROKEN_TIME_AT_WITH_NSEC = defined?(JRUBY_VERSION) && (JRUBY_VERSION < '9.3' || (JRUBY_VERSION < '9.4' && JRUBY_VERSION.split('.')[2].to_i < 9))
+      BROKEN_TIME_AT_WITH_NSEC = defined?(JRUBY_VERSION) && (JRUBY_VERSION.to_r < Rational('9.3') || (JRUBY_VERSION.to_r < Rational('9.4') && JRUBY_VERSION.split('.')[2].to_i < 9))
       private_constant :BROKEN_TIME_AT_WITH_NSEC
 
       # Convert the given input Time (which must be in UTC) to the given input timezone,
@@ -80,10 +80,10 @@ module Sequel
         raise unless disamb = tzinfo_disambiguator_for(v)
         period = input_timezone.period_for_local(v, &disamb)
         offset = period.utc_total_offset
-        # :nocov:
+        # simplecov:disable
         if BROKEN_TIME_AT_WITH_NSEC
           Time.at(v.to_i - offset, :in => input_timezone) + v.nsec/1000000000.0
-        # :nocov:
+        # simplecov:enable
         else
           Time.at(v.to_i - offset, v.nsec, :nsec, :in => input_timezone)
         end
@@ -92,16 +92,16 @@ module Sequel
       # Convert the given input Time to the given output timezone,
       # which should be a TZInfo::Timezone instance.
       def convert_output_time_other(v, output_timezone)
-        # :nocov:
+        # simplecov:disable
         if BROKEN_TIME_AT_WITH_NSEC
           Time.at(v.to_i, :in => output_timezone) + v.nsec/1000000000.0
-        # :nocov:
+        # simplecov:enable
         else
           Time.at(v.to_i, v.nsec, :nsec, :in => output_timezone)
         end
       end
       # :nodoc:
-      # :nocov:
+      # simplecov:disable
     else
       def convert_input_time_other(v, input_timezone)
         local_offset = input_timezone.period_for_local(v, &tzinfo_disambiguator_for(v)).utc_total_offset
@@ -122,7 +122,7 @@ module Sequel
         end
       end
       # :nodoc:
-      # :nocov:
+      # simplecov:enable
     end
 
     # Handle both TZInfo 1 and TZInfo 2
@@ -139,7 +139,7 @@ module Sequel
         DateTime.civil(v.year, v.month, v.day, v.hour, v.minute, v.second + v.sec_fraction, v.offset, v.start)
       end
       # :nodoc:
-      # :nocov:
+      # simplecov:disable
     else
       # Assume the given DateTime has a correct time but a wrong timezone.  It is
       # currently in UTC timezone, but it should be converted to the input_timezone.
@@ -161,7 +161,7 @@ module Sequel
         (v - local_offset).new_offset(local_offset)
       end
       # :nodoc:
-      # :nocov:
+      # simplecov:enable
     end
     
     # Returns TZInfo::Timezone instance if given a String.