sequel 3.6.0 → 3.7.0

data/CHANGELOG

@@ -1,3 +1,31 @@
+=== 3.7.0 (2009-12-01)
+
+* Add Dataset#sequence to the shared Oracle Adapter, for returning autogenerated primary key values on insert (jeremyevans) (#280)
+
+* Bring support for modifying joined datasets into Sequel proper, supported on MySQL and PostgreSQL (jeremyevans)
+
+* No longer use native autoreconnection in the mysql adapter (jeremyevans)
+
+* Add NULL, NOTNULL, TRUE, SQLTRUE, FALSE, and SQLFALSE constants (jeremyevans)
+
+* Add Dataset #select_map, #select_order_map, and #select_hash (jeremyevans)
+
+* Make Dataset#group_and_count handle arguments other than Symbols (jeremyevans)
+
+* Add :only_if_modified option to validates_unique method in validation_helpers plugin (jeremyevans)
+
+* Allow specifying the dataset alias via :alias option when using union/intersect/except (jeremyevans)
+
+* Allow Model#destroy to take an options hash and respect a :transaction option (john_firebaugh)
+
+* If a transaction is being used, raise_on_save_failure is false, and a before hook returns false, rollback the transaction (john_firebaugh, jeremyevans)
+
+* In the schema_dumper, explicitly specify the :type option if it isn't Integer (jeremyevans)
+
+* On postgres, use bigserial type if :type=>Bignum is given as an option to primary_key (jeremyevans)
+
+* Use READ_DEFAULT_GROUP in the mysql adapter to load the options in the client section of the my.cnf file (crohr)
+
 === 3.6.0 (2009-11-02)
 
 * Make the MSSQL shared adapter correctly parse the column schema information for tables in the non-default database schema (rohit.namjoshi)

data/Rakefile

