sequel 4.48.0 → 4.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b093264594c435f6dee3a24f2245dd8a84f3a739
-  data.tar.gz: 92d8d17d4d092f86d8d20d015fa86da8422005b5
+  metadata.gz: 272cf6bec70bfd569e735839c6e7dce242527188
+  data.tar.gz: 8fac2b669b6d97264ef870f601a882a833d2abeb
 SHA512:
-  metadata.gz: 451903d4f3abb15ce7395afdb6052ba9b60e30b895b413b8bdb74067dce03a6b748c2357a89a65eda6a6620d7dce85f007fba1be4b796954ff530d744c4b927b
-  data.tar.gz: 003675d934cf08064143725513b42857aaffa99de6586a5a3bf57bb0f6d241428379a2bdc643de7eaf947c89cb4d1c2310c904e6697ad1b60023a85c6db9ec1d
+  metadata.gz: 5d1fffb914a7352c99aceb0d0ae222a36a6a48c3fef47aa9b10d1ffc494ae625e53f1f0435d009aa050e13fbf8e1296b6bb15110e19e1762bce0f8f77ce4621e
+  data.tar.gz: f79ce483f64c7fbf4df674c374e2bac0009b6f1b479b8bb6e008921dd08ae2b88b16226427b26ce7bb3241c96ad0c2bbb55c6b66202efe4fa01e8813662a644e

data/CHANGELOG

