sequel 3.12.1 → 3.13.0

data/lib/sequel/timezones.rb

@@ -9,21 +9,44 @@ module Sequel
   @database_timezone = nil
   @typecast_timezone = nil
   
+  # Sequel doesn't pay much attention to timezones by default, but you can set it
+  # handle timezones if you want.  There are three separate timezone settings, application_timezone,
+  # database_timezone, and typecast_timezone.  All three timezones have getter and setter methods.
+  # You can set all three timezones to the same value at once via <tt>Sequel.default_timezone=</tt>.
+  #
+  # The only timezone values that are supported by default are <tt>:utc</tt> (convert to UTC),
+  # <tt>:local</tt> (convert to local time), and +nil+ (don't convert).  If you need to
+  # convert to a specific timezone, or need the timezones being used to change based
+  # on the environment (e.g. current user), you need to use the +named_timezones+ extension (and use
+  # +DateTime+ as the +datetime_class+). Sequel also ships with a +thread_local_timezones+ extensions
+  # which allows each thread to have its own timezone values for each of the timezones.
   module Timezones
-    attr_reader :application_timezone, :database_timezone, :typecast_timezone
+    # The timezone you want the application to use.  This is the timezone
+    # that incoming times from the database and typecasting are converted to.
+    attr_reader :application_timezone
+    
+    # The timezone for storage in the database.  This is the
+    # timezone to which Sequel will convert timestamps before literalizing them
+    # for storage in the database.  It is also the timezone that Sequel will assume
+    # database timestamp values are already in (if they don't include an offset).
+    attr_reader :database_timezone
+    
+    # The timezone that incoming data that Sequel needs to typecast
+    # is assumed to be already in (if they don't include an offset).
+    attr_reader :typecast_timezone
   
     %w'application database typecast'.each do |t|
       class_eval("def #{t}_timezone=(tz); @#{t}_timezone = convert_timezone_setter_arg(tz) end", __FILE__, __LINE__)
     end
   
-    # Convert the given Time/DateTime object into the database timezone, used when
+    # Convert the given +Time+/+DateTime+ object into the database timezone, used when
     # literalizing objects in an SQL string.
     def application_to_database_timestamp(v)
       convert_output_timestamp(v, Sequel.database_timezone)
     end
 
-    # Convert the given object into an object of Sequel.datetime_class in the
-    # application_timezone.  Used when coverting datetime/timestamp columns
+    # Convert the given object into an object of <tt>Sequel.datetime_class</tt> in the
+    # +application_timezone+.  Used when coverting datetime/timestamp columns
     # returned by the database.
     def database_to_application_timestamp(v)
       convert_timestamp(v, Sequel.database_timezone)
@@ -36,8 +59,8 @@ module Sequel
       self.typecast_timezone = tz
     end
   
-    # Convert the given object into an object of Sequel.datetime_class in the
-    # application_timezone.  Used when typecasting values when assigning them
+    # Convert the given object into an object of <tt>Sequel.datetime_class</tt> in the
+    # +application_timezone+.  Used when typecasting values when assigning them
     # to model datetime attributes.
     def typecast_to_application_timestamp(v)
       convert_timestamp(v, Sequel.typecast_timezone)
@@ -45,7 +68,7 @@ module Sequel
 
     private
 
-    # Convert the given DateTime to the given input_timezone, keeping the
+    # Convert the given +DateTime+ to the given input_timezone, keeping the
     # same time and just modifying the timezone.
     def convert_input_datetime_no_offset(v, input_timezone)
       case input_timezone
@@ -58,16 +81,16 @@ module Sequel
       end
     end
     
-    # Convert the given DateTime to the given input_timezone that is not supported
-    # by default (such as nil, :local, or :utc).  Raises an error by default.
+    # Convert the given +DateTime+ to the given input_timezone that is not supported
+    # by default (i.e. one other than +nil+, <tt>:local</tt>, or <tt>:utc</tt>).  Raises an +InvalidValue+ by default.
     # Can be overridden in extensions.
     def convert_input_datetime_other(v, input_timezone)
       raise InvalidValue, "Invalid input_timezone: #{input_timezone.inspect}"
     end
     
-    # Converts the object from a String, Array, Date, DateTime, or Time into an
-    # instance of Sequel.datetime_class.  If given an array or a string that doesn't
-    # contain an offset, assume that the array/string is already in the given input_timezone.
+    # Converts the object from a +String+, +Array+, +Date+, +DateTime+, or +Time+ into an
+    # instance of <tt>Sequel.datetime_class</tt>.  If given an array or a string that doesn't
+    # contain an offset, assume that the array/string is already in the given +input_timezone+.
     def convert_input_timestamp(v, input_timezone)
       case v
       when String
