sequel 5.106.0 → 5.109.0

data/lib/sequel/connection_pool/sharded_threaded.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+# SEQUEL6: Remove, deprecation: add warning if used on Ruby 3.2+
+
 require_relative 'threaded'
 
 # The slowest and most advanced connection pool, dealing with both multi-threaded
@@ -95,7 +97,7 @@ class Sequel::ShardedThreadedConnectionPool < Sequel::ThreadedConnectionPool
   # 
   # Once a connection is requested using #hold, the connection pool
   # creates new connections to the database. Options:
-  # :server :: Should be a symbol specifing the server to disconnect from,
+  # :server :: Should be a symbol specifying the server to disconnect from,
   #            or an array of symbols to specify multiple servers.
   def disconnect(opts=OPTS)
     (opts[:server] ? Array(opts[:server]) : sync{@servers.keys}).each do |s|
@@ -203,7 +205,7 @@ class Sequel::ShardedThreadedConnectionPool < Sequel::ThreadedConnectionPool
 
     until conn = assign_connection(thread, server)
       elapsed = Sequel.elapsed_seconds_since(timer)
-      # :nocov:
+      # simplecov:disable
       raise_pool_timeout(elapsed, server) if elapsed > timeout
 
       # It's difficult to get to this point, it can only happen if there is a race condition
@@ -211,7 +213,7 @@ class Sequel::ShardedThreadedConnectionPool < Sequel::ThreadedConnectionPool
       if conn = acquire_available(thread, server, timeout - elapsed)
         return conn
       end
-      # :nocov:
+      # simplecov:enable
     end
 
     conn
@@ -223,11 +225,11 @@ class Sequel::ShardedThreadedConnectionPool < Sequel::ThreadedConnectionPool
       # Check if connection was checked in between when assign_connection failed and now.
       # This is very unlikely, but necessary to prevent a situation where the waiter
       # will wait for a connection even though one has already been checked in.
-      # :nocov:
+      # simplecov:disable
       if conn = next_available(server)
         return(allocated(server)[thread] = conn)
       end
-      # :nocov:
+      # simplecov:enable
 
       @waiters[server].wait(@mutex, timeout)
 

data/lib/sequel/connection_pool/sharded_timed_queue.rb

@@ -1,8 +1,8 @@
 # frozen-string-literal: true
 
-# :nocov:
+# simplecov:disable
 raise LoadError, "Sequel::ShardedTimedQueueConnectionPool is only available on Ruby 3.2+" unless RUBY_VERSION >= '3.2'
-# :nocov:
+# simplecov:enable
 
 # A connection pool allowing multi-threaded access to a sharded pool of connections,
 # using a timed queue (only available in Ruby 3.2+).
@@ -148,7 +148,7 @@ class Sequel::ShardedTimedQueueConnectionPool < Sequel::ConnectionPool
     @queues[pick_server(server)].num_waiting
   end
 
-  # The total number of connections in the pool. Using a non-existant server will return nil.
+  # The total number of connections in the pool. Using a non-existent server will return nil.
   def size(server=:default)
     sync{@sizes[server]}
   end

data/lib/sequel/connection_pool/threaded.rb

@@ -1,9 +1,11 @@
 # frozen-string-literal: true
 
+# SEQUEL6: Remove, deprecation: add warning if used on Ruby 3.2+
+
 # A connection pool allowing multi-threaded access to a pool of connections.
 # This is the default connection pool used by Sequel.
 class Sequel::ThreadedConnectionPool < Sequel::ConnectionPool
-  USE_WAITER = true # SEQUEL6: Remove
+  USE_WAITER = true
   Sequel::Deprecation.deprecate_constant(self, :USE_WAITER)
 
   # The maximum number of connections this pool will create (per shard/server
@@ -12,11 +14,11 @@ class Sequel::ThreadedConnectionPool < Sequel::ConnectionPool
   
   # An array of connections that are available for use by the pool.
   # The calling code should already have the mutex before calling this.
-  attr_reader :available_connections # SEQUEL6: Remove
+  attr_reader :available_connections
   
   # A hash with thread/fiber keys and connection values for currently allocated connections.
   # The calling code should already have the mutex before calling this.
