sequel 4.49.0 → 5.3.0

data/lib/sequel/extensions/freeze_datasets.rb

@@ -1,71 +1,3 @@
 # frozen-string-literal: true
-#
-# The freeze_datasets extension freezes a databases's datasets by
-# default, and makes it so the databases's datasets are always
-# frozen.  This makes sure you can never accidentally modify a
-# dataset that may be used elsewhere (such as a model class's
-# dataset or the same dataset being used in another thread).
-# Frozen datasets can also perform caching for many
-# different methods that can significantly improve performance.
-#
-# In addition to the caching provided by frozen datasets, this
-# also adds caching of Database#from calls if the method is
-# called with a single Symbol argument and not a block.  In
-# addition to speeding up Dataset#from itself, because it
-# returns a cached dataset, all caching done by that dataset
-# can also improve performance.
-#
-# Usage:
-#
-#   DB.extension(:freeze_datasets)
-#
-# Related module: Sequel::FreezeDatasets
 
-#
-module Sequel
-  class Database
-    module FreezeDatasets
-      module DatasetMethods
-        # Make dup be an alias to clone, so that it
-        # returns a frozen dataset.
-        def dup
-          clone
-        end
-      end
-
-      # Reset the default dataset for this database after
-      # loading the extension.
-      def self.extended(db)
-        db.extend_datasets(DatasetMethods)
-      end
-
-      # Cache returned dataset if given a single argument and no block.
-      def from(*args, &block)
-        if !block && args.length == 1 && (table = args[0]).is_a?(Symbol)
-           @default_dataset.send(:cached_dataset, :"_from_#{table}_ds"){super}
-        else
-          super
-        end
-      end
-
-      # Freeze datasets created from this dataset.
-      def dataset
-        super.freeze
-      end
-
-      private
-
-      # Clear the cache of the default dataset when removing a cached
-      # schema, in order to clear the from table cache.
-      def remove_cached_schema(table)
-        cache = @default_dataset.send(:cache)
-        Sequel.synchronize{cache.clear}
-        super
-      end
-    end
-
-    register_extension(:freeze_datasets, FreezeDatasets)
-  end
-end
-
-# Sequel::Database.register_extension(:freeze_datasets){} # SEQUEL5
+Sequel::Database.register_extension(:freeze_datasets){}

data/lib/sequel/extensions/from_block.rb

@@ -1,37 +1,3 @@
 # frozen-string-literal: true
-#
-# The from_block extension changes Database#from so that blocks given
-# to it are treated as virtual rows applying to the FROM clause,
-# instead of virtual rows applying to the WHERE clause.  This will
-# probably be made the default in the next major version of Sequel.
-#
-# This makes it easier to use table returning functions:
-#
-#   DB.from{table_function(1)}
-#   # SELECT * FROM table_function(1)
-#
-# To load the extension into the database:
-#
-#   DB.extension :from_block
-#
-# Related module: Sequel::Database::FromBlock
 
-#
-module Sequel
-  module Database::FromBlock
-    # If a block is given, make it affect the FROM clause:
-    #   DB.from{table_function(1)}
-    #   # SELECT * FROM table_function(1)
-    def from(*args, &block)
-      if block
-        @default_dataset.from(*args, &block)
-      else
-        super
-      end
-    end
-  end
-
-  Database.register_extension(:from_block, Database::FromBlock)
-end
-
-# Sequel::Database.register_extension(:from_block){} # SEQUEL5
+Sequel::Database.register_extension(:from_block){}

data/lib/sequel/extensions/graph_each.rb

@@ -4,7 +4,7 @@
 # makes Dataset#each call #graph_each if the dataset has been graphed.
 # Dataset#graph_each splits result hashes into subhashes per table:
 #
-#   DB[:a].graph(:b, :id=>:b_id).all
+#   DB[:a].graph(:b, id: :b_id).all
 #   # => {:a=>{:id=>1, :b_id=>2}, :b=>{:id=>2}}
 #
 # You can load this extension into specific datasets:
@@ -56,7 +56,7 @@ module Sequel
       datasets = datasets.map{|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] # SEQUEL5: Remove :graph_aliases support
+      column_aliases = @opts[:graph][:column_aliases]
       fetch_rows(sql) do |r|
         graph = {}
         # Create the sub hashes, one per table