@@ -110,14 +133,14 @@ module Sequel
       end
     end
     
-    # Convert the given DateTime to the given output_timezone that is not supported
-    # by default (such as nil, :local, or :utc).  Raises an error by default.
+    # Convert the given +DateTime+ to the given output_timezone that is not supported
+    # by default (i.e. one other than +nil+, <tt>:local</tt>, or <tt>:utc</tt>).  Raises an +InvalidValue+ by default.
     # Can be overridden in extensions.
     def convert_output_datetime_other(v, output_timezone)
       raise InvalidValue, "Invalid output_timezone: #{output_timezone.inspect}"
     end
     
-    # Converts the object to the given output_timezone.
+    # Converts the object to the given +output_timezone+.
     def convert_output_timestamp(v, output_timezone)
       if output_timezone
         if v.is_a?(DateTime)
@@ -138,8 +161,8 @@ module Sequel
     end
     
     # Converts the given object from the given input timezone to the
-    # application timezone using convert_input_timestamp and
-    # convert_output_timestamp.
+    # +application_timezone+ using +convert_input_timestamp+ and
+    # +convert_output_timestamp+.
     def convert_timestamp(v, input_timezone)
       begin
         convert_output_timestamp(convert_input_timestamp(v, input_timezone), Sequel.application_timezone)

data/lib/sequel/version.rb

@@ -1,8 +1,14 @@
 module Sequel
+  # The major version of Sequel.  Only bumped for major changes.
   MAJOR = 3
-  MINOR = 12
-  TINY  = 1
+  # The minor version of Sequel.  Bumped for every non-patch level
+  # release, generally around once a month.
+  MINOR = 13
+  # The tiny version of Sequel.  Usually 0, only bumped for bugfix
+  # releases that fix regressions from previous versions.
+  TINY  = 0
   
+  # The version of Sequel you are using, as a string (e.g. "2.11.0")
   VERSION = [MAJOR, MINOR, TINY].join('.')
   
   # The version of Sequel you are using, as a string (e.g. "2.11.0")

data/spec/adapters/firebird_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
 unless defined?(FIREBIRD_DB)
   FIREBIRD_URL = 'firebird://sysdba:masterkey@localhost/reality_spec' unless defined? FIREBIRD_URL
@@ -13,7 +13,7 @@ logger = Object.new
 def logger.method_missing(m, msg)
   FIREBIRD_DB.sqls.push(msg)
 end
-FIREBIRD_DB.logger = logger
+FIREBIRD_DB.loggers = [logger]
 
 FIREBIRD_DB.create_table! :test do
   varchar :name,  :size => 50

data/spec/adapters/informix_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
 unless defined?(INFORMIX_DB)
   INFORMIX_DB = Sequel.connect('informix://localhost/mydb')

data/spec/adapters/mssql_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
 require ENV['SEQUEL_MSSQL_SPEC_REQUIRE'] if ENV['SEQUEL_MSSQL_SPEC_REQUIRE']
 
@@ -15,7 +15,7 @@ logger = Object.new
 def logger.method_missing(m, msg)
   MSSQL_DB.sqls << msg
 end
-MSSQL_DB.logger = logger
+MSSQL_DB.loggers = [logger]
 
 MSSQL_DB.create_table! :test do
   text :name

data/spec/adapters/mysql_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
 unless defined?(MYSQL_USER)
   MYSQL_USER = 'root'
@@ -25,7 +25,7 @@ logger = Object.new
 def logger.method_missing(m, msg)
   MYSQL_DB.sqls << msg
 end
-MYSQL_DB.logger = logger
+MYSQL_DB.loggers = [logger]
 MYSQL_DB.drop_table(:items) rescue nil
 MYSQL_DB.drop_table(:dolls) rescue nil
 MYSQL_DB.drop_table(:booltest) rescue nil

data/spec/adapters/oracle_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
 unless defined?(ORACLE_DB)
   ORACLE_DB = Sequel.connect('oracle://hr:hr@localhost/XE')

data/spec/adapters/postgres_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
 unless defined?(POSTGRES_DB)
   POSTGRES_URL = 'postgres://postgres:postgres@localhost:5432/reality_spec' unless defined? POSTGRES_URL
@@ -13,7 +13,7 @@ logger = Object.new
 def logger.method_missing(m, msg)
   POSTGRES_DB.sqls << msg
 end
-POSTGRES_DB.logger = logger
+POSTGRES_DB.loggers = [logger]
 
 #POSTGRES_DB.instance_variable_set(:@server_version, 80100)
 POSTGRES_DB.create_table! :test do
