arel_extensions 2.3.2 → 2.4.0

data/init/postgresql.sql

@@ -1,18 +1,17 @@
-CREATE OR REPLACE FUNCTION public.find_in_set(n INTEGER, s TEXT)
+CREATE OR REPLACE FUNCTION public.find_in_set(n TEXT, s TEXT)
  RETURNS INT4
  LANGUAGE sql
 AS $function$
     SELECT * FROM (
       select int4(z.row_number) from (
         select row_number() over(), y.x
-        from (select unnest(('{' || $2 || '}')::int[]) as x) as y
+        from (select unnest(regexp_split_to_array($2, ',')) as x) as y -- use string_to_array if on pg 14+.
       ) as z
       where z.x = $1
     UNION ALL
       SELECT 0) z
     LIMIT 1
-$function$
-;
+$function$;
 
 CREATE OR REPLACE FUNCTION public.levenshtein_distance(s text, t text)
 RETURNS integer AS $$

data/lib/arel_extensions/comparators.rb

@@ -25,6 +25,8 @@ module ArelExtensions
       #      end
     end
 
+    alias regex_matches =~
+
     # NOT_REGEXP function
     # Negation of Regexp
     def !~(other)

data/lib/arel_extensions/constants.rb

@@ -0,0 +1,13 @@
+module ArelExtensions
+  ACTIVE_RECORD_VERSION = Gem::Version.new(ActiveRecord::VERSION::STRING).freeze
+  AREL_VERSION = Gem::Version.new(Arel::VERSION).freeze
+  V10 = Gem::Version.new('10.0').freeze
+  V5 = Gem::Version.new('5.0').freeze
+  V6 = Gem::Version.new('6.0').freeze
+  V7 = Gem::Version.new('7.0').freeze
+  V7_0 = Gem::Version.new('7.0').freeze
+  V7_1 = Gem::Version.new('7.1').freeze
+  V7_2 = Gem::Version.new('7.2').freeze
+  V8_1 = Gem::Version.new('8.1').freeze
+  V9_0 = Gem::Version.new('9.0').freeze
+end

data/lib/arel_extensions/helpers.rb

@@ -1,5 +1,4 @@
 module ArelExtensions
-
   #
   # column_of
   #
@@ -34,13 +33,13 @@ module ArelExtensions
       column_of_via_arel_table(table_name, column_name)
     else
       if pool.respond_to?(:pool_config)
-        if pool.pool_config.respond_to?(:schema_reflection) # activerecord >= 7.1
-          if ActiveRecord.version >= Gem::Version.create('7.2')
+        if pool.pool_config.respond_to?(:schema_reflection)
+          if ACTIVE_RECORD_VERSION >= V7_2
             pool.pool_config.schema_reflection.columns_hash(pool, table_name)[column_name]
           else
             pool.pool_config.schema_reflection.columns_hash(ActiveRecord::Base.connection, table_name)[column_name]
           end
-        else # activerecord < 7.1
+        else
           pool.pool_config.schema_cache.columns_hash(table_name)[column_name]
         end
       elsif pool.respond_to?(:schema_cache) # activerecord < 6.1

data/lib/arel_extensions/math_functions.rb

@@ -71,7 +71,7 @@ module ArelExtensions
     end
 
     def sum opts = {unbiased: true}
-      if Gem::Version.new(Arel::VERSION) >= Gem::Version.new('9.0.0')
+      if AREL_VERSION >= V9_0
         Arel::Nodes::Sum.new [self]
       else
         ArelExtensions::Nodes::Sum.new self, **opts

data/lib/arel_extensions/nodes/byte_size.rb

@@ -0,0 +1,11 @@
+module ArelExtensions
+  module Nodes
+    class ByteSize < Function
+      RETURN_TYPE = :integer
+
+      def initialize(node)
+        super([node])
+      end
+    end
+  end
+end

data/lib/arel_extensions/nodes/case.rb

@@ -1,6 +1,6 @@
 module ArelExtensions
   module Nodes