-  attr_reader :allocated # SEQUEL6: Remove
+  attr_reader :allocated
 
   # The following additional options are respected:
   # :max_connections :: The maximum number of connections the connection pool
@@ -149,7 +151,7 @@ class Sequel::ThreadedConnectionPool < Sequel::ConnectionPool
 
     until conn = assign_connection(thread)
       elapsed = Sequel.elapsed_seconds_since(timer)
-      # :nocov:
+      # simplecov:disable
       raise_pool_timeout(elapsed) if elapsed > timeout
 
       # It's difficult to get to this point, it can only happen if there is a race condition
@@ -157,7 +159,7 @@ class Sequel::ThreadedConnectionPool < Sequel::ConnectionPool
       if conn = acquire_available(thread, timeout - elapsed)
         return conn
       end
-      # :nocov:
+      # simplecov:enable
     end
 
     conn
@@ -169,11 +171,11 @@ class Sequel::ThreadedConnectionPool < Sequel::ConnectionPool
       # Check if connection was checked in between when assign_connection failed and now.
       # This is very unlikely, but necessary to prevent a situation where the waiter
       # will wait for a connection even though one has already been checked in.
-      # :nocov:
+      # simplecov:disable
       if conn = next_available
         return(@allocated[thread] = conn)
       end
-      # :nocov:
+      # simplecov:enable
 
       @waiter.wait(@mutex, timeout)
 

data/lib/sequel/connection_pool/timed_queue.rb

@@ -1,8 +1,8 @@
 # frozen-string-literal: true
 
-# :nocov:
+# simplecov:disable
 raise LoadError, "Sequel::TimedQueueConnectionPool is only available on Ruby 3.2+" unless RUBY_VERSION >= '3.2'
-# :nocov:
+# simplecov:enable
 
 # A connection pool allowing multi-threaded access to a pool of connections,
 # using a timed queue (only available in Ruby 3.2+).

data/lib/sequel/connection_pool.rb

@@ -38,7 +38,7 @@ class Sequel::ConnectionPool
   POOL_CLASS_MAP.freeze
 
   # Class methods used to return an appropriate pool subclass, separated
-  # into a module for easier overridding by extensions.
+  # into a module for easier overriding by extensions.
   module ClassMethods
     # Return a pool subclass instance based on the given options.  If a <tt>:pool_class</tt>
     # option is provided is provided, use that pool class, otherwise
@@ -72,11 +72,11 @@ class Sequel::ConnectionPool
           opts[:servers] ? :sharded_single : :single
         elsif RUBY_VERSION >= '3.2'
           opts[:servers] ? :sharded_timed_queue : :timed_queue
-        # :nocov:
+        # simplecov:disable
         else
           opts[:servers] ? :sharded_threaded : :threaded
         end
-        # :nocov:
+        # simplecov:enable
 
         connection_pool_class(:pool_class=>pc)
       end

data/lib/sequel/core.rb

@@ -26,8 +26,8 @@
 # For a quicker introduction, see the {cheat sheet}[rdoc-ref:doc/cheat_sheet.rdoc].
 module Sequel
   @convert_two_digit_years = true
-  @datetime_class = Time
-  @split_symbols = false
+  @datetime_class = Time # SEQUEL6: Remove
+  @split_symbols = false # SEQUEL6: Remove
   @single_threaded = false
 
   # Mutex used to protect mutable data structures
@@ -36,7 +36,7 @@ module Sequel
   # Frozen hash used as the default options hash for most options.
   OPTS = {}.freeze
 
-  SPLIT_SYMBOL_CACHE = {}
+  SPLIT_SYMBOL_CACHE = {}  # SEQUEL6: Remove
 
   module SequelMethods
     # Sequel converts two digit years in <tt>Date</tt>s and <tt>DateTime</tt>s by default,
@@ -56,6 +56,8 @@ module Sequel
     # cases where they implement the same methods, they often implement them
     # differently (e.g. + using seconds on +Time+ and days on +DateTime+).
     attr_accessor :datetime_class
+    # SEQUEL6: Remove datetime_class=
+    # SEQUEL6.1: Remove datetime_class
 
     # Set whether Sequel is being used in single threaded mode. By default,
     # Sequel uses a thread-safe connection pool, which isn't as fast as the