@@ -130,6 +130,15 @@ context "A PostgreSQL dataset" do
     @d.filter(:name => /^bc/).count.should == 1
   end
   
+  specify "should support NULLS FIRST and NULLS LAST" do
+    @d << {:name => 'abc'}
+    @d << {:name => 'bcd'}
+    @d << {:name => 'bcd', :value => 2}
+    @d.order(:value.asc(:nulls=>:first), :name).select_map(:name).should == %w[abc bcd bcd]
+    @d.order(:value.asc(:nulls=>:last), :name).select_map(:name).should == %w[bcd abc bcd]
+    @d.order(:value.asc(:nulls=>:first), :name).reverse.select_map(:name).should == %w[bcd bcd abc]
+  end
+  
   specify "#lock should lock tables and yield if a block is given" do
     @d.lock('EXCLUSIVE'){@d.insert(:name=>'a')}
   end
@@ -557,9 +566,11 @@ context "Postgres::Database schema qualified tables" do
     POSTGRES_DB.drop_table(:schema_test.qualify(:schema_test))
   end
   
-  specify "#tables should include only tables in the public schema if no schema is given" do
+  specify "#tables should not include tables in a default non-public schema" do
     POSTGRES_DB.create_table(:schema_test__schema_test){integer :i}
-    POSTGRES_DB.tables.should_not include(:schema_test)
+    POSTGRES_DB.tables.should include(:schema_test)
+    POSTGRES_DB.tables.should_not include(:pg_am)
+    POSTGRES_DB.tables.should_not include(:domain_udt_usage)
   end
   
   specify "#tables should return tables in the schema provided by the :schema argument" do
@@ -567,9 +578,28 @@ context "Postgres::Database schema qualified tables" do
     POSTGRES_DB.tables(:schema=>:schema_test).should == [:schema_test]
   end
   
-  specify "#table_exists? should assume the public schema if no schema is provided" do
+  specify "#schema should not include columns from tables in a default non-public schema" do
+    POSTGRES_DB.create_table(:schema_test__domains){integer :i}
+    sch = POSTGRES_DB.schema(:domains)
+    cs = sch.map{|x| x.first}
+    cs.should include(:i)
+    cs.should_not include(:data_type)
+  end
+  
+  specify "#schema should only include columns from the table in the given :schema argument" do
+    POSTGRES_DB.create_table!(:domains){integer :d}
+    POSTGRES_DB.create_table(:schema_test__domains){integer :i}
+    sch = POSTGRES_DB.schema(:domains, :schema=>:schema_test)
+    cs = sch.map{|x| x.first}
+    cs.should include(:i)
+    cs.should_not include(:d)
+    POSTGRES_DB.drop_table(:domains)
+  end
+  
+  specify "#table_exists? should not include tables from the default non-public schemas" do
     POSTGRES_DB.create_table(:schema_test__schema_test){integer :i}
-    POSTGRES_DB.table_exists?(:schema_test).should == false
+    POSTGRES_DB.table_exists?(:schema_test).should == true
+    POSTGRES_DB.table_exists?(:domain_udt_usage).should == false
   end
   
   specify "#table_exists? should see if the table is in a given schema" do

data/spec/adapters/spec_helper.rb

@@ -1,12 +1,12 @@
 require 'rubygems'
 require 'logger'
 unless Object.const_defined?('Sequel')
-  $:.unshift(File.join(File.dirname(__FILE__), "../../lib/"))
+  $:.unshift(File.join(File.dirname(File.expand_path(__FILE__)), "../../lib/"))
   require 'sequel'
   Sequel.quote_identifiers = false
 end
 begin
-  require File.join(File.dirname(File.dirname(__FILE__)), 'spec_config.rb')
+  require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'spec_config.rb')
 rescue LoadError
 end
 

data/spec/adapters/sqlite_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
 
 unless defined?(SQLITE_DB)
   SQLITE_URL = 'sqlite:/' unless defined? SQLITE_URL

data/spec/core/connection_pool_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper')
 CONNECTION_POOL_DEFAULTS = {:pool_timeout=>5, :pool_sleep_time=>0.001, :max_connections=>4}
 
 context "An empty ConnectionPool" do
@@ -70,7 +70,7 @@ context "A connection pool handling connections" do
     @cpool.hold {:block_return}.should == :block_return
   end
 