@@ -55,11 +55,9 @@ task :uninstall=>[:clean] do
   sh %{sudo gem uninstall #{NAME}}
 end
 
-desc "Upload sequel gem to rubyforge"
+desc "Upload sequel gem to gemcutter"
 task :release=>[:package] do
-  sh %{rubyforge login}
-  sh %{rubyforge add_release sequel #{NAME} #{VERS.call} pkg/#{NAME}-#{VERS.call}.tgz}
-  sh %{rubyforge add_file sequel #{NAME} #{VERS.call} pkg/#{NAME}-#{VERS.call}.gem} 
+  sh %{gem push pkg/#{NAME}-#{VERS.call}.gem} 
 end
 
 ### RDoc
@@ -116,7 +114,6 @@ begin
   spec_opts = lambda do
     lib_dir = File.join(File.dirname(__FILE__), 'lib')
     ENV['RUBYLIB'] ? (ENV['RUBYLIB'] += ":#{lib_dir}") : (ENV['RUBYLIB'] = lib_dir)
-    File.read("spec/spec.opts").split("\n")
   end
 
   rcov_opts = lambda do
@@ -126,7 +123,7 @@ begin
   desc "Run core and model specs with coverage"
   Spec::Rake::SpecTask.new("spec_coverage") do |t|
     t.spec_files = Dir["spec/{core,model}/*_spec.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
     t.rcov, t.rcov_opts = rcov_opts.call
   end
   
@@ -134,44 +131,44 @@ begin
   task :default => [:spec]
   Spec::Rake::SpecTask.new("spec") do |t|
     t.spec_files = Dir["spec/{core,model}/*_spec.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
   end
   
   desc "Run core specs"
   Spec::Rake::SpecTask.new("spec_core") do |t|
     t.spec_files = Dir["spec/core/*_spec.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
   end
   
   desc "Run model specs"
   Spec::Rake::SpecTask.new("spec_model") do |t|
     t.spec_files = Dir["spec/model/*_spec.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
   end
   
   desc "Run extension/plugin specs"
   Spec::Rake::SpecTask.new("spec_plugin") do |t|
     t.spec_files = Dir["spec/extensions/*_spec.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
   end
   
   desc "Run extention/plugin specs with coverage"
   Spec::Rake::SpecTask.new("spec_plugin_cov") do |t|
     t.spec_files = Dir["spec/extensions/*_spec.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
     t.rcov, t.rcov_opts = rcov_opts.call
   end
   
   desc "Run integration tests"
   Spec::Rake::SpecTask.new("integration") do |t|
     t.spec_files = Dir["spec/integration/*_test.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
   end
   
   desc "Run integration tests with coverage"
   Spec::Rake::SpecTask.new("integration_cov") do |t|
     t.spec_files = Dir["spec/integration/*_test.rb"]
-    t.spec_opts  = spec_opts.call
+    spec_opts.call
     t.rcov, t.rcov_opts = rcov_opts.call
   end
   
@@ -179,13 +176,13 @@ begin
     desc "Run #{adapter} specs"
     Spec::Rake::SpecTask.new("spec_#{adapter}") do |t|
       t.spec_files = ["spec/adapters/#{adapter}_spec.rb"] + Dir["spec/integration/*_test.rb"]
-      t.spec_opts  = spec_opts.call
+      spec_opts.call
     end
 
     desc "Run #{adapter} specs with coverage"
     Spec::Rake::SpecTask.new("spec_#{adapter}_cov") do |t|
       t.spec_files = ["spec/adapters/#{adapter}_spec.rb"] + Dir["spec/integration/*_test.rb"]
-      t.spec_opts  = spec_opts.call
+      spec_opts.call
       t.rcov, t.rcov_opts = rcov_opts.call
     end
   end

data/doc/release_notes/3.7.0.txt

@@ -0,0 +1,179 @@
+New Features
+------------
+
+* Sequel now has support for deleting and updating joined datasets
+  on MySQL and PostgreSQL.  Previously, Sequel only supported this to
+  a limited extent on Microsoft SQL Server, and support there has been
+  improved as well.  
+  
+  This allows you to do:
+  
+    DB.create_table!(:a){Integer :a; Integer :d}
+    DB.create_table!(:b){Integer :b; Integer :e}
+    DB.create_table!(:c){Integer :c; Integer :f}
+    
+    # Insert some rows
+    
+    ds = DB.from(:a, :b).
+      join(:c, :c=>:e.identifier).
+      where(:d=>:b)
+    ds.where(:f=>6).update(:a => 10)
+    ds.where(:f=>5).delete
+      
+  Which will set the a column to 10 for all rows in table a, where
+  an associated row in table c (through table b) has a value of 6 for
+  column f.  It will delete rows from table a where an associated row
+  in table c (through table b) has a value of 5 for column f.
+
+  Sequel assumes the that first FROM table is the table being
+  updated/deleted.  MySQL and Microsoft SQL Server do not require
+  multiple FROM tables, but PostgreSQL does.
+
+* Dataset #select_map, #select_order_map, and #select_hash
+  convenience methods were added for quickly creating arrays and
+  hashes from a dataset.
+  
+  select_map and select_order_map both return arrays of values for the
+  column specified.  The column can be specified either via an argument
+  or a block, similar to Dataset#get.  Both accept any valid objects as
+  arguments.
+
+  select_hash returns a hash.  It requires two symbol arguments, but
+  can handle implicit qualifiers or aliases in the symbols.
+
+  Neither of these methods offer any new functionality, they just cut
+  down on the number of required key strokes:
+
+    select_map(:column)       # select(:column).map(:column)
+    select_order_map(:column) # select(:column).order(:column).
+                              #  map(:column)
+    select_hash(:key_column, :value_column)
+    # select(:key_column, :value_column).
+    #  to_hash(:key_column, :value_column)
+
+* The NULL, NOTNULL, TRUE, SQLTRUE, FALSE, and SQLFALSE constants
+  were added to Sequel::SQL::Constants.  This allows you to do:
+  
+    include Sequel::SQL::Constants
+    DB[:table].where(:a=>'1', :b=>NOTNULL)
+    
+  Previously, the shortest way to do this was:
+
+    DB[:table].where(:a=>'1').exclude(:b=>nil)
+    
+  It may make the code more descriptive:
+
+    DB[:table].where(:b=>NULL)
+    # compared to
+    DB[:table].where(:b=>nil)
+
+  This gives the option to use SQL terminology instead of ruby
+  terminology.
+
+  The other advantage of using the constants it that they handle
+  operators and methods like other Sequel::SQL objects:
+
+    NULL & SQLFALSE # BooleanExpression => "(NULL AND FALSE)"
+    nil & false     # false
+
+    NULL + :a       # NumericExpression => "(NULL + a)"
+    nil + :a        # raises NoMethodError
+    NULL.sql_string + :a  # StringExpression => "(NULL || a)"
+    NULL.as(:b)     # AliasedExpression => "NULL AS b"
+
+  For complex systems that want to represent SQL boolean objects
+  in ruby (where you don't know exactly how they'll be used), using
+  the constants is recommended.
+
+  In order not to be too verbose, including Sequel::SQL::Constants
+  is recommended.  It's not done by default, but you can still
+  reference the constants under the main Sequel module by default
+  (e.g. Sequel::NULL).
+  
+* The validates_unique method in the validation_helpers plugin now
+  supports an :only_if_modified option, which should speed up the
+  common case where the unique attribute is not modified for an
+  existing record.  It's not on by default, since it's possible the
+  database could be changed between retrieving the model object and
+  updating it.
+  
+* The Dataest #union, #intersect, and #except methods now accept an
+  :alias option that it used as the alias for the returned dataset.
+  
+    DB[:table].union(DB[:old_table], :alias=>:table)
+
+* Model#destroy now supports a :transaction option, similar to
+  Model#save.
+
+* The shared Oracle adapter now supports Dataset#sequence for
+  returning autogenerated primary key values on insert from a
+  related sequence.
+
+  This makes Oracle work correctly when using models, with
+  something like the following:
+  
+    class Album < Sequel::Model
+      set_dataset dataset.sequence(:seq_albums_id)
+    end
+    
+  You currently need to call Dataset#sequence in every model
+  class where the underlying table uses a sequence to generate
+  primary key values.
+
+Other Improvements
+------------------
+
+* In Model #save and #destroy when using transactions and when
+  raise_on_save_failure is false, ensure that transactions are rolled
+  back if a before hook returns false.
+
+* Dataset#group_and_count now handles arguments other than Symbols.
+  A previous change to the method raised an exception if a Symbol was
+  not provided.  It also handles AliasedExpressions natively, so the
+  following works correctly:
+  
+    DB[:table].group_and_count(:column.as(:alias))
+
+* Sequel no longer uses native autoreconnection in the mysql adapter.
+  Native autoreconnection has problems with prepared statements,
+  where a new native connection is used behind Sequel's back, so
+  Sequel thinks the prepared statement has already been defined on
+  the connection, when it fact it hasn't.  Any other changes that
+  affect the state of the connection will be lost when native
+  autoreconnection is used as well.
+
+  Sequel's connection pool already handles reconnection if it detects
+  a disconnection.  This commit also adds an additional exception
+  message to recognize as a disconnect.  If there other exception
+  messages related to disconnects, please post them on the Sequel
+  mailing list.
+
+* The schema_dumper plugin now specifies the :type option for primary
+  key if it isn't Integer.
+
+* On PostgreSQL, the bigserial type is used if :type=>Bignum is
+  given as an option to primary key.  This makes it operate more
+  similarly to other adapters that support autoincrementing 64-bit
+  integer primary keys.
+  
+* The native mysql adapter will now attempt to load options in the
+  [client] section of the my.cnf file.
+
+* The rake spec tasks for the project now work correctly with RSpec
+  1.2.9.
+
+Backwards Compatibility
+-----------------------
+
+* Dataset::GET_ERROR_MSG and Dataset::MAP_ERROR_MSG constants were
+  removed.  Both were replaced with Dataset::ARG_BLOCK_ERROR_MSG.
+  
+* The behavior of the Model#save_failure private instance method was
+  modified.  It now always raises an exception, and validation
+  failures no longer call it.
+
+* The internals of how autogenerated primary key metadata is stored
+  when creating tables on PostgreSQL has been modified.
+
+* The native MySQL adapter no longer sets the OPT_LOCAL_INFILE option
+  to "client" on the native connection.

data/doc/virtual_rows.rdoc

@@ -15,6 +15,7 @@ called.  This is best shown by example:
   ds.filter{column > 1}        # column > 1
   ds.filter{table__column > 1} # table.column > 1
   ds.filter{function(1) > 1}   # function(1) > 1
+  ds.select{[column1, sum(column2).as(sum)]} # column1, sum(column2) AS sum
   ds.select{version{}}   # version()
   ds.select{count(:*){}} # count(*)
   ds.select{count(:distinct, col1){}} # count(DISTINCT col1)
@@ -54,3 +55,5 @@ that.  If you want to create identifiers or qualified identifiers
 with the same name as existing local variables, make sure ruby
 knows it is a method call instead of a local variable reference
 by not ommiting the parentheses at the end of the method call.
+If you want to return multiple arguments (common for select and
+order), have the block return an array of arguments.

data/lib/sequel/adapters/mysql.rb

@@ -11,13 +11,16 @@ module Sequel
   # it returns the strings as is.  It is false by default, which means that
   # invalid dates and times will raise errors.
   #
-  #   Sequel::MySQL.convert_invalid_date_time = true
+  #   Sequel::MySQL.convert_invalid_date_time = nil
   #
   # Sequel converts the column type tinyint(1) to a boolean by default when
   # using the native MySQL adapter.  You can turn off the conversion to use
   # tinyint as an integer:
   #
-  #   Sequel.convert_tinyint_to_bool = false
+  #   Sequel::MySQL.convert_tinyint_to_bool = false
+  #
+  # In most cases these settings need to be made after the adapter has been
+  # loaded, since the Sequel::MySQL module probably won't exist before then.
   module MySQL
     # Mapping of type numbers to conversion procs
     MYSQL_TYPES = {}
@@ -67,7 +70,7 @@ module Sequel
       include Sequel::MySQL::DatabaseMethods
       
       # Mysql::Error messages that indicate the current connection should be disconnected
-      MYSQL_DATABASE_DISCONNECT_ERRORS = /\A(Commands out of sync; you can't run this command now\z|Can't connect to local MySQL server through socket)/
+      MYSQL_DATABASE_DISCONNECT_ERRORS = /\A(Commands out of sync; you can't run this command now|Can't connect to local MySQL server through socket|MySQL server has gone away)/
       
       set_adapter_scheme :mysql
       
@@ -93,7 +96,8 @@ module Sequel
       def connect(server)
         opts = server_opts(server)
         conn = Mysql.init
-        conn.options(Mysql::OPT_LOCAL_INFILE, "client")
+        # reads additional options defined under the [client] tag in the mysql configuration file
+        conn.options(Mysql::READ_DEFAULT_GROUP, "client")
         if encoding = opts[:encoding] || opts[:charset]
           # set charset _before_ the connect. using an option instead of "SET (NAMES|CHARACTER_SET_*)" works across reconnects
           conn.options(Mysql::SET_CHARSET_NAME, encoding)
@@ -120,7 +124,6 @@ module Sequel
           attr_accessor :prepared_statements
         end
         conn.prepared_statements = {}
-        conn.reconnect = true
         conn
       end
       

data/lib/sequel/adapters/shared/mssql.rb

@@ -323,6 +323,11 @@ module Sequel
         false
       end
 
+      # MSSQL 2005+ supports modifying joined datasets
+      def supports_modifying_joins?
+        true
+      end
+
       # MSSQL does not support multiple columns for the IN/NOT IN operators
       def supports_multiple_column_in?
         false
@@ -335,17 +340,26 @@ module Sequel
 
       private
 
-      # MSSQL can modify joined datasets
-      def check_modification_allowed!
-        raise(InvalidOperation, "Grouped datasets cannot be modified") if opts[:group]
-      end
-
       # MSSQL supports the OUTPUT clause for DELETE statements.
       # It also allows prepending a WITH clause.
       def delete_clause_methods
         DELETE_CLAUSE_METHODS
       end
 
+      # Only include the primary table in the main delete clause
+      def delete_from_sql(sql)
+        sql << " FROM #{source_list(@opts[:from][0..0])}"
+      end
+
+      # MSSQL supports FROM clauses in DELETE and UPDATE statements.
+      def delete_from2_sql(sql)
+        if joined_dataset?
+          select_from_sql(sql)
+          select_join_sql(sql)
+        end
+      end
+      alias update_from_sql delete_from2_sql
+      
       # Handle the with clause for delete, insert, and update statements
       # to be the same as the insert statement.
       def delete_with_sql(sql)
@@ -361,16 +375,6 @@ module Sequel
         sprintf(".%03d", usec/1000)
       end
 
-      # MSSQL supports FROM clauses in DELETE and UPDATE statements.
-      def from_sql(sql)
-        if (opts[:from].is_a?(Array) && opts[:from].size > 1) || opts[:join]
-          select_from_sql(sql)
-          select_join_sql(sql)
-        end
-      end
-      alias delete_from2_sql from_sql
-      alias update_from_sql from_sql
-      
       # MSSQL supports the OUTPUT clause for INSERT statements.
       # It also allows prepending a WITH clause.
       def insert_clause_methods
@@ -441,6 +445,11 @@ module Sequel
       def update_clause_methods
         UPDATE_CLAUSE_METHODS
       end
+
+      # Only include the primary table in the main update clause
+      def update_table_sql(sql)
+        sql << " #{source_list(@opts[:from][0..0])}"
+      end
     end
   end
 end

data/lib/sequel/adapters/shared/mysql.rb

@@ -327,6 +327,11 @@ module Sequel
         false
       end
       
+      # MySQL supports modifying joined datasets
+      def supports_modifying_joins?
+        true
+      end
+
       # MySQL does support fractional timestamps in literal timestamps, but it
       # ignores them.  Also, using them seems to cause problems on 1.9.  Since
       # they are ignored anyway, not using them is probably best.
@@ -347,6 +352,17 @@ module Sequel
       def delete_clause_methods
         DELETE_CLAUSE_METHODS
       end
+      
+      # Consider the first table in the joined dataset is the table to delete
+      # from, but include the others for the purposes of selecting rows.
+      def delete_from_sql(sql)
+        if joined_dataset?
+          sql << " #{source_list(@opts[:from][0..0])} FROM #{source_list(@opts[:from])}"
+          select_join_sql(sql)
+        else
+          super
+        end
+      end
 
       # MySQL supports the IGNORE and ON DUPLICATE KEY UPDATE clauses for INSERT statements
       def insert_clause_methods