sequel 5.107.0 → 5.108.0

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,14 @@
 #
 #   using Sequel::CoreRefinements
 
-# :nocov:
+# simplecov:disable
 raise(Sequel::Error, "Refinements require ruby 2.0.0 or greater") unless RUBY_VERSION >= '2.0.0'
-# :nocov:
+# simplecov:enable
 
 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 +201,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 +222,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,9 @@
 
 module Sequel
   module DuplicateColumnsHandler
-    # :nocov:
+    # simplecov:disable
     CALLER_ARGS = (RUBY_VERSION >= '2.0' ? [0,1] : [0]).freeze
-    # :nocov:
+    # simplecov:enable
 
     # 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

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

@@ -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.

data/lib/sequel/extensions/pg_array.rb

@@ -77,6 +77,7 @@ module Sequel
     # Represents a PostgreSQL array column value.
     class PGArray < DelegateClass(Array)
       include Sequel::SQL::AliasMethods
+      include Sequel::SQL::CastMethods
 
       module DatabaseMethods
         BLOB_RANGE = 1...-1
@@ -362,18 +363,18 @@ module Sequel
             raise Sequel::Error, "invalid array, empty string" if eos?
             raise Sequel::Error, "invalid array, doesn't start with {" unless scan(/((\[\d+:\d+\])+=)?\{/)
 
-            # :nocov:
+            # simplecov:disable
             while !eos?
-            # :nocov:
+            # simplecov:enable
               char = scan(/[{}",]|[^{}",]+/)
               if char == ','
                 # Comma outside quoted string indicates end of current entry
                 new_entry
               elsif char == '"'
                 raise Sequel::Error, "invalid array, opening quote with existing recorded data" unless @recorded.empty?
-                # :nocov:
+                # simplecov:disable
                 while true
-                # :nocov:
+                # simplecov:enable
                   char = scan(/["\\]|[^"\\]+/)
                   if char == '\\'
                     @recorded << getch
@@ -434,12 +435,12 @@ module Sequel
         end
 
         if Sequel::Postgres.respond_to?(:parse_pg_array)
-        # :nocov:
+        # simplecov:disable
           # Use sequel_pg's C-based parser if it has already been defined.
           def call(string)
             PGArray.new(Sequel::Postgres.parse_pg_array(string, @converter), @type)
           end
-        # :nocov:
+        # simplecov:enable
         else
           # Parse the string using Parser with the appropriate
           # converter, and return a PGArray with the appropriate database
@@ -531,7 +532,7 @@ module Sequel
   Database.register_extension(:pg_array, Postgres::PGArray::DatabaseMethods)
 end
 
-# :nocov:
+# simplecov:disable
 if Sequel.core_extensions?
   class Array
     # Return a PGArray proxy to the receiver, using a
@@ -553,4 +554,4 @@ if defined?(Sequel::CoreRefinements)
     end
   end
 end
-# :nocov:
+# simplecov:enable

data/lib/sequel/extensions/pg_array_ops.rb

@@ -54,15 +54,20 @@
 #   ia.join            # array_to_string(int_array_column, '')
 #   ia.join(':')       # array_to_string(int_array_column, ':')
 #   ia.join(':', ' ')  # array_to_string(int_array_column, ':', ' ')
-#   ia.unnest          # unnest(int_array_column)
-#   ia.unnest(:b)      # unnest(int_array_column, b)
-#
-# On PostgreSQL 18+, the following are supported:
-#
+#   ia.ndims           # array_ndims(int_array_column)
+#   ia.position(3)     # array_position(int_array_column, 3, 1)
+#   ia.position(3, 2)  # array_position(int_array_column, 3, 2)
+#   ia.positions(3)    # array_positions(int_array_column, 3)
+#   ia.prepend(3)      # array_prepend(3, int_array_column)
+#   ia.reverse             # array_reverse(int_array_column)
+#   ia.sample(3)       # array_sample(int_array_column, 3)
+#   ia.shuffle         # array_shuffle(int_array_column)
 #   ia.sort                # array_sort(int_array_column)
 #   ia.sort(desc: true)    # array_sort(int_array_column, true)
 #   ia.sort(nulls: :first) # array_sort(int_array_column, false, true)
-#   ia.reverse             # array_reverse(int_array_column)
+#   ia.trim(1)         # trim_array(int_array_column, 1)
+#   ia.unnest          # unnest(int_array_column)
+#   ia.unnest(:b)      # unnest(int_array_column, b)
 # 
 # See the PostgreSQL array function and operator documentation for more
 # details on what these functions and operators do.
@@ -153,6 +158,13 @@ module Sequel
         function(:array_dims)
       end
 
+      # Call the array_ndims method:
+      #
+      #   array_op.ndims # array_ndims(array)
+      def ndims
+        function(:array_ndims)
+      end
+
       # Convert the array into an hstore using the hstore function.
       # If given an argument, use the two array form:
       #
@@ -164,9 +176,9 @@ module Sequel
         else
           Sequel.function(:hstore, self, wrap_array(arg))
         end
-        # :nocov:
+        # simplecov:disable
         if Sequel.respond_to?(:hstore_op)
-        # :nocov:
+        # simplecov:enable
           v = Sequel.hstore_op(v)
         end
         v
@@ -188,6 +200,28 @@ module Sequel
         function(:array_lower, dimension)
       end
       
+      # Call the array_position method:
+      #
+      #   array_op.position(1)    # array_position(array, 1, 1)
+      #   array_op.position(1, 2) # array_position(array, 1, 2)
+      def position(element, offset = 1)
+        function(:array_position, element, offset)
+      end
+      
+      # Call the array_positions method:
+      #
+      #   array_op.positions(1) # array_positions(array, 1)
+      def positions(element)
+        function(:array_positions, element)
+      end
+      
+      # Call the array_prepend method:
+      #
+      #   array_op.prepend(1) # array_prepend(1, array)
+      def prepend(element)
+        SQL::Function.new(:array_prepend, element, self)
+      end
+      
       # Use the overlaps (&&) operator:
       #
       #   array_op.overlaps(:a) # (array && a)
@@ -195,7 +229,7 @@ module Sequel
         bool_op(OVERLAPS, wrap_array(other))
       end
 
-      # Use the concatentation (||) operator:
+      # Use the concatenation (||) operator:
       #
       #   array_op.push(:a) # (array || a)
       #   array_op.concat(:a) # (array || a)
@@ -231,6 +265,20 @@ module Sequel
         function(:array_reverse)
       end
       
+      # Call the array_sample method:
+      #
+      #   array_op.sample(1) # array_sample(array, 1)
+      def sample(element)
+        function(:array_sample, element)
+      end
+      
+      # Call the array_shuffle method:
+      #
+      #   array_op.shuffle # array_shuffle
+      def shuffle
+        function(:array_shuffle)
+      end
+      
       # Call the array_sort method. Options:
       #
       # :desc :: Sort in descending order instead of ascending order.
@@ -273,6 +321,13 @@ module Sequel
       end
       alias join to_string
       
+      # Call the trim_array method:
+      #
+      #   array_op.trim(1) # array_trim(array, 1)
+      def trim(number)
+        function(:trim_array, number)
+      end
+      
       # Call the unnest method:
       #
       #   array_op.unnest # unnest(array)
@@ -280,7 +335,7 @@ module Sequel
         function(:unnest, *args.map{|a| wrap_array(a)})
       end
       
-      # Use the concatentation (||) operator, reversing the order:
+      # Use the concatenation (||) operator, reversing the order:
       #
       #   array_op.unshift(:a) # (a || array)
       def unshift(other)
@@ -326,9 +381,9 @@ module Sequel
       end
     end
 
-    # :nocov:
+    # simplecov:disable
     if defined?(PGArray)
-    # :nocov:
+    # simplecov:enable
       class PGArray
         # Wrap the PGArray instance in an ArrayOp, allowing you to easily use
         # the PostgreSQL array functions and operators with literal arrays.
@@ -360,7 +415,7 @@ module Sequel
   end
 end
 
-# :nocov:
+# simplecov:disable
 if Sequel.core_extensions?
   class Symbol
     include Sequel::Postgres::ArrayOpMethods
@@ -374,4 +429,4 @@ if defined?(Sequel::CoreRefinements)
     end
   end
 end
-# :nocov:
+# simplecov:enable

data/lib/sequel/extensions/pg_auto_parameterize.rb

@@ -56,7 +56,7 @@
 #      DB[:t].select{foo('a').as(:f)}.group{foo('a')}
 #      # SELECT foo('a') AS "f" FROM "t" GROUP BY foo('a')
 #
-#    Will get auto paramterized as:
+#    Will get auto parameterized as:
 #
 #      # SELECT foo($1) AS "f" FROM "t" GROUP BY foo($2)
 #
@@ -180,7 +180,7 @@ module Sequel
         end
       end
 
-      # PlacholderLiteralizer subclass with support for stored auto parameters.
+      # PlaceholderLiteralizer subclass with support for stored auto parameters.
       class PlaceholderLiteralizer < ::Sequel::Dataset::PlaceholderLiteralizer
         def initialize(dataset, fragments, final_sql, arity)
           s = dataset.sql.dup

data/lib/sequel/extensions/pg_auto_parameterize_in_array.rb

@@ -49,7 +49,7 @@ module Sequel
     # Enable automatically parameterizing queries.
     module AutoParameterizeInArray
       module TreatStringListAsUntypedArray
-        # Sentinal value to use as an auto param type to use auto parameterization
+        # Sentinel value to use as an auto param type to use auto parameterization
         # of a string array without an explicit type cast.
         NO_EXPLICIT_CAST = Object.new.freeze
 
@@ -64,7 +64,7 @@ module Sequel
 
         private
 
-        # Recognize NO_EXPLICIT_CAST sentinal value and use wrapped
+        # Recognize NO_EXPLICIT_CAST sentinel value and use wrapped
         # PGArray that will be parameterized into the query.
         def _convert_array_to_pg_array_with_type(r, type)
           if NO_EXPLICIT_CAST.equal?(type)
@@ -158,7 +158,7 @@ module Sequel
         nil
       end
 
-      # The minimium size of array to auto parameterize.
+      # The minimum size of array to auto parameterize.
       def pg_auto_parameterize_min_array_size
         2
       end

data/lib/sequel/extensions/pg_enum.rb

@@ -180,9 +180,9 @@ module Sequel
   end
 
   # support reversible create_enum statements if the migration extension is loaded
-  # :nocov:
+  # simplecov:disable
   if defined?(MigrationReverser)
-  # :nocov:
+  # simplecov:enable
     class MigrationReverser
       private
       def create_enum(name, _)

data/lib/sequel/extensions/pg_extended_date_support.rb

@@ -31,7 +31,7 @@ module Sequel
       RATIONAL_60 = Rational(60)
       TIME_CAN_PARSE_BC = RUBY_VERSION >= '2.5'
 
-      # Add dataset methods and update the conversion proces for dates and timestamps.
+      # Add dataset methods and update the conversion process for dates and timestamps.
       def self.extended(db)
         db.extend_datasets(DatasetMethods)
         procs = db.conversion_procs
@@ -114,10 +114,10 @@ module Sequel
               DateTime.parse(value)
             elsif TIME_CAN_PARSE_BC
               Time.parse(value)
-            # :nocov:
+            # simplecov:disable
             else
               DateTime.parse(value).to_time
-            # :nocov:
+            # simplecov:enable
             end
 
             Sequel.convert_output_timestamp(dt, Sequel.application_timezone)
@@ -219,7 +219,7 @@ module Sequel
         end
 
         if RUBY_ENGINE == 'jruby'
-          # :nocov:
+          # simplecov:disable
 
           ExtendedDateSupport::CONVERT_TYPES = [Java::JavaSQL::Types::DATE, Java::JavaSQL::Types::TIMESTAMP]
 
@@ -241,7 +241,7 @@ module Sequel
               super
             end
           end
-          # :nocov:
+          # simplecov:enable
         else
           # Handle BC Time objects.
           def literal_time(time)

data/lib/sequel/extensions/pg_extended_integer_support.rb

@@ -53,7 +53,7 @@
 #  # => "numeric"
 #
 # The +:raw+ behavior was Sequel's historical behavior, but unless
-# you fully understand the reprecussions of PostgreSQL using a
+# you fully understand the repercussions of PostgreSQL using a
 # numeric type for integer values, you should not use it.
 #
 # To get the current default behavior of raising an exception for

data/lib/sequel/extensions/pg_hstore.rb

@@ -326,7 +326,7 @@ module Sequel
   Database.register_extension(:pg_hstore, Postgres::HStore::DatabaseMethods)
 end
 
-# :nocov:
+# simplecov:disable
 if Sequel.core_extensions?
   class Hash
     # Create a new HStore using the receiver as the input
@@ -350,4 +350,4 @@ if defined?(Sequel::CoreRefinements)
     end
   end
 end
-# :nocov:
+# simplecov:enable