sequel 3.47.0 → 3.48.0

data/lib/sequel/core.rb

@@ -28,15 +28,10 @@ module Sequel
   @convert_two_digit_years = true
   @datetime_class = Time
   @empty_array_handle_nulls = true
-  @virtual_row_instance_eval = true
-  @require_thread = nil
-  
-  # Mutex used to protect file loading/requireing
-  @require_mutex = Mutex.new
-  
+
   # Whether Sequel is being run in single threaded mode
   @single_threaded = false
-  
+
   class << self
     # Sequel converts two digit years in <tt>Date</tt>s and <tt>DateTime</tt>s by default,
     # so 01/02/03 is interpreted at January 2nd, 2003, and 12/13/99 is interpreted
@@ -79,29 +74,30 @@ module Sequel
     # 
     # This may not handle NULLs correctly, but can be much faster on
     # some databases.
-    attr_accessor :empty_array_handle_nulls
+    attr_reader :empty_array_handle_nulls
+
+    def empty_array_handle_nulls=(v)
+      Sequel::Deprecation.deprecate('Sequel.empty_array_handle_nulls=', 'Please switch to loading the empty_array_ignore_nulls plugin if you wish empty array handling to ignore nulls')
+      @empty_array_handle_nulls = v
+    end
 
-    # For backwards compatibility, has no effect.
-    attr_accessor :virtual_row_instance_eval
-    
-    # Alias to the standard version of require
-    alias k_require require
+    # REMOVE40
+    def virtual_row_instance_eval
+      Sequel::Deprecation.deprecate('Sequel.virtual_row_instance_eval', 'It has no effect, so you can safely stop calling it.')
+    end
+    def virtual_row_instance_eval=(v)
+      Sequel::Deprecation.deprecate('Sequel.virtual_row_instance_eval=', 'It has no effect, so you can safely stop calling it.')
+    end
+    def k_require(*a)
+      Sequel::Deprecation.deprecate('Sequel.k_require', 'Please switch to Kernel.require')
+      Kernel.require(*a)
+    end
 
     private
 
     # Make thread safe requiring reentrant to prevent deadlocks.
     def check_requiring_thread
-      return yield if @single_threaded
-      t = Thread.current
-      return(yield) if @require_thread == t
-      @require_mutex.synchronize do
-        begin
-          @require_thread = t 
-          yield
-        ensure
-          @require_thread = nil
-        end
-      end
+      Sequel::Deprecation.deprecate('Sequel.check_requiring_thread', 'It has no effect, so you can safely stop calling it.')
     end
   end
 
@@ -119,7 +115,7 @@ module Sequel
     when Hash
       true
     when Array
-      !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| (Array === i) && (i.length == 2)}
+      !obj.empty? && !obj.is_a?(SQL::ValueList) && obj.all?{|i| i.is_a?(Array) && (i.length == 2)}
     else
       false
     end
@@ -152,7 +148,7 @@ module Sequel
   def self.core_extensions?
     false
   end
-  
+
   # Convert the +exception+ to the given class.  The given class should be
   # <tt>Sequel::Error</tt> or a subclass.  Returns an instance of +klass+ with
   # the message and backtrace of +exception+.
@@ -175,7 +171,7 @@ module Sequel
   #   Sequel.extension(:schema_dumper)
   #   Sequel.extension(:pagination, :query)
   def self.extension(*extensions)
-    extensions.each{|e| tsk_require "sequel/extensions/#{e}"}
+    extensions.each{|e| Kernel.require "sequel/extensions/#{e}"}
   end
   
   # Set the method to call on identifiers going into the database.  This affects
@@ -192,7 +188,7 @@ module Sequel
   def self.identifier_input_method=(value)
     Database.identifier_input_method = value
   end
-  
+
   # Set the method to call on identifiers coming out of the database.  This affects
   # the literalization of identifiers by calling this method on them when they are
   # retrieved from the database.  Sequel downcases identifiers retrieved for most
@@ -209,12 +205,24 @@ module Sequel
     Database.identifier_output_method = value
   end
 
+  # The exception classed raised if there is an error parsing JSON.
+  # This can be overridden to use an alternative json implementation.
+  def self.json_parser_error_class
+    JSON::ParserError
+  end
+
+  # Convert given object to json and return the result.
+  # This can be overridden to use an alternative json implementation.
+  def self.object_to_json(obj, *args)
+    obj.to_json(*args)
+  end
+
   # Parse the string as JSON and return the result.
-  # This is solely for internal use, it should not be used externally.
-  def self.parse_json(json) # :nodoc:
+  # This can be overridden to use an alternative json implementation.
+  def self.parse_json(json)
     JSON.parse(json, :create_additions=>false)
   end
-  
+
   # Set whether to quote identifiers for all databases by default. By default,
   # Sequel quotes identifiers in all SQL strings, so to turn that off:
   #