-  if RUBY_VERSION < '1.9.0' and (!defined?(RUBY_ENGINE) or RUBY_ENGINE != 'jruby')
+  if RUBY_VERSION < '1.9.0' and !defined?(RUBY_ENGINE)
     specify "#hold should remove dead threads from the pool if it reaches its max_size" do
       Thread.new{@cpool.hold{Thread.current.exit!}}.join
       @cpool.allocated.keys.map{|t| t.alive?}.should == [false]
@@ -96,7 +96,7 @@ context "A connection pool handling connections" do
 
   specify "#hold should remove the connection if a DatabaseDisconnectError is raised" do
     @cpool.created_count.should == 0
-    @cpool.hold{Thread.new{@cpool.hold{}}; sleep 0.01}
+    @cpool.hold{Thread.new{@cpool.hold{}}; sleep 0.03}
     @cpool.created_count.should == 2
     proc{@cpool.hold{raise Sequel::DatabaseDisconnectError}}.should raise_error(Sequel::DatabaseDisconnectError)
     @cpool.created_count.should == 1

data/spec/core/core_sql_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper')
 
 context "Array#all_two_pairs?" do
   specify "should return false if empty" do
@@ -39,6 +39,10 @@ context "Array#case and Hash#case" do
     @d.literal([[:x, :y], [:a, :b]].case(:z, :exp__w)).should == '(CASE exp.w WHEN x THEN y WHEN a THEN b ELSE z END)'
   end
 
+  specify "should return SQL CASE expression with expression even if nil" do
+    @d.literal({:x=>:y}.case(:z, nil)).should == '(CASE NULL WHEN x THEN y ELSE z END)'
+  end
+
   specify "should raise an error if an array that isn't all two pairs is used" do
     proc{[:b].case(:a)}.should raise_error(Sequel::Error)
     proc{[:b, :c].case(:a)}.should raise_error(Sequel::Error)
@@ -51,19 +55,28 @@ context "Array#case and Hash#case" do
   end
 end
 
-context "Array#sql_array" do
+context "Array#sql_value_list and #sql_array" do
   before do
     @d = Sequel::Dataset.new(nil)
   end
 
-  specify "should treat the array as an SQL array instead of conditions" do
-    @d.literal([[:x, 1], [:y, 2]]).should == '((x = 1) AND (y = 2))'
-    @d.literal([[:x, 1], [:y, 2]].sql_array).should == '((x, 1), (y, 2))'
+  specify "should treat the array as an SQL value list instead of conditions when used as a placeholder value" do
+    @d.filter("(a, b) IN ?", [[:x, 1], [:y, 2]]).sql.should == 'SELECT * WHERE ((a, b) IN ((x = 1) AND (y = 2)))'
+    @d.filter("(a, b) IN ?", [[:x, 1], [:y, 2]].sql_value_list).sql.should == 'SELECT * WHERE ((a, b) IN ((x, 1), (y, 2)))'
+    @d.filter("(a, b) IN ?", [[:x, 1], [:y, 2]].sql_array).sql.should == 'SELECT * WHERE ((a, b) IN ((x, 1), (y, 2)))'
+  end
+
+  specify "should be no difference when used as a hash value" do
+    @d.filter([:a, :b]=>[[:x, 1], [:y, 2]]).sql.should == 'SELECT * WHERE ((a, b) IN ((x, 1), (y, 2)))'
+    @d.filter([:a, :b]=>[[:x, 1], [:y, 2]].sql_value_list).sql.should == 'SELECT * WHERE ((a, b) IN ((x, 1), (y, 2)))'
     @d.filter([:a, :b]=>[[:x, 1], [:y, 2]].sql_array).sql.should == 'SELECT * WHERE ((a, b) IN ((x, 1), (y, 2)))'
   end
 end
 
 context "String#lit" do
+  before do
+    @ds = ds = MockDatabase.new.dataset
+  end
   specify "should return an LiteralString object" do
     'xyz'.lit.should be_a_kind_of(Sequel::LiteralString)
     'xyz'.lit.to_s.should == 'xyz'
@@ -77,19 +90,24 @@ context "String#lit" do
   specify "should return a PlaceholderLiteralString object if args are given" do
     a = 'DISTINCT ?'.lit(:a)
     a.should be_a_kind_of(Sequel::SQL::PlaceholderLiteralString)
-    ds = MockDatabase.new.dataset
-    ds.literal(a).should == 'DISTINCT a'
-    ds.quote_identifiers = true
-    ds.literal(a).should == 'DISTINCT "a"'
+    @ds.literal(a).should == 'DISTINCT a'
+    @ds.quote_identifiers = true
+    @ds.literal(a).should == 'DISTINCT "a"'
   end
   
   specify "should handle named placeholders if given a single argument hash" do
     a = 'DISTINCT :b'.lit(:b=>:a)
     a.should be_a_kind_of(Sequel::SQL::PlaceholderLiteralString)
