sequel 5.28.0 → 5.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e206de897422ca8260c788bcfc20bcb154c9122dd17a12dc4b45ecdca023eb9a
-  data.tar.gz: 319df67cbb77d1b93d12cd0a1f429de0b674543ebd62b6407d40e1bd992e2352
+  metadata.gz: 014f4b025465c81d313d8ea8d5591d47165d84ee0e15906d3591992f63830e08
+  data.tar.gz: f0d19f67d618a2e7cbdf67b198f218cc765507d9de093934edfe1e30aa641e41
 SHA512:
-  metadata.gz: a69c5b0bdfdb9c32503204b19d7dc18a7f78f7af7d46c44a7a4413ed4561c3ed3d0a796742045b158714a45f165957a0b9e5d6830bb110e53872a17a1ccb1ed8
-  data.tar.gz: 73a7df723afa66c70f72218e0327f10ef659a22614e5a4438d8fdc2ba16ec97d6e33213c4fd2ed08e806f2860f968786543015b34f38449093d71194aadb3655
+  metadata.gz: c1cda2787c781672dba64847f1524c0ae4120f0ee1eb412a9dbf814336941337b71b4bbc4bb481eb7d9fd847646ca657fcb2309f66030d6d51d28e96f787f073
+  data.tar.gz: 64a84a203bb795e586ca50f47d9ff865f9162bffae9d5f36c3d3dfc1baa3696f925bd474b2d4c74fc400f77f550c7fb7f74ea29ff4dfac9322db54a3c42a8732

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 5.29.0 (2020-02-01)
+
+* Recognize another disconnect error in the tinytds adapter (jeremyevans)
+
+* Fix verbose warning in postgres adapter when using prepared statements and recent versions of ruby-pg (jeremyevans)
+
+* Work correctly on Ruby 2.8+ by supporting second argument for initialize_clone (jeremyevans)
+
+* Add empty_failure_backtraces plugin for empty backtraces for ValidationFailed and HookFailed exceptions, much faster on JRuby (jeremyevans)
+
+* Add Dataset#json_serializer_opts to json_serializer plugin, allowing to set json_serializer options on a per-dataset basis (jeremyevans)
+
 === 5.28.0 (2020-01-01)
 
 * Warn when calling Sequel::JDBC::Postgres::Dataset#with_fetch_size (jeremyevans) (#1665)

data/MIT-LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2007-2008 Sharon Rosner
-Copyright (c) 2008-2019 Jeremy Evans
+Copyright (c) 2008-2020 Jeremy Evans
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/doc/release_notes/5.29.0.txt

@@ -0,0 +1,22 @@
+= New Features
+
+* An empty_failure_backtraces plugin has been added for using empty
+  backtraces for ValidationFailed and HookFailed exceptions. In many
+  cases, these exceptions are automatically handled (e.g. web form
+  submission handling to display appropriate error pages), and using
+  empty backtraces is 10-15x faster on JRuby 9.2.7.0+.
+
+* Dataset#json_serializer_opts has been added to the json_serializer
+  plugin.  This allows setting default options on a per-Dataset basis
+  for all Dataset#to_json calls.
+
+= Other Improvements
+
+* Another disconnect error is now recognized in the tinytds adapter.
+
+* Using Sequel with the the CRuby master branch (what will be Ruby 3)
+  now works by supporting a second argument for
+  Dataset#initialize_clone.
+
+* Sequel now avoids a warning in verbose mode when using the postgres
+  adapter, a recent version of ruby-pg, and bound variables.

data/lib/sequel/adapters/postgres.rb

@@ -70,6 +70,10 @@ module Sequel
         # string names of the server side prepared statement, and values
         # are SQL strings.
         attr_reader :prepared_statements
+
+        unless public_method_defined?(:async_exec_params)
+          alias async_exec_params async_exec
+        end
       else
         # Make postgres-pr look like pg
         CONNECTION_OK = -1
@@ -149,7 +153,7 @@ module Sequel
 
       # Return the PGResult containing the query results.
       def execute_query(sql, args)
-        @db.log_connection_yield(sql, self, args){args ? async_exec(sql, args) : async_exec(sql)}
+        @db.log_connection_yield(sql, self, args){args ? async_exec_params(sql, args) : async_exec(sql)}
       end
     end
     

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