data/lib/sequel/extensions/identifier_mangling.rb

@@ -120,10 +120,9 @@ module Sequel
       # Reset the identifier mangling options.  Overrides any already set on
       # the instance.  Only for internal use by shared adapters.
       def reset_identifier_mangling
-        # SEQUEL5: Stop checking Database.*
-        @quote_identifiers = @opts.fetch(:quote_identifiers){(qi = Database.quote_identifiers).nil? ? quote_identifiers_default : qi}
-        @identifier_input_method = @opts.fetch(:identifier_input_method){(iim = Database.identifier_input_method).nil? ? identifier_input_method_default : (iim if iim)}
-        @identifier_output_method = @opts.fetch(:identifier_output_method){(iom = Database.identifier_output_method).nil? ? identifier_output_method_default : (iom if iom)}
+        @quote_identifiers = @opts.fetch(:quote_identifiers, quote_identifiers_default)
+        @identifier_input_method = @opts.fetch(:identifier_input_method, identifier_input_method_default)
+        @identifier_output_method = @opts.fetch(:identifier_output_method, identifier_output_method_default)
         reset_default_dataset
       end
     end
@@ -135,25 +134,12 @@ module Sequel
         @opts.fetch(:identifier_input_method, db.identifier_input_method)
       end
       
-      # Set the method to call on identifiers going into the database for this dataset
-      def identifier_input_method=(v)
-        raise_if_frozen!(%w"identifier_input_method= with_identifier_input_method")
-        skip_symbol_cache!
-        @opts[:identifier_input_method] = v
-      end
-      
       # The String instance method to call on identifiers before sending them to
       # the database.
       def identifier_output_method
         @opts.fetch(:identifier_output_method, db.identifier_output_method)
       end
     
-      # Set the method to call on identifiers coming the database for this dataset
-      def identifier_output_method=(v)
-        raise_if_frozen!(%w"identifier_output_method= with_identifier_output_method")
-        @opts[:identifier_output_method] = v
-      end
-
       # Check with the database to see if identifier quoting is enabled
       def quote_identifiers?
         @opts.fetch(:quote_identifiers, db.quote_identifiers?)
@@ -174,14 +160,18 @@ module Sequel
       # Convert the identifier to the version used in the database via
       # identifier_input_method.
       def input_identifier(v)
-        (i = identifier_input_method) ? v.to_s.send(i) : v.to_s
+        (i = identifier_input_method) ? v.to_s.public_send(i) : v.to_s
       end
 
       # Modify the identifier returned from the database based on the
       # identifier_output_method.
       def output_identifier(v)
         v = 'untitled' if v == ''
-        (i = identifier_output_method) ? v.to_s.send(i).to_sym : v.to_sym
+        (i = identifier_output_method) ? v.to_s.public_send(i).to_sym : v.to_sym
+      end
+
+      def non_sql_option?(key)
+        super || key == :identifier_input_method || key == :identifier_output_method
       end
     end
   end

data/lib/sequel/extensions/implicit_subquery.rb

@@ -27,7 +27,7 @@
 module Sequel
   class Dataset
     module ImplicitSubquery