-    ds = MockDatabase.new.dataset
-    ds.literal(a).should == 'DISTINCT a'
-    ds.quote_identifiers = true
-    ds.literal(a).should == 'DISTINCT "a"'
+    @ds.literal(a).should == 'DISTINCT a'
+    @ds.quote_identifiers = true
+    @ds.literal(a).should == 'DISTINCT "a"'
+  end
+
+  specify "should treat placeholder literal strings as generic expressions" do
+    a = ':b'.lit(:b=>:a)
+    @ds.literal(a + 1).should == "(a + 1)"
+    @ds.literal(a & :b).should == "(a AND b)"
+    @ds.literal(a.sql_string + :b).should == "(a || b)"
   end
 end
 

data/spec/core/database_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper')
 
 context "A new Database" do
   before do
@@ -213,6 +213,7 @@ context "Database#log_info" do
   before do
     @o = Object.new
     def @o.logs; @logs || []; end
+    def @o.to_ary; [self]; end
     def @o.method_missing(*args); (@logs ||= []) << args; end
     @db = Sequel::Database.new(:logger=>@o)
   end
@@ -234,6 +235,7 @@ context "Database#log_yield" do
     def @o.logs; @logs || []; end
     def @o.warn(*args); (@logs ||= []) << [:warn] + args; end
     def @o.method_missing(*args); (@logs ||= []) << args; end
+    def @o.to_ary; [self]; end
     @db = Sequel::Database.new(:logger=>@o)
   end
 
@@ -693,10 +695,33 @@ context "Database#transaction" do
   end
   
   specify "should wrap the supplied block with BEGIN + COMMIT statements" do
-    @db.transaction {@db.execute 'DROP TABLE test;'}
+    @db.transaction{@db.execute 'DROP TABLE test;'}
     @db.sql.should == ['BEGIN', 'DROP TABLE test;', 'COMMIT']
   end
   
+  specify "should support transaction isolation levels" do
+    @db.meta_def(:supports_transaction_isolation_levels?){true}
+    [:uncommitted, :committed, :repeatable, :serializable].each do |l|
+      @db.transaction(:isolation=>l){@db.run "DROP TABLE #{l}"}
+    end
+    @db.sql.should == ['BEGIN', 'SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED', 'DROP TABLE uncommitted', 'COMMIT',
+                       'BEGIN', 'SET TRANSACTION ISOLATION LEVEL READ COMMITTED', 'DROP TABLE committed', 'COMMIT',
+                       'BEGIN', 'SET TRANSACTION ISOLATION LEVEL REPEATABLE READ', 'DROP TABLE repeatable', 'COMMIT',
+                       'BEGIN', 'SET TRANSACTION ISOLATION LEVEL SERIALIZABLE', 'DROP TABLE serializable', 'COMMIT']
+  end
+
+  specify "should allow specifying a default transaction isolation level" do
+    @db.meta_def(:supports_transaction_isolation_levels?){true}
+    [:uncommitted, :committed, :repeatable, :serializable].each do |l|
+      @db.transaction_isolation_level = l
+      @db.transaction{@db.run "DROP TABLE #{l}"}
+    end
+    @db.sql.should == ['BEGIN', 'SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED', 'DROP TABLE uncommitted', 'COMMIT',
+                       'BEGIN', 'SET TRANSACTION ISOLATION LEVEL READ COMMITTED', 'DROP TABLE committed', 'COMMIT',
+                       'BEGIN', 'SET TRANSACTION ISOLATION LEVEL REPEATABLE READ', 'DROP TABLE repeatable', 'COMMIT',
+                       'BEGIN', 'SET TRANSACTION ISOLATION LEVEL SERIALIZABLE', 'DROP TABLE serializable', 'COMMIT']
+  end
+  
   specify "should handle returning inside of the block by committing" do
     def @db.ret_commit
       transaction do
@@ -1581,6 +1606,18 @@ context "Database#supports_savepoints?" do
   end
 end
 
+context "Database#supports_prepared_transactions?" do
+  specify "should be false by default" do
+    Sequel::Database.new.supports_prepared_transactions?.should == false
+  end
+end
+
+context "Database#supports_transaction_isolation_levels?" do
+  specify "should be false by default" do
+    Sequel::Database.new.supports_transaction_isolation_levels?.should == false
+  end
+end
+
 context "Database#input_identifier_meth" do
   specify "should be the input_identifer method of a default dataset for this database" do
     db = Sequel::Database.new