@@ -235,7 +243,7 @@ module Sequel
       end
     end
   end
-  
+
   # Require all given +files+ which should be in the same or a subdirectory of
   # this file.  If a +subdir+ is given, assume all +files+ are in that subdir.
   # This is used to ensure that the files loaded are from the same version of
@@ -243,7 +251,7 @@ module Sequel
   def self.require(files, subdir=nil)
     Array(files).each{|f| super("#{File.dirname(__FILE__).untaint}/#{"#{subdir}/" if subdir}#{f}")}
   end
-  
+
   # 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
   # single threaded connection pool, and also has some additional thread
@@ -377,14 +385,14 @@ module Sequel
     end
   end
 
-  # Same as Sequel.require, but wrapped in a mutex in order to be thread safe.
+  # REMOVE40
   def self.ts_require(*args)
-    check_requiring_thread{require(*args)}
+    Sequel::Deprecation.deprecate('Sequel.ts_require', 'Please switch to Sequel.require')
+    require(*args)
   end
-  
-  # Same as Kernel.require, but wrapped in a mutex in order to be thread safe.
   def self.tsk_require(*args)
-    check_requiring_thread{k_require(*args)}
+    Sequel::Deprecation.deprecate('Sequel.tsk_require', 'Please switch to Kernel.require')
+    Kernel.require(*args)
   end
 
   # If the supplied block takes a single argument,
@@ -403,21 +411,20 @@ module Sequel
       block.call(vr)
     end  
   end
-  
+
   ### Private Class Methods ###
 
   # Helper method that the database adapter class methods that are added to Sequel via
   # metaprogramming use to parse arguments.
-  def self.adapter_method(adapter, *args, &block) # :nodoc:
-    raise(::Sequel::Error, "Wrong number of arguments, 0-2 arguments valid") if args.length > 2
-    opts = {:adapter=>adapter.to_sym}
-    opts[:database] = args.shift if args.length >= 1 && !(args[0].is_a?(Hash))
-    if Hash === (arg = args[0])
-      opts.merge!(arg)
-    elsif !arg.nil?
+  def self.adapter_method(adapter, *args, &block)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    opts = {:adapter => adapter.to_sym}
+    opts[:database] = args.shift if args.first.is_a?(String)
+    if args.any?
       raise ::Sequel::Error, "Wrong format of arguments, either use (), (String), (Hash), or (String, Hash)"
     end
-    connect(opts, &block)
+
+    connect(opts.merge(options), &block)
   end
 
   # Method that adds a database adapter class method to Sequel that calls
@@ -432,11 +439,11 @@ module Sequel
   end
 
   private_class_method :adapter_method, :def_adapter_method
-  
-  require(%w"sql connection_pool exceptions dataset database timezones ast_transformer version")
+
+  require(%w"deprecated sql connection_pool exceptions dataset database timezones ast_transformer version")
   if !defined?(::SEQUEL_NO_CORE_EXTENSIONS) && !ENV.has_key?('SEQUEL_NO_CORE_EXTENSIONS')
   # :nocov:
-    extension(:core_extensions)
+    require(:deprecated_core_extensions)
   # :nocov:
   end
 

data/lib/sequel/database/connecting.rb

@@ -8,8 +8,12 @@ module Sequel
     # Array of supported database adapters
     ADAPTERS = %w'ado amalgalite cubrid db2 dbi do firebird ibmdb informix jdbc mock mysql mysql2 odbc openbase oracle postgres sqlite swift tinytds'.collect{|x| x.to_sym}
 
-    # Whether to use the single threaded connection pool by default
-    @@single_threaded = false
+    @single_threaded = false
+
+    class << self
+      # Whether to use the single threaded connection pool by default
+      attr_accessor :single_threaded
+    end
 
     # The Database subclass for the given adapter scheme.
     # Raises Sequel::AdapterNotFound if the adapter
@@ -22,7 +26,7 @@ module Sequel
       unless klass = ADAPTER_MAP[scheme]
         # attempt to load the adapter file
         begin
-          Sequel.tsk_require "sequel/adapters/#{scheme}"
+          require "sequel/adapters/#{scheme}"
         rescue LoadError => e
           raise Sequel.convert_exception_class(e, AdapterNotFound)
         end
@@ -37,7 +41,7 @@ module Sequel
         
     # Returns the scheme symbol for the Database class.
     def self.adapter_scheme
-      @scheme if defined?(@scheme)
+      @scheme
     end
     
     # Connects to a database.  See Sequel.connect.
@@ -86,12 +90,6 @@ module Sequel
       db
     end
     
-    # Sets the default single_threaded mode for new databases.
-    # See Sequel.single_threaded=.
-    def self.single_threaded=(value)
-      @@single_threaded = value
-    end
-
     # Sets the adapter scheme for the Database class. Call this method in
     # descendants of Database to allow connection using a URL. For example the
     # following:
@@ -142,6 +140,7 @@ module Sequel
 
     # Connects to the database. This method should be overridden by descendants.
     def connect(server)
+      Sequel::Deprecation.deprecate('Database#connect default implementation and Sequel::NotImplemented', 'All database instance can be assumed to implement connect.')
       raise NotImplemented, "#connect should be overridden by adapters"
     end
     

data/lib/sequel/database/dataset.rb

@@ -17,15 +17,20 @@ module Sequel
     #
     #   DB[:items].sql #=> "SELECT * FROM items"
     def [](*args)
-      (String === args.first) ? fetch(*args) : from(*args)
+      args.first.is_a?(String) ? fetch(*args) : from(*args)
     end
     
     # Returns a blank dataset for this database.
     #
     #   DB.dataset # SELECT *
     #   DB.dataset.from(:items) # SELECT * FROM items
-    def dataset(opts=nil)
-      @dataset_class.new(self, opts)
+    def dataset(opts=(no_arg_given=true; nil))
+      # REMOVE40
+      if no_arg_given
+        @dataset_class.new(self)
+      else
+        @dataset_class.new(self, opts)
+      end
     end
 
     # Fetches records for an arbitrary SQL statement. If a block is given,
@@ -42,7 +47,7 @@ module Sequel
     #
     #   DB.fetch('SELECT * FROM items WHERE name = ?', my_name).all
     def fetch(sql, *args, &block)
-      ds = dataset.with_sql(sql, *args)
+      ds = @default_dataset.with_sql(sql, *args)
       ds.each(&block) if block
       ds
     end
@@ -53,7 +58,7 @@ module Sequel
     #   DB.from(:items) # SELECT * FROM items
     #   DB.from(:items){id > 2} # SELECT * FROM items WHERE (id > 2)
     def from(*args, &block)
-      ds = dataset.from(*args)
+      ds = @default_dataset.from(*args)
       block ? ds.filter(&block) : ds
     end
     
@@ -63,7 +68,7 @@ module Sequel
     #   DB.select{server_version{}} # SELECT server_version()
     #   DB.select(:id).from(:items) # SELECT id FROM items
     def select(*args, &block)
-      dataset.select(*args, &block)
+      @default_dataset.select(*args, &block)
     end
   end
 end

data/lib/sequel/database/dataset_defaults.rb

@@ -8,52 +8,54 @@ module Sequel
     # The default class to use for datasets
     DatasetClass = Sequel::Dataset
 
-    # The identifier input method to use by default
-    @@identifier_input_method = nil
+    @identifier_input_method = nil
+    @identifier_output_method = nil
+    @quote_identifiers = nil
 
-    # The identifier output method to use by default
-    @@identifier_output_method = nil
+    class << self
+      # The identifier input method to use by default for all databases (default: adapter default)
+      attr_reader :identifier_input_method
 
-    # Whether to quote identifiers (columns and tables) by default
-    @@quote_identifiers = nil
+      # The identifier output method to use by default for all databases (default: adapter default)
+      attr_reader :identifier_output_method
 
-    # The method to call on identifiers going into the database
-    def self.identifier_input_method
-      @@identifier_input_method
+      # Whether to quote identifiers (columns and tables) by default for all databases (default: adapter default)
+      attr_accessor :quote_identifiers
     end
-    
-    # Set the method to call on identifiers going into the database
-    # See Sequel.identifier_input_method=.
+
+    # Change the default identifier input method to use for all databases,
     def self.identifier_input_method=(v)
-      @@identifier_input_method = v || ""
-    end
-    
-    # The method to call on identifiers coming from the database
-    def self.identifier_output_method
-      @@identifier_output_method
-    end
-    
-    # Set the method to call on identifiers coming from the database
-    # See Sequel.identifier_output_method=.
-    def self.identifier_output_method=(v)
-      @@identifier_output_method = v || ""
+      @identifier_input_method = v.nil? ? false : v
     end
 
-    # Sets the default quote_identifiers mode for new databases.
-    # See Sequel.quote_identifiers=.
-    def self.quote_identifiers=(value)
-      @@quote_identifiers = value
-    end
+    # Change the default identifier output method to use for all databases,
+    def self.identifier_output_method=(v)
+      @identifier_output_method = v.nil? ? false : v
+     end
 
     # The class to use for creating datasets.  Should respond to
     # new with the Database argument as the first argument, and
     # an optional options hash.
     attr_reader :dataset_class
 
-    # The default schema to use, generally should be nil.  This sets
-    # the default schema used for some schema modification and
-    # introspection queries, but does not effect most dataset code.
-    attr_accessor :default_schema
+    # The identifier input method to use by default for this database (default: adapter default)
+    attr_reader :identifier_input_method
+
+    # The identifier output method to use by default for this database (default: adapter default)
+    attr_reader :identifier_output_method
+
+    # REMOVE40
+    def _default_schema
+      @default_schema
+    end
+    def default_schema
+      Sequel::Deprecation.deprecate('Database#default_schema', 'Use qualified tables instead')
+      @default_schema
+    end
+    def default_schema=(v)
+      Sequel::Deprecation.deprecate('Database#default_schema=', 'Use qualified tables instead') if v
+      @default_schema = v
+    end
 
     # If the database has any dataset modules associated with it,
     # use a subclass of the given class that includes the modules
@@ -64,6 +66,7 @@ module Sequel
         @dataset_modules.each{|m| c.send(:include, m)}
       end
       @dataset_class = c
+      reset_default_dataset
     end
 
     # Equivalent to extending all datasets produced by the database with a
@@ -90,7 +93,6 @@ module Sequel
     #   end
     def extend_datasets(mod=nil, &block)
       raise(Error, "must provide either mod or block, not both") if mod && block
-      reset_schema_utility_dataset
       mod = Module.new(&block) if block
       if @dataset_modules.empty?
        @dataset_modules = [mod]
@@ -99,42 +101,17 @@ module Sequel
        @dataset_modules << mod
       end
       @dataset_class.send(:include, mod)
+      reset_default_dataset
     end
 
-    # The method to call on identifiers going into the database
-    def identifier_input_method
-      case @identifier_input_method
-      when nil
-        @identifier_input_method = @opts.fetch(:identifier_input_method, (@@identifier_input_method.nil? ? identifier_input_method_default : @@identifier_input_method))
-        @identifier_input_method == "" ? nil : @identifier_input_method
-      when ""
-        nil
-      else
-        @identifier_input_method
-      end
-    end
-    
     # Set the method to call on identifiers going into the database:
     #
     #   DB[:items] # SELECT * FROM items
     #   DB.identifier_input_method = :upcase
     #   DB[:items] # SELECT * FROM ITEMS
     def identifier_input_method=(v)
-      reset_schema_utility_dataset
-      @identifier_input_method = v || ""
-    end
-    
-    # The method to call on identifiers coming from the database
-    def identifier_output_method
-      case @identifier_output_method
-      when nil
-        @identifier_output_method = @opts.fetch(:identifier_output_method, (@@identifier_output_method.nil? ? identifier_output_method_default : @@identifier_output_method))
-        @identifier_output_method == "" ? nil : @identifier_output_method
-      when ""
-        nil
-      else
-        @identifier_output_method
-      end
+      reset_default_dataset
+      @identifier_input_method = v
     end
     
     # Set the method to call on identifiers coming from the database:
@@ -143,8 +120,8 @@ module Sequel
     #   DB.identifier_output_method = :upcase
     #   DB[:items].first # {:ID=>1, :NAME=>'foo'}
     def identifier_output_method=(v)
-      reset_schema_utility_dataset
-      @identifier_output_method = v || ""
+      reset_default_dataset
+      @identifier_output_method = v
     end
 
     # Set whether to quote identifiers (columns and tables) for this database:
@@ -153,14 +130,13 @@ module Sequel
     #   DB.quote_identifiers = true
     #   DB[:items] # SELECT * FROM "items"
     def quote_identifiers=(v)
-      reset_schema_utility_dataset
+      reset_default_dataset
       @quote_identifiers = v
     end
     
     # Returns true if the database quotes identifiers.
     def quote_identifiers?
-      return @quote_identifiers unless @quote_identifiers.nil?
-      @quote_identifiers = @opts.fetch(:quote_identifiers, (@@quote_identifiers.nil? ? quote_identifiers_default : @@quote_identifiers))
+      @quote_identifiers
     end
     
     private
@@ -169,12 +145,19 @@ module Sequel
     def dataset_class_default
       self.class.const_get(:DatasetClass)
     end
-    
-    # The default value for default_schema.
+
+    # REMOVE40
     def default_schema_default
       nil
     end
 
+    # Reset the default dataset used by most Database methods that
+    # create datasets.  Usually done after changes to the identifier
+    # mangling methods.
+    def reset_default_dataset
+      @default_dataset = dataset
+    end
+
     # The method to apply to identifiers going into the database by default.
     # Should be overridden in subclasses for databases that fold unquoted
     # identifiers to lower case instead of uppercase, such as
@@ -196,5 +179,14 @@ module Sequel
     def quote_identifiers_default
       true
     end
+
+    # Reset the identifier mangling options.  Overrides any already set on
+    # the instance.  Only for internal use by shared adapters.
+    def reset_identifier_mangling
+      @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)}
+      reset_default_dataset
+    end
   end
 end