sequel 5.48.0 → 5.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b395c399cd3632c44311c05df70fd6cd0fa924331f665dc964e041ec87013c08
-  data.tar.gz: de423f5ece8a1f212f010d430d671e52cf89e00fa0e952fb69fe8cf9c7931e4c
+  metadata.gz: bb8660c16f1da94fc18fcc5e983437d5d7bbebd2484a67af4d266c0245045a0c
+  data.tar.gz: 9844b032cae12dba23e2719c87991ef6ffbdf9f0b793dcef201336eda8f4d8d4
 SHA512:
-  metadata.gz: 475081e84ac0c0ef2b05e642d02cf3956cf263cebc280ecd469401a9c3ed591c8854fe42e687343e68effe47e6cc0f4f12f73734e5477a8749406a8ae94afe15
-  data.tar.gz: eb5a432efd4e788461422ee754ace25d14add6a6117d10064446f31b3d719943bd4a935b3e70db10613205cf1d7bb980aaaf850449299a8f1861466aa0dcb50f
+  metadata.gz: 73fe26957ca392a3d9f0a88a786bbfd03fe1a81053354882469b7b7f4efc1a24784c792a8ac4bc5f7510519619e01c06bd1abfbb858a307b1559619453588e9a
+  data.tar.gz: 561b46e5e32cbbbb33851133858bb5049d8eeb69a67e86d24009e94c6e089e0c12d1e92769cb77906cd290afcc58e832abce686cce305c92abdb45b18f36781c

data/CHANGELOG

@@ -1,3 +1,23 @@
+=== 5.49.0 (2021-10-01)
+
+* Switch block_given? usage to defined?(yield) (jeremyevans)
+
+* Support table aliases for JOIN USING columns on PostgreSQL 14+ (jeremyevans)
+
+* Support calling PostgreSQL procedures without arguments (jeremyevans)
+
+* Support hstore subscripts in pg_hstore_ops on PostgreSQL 14+, for updating only part of an hstore value (jeremyevans)
+
+* Support JSONB subscripts in pg_json_ops on PostgreSQL 14+, for updating only part of a JSONB value (jeremyevans)
+
+* Support SQL::Expression#sequel_ast_transform for custom AST transforms on arbitrary expressions (jeremyevans)
+
+* Add Database#create_trigger :replace option on PostgreSQL 14+ for CREATE OR REPLACE TRIGGER (jeremyevans)
+
+* Make auto_validations plugin automatically setup no_null_byte validations (jeremyevans)
+
+* Add Model#validates_no_null_byte to validation_helpers plugin (jeremyevans)
+
 === 5.48.0 (2021-09-01)
 
 * Make the unused_associations plugin association reflection tracking work correctly when combining coverage runs (jeremyevans)

data/README.rdoc

@@ -894,7 +894,8 @@ in the most current release.
 Sequel fully supports the currently supported versions of Ruby (MRI) and JRuby.  It may
 support unsupported versions of Ruby or JRuby, but such support may be dropped in any
 minor version if keeping it becomes a support issue.  The minimum Ruby version
-required to run the current version of Sequel is 1.9.2.
+required to run the current version of Sequel is 1.9.2, and the minimum JRuby version is
+9.0.0.0.
 
 == Maintainer
 

data/doc/postgresql.rdoc

@@ -428,6 +428,14 @@ rows that are distinct on just those columns:
   DB[:table].distinct(:id).all
   # SELECT DISTINCT ON ("id") * FROM "table"
 
+=== JOIN USING table alias
+
+Sequel allows passing an SQL::AliasedExpression to join table methods to use a USING
+join with a table alias for the USING columns:
+
+  DB[:t1].join(:t2, Sequel.as([:c1, :c2], :alias))
+  # SELECT * FROM "t1" INNER JOIN "t2" USING ("c1", "c2") AS "alias"
+
 === Calling PostgreSQL 11+ Procedures <tt>postgres only</tt>
 
 PostgreSQL 11+ added support for procedures, which are different from the user defined

data/doc/release_notes/5.49.0.txt

@@ -0,0 +1,59 @@
+= New Features
+
+* Model#validates_no_null_byte has been added to the
+  validation_helpers.  It checks that the value being validated does
+  not contain an ASCII NUL ('\0') byte.  Some databases will return an
+  error if a string contains a NUL byte.
+
+  The auto_validations plugin will now automatically add no_null_byte
+  validations for all string columns in the model's table.  This will
+  change exceptions raised by NUL bytes from database errors to
+  validation failures.
+  
+  If you are using auto_validations and would like to have a table
+  accept NUL bytes in string columns, use the following code inside
+  the model:
+
+    skip_auto_validations(:no_null_byte)
+
+* JSONB subscripts are now supported on PostgreSQL 14+ when using the
+  pg_json_ops extension.  You can use JSONB subscripts to more easily
+  update part of a JSONB column:
+
+    DB[:table].update(Sequel.pg_jsonb_op(:column)['key'] => 'value')
+    UPDATE "table" SET "column"['key'] = 'value'
+
+* hstore subscripts are now supported on PostgreSQL 14+ when using the
+  pg_hstore_ops extension.  You can use hstore subscripts to more
+  easily update part of an hstore column:
+
+    DB[:table].update(Sequel.hstore_op(:column)['key'] => 'value')
+    UPDATE "table" SET "column"['key'] = 'value'
+
+* Sequel now supports table aliases for JOIN USING columns on
+  PostgreSQL 14+.  These allow you to reference the USING columns in
+  the query using a qualified identifier. To use this support, pass an
+  SQL::AliasedExpression as the expression to join on:
+
+    DB[:t1].join(:t2, Sequel.as([:c1, :c2], :alias))
+    # SELECT * FROM "t1" INNER JOIN "t2" USING ("c1", "c2") AS "alias"
+
+* Database#create_trigger on PostgreSQL now supports a :replace option
+  for CREATE OR REPLACE TRIGGER (supported in PostgreSQL 14+).
+
+* SQL::Expression#sequel_ast_transform has been added to support
+  AST transforms of custom expression classes.
+
+= Other Improvements
+
+* Sequel now supports calling PostgreSQL procedures without arguments
+  when using Database#call_procedure.  Previously, attempts to call
+  procuredures without arguments would call the procedure with a
+  single NULL argument.
+
+* Sequel now uses defined?(yield) instead of block_given? internally
+  for better performance on CRuby.  defined?(yield) is faster as it is
+  built into the VM, while block_given? is a regular method and has
+  the overhead of calling a regular method.  Note that defined?(yield)
+  is not implemented correctly on JRuby before 9.0.0.0, so this
+  release of Sequel drops support for JRuby versions before 9.0.0.0.

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