@@ -66,8 +68,7 @@ module Sequel
     #   Sequel.single_threaded = true
     attr_accessor :single_threaded
 
-    # Alias of original require method, as Sequel.require does a relative
-    # require for backwards compatibility.
+    # # SEQUEL6: Remove
     alias orig_require require
     private :orig_require
 
@@ -155,7 +156,15 @@ module Sequel
     #   Sequel.extension(:blank)
     #   Sequel.extension(:core_extensions, :named_timezones)
     def extension(*extensions)
-      extensions.each{|e| orig_require("sequel/extensions/#{e}")}
+      extensions.each do |e|
+        e = e.to_s
+
+        if %r{..[/\\]} =~ e
+          raise Error, "cannot use extension with ../ for security reasons"
+        end
+
+        orig_require("sequel/extensions/#{e}")
+      end
     end
     
     # The exception classed raised if there is an error parsing JSON.
@@ -169,14 +178,14 @@ module Sequel
       def array_or_set_join(obj, arg)
         obj.join(arg)
       end
-    # :nocov:
+    # simplecov:disable
     else
       def array_or_set_join(obj, arg)
         obj = obj.to_a if obj.is_a?(Set)
         obj.join(arg)
       end
     end
-    # :nocov:
+    # simplecov:enable
 
     if RUBY_VERSION >= '3.3'
       # Create a new module using the block, and set the temporary name
@@ -185,13 +194,13 @@ module Sequel
         mod.set_temporary_name(yield)
         mod
       end
-    # :nocov:
+    # simplecov:disable
     else
       def set_temp_name(mod)
         mod
       end
     end
-    # :nocov:
+    # simplecov:enable
 
     # Convert given object to json and return the result.
     # This can be overridden to use an alternative json implementation.
@@ -202,7 +211,11 @@ module Sequel
     # Parse the string as JSON and return the result.
     # This can be overridden to use an alternative json implementation.
     def parse_json(json)
-      JSON.parse(json, :create_additions=>false)
+      if JSON::VERSION >= '3'
+        JSON.parse(json)
+      else
+        JSON.parse(json, :create_additions=>false)
+      end
     end
 
     # If a mutex is given, synchronize access using it.  If nil is given, just
@@ -231,18 +244,23 @@ module Sequel
 
     # For backwards compatibility only.  require_relative should be used instead.
     def require(files, subdir=nil)
+      # SEQUEL6: Remove
       # Use Kernel.require_relative to work around JRuby 9.0 bug