@@ -1,3 +1,59 @@
+=== 4.49.0 (2017-08-01)
+
+* Make dataset_associations plugin automatically alias tables when using many_through_many associations that join the same table multiple times (jeremyevans)
+
+* Deprecate using a :pool_class Database that is not a class or a symbol for a supported pool class (jeremyevans)
+
+* Deprecate :eager_loading_predicate_key association option and association reflection method (jeremyevans)
+
+* Deprecate Model.serialized_columns in the serialization plugin (jeremyevans)
+
+* Deprecate Model.cti_columns in the class_table_inheritance plugin (jeremyevans)
+
+* Deprecate SQL::AliasedExpression#aliaz, use #alias instead (jeremyevans)
+
+* Deprecate SQL::Function#f, use #name instead (jeremyevans)
+
+* Deprecate treating cross join with conditions as inner join on MySQL (jeremyevans)
+
+* Deprecate ConnectionPool#created_count, use #size instead (jeremyevans)
+
+* Deprecate ConnectionPool::CONNECTION_POOL_MAP, use the :pool_class option to specify a non-default connection pool (jeremyevans)
+
+* Deprecate Sequel::IBMDB::Connection#prepared_statements= in the ibmdb adapter (jeremyevans)
+
+* Deprecate DEFAULT_OPTIONS in validation_helpers, override default_validation_helpers_options private method instead (jeremyevans)
+
+* Deprecate model association before callbacks returning false to cancel the action (jeremyevans)
+
+* Support native offset syntax on Oracle 12 (timon) (#1397)
+
+* Deprecate Dataset#nullify! in the null_dataset extension (jeremyevans)
+
+* Deprecate Dataset#autoid=, #_fetch=, and #numrows= in the mock adapter (jeremyevans)
+
+* Deprecate loading plugins by requiring sequel_#{plugin} (jeremyevans)
+
+* Add Model.sti_class_from_sti_key in the single_table_inheritance plugin to get the appropriate class to use (Aryk) (#1396)
+
+* Make Sequel::Error#cause use #wrapped_exception if it exists on ruby 2.1+ (jeremyevans)
+
+* Make Dataset#where_all, #where_each, #where_single_value core dataset methods instead of just model dataset methods (jeremyevans)
+
+* Make Database#extend_datasets and Dataset#with_extend now use a Dataset::DatasetModule instance if given a block (jeremyevans)
+
+* Add Sequel::Dataset::DatasetModule, now a superclass of Sequel::Model::DatasetModule (jeremyevans)
+
+* Make composition plugin with :mapping option work correctly if Model#get_column_value is overridden (jeremyevans)
+
+* Support Dataset#paged_each :stream => false option on mysql2 to disable streaming (Aryk) (#1395)
+
+* Make datetimeoffset handling in the jdbc/sqlserver adapter work on more drivers (jeremyevans)
+
+* Make alter_table add_primary_key work correctly on H2 1.4+ (jeremyevans)
+
+* Support :sslrootcert Database option in the postgres adapter (dleavitt) (#1391)
+
 === 4.48.0 (2017-07-01)
 
 * Deprecate Model.<< (jeremyevans)

data/doc/advanced_associations.rdoc

@@ -211,7 +211,7 @@ and the tracks eager loader looks like:
   Album.one_to_many :tracks, :eager_loader=>(proc do |eo_opts|
     eo_opts[:rows].each{|album| album.associations[:tracks] = []}
     id_map = eo_opts[:id_map]
-    Track.where(:id=>id_map.keys).all do |tracks|
+    Track.where(:album_id=>id_map.keys).all do |track|
       if albums = id_map[track.album_id]
         albums.each do |album|
           album.associations[:tracks] << track

data/doc/opening_databases.rdoc

@@ -284,7 +284,7 @@ The following additional options are supported:
 
 === postgres
 
-Requires: pg (or postgres if pg is not available)
+Requires: pg (or postgres-pr/postgres-compat if pg is not available)
 
 The Sequel postgres adapter works with the pg, postgres, and postgres-pr ruby libraries.
 The pg library is the best supported, as it supports real bound variables and prepared statements.
@@ -308,8 +308,9 @@ The following additional options are supported:
 :notice_receiver :: A proc that be called with the PGresult objects that have notice or warning messages.
                     The default notice receiver just prints the messages to stderr, but this can be used
                     to handle notice/warning messages differently.  Only respected if using the pg library).
-:sslmode :: Set to 'disable', 'allow', 'prefer', 'require' to choose how to treat SSL (only
+:sslmode :: Set to 'disable', 'allow', 'prefer', 'require', 'verify-ca', or 'verify-full' to choose how to treat SSL (only
             respected if using the pg library)
+:sslrootcert :: Specify the path to the root SSL certificate to use.
 :search_path :: Set to the schema search_path.  This can either be a single string containing the schemas
                 separated by commas (for use via a URL: <tt>postgres:///?search_path=schema1,schema2</tt>), or it
                 can be an array of strings (for use via an option:

data/doc/release_notes/4.49.0.txt

@@ -0,0 +1,222 @@
+= Forward Compatibility
+
+Sequel 4.49.0 will be the last minor release of Sequel 4. While the
+vast majority of backwards incompatible changes in Sequel 5 have
+deprecation warnings in 4.49.0, there are a few changes that do
+not.  Here is a brief list of changes coming in Sequel 5 that
+do not have deprecation warnings (note that this list may not be
+exhaustive):
+
+* The {before,after,around}_validation hooks will always be called
+  when saving, even if the validate: false option is used.  This
+  will allow you to use the before_validation hook to make changes
+  to the model instance that are required before validation and
+  before saving even if not validating.  Currently, you would have
+  to use both a before_save and before_validation hook, which would
+  both be run on normal instance saving.
+
+* Getting values for newly created model instances after insertion
+  now happens before after_create is called, instead of after.
+  This behavior is currently available via the before_after_save
+  plugin, and and will become the default behavior.
+
+* Sequel will now immediately attempt to the connect to the database
+  when a Database instance is created, in order to fail fast.  This
+  behavior is currently available via the test: true option, and
+  will become the default behavior.  You can force not testing the
+  connection by using the test: false option.
+
+* The validates_unique method in the validation_helpers plugin will
+  now only check for uniqueness by default if the record is new or
+  one of the related columns has been modified by default.  You can
+  use only_if_modified: false to force the uniqueness check.
+
+* Database schema methods and schema generator methods will return
+  nil instead of some internal value.
+
+* Many cases where Sequel uses send internally will be switched to
+  public_send so they only call public methods, unless it is
+  specifically expected that they will call private methods.
+
+* Model association hooks will be nil instead of empty arrays by
+  default.  They will only be arrays if that hook has been set for
+  the association.
+
+* Internal uses of instance_eval with a block will be changed to
+  instance_exec.  This will allow them to be used with lambdas that
+  take no arguments.  Unfortunately, it will break the case where a
+  lambda is currently used that takes one argument.
+
+* Most internal constants will be frozen, unless there is a
+  requirement that they be modified at runtime.
+
+* The @was_new instance variable set during model instance creation
+  will be removed.
+
+= Deprecated Features
+
+* Model association before callbacks returning false canceling the
+  action is now deprecated.  The callbacks should now call
+  Model#cancel_action to cancel the action.
+
+* Loading plugins by requiring them via sequel_#{plugin} is now
+  deprecated.  Affected plugins should move the plugin file so it can
+  be required via sequel/plugins/#{plugin}.
+
+* In the mock adapter, Dataset#autoid=, #_fetch=, and #numrows= are
+  now deprecated.  They modified the dataset itself, which would not
+  work for frozen datasets.  Dataset#with_autoid, #with_fetch,
+  and #with_numrows should be used instead, which return a modified
+  copy.
+
+* In the null_dataset extension, Dataset#nullify! is now deprecated.
+  It modified the dataset itself, which would not work for frozen
+  datasets.  Dataset#nullify should be used instead, which returns a
+  modified copy.
+
+* Modifying the validation_helpers plugin DEFAULT_OPTIONS hash is now
+  deprecated.  Any change to the default options should be done by
+  overriding the Model#default_validation_helpers_options private
+  method.
+
+* Modifying ConnectionPool::CONNECTION_POOL_MAP to support an
+  external connection pool is now deprecated.  To use an external
+  connection pool, pass the pool class via the :pool_class
+  Database option.  Additionally, using a :pool_class option that
+  is not a class or a symbol for one of the default connection
+  pools is also deprecated.
+
+* ConnectionPool#created_count is now deprecated.  This method was
+  misnamed, as it was in alias to size, but the name implies it
+  returns how many connections have been created, as opposed to how
+  many connections are still in the pool.
+
+* Sequel::SQL::Function#f is now deprecated, switch to using #name
+  instead.
+
+* Sequel::SQL::AliasedExpression#aliaz is now deprecated, switch
+  to using #alias instead.
+
+* The :eager_loading_predicate_key association option and
+  eager_loading_predicate_key association method are now deprecated.
+  The predicate_key option and method should be used instead.
+
+* The cti_columns class method in the class_table_inheritance plugin
+  is now deprecated.
+
+* The serialized_columns class method in the serialization plugin
+  is now deprecated.
+
+* Having ds.join_table(:table, :cross, :a=>:b) be treated as an
+  inner join on MySQL is now deprecated.
+
+* Sequel::IBMDB::Connection#prepared_statements= in the ibmdb
+  adapter is now deprecated.
+
+* Additional internal constants are now deprecated.
+
+= New Features
+
+* Database#extend_datasets and Database#with_extend if given a block
+  now use a Dataset::DatasetModule instance instead of a plain Module
+  instance.  Dataset::DatasetModule is a subset of
+  Model::DatasetModule, and allows for the easy creation of dataset
+  methods that can perform caching for frozen datasets.
+
+  Defining dataset methods is done by calling methods with the same
+  name as dataset methods inside the extend_datasets or with_extend
+  block:
+
+    DB.extend_datasets do
+      order :by_id, :id
+      select :with_id_and_name, :id, :name
+      where :active, :active
+    end
+
+  This is equivalent to:
+
+    DB.extend_datasets do
+      def by_id
+        order(:id)
+      end
+
+      def with_id_and_name
+        select(:id, :name)
+      end
+
+      def active
+        where(:active)
+      end
+    end
+
+  Except that for frozen datasets (the default in Sequel 5),
+  code like:
+
+    100.times do
+      DB[:table].active.with_id_and_name.by_id
+    end
+
+  will only allocate 4 datasets instead of 400, and can be
+  3-4 times faster.
+
+* Dataset#where_{all,each,single_value} are now core dataset methods
+  instead of just model dataset methods.  These methods allow you to
+  replace:
+
+    dataset.where(cond).all
+    dataset.where(cond).each{}
+    dataset.where(cond).single_value
+
+  with:
+
+    dataset.where_all(cond)
+    dataset.where_each(cond){}
+    dataset.where_single_value(cond)
+
+  The advantage of #where_{all,each,single_value} is that frozen
+  datasets can take potentially advantage of caching and perform
+  70%-300% faster.
+
+* Oracle 12 native limit/offset support is now supported, which
+  in particular makes offset queries much faster as they don't
+  have to be emulated using the row_number window function.
+
+* Dataset#paged_each in the mysql2 adapter now supports a
+  :stream=>false option to disable streaming and fallback to
+  the default implementation.
+  
+* The postgres adapter now supports the :sslrootcert option
+  directly, you no longer need to specify it using the
+  :driver_options hash.
+
+* The single_table_inheritance plugin now supports an
+  sti_class_from_sti_key method for getting the appropriate
+  subclass for the given key.
+
+= Other Improvements
+
+* Using the dataset_associations plugin with a many_through_many
+  association that joins to the same table multiple times is now
+  handled correctly by automatically aliasing the table
+  appropriately.
+
+* On Ruby 2.1+, Sequel::Error#cause will use wrapped_exception
+  if one is set.  This doesn't result in different behavior in
+  most cases, but it can in cases where nested exception handling
+  is done and Sequel tries to raise the most relevant exception.
+
+* Using the composition plugin with the :mapping option now works
+  correctly when using the column_conflicts plugin.
+
+* The validation_helpers plugin's validates_max_length method
+  now correctly gets the default :nil_message option from
+  the default_validation_helpers_options method instead of
+  looking at the plugin defaults.
+
+* The duplicate_columns_handler extension no longer makes the
+  Dataset#columns= method public.
+
+* On H2 1.4+, alter_table add_primary_key now works correctly.
+
+* The jdbc/sqlserver adapter's datetimeoffset type handling now
+  works with more JDBC driver versions.

data/lib/sequel/adapters/ibmdb.rb

@@ -37,7 +37,12 @@ module Sequel
     class Connection
       # A hash with prepared statement name symbol keys, where each value is 
       # a two element array with an sql string and cached Statement value.
-      attr_accessor :prepared_statements
+      attr_reader :prepared_statements
+
+      def prepared_statements=(v)
+        Sequel::Deprecation.deprecate("Sequel::IBMDB::Connection#prepared_statements=", "Use replace on the hash instead of reassigning it")
+        @prepared_statements = v
+      end
 
       # Error class for exceptions raised by the connection.
       class Error < StandardError

data/lib/sequel/adapters/jdbc.rb

@@ -10,6 +10,7 @@ module Sequel
     module JavaLang
       include_package 'java.lang'
     end
+    Sequel::Deprecation.deprecate_constant(self, :JavaLang)
     
     # Make it accesing the java.sql hierarchy more ruby friendly.
     module JavaSQL
@@ -20,6 +21,7 @@ module Sequel
     module JavaxNaming
       include_package 'javax.naming'
     end
+    Sequel::Deprecation.deprecate_constant(self, :JavaxNaming)
 
     # Used to identify a jndi connection and to extract the jndi
     # resource name.
@@ -488,7 +490,7 @@ module Sequel
       # Gets the connection from JNDI.
       def get_connection_from_jndi
         jndi_name = JNDI_URI_REGEXP.match(uri)[1]
-        JavaxNaming::InitialContext.new.lookup(jndi_name).connection
+        javax.naming.InitialContext.new.lookup(jndi_name).connection
       end
             
       # Gets the JDBC connection uri from the JNDI resource.

data/lib/sequel/adapters/jdbc/h2.rb

@@ -30,6 +30,15 @@ module Sequel
           :h2
         end
 
+        def freeze
+          h2_version
+          super
+        end
+
+        def h2_version
+          @h2_version ||= get(Sequel.function(:H2VERSION))
+        end
+
         # Rollback an existing prepared transaction with the given transaction
         # identifier string.
         def rollback_prepared_transaction(transaction_id, opts=OPTS)
@@ -84,7 +93,7 @@ module Sequel
 
               sqls = [super(table, op)]
 
-              if pk && op[:type] != :identity
+              if pk && (h2_version >= '1.4' || op[:type] != :identity)
                 sqls << "ALTER TABLE #{quote_schema_table(table)} ADD PRIMARY KEY (#{quote_identifier(op[:name])})"
               end
 

data/lib/sequel/adapters/jdbc/postgresql.rb

@@ -211,6 +211,8 @@ module Sequel
         include Sequel::Postgres::DatasetMethods
         APOS = "'".freeze
         Sequel::Deprecation.deprecate_constant(self, :APOS)
+        HSTORE_TYPE = 'hstore'.freeze
+        Sequel::Deprecation.deprecate_constant(self, :HSTORE_TYPE)
         
         private
         
@@ -228,7 +230,6 @@ module Sequel
         ARRAY_TYPE = Java::JavaSQL::Types::ARRAY
         ARRAY_METHOD = Postgres.method(:RubyPGArray)
         PG_SPECIFIC_TYPES = [ARRAY_TYPE, Java::JavaSQL::Types::OTHER, Java::JavaSQL::Types::STRUCT]#.freeze # SEQUEL5
-        HSTORE_TYPE = 'hstore'.freeze
         HSTORE_METHOD = Postgres.method(:RubyPGHstore)
 
         def type_convertor(map, meta, type, i)
@@ -241,7 +242,7 @@ module Sequel
               ARRAY_METHOD
             elsif oid == 2950 # UUID
               map[STRING_TYPE]
-            elsif meta.getPGType(i) == HSTORE_TYPE
+            elsif meta.getPGType(i) == 'hstore'
               HSTORE_METHOD
             else
               super

data/lib/sequel/adapters/jdbc/sqlserver.rb

@@ -42,8 +42,15 @@ module Sequel
           super
           map = @type_convertor_map
           map[Java::JavaSQL::Types::TIME] = SQLServer.method(:MSSQLRubyTime)
-          if defined?(Java::MicrosoftSql::Types::DATETIMEOFFSET)
-            map[Java::MicrosoftSql::Types::DATETIMEOFFSET] = lambda do |r, i|
+
+          # Work around constant lazy loading in some drivers
+          begin
+            dto = Java::MicrosoftSql::Types::DATETIMEOFFSET
+          rescue NameError
+          end
+
+          if dto
+            map[dto] = lambda do |r, i|
               if v = r.getDateTimeOffset(i)
                 to_application_timestamp(v.to_s)
               end

data/lib/sequel/adapters/mock.rb

@@ -321,6 +321,7 @@ module Sequel
 
       # Override the databases's autoid setting for this dataset
       def autoid=(v)
+        Sequel::Deprecation.deprecate("Sequel::Mock::Dataset#autoid=", "Use with_autoid to return a modified dataset")
         cache_set(:_autoid, nil)
         @opts[:autoid] = v
       end
@@ -332,6 +333,7 @@ module Sequel
 
       # Override the databases's fetch setting for this dataset
       def _fetch=(v)
+        Sequel::Deprecation.deprecate("Sequel::Mock::Dataset#_fetch=", "Use with_fetch to return a modified dataset")
         cache_set(:_fetch, nil)
         @opts[:fetch] = v
       end
@@ -343,6 +345,7 @@ module Sequel
 
       # Override the databases's numrows setting for this dataset
       def numrows=(v)
+        Sequel::Deprecation.deprecate("Sequel::Mock::Dataset#_numrows=", "Use with_numrows to return a modified dataset")
         cache_set(:_numrows, nil)
         @opts[:numrows] = v
       end