sequel 3.8.0 → 3.9.0

data/CHANGELOG

@@ -1,3 +1,51 @@
+=== 3.9.0 (2010-03-04)
+
+* Allow loading adapters and extensions from outside of the Sequel lib directory (jeremyevans)
+
+* Make limit and offset work as bound variables in prepared statements (jeremyevans)
+
+* In the single_table_inheritance plugin, handle case where the sti_key is nil or '' specially (jeremyevans) (#287)
+
+* Handle IN/NOT IN with an empty array (jeremyevans)
+
+* Emulate IN/NOT IN with multiple columns where the database doesn't support it and a dataset is given (jeremyevans)
+
+* Add Dataset#unused_table_alias, for generating a table alias that has not yet been used in the query (jeremyevans)
+
+* Support an empty database argument in bin/sequel, useful for testing things without a real database (jeremyevans)
+
+* Support for schemas and aliases when eager graphing (jeremyevans)
+
+* Handle using an SQL::Identifier as an 4th option to Dataset#join_table (jeremyevans)
+
+* Move gem spec from Rakefile to a .gemspec file, for compatibility with gem build and builder (jeremyevans) (#285)
+
+* Fix MSSQL 2005+ offset emulation on ruby 1.9 (jeremyevans)
+
+* Make active_model plugin work with ActiveModel 3.0 beta Lint specs, now requires active_model (jeremyevans)
+
+* Correctly create foreign key constraints on MySQL with the InnoDB engine, but you must specify the :key option (jeremyevans)
+
+* Add an optimistic_locking plugin for models, similar to ActiveRecord's optimistic locking support (jeremyevans)
+
+* Handle implicitly qualified symbols in UPDATE statements, useful for updating joined datasets (jeremyevans)
+
+* Have schema_dumper extension pass options hash to Database#tables (jeremyevans) (#283)
+
+* Make all internal uses of require thread-safe (jeremyevans)
+
+* Refactor connection pool into 4 separate pools, increase performance for unsharded setups (jeremyevans)
+
+* Change a couple instance_evaled lambdas into procs, for 1.9.2 compatibility (jeremyevans)
+
+* Raise error message earlier if DISTINCT ON is used on SQLite (jeremyevans)
+
+* Speed up prepared statements on SQLite (jeremyevans)
+
+* Correctly handle ODBC timestamps when database_timezone is nil (jeremyevans)
+
+* Add Sequel::ValidationFailed#errors (tmm1)
+
 === 3.8.0 (2010-01-04)
 
 * Catch cases in the postgres adapter where exceptions weren't converted or raised appropriately (jeremyevans)

data/Rakefile

@@ -9,45 +9,23 @@ end
 
 NAME = 'sequel'
 VERS = lambda do
-  require "lib/sequel/version"
+  require File.expand_path("../lib/sequel/version", __FILE__)
   Sequel.version
 end
-CLEAN.include ["**/.*.sw?", "pkg", ".config", "rdoc", "coverage", "www/public/*.html", "www/public/rdoc*"]
+CLEAN.include ["**/.*.sw?", "sequel-*.gem", ".config", "rdoc", "coverage", "www/public/*.html", "www/public/rdoc*"]
 RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'Sequel: The Database Toolkit for Ruby']
 RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
 
 # Gem Packaging and Release
 
-spec = Gem::Specification.new do |s|
-  s.name = NAME
-  s.rubyforge_project = 'sequel'
-  s.version = VERS.call
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG", "COPYING"] + Dir["doc/*.rdoc"] + Dir['doc/release_notes/*.txt']
-  s.rdoc_options += RDOC_OPTS 
-  s.summary = "The Database Toolkit for Ruby"
-  s.description = s.summary
-  s.author = "Jeremy Evans"
-  s.email = "code@jeremyevans.net"
-  s.homepage = "http://sequel.rubyforge.org"
-  s.required_ruby_version = ">= 1.8.4"
-  s.files = %w(COPYING CHANGELOG README.rdoc Rakefile) + Dir["{bin,doc,spec,lib}/**/*"]
-  s.require_path = "lib"
-  s.bindir = 'bin'
-  s.executables << 'sequel'
-end
-
 desc "Packages sequel"
-task :package=>[:clean]
-Rake::GemPackageTask.new(spec) do |p|
-  p.need_tar = true
-  p.gem_spec = spec
+task :package=>[:clean] do |p|
+  sh %{gem build sequel.gemspec}
 end
 
 desc "Install sequel gem"
 task :install=>[:package] do
-  sh %{sudo gem install pkg/#{NAME}-#{VERS.call} --local}
+  sh %{sudo gem install ./#{NAME}-#{VERS.call} --local}
 end
 
 desc "Uninstall sequel gem"
@@ -57,7 +35,7 @@ end
 
 desc "Upload sequel gem to gemcutter"
 task :release=>[:package] do
-  sh %{gem push pkg/#{NAME}-#{VERS.call}.gem} 
+  sh %{gem push ./#{NAME}-#{VERS.call}.gem} 
 end
 
 ### RDoc

data/bin/sequel

@@ -95,7 +95,6 @@ end
 error_proc["Error: Must specify -m if using -M"] if migrate_ver && !migrate_dir
 error_proc["Error: Cannot specify -D or -d with -m"] if dump_migration && migrate_dir
 error_proc["Error: Cannot specify -C with -d, -D, or -m"] if copy_databases && (dump_migration || migrate_dir)
-error_proc["Error: Must specify database connection string or path to yaml file as argument"] if db.nil? || db.empty?
 
 if logfile || echo
   require 'logger'
@@ -105,7 +104,13 @@ if logfile || echo
 end
 
 connect_proc = lambda do |database|
-  db = if File.exist?(database)
+  db = if database.nil? || database.empty?
+    db = Sequel::Database.new(:quote_identifiers=>false)
+    def db.connect(*args); Object.new; end
+    db.identifier_input_method = nil
+    db.identifier_output_method = nil
+    db
+  elsif File.exist?(database)
     require 'yaml'
     env ||= "development"
     db_config = YAML.load_file(database)

data/doc/release_notes/3.9.0.txt

@@ -0,0 +1,233 @@
+New Features
+------------
+
+* The ConnectionPool classes were refactored from 2 separate
+  classes to a 5 class hierarchy, with one main class and 4 
+  subclasses, one for each combination of sharding and threading.
+  
+  The primary reason for this refactoring is to make it so that
+  the user doesn't have to pay a performance penalty for sharding
+  if they aren't using it.  A connection pool that supports sharding
+  is automatically used if the :servers option is used when setting
+  up the database connection.
+  
+  In addition, the default connection pool no longer contains
+  the code to schedule future disconnections of currently allocated
+  connections.  The sharded connection pool must be used if that
+  feature is desired.
+  
+  The unsharded connection pools are about 25-30% faster than the
+  sharded versions.
+
+* An optimistic_locking plugin was added to Sequel::Model.  This
+  plugin implements a simple database-independent locking mechanism
+  to ensure that concurrent updates do not override changes:
+
+    class Person < Sequel::Model
+      plugin :optimistic_locking
+    end
+    p1 = Person[1]
+    p2 = Person[1]
+    # works
+    p1.update(:name=>'Jim')
+    # raises Sequel::Plugins::OptimisticLocking::Error
+    p2.update(:name=>'Bob')
+
+  In order for this plugin to work, you need to make sure that the
+  database table has a lock_version column (or other column you name
+  via the lock_column class level accessor) that defaults to 0.
+
+  The optimistic_locking plugin does not work with the
+  class_table_inheritance plugin.
+
+* Dataset#unused_table_alias was added, which takes a symbol and
+  returns either that symbol or a new symbol which can be used as
+  a table alias when joining a table to the dataset.  The symbol
+  returned is guaranteed to not already be used by the dataset:
+
+    DB[:test].unused_table_alias(:blah) # => :blah
+    DB[:test].unused_table_alias(:test) # => :test_0
+    
+  The use case is when you need to join a table to a dataset, where
+  the table may already be used inside the dataset, and you want
+  to generate a unique alias:
+  
+    ds.join(:table.as(ds.unused_table_alias(:table)), ...)
+    
+* The Sequel::ValidationFailed exception now has an errors accessor
+  which returns the Sequel::Model::Errors instance with the
+  validation errors.  This can be helpful in situations where a
+  generalized rescue is done where the model object reference is
+  not available.
+
+* bin/sequel now works without an argument, which is useful for
+  testing SQL generation (and not much else).
+
+* Support SELECT ... INTO in the MSSQL adapter, using Dataset#into,
+  which takes a table argument.
+  
+* You can now provide your own connection pool class via the
+  :pool_class option when instantiating the database.
+
+Other Improvements
+------------------
+
+* IN/NOT IN constructs with an empty array are now handled properly.
+  
+    DB[:table].filter(:id=>[]) # IN
+    DB[:table].exclude(:id=>[]) # NOT IN
+    
+  Before, the IN construct would mostly work, other than some minor
+  differences in NULL semantics.  However, the NOT IN construct
+  would not work.  Sequel now handles the NOT IN case using an
+  expression that evaluates to true.
+  
+* If using an IN/NOT IN construct with multiple columns and a dataset
+  argument, where multiple column IN/NOT IN support is emulated, a
+  separate query is done to get the records, which is then handled
+  like an array of values.  This means that the following type of
+  query now works on all tested databases:
+  
+    DB[:table1].filter([:id1, :id2]=>DB[:table2].select(:id1, :id2))
+
+* Schemas and aliases are now handled correctly when eager graphing.
+
+* Implicitly qualified symbols are now handled correctly in update
+  statements, useful if you are updating a joined dataset and need
+  to reference a column that appears in multiple tables.
+
+* The active_model plugin has been brought up to date with
+  activemodel 3.0 beta (though it doesn't work on edge).
+  Additionally, the active_model plugin now requires active_model
+  in order to use ActiveModel::Naming.
+
+* In the schema_dumper extension, always include the varchar limit,
+  even if it is 255 columns (the default).  This makes it so that
+  PostgreSQL will use a varchar(255) column instead of a text column
+  when restoring a schema dump of a varchar(255) column from another
+  database.
+  
+* You can now load adapters from outside the Sequel lib directory,
+  now they just need to be in a sequel/adapters directory somewhere
+  in the LOAD_PATH.
+
+* You can now load extensions from outside the Sequel lib directory
+  using Sequel.extension.  External extensions need to be in a
+  sequel/extensions directory somewhere in the LOAD_PATH.
+
+* Using bound variables for limit and offset in prepared statements
+  now works correctly.
+
+* Performance of prepared statements was improved in the native
+  SQLite adapter.
+  
+* The schema_dumper extension now passes the options hash from
+  dump_*_migration to Database#tables.
+
+* In the single_table_inheritance plugin, qualify the sti_key column
+  with the table name, so that subclass datasets can safely be joined
+  to other tables having the same column name.
+
+* In the single_table_inheritance plugin, handle case where the
+  sti_key value is nil or '' specially, so that those cases
+  always return an instance of the main model class.  This fixes
+  issues if constantize(nil) returns Object instead of raising
+  an exception.
+  
+* No longer use Date#to_s for literalization, always use ISO8601
+  format for dates.
+  
+* A couple lambdas which were instance_evaled were changed to procs
+  for ruby 1.9.2 compatibility.
+  
+* MSSQL emulated offset support was simplified to only use one
+  subquery, and made to work correctly on ruby 1.9.
+  
+* Emulate multiple column IN/NOT IN on H2, since it doesn't handle
+  all cases correctly.
+  
+* ODBC timestamps are now handled correctly if the database_timezone
+  is nil.
+  
+* ArgumentErrors raised when running queries in the ODBC adapter are
+  now raised as DatabaseErrors.
+  
+* Attempting to use DISTINCT ON on SQLite now raises an error before
+  sending the query to the database.
+  
+* The options hash passed to the database connection method is no
+  longer modified.  However, there may be additional options
+  present in Database#opts that weren't specified by the options
+  hash passed to the database connection method.
+  
+* Make Dataset#add_graph_aliases handle the case where the dataset
+  has not yet been graphed.
+
+* You can now provide an SQL::Identifier as a 4th argument to
+  Dataset#join_table, and unsupported arguments are caught and an
+  exception is raised.
+  
+* The gem specification has been moved out of the Rakefile, so
+  that the gem can now be built without rake, and works well with
+  gem build and bundler.
+  
+* The Rakefile no longer assumes the current directory is in the
+  $LOAD_PATH, so it should work correctly on ruby 1.9.2.
+
+* All internal uses of require are now thread safe.
+
+* Empty query parameter keys in connection strings are now ignored
+  instead of raising an exception.
+  
+* The specs were changed so that you can run them in parallel.
+  Previously there was a race condition in the migration extension
+  specs.
+
+Backwards Compatibility
+-----------------------
+
+* If you plan on using sharding at any point, you now must pass
+  a :servers option when connecting to the database, even if it is
+  an empty hash.  You can no longer just call Database#add_servers
+  later.
+
+* The connection_proc and disconnection_proc accessors were removed
+  from the connection pools, so you can no longer modify the procs
+  after the connection pool has been instantiated.  You must now
+  provide the connection_proc as the block argument when
+  instantiating the pool, and the disconnection_proc via the
+  :disconnection_proc option.
+
+* In the hash passed to Dataset#update, symbol keys with a double
+  embedded underscore are now considerated as implicit qualifiers,
+  instead of being used verbatim.  If you have a column that includes
+  a double underscore, you now need to wrap it in an SQL::Identifier
+  or use a String instead.
+  
+* The connection pools no longer convert non-StandardError based
+  exceptions to RuntimeErrors.  Previously, all of the common adapters
+  turned this feature off, so there is no change for most users.
+
+* Sequel::ConnectionPool is now considered an abstract class and
+  should not be instantiated directly.  Use ConnectionPool.get_pool
+  to return an instance of the appropriate subclass.
+
+* The Sequel::SingleThreadedPool constant is no longer defined.
+
+* The private Dataset#eager_unique_table_alias method was removed,
+  use the new public Dataset#unused_table_alias method instead, which
+  has a slightly different API.
+
+* The private Dataset#eager_graph_qualify_order method was removed,
+  used Dataset#qualified_expression instead.
+  
+* The private Sequel::Model class methods plugin_gem_location and
+  plugin_gem_location_old have been removed.
+  
+* Gems built with the rake tasks now show up in the root directory
+  instead of the pkg subdirectory, and no tarball package is created.
+
+Other News
+----------
+
+* Sequel now has an official blog at http://sequel.heroku.com.

data/lib/sequel/adapters/ado.rb

@@ -7,11 +7,11 @@ module Sequel
       set_adapter_scheme :ado
 
       def initialize(opts)
-        super(opts)
-        opts[:driver] ||= 'SQL Server'
-        case opts[:driver]
+        super
+        @opts[:driver] ||= 'SQL Server'
+        case @opts[:driver]
         when 'SQL Server'
-          Sequel.require 'adapters/ado/mssql'
+          Sequel.ts_require 'adapters/ado/mssql'
           extend Sequel::ADO::MSSQL::DatabaseMethods
         end
       end
@@ -69,10 +69,6 @@ module Sequel
         end
       end
       
-      def connection_pool_default_options
-        super.merge(:pool_convert_exceptions=>false)
-      end
-
       def disconnect_connection(conn)
         conn.Close
       end

data/lib/sequel/adapters/amalgalite.rb

@@ -125,7 +125,7 @@ module Sequel
       # Also, force the max connections to 1 if a memory database is being
       # used, as otherwise each connection gets a separate database.
       def connection_pool_default_options
-        o = super.merge(:pool_convert_exceptions=>false)
+        o = super.dup
         # Default to only a single connection if a memory database is used,
         # because otherwise each connection will get a separate database
         o[:max_connections] = 1 if @opts[:database] == ':memory:' || blank_object?(@opts[:database])

data/lib/sequel/adapters/dbi.rb

@@ -21,10 +21,10 @@ module Sequel
       }
       
       def initialize(opts)
-        super(opts)
-        case opts[:db_type]
+        super
+        case @opts[:db_type]
         when 'mssql'
-          Sequel.require 'adapters/shared/mssql'
+          Sequel.ts_require 'adapters/shared/mssql'
           extend Sequel::MSSQL::DatabaseMethods
         end
       end

data/lib/sequel/adapters/do.rb

@@ -14,18 +14,18 @@ module Sequel
     # Contains procs keyed on sub adapter type that extend the
     # given database object so it supports the correct database type.
     DATABASE_SETUP = {:postgres=>proc do |db|
-        require 'do_postgres'
-        Sequel.require 'adapters/do/postgres'
+        Sequel.tsk_require 'do_postgres'
+        Sequel.ts_require 'adapters/do/postgres'
         db.extend(Sequel::DataObjects::Postgres::DatabaseMethods)
       end,
       :mysql=>proc do |db|
-        require 'do_mysql'
-        Sequel.require 'adapters/do/mysql'
+        Sequel.tsk_require 'do_mysql'
+        Sequel.ts_require 'adapters/do/mysql'
         db.extend(Sequel::DataObjects::MySQL::DatabaseMethods)
       end,
       :sqlite3=>proc do |db|
-        require 'do_sqlite3'
-        Sequel.require 'adapters/do/sqlite'
+        Sequel.tsk_require 'do_sqlite3'
+        Sequel.ts_require 'adapters/do/sqlite'
         db.extend(Sequel::DataObjects::SQLite::DatabaseMethods)
       end
     }
@@ -43,12 +43,11 @@ module Sequel
       # raise an error immediately if the connection doesn't have a
       # uri, since DataObjects requires one.
       def initialize(opts)
-        @opts = opts
+        super
         raise(Error, "No connection string specified") unless uri
         if prok = DATABASE_SETUP[subadapter.to_sym]
           prok.call(self)
         end
-        super(opts)
       end
       
       # Setup a DataObjects::Connection to the database.
@@ -145,11 +144,6 @@ module Sequel
         :execute_non_query
       end
       
-      # The DataObjects adapter should convert exceptions by default.
-      def connection_pool_default_options
-        super.merge(:pool_convert_exceptions=>false)
-      end
-
       # Close the given database connection.
       def disconnect_connection(c)
         c.close