+      # simplecov:disable
       Array(files).each{|f| Kernel.require_relative "#{"#{subdir}/" if subdir}#{f}"}
+      # simplecov:enable
+      Sequel::Deprecation.deprecate("Sequel.require is deprecated and will be removed in Sequel 6.")
     end
 
     # Splits the symbol into three parts, if symbol splitting is enabled (not the default).
     # Each part will either be a string or nil. If symbol splitting
     # is disabled, returns an array with the first and third parts
-    # being nil, and the second part beind a string version of the symbol.
+    # being nil, and the second part behind a string version of the symbol.
     #
     # For columns, these parts are the table, column, and alias.
     # For tables, these parts are the schema, table, and alias.
     def split_symbol(sym)
+      # SEQUEL6.1: Remove
       unless v = Sequel.synchronize{SPLIT_SYMBOL_CACHE[sym]}
         if split_symbols?
           v = case s = sym.to_s
@@ -284,7 +302,7 @@ module Sequel
     #
     # Disabling symbol splitting will also disable the handling
     # of double underscores in virtual row methods, causing such methods to
-    # yield regular identifers instead of qualified identifiers:
+    # yield regular identifiers instead of qualified identifiers:
     #
     #   # Sequel.split_symbols = true
     #   Sequel.expr{table__column}  # table.column
@@ -294,12 +312,14 @@ module Sequel
     #   Sequel.expr{table__column}  # table__column
     #   Sequel.expr{table[:column]} # table.column
     def split_symbols=(v)
+      # SEQUEL6: Remove
       Sequel.synchronize{SPLIT_SYMBOL_CACHE.clear}
       @split_symbols = v
     end
 
     # Whether Sequel currently splits symbols into qualified/aliased identifiers.
     def split_symbols?
+      # SEQUEL6.1: Remove
       @split_symbols
     end
 
@@ -352,11 +372,11 @@ module Sequel
         Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
     else
-      # :nocov:
+      # simplecov:disable
       def start_timer # :nodoc:
         Time.now
       end
-      # :nocov:
+      # simplecov:enable
     end
 
     # The elapsed seconds since the given timer object was created.  The
@@ -451,15 +471,15 @@ module Sequel
   end
   extend SequelMethods
 
-    require_relative "deprecated"
-    require_relative "sql"
-    require_relative "connection_pool"
-    require_relative "exceptions"
-    require_relative "dataset"
-    require_relative "database"
-    require_relative "timezones"
-    require_relative "ast_transformer"
-    require_relative "version"
+  require_relative "deprecated"
+  require_relative "sql"
+  require_relative "connection_pool"
+  require_relative "exceptions"
+  require_relative "dataset"
+  require_relative "database"
+  require_relative "timezones"
+  require_relative "ast_transformer"
+  require_relative "version"
 
   class << self
     # Allow nicer syntax for creating Sequel expressions:

data/lib/sequel/database/connecting.rb

@@ -192,7 +192,7 @@ module Sequel
     
     # Disconnects all available connections from the connection pool.  Any
     # connections currently in use will not be disconnected. Options:
-    # :server :: Should be a symbol specifing the server to disconnect from,
+    # :server :: Should be a symbol specifying the server to disconnect from,
     #             or an array of symbols to specify multiple servers.
     #
     # Example:

data/lib/sequel/database/features.rb

@@ -5,7 +5,7 @@ module Sequel
     # ---------------------
     # :section: 9 - Methods that describe what the database supports
     # These methods all return booleans, with most describing whether or not the
-    # database supprots a given feature.
+    # database supports a given feature.
     # ---------------------
     
     # Whether the database uses a global namespace for the index, true by default.  If

data/lib/sequel/database/misc.rb

@@ -26,9 +26,9 @@ module Sequel
       :time=>Sequel::SQLTime, :boolean=>[TrueClass, FalseClass].freeze, :float=>Float, :decimal=>BigDecimal,
       :blob=>Sequel::SQL::Blob}.freeze
 
-    # :nocov:
+    # simplecov:disable
     URI_PARSER = defined?(::URI::RFC2396_PARSER) ? ::URI::RFC2396_PARSER : ::URI::DEFAULT_PARSER
-    # :nocov:
+    # simplecov:enable
     private_constant :URI_PARSER
 
     # Nested hook Proc; each new hook Proc just wraps the previous one.
@@ -98,7 +98,7 @@ module Sequel
     # The options hash for this database
     attr_reader :opts
     
-    # Set the timezone to use for this database, overridding <tt>Sequel.database_timezone</tt>.
+    # Set the timezone to use for this database, overriding <tt>Sequel.database_timezone</tt>.
     attr_writer :timezone
     
     # The specific default size of string columns for this Sequel::Database, usually 255 by default.
@@ -229,12 +229,7 @@ module Sequel
     end
 
     # Disallow dup/clone for Database instances
-    undef_method :dup, :clone, :initialize_copy
-    # :nocov:
-    if RUBY_VERSION >= '1.9.3'
-    # :nocov:
-      undef_method :initialize_clone, :initialize_dup
-    end
+    undef_method :dup, :clone, :initialize_copy, :initialize_clone, :initialize_dup
 
     # Cast the given type to a literal type
     #
@@ -580,7 +575,7 @@ module Sequel
       # Typecast a string to a BigDecimal
       alias _typecast_value_string_to_decimal BigDecimal
     else
-      # :nocov:
+      # simplecov:disable
       def _typecast_value_string_to_decimal(value)
         d = BigDecimal(value)
         if d.zero?
@@ -595,7 +590,7 @@ module Sequel
         end
         d
       end
-      # :nocov:
+      # simplecov:enable
     end
 
     # Typecast the value to a BigDecimal

data/lib/sequel/database/query.rb

@@ -415,9 +415,9 @@ module Sequel
 
     # Post process the schema values.  
     def schema_post_process(cols)
-      # :nocov:
+      # simplecov:disable
       if RUBY_VERSION >= '2.5'