@@ -691,7 +691,7 @@ module Sequel
       end
       
       # Return the results of an EXPLAIN query as a string. Options:
-      # :extended :: Use EXPLAIN EXPTENDED instead of EXPLAIN if true.
+      # :extended :: Use EXPLAIN EXTENDED instead of EXPLAIN if true.
       def explain(opts=OPTS)
         # Load the PrettyTable class, needed for explain output
         Sequel.extension(:_pretty_table) unless defined?(Sequel::PrettyTable)

data/lib/sequel/adapters/tinytds.rb

@@ -145,7 +145,7 @@ module Sequel
 
       # Return true if the :conn argument is present and not active.
       def disconnect_error?(e, opts)
-        super || (opts[:conn] && !opts[:conn].active?) || ((e.is_a?(::TinyTds::Error) && /\A(Attempt to initiate a new Adaptive Server operation with results pending|The request failed to run because the batch is aborted, this can be caused by abort signal sent from client|Adaptive Server connection timed out)/.match(e.message)))
+        super || (opts[:conn] && !opts[:conn].active?) || ((e.is_a?(::TinyTds::Error) && /\A(Attempt to initiate a new Adaptive Server operation with results pending|The request failed to run because the batch is aborted, this can be caused by abort signal sent from client|Adaptive Server connection timed out|DBPROCESS is dead or not enabled)/.match(e.message)))
       end
 
       # Dispose of any possible results of execution.

data/lib/sequel/database/schema_generator.rb

@@ -126,7 +126,7 @@ module Sequel
       # :on_update :: Specify the behavior of this column when being updated
       #               (:restrict, :cascade, :set_null, :set_default, :no_action).
       # :primary_key :: Make the column as a single primary key column.  This should not
-      #                 be used if you have a single, nonautoincrementing primary key column
+      #                 be used if you want a single autoincrementing primary key column
       #                 (use the primary_key method in that case).
       # :primary_key_constraint_name :: The name to give the primary key constraint
       # :primary_key_deferrable :: Similar to :deferrable, but for the primary key constraint

data/lib/sequel/database/transactions.rb

@@ -439,13 +439,12 @@ module Sequel
 
     # Remove the current thread from the list of active transactions
     def remove_transaction(conn, committed)
+      callbacks = transaction_hooks(conn, committed)
       if in_savepoint?(conn)
         savepoint_callbacks = savepoint_hooks(conn, committed)
         if committed
           savepoint_rollback_callbacks = savepoint_hooks(conn, false)
         end
-      else
-        callbacks = transaction_hooks(conn, committed)
       end
 
       if transaction_finished?(conn)
@@ -453,7 +452,6 @@ module Sequel
         rolled_back = !committed
         Sequel.synchronize{h[:rolled_back] = rolled_back}
         Sequel.synchronize{@transactions.delete(conn)}
-        callbacks.each(&:call) if callbacks
       elsif savepoint_callbacks || savepoint_rollback_callbacks
         if committed
           meth = in_savepoint?(conn) ? :add_savepoint_hook : :add_transaction_hook 
@@ -473,6 +471,8 @@ module Sequel
           savepoint_callbacks.each(&:call)
         end
       end
+
+      callbacks.each(&:call) if callbacks
     end
 
     # SQL to rollback to a savepoint

data/lib/sequel/dataset/misc.rb

@@ -329,7 +329,7 @@ module Sequel
     end
 
     # Set the db, opts, and cache for the copy of the dataset.
-    def initialize_copy(c)
+    def initialize_clone(c, _=nil)
       @db = c.db
       @opts = Hash[c.opts]
       if cols = c.cache_get(:_columns)
@@ -338,7 +338,7 @@ module Sequel
         @cache = {}
       end
     end
-    alias initialize_clone initialize_copy
+    alias initialize_copy initialize_clone
 
     # Internal recursive version of unqualified_column_for, handling Strings inside
     # of other objects.

data/lib/sequel/plugins/empty_failure_backtraces.rb