-      exceptions = [:and, :add_graph_aliases, :filter, :from, :from_self, :naked, :or, :order_more,
+      exceptions = [:add_graph_aliases, :filter, :from, :from_self, :naked, :or, :order_more,
                     :qualify, :reverse, :reverse_order, :select_all, :select_more, :server,
                     :set_graph_aliases, :unfiltered, :ungraphed, :ungrouped, :unlimited, :unordered,
                     :with_sql]
@@ -35,7 +35,7 @@ module Sequel
       (Dataset::QUERY_METHODS - Dataset::JOIN_METHODS - exceptions + additions).each do |meth|
         define_method(meth) do |*a, &b|
           if opts[:sql]
-            from_self.send(meth, *a, &b)
+            from_self.public_send(meth, *a, &b)
           else
             super(*a, &b)
           end

data/lib/sequel/extensions/inflector.rb

@@ -95,8 +95,8 @@ class String
       (@uncountables << words).flatten!
     end
 
-    Sequel.require('default_inflections', 'model')
-    instance_eval(&Sequel::DEFAULT_INFLECTIONS_PROC)
+    require_relative '../model/default_inflections'
+    instance_exec(&Sequel::DEFAULT_INFLECTIONS_PROC)
   end
 
   # Yield the Inflections module if a block is given, and return
@@ -151,7 +151,7 @@ class String
   # Example
   #   "puni_puni".dasherize #=> "puni-puni"
   def dasherize
-    gsub(/_/, '-')
+    gsub('_', '-')
   end
 
   # Removes the module part from the expression in the string
@@ -181,7 +181,7 @@ class String
   #   "employee_salary" #=> "Employee salary"
   #   "author_id" #=> "Author"
   def humanize
-    gsub(/_id$/, "").gsub(/_/, " ").capitalize
+    gsub(/_id$/, "").gsub('_', " ").capitalize
   end
 
   # Returns the plural form of the word in the string.

data/lib/sequel/extensions/migration.rb

@@ -41,7 +41,7 @@ module Sequel
     # direction.
     def self.apply(db, direction)
       raise(ArgumentError, "Invalid migration direction specified (#{direction.inspect})") unless [:up, :down].include?(direction)
-      new(db).send(direction)
+      new(db).public_send(direction)
     end
 
     # Returns the list of Migration descendants.
@@ -65,6 +65,7 @@ module Sequel
     
     # Intercepts method calls intended for the database and sends them along.
     def method_missing(method_sym, *args, &block)
+      # Allow calling private methods for backwards compatibility
       @db.send(method_sym, *args, &block)
     end
 
@@ -99,29 +100,29 @@ module Sequel
     end
 
     # Apply the appropriate block on the +Database+
-    # instance using instance_eval.
+    # instance using instance_exec.
     def apply(db, direction)
       raise(ArgumentError, "Invalid migration direction specified (#{direction.inspect})") unless [:up, :down].include?(direction)
-      if prok = send(direction)
-        db.instance_eval(&prok)
+      if prok = public_send(direction)
+        db.instance_exec(&prok)
       end
     end
   end
 
   # Internal class used by the Sequel.migration DSL, part of the +migration+ extension.
   class MigrationDSL < BasicObject
-    # The underlying Migration instance
+    # The underlying SimpleMigration instance
     attr_reader :migration
 
     def self.create(&block)
       new(&block).migration
     end
 
-    # Create a new migration class, and instance_eval the block.
+    # Create a new migration class, and instance_exec the block.
     def initialize(&block)
       @migration = SimpleMigration.new
       Migration.descendants << migration
-      instance_eval(&block)
+      instance_exec(&block)
     end
 
     # Defines the migration's down action.
@@ -150,7 +151,7 @@ module Sequel
     # the block.
     #
     # There are no guarantees that this will work perfectly
-    # in all cases, but it should work for most common cases.
+    # in all cases, but it works for some simple cases.
     def change(&block)
       migration.up = block
       migration.down = MigrationReverser.new.reverse(&block)
@@ -170,7 +171,7 @@ module Sequel
     # the given block.
     def reverse(&block)
       begin
-        instance_eval(&block)
+        instance_exec(&block)
       rescue
         just_raise = true
       end
@@ -180,12 +181,9 @@ module Sequel
         actions = @actions.reverse
         Proc.new do
           actions.each do |a|
-            if a.last.is_a?(Proc)
-              pr = a.pop
-              send(*a, &pr)
-            else
-              send(*a)
-            end
+            pr = a.last.is_a?(Proc) ? a.pop : nil
+            # Allow calling private methods as the reversing methods are private
+            send(*a, &pr)
           end
         end
       end
@@ -233,8 +231,9 @@ module Sequel
     end
 
     def reverse(&block)
-      instance_eval(&block)
+      instance_exec(&block)
       actions = @actions.reverse
+      # Allow calling private methods as the reversing methods are private
       Proc.new{actions.each{|a| send(*a)}}
     end
 
@@ -339,25 +338,20 @@ module Sequel
   #
   # For example, to migrate the database all the way down:
   #
-  #   Sequel::Migrator.run(DB, '.', :target=>0)
+  #   Sequel::Migrator.run(DB, '.', target: 0)
   #
   # For example, to migrate the database to version 4:
   #
-  #   Sequel::Migrator.run(DB, '.', :target=>4)
+  #   Sequel::Migrator.run(DB, '.', target: 4)
   #
   # To migrate the database from version 1 to version 5:
   #
-  #   Sequel::Migrator.run(DB, '.', :target=>5, :current=>1)
+  #   Sequel::Migrator.run(DB, '.', target: 5, current: 1)
   #
   # Part of the +migration+ extension.
   class Migrator
     MIGRATION_FILE_PATTERN = /\A(\d+)_.+\.rb\z/i.freeze
 
-    MIGRATION_SPLITTER = '_'.freeze
-    Sequel::Deprecation.deprecate_constant(self, :MIGRATION_SPLITTER)
-    MINIMUM_TIMESTAMP = 20000101
-    Sequel::Deprecation.deprecate_constant(self, :MINIMUM_TIMESTAMP)
-
     # Exception class raised when there is an error with the migrator's
     # file structure, database, or arguments.
     class Error < Sequel::Error
@@ -397,16 +391,15 @@ module Sequel
     #
     # Examples: 
     #   Sequel::Migrator.run(DB, "migrations")
-    #   Sequel::Migrator.run(DB, "migrations", :target=>15, :current=>10)
-    #   Sequel::Migrator.run(DB, "app1/migrations", :column=> :app2_version)
-    #   Sequel::Migrator.run(DB, "app2/migrations", :column => :app2_version, :table=>:schema_info2)
+    #   Sequel::Migrator.run(DB, "migrations", target: 15, current: 10)
+    #   Sequel::Migrator.run(DB, "app1/migrations", column: :app2_version)
+    #   Sequel::Migrator.run(DB, "app2/migrations", column: :app2_version, table: :schema_info2)
     def self.run(db, directory, opts=OPTS)
       migrator_class(directory).new(db, directory, opts).run
     end
 
     # Choose the Migrator subclass to use.  Uses the TimestampMigrator
-    # if the version number appears to be a unix time integer for a year
-    # after 2005, otherwise uses the IntegerMigrator.
+    # if the version number is greater than 20000101, otherwise uses the IntegerMigrator.
     def self.migrator_class(directory)
       if self.equal?(Migrator)
         Dir.new(directory).each do |file|
@@ -508,11 +501,6 @@ module Sequel
   # version number starting with 1, where missing or duplicate migration file
   # versions are not allowed.  Part of the +migration+ extension.
   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
 
     # The current version for this migrator
@@ -528,6 +516,8 @@ module Sequel
     def initialize(db, directory, opts=OPTS)
       super
       @current = opts[:current] || current_migration_version
+      raise(Error, "No current version available") unless current
+
       latest_version = latest_migration_version
 
       @target = if opts[:target]
@@ -538,15 +528,14 @@ module Sequel
         latest_version
       end
 
+      raise(Error, "No target version available, probably because no migration files found or filenames don't follow the migration filename convention") unless target
+
       if @target > latest_version
         @target = latest_version
       elsif @target < 0
         @target = 0
       end
 
-      raise(Error, "No current version available") unless current
-      raise(Error, "No target version available, probably because no migration files found or filenames don't follow the migration filename convention") unless target
-
       @direction = current < target ? :up : :down
       @migrations = get_migrations
     end
@@ -663,17 +652,12 @@ module Sequel
     end
   end
 
-  # The migrator used if any migration file version appears to be a timestamp.
+  # The migrator used if any migration file version is greater than 20000101.
   # Stores filenames of migration files, and can figure out which migrations
   # have not been applied and apply them, even if earlier migrations are added
   # after later migrations.  If you plan to do that, the responsibility is on
   # you to make sure the migrations don't conflict. Part of the +migration+ extension.
   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
 
     # Array of strings of applied migration filenames

data/lib/sequel/extensions/no_auto_literal_strings.rb

@@ -1,86 +1,4 @@
 # frozen-string-literal: true
-#
-# The no_auto_literal_strings extension removes Sequel's automatic conversion
-# of strings to literal strings in the dataset filter methods.  By default,
-# Sequel considers a string passed to a filter method as a literal string:
-#
-#   DB[:table].where("name > 'A'")
-#
-# This is fine, except when the string is derived from user input:
-#
-#   DB[:table].where("name > '#{params[:user]}'") # SQL Injection!
-#
-# Sequel does support using placeholders for such strings:
-#
-#   DB[:table].where("name > ?", params[:user].to_s) # Safe
-#
-# However, if you forget to user placeholders, and pass a string to a filter
-# method that is derived from user input, you open yourself up to SQL injection.
-# With this extension, using a plain string in a filter method will result
-# in an exception being raised.  You either need to explicitly use a literal
-# string:
-#
-#   DB[:table].where(Sequel.lit("name > ?", params[:user].to_s))
-#
-# or you need to construct the same SQL using a non-string based approach:
-#
-#   DB[:table].where{|o| o.name > params[:user].to_s}
-#
-# Note that as listed in Sequel's security guide, a large number of dataset
-# methods call down to a filtering method, and this protects all of those
-# cases.
-#
-# This extension also protects the use of a plain string passed to Dataset#update:
-#
-#   DB[:table].update("column = column + 1")
-#
-# Again, you either need to explicitly use a literal string:
-#
-#   DB[:table].update(Sequel.lit("column = column + 1"))
-#
-# or construct the same SQL using a non-string based approach:
-#
-#   DB[:table].update(:column => Sequel[:column] + 1)
-#
-# Related module: Sequel::Dataset::NoAutoLiteralStrings
 
-#
-module Sequel
-  class Dataset
-    module NoAutoLiteralStrings
-      # Raise an error if passing a plain string or an array whose first
-      # entry is a plain string.
-      def filter_expr(expr = nil)
-        case expr
-        when LiteralString
-          super
-        when String
-          raise Error, "plain string passed to a dataset filtering method"
-        when Array
-          if expr.first.is_a?(String) && !expr.first.is_a?(LiteralString)
-            raise Error, "plain string passed to a dataset filtering method"
-          end
-          super
-        else
-          super
-        end
-      end
-
-      # Raise an error if passing a plain string.
-      def update_sql(values=OPTS)
-        case values
-        when LiteralString
-          super
-        when String
-          raise Error, "plain string passed to a dataset filtering method"
-        else
-          super
-        end
-      end
-    end
-
-    register_extension(:no_auto_literal_strings, NoAutoLiteralStrings)
-  end
-end
-
-# Sequel::Dataset.register_extension(:no_auto_literal_strings){} # SEQUEL5
+Sequel::Database.register_extension(:no_auto_literal_strings){}
+Sequel::Dataset.register_extension(:no_auto_literal_strings){}

data/lib/sequel/extensions/null_dataset.rb

@@ -13,7 +13,7 @@
 #
 # Usage:
 #
-#   ds = DB[:items].nullify.where(:a=>:b).select(:c)
+#   ds = DB[:items].nullify.where(a: :b).select(:c)
 #   ds.sql # => "SELECT c FROM items WHERE (a = b)"
 #   ds.all # => [] # no query sent to the database
 #
@@ -41,13 +41,7 @@ module Sequel
     module Nullifiable
       # Return a cloned nullified dataset.
       def nullify
-        clone.with_extend(NullDataset)
-      end
-
-      # Nullify the current dataset
-      def nullify!
-        Sequel::Deprecation.deprecate("Dataset#nullify! from the null_dataset extension", "Use Dataset#nullify, which returned a modified copy")
-        extend NullDataset
+        with_extend(NullDataset)
       end
     end
 

data/lib/sequel/extensions/pagination.rb

@@ -64,10 +64,8 @@ module Sequel
 
   class Dataset
     # Holds methods that only relate to paginated datasets. Paginated dataset
-    # have pages starting at 1 (page 1 is offset 0, page 1 is offset page_size).
+    # have pages starting at 1 (page 1 is offset 0, page 2 is offset 1 * page_size).
     module Pagination
-      Sequel::Dataset.def_deprecated_opts_setter(self, :page_size, :page_count, :current_page, :pagination_record_count)
-
       # The number of records per page (the final page may have fewer than
       # this number of records).
       def page_size
@@ -135,20 +133,6 @@ module Sequel
       def prev_page
         current_page > 1 ? (current_page - 1) : nil
       end
-
-      # SEQUEL5: Remove
-      # :nocov:
-      def set_pagination_info(page_no, page_size, record_count)
-        Sequel::Deprecation.deprecate("Dataset#set_pagination_info", "It should no longer be necessary to call this method")
-        self.current_page = page_no
-        self.page_size = page_size
-        self.pagination_record_count = record_count
-        page_count = (record_count / page_size.to_f).ceil
-        page_count = 1 if page_count == 0
-        self.page_count = page_count
-        self
-      end
-      # :nocov:
     end
   end