-      # :nocov:
+      # simplecov:enable
         cols.each do |_, h|
           db_type = h[:db_type]
           if db_type.is_a?(String)

data/lib/sequel/database/schema_generator.rb

@@ -13,11 +13,13 @@ module Sequel
       def _merge_column_options(defaults, opts)
         defaults.merge!(opts) do |k, defv, v|
           unless defv == v
-            # :nocov:
+            # simplecov:disable
             if RUBY_VERSION >= "3.2"
-            # :nocov:
+            # simplecov:enable
               caller_loc = Thread.each_caller_location do |loc|
-                break loc unless loc.path == __FILE__
+                # Skip core library methods implemented in Ruby
+                path = loc.path
+                break loc unless path == __FILE__ || (path && path.start_with?('<internal:'))
               end
               caller_loc &&= "#{caller_loc.path}:#{caller_loc.lineno}: "
             end
@@ -150,7 +152,7 @@ module Sequel
       # :not_null :: Similar to setting <tt>null: false</tt>, but you can provide a hash value
       #              to specify options for the NOT NULL constraint on PostgreSQL 18+:
       #              :name :: The name of the NOT NULL constraint
-      #              :no_inherit :: Set NO INHERIT on the constraint, so it will not propogate to
+      #              :no_inherit :: Set NO INHERIT on the constraint, so it will not propagate to
       #                             child tables.
       # :null :: Mark the column as allowing NULL values (if true),
       #          or not allowing NULL values (if false).  The default is to allow NULL values.
@@ -225,7 +227,7 @@ module Sequel
       # :deferrable :: Whether the CHECK constraint should be marked DEFERRABLE.
       #
       # PostgreSQL specific options:
-      # :no_inherit :: Set NO INHERIT on the constraint, so it will not propogate to
+      # :no_inherit :: Set NO INHERIT on the constraint, so it will not propagate to
       #                child tables.
       # :not_enforced :: Whether the CHECK constraint should be marked NOT ENFORCED.
       # :not_valid :: Whether the CHECK constraint should be marked NOT VALID.

data/lib/sequel/database/schema_methods.rb

@@ -984,7 +984,7 @@ module Sequel
       on_delete_clause(action)
     end
     
-    # Add fragment for primary key specification, separated for easier overridding.
+    # Add fragment for primary key specification, separated for easier overriding.
     def primary_key_constraint_sql_fragment(_)
       'PRIMARY KEY'
     end
@@ -1144,7 +1144,7 @@ module Sequel
       "#{type}#{literal(Array(elements)) if elements}#{' UNSIGNED' if column[:unsigned]}"
     end
 
-    # Add fragment for unique specification, separated for easier overridding.
+    # Add fragment for unique specification, separated for easier overriding.
     def unique_constraint_sql_fragment(_)
       'UNIQUE'
     end

data/lib/sequel/database/transactions.rb

@@ -50,7 +50,7 @@ module Sequel
     # Options:
     # :savepoint :: If currently inside a savepoint, run this hook immediately when
     #               any enclosing savepoint is rolled back, which may be before the transaction
-    #               commits or rollsback.
+    #               commits or rolls back.
     # :server :: The server/shard to use.
     def after_rollback(opts=OPTS, &block)
       raise Error, "must provide block to after_rollback" unless block
@@ -69,7 +69,7 @@ module Sequel
     # When exiting the transaction block through methods other than an exception
     # (e.g. normal exit, non-local return, or throw), set the current transaction
     # to rollback instead of committing.  This is designed for use in cases where
-    # you want to preform a non-local return but also want to rollback instead of
+    # you want to perform a non-local return but also want to rollback instead of
     # committing.
     # Options:
     # :cancel :: Cancel the current rollback_on_exit setting, so exiting will commit instead
@@ -246,7 +246,7 @@ module Sequel
     # Internal generic transaction method.  Any exception raised by the given
     # block will cause the transaction to be rolled back.  If the exception is
     # not a Sequel::Rollback, the error will be reraised. If no exception occurs
-    # inside the block, the transaction is commited.
+    # inside the block, the transaction is committed.
     def _transaction(conn, opts=OPTS)
       rollback = opts[:rollback]
       begin