@@ -0,0 +1,38 @@
+# frozen-string-literal: true
+
+module Sequel
+  module Plugins
+    # The empty_failure_backtraces plugin uses empty backtraces when raising HookFailed and ValidationFailed
+    # exceptions.  This can be significantly faster, and if you are using these exceptions for
+    # flow control, you do not need the backtraces.  This plugin is about 10% faster on CRuby
+    # and 10-15x faster on JRuby 9.2.7.0+.  This does not have an effect on JRuby <9.2.7.0.
+    #
+    # Usage:
+    #
+    #   # Make all model subclass instances use empty backtraces for HookFailed
+    #   # and ValidationFailed exceptions (called before loading subclasses)
+    #   Sequel::Model.plugin :empty_failure_backtraces
+    #
+    #   # Make the Album class use empty backtraces for HookFailed and ValidationFailed exceptions
+    #   Album.plugin :empty_failure_backtraces
+    module EmptyFailureBacktraces
+      module InstanceMethods
+        private
+
+        # Use empty backtrace for HookFailed exceptions.
+        def hook_failed_error(msg)
+          e = super
+          e.set_backtrace([])
+          e
+        end
+
+        # Use empty backtrace for ValidationFailed exceptions.
+        def validation_failed_error
+          e = super
+          e.set_backtrace([])
+          e
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/json_serializer.rb

@@ -369,6 +369,13 @@ module Sequel
       end
 
       module DatasetMethods
+        # Store default options used when calling to_json on this dataset.
+        # These options take precedence over the class level options,
+        # and can be overridden by passing options directly to to_json.
+        def json_serializer_opts(opts=OPTS)
+          clone(:json_serializer_opts=>opts)
+        end
+
         # Return a JSON string representing an array of all objects in
         # this dataset.  Takes the same options as the instance
         # method, and passes them to every instance.  Additionally,
@@ -386,11 +393,15 @@ module Sequel
         #          object.  If set to a string, wraps the collection in
         #          a root object using the string as the key.  
         def to_json(*a)
-          if opts = a.first.is_a?(Hash)
-            opts = model.json_serializer_opts.merge(a.first)
+          opts = model.json_serializer_opts
+
+          if ds_opts = @opts[:json_serializer_opts]
+            opts = opts.merge(ds_opts)
+          end
+
+          if (arg = a.first).is_a?(Hash)
+            opts = opts.merge(arg)
             a = []
-          else
-            opts = model.json_serializer_opts
           end
 
           case collection_root = opts[:root]

data/lib/sequel/plugins/throw_failures.rb

@@ -48,7 +48,7 @@ module Sequel
         # nil if there were any.
         def catch_hook_failures
           called = ret = nil
-          caught = catch(HookFailed) do
+          catch(HookFailed) do
             ret = yield
             called = true
           end

data/lib/sequel/version.rb

@@ -6,7 +6,7 @@ module Sequel
 
   # The minor version of Sequel.  Bumped for every non-patch level
   # release, generally around once a month.
-  MINOR = 28
+  MINOR = 29
 
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.

data/spec/core/dataset_spec.rb

@@ -3065,7 +3065,6 @@ describe "Dataset#get" do
   end
   
   it "should select the specified column and fetch its value" do
-    @d
     5.times do
       @d.get(:name).must_equal "SELECT name FROM test LIMIT 1"
       @d.get(:abc).must_equal "SELECT abc FROM test LIMIT 1"
@@ -3077,14 +3076,12 @@ describe "Dataset#get" do
   end
   
   it "should work with aliased fields" do
-    @d
     5.times do
       @d.get(Sequel.expr(Sequel[:x][:b]).as(:name)).must_equal "SELECT x.b AS name FROM test LIMIT 1"
     end
   end
   
   it "should work with plain strings" do
-    @d
     5.times do
       @d.get('a').must_equal "SELECT 'a' AS v FROM test LIMIT 1"
     end

data/spec/extensions/caller_logging_spec.rb

@@ -42,7 +42,7 @@ describe "caller_logging extension" do
 
   it "should not log caller information if all callers lines are filtered" do
     @db.caller_logging_ignore = /./
-    exec_sql("SELECT * FROM items"); line = __LINE__
+    exec_sql("SELECT * FROM items")
     @log_stream.rewind
     lines = @log_stream.read.split("\n")
     lines.length.must_equal 1

data/spec/extensions/empty_failure_backtraces_spec.rb

