sequel 4.40.0 → 4.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7036daa139080700c287bce9f5c7c2d068d5476e
-  data.tar.gz: cd75becb35bf05f4a74b70c6468bbfbd214359e5
+  metadata.gz: '04857dbc303fa5d8cd9cb242dee35021eada5410'
+  data.tar.gz: f05247db19fc6bfb7afdb6730d301eed82fd398e
 SHA512:
-  metadata.gz: 46cb6f09318eab28fa222d4e37484bb5781d1f94cbe4e341dd2c70c521819513e3f877e74a31dd90b998fa35abeea4ab1366e67a3bd883f85d8eec531f1841c3
-  data.tar.gz: 71ec283114e83204a544ccdc22fd5f73cad5cd403e6c2c17d55318a6dccbe1ae5b131d62ff9cd6a3552047f4808bc41bce1f04755d123ece61a16020aa7dffe9
+  metadata.gz: 320e1e83b8f39e3baa396ec77fefd70f780cd96960c5e86353419d3f2f905f4fbdfc3acf18bb1e37c35620e5dca9d2401a7895b77a205ccf52d31dd8d25b07b6
+  data.tar.gz: f1ea15ae50f0b4e398966a5fbedde61f943032a157406e6e4d39fdc01dbcae4dc3b97432395267ae82b848af251f39ece08cf20f65893258f636d9397483fb70

data/CHANGELOG