@@ -374,9 +374,7 @@ module Sequel
 
     # Whether to commit the current transaction. Thread.current.status is
     # checked because Thread#kill skips rescue blocks (so exception would be
-    # nil), but the transaction should still be rolled back. On Ruby 1.9 (but
-    # not 2.0+), the thread status will still be "run", so Thread#kill
-    # will erroneously commit the transaction, and there isn't a workaround.
+    # nil), but the transaction should still be rolled back.
     def commit_or_rollback_transaction(exception, conn, opts)
       if exception
         false
@@ -538,7 +536,7 @@ module Sequel
     end
 
     # Finish a subtransaction.  If savepoints are supported, pops the current
-    # tansaction off the savepoint stack.
+    # transaction off the savepoint stack.
     def transaction_finished?(conn)
       if supports_savepoints?
         stack = _trans(conn)[:savepoints]

data/lib/sequel/dataset/actions.rb

@@ -242,7 +242,7 @@ module Sequel
         end
       when 1
         arg = args[0]
-        if arg.is_a?(Integer)
+        if arg.is_a?(Integer) && arg >= 0
           res = if block
             if loader = cached_placeholder_literalizer(:_first_integer_cond_loader) do |pl|
                 where(pl.arg).limit(pl.arg)
@@ -1343,7 +1343,7 @@ module Sequel
       Sequel.|(*cond)
     end
 
-    # Downcase identifiers by default when outputing them from the database.
+    # Downcase identifiers by default when outputting them from the database.
     def output_identifier(v)
       v = 'untitled' if v == ''
       v.to_s.downcase.to_sym

data/lib/sequel/dataset/features.rb

@@ -25,7 +25,7 @@ module Sequel
       false
     end
 
-    # :nocov:
+    # simplecov:disable
 
     # Whether the dataset requires SQL standard datetimes. False by default,
     # as most allow strings with ISO 8601 format. Only for backwards compatibility,
@@ -34,7 +34,7 @@ module Sequel
       # SEQUEL6: Remove
       false
     end
-    # :nocov:
+    # simplecov:enable
 
     # Whether type specifiers are required for prepared statement/bound
     # variable argument placeholders (i.e. :bv__integer), false by default.
@@ -188,14 +188,14 @@ module Sequel
       true
     end
 
-    # :nocov:
+    # simplecov:disable
 
     # Whether the dataset supports timezones in literal timestamps, false by default.
     def supports_timestamp_timezones?
       # SEQUEL6: Remove
       false
     end
-    # :nocov:
+    # simplecov:enable
     
     # Whether the dataset supports fractional seconds in literal timestamps, true by default.
     def supports_timestamp_usecs?

data/lib/sequel/dataset/graph.rb

@@ -165,7 +165,7 @@ module Sequel
               # columns in the subselect, qualified by the subselect alias.
               Sequel.qualify(qualifier, Sequel.identifier(column))
             else
-              # Initial dataset not wrapped in subslect, just make
+              # Initial dataset not wrapped in subselect, just make
               # sure columns are qualified in some way.
               qualified_expression(sel, qualifier)
             end

data/lib/sequel/dataset/misc.rb

@@ -76,7 +76,7 @@ module Sequel
         super
       end
     else
-      # :nocov:
+      # simplecov:disable
       def freeze # :nodoc:
         self
       end
@@ -84,7 +84,7 @@ module Sequel
       def frozen?  # :nodoc:
         true
       end
-      # :nocov:
+      # simplecov:enable
     end
    
     # Alias of +first_source_alias+
@@ -259,7 +259,7 @@ module Sequel
     # underscore are reserved for internal use.
     attr_reader :cache
 
-    # Retreive a value from the dataset's cache in a thread safe manner.
+    # Retrieve a value from the dataset's cache in a thread safe manner.
     def cache_get(k)
       Sequel.synchronize{@cache[k]}
     end

data/lib/sequel/dataset/prepared_statements.rb

@@ -206,9 +206,9 @@ module Sequel
         when :insert_pk, :single_value
           with_sql_single_value(prepared_sql)
         when Array
-          # :nocov:
+          # simplecov:disable
           case type[0]
-          # :nocov:
+          # simplecov:enable
           when :map, :as_hash, :to_hash, :to_hash_groups
             force_prepared_sql.public_send(*type, &block) 
           end