@@ -0,0 +1,60 @@
+require_relative "spec_helper"
+
+describe "empty_failure_backtraces plugin" do
+  before do
+    @c = Class.new(Sequel::Model(:items)) do
+      plugin :empty_failure_backtraces
+      columns :x
+      set_primary_key :x
+      unrestrict_primary_key
+      def before_create
+        super
+        cancel_action 'bc' if x == 2
+      end
+      def before_destroy
+        super
+        cancel_action 'bd' if x == 2
+      end
+      def validate
+        super
+        errors.add(:x, "3") if x == 3
+      end
+    end
+    DB.reset
+  end
+  
+  it "should work normally if no exceptions are thrown/raised" do
+    o = @c.create(:x=>1)
+    o.must_be_kind_of @c
+    o.valid?.must_equal true
+    o.destroy.must_equal o
+  end
+
+  it "should work normally when not rescuing exceptions internally when calling save" do
+    @c.new.set(:x => 2).save(:raise_on_failure=>false).must_be_nil
+    @c.raise_on_save_failure = false
+    @c.create(:x => 2).must_be_nil
+    @c.load(:x => 2).destroy(:raise_on_failure=>false).must_be_nil
+  end
+    
+  it "should work normally when not rescuing exceptions internally when calling valid?" do
+    @c.send(:define_method, :before_validation){cancel_action "bv"}
+    @c.new(:x => 2).valid?.must_equal false
+  end
+
+  it "should raise exceptions with empty backtraces" do
+    begin
+      @c.create(:x => 2)
+    rescue Sequel::HookFailed => e 
+      e.backtrace.must_be_empty
+      1
+    end.must_equal 1
+
+    begin
+      @c.create(:x => 3)
+    rescue Sequel::ValidationFailed => e 
+      e.backtrace.must_be_empty
+      1
+    end.must_equal 1
+  end
+end

data/spec/extensions/json_serializer_spec.rb

@@ -187,6 +187,16 @@ describe "Sequel::Plugins::JsonSerializer" do
     Album.array_from_json(Album.dataset.to_json(:only=>:name)).must_equal [Album.load(:name=>@album.name)]
   end
 
+  it "should support setting json_serializer_opts for datasets" do
+    Album.dataset = Album.dataset.with_fetch(:id=>1, :name=>'RF', :artist_id=>2)
+    Album.array_from_json(Album.dataset.json_serializer_opts(:only=>:name).to_json).must_equal [Album.load(:name=>@album.name)]
+    Album.plugin :json_serializer, :only=>:id
+    Album.array_from_json(Album.dataset.json_serializer_opts(:only=>:name).to_json).must_equal [Album.load(:name=>@album.name)]
+    Album.array_from_json(Album.dataset.json_serializer_opts(:only=>:name).to_json(:only=>:artist_id)).must_equal [Album.load(:artist_id=>2)]
+    json = Album.dataset.json_serializer_opts(:only=>:name, :root=>true).to_json(:only=>:artist_id)
+    Album.array_from_json(JSON.parse(json)['albums'].to_json).must_equal [Album.load(:artist_id=>2)]
+  end
+
   it "should have dataset to_json method work with eager_graph datasets" do
     ds = Album.dataset.eager_graph(:artist).with_fetch(:id=>1, :name=>'RF', :artist_id=>2, :artist_id_0=>2, :artist_name=>'YM')
     Sequel.parse_json(ds.to_json(:only=>:name, :include=>{:artist=>{:only=>:name}})).must_equal [{"name"=>"RF", "artist"=>{"name"=>"YM"}}]

data/spec/extensions/named_timezones_spec.rb

@@ -158,12 +158,12 @@ describe "Sequel named_timezones extension with Time class" do
     dt = Sequel.database_to_application_timestamp('2009-06-01 06:20:30-0400')
     dt.must_be_instance_of Time
     dt.must_equal Time.new(2009,6,1,3,20,30,-25200)
-    dt.utc_offset.must_equal -25200
+    dt.utc_offset.must_equal(-25200)
     
     dt = Sequel.database_to_application_timestamp('2009-06-01 10:20:30+0000')
     dt.must_be_instance_of Time
     dt.must_equal Time.new(2009,6,1,3,20,30,-25200)
-    dt.utc_offset.must_equal -25200
+    dt.utc_offset.must_equal(-25200)
   end
     
   it "should raise an error for ambiguous timezones by default" do
@@ -175,19 +175,19 @@ describe "Sequel named_timezones extension with Time class" do
     Sequel.database_to_application_timestamp('2004-10-31T01:30:00').must_equal Time.new(2004, 10, 30, 22, 30, 0, -25200)
     dt = Sequel.database_to_application_timestamp('2004-10-31T01:30:00')
     dt.must_equal Time.new(2004, 10, 30, 22, 30, 0, -25200)
