arel_extensions 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec5e40945328be87eb2078d58b5bbe144f9927f76f44d636b207e9c79ed8d083
-  data.tar.gz: a829d89fbafe6717a773b3cd1deb4a86c4a230d30b712f8dc9c2d87967fb325d
+  metadata.gz: bec346d9bbce78a1d91d023e0291903cb1c61b115237681cb4d9b4174e5f370a
+  data.tar.gz: b2e307f12bdb154129d29179093a04e1c7cd632feb2ed4d5e706a97acbfd0526
 SHA512:
-  metadata.gz: 868227bed38916facdf1f48b0961b48a41bcfb65a5741c17947e73fa3e28d7c9b01ccef238396f1b23288d3ca12dd5c4dfdbedcf9a900dd17efe08dc1e3ef139
-  data.tar.gz: a8843d2c5a52ea04a9b0b46bf6b4563697829cd2ea63b39c23fdf2d4790c8e25902d302165392997c617ab13c06b5465f560b4de185a4152804ed493df8c8246
+  metadata.gz: 90fc4233e4699e6a7da8d7141351f21d1d33d72d9f3220a2b47f5f9e425bca147be2db7a1f062696b17b593cb5191bf5fe75be2f68022139c4e7fce6021a43a9
+  data.tar.gz: 5c49180d1bb19d6ad2338a509811010c0749bcb6beda93c9d1d8e68c46f4316bd9bf3cc22768695bf790c2d4f6ddd68d7378819dbf10ad38823cf55030c3aff9

data/NEWS.md

@@ -2,14 +2,19 @@
 
 ## [unreleased]
 
+## Release v2.3.0/v1.5.0 (19-12-2024)
+
+- Use ActiveSupport's deprecation machinery instead of Ruby's Warning module.
+- Fix a bug with group concat that didn't correctly check for the separator value.
+
 ## Release v2.2.2/v1.4.2 (27-11-2024)
 
-- Fix deprecartion warnings for `==` and `!=`, showing the true location.
-- Always emit deprecartion warnings for `==` and `!=`.
+- Fix deprecation warnings for `==` and `!=`, showing the true location.
+- Always emit deprecation warnings for `==` and `!=`.
 
 ## Release v2.2.1/v1.4.1 (08-11-2024)
 
-- Improved deprecartion warnings for `==` and `!=`, showing the location where they're called.
+- Improved deprecation warnings for `==` and `!=`, showing the location where they're called.
 
 ## Release v2.2.0/v1.4.0
 

data/gemfiles/rails6_1.gemfile

@@ -28,6 +28,14 @@ group :development, :test do
   gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
   gem 'jdbc-mssql', platforms: :jruby, require: true
   gem 'jdbc-sqlite3', platforms: :jruby
+
+  # Ruby 3.4+ removes the following gems from the standard distribution.
+  # Warnings are emitted from 3.3 .
+  if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('3.3.0')
+    gem 'base64'
+    gem 'bigdecimal'
+    gem 'mutex_m'
+  end
 end
 
 gemspec path: Dir.pwd

data/gemfiles/rails7.gemfile

@@ -28,6 +28,14 @@ group :development, :test do
   gem 'activerecord-jdbcmysql-adapter', platforms: :jruby
   gem 'activerecord-jdbcpostgresql-adapter', platforms: :jruby
   gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+
+  # Ruby 3.4+ removes the following gems from the standard distribution.
+  # Warnings are emitted from 3.3 .
+  if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('3.3.0')
+    gem 'base64'
+    gem 'bigdecimal'
+    gem 'mutex_m'
+  end
 end
 
 gemspec path: Dir.pwd

data/gemfiles/rails7_1.gemfile

@@ -22,12 +22,21 @@ group :development, :test do
   gem 'activerecord-oracle_enhanced-adapter', '~> 7.0.0' if ENV.has_key? 'ORACLE_HOME'
 
   # for JRuby
+  gem 'jar-dependencies', '0.4.1', platforms: :jruby
   gem 'jdbc-mssql', platforms: :jruby, require: true
   gem 'jdbc-sqlite3', platform: :jruby
   gem 'activerecord-jdbc-alt-adapter', '~> 71.0.0.alpha1', platform: :jruby, require: true
   gem 'activerecord-jdbcmysql-adapter', platforms: :jruby
   gem 'activerecord-jdbcpostgresql-adapter', platforms: :jruby
   gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+
+  # Ruby 3.4+ removes the following gems from the standard distribution.
+  # Warnings are emitted from 3.3 .
+  if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('3.3.0')
+    gem 'base64'
+    gem 'bigdecimal'
+    gem 'mutex_m'
+  end
 end
 
 gemspec path: Dir.pwd

data/gemfiles/rails7_2.gemfile

@@ -28,6 +28,14 @@ group :development, :test do
   gem 'activerecord-jdbcmysql-adapter', platforms: :jruby
   gem 'activerecord-jdbcpostgresql-adapter', platforms: :jruby
   gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+
+  # Ruby 3.4+ removes the following gems from the standard distribution.
+  # Warnings are emitted from 3.3 .
+  if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('3.3.0')
+    gem 'base64'
+    gem 'bigdecimal'
+    gem 'mutex_m'
+  end
 end
 
 gemspec path: Dir.pwd

data/lib/arel_extensions/attributes.rb

@@ -17,18 +17,15 @@ module ArelExtensions
     include ArelExtensions::NullFunctions
     include ArelExtensions::StringFunctions
     include ArelExtensions::Predications
+    include ArelExtensions::Warning
 
     def ==(other)
-      if Gem::Version.create(ArelExtensions::VERSION) >= Gem::Version.create('2.2')
-        warn("#{caller(1..1).first} arel_extensions: `==` is now deprecated and will be removed soon. Use `.eq` instead.")
-      end
+      deprecated 'Use `.eq` instead.' if Gem::Version.create(ArelExtensions::VERSION) >= Gem::Version.create('2.2')
       Arel::Nodes::Equality.new self, Arel.quoted(other, self)
     end
 
     def !=(other)
-      if Gem::Version.create(ArelExtensions::VERSION) >= Gem::Version.create('2.2')
-        warn("#{caller(1..1).first} arel_extensions: `!=` is now deprecated and will be removed soon. Use `.not_eq` instead.")
-      end
+      deprecated 'Use `.not_eq` instead.' if Gem::Version.create(ArelExtensions::VERSION) >= Gem::Version.create('2.2')
       Arel::Nodes::NotEqual.new self, Arel.quoted(other, self)
     end
   end

data/lib/arel_extensions/nodes/aggregate_function.rb

@@ -4,8 +4,8 @@ module ArelExtensions
       attr_accessor :order, :group
 
       def initialize node, **opts
-        @order = Array(opts[:order]).map{|e| convert_to_node(e)}
-        @group = Array(opts[:group]).map{|e| convert_to_node(e)}
+        @order = Array.wrap(opts[:order]).map{|e| convert_to_node(e)}
+        @group = Array.wrap(opts[:group]).map{|e| convert_to_node(e)}
         super [node]
       end
     end

data/lib/arel_extensions/nodes/function.rb

@@ -1,5 +1,11 @@
 require 'arel_extensions/predications'
 
+# This is required for rails 6.1
+# See https://github.com/thoughtbot/shoulda-matchers/issues/335
+if !Array.respond_to?(:wrap)
+  require 'active_support/core_ext/array/wrap'
+end
+
 module ArelExtensions
   module Nodes
     class Function < Arel::Nodes::Function

data/lib/arel_extensions/nodes/rollup.rb

@@ -3,7 +3,7 @@
 
 begin
   Arel::Nodes.const_get('RollUp')
-rescue NameError => e
+rescue NameError => _
   module Arel
     module Nodes
       class RollUp < Arel::Nodes::Unary

data/lib/arel_extensions/string_functions.rb

@@ -144,7 +144,7 @@ module ArelExtensions
     # concat elements of a group, separated by sep and ordered by a list of Ascending or Descending
     def group_concat(sep = nil, *orders, group: nil, order: nil)
       if orders.present?
-        warn("Warning: ArelExtensions: group_concat: you should now use the kwarg 'order' to specify an order in the group_concat.")
+        deprecated 'Use the kwarg `order` instead.', what: 'orders'
       end
       order_tabs = [orders].flatten.map{ |o|
         if o.is_a?(Arel::Nodes::Ascending) || o.is_a?(Arel::Nodes::Descending)

data/lib/arel_extensions/version.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = '2.2.2'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/lib/arel_extensions/visitors/mssql.rb

@@ -608,13 +608,13 @@ module ArelExtensions
         grouping_array_or_grouping_element o, collector
       end
 
-      # TODO;
       def visit_ArelExtensions_Nodes_GroupConcat o, collector
         collector << '(STRING_AGG('
         collector = visit o.left, collector
         collector << Arel::Visitors::Oracle::COMMA
+        sep = o.separator.is_a?(Arel::Nodes::Quoted) ? o.separator.expr : o.separator
         collector =
-          if o.separator && o.separator != 'NULL'
+          if 'NULL' != sep
             visit o.separator, collector
           else
             visit Arel.quoted(','), collector

data/lib/arel_extensions/visitors/mysql.rb

@@ -16,7 +16,7 @@ module ArelExtensions
 
       # This helper method did not exist in rails < 5.2
       if !Arel::Visitors::MySQL.method_defined?(:collect_nodes_for)
-        def collect_nodes_for(nodes, collector, spacer, connector = ", ")
+        def collect_nodes_for(nodes, collector, spacer, connector = ', ')
           if nodes&.any?
             collector << spacer
             inject_join nodes, collector, connector
@@ -24,42 +24,45 @@ module ArelExtensions
         end
       end
 
-        # The whole purpose of this override is to fix the behavior of RollUp.
-        # All other databases treat RollUp sanely, execpt MySQL which requires
-        # that it figures as the last element of a GROUP BY.
-        def visit_Arel_Nodes_SelectCore(o, collector)
-          collector << "SELECT"
+      if private_method_defined?(:visit_Arel_Nodes_SelectCore) || method_defined?(:visit_Arel_Nodes_SelectCore)
+        alias_method(:old_visit_Arel_Nodes_SelectCore, :visit_Arel_Nodes_SelectCore)
+      end
+      # The whole purpose of this override is to fix the behavior of RollUp.
+      # All other databases treat RollUp sanely, execpt MySQL which requires
+      # that it figures as the last element of a GROUP BY.
+      def visit_Arel_Nodes_SelectCore(o, collector)
+        collector << 'SELECT'
 
-          collector = collect_optimizer_hints(o, collector) if self.respond_to?(:collect_optimizer_hinsts)
-          collector = maybe_visit o.set_quantifier, collector
+        collector = collect_optimizer_hints(o, collector) if self.respond_to?(:collect_optimizer_hinsts)
+        collector = maybe_visit o.set_quantifier, collector
 
-          collect_nodes_for o.projections, collector, " "
+        collect_nodes_for o.projections, collector, ' '
 
-          if o.source && !o.source.empty?
-            collector << " FROM "
-            collector = visit o.source, collector
-          end
+        if o.source && !o.source.empty?
+          collector << ' FROM '
+          collector = visit o.source, collector
+        end
 
-          # The actual work
-          groups = o.groups
-          rollup = groups.select { |g| g.expr.class == Arel::Nodes::RollUp }.map { |r| r.expr.value }
-          if rollup && !rollup.empty?
-            groups = o.groups.reject { |g| g.expr.class == Arel::Nodes::RollUp }
-            groups << Arel::Nodes::RollUp.new(rollup)
-          end
-          # FIN
+        # The actual work
+        groups = o.groups
+        rollup = groups.select { |g| g.expr.class == Arel::Nodes::RollUp }.map { |r| r.expr.value }
+        if rollup && !rollup.empty?
+          groups = o.groups.reject { |g| g.expr.class == Arel::Nodes::RollUp }
+          groups << Arel::Nodes::RollUp.new(rollup)
+        end
+        # FIN
 
-          collect_nodes_for o.wheres, collector, " WHERE ", " AND "
-          collect_nodes_for groups, collector, " GROUP BY "            # Look ma, I'm viring a group
-          collect_nodes_for o.havings, collector, " HAVING ", " AND "
-          collect_nodes_for o.windows, collector, " WINDOW "
+        collect_nodes_for o.wheres, collector, ' WHERE ', ' AND '
+        collect_nodes_for groups, collector, ' GROUP BY '
+        collect_nodes_for o.havings, collector, ' HAVING ', ' AND '
+        collect_nodes_for o.windows, collector, ' WINDOW '
 
-          if o.respond_to?(:comment)
-            maybe_visit o.comment, collector 
-          else
-            collector
-          end
+        if o.respond_to?(:comment)
+          maybe_visit o.comment, collector
+        else
+          collector
         end
+      end
 
       # Math functions
       def visit_ArelExtensions_Nodes_Log10 o, collector
@@ -199,7 +202,8 @@ module ArelExtensions
             collector = visit order, collector
           end
         end
-        if o.separator && o.separator != 'NULL'
+        sep = o.separator.is_a?(Arel::Nodes::Quoted) ? o.separator.expr : o.separator
+        if 'NULL' != sep
           collector << ' SEPARATOR '
           collector = visit o.separator, collector
         end

data/lib/arel_extensions/visitors/oracle.rb

@@ -135,8 +135,9 @@ module ArelExtensions
         collector << '(LISTAGG('
         collector = visit o.left, collector
         collector << COMMA
+        sep = o.separator.is_a?(Arel::Nodes::Quoted) ? o.separator.expr : o.separator
         collector =
-          if o.separator && o.separator != 'NULL'
+          if 'NULL' != sep
             visit o.separator, collector
           else
             visit Arel.quoted(','), collector

data/lib/arel_extensions/visitors/postgresql.rb

@@ -136,8 +136,9 @@ module ArelExtensions
         o.order = nil
         visit_Aggregate_For_AggregateFunction o, collector
         collector << COMMA
+        sep = o.separator.is_a?(Arel::Nodes::Quoted) ? o.separator.expr : o.separator
         collector =
-          if o.separator && o.separator != 'NULL'
+          if 'NULL' != sep
             visit o.separator, collector
           else
             visit Arel.quoted(','), collector

data/lib/arel_extensions/visitors/to_sql.rb

@@ -112,7 +112,8 @@ module ArelExtensions
       def visit_ArelExtensions_Nodes_GroupConcat o, collector
         collector << 'GROUP_CONCAT('
         collector = visit o.left, collector
-        if o.separator && o.separator != 'NULL'
+        sep = o.separator.is_a?(Arel::Nodes::Quoted) ? o.separator.expr : o.separator
+        if 'NULL' != sep
           collector << COMMA
           collector = visit o.separator, collector
         end

data/lib/arel_extensions/warning.rb

@@ -0,0 +1,15 @@
+module ArelExtensions
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new(ArelExtensions::VERSION, "arel_extensions")
+  end
+
+  module Warning
+    def deprecated msg, what: nil
+      kaller = caller(2..2).first
+      return if kaller.include?('lib/arel_extensions') && ENV['AREL_EXTENSIONS_IN_TEST'] != '1'
+
+      what = caller_locations(1, 1).first.label if what.nil?
+      ArelExtensions.deprecator.warn "#{kaller}: `#{what}` is now deprecated. #{msg}"
+    end
+  end
+end

data/lib/arel_extensions.rb

@@ -52,6 +52,7 @@ if Gem::Version.new(Arel::VERSION) >= Gem::Version.new('7.1.0')
   end
 end
 
+require 'arel_extensions/warning'
 require 'arel_extensions/helpers'
 require 'arel_extensions/version'
 require 'arel_extensions/aliases'
@@ -256,6 +257,7 @@ class Arel::SelectManager
   include ArelExtensions::SetFunctions
   include ArelExtensions::Nodes
 
+  remove_method(:as) if method_defined?(:as)
   def as table_name
     Arel::Nodes::TableAlias.new(self, table_name)
   end

data/test/arelx_test_helper.rb

@@ -6,6 +6,8 @@ require 'active_record'
 
 require 'support/fake_record'
 
+ENV['AREL_EXTENSIONS_IN_TEST'] = '1' # Useful for deprecation warnings.
+
 def colored(color, msg)
   /^xterm|-256color$/.match?(ENV['TERM']) ? "\x1b[#{color}m#{msg}\x1b[89m\x1b[0m" : "#{msg}"
 end
@@ -40,6 +42,22 @@ db_and_gem =
     }
   end
 
+module Warning
+  ARELX_IGNORED = [
+    'PG::Coder.new(hash)',
+    'rb_check_safe_obj',       # ruby 3.0
+    'rb_tainted_str_new',      # ruby 3.0
+    'Using the last argument', # ruby < 3.0
+  ].freeze
+
+  def self.warn(message)
+    return if ARELX_IGNORED.any? { |msg| message.include?(msg) }
+
+    super
+  end
+end
+
+
 def load_lib(gems)
   if gems && (RUBY_PLATFORM == 'java' || Arel::VERSION.to_i > 9)
     gems.each do |gem|

data/test/with_ar/all_agnostic_test.rb

@@ -242,10 +242,10 @@ module ArelExtensions
         assert_equal 'Lucas,Sophie', t(User.where(name: %w[Lucas Sophie]), @name.group_concat)
 
         skip 'No order in group_concat in SqlLite' if $sqlite
-        assert_equal 'Arthur,Lucas,Sophie', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', @name.asc))
-        assert_equal 'Sophie,Lucas,Arthur', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', @name.desc))
-        assert_equal 'Lucas,Sophie,Arthur', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', [@score.asc, @name.asc]))
-        assert_equal 'Lucas,Sophie,Arthur', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', @score.asc, @name.asc))
+        assert_equal 'Arthur,Lucas,Sophie', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', order: @name.asc))
+        assert_equal 'Sophie,Lucas,Arthur', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', order: @name.desc))
+        assert_equal 'Lucas,Sophie,Arthur', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', order: [@score.asc, @name.asc]))
+        assert_equal 'Lucas,Sophie,Arthur', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', order: [@score.asc, @name.asc]))
         assert_equal 'Lucas,Sophie,Arthur', t(User.where(name: %w[Lucas Sophie Arthur]), @name.group_concat(',', order: [@score.asc, @name.asc]))
       end
 

data/version_v1.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = '1.4.2'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/version_v2.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = '2.2.2'.freeze
+  VERSION = '2.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arel_extensions
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Yann Azoury
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -179,6 +179,7 @@ files:
 - lib/arel_extensions/visitors/postgresql.rb
 - lib/arel_extensions/visitors/sqlite.rb
 - lib/arel_extensions/visitors/to_sql.rb
+- lib/arel_extensions/warning.rb
 - test/arelx_test_helper.rb
 - test/database.yml
 - test/real_db_test.rb