@@ -1,3 +1,33 @@
+=== 4.41.0 (2016-12-01)
+
+* Add Dataset#with_mssql_unicode_strings on Microsoft SQL Server, returning a clone with mssql_unicode_strings set (jeremyevans)
+
+* Add Dataset#with_identifier_output_method, returning a clone with identifier_output_method set (jeremyevans)
+
+* Add Dataset#with_identifier_input_method, returning a clone with identifier_input_method set (jeremyevans)
+
+* Add Dataset#with_quote_identifiers, returning a clone with quote_identifiers set (jeremyevans)
+
+* Add Dataset#with_extend, returning a clone extended with given modules (jeremyevans)
+
+* Add Dataset#with_row_proc, returning a clone with row_proc set (jeremyevans)
+
+* Support use of SQL::AliasedExpressions as Model#to_json :include option keys in the json_serializer plugin (sensadrome) (#1269)
+
+* Major improvements to type conversion in the ado adapter (vais, jeremyevans) (#1265)
+
+* Avoid memory leak in ado adapter by closing result sets after yielding them (vais, jeremyevans) (#1259)
+
+* Fix hook_class_methods plugin handling of commit hooks (jeremyevans)
+
+* Make association dataset method correctly handle cases where key fields are nil (jeremyevans)
+
+* Handle pure java exceptions that don't support message= when reraising the exception in the jdbc adapter (jeremyevans)
+
+* Add support for :offset_strategy Database option on DB2, with :limit_offset and :offset_fetch values, to disable OFFSET emulation (#1254) (jeremyevans)
+
+* Remove deprecated support for using Bignum class as a generic type (jeremyevans)
+
 === 4.40.0 (2016-10-28)
 
 * Make column_select plugin not raise an exception if the model's table does not exist (jeremyevans)

data/Rakefile

@@ -98,9 +98,12 @@ spec_task = proc do |description, name, file, coverage|
 
   desc "#{description} with warnings, some warnings filtered"
   task :"#{name}_w" do
-    ENV['RUBYOPT'] ? (ENV['RUBYOPT'] += " -w") : (ENV['RUBYOPT'] = '-w')
-    rake = ENV['RAKE'] || "#{FileUtils::RUBY} -S rake"
-    sh "#{rake} #{name} 2>&1 | egrep -v \"(: warning: instance variable @.* not initialized|: warning: method redefined; discarding old|: warning: previous definition of)\""
+    rubyopt = ENV['RUBYOPT']
+    ENV['RUBYOPT'] = "#{rubyopt} -w"
+    ENV['WARNING'] = '1'
+    run_spec.call(file)
+    ENV.delete('WARNING')
+    ENV['RUBYOPT'] = rubyopt
   end
 
   if coverage

data/doc/association_basics.rdoc

@@ -318,11 +318,11 @@ Associations are cached after being retrieved:
   @album.artists # Cached - No Database Query
   
 You can choose to ignore the cached versions and do a database query to
-retrieve results by passing a true argument to the association method:
+retrieve results by passing a :reload=>true option to the association method:
 
   @album.artists # Not cached - Database Query
   @album.artists # Cached - No Database Query
-  @album.artists(true) # Ignore cache - Database Query
+  @album.artists(:reload=>true) # Ignore cache - Database Query
 
 If you reload/refresh the object, it will automatically clear the
 associations cache for the object:
@@ -654,7 +654,7 @@ used is not correct, you need to specify the full class name with the
 In all of these methods, _association_ is replaced by the symbol you
 pass to the association.
 
-=== _association_(reload = false) (e.g. albums)
+=== _association_(opts={}) (e.g. albums)
 
 For +many_to_one+ and +one_to_one+ associations, the _association_ method
 returns either the single object associated, or nil if no object is

data/doc/opening_databases.rdoc

@@ -123,9 +123,9 @@ The following options are supported:
              for every query, which breaks things such as transactions and temporary tables.
 
 Pay special attention to the :provider option, as without specifying a provider,
-many things will be broken.  The SQLNCLI10 provider appears to work well if you
-are connecting to Microsoft SQL Server, but it is not the default as that would
-break backwards compatability.
+many things will be broken.  The SQLNCLI10 and SQLNCLI11 providers work well if you
+are connecting to Microsoft SQL Server, but it is not the default as it depends on
+those providers being installed.
 
 Example connections:
 

data/doc/release_notes/4.41.0.txt

@@ -0,0 +1,77 @@
+= New Features
+
+* Dataset#with_* methods have been added as equivalents for a
+  few Dataset#*= methods, but instead of modifying the receiver, they
+  return a modified copy, similar to the dataset query methods.
+  Specific methods added:
+
+  with_extend :: Extends clone with given modules
+  with_row_proc :: Modifies row_proc in clone
+  with_quote_identifiers :: Modifies quote_identifiers setting in
+                            clone
+  with_identifier_input_method :: Modifies identifier_input_method
+                                  setting in clone
+  with_identifier_output_method :: Modifies identifier_output_method
+                                   setting in clone
+
+  Similarly, on Microsoft SQL Server, a with_mssql_unicode_strings
+  method has been added, which returns a clone with the
+  mssql_unicode_strings setting modified.
+
+* On DB2, Sequel now supports an :offset_strategy Database option,
+  which can be set to :limit_offset for "LIMIT X OFFSET Y" or
+  :offset_fetch for "OFFSET Y FETCH FIRST X ROWS ONLY".  Depending
+  on what version of DB2 is used and how DB2 is configured, it's
+  possible one of these strategies will work.  For backwards
+  compatibility, the current default is still to emulate offsets
+  using the ROW_NUMBER window function.
+
+* In the json_serializer plugin, you can now use an
+  Sequel::SQL::AliasedExpression instance as an association name
+  value, which allows you to rename the association in the resulting
+  JSON:
+
+    album.to_json(:include=>{Sequel.as(:album, :s)=>{:only=>:name}})
+    # => '{"id":1,"name":"RF","artist_id":2,"s":{"name":"YJM"}}'
+
+= Other Improvements
+
+* The association dataset methods now correctly handle cases where
+  one of the keys is nil.  Previously, they would incorrectly use an
+  IS NULL predicate in such cases.  Now, they use a false predicate.
+
+* The hook_class_methods plugin handling of commit hooks has been
+  fixed.  The implementation of commit hooks (but not rollback
+  hooks) was broken in hook_class_methods starting in 4.39.0 due to
+  changes to avoid keeping references to all model instances until
+  the transaction was committed or rolled back.
+
+* Using the Fixnum schema method no longer raises a warning on ruby
+  2.4+, as it now uses the Integer class instead of the Fixnum
+  constant.
+
+* The ado adapter has been greatly improved.  It now avoids memory
+  leaks, has much better type handling, and passes almost all specs.
+  Note that the ado adapter's behavior can change depending on the
+  version of ruby in use, try to use ruby 2.2+ for best compatibility.
+
+* Dataset#graph no longer mutates the receiver.  Previously, it set
+  an empty hash as the :graph option in the receiver, which was
+  unintentional and not desired.
+
+* Pure java exceptions that don't support the message= method are now
+  handled properly when reraising the exception on connection errors
+  in the jdbc adapter.
+
+= Backwards Compatibility
+
+* Support for using the Bignum constant as a generic type has been
+  removed, as was preannounced in the 4.36.0 release notes.  Users
+  should switch to using the :Bignum constant if they haven't already.
+
+* Users of the ado adapter may need to update their code now that the
+  ado adapter correctly handles most types.
+
+* The spec_*_w rake tasks in the repository now require ruby 2.4+ and
+  use the warning library for filtering warnings, instead of trying to
+  filter warnings with egrep.

data/doc/schema_modification.rdoc

@@ -22,7 +22,7 @@ Columns are generally created by specifying the column type as the method
 name, followed by the column name symbol to use, and after that any options that should be used.
 If the method is a ruby class name that Sequel recognizes, Sequel will transform it into the appropriate
 type for the given database.  So while you specified +String+, Sequel will actually use +varchar+ or
-+text+ depending on the underlying database.  Here's a list of all of ruby classes that Sequel will
++text+ depending on the underlying database.  Here's a list of all ruby classes that Sequel will
 convert to database types:
 
   create_table(:columns_types) do       # common database type used
@@ -75,7 +75,7 @@ as the second argument, either as ruby classes, symbols, or strings:
   end
 
 If you use a ruby class as the type, Sequel will try to guess the appropriate type name for the
-database you are using.  If a symbol or string as used as the type, it is used verbatim as the type
+database you are using.  If a symbol or string is used as the type, it is used verbatim as the type
 name in SQL, with the exception of :Bignum.  Using the symbol :Bignum as a type will use the
 appropriate 64-bit integer type for the database you are using.
 
@@ -102,7 +102,7 @@ method, the fourth argument is the options hash.  The following options are supp
 
 === Other methods
 
-In addition to the +column+ method and other methods that create columns, there are a other methods that can be used:
+In addition to the +column+ method and other methods that create columns, there are other methods that can be used:
 
 ==== +primary_key+
 
@@ -129,7 +129,7 @@ via the :name option:
     Integer :group_id
     Integer :position
     primary_key [:group_id, :position], :name=>:items_pk
-  end 
+  end
 
 If provided with an array, +primary_key+ does not create a column, it just sets up the primary key constraint.
 
@@ -159,7 +159,7 @@ as its third argument.  A simple example is:
         references the primary key of the associated table, at least
         on most databases.
 :on_delete :: Specify the behavior of this foreign key column when the row with the primary key
-              it references is deleted , can be :restrict, :cascade, :set_null, or :set_default.
+              it references is deleted, can be :restrict, :cascade, :set_null, or :set_default.
               You can also use a string, which is used literally.
 :on_update :: Specify the behavior of this foreign key column when the row with the primary key
               it references modifies the value of the primary key.  Takes the same options as
@@ -276,7 +276,7 @@ both take the same options as +index+.
     String :name
     constraint(:name_min_length){char_length(name) > 2}
   end
-  
+
 Instead of using a block, you can use arguments that will be handled similarly
 to <tt>Dataset#where</tt>:
 
@@ -285,7 +285,7 @@ to <tt>Dataset#where</tt>:
     String :name
     constraint(:name_length_range, Sequel.function(:char_length, :name)=>3..50)
   end
-  
+
 ==== +check+
 
 +check+ operates just like +constraint+, except that it doesn't take a name
@@ -296,7 +296,7 @@ and it creates an unnamed constraint:
     String :name
     check{char_length(name) > 2}
   end
-  
+
 It's recommended that you use the +constraint+ method and provide a name for the
 constraint, as that makes it easier to drop the constraint later if necessary.
 
@@ -478,8 +478,8 @@ method:
     add_constraint(:name_min_length){char_length(name) > 2}
   end
 
-There is no method to add an unnamed constraint, but you can pass nil as the first
-argument of +add_constraint+ to do so.  However, it's not recommend to do that
+There is no method to add an unnamed constraint, but you can pass +nil+ as the first
+argument of +add_constraint+ to do so.  However, it's not recommended to do that
 as it is difficult to drop such a constraint.
 
 === +add_unique_constraint+
@@ -640,7 +640,7 @@ is the same as:
   unless table_exists?(:artists)
     create_table(:artists) do
       primary_key :id
-    end 
+    end
   end
 
 Like <tt>create_table!</tt>, it should not be used inside migrations.

data/lib/sequel/adapters/ado.rb

@@ -5,11 +5,92 @@ require 'win32ole'
 module Sequel
   # The ADO adapter provides connectivity to ADO databases in Windows.
   module ADO
+    # ADO constants (DataTypeEnum)
+    # Source: https://msdn.microsoft.com/en-us/library/ms675318(v=vs.85).aspx
+    AdBigInt           = 20
+    AdBinary           = 128
+    #AdBoolean          = 11
+    #AdBSTR             = 8
+    #AdChapter          = 136
+    #AdChar             = 129
+    #AdCurrency         = 6
+    #AdDate             = 7
+    AdDBDate           = 133
+    #AdDBTime           = 134
+    AdDBTimeStamp      = 135
+    #AdDecimal          = 14
+    #AdDouble           = 5
+    #AdEmpty            = 0
+    #AdError            = 10
+    #AdFileTime         = 64
+    #AdGUID             = 72
+    #AdIDispatch        = 9
+    #AdInteger          = 3
+    #AdIUnknown         = 13
+    AdLongVarBinary    = 205
+    #AdLongVarChar      = 201
+    #AdLongVarWChar     = 203
+    AdNumeric          = 131
+    #AdPropVariant      = 138
+    #AdSingle           = 4
+    #AdSmallInt         = 2
+    #AdTinyInt          = 16
+    #AdUnsignedBigInt   = 21
+    #AdUnsignedInt      = 19
+    #AdUnsignedSmallInt = 18
+    #AdUnsignedTinyInt  = 17
+    #AdUserDefined      = 132
+    AdVarBinary        = 204
+    #AdVarChar          = 200
+    #AdVariant          = 12
+    AdVarNumeric       = 139
+    #AdVarWChar         = 202
+    #AdWChar            = 130
+
+    cp = Object.new
+
+    def cp.bigint(v)
+      v.to_i
+    end
+
+    def cp.numeric(v)
+      BigDecimal.new(v)
+    end
+
+    def cp.binary(v)
+      Sequel.blob(v.pack('c*'))
+    end
+
+    if RUBY_VERSION >= '1.9'
+      def cp.date(v)
+        Date.new(v.year, v.month, v.day)
+      end
+    else
+      def cp.date(v)
+        Date.new(*v[0...10].split('/').map{|x| x.to_i})
+      end
+    end
+
+    CONVERSION_PROCS = {}
+    [
+      [:bigint, AdBigInt],
+      [:numeric, AdNumeric, AdVarNumeric],
+      [:date, AdDBDate],
+      [:binary, AdBinary, AdVarBinary, AdLongVarBinary]
+    ].each do |meth, *types|
+      method = cp.method(meth)
+      types.each do |i|
+        CONVERSION_PROCS[i] = method
+      end
+    end
+
     class Database < Sequel::Database
       DISCONNECT_ERROR_RE = /Communication link failure/
 
       set_adapter_scheme :ado
 
+      attr_reader :conversion_procs
+
       # In addition to the usual database options,
       # the following options have an effect:
       #
@@ -76,7 +157,14 @@ module Sequel
         synchronize(opts[:server]) do |conn|
           begin
             r = log_connection_yield(sql, conn){conn.Execute(sql)}
-            yield(r) if block_given?
+            begin
+              yield r if block_given?
+            ensure
+              begin
+                r.close
+              rescue ::WIN32OLERuntimeError
+              end
+            end
           rescue ::WIN32OLERuntimeError => e
             raise_error(e)
           end
@@ -102,6 +190,9 @@ module Sequel
             set_mssql_unicode_strings
           end
         end
+
+        @conversion_procs = CONVERSION_PROCS.dup
+
         super
       end
 
@@ -132,15 +223,52 @@ module Sequel
     class Dataset < Sequel::Dataset
       Database::DatasetClass = self
 
+
+
       def fetch_rows(sql)
-        execute(sql) do |s|
-          columns = cols = s.Fields.extend(Enumerable).map{|column| output_identifier(column.Name)}
-          self.columns = columns
-          s.getRows.transpose.each do |r|
-            row = {}
-            cols.each{|c| row[c] = r.shift}
-            yield row
-          end unless s.eof
+        execute(sql) do |recordset|
+          cols = []
+          conversion_procs = db.conversion_procs
+
+          i = -1
+          ts_cp = nil
+          recordset.Fields.each do |field|
+            type = field.Type
+            cp = if type == AdDBTimeStamp
+              ts_cp ||= if RUBY_VERSION >= '1.9'
+                nsec_div = 1000000000.0/(10**(timestamp_precision))
+                nsec_mul = 10**(timestamp_precision+3)
+                meth = db.method(:to_application_timestamp)
+                lambda do |v|
+                  # Fractional second handling is not correct on ruby <2.2
+                  meth.call([v.year, v.month, v.day, v.hour, v.min, v.sec, (v.nsec/nsec_div).round * nsec_mul])
+                end
+              else
+                # Ruby 1.8 returns AdDBTimeStamp values as a string
+                db.method(:to_application_timestamp)
+              end
+            else
+              conversion_procs[type]
+            end
+            cols << [output_identifier(field.Name), cp, i+=1]
+          end
+
+          self.columns = cols.map(&:first)
+          return if recordset.EOF
+
+          recordset.GetRows.transpose.each do |field_values|
+            h = {}
+
+            cols.each do |name, cp, i|
+              h[name] = if (v = field_values[i]) && cp
+                cp[v]
+              else
+                v
+              end
+            end
+            
+            yield h
+          end
         end
       end
       

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

@@ -56,7 +56,7 @@ module Sequel
         # is necessary as ADO's default :provider uses a separate native
         # connection for each query.
         def insert(*values)
-          return super if @opts[:sql]
+          return super if @opts[:sql] || @opts[:returning]
           with_sql("SET NOCOUNT ON; #{insert_sql(*values)}; SELECT CAST(SCOPE_IDENTITY() AS INTEGER)").single_value
         end