-    dt.utc_offset.must_equal -25200
+    dt.utc_offset.must_equal(-25200)
   end
 
   it "should assume datetimes coming out of the database that don't have an offset as coming from database_timezone" do
     dt = Sequel.database_to_application_timestamp('2009-06-01 06:20:30')
     dt.must_be_instance_of Time
     dt.must_equal Time.new(2009,6,1,3,20,30, -25200)
-    dt.utc_offset.must_equal -25200
+    dt.utc_offset.must_equal(-25200)
     
     dt = Sequel.database_to_application_timestamp('2009-06-01 10:20:30')
     dt.must_be_instance_of Time
     dt.must_equal Time.new(2009,6,1,7,20,30, -25200)
-    dt.utc_offset.must_equal -25200
+    dt.utc_offset.must_equal(-25200)
   end
   
   it "should work with the thread_local_timezones extension" do

data/spec/integration/associations_test.rb

@@ -2131,7 +2131,7 @@ describe "Sequel::Model Simple Associations" do
     a.must_equal [@album, album2]
     a.map(&:artist).must_equal [@artist, @artist]
     a.map(&:artist).map(&:albums).must_equal [[@album, album2], [@album, album2]]
-    a.map(&:artist).map{|a| a.associations[:tags]}.must_equal [[], []]
+    a.map(&:artist).map{|artist| artist.associations[:tags]}.must_equal [[], []]
   end
 
   it "should have remove method raise an error for one_to_many records if the object isn't already associated" do

data/spec/model/plugins_spec.rb

@@ -326,12 +326,12 @@ describe "Sequel::Plugins.def_sequel_method" do
   it "should define methods using block" do
     m0 = Sequel::Plugins.def_sequel_method(@m, "x", 0){1}
     m0.must_be_kind_of Symbol
-    m0.must_match /\A_sequel_x_\d+\z/
+    m0.must_match(/\A_sequel_x_\d+\z/)
     @scope.send(m0).must_equal 1
 
     m1 = Sequel::Plugins.def_sequel_method(@m, "x", 1){|x| [x, 2]}
     m1.must_be_kind_of Symbol
-    m1.must_match /\A_sequel_x_\d+\z/
+    m1.must_match(/\A_sequel_x_\d+\z/)
     @scope.send(m1, 3).must_equal [3, 2]
   end
 

data/spec/sequel_warning.rb

@@ -1,4 +1,5 @@
 if ENV['WARNING']
   require 'warning'
   Warning.ignore([:missing_ivar, :method_redefined, :not_reached], File.dirname(File.dirname(__FILE__)))
+  Warning.dedup if Warning.respond_to?(:dedup)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel
 version: !ruby/object:Gem::Version
-  version: 5.28.0
+  version: 5.29.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -226,6 +226,7 @@ extra_rdoc_files:
 - doc/release_notes/5.26.0.txt
 - doc/release_notes/5.27.0.txt
 - doc/release_notes/5.28.0.txt
+- doc/release_notes/5.29.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -325,6 +326,7 @@ files:
 - doc/release_notes/5.26.0.txt
 - doc/release_notes/5.27.0.txt
 - doc/release_notes/5.28.0.txt
+- doc/release_notes/5.29.0.txt
 - doc/release_notes/5.3.0.txt
 - doc/release_notes/5.4.0.txt
 - doc/release_notes/5.5.0.txt
@@ -537,6 +539,7 @@ files:
 - lib/sequel/plugins/dirty.rb
 - lib/sequel/plugins/eager_each.rb
 - lib/sequel/plugins/eager_graph_eager.rb
+- lib/sequel/plugins/empty_failure_backtraces.rb
 - lib/sequel/plugins/error_splitter.rb
 - lib/sequel/plugins/finder.rb
 - lib/sequel/plugins/force_encoding.rb
@@ -663,6 +666,7 @@ files:
 - spec/extensions/eager_each_spec.rb
 - spec/extensions/eager_graph_eager_spec.rb
 - spec/extensions/empty_array_consider_nulls_spec.rb
+- spec/extensions/empty_failure_backtraces_spec.rb
 - spec/extensions/error_splitter_spec.rb
 - spec/extensions/error_sql_spec.rb
 - spec/extensions/escaped_like_spec.rb