sequel 5.107.0 → 5.108.0

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
 
@@ -169,14 +170,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 +186,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.
@@ -231,18 +232,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 +290,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 +300,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 +360,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 +459,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.
@@ -230,9 +230,9 @@ module Sequel
 
     # Disallow dup/clone for Database instances
     undef_method :dup, :clone, :initialize_copy
-    # :nocov:
+    # simplecov:disable
     if RUBY_VERSION >= '1.9.3'
-    # :nocov:
+    # simplecov:enable
       undef_method :initialize_clone, :initialize_dup
     end
 
@@ -580,7 +580,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 +595,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,9 +13,9 @@ 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|
                 # Skip core library methods implemented in Ruby
                 path = loc.path
@@ -152,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.
@@ -227,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
@@ -538,7 +538,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

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

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.
@@ -1372,7 +1380,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 +1446,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 +1567,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