@@ -318,7 +318,7 @@ module Sequel
                   conn.OpenSchema(ado_schema.type, ado_schema.criteria) 
                 end
               }
-              yield(r) if block_given?
+              yield(r) if defined?(yield)
             rescue ::WIN32OLERuntimeError => e
               raise_error(e)
             end

data/lib/sequel/adapters/ado.rb

@@ -161,7 +161,7 @@ module Sequel
           begin
             r = log_connection_yield(sql, conn){conn.Execute(sql)}
             begin
-              yield r if block_given?
+              yield r if defined?(yield)
             ensure
               begin
                 r.close

data/lib/sequel/adapters/ibmdb.rb

@@ -246,7 +246,7 @@ module Sequel
           end
           begin
             stmt = log_connection_yield(log_sql, conn, args){conn.execute_prepared(ps_name, *args)}
-            if block_given?
+            if defined?(yield)
               yield(stmt)
             else  
               stmt.affected
@@ -268,7 +268,7 @@ module Sequel
       # is given or returning the number of affected rows if not, and ensuring the statement is freed.
       def _execute(conn, sql, opts)
         stmt = log_connection_yield(sql, conn){conn.execute(sql)}
-        if block_given?
+        if defined?(yield)
           yield(stmt)
         else  
           stmt.affected

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

@@ -35,9 +35,9 @@ module Sequel
           data = opts[:data]
           data = Array(data) if data.is_a?(String)
 
-          if block_given? && data
+          if defined?(yield) && data
             raise Error, "Cannot provide both a :data option and a block to copy_into"
-          elsif !block_given? && !data
+          elsif !defined?(yield) && !data
             raise Error, "Must provide either a :data option or a block to copy_into"
           end
 
@@ -45,7 +45,7 @@ module Sequel
             begin
               copy_manager = org.postgresql.copy.CopyManager.new(conn)
               copier = copy_manager.copy_in(copy_into_sql(table, opts))
-              if block_given?
+              if defined?(yield)
                 while buf = yield
                   java_bytes = buf.to_java_bytes
                   copier.writeToCopy(java_bytes, 0, java_bytes.length)
@@ -77,7 +77,7 @@ module Sequel
             copy_manager = org.postgresql.copy.CopyManager.new(conn)
             copier = copy_manager.copy_out(copy_table_sql(table, opts))
             begin
-              if block_given?
+              if defined?(yield)
                 while buf = copier.readFromCopy
                   yield(String.from_java_bytes(buf))
                 end

data/lib/sequel/adapters/jdbc.rb

@@ -196,7 +196,7 @@ module Sequel
           args.each{|arg| set_ps_arg(cps, arg, i+=1)}
 
           begin
-            if block_given?
+            if defined?(yield)
               yield log_connection_yield(sql, conn){cps.executeQuery}
             else
               log_connection_yield(sql, conn){cps.executeUpdate}
@@ -461,7 +461,7 @@ module Sequel
             msg << ")"
           end
           begin
-            if block_given?
+            if defined?(yield)
               yield log_connection_yield(msg, conn, args){cps.executeQuery}
             else
               case opts[:type]

data/lib/sequel/adapters/mysql.rb

@@ -167,7 +167,7 @@ module Sequel
           r = log_connection_yield((log_sql = opts[:log_sql]) ? sql + log_sql : sql, conn){conn.query(sql)}
           if opts[:type] == :select
             yield r if r
-          elsif block_given?
+          elsif defined?(yield)
             yield conn
           end
           if conn.respond_to?(:more_results?)

data/lib/sequel/adapters/mysql2.rb

@@ -151,7 +151,7 @@ module Sequel
                 yield r
               end
             end
-          elsif block_given?
+          elsif defined?(yield)
             yield conn
           end
         rescue ::Mysql2::Error => e
@@ -244,7 +244,7 @@ module Sequel
       # it hasn't been disabled.
       def paged_each(opts=OPTS, &block)
         if STREAMING_SUPPORTED && opts[:stream] != false
-          unless block_given?
+          unless defined?(yield)
             return enum_for(:paged_each, opts)
           end
           stream.each(&block)

data/lib/sequel/adapters/odbc.rb

@@ -40,7 +40,7 @@ module Sequel
         synchronize(opts[:server]) do |conn|
           begin
             r = log_connection_yield(sql, conn){conn.run(sql)}
-            yield(r) if block_given?
+            yield(r) if defined?(yield)
           rescue ::ODBC::Error, ArgumentError => e
             raise_error(e)
           ensure

data/lib/sequel/adapters/oracle.rb

@@ -88,11 +88,11 @@ module Sequel
               r = conn.parse(sql)
               args = cursor_bind_params(conn, r, args)
               nr = log_connection_yield(sql, conn, args){r.exec}
-              r = nr unless block_given?
+              r = nr unless defined?(yield)
             else
               r = log_connection_yield(sql, conn){conn.exec(sql)}
             end
-            if block_given?
+            if defined?(yield)
               yield(r)
             elsif type == :insert
               last_insert_id(conn, opts)
@@ -192,7 +192,7 @@ module Sequel
           log_sql << ")"
         end
         r = log_connection_yield(log_sql, conn, args){cursor.exec}
-        if block_given?
+        if defined?(yield)
           yield(cursor)
         elsif type == :insert
           last_insert_id(conn, opts)

data/lib/sequel/adapters/postgres.rb

@@ -143,7 +143,7 @@ module Sequel
         args = args.map{|v| @db.bound_variable_arg(v, self)} if args
         q = check_disconnect_errors{execute_query(sql, args)}
         begin
-          block_given? ? yield(q) : q.cmd_tuples
+          defined?(yield) ? yield(q) : q.cmd_tuples
         ensure
           q.clear if q && q.respond_to?(:clear)
         end
@@ -350,7 +350,7 @@ module Sequel
           synchronize(opts[:server]) do |conn|
             conn.execute(copy_table_sql(table, opts))
             begin
-              if block_given?
+              if defined?(yield)
                 while buf = conn.get_copy_data
                   yield buf
                 end
@@ -400,16 +400,16 @@ module Sequel
           data = opts[:data]
           data = Array(data) if data.is_a?(String)
 
-          if block_given? && data
+          if defined?(yield) && data
             raise Error, "Cannot provide both a :data option and a block to copy_into"
-          elsif !block_given? && !data
+          elsif !defined?(yield) && !data
             raise Error, "Must provide either a :data option or a block to copy_into"
           end
 
           synchronize(opts[:server]) do |conn|
             conn.execute(copy_into_sql(table, opts))
             begin
-              if block_given?
+              if defined?(yield)
                 while buf = yield
                   conn.put_copy_data(buf)
                 end
@@ -590,7 +590,7 @@ module Sequel
 
         q = conn.check_disconnect_errors{log_connection_yield(log_sql, conn, args){_execute_prepared_statement(conn, ps_name, args, opts)}}
         begin
-          block_given? ? yield(q) : q.cmd_tuples
+          defined?(yield) ? yield(q) : q.cmd_tuples
         ensure
           q.clear if q && q.respond_to?(:clear)
         end
@@ -616,7 +616,7 @@ module Sequel
       
       # Use a cursor for paging.
       def paged_each(opts=OPTS, &block)
-        unless block_given?
+        unless defined?(yield)
           return enum_for(:paged_each, opts)
         end
         use_cursor(opts).each(&block)
@@ -717,7 +717,9 @@ module Sequel
         sql = String.new
         sql << "CALL "
         identifier_append(sql, name)
-        literal_append(sql, args)
+        sql << "("
+        expression_list_append(sql, args)
+        sql << ")"
         with_sql_first(sql)
       end
 

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

@@ -479,6 +479,7 @@ module Sequel
       #         :each_row :: Calls the trigger for each row instead of for each statement.
       #         :events :: Can be :insert, :update, :delete, or an array of any of those. Calls the trigger whenever that type of statement is used.  By default,
       #                    the trigger is called for insert, update, or delete.
+      #         :replace :: Replace the trigger with the same name if it already exists (PostgreSQL 14+).
       #         :when :: A filter to use for the trigger
       def create_trigger(table, name, function, opts=OPTS)
         self << create_trigger_sql(table, name, function, opts)
@@ -1237,7 +1238,7 @@ module Sequel
           raise Error, "Trigger conditions are not supported for this database" unless supports_trigger_conditions?
           filter = " WHEN #{filter_expr(filter)}"
         end
-        "CREATE TRIGGER #{name} #{whence} #{events.map{|e| e.to_s.upcase}.join(' OR ')} ON #{quote_schema_table(table)}#{' FOR EACH ROW' if opts[:each_row]}#{filter} EXECUTE PROCEDURE #{function}(#{Array(opts[:args]).map{|a| literal(a)}.join(', ')})"
+        "CREATE #{'OR REPLACE ' if opts[:replace]}TRIGGER #{name} #{whence} #{events.map{|e| e.to_s.upcase}.join(' OR ')} ON #{quote_schema_table(table)}#{' FOR EACH ROW' if opts[:each_row]}#{filter} EXECUTE PROCEDURE #{function}(#{Array(opts[:args]).map{|a| literal(a)}.join(', ')})"
       end
 
       # DDL fragment for initial part of CREATE VIEW statement
@@ -1335,7 +1336,7 @@ module Sequel
         ds = metadata_dataset.from(:pg_class).where(:relkind=>type).select(:relname).server(opts[:server]).join(:pg_namespace, :oid=>:relnamespace)
         ds = filter_schema(ds, opts)
         m = output_identifier_meth
-        if block_given?
+        if defined?(yield)
           yield(ds)
         elsif opts[:qualify]
           ds.select_append{pg_namespace[:nspname]}.map{|r| Sequel.qualify(m.call(r[:nspname]).to_s, m.call(r[:relname]).to_s)}
@@ -1727,13 +1728,22 @@ module Sequel
         ds.insert_sql(*values)
       end
 
+      # Support SQL::AliasedExpression as expr to setup a USING join with a table alias for the
+      # USING columns.
+      def join_table(type, table, expr=nil, options=OPTS, &block)
+        if expr.is_a?(SQL::AliasedExpression) && expr.expression.is_a?(Array) && !expr.expression.empty? && expr.expression.all?
+          options = options.merge(:join_using=>true)
+        end
+        super
+      end
+
       # Locks all tables in the dataset's FROM clause (but not in JOINs) with
       # the specified mode (e.g. 'EXCLUSIVE').  If a block is given, starts
       # a new transaction, locks the table, and yields.  If a block is not given,
       # just locks the tables.  Note that PostgreSQL will probably raise an error
       # if you lock the table outside of an existing transaction.  Returns nil.
       def lock(mode, opts=OPTS)
-        if block_given? # perform locking inside a transaction and yield to block
+        if defined?(yield) # perform locking inside a transaction and yield to block
           @db.transaction(opts){lock(mode, opts); yield}
         else
           sql = 'LOCK TABLE '.dup
@@ -2023,6 +2033,17 @@ module Sequel
         end
       end
 
+      # Support table aliases for USING columns
+      def join_using_clause_using_sql_append(sql, using_columns)
+        if using_columns.is_a?(SQL::AliasedExpression)
+          super(sql, using_columns.expression)
+          sql << ' AS '
+          identifier_append(sql, using_columns.alias)
+        else
+          super
+        end
+      end
+    
       # Use a generic blob quoting method, hopefully overridden in one of the subadapter methods
       def literal_blob_append(sql, v)
         sql << "'" << v.gsub(/[\000-\037\047\134\177-\377]/n){|b| "\\#{("%o" % b[0..1].unpack("C")[0]).rjust(3, '0')}"} << "'"

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

@@ -393,7 +393,7 @@ module Sequel
         old_columns = def_columns.map{|c| c[:name]}
         opts[:old_columns_proc].call(old_columns) if opts[:old_columns_proc]
 
-        yield def_columns if block_given?
+        yield def_columns if defined?(yield)
 
         constraints = (opts[:constraints] || []).dup
         pks = []

data/lib/sequel/adapters/sqlanywhere.rb

@@ -120,7 +120,7 @@ module Sequel
 
         case type
         when :select
-          yield rs if block_given?
+          yield rs if defined?(yield)
         when :rows
           return @api.sqlany_affected_rows(rs)
         when :insert

data/lib/sequel/adapters/tinytds.rb

@@ -75,7 +75,7 @@ module Sequel
                 return r.public_send(m) if m
               end
             end
-            yield(r) if block_given?
+            yield(r) if defined?(yield)
           rescue TinyTds::Error => e
             raise_error(e, :disconnect=>!c.active?)
           ensure

data/lib/sequel/ast_transformer.rb

@@ -80,6 +80,12 @@ module Sequel
         SQL::DelayedEvaluation.new(lambda{|ds| v(o.call(ds))})
       when SQL::Wrapper
         SQL::Wrapper.new(v(o.value))
+      when SQL::Expression
+        if o.respond_to?(:sequel_ast_transform)
+          o.sequel_ast_transform(method(:v))
+        else
+          o
+        end
       else
         o
       end

data/lib/sequel/database/connecting.rb

@@ -55,11 +55,11 @@ module Sequel
 
       begin
         db = c.new(opts)
-        if block_given?
+        if defined?(yield)
           return yield(db)
         end
       ensure
-        if block_given?
+        if defined?(yield)
           db.disconnect if db
           Sequel.synchronize{::Sequel::DATABASES.delete(db)}
         end

data/lib/sequel/dataset/actions.rb

@@ -546,7 +546,7 @@ module Sequel
       unless @opts[:order]
         raise Sequel::Error, "Dataset#paged_each requires the dataset be ordered"
       end
-      unless block_given?
+      unless defined?(yield)
         return enum_for(:paged_each, opts)
       end
 

data/lib/sequel/dataset/query.rb

@@ -508,6 +508,7 @@ module Sequel
     #                            argument.
     #            :implicit_qualifier :: The name to use for qualifying implicit conditions.  By default,
     #                                   the last joined or primary table is used.
+    #            :join_using :: Force the using of JOIN USING, even if +expr+ is not an array of symbols.
     #            :reset_implicit_qualifier :: Can set to false to ignore this join when future joins determine qualifier
     #                                         for implicit conditions.
     #            :qualify :: Can be set to false to not do any implicit qualification.  Can be set
@@ -541,7 +542,7 @@ module Sequel
         return s.join_table(type, ds, expr, options, &block)
       end
 
-      using_join = expr.is_a?(Array) && !expr.empty? && expr.all?{|x| x.is_a?(Symbol)}
+      using_join = options[:join_using] || (expr.is_a?(Array) && !expr.empty? && expr.all?{|x| x.is_a?(Symbol)})
       if using_join && !supports_join_using?
         h = {}
         expr.each{|e| h[e] = e}
@@ -616,7 +617,7 @@ module Sequel
     UNCONDITIONED_JOIN_TYPES.each do |jtype|
       class_eval(<<-END, __FILE__, __LINE__+1)
         def #{jtype}_join(table, opts=Sequel::OPTS)
-          raise(Sequel::Error, '#{jtype}_join does not accept join table blocks') if block_given?
+          raise(Sequel::Error, '#{jtype}_join does not accept join table blocks') if defined?(yield)
           raise(Sequel::Error, '#{jtype}_join 2nd argument should be an options hash, not conditions') unless opts.is_a?(Hash)
           join_table(:#{jtype}, table, nil, opts)
         end

data/lib/sequel/dataset/sql.rb

@@ -559,11 +559,9 @@ module Sequel
     # Append literalization of JOIN USING clause to SQL string.
     def join_using_clause_sql_append(sql, jc)
       join_clause_sql_append(sql, jc)
-      sql << ' USING ('
-      column_list_append(sql, jc.using)
-      sql << ')'
+      join_using_clause_using_sql_append(sql, jc.using) 
     end
-    
+
     # Append literalization of negative boolean constant to SQL string.
     def negative_boolean_constant_sql_append(sql, constant)
       sql << 'NOT '
@@ -1218,6 +1216,13 @@ module Sequel
       "#{join_type.to_s.gsub('_', ' ').upcase} JOIN"
     end
 
+    # Append USING clause for JOIN USING
+    def join_using_clause_using_sql_append(sql, using_columns)
+      sql << ' USING ('
+      column_list_append(sql, using_columns)
+      sql << ')'
+    end
+    
     # Append a literalization of the array to SQL string.
     # Treats as an expression if an array of all two pairs, or as a SQL array otherwise.
     def literal_array_append(sql, v)

data/lib/sequel/extensions/any_not_empty.rb

@@ -33,7 +33,7 @@ module Sequel
   module AnyNotEmpty
     # If a block is not given, return whether the dataset is not empty.
     def any?
-      if block_given?
+      if defined?(yield)
         super
       else
         !empty?

data/lib/sequel/extensions/duplicate_columns_handler.rb

@@ -44,7 +44,7 @@ module Sequel
     # :nocov:
 
     # Customize handling of duplicate columns for this dataset.
-    def on_duplicate_columns(handler = (raise Error, "Must provide either an argument or a block to on_duplicate_columns" unless block_given?; nil), &block)
+    def on_duplicate_columns(handler = (raise Error, "Must provide either an argument or a block to on_duplicate_columns" unless defined?(yield); nil), &block)
       raise Error, "Cannot provide both an argument and a block to on_duplicate_columns" if handler && block
       clone(:on_duplicate_columns=>handler||block)
     end

data/lib/sequel/extensions/inflector.rb

@@ -102,7 +102,7 @@ class String
   # Yield the Inflections module if a block is given, and return
   # the Inflections module.
   def self.inflections
-    yield Inflections if block_given?
+    yield Inflections if defined?(yield)
     Inflections
   end
   

data/lib/sequel/extensions/pagination.rb

@@ -54,7 +54,7 @@ module Sequel
     # an enumerator if no block is given.
     def each_page(page_size)
       raise(Error, "You cannot paginate a dataset that already has a limit") if @opts[:limit]
-      return to_enum(:each_page, page_size) unless block_given?
+      return to_enum(:each_page, page_size) unless defined?(yield)
       record_count = count
       total_pages = (record_count / page_size.to_f).ceil
       (1..total_pages).each{|page_no| yield paginate(page_no, page_size, record_count)}

data/lib/sequel/extensions/pg_extended_date_support.rb

@@ -83,7 +83,7 @@ module Sequel
       # If convert_infinite_timestamps is true and the value is infinite, return an appropriate
       # value based on the convert_infinite_timestamps setting.
       def to_application_timestamp(value)
-        if value.is_a?(String) && (m = value.match(/((?:[-+]\d\d:\d\d)(:\d\d)?)?( BC)?\z/)) && (m[2] || m[3])
+        if value.is_a?(String) && (m = /((?:[-+]\d\d:\d\d)(:\d\d)?)?( BC)?\z/.match(value)) && (m[2] || m[3])
           if m[3]
             value = value.sub(' BC', '').sub(' ', ' BC ')
             conv = defined?(JRUBY_VERSION) && JRUBY_VERSION == '9.2.0.0'

data/lib/sequel/extensions/pg_hstore_ops.rb

@@ -62,6 +62,19 @@
 #   # Delete a key
 #   DB[:tab].update(h: Sequel.hstore_op(:h).delete('k1'))
 #  
+# On PostgreSQL 14+, The hstore <tt>[]</tt> method will use subscripts instead of being
+# the same as +get+, if the value being wrapped is an identifer:
+#
+#   Sequel.hstore_op(:hstore_column)['a']    # hstore_column['a']
+#   Sequel.hstore_op(Sequel[:h][:s])['a']      # h.s['a']
+#
+# This support allows you to use hstore subscripts in UPDATE statements to update only
+# part of a column:
+#
+#   h = Sequel.hstore_op(:h)
+#   DB[:t].update(h['key1'] => 'val1', h['key2'] => 'val2')
+#   #  UPDATE "t" SET "h"['key1'] = 'val1', "h"['key2'] = 'val2'
+#
 # See the PostgreSQL hstore function and operator documentation for more
 # details on what these functions and operators do.
 #
@@ -114,10 +127,15 @@ module Sequel
       #
       #   hstore_op['a'] # (hstore -> 'a')
       def [](key)
-        v = Sequel::SQL::PlaceholderLiteralString.new(LOOKUP, [value, wrap_input_array(key)])
         if key.is_a?(Array) || (defined?(Sequel::Postgres::PGArray) && key.is_a?(Sequel::Postgres::PGArray)) || (defined?(Sequel::Postgres::ArrayOp) && key.is_a?(Sequel::Postgres::ArrayOp))
-          wrap_output_array(v)
+          wrap_output_array(Sequel::SQL::PlaceholderLiteralString.new(LOOKUP, [value, wrap_input_array(key)]))
         else
+          v = case @value
+          when Symbol, SQL::Identifier, SQL::QualifiedIdentifier
+            HStoreSubscriptOp.new(self, key)
+          else
+            Sequel::SQL::PlaceholderLiteralString.new(LOOKUP, [value, key])
+          end
           Sequel::SQL::StringExpression.new(:NOOP, v)
         end
       end
@@ -304,6 +322,38 @@ module Sequel
       end
     end
 
+    # Represents hstore subscripts. This is abstracted because the
+    # subscript support depends on the database version.
+    class HStoreSubscriptOp < SQL::Expression
+      SUBSCRIPT = ["".freeze, "[".freeze, "]".freeze].freeze
+
+      # The expression being subscripted
+      attr_reader :expression
+
+      # The subscript to use
+      attr_reader :sub
+
+      # Set the expression and subscript to the given arguments
+      def initialize(expression, sub)
+        @expression = expression
+        @sub = sub
+        freeze
+      end
+
+      # Use subscripts instead of -> operator on PostgreSQL 14+
+      def to_s_append(ds, sql)
+        server_version = ds.db.server_version
+        frag = server_version && server_version >= 140000 ? SUBSCRIPT : HStoreOp::LOOKUP
+        ds.literal_append(sql, Sequel::SQL::PlaceholderLiteralString.new(frag, [@expression, @sub]))
+      end
+
+      # Support transforming of hstore subscripts
+      def sequel_ast_transform(transformer)
+        self.class.new(transformer.call(@expression), transformer.call(@sub))
+      end
+    end
+
+
     module HStoreOpMethods
       # Wrap the receiver in an HStoreOp so you can easily use the PostgreSQL
       # hstore functions and operators with it.

data/lib/sequel/extensions/pg_json_ops.rb

@@ -101,6 +101,27 @@
 # substituted in +path+. +silent+ specifies whether errors are suppressed. By default,
 # errors are not suppressed.
 #
+# On PostgreSQL 14+, The JSONB <tt>[]</tt> method will use subscripts instead of being
+# the same as +get+, if the value being wrapped is an identifer:
+#
+#   Sequel.pg_jsonb_op(:jsonb_column)[1]       # jsonb_column[1]
+#   Sequel.pg_jsonb_op(:jsonb_column)[1][2]    # jsonb_column[1][2]
+#   Sequel.pg_jsonb_op(Sequel[:j][:b])[1]      # j.b[1]
+#
+# This support allows you to use JSONB subscripts in UPDATE statements to update only
+# part of a column:
+#
+#   c = Sequel.pg_jsonb_op(:c)
+#   DB[:t].update(c['key1'] => '1', c['key2'] => '"a"')
+#   #  UPDATE "t" SET "c"['key1'] = '1', "c"['key2'] = '"a"'
+#
+# Note that you have to provide the value of a JSONB subscript as a JSONB value, so this
+# will update +key1+ to use the number <tt>1</tt>, and +key2+ to use the string <tt>a</tt>.
+# For this reason it may be simpler to use +to_json+:
+#
+#   c = Sequel.pg_jsonb_op(:c)
+#   DB[:t].update(c['key1'] => 1.to_json, c['key2'] => "a".to_json)
+#
 # If you are also using the pg_json extension, you should load it before
 # loading this extension.  Doing so will allow you to use the #op method on
 # JSONHash, JSONHarray, JSONBHash, and JSONBArray, allowing you to perform json/jsonb operations
@@ -323,6 +344,24 @@ module Sequel
       PATH_EXISTS = ["(".freeze, " @? ".freeze, ")".freeze].freeze
       PATH_MATCH = ["(".freeze, " @@ ".freeze, ")".freeze].freeze
 
+      # Support subscript syntax for JSONB.
+      def [](key)
+        if is_array?(key)
+          super
+        else
+          case @value
+          when Symbol, SQL::Identifier, SQL::QualifiedIdentifier, JSONBSubscriptOp
+            # Only use subscripts for identifiers.  In other cases, switching from
+            # the -> operator to [] for subscripts causes SQL syntax issues.  You
+            # only need the [] for subscripting when doing assignment, and
+            # assignment is generally done on identifiers.
+            self.class.new(JSONBSubscriptOp.new(self, key))
+          else
+            super
+          end
+        end
+      end
+
       # jsonb expression for deletion of the given argument from the
       # current jsonb.
       #
@@ -582,6 +621,37 @@ module Sequel
       end
     end
 
+    # Represents JSONB subscripts. This is abstracted because the
+    # subscript support depends on the database version.
+    class JSONBSubscriptOp < SQL::Expression
+      SUBSCRIPT = ["".freeze, "[".freeze, "]".freeze].freeze
+
+      # The expression being subscripted
+      attr_reader :expression
+
+      # The subscript to use
+      attr_reader :sub
+
+      # Set the expression and subscript to the given arguments
+      def initialize(expression, sub)
+        @expression = expression
+        @sub = sub
+        freeze
+      end
+
+      # Use subscripts instead of -> operator on PostgreSQL 14+
+      def to_s_append(ds, sql)
+        server_version = ds.db.server_version
+        frag = server_version && server_version >= 140000 ? SUBSCRIPT : JSONOp::GET
+        ds.literal_append(sql, Sequel::SQL::PlaceholderLiteralString.new(frag, [@expression, @sub]))
+      end
+
+      # Support transforming of jsonb subscripts
+      def sequel_ast_transform(transformer)
+        self.class.new(transformer.call(@expression), transformer.call(@sub))
+      end
+    end
+
     module JSONOpMethods
       # Wrap the receiver in an JSONOp so you can easily use the PostgreSQL
       # json functions and operators with it.

data/lib/sequel/extensions/string_agg.rb

@@ -147,7 +147,7 @@ module Sequel
       def initialize(expr, separator=nil)
         @expr = expr
         @separator = separator
-        yield self if block_given?
+        yield self if defined?(yield)
         freeze
       end
 

data/lib/sequel/model/base.rb

@@ -1093,7 +1093,7 @@ module Sequel
         @modified = true
         initialize_set(values)
         _clear_changed_columns(:initialize)
-        yield self if block_given?
+        yield self if defined?(yield)
       end
 
       # Returns value of the column's attribute.

data/lib/sequel/model/inflections.rb

@@ -4,7 +4,7 @@ module Sequel
   # Yield the Inflections module if a block is given, and return
   # the Inflections module.
   def self.inflections
-    yield Inflections if block_given?
+    yield Inflections if defined?(yield)
     Inflections
   end
 

data/lib/sequel/plugins/auto_validations.rb

@@ -71,12 +71,14 @@ module Sequel
       MAX_LENGTH_OPTIONS = {:from=>:values, :allow_nil=>true}.freeze
       SCHEMA_TYPES_OPTIONS = NOT_NULL_OPTIONS
       UNIQUE_OPTIONS = NOT_NULL_OPTIONS
+      NO_NULL_BYTE_OPTIONS = MAX_LENGTH_OPTIONS
       EMPTY_ARRAY = [].freeze
 
       def self.apply(model, opts=OPTS)
         model.instance_exec do
           plugin :validation_helpers
           @auto_validate_presence = false
+          @auto_validate_no_null_byte_columns = []
           @auto_validate_not_null_columns = []
           @auto_validate_explicit_not_null_columns = []
           @auto_validate_max_length_columns = []
@@ -84,6 +86,7 @@ module Sequel
           @auto_validate_types = true
 
           @auto_validate_options = {
+              :no_null_byte=>NO_NULL_BYTE_OPTIONS,
               :not_null=>NOT_NULL_OPTIONS,
               :explicit_not_null=>EXPLICIT_NOT_NULL_OPTIONS,
               :max_length=>MAX_LENGTH_OPTIONS,
@@ -102,14 +105,14 @@ module Sequel
           end
 
           h = @auto_validate_options.dup
-          [:not_null, :explicit_not_null, :max_length, :schema_types, :unique].each do |type|
+          [:not_null, :explicit_not_null, :max_length, :no_null_byte, :schema_types, :unique].each do |type|
             if type_opts = opts[:"#{type}_opts"]
               h[type] = h[type].merge(type_opts).freeze
             end
           end
 
           if opts[:skip_invalid]
-            [:not_null, :explicit_not_null, :max_length, :schema_types].each do |type|
+            [:not_null, :explicit_not_null, :no_null_byte, :max_length, :schema_types].each do |type|
               h[type] = h[type].merge(:skip_invalid=>true).freeze
             end
           end
@@ -119,6 +122,9 @@ module Sequel
       end
 
       module ClassMethods
+        # The columns with automatic no_null_byte validations
+        attr_reader :auto_validate_no_null_byte_columns
+
         # The columns with automatic not_null validations
         attr_reader :auto_validate_not_null_columns
 
@@ -135,7 +141,15 @@ module Sequel
         # Inherited options
         attr_reader :auto_validate_options
 
-        Plugins.inherited_instance_variables(self, :@auto_validate_presence=>nil, :@auto_validate_types=>nil, :@auto_validate_not_null_columns=>:dup, :@auto_validate_explicit_not_null_columns=>:dup, :@auto_validate_max_length_columns=>:dup, :@auto_validate_unique_columns=>:dup, :@auto_validate_options => :dup)
+        Plugins.inherited_instance_variables(self,
+          :@auto_validate_presence=>nil,
+          :@auto_validate_types=>nil,
+          :@auto_validate_no_null_byte_columns=>:dup,
+          :@auto_validate_not_null_columns=>:dup,
+          :@auto_validate_explicit_not_null_columns=>:dup,
+          :@auto_validate_max_length_columns=>:dup,
+          :@auto_validate_unique_columns=>:dup,
+          :@auto_validate_options => :dup)
         Plugins.after_set_dataset(self, :setup_auto_validations)
 
         # Whether to use a presence validation for not null columns
@@ -150,6 +164,7 @@ module Sequel
 
         # Freeze auto_validation settings when freezing model class.
         def freeze
+          @auto_validate_no_null_byte_columns.freeze
           @auto_validate_not_null_columns.freeze
           @auto_validate_explicit_not_null_columns.freeze
           @auto_validate_max_length_columns.freeze
@@ -158,12 +173,13 @@ module Sequel
           super
         end
 
-        # Skip automatic validations for the given validation type (:not_null, :types, :unique).
+        # Skip automatic validations for the given validation type
+        # (:not_null, :types, :unique, :max_length, :no_null_byte).
         # If :all is given as the type, skip all auto validations.
         def skip_auto_validations(type)
           case type
           when :all
-            [:not_null, :types, :unique, :max_length].each{|v| skip_auto_validations(v)}
+            [:not_null, :no_null_byte, :types, :unique, :max_length].each{|v| skip_auto_validations(v)}
           when :not_null
             auto_validate_not_null_columns.clear
             auto_validate_explicit_not_null_columns.clear
@@ -183,6 +199,7 @@ module Sequel
           explicit_not_null_cols += Array(primary_key)
           @auto_validate_explicit_not_null_columns = explicit_not_null_cols.uniq
           @auto_validate_max_length_columns = db_schema.select{|col, sch| sch[:type] == :string && sch[:max_length].is_a?(Integer)}.map{|col, sch| [col, sch[:max_length]]}
+          @auto_validate_no_null_byte_columns = db_schema.select{|_, sch| sch[:type] == :string}.map{|col, _| col}
           table = dataset.first_source_table
           @auto_validate_unique_columns = if db.supports_index_parsing? && [Symbol, SQL::QualifiedIdentifier, SQL::Identifier, String].any?{|c| table.is_a?(c)}
             db.indexes(table).select{|name, idx| idx[:unique] == true}.map{|name, idx| idx[:columns].length == 1 ? idx[:columns].first : idx[:columns]}
@@ -209,6 +226,9 @@ module Sequel
           return if skip.include?(:all)
           opts = model.auto_validate_options
 
+          unless skip.include?(:no_null_byte) || (no_null_byte_columns = model.auto_validate_no_null_byte_columns).empty?
+            validates_no_null_byte(no_null_byte_columns, opts[:no_null_byte])
+          end
 
           unless skip.include?(:not_null)
             not_null_method = model.auto_validate_presence? ? :validates_presence : :validates_not_null

data/lib/sequel/plugins/column_encryption.rb

@@ -608,7 +608,7 @@ module Sequel
 
         # Setup encryption for the given column.
         def _encrypt_column(column, opts)
-          cryptor ||= if block_given?
+          cryptor ||= if defined?(yield)
             dsl = ColumnDSL.new
             yield dsl
             Cryptor.new(dsl.keys)

data/lib/sequel/plugins/json_serializer.rb

@@ -365,7 +365,7 @@ module Sequel
             h = {root => h}
           end
 
-          h = yield h if block_given?
+          h = yield h if defined?(yield)
           Sequel.object_to_json(h, *a)
         end
 
@@ -441,7 +441,7 @@ module Sequel
           end
 
           res = {collection_root => res} if collection_root
-          res = yield res if block_given?
+          res = yield res if defined?(yield)
 
           Sequel.object_to_json(res, *a)
         end

data/lib/sequel/plugins/static_cache.rb

@@ -87,7 +87,7 @@ module Sequel
         # array containing the number of instances specified (single integer
         # argument).
         def first(*args)
-          if block_given? || args.length > 1 || (args.length == 1 && !args[0].is_a?(Integer))
+          if defined?(yield) || args.length > 1 || (args.length == 1 && !args[0].is_a?(Integer))
             super
           else
             @all.first(*args)

data/lib/sequel/plugins/update_or_create.rb

@@ -55,7 +55,7 @@ module Sequel
         def find_or_new(attrs, set_attrs=nil)
           obj = find(attrs) || new(attrs)
           obj.set(set_attrs) if set_attrs
-          yield obj if block_given?
+          yield obj if defined?(yield)
           obj
         end
       end

data/lib/sequel/plugins/validation_helpers.rb

@@ -85,6 +85,7 @@ module Sequel
         :max_length=>{:message=>lambda{|max| "is longer than #{max} characters"}, :nil_message=>lambda{"is not present"}},
         :min_length=>{:message=>lambda{|min| "is shorter than #{min} characters"}},
         :not_null=>{:message=>lambda{"is not present"}},
+        :no_null_byte=>{:message=>lambda{"contains a null byte"}},
         :numeric=>{:message=>lambda{"is not a number"}},
         :operator=>{:message=>lambda{|operator, rhs| "is not #{operator} #{rhs}"}},
         :type=>{:message=>lambda{|klass| klass.is_a?(Array) ? "is not a valid #{klass.join(" or ").downcase}" : "is not a valid #{klass.to_s.downcase}"}},
@@ -149,6 +150,11 @@ module Sequel
         def validates_not_null(atts, opts=OPTS)
           validatable_attributes_for_type(:not_null, atts, opts){|a,v,m| validation_error_message(m) if v.nil?}
         end
+
+        # Check attribute value(s) does not contain a null ("\0", ASCII NUL) byte.
+        def validates_no_null_byte(atts, opts=OPTS)
+          validatable_attributes_for_type(:no_null_byte, atts, opts){|a,v,m| validation_error_message(m) if String === v && v.include?("\0")}
+        end
         
         # Check attribute value(s) string representation is a valid float.
         def validates_numeric(atts, opts=OPTS)
@@ -260,7 +266,7 @@ module Sequel
               next if vals.any?(&:nil?)
               ds.where(arr.zip(vals))
             end
-            ds = yield(ds) if block_given?
+            ds = yield(ds) if defined?(yield)
             unless new?
               h = ds.joined_dataset? ? qualified_pk_hash : pk_hash
               ds = ds.exclude(h)

data/lib/sequel/plugins/xml_serializer.rb

@@ -359,7 +359,7 @@ module Sequel
             else
               Array(inc).each{|i| to_xml_include(x1, i)}
             end
-            yield x1 if block_given?
+            yield x1 if defined?(yield)
           end
           x.to_xml
         end

data/lib/sequel/sql.rb

@@ -467,7 +467,7 @@ module Sequel
       #
       #   Sequel[1] - :a # SQL: (1 - a)
       def expr(arg=(no_arg=true), &block)
-        if block_given?
+        if defined?(yield)
           if no_arg
             return expr(block)
           else

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 = 48
+  MINOR = 49
 
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel
 version: !ruby/object:Gem::Version
-  version: 5.48.0
+  version: 5.49.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -192,6 +192,7 @@ extra_rdoc_files:
 - doc/release_notes/5.46.0.txt
 - doc/release_notes/5.47.0.txt
 - doc/release_notes/5.48.0.txt
+- doc/release_notes/5.49.0.txt
 - doc/release_notes/5.5.0.txt
 - doc/release_notes/5.6.0.txt
 - doc/release_notes/5.7.0.txt
@@ -268,6 +269,7 @@ files:
 - doc/release_notes/5.46.0.txt
 - doc/release_notes/5.47.0.txt
 - doc/release_notes/5.48.0.txt
+- doc/release_notes/5.49.0.txt
 - doc/release_notes/5.5.0.txt
 - doc/release_notes/5.6.0.txt
 - doc/release_notes/5.7.0.txt