-    if Gem::Version.new(Arel::VERSION) < Gem::Version.new('7.1.0')
+    if AREL_VERSION < V7_1
       class Case < Arel::Nodes::Node
         include Arel::Expressions
         include Arel::Math

data/lib/arel_extensions/nodes/char_length.rb

@@ -0,0 +1,11 @@
+module ArelExtensions
+  module Nodes
+    class CharLength < Function
+      RETURN_TYPE = :integer
+
+      def initialize(node)
+        super([node])
+      end
+    end
+  end
+end

data/lib/arel_extensions/nodes/function.rb

@@ -28,9 +28,7 @@ module ArelExtensions
 
       def as other
         res = Arel::Nodes::As.new(self.clone, Arel.sql(other))
-        if Gem::Version.new(Arel::VERSION) >= Gem::Version.new('9.0.0')
-          self.alias = Arel.sql(other)
-        end
+        self.alias = Arel.sql(other)
         res
       end
 

data/lib/arel_extensions/nodes/matches.rb

@@ -1,11 +1,11 @@
 module ArelExtensions
   module Nodes
     class IMatches < Arel::Nodes::Matches
-      attr_accessor :case_sensitive if Arel::VERSION.to_i < 7
+      attr_accessor :case_sensitive if AREL_VERSION < V7
 
       def initialize(left, right, escape = nil)
         r = Arel.quoted(right)
-        if Arel::VERSION.to_i < 7 # managed by default in version 7+ (rails 5), so useful for rails 3 & 4
+        if AREL_VERSION < V7 # managed by default in version 7+ (rails 5), so useful for rails 3 & 4
           super(left, r, escape)
           @case_sensitive = false
         else

data/lib/arel_extensions/predications.rb

@@ -5,7 +5,7 @@ module ArelExtensions
     end
 
     def matches(other, escape = nil, case_sensitive = nil)
-      if Arel::VERSION.to_i < 7
+      if AREL_VERSION < V7
         Arel::Nodes::Matches.new(self, Arel.quoted(other), escape)
       else
         Arel::Nodes::Matches.new(self, Arel.quoted(other), escape, case_sensitive)

data/lib/arel_extensions/string_functions.rb

@@ -1,3 +1,5 @@
+require 'arel_extensions/nodes/byte_size'
+require 'arel_extensions/nodes/char_length'
 require 'arel_extensions/nodes/concat' # if Arel::VERSION.to_i < 7
 require 'arel_extensions/nodes/length'
 require 'arel_extensions/nodes/locate'
@@ -19,22 +21,33 @@ require 'arel_extensions/nodes/md5'
 
 module ArelExtensions
   module StringFunctions
+    include ArelExtensions::Warning
+
     # *FindInSet function .......
     def &(other)
-      ArelExtensions::Nodes::FindInSet.new [other, self]
+      ArelExtensions::Nodes::FindInSet.new [
+        Arel.quoted(other.is_a?(Integer) ? other.to_s : other),
+        self,
+      ]
     end
 
     # LENGTH function returns the length (bytewise) of the value in a text field.
     def length
+      deprecated "Use `byte_size` or `char_length` instead. `length` relies on the vendor's `LEN/LENGTH` implementation and it's not portable"
       ArelExtensions::Nodes::Length.new self, true
     end
 
     def byte_length
+      deprecated "Use `byte_size` instead. `byte_length` relies on the vendor's `LEN/LENGTH` implementation and it's not portable"
       ArelExtensions::Nodes::Length.new self, true
     end
 
+    def byte_size
+      ArelExtensions::Nodes::ByteSize.new self
+    end
+
     def char_length
-      ArelExtensions::Nodes::Length.new self, false
+      ArelExtensions::Nodes::CharLength.new self
     end
 
     # LOCATE function returns the first starting position of a string in another string.

data/lib/arel_extensions/version.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = '2.3.2'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/lib/arel_extensions/visitors/mssql.rb

@@ -76,7 +76,7 @@ module ArelExtensions
       # The following is adapted from
       # https://github.com/rails/rails/blob/main/activerecord/lib/active_record/connection_adapters/abstract/quoting.rb
       #
-      if RUBY_PLATFORM == 'java' && Arel::VERSION.to_i <= 6
+      if RUBY_PLATFORM == 'java' && AREL_VERSION <= V6
         def quote_string(s)
           s.gsub('\\', '\&\&').gsub("'", "''") # ' (for ruby-mode)
         end
@@ -133,7 +133,7 @@ module ArelExtensions
             value.to_s('F')
           when Numeric, ActiveSupport::Duration
             value.to_s
-          when Arel::VERSION.to_i > 6 && ActiveRecord::Type::Time::Value
+          when AREL_VERSION > V6 && ActiveRecord::Type::Time::Value
             "'#{quoted_time(value)}'"
           when Date, Time
             "'#{quoted_date(value)}'"
@@ -216,8 +216,6 @@ module ArelExtensions
         collector
       end
 
-
-
       def visit_ArelExtensions_Nodes_DateDiff o, collector
         case o.right_node_type
         when :ruby_date, :ruby_time, :date, :datetime, :time
@@ -274,6 +272,23 @@ module ArelExtensions
         collector
       end
 
+      def visit_ArelExtensions_Nodes_ByteSize o, collector
+        collector << 'DATALENGTH(CAST('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ' AS VARCHAR(MAX)))'
+        collector
+      end
+
+      def visit_ArelExtensions_Nodes_CharLength o, collector
+        # According to the docs https://learn.microsoft.com/en-us/sql/t-sql/functions/len-transact-sql?view=sql-server-ver17
+        # LEN doesn't take into account the trailing white space, and that's why
+        # we need to do acrobatics.
+        collector << 'LEN('
+        collector = visit o.expr.coalesce(''), collector
+        collector << " + 'x') - 1"
+        collector
+      end
+
       def visit_ArelExtensions_Nodes_Length o, collector
         if o.bytewise
           collector << '(DATALENGTH('
@@ -575,11 +590,11 @@ module ArelExtensions
         # Sometimes these values are already quoted, if they are, don't double quote it
         lft, rgt =
           if o.right.is_a?(Arel::Nodes::SqlLiteral)
-            if Arel::VERSION.to_i >= 6 && o.right[0] != '[' && o.right[-1] != ']'
+            if AREL_VERSION >= V6 && o.right[0] != '[' && o.right[-1] != ']'
               # This is a lie, it's not about arel version, but SQL Server's (>= 2000).
-              ['[', ']']
-            elsif o.right[0] != '"' && o.right[-1] != '"'
-              ['"', '"']
+              %w([ ])
+            elsif ACTIVE_RECORD_VERSION < V8_1 && o.right[0] != '"' && o.right[-1] != '"'
+              %w(" ")
             else
               []
             end

data/lib/arel_extensions/visitors/mysql.rb

@@ -86,6 +86,20 @@ module ArelExtensions
       end
 
       # String functions
+      def visit_ArelExtensions_Nodes_ByteSize o, collector
+        collector << 'LENGTH('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ')'
+        collector
+      end
+
+      def visit_ArelExtensions_Nodes_CharLength o, collector
+        collector << 'CHAR_LENGTH('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ')'
+        collector
+      end
+
       def visit_ArelExtensions_Nodes_IMatches o, collector # insensitive on ASCII
         collector << 'LOWER('
         collector = visit o.left, collector

data/lib/arel_extensions/visitors/oracle.rb

@@ -13,6 +13,20 @@ module ArelExtensions
       }
       NUMBER_COMMA_MAPPING = {'en_US' => '.,', 'fr_FR' => ',', 'sv_SE' => ', '}
 
+      def visit_ArelExtensions_Nodes_ByteSize o, collector
+        collector << 'LENGTHB('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ')'
+        collector
+      end
+
+      def visit_ArelExtensions_Nodes_CharLength o, collector
+        collector << 'LENGTH('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ')'
+        collector
+      end
+
       def visit_ArelExtensions_Nodes_Log10 o, collector
         collector << 'LOG('
         o.expressions.each_with_index { |arg, i|
@@ -489,7 +503,7 @@ module ArelExtensions
       end
 
       # add primary_key if not present, avoid zip
-      if Arel::VERSION.to_i < 7
+      if AREL_VERSION < V7
         def visit_ArelExtensions_InsertManager_BulkValues o, collector
           collector << '('
           o.left.each_with_index do |row, idx| # values

data/lib/arel_extensions/visitors/postgresql.rb

@@ -20,6 +20,20 @@ module ArelExtensions
         'en_US' => '.,', 'fr_FR' => ',', 'sv_SE' => ', '
       }.freeze
 
+      def visit_ArelExtensions_Nodes_ByteSize o, collector
+        collector << 'octet_length('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ')'
+        collector
+      end
+
+      def visit_ArelExtensions_Nodes_CharLength o, collector
+        collector << 'length('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ')'
+        collector
+      end
+
       def visit_ArelExtensions_Nodes_Rand o, collector
         collector << 'RANDOM('
         if (o.left != nil && o.right != nil)

data/lib/arel_extensions/visitors/sqlite.rb

@@ -18,6 +18,22 @@ module ArelExtensions
       }.freeze
 
       # String functions
+      def visit_ArelExtensions_Nodes_ByteSize o, collector
+        # sqlite 3.43.0 (2023-08-24) introduced `octet_length`, but we still support older versions.
+        # https://sqlite.org/changes.html
+        collector << 'length(CAST('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ' AS BLOB))'
+        collector
+      end
+
+      def visit_ArelExtensions_Nodes_CharLength o, collector
+        collector << 'length('
+        collector = visit o.expr.coalesce(''), collector
+        collector << ')'
+        collector
+      end
+
       def visit_ArelExtensions_Nodes_IMatches o, collector # insensitive on ASCII
         collector = visit o.left.ci_collate, collector
         collector << ' LIKE '
@@ -237,7 +253,7 @@ module ArelExtensions
         collector
       end
 
-      if Arel::VERSION.to_i < 7
+      if AREL_VERSION < V7
         def visit_ArelExtensions_InsertManager_BulkValues o, collector
           o.left.each_with_index do |row, idx|
             collector << 'SELECT '

data/lib/arel_extensions/visitors/to_sql.rb

@@ -462,7 +462,7 @@ module ArelExtensions
         collector
       end
 
-      if Arel::VERSION.to_i < 7
+      if AREL_VERSION < V7
         def visit_ArelExtensions_InsertManager_BulkValues o, collector
           collector << 'VALUES '
           row_nb = o.left.length

data/lib/arel_extensions/visitors.rb

@@ -14,7 +14,7 @@ if RUBY_PLATFORM == 'java' \
     warn 'arel/visitors/sqlserver not found: MSSQL might not work correctly.'
   end
 elsif RUBY_PLATFORM != 'java' \
-  && Arel::VERSION.to_i < 10 \
+  && ArelExtensions::AREL_VERSION < ArelExtensions::V10 \
   && Gem::Specification.find { |g| g.name == 'activerecord-sqlserver-adapter' }
   begin
     require 'arel_sqlserver'

data/lib/arel_extensions.rb

@@ -1,4 +1,5 @@
 require 'arel'
+require 'arel_extensions/constants'
 require 'base64'
 
 require 'arel_extensions/railtie' if defined?(Rails::Railtie)
@@ -17,7 +18,7 @@ class Arel::Nodes::Casted
   include Arel::AliasPredication
 
   # They forget to define hash.
-  if Gem::Version.new(Arel::VERSION) < Gem::Version.new('10.0.0')
+  if ArelExtensions::AREL_VERSION < ArelExtensions::V10
     def hash
       [self.class, self.val, self.attribute].hash
     end
@@ -45,7 +46,7 @@ class Arel::Nodes::Function
   include Arel::Expressions
 end
 
-if Gem::Version.new(Arel::VERSION) >= Gem::Version.new('7.1.0')
+if ArelExtensions::AREL_VERSION >= ArelExtensions::V7_1
   class Arel::Nodes::Case
     include Arel::Math
     include Arel::Expressions
@@ -199,12 +200,20 @@ class Arel::Nodes::Function
   include ArelExtensions::NullFunctions
   include ArelExtensions::Predications
 
+  if ArelExtensions::ACTIVE_RECORD_VERSION >= ArelExtensions::V8_1
+    attr_accessor :alias
+    alias_method :old_initialize, :initialize
+
+    def initialize(expr, aliaz = nil)
+      old_initialize(expr)
+      self.alias = aliaz
+    end
+  end
+
   alias_method(:old_as, :as) rescue nil
   def as other
     res = Arel::Nodes::As.new(self.clone, Arel.sql(other))
-    if Gem::Version.new(Arel::VERSION) >= Gem::Version.new('9.0.0')
-      self.alias = Arel.sql(other)
-    end
+    self.alias = Arel.sql(other)
     res
   end
 end
@@ -325,7 +334,7 @@ class Arel::Nodes::Node
 end
 
 require 'active_record'
-if ActiveRecord.version >= Gem::Version.create('7.2')
+if ArelExtensions::ACTIVE_RECORD_VERSION >= ArelExtensions::V7_2
   class ActiveRecord::Relation::WhereClause
     def except_predicates(columns)
       attrs = columns.extract! { |node| node.is_a?(Arel::Attribute) }

data/test/arelx_test_helper.rb

@@ -1,11 +1,13 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'fileutils'
-require 'arel'
 require 'active_record'
-
+require 'arel'
+require 'arel_extensions/constants'
+require 'fileutils'
+require 'minitest/autorun'
+require 'rubygems'
 require 'support/fake_record'
 
+require_relative './config_loader'
+
 ENV['AREL_EXTENSIONS_IN_TEST'] = '1' # Useful for deprecation warnings.
 
 def colored(color, msg)
@@ -59,7 +61,7 @@ end
 
 
 def load_lib(gems)
-  if gems && (RUBY_PLATFORM == 'java' || Arel::VERSION.to_i > 9)
+  if gems && (RUBY_PLATFORM == 'java' || ArelExtensions::AREL_VERSION > ArelExtensions::V9_0)
     gems.each do |gem|
       begin
         require gem

data/test/config_loader.rb

@@ -0,0 +1,9 @@
+require 'erb'
+require 'yaml'
+
+module ConfigLoader
+  def self.load(path)
+    yaml_content = ERB.new(File.read(path)).result
+    YAML.load(yaml_content)
+  end
+end

data/test/database.yml

@@ -1,3 +1,4 @@
+# Updated to use ENV vars mapped in compose.yml
 sqlite:
   adapter: sqlite3
   database: ":memory:"
@@ -10,27 +11,28 @@ mysql:
   adapter: mysql2
   database: arelx_test
   username: root
-  host: 127.0.0.1
+  host: <%= ENV.fetch('MYSQL_HOST', '127.0.0.1') %>
   port: 3306
-  encoding: utf8
+  encoding: utf8mb4
 jdbc-mysql:
   adapter: jdbcmysql
   database: arelx_test
   username: root
-  encoding: utf8
+  encoding: utf8mb4
+  host: <%= ENV.fetch('MYSQL_HOST', '127.0.0.1') %>
 postgresql:
   adapter: postgresql
   database: arelx_test
   username: postgres
   password: secret
-  host: 127.0.0.1
+  host: <%= ENV.fetch('POSTGRES_HOST', '127.0.0.1') %>
   port: 5432
 jdbc-postgresql:
   adapter: jdbcpostgresql
   database: arelx_test
   username: postgres
   password: secret
-  host: 127.0.0.1
+  host: <%= ENV.fetch('POSTGRES_HOST', '127.0.0.1') %>
   port: 5432
 oracle:
   adapter: oracle_enhanced
@@ -48,7 +50,7 @@ ibm_db:
   database: arelx_test
 mssql:
   adapter: sqlserver
-  host: localhost
+  host: <%= ENV.fetch('MSSQL_HOST', 'localhost') %>
   database: master
   username: sa
   password: Password12!

data/test/real_db_test.rb

@@ -6,9 +6,9 @@ $:.unshift "#{File.dirname(__FILE__)}../../lib"
 require 'arel_extensions'
 
 def setup_db
-  ActiveRecord::Base.configurations = YAML.load_file('test/database.yml')
+  ActiveRecord::Base.configurations = ConfigLoader.load('test/database.yml')
   ActiveRecord::Base.establish_connection(ENV['DB'].try(:to_sym) || (RUBY_PLATFORM == 'java' ? :"jdbc-sqlite" : :sqlite))
-  if ActiveRecord::VERSION::MAJOR >= 7
+  if ACTIVE_RECORD_VERSION >= V7_0
     ActiveRecord.default_timezone = :utc
   else
     ActiveRecord::Base.default_timezone = :utc

data/test/support/fake_record.rb

@@ -1,3 +1,5 @@
+require 'arel_extensions/constants'
+
 module FakeRecord
   class Column < Struct.new(:name, :type)
   end
@@ -146,7 +148,7 @@ module FakeRecord
       connection_pool.connection
     end
 
-    if ActiveRecord.version >= Gem::Version.create('7.2')
+    if ArelExtensions::ACTIVE_RECORD_VERSION >= ArelExtensions::V7_2
       def with_connection(*args, **kwargs, &block)
         connection_pool.with_connection(*args, **kwargs, &block)
       end

data/test/visitors/test_bulk_insert_oracle.rb

@@ -15,7 +15,7 @@ module ArelExtensions
       end
 
       def compile node
-        if Arel::VERSION.to_i > 5
+        if AREL_VERSION > V5
           @visitor.accept(node, Arel::Collectors::SQLString.new).value
         else
           @visitor.accept(node)
@@ -23,7 +23,7 @@ module ArelExtensions
       end
 
       it 'should import large set of data in Oracle' do
-        insert_manager = Arel::VERSION.to_i > 6 ? Arel::InsertManager.new.into(@table) : Arel::InsertManager.new(@conn).into(@table)
+        insert_manager = AREL_VERSION > V6 ? Arel::InsertManager.new.into(@table) : Arel::InsertManager.new(@conn).into(@table)
         insert_manager.bulk_insert(@cols, @data)
         _(compile(insert_manager.ast))
           .must_be_like %Q[INSERT INTO "users" ("name", "comments", "created_at")

data/test/visitors/test_bulk_insert_sqlite.rb

@@ -16,7 +16,7 @@ module ArelExtensions
       end
 
       def compile node
-        if Arel::VERSION.to_i > 5
+        if AREL_VERSION > V5
           @visitor.accept(node, Arel::Collectors::SQLString.new).value
         else
           @visitor.accept(node)
@@ -24,7 +24,7 @@ module ArelExtensions
       end
 
       it 'should import large set of data' do
-        insert_manager = Arel::VERSION.to_i > 6 ? Arel::InsertManager.new.into(@table) : Arel::InsertManager.new(@conn).into(@table)
+        insert_manager = AREL_VERSION > V6 ? Arel::InsertManager.new.into(@table) : Arel::InsertManager.new(@conn).into(@table)
         insert_manager.bulk_insert(@cols, @data)
         _(compile(insert_manager.ast))
           .must_be_like %Q[INSERT INTO "users" ("id", "name", "comments", "created_at")

data/test/visitors/test_to_sql.rb

@@ -115,7 +115,7 @@ module ArelExtensions
         # puts (c.length.round + 42).inspect
         _(compile(c.length.round + 42)).must_be_like %{(ROUND(LENGTH("users"."name")) + 42)}
         _(compile(c.locate('test'))).must_be_like %{LOCATE('test', "users"."name")}
-        _(compile(c & 42)).must_be_like %{FIND_IN_SET(42, "users"."name")}
+        _(compile(c & 42)).must_be_like %{FIND_IN_SET('42', "users"."name")}
 
         _(compile((c >= 'test').as('new_name'))).must_be_like %{("users"."name" >= 'test') AS new_name}
         _(compile(c <= @table[:comments])).must_be_like %{"users"."name" <= "users"."comments"}