sequel 4.45.0 → 4.46.0

data/lib/sequel/deprecated.rb

@@ -36,25 +36,34 @@ module Sequel
       attr_accessor :prefix
     end
 
-    # Print the message and possibly backtrace to the output.
-    def self.deprecate(method, instead=nil)
-      return unless output
-      message = instead ? "#{method} is deprecated and will be removed in Sequel 5.  #{instead}." : method
-      message = "#{prefix}#{message}" if prefix
-      output.puts(message)
-      case b = backtrace_filter
-      when Integer
-        caller.each do |c|
-          b -= 1
-          output.puts(c)
-          break if b <= 0
+    if RUBY_VERSION < '1.9'
+      # :nocov:
+      def self.deprecate(_method, _instead=nil)
+        # Sequel 5 will drop ruby 1.8 support completely, so it doesn't make sense to issue deprecation
+        # warnings on ruby 1.8.
+      end
+      # :nocov:
+    else
+      # Print the message and possibly backtrace to the output.
+      def self.deprecate(method, instead=nil)
+        return unless output
+        message = instead ? "#{method} is deprecated and will be removed in Sequel 5.  #{instead}." : method
+        message = "#{prefix}#{message}" if prefix
+        output.puts(message)
+        case b = backtrace_filter
+        when Integer
+          caller.each do |c|
+            b -= 1
+            output.puts(c)
+            break if b <= 0
+          end
+        when true
+          caller.each{|c| output.puts(c)}
+        when Proc
+          caller.each_with_index{|line, line_no| output.puts(line) if b.call(line, line_no)}
         end
-      when true
-        caller.each{|c| output.puts(c)}
-      when Proc
-        caller.each_with_index{|line, line_no| output.puts(line) if b.call(line, line_no)}
+        nil
       end
-      nil
     end
 
     # If using ruby 2.3+, use Module#deprecate_constant to deprecate the constant,

data/lib/sequel/extensions/_deprecated_identifier_mangling.rb

@@ -70,7 +70,7 @@ module Sequel
       
       def identifier_input_method=(v)
         Sequel::Deprecation.deprecate("Dataset#identifier_input_method=", "Explicitly load the identifier_mangling extension if you would like to use this")
-        raise_if_frozen!("identifier_input_method=")
+        raise_if_frozen!(%w"identifier_input_method= with_identifier_input_method")
         skip_symbol_cache!
         @opts[:identifier_input_method] = v
       end
@@ -81,7 +81,7 @@ module Sequel
     
       def identifier_output_method=(v)
         Sequel::Deprecation.deprecate("Dataset#identifier_output_method=", "Explicitly load the identifier_mangling extension if you would like to use this")
-        raise_if_frozen!("identifier_output_method=")
+        raise_if_frozen!(%w"identifier_output_method= with_identifier_output_method")
         @opts[:identifier_output_method] = v
       end
 

data/lib/sequel/extensions/auto_literal_strings.rb

@@ -0,0 +1,74 @@
+# frozen-string-literal: true
+#
+# The auto_literal_strings extension treats string values passed as filter
+# arguments as SQL query fragments.  This is the behavior of previous
+# versions of Sequel.  Using this extension makes using raw SQL fragments
+# easier, since you don't need to wrap them with Sequel.lit, but also makes
+# it easier to introduce SQL injection vulnerabilities into the application.
+# It is only recommended to use this extension for
+# backwards compatibility with previous versions of Sequel.
+#
+# With this extension, if a single string is given, it is used as an SQL
+# query fragment:
+#
+#   ds = DB[:table].extension(:auto_literal_strings)
+#   ds.where("name > 'A'")
+#   # SELECT * FROM table WHERE (name > 'A')
+#
+# If additional arguments are given, they are used as placeholders:
+#
+#   ds.where("name > ?", "A")
+#   # SELECT * FROM table WHERE (name > 'A')
+#
+# Named placeholders can also be used with a hash:
+#
+#   ds.where("name > :a", :a=>"A")
+#   # SELECT * FROM table WHERE (name > 'A')
+#
+# This extension also allows the use of a plain string passed to Dataset#update:
+#
+#   ds.update("column = column + 1")
+#   # UPDATE table SET column = column + 1
+#
+# Related module: Sequel::Dataset::AutoLiteralStrings
+
+#
+module Sequel
+  class Dataset
+    module AutoLiteralStrings
+      # Treat plain strings as literal strings, and arrays where the first element
+      # is a string as a literal string with placeholders.
+      def filter_expr(expr = nil)
+        case expr
+        when LiteralString
+          super
+        when String
+          super(LiteralString.new(expr))
+        when Array
+          if (sexpr = expr.first).is_a?(String)
+            super(SQL::PlaceholderLiteralString.new(sexpr, expr[1..-1], true))
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+
+      # Treat plain strings as literal strings.
+      def update_sql(values=OPTS)
+        case values
+        when LiteralString
+          super
+        when String
+          super(LiteralString.new(values))
+        else
+          super
+        end
+      end
+    end
+
+    register_extension(:auto_literal_strings, AutoLiteralStrings)
+  end
+end
+

data/lib/sequel/extensions/from_block.rb

@@ -29,6 +29,7 @@ module Sequel
         super
       end
     end
+    # SEQUEL5: Make this an empty module, since it will be the default behavior
   end
 
   Database.register_extension(:from_block, Database::FromBlock)

data/lib/sequel/extensions/graph_each.rb

@@ -56,7 +56,7 @@ module Sequel
       datasets = datasets.collect{|ta, ds| [ta, ds, ds.row_proc]}
       # Use the manually set graph aliases, if any, otherwise
       # use the ones automatically created by .graph
-      column_aliases = @opts[:graph_aliases] || @opts[:graph][:column_aliases]
+      column_aliases = @opts[:graph_aliases] || @opts[:graph][:column_aliases] # SEQUEL5: Remove :graph_aliases support
       fetch_rows(sql) do |r|
         graph = {}
         # Create the sub hashes, one per table

data/lib/sequel/extensions/identifier_mangling.rb

@@ -144,7 +144,7 @@ module Sequel
       
       # Set the method to call on identifiers going into the database for this dataset
       def identifier_input_method=(v)
-        raise_if_frozen!("identifier_input_method=")
+        raise_if_frozen!(%w"identifier_input_method= with_identifier_input_method")
         skip_symbol_cache!
         @opts[:identifier_input_method] = v
       end
@@ -157,7 +157,7 @@ module Sequel
     
       # Set the method to call on identifiers coming the database for this dataset
       def identifier_output_method=(v)
-        raise_if_frozen!("identifier_output_method=")
+        raise_if_frozen!(%w"identifier_output_method= with_identifier_output_method")
         @opts[:identifier_output_method] = v
       end
 

data/lib/sequel/extensions/migration.rb

@@ -448,9 +448,9 @@ module Sequel
       @directory = directory
       @allow_missing_migration_files = opts[:allow_missing_migration_files]
       @files = get_migration_files
-      schema, table = @db.send(:schema_and_table, opts[:table]  || self.class.const_get(:DEFAULT_SCHEMA_TABLE))
+      schema, table = @db.send(:schema_and_table, opts[:table] || default_schema_table)
       @table = schema ? Sequel::SQL::QualifiedIdentifier.new(schema, table) : table
-      @column = opts[:column] || self.class.const_get(:DEFAULT_SCHEMA_COLUMN)
+      @column = opts[:column] || default_schema_column
       @ds = schema_dataset
       @use_transactions = opts[:use_transactions]
     end
@@ -482,7 +482,7 @@ module Sequel
     def load_migration_file(file)
       n = Migration.descendants.length
       load(file)
-      raise Error, "Migration file not containing a single migration detected" unless n + 1 == Migration.descendants.length
+      raise Error, "Migration file #{file.inspect} not containing a single migration detected" unless n + 1 == Migration.descendants.length
     end
 
     # Remove all migration classes.  Done by the migrator to ensure that
@@ -507,6 +507,8 @@ module Sequel
   class IntegerMigrator < Migrator
     DEFAULT_SCHEMA_COLUMN = :version
     DEFAULT_SCHEMA_TABLE = :schema_info
+    Sequel::Deprecation.deprecate_constant(self, :DEFAULT_SCHEMA_COLUMN)
+    Sequel::Deprecation.deprecate_constant(self, :DEFAULT_SCHEMA_TABLE)
 
     Error = Migrator::Error
 
@@ -574,6 +576,16 @@ module Sequel
       ds.get(column) || 0
     end
 
+    # The default column storing schema version.
+    def default_schema_column
+      :version
+    end
+
+    # The default table storing schema version.
+    def default_schema_table
+      :schema_info
+    end
+
     # Returns any found migration files in the supplied directory.
     def get_migration_files
       files = []
@@ -656,6 +668,8 @@ module Sequel
   class TimestampMigrator < Migrator
     DEFAULT_SCHEMA_COLUMN = :filename
     DEFAULT_SCHEMA_TABLE = :schema_migrations
+    Sequel::Deprecation.deprecate_constant(self, :DEFAULT_SCHEMA_COLUMN)
+    Sequel::Deprecation.deprecate_constant(self, :DEFAULT_SCHEMA_TABLE)
     
     Error = Migrator::Error
 
@@ -699,7 +713,7 @@ module Sequel
     # Convert the schema_info table to the new schema_migrations table format,
     # using the version of the schema_info table and the current migration files.
     def convert_from_schema_info
-      v = db[IntegerMigrator::DEFAULT_SCHEMA_TABLE].get(IntegerMigrator::DEFAULT_SCHEMA_COLUMN)
+      v = db[:schema_info].get(:version)
       ds = db.from(table)
       files.each do |path|
         f = File.basename(path)
@@ -709,6 +723,16 @@ module Sequel
       end
     end
 
+    # The default column storing migration filenames.
+    def default_schema_column
+      :filename
+    end
+
+    # The default table storing migration filenames.
+    def default_schema_table
+      :schema_migrations
+    end
+
     # Returns filenames of all applied migrations
     def get_applied_migrations
       am = ds.select_order_map(column)

data/lib/sequel/extensions/no_auto_literal_strings.rb

@@ -82,3 +82,5 @@ module Sequel
     register_extension(:no_auto_literal_strings, NoAutoLiteralStrings)
   end
 end
+
+# SEQUEL5: Make extension empty

data/lib/sequel/extensions/schema_dumper.rb

@@ -163,7 +163,7 @@ END_MIG
       end
     end
 
-    # Recreate the column in the passed Schema::Generator from the given name and parsed database schema.
+    # Recreate the column in the passed Schema::CreateTableGenerator from the given name and parsed database schema.
     def recreate_column(name, schema, gen, options)
       if options[:single_pk] && schema_autoincrementing_primary_key?(schema)
         type_hash = options[:same_db] ? {:type=>schema[:db_type]} : column_schema_to_ruby_type(schema)
@@ -242,7 +242,7 @@ END_MIG
       end
     end
 
-    # Return a Schema::Generator object that will recreate the
+    # Return a Schema::CreateTableGenerator object that will recreate the
     # table's schema.  Takes the same options as dump_schema_migration.
     def dump_table_generator(table, options=OPTS)
       s = schema(table, options).dup
@@ -304,7 +304,7 @@ END_MIG
       gen.dump_indexes(meth=>table, :ignore_errors=>!options[:same_db])
     end
 
-    # Convert the parsed index information into options to the Generators index method. 
+    # Convert the parsed index information into options to the CreateTableGenerator's index method. 
     def index_to_generator_opts(table, name, index_opts, options=OPTS)
       h = {}
       if options[:index_names] != false && default_index_name(table, index_opts[:columns]) != name.to_s
@@ -380,7 +380,7 @@ END_MIG
   end
 
   module Schema
-    class Generator
+    class CreateTableGenerator
       # Dump this generator's columns to a string that could be evaled inside
       # another instance to represent the same columns
       def dump_columns

data/lib/sequel/extensions/sequel_3_dataset_methods.rb

@@ -26,7 +26,9 @@
 #
 module Sequel
   module Sequel3DatasetMethods
-    COMMA = Dataset::COMMA
+    COMMA = ', '
+    Sequel::Deprecation.deprecate_constant(self, :COMMA)
+
     # Change the database for this dataset.
     def db=(v)
       raise_if_frozen!("db=")
@@ -119,8 +121,8 @@ module Sequel
       n = naked
       cols = n.columns
       csv = String.new
-      csv << "#{cols.join(COMMA)}\r\n" if include_column_titles
-      n.each{|r| csv << "#{cols.collect{|c| r[c]}.join(COMMA)}\r\n"}
+      csv << "#{cols.join(', ')}\r\n" if include_column_titles
+      n.each{|r| csv << "#{cols.collect{|c| r[c]}.join(', ')}\r\n"}
       csv
     end
   end

data/lib/sequel/extensions/set_overrides.rb

@@ -18,6 +18,8 @@
 #
 # Related module: Sequel::SetOverrides
 
+Sequel::Deprecation.deprecate("The set_overrides extension", "Please consider maintaining it yourself as an external sequel extension if you want to continue using it")
+
 #
 module Sequel
   module SetOverrides

data/lib/sequel/extensions/split_array_nil.rb

@@ -46,9 +46,9 @@ module Sequel
       def complex_expression_sql_append(sql, op, args)
       case op
       when :IN, :"NOT IN"
-        vals = args.at(1)
+        vals = args[1]
         if vals.is_a?(Array) && vals.any?(&:nil?)
-          cols = args.at(0)
+          cols = args[0]
           vals = vals.compact
           c = Sequel::SQL::BooleanExpression
           if op == :IN

data/lib/sequel/extensions/virtual_row_method_block.rb

@@ -0,0 +1,44 @@
+# frozen-string-literal: true
+#
+# These modifies virtual row blocks so that you can pass a block
+# when calling a method to change the behavior.  It only exists
+# for backwards compatibility with previous Sequel versions, and
+# is not recommended for new applications.
+# 
+# To load the extension:
+#
+#   Sequel.extension :virtual_row_method_block
+
+#
+module Sequel
+  module SQL
+    class VirtualRow < BasicObject
+      include(Module.new do
+        # Handle blocks passed to methods and change the behavior.
+        def method_missing(m, *args, &block)
+          if block
+            if args.empty?
+              Function.new(m)
+            else
+              case args.shift
+              when :*
+                Function.new(m, *args).*
+              when :distinct
+                Function.new(m, *args).distinct
+              when :over
+                opts = args.shift || OPTS
+                f = Function.new(m, *::Kernel.Array(opts[:args]))
+                f = f.* if opts[:*]
+                f.over(opts)
+              else
+                Kernel.raise(Error, 'unsupported VirtualRow method argument used with block')
+              end
+            end
+          else
+            super
+          end
+        end
+      end)
+    end
+  end
+end

data/lib/sequel/model.rb

@@ -33,11 +33,13 @@ module Sequel
 
     # Class methods added to model that call the method of the same name on the dataset
     DATASET_METHODS = (Dataset::ACTION_METHODS + Dataset::QUERY_METHODS + [:each_server, :where_all, :where_each, :where_single_value]) -
-      [:and, :or, :[], :columns, :columns!, :delete, :update, :add_graph_aliases, :first, :first!]
+      [:and, :or, :[], :columns, :columns!, :delete, :update, :add_graph_aliases] # SEQUEL5: Remove set_graph_aliases
     
     # Boolean settings that can be modified at the global, class, or instance level.
     BOOLEAN_SETTINGS = [:typecast_empty_string_to_nil, :typecast_on_assignment, :strict_param_setting, \
-      :raise_on_save_failure, :raise_on_typecast_failure, :require_modification, :use_after_commit_rollback, :use_transactions]
+      :raise_on_save_failure, :raise_on_typecast_failure, :require_modification, :use_transactions,
+      :use_after_commit_rollback # SEQUEL5: Remove
+      ]
 
     # Hooks that are called before an action.  Can return false to not do the action.  When
     # overriding these, it is recommended to call +super+ as the last line of your method,
@@ -64,14 +66,16 @@ module Sequel
     # Class instance variables that are inherited in subclasses.  If the value is <tt>:dup</tt>, dup is called
     # on the superclass's instance variable when creating the instance variable in the subclass.
     # If the value is +nil+, the superclass's instance variable is used directly in the subclass.
-    INHERITED_INSTANCE_VARIABLES = {:@allowed_columns=>:dup,
+    INHERITED_INSTANCE_VARIABLES = {
+      :@allowed_columns=>:dup, # SEQUEL5: Remove
       :@dataset_method_modules=>:dup, :@primary_key=>nil, :@use_transactions=>nil,
       :@raise_on_save_failure=>nil, :@require_modification=>nil, :@restrict_primary_key=>nil,
       :@simple_pk=>nil, :@simple_table=>nil, :@strict_param_setting=>nil,
       :@typecast_empty_string_to_nil=>nil, :@typecast_on_assignment=>nil,
       :@raise_on_typecast_failure=>nil, :@plugins=>:dup, :@setter_methods=>nil,
       :@use_after_commit_rollback=>nil, :@fast_pk_lookup_sql=>nil,
-      :@fast_instance_delete_sql=>nil, :@finders=>:dup, :@finder_loaders=>:dup,
+      :@fast_instance_delete_sql=>nil,
+      :@finders=>:dup, :@finder_loaders=>:dup, # SEQUEL5: Remove
       :@db=>nil, :@default_set_fields_options=>:dup, :@require_valid_table=>nil,
       :@cache_anonymous_models=>nil, :@dataset_module_class=>nil}
 
@@ -84,7 +88,7 @@ module Sequel
     # (i.e. it ends with =).
     SETTER_METHOD_REGEXP = /=\z/
 
-    @allowed_columns = nil
+    @allowed_columns = nil # SEQUEL5: Remove
     @cache_anonymous_models = true
     @db = nil
     @db_schema = nil
@@ -92,8 +96,8 @@ module Sequel
     @dataset_method_modules = []
     @default_eager_limit_strategy = true
     @default_set_fields_options = {}
-    @finders = {}
-    @finder_loaders = {}
+    @finders = {} # SEQUEL5: Remove
+    @finder_loaders = {} # SEQUEL5: Remove
     @overridable_methods_module = nil
     @fast_pk_lookup_sql = nil
     @fast_instance_delete_sql = nil