arel_extensions 1.2.3 → 1.2.14

data/lib/arel_extensions/null_functions.rb

@@ -8,12 +8,12 @@ module ArelExtensions
     def is_null
       ArelExtensions::Nodes::IsNull.new [self]
     end
-    
+
     #ISNOTNULL function lets you return an alternative value when an expression is NOT NULL.
     def is_not_null
       ArelExtensions::Nodes::IsNotNull.new [self]
     end
-    
+
     # returns the first non-null expr in the expression list. You must specify at least two expressions.
     #If all occurrences of expr evaluate to null, then the function returns null.
     def coalesce *args

data/lib/arel_extensions/predications.rb

@@ -1,10 +1,11 @@
 module ArelExtensions
   module Predications
-    def when right, expression=nil
+
+    def when right, expression = nil
       ArelExtensions::Nodes::Case.new(self).when(right,expression)
     end
 
-    def matches(other, escape=nil,case_sensitive= nil)
+    def matches(other, escape = nil,case_sensitive = nil)
       if Arel::VERSION.to_i < 7
         Arel::Nodes::Matches.new(self, Arel::Nodes.build_quoted(other), escape)
       else
@@ -12,7 +13,7 @@ module ArelExtensions
       end
     end
 
-    def imatches(other, escape=nil)
+    def imatches(other, escape = nil)
       ArelExtensions::Nodes::IMatches.new(self, other, escape)
     end
 
@@ -20,51 +21,53 @@ module ArelExtensions
       ArelExtensions::Nodes::Cast.new([self,right])
     end
 
-    def in(other) #In should handle nil element in the Array
+    def in(*other) #In should handle nil element in the Array
+      other = other.first if other.length <= 1
       case other
       when Range
         self.between(other)
+      when Arel::Nodes::Grouping
+        Arel::Nodes::In.new(self, quoted_node(other))
       when Enumerable
-        if other.include?(nil)
-          other.delete(nil)
-          case other.length
-          when 0
-            self.is_null
-          when 1
-            self.is_null.or(self==other[0])
-          else
-            self.is_null.or(Arel::Nodes::In.new(self,quoted_array(other)))
-          end
-        else
-          Arel::Nodes::In.new(self,quoted_array(other))
-        end
+        nils, values   = other.partition{ |v| v.nil? }
+        ranges, values = values.partition{ |v| v.is_a?(Range) || v.is_a?(Arel::SelectManager)}
+        # In order of (imagined) decreasing efficiency: nil, values, and then more complex.
+        clauses =
+          nils.uniq.map { |r| self.in(r) } \
+          + (case values.uniq.size
+              when 0 then []
+              when 1 then [values[0].is_a?(Arel::Nodes::Grouping) ? self.in(values[0]) : self.eq(values[0])]
+              else [Arel::Nodes::In.new(self, quoted_array(values))] end) \
+          + ranges.uniq.map { |r| self.in(r) }
+        clauses.empty? ? Arel.false : clauses.reduce(&:or)
       when nil
         self.is_null
       when Arel::SelectManager
         Arel::Nodes::In.new(self, other.ast)
       else
-        Arel::Nodes::In.new(self,quoted_node(other))
+        Arel::Nodes::In.new(self, quoted_node(other))
       end
     end
 
-    def not_in(other) #In should handle nil element in the Array
+    def not_in(*other) #In should handle nil element in the Array
+      other = other.first if other.length <= 1
       case other
       when Range
         Arel::Nodes::Not.new(self.between(other))
+      when Arel::Nodes::Grouping
+        Arel::Nodes::NotIn.new(self, quoted_node(other))
       when Enumerable
-        if other.include?(nil)
-          other.delete(nil)
-          case other.length
-          when 0
-            self.is_not_null
-          when 1
-            self.is_not_null.and(self!=other[0])
-          else
-            self.is_not_null.and(Arel::Nodes::NotIn.new(self,quoted_array(other)))
-          end
-        else
-          Arel::Nodes::NotIn.new(self,quoted_array(other))
-        end
+        nils, values   = other.partition{ |v| v.nil? }
+        ranges, values = values.partition{ |v| v.is_a?(Range) || v.is_a?(Arel::SelectManager)}
+        # In order of (imagined) decreasing efficiency: nil, values, and then more complex.
+        clauses =
+          nils.uniq.map { |r| self.not_in(r) } \
+          + (case values.uniq.size
+              when 0 then []
+              when 1 then [values[0].is_a?(Arel::Nodes::Grouping) ? self.not_in(values[0]) : self.not_eq(values[0])]
+              else [Arel::Nodes::NotIn.new(self, quoted_array(values))] end) \
+          + ranges.uniq.map { |r| self.not_in(r) }
+        Arel::Nodes::And.new clauses
       when nil
         self.is_not_null
       when Arel::SelectManager
@@ -94,6 +97,5 @@ module ArelExtensions
         raise(ArgumentError, "#{object.class} can not be converted to CONCAT arg")
       end
     end
-
   end
 end

data/lib/arel_extensions/set_functions.rb

@@ -23,10 +23,10 @@ module ArelExtensions
   end
 end
 
-Arel::Nodes::Union.class_eval do
+class Arel::Nodes::Union
   include ArelExtensions::SetFunctions
 end
 
-Arel::Nodes::UnionAll.class_eval do
+class Arel::Nodes::UnionAll
   include ArelExtensions::SetFunctions
 end

data/lib/arel_extensions/string_functions.rb

@@ -64,6 +64,19 @@ module ArelExtensions
       grouping_any :imatches, others, escape
     end
 
+#    def grouping_any method, others, *extra
+#      puts "*******************"
+#      puts method
+#      puts others.inspect
+#      puts extra.inspect
+#      puts "-------------------"
+#      res = super(method,others,*extra)
+#      puts res.to_sql
+#      puts res.inspect
+#      puts "*******************"
+#      res
+#    end
+
     def imatches_all others, escape = nil
       grouping_all :imatches, others, escape, escape
     end
@@ -92,7 +105,7 @@ module ArelExtensions
       ArelExtensions::Nodes::SMatches.new(self,other)
     end
 
-    def ai_collate 
+    def ai_collate
       ArelExtensions::Nodes::Collate.new(self,nil,true,false)
     end
 
@@ -100,31 +113,40 @@ module ArelExtensions
       ArelExtensions::Nodes::Collate.new(self,nil,false,true)
     end
 
-    def collate ai=false,ci=false, option=nil
+    def collate ai = false,ci = false, option = nil
       ArelExtensions::Nodes::Collate.new(self,option,ai,ci)
     end
 
     #REPLACE function replaces a sequence of characters in a string with another set of characters, not case-sensitive.
-    def replace left, right
-      ArelExtensions::Nodes::Replace.new [self, left, right]
+    def replace pattern, substitute
+      if pattern.is_a? Regexp
+        ArelExtensions::Nodes::RegexpReplace.new self, pattern, substitute
+      else
+        ArelExtensions::Nodes::Replace.new self, pattern, substitute
+      end
+    end
+
+    def regexp_replace pattern, substitute
+      ArelExtensions::Nodes::RegexpReplace.new self, pattern, substitute
     end
-    
+
     def concat other
       ArelExtensions::Nodes::Concat.new [self, other]
     end
 
     #concat elements of a group, separated by sep and ordered by a list of Ascending or Descending
-    def group_concat sep = nil, *orders 
+    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.")
+      end
       order_tabs = [orders].flatten.map{ |o|
         if o.is_a?(Arel::Nodes::Ascending) || o.is_a?(Arel::Nodes::Descending)
           o
         elsif o.respond_to?(:asc)
           o.asc
-        else
-          nil
         end
       }.compact
-      ArelExtensions::Nodes::GroupConcat.new [self, sep, order_tabs]
+      ArelExtensions::Nodes::GroupConcat.new(self, sep, group: group, order: (order || order_tabs))
     end
 
     #Function returns a string after removing left, right or the both prefixes or suffixes int argument
@@ -155,11 +177,11 @@ module ArelExtensions
     def not_blank
       ArelExtensions::Nodes::NotBlank.new [self]
     end
-    
-    def repeat other = 1 
+
+    def repeat other = 1
       ArelExtensions::Nodes::Repeat.new [self, other]
     end
-    
+
     def levenshtein_distance other
       ArelExtensions::Nodes::LevenshteinDistance.new [self, other]
     end

data/lib/arel_extensions/tasks.rb

@@ -1,12 +1,12 @@
 namespace :arel_extensions do
-	desc 'Install DB functions into current DB'
-	task :install_functions => :environment do
-		@env_db = if ENV['DB'] == 'oracle' && ((defined?(RUBY_ENGINE) && RUBY_ENGINE == "rbx") || (RUBY_PLATFORM == 'java')) # not supported
+  desc 'Install DB functions into current DB'
+  task :install_functions => :environment do
+    @env_db = if ENV['DB'] == 'oracle' && ((defined?(RUBY_ENGINE) && RUBY_ENGINE == "rbx") || (RUBY_PLATFORM == 'java')) # not supported
                 (RUBY_PLATFORM == 'java' ? "jdbc-sqlite" : 'sqlite')
               else
                 ENV['DB'] || ActiveRecord::Base.connection.adapter_name
               end
-    ActiveRecord::Base.establish_connection(Rails.env)
+    ActiveRecord::Base.establish_connection(Rails.env.to_sym)
     CommonSqlFunctions.new(ActiveRecord::Base.connection).add_sql_functions(@env_db)
-	end
+  end
 end

data/lib/arel_extensions/version.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = "1.2.3".freeze
+  VERSION = "1.2.14".freeze
 end

data/lib/arel_extensions/visitors.rb

@@ -6,7 +6,7 @@ require 'arel_extensions/visitors/postgresql'
 require 'arel_extensions/visitors/sqlite'
 require 'arel_extensions/visitors/mssql'
 
-Arel::Visitors::MSSQL.class_eval do
+class Arel::Visitors::MSSQL
   include ArelExtensions::Visitors::MSSQL
 
   alias_method :old_visit_Arel_Nodes_As, :visit_Arel_Nodes_As

data/lib/arel_extensions/visitors/ibm_db.rb

@@ -1,6 +1,6 @@
 module ArelExtensions
   module Visitors
-    Arel::Visitors::IBM_DB.class_eval do
+    class Arel::Visitors::IBM_DB
 
       def visit_ArelExtensions_Nodes_Ceil o, collector
         collector << "CEILING("

data/lib/arel_extensions/visitors/mssql.rb

@@ -400,14 +400,15 @@ module ArelExtensions
         collector << "(STRING_AGG("
         collector = visit o.left, collector
         collector << Arel::Visitors::Oracle::COMMA
-        if o.right  && o.right != 'NULL'
-          collector = visit o.right, collector
-        else
-          collector = visit Arel::Nodes.build_quoted(','), collector
-        end
+        collector =
+          if o.separator && o.separator != 'NULL'
+            visit o.separator, collector
+          else
+            visit Arel::Nodes.build_quoted(','), collector
+          end
         collector << ") WITHIN GROUP (ORDER BY "
-        if !o.orders.blank?
-          o.orders.each_with_index do |order,i|
+        if o.order.present?
+          o.order.each_with_index do |order,i|
             collector << Arel::Visitors::Oracle::COMMA unless i == 0
             collector = visit order, collector
           end
@@ -466,8 +467,9 @@ module ArelExtensions
               Arel::Nodes.build_quoted(1) :
               ArelExtensions::Nodes::Case.new.when(col<0).then(1).else(0)
 
-        if o.scientific_notation
-          number = ArelExtensions::Nodes::Concat.new([
+        number =
+          if o.scientific_notation
+            ArelExtensions::Nodes::Concat.new([
                   Arel::Nodes::NamedFunction.new('FORMAT',[
                     col.abs/Arel::Nodes.build_quoted(10).pow(col.abs.log10.floor),
                     param,
@@ -480,13 +482,13 @@ module ArelExtensions
                     locale
                   ])
                 ])
-        else
-          number = Arel::Nodes::NamedFunction.new('FORMAT',[
+          else
+            Arel::Nodes::NamedFunction.new('FORMAT',[
                 Arel::Nodes.build_quoted(col.abs),
                 param,
                 locale
               ])
-        end
+          end
 
         repeated_char = (o.width == 0) ? Arel::Nodes.build_quoted('') : ArelExtensions::Nodes::Case.new().
           when(Arel::Nodes.build_quoted(o.width).abs-(number.length+sign_length)>0).
@@ -548,7 +550,6 @@ module ArelExtensions
         collector
       end
 
-
     end
   end
 end

data/lib/arel_extensions/visitors/mysql.rb

@@ -1,6 +1,6 @@
 module ArelExtensions
   module Visitors
-    Arel::Visitors::MySQL.class_eval do
+    class Arel::Visitors::MySQL
       Arel::Visitors::MySQL::DATE_MAPPING = {'d' => 'DAY', 'm' => 'MONTH', 'w' => 'WEEK', 'y' => 'YEAR', 'wd' => 'WEEKDAY', 'h' => 'HOUR', 'mn' => 'MINUTE', 's' => 'SECOND'}
       Arel::Visitors::MySQL::DATE_FORMAT_DIRECTIVES = { # ISO C / POSIX
         '%Y' => '%Y', '%C' =>   '', '%y' => '%y', '%m' => '%m', '%B' => '%M', '%b' => '%b', '%^b' => '%b',  # year, month
@@ -97,26 +97,28 @@ module ArelExtensions
       end
 
       def visit_ArelExtensions_Nodes_Collate o, collector
-        case o.expressions.first
-        when Arel::Attributes::Attribute
-          charset = case o.option
+        charset =
+          case o.expressions.first
+          when Arel::Attributes::Attribute
+            case o.option
             when 'latin1','utf8'
               o.option
             else
               Arel::Table.engine.connection.charset || 'utf8'
             end
-        else
-          charset = (o.option == 'latin1') ? 'latin1' : 'utf8'
-        end
+          else
+            (o.option == 'latin1') ? 'latin1' : 'utf8'
+          end
         collector = visit o.expressions.first, collector
-        if o.ai
-          collector << " COLLATE #{charset == 'latin1' ? 'latin1_general_ci' : 'utf8_unicode_ci' }"
+        collector <<
+          if o.ai
+            " COLLATE #{charset == 'latin1' ? 'latin1_general_ci' : 'utf8_unicode_ci' }"
           #doesn't work in latin1
-        elsif o.ci
-          collector << " COLLATE #{charset == 'latin1' ? 'latin1_general_ci' : 'utf8_unicode_ci' }"
-        else
-          collector << " COLLATE #{charset}_bin"
-        end
+          elsif o.ci
+            " COLLATE #{charset == 'latin1' ? 'latin1_general_ci' : 'utf8_unicode_ci' }"
+          else
+            " COLLATE #{charset}_bin"
+          end
         collector
       end
 
@@ -139,16 +141,16 @@ module ArelExtensions
       def visit_ArelExtensions_Nodes_GroupConcat o, collector
         collector << "GROUP_CONCAT("
         collector = visit o.left, collector
-        if !o.orders.blank?
+        if !o.order.blank?
           collector << ' ORDER BY '
-          o.orders.each_with_index do |order,i|
+          o.order.each_with_index do |order,i|
             collector << Arel::Visitors::ToSql::COMMA unless i == 0
             collector = visit order, collector
           end
         end
-        if o.right && o.right != 'NULL'
+        if o.separator && o.separator != 'NULL'
           collector << ' SEPARATOR '
-          collector = visit o.right, collector
+          collector = visit o.separator, collector
         end
         collector << ")"
         collector
@@ -191,6 +193,13 @@ module ArelExtensions
         collector
       end
 
+      def visit_ArelExtensions_Nodes_RegexpReplace o, collector
+        if !regexp_replace_supported?
+          warn("Warning : ArelExtensions: REGEXP_REPLACE does not seem to be available in the current version of the DBMS, it might crash")
+        end
+        super(o,collector)
+      end
+
       def visit_ArelExtensions_Nodes_Format o, collector
         case o.col_type
         when :date, :datetime
@@ -262,7 +271,7 @@ module ArelExtensions
         else
           if o.with_interval
             case o.left
-            when  'd','m','y'
+            when 'd','m','y'
               interval = 'DAY'
             when 'h','mn','s'
               interval = 'SECOND'
@@ -362,20 +371,21 @@ module ArelExtensions
                   else(o.flags.include?('+') ? '+' : (o.flags.include?(' ') ? ' ' : ''))
         sign_length = ArelExtensions::Nodes::Length.new([sign])
 
-        if o.scientific_notation
-          number = ArelExtensions::Nodes::Concat.new([
-                  Arel::Nodes::NamedFunction.new('FORMAT',[
-                    col.abs/Arel::Nodes.build_quoted(10).pow(col.abs.log10.floor)
-                  ]+params),
-                  o.type,
-                  Arel::Nodes::NamedFunction.new('FORMAT',[
-                    col.abs.log10.floor,
-                    0
+        number =
+          if o.scientific_notation
+            ArelExtensions::Nodes::Concat.new([
+                    Arel::Nodes::NamedFunction.new('FORMAT',[
+                      col.abs/Arel::Nodes.build_quoted(10).pow(col.abs.log10.floor)
+                    ]+params),
+                    o.type,
+                    Arel::Nodes::NamedFunction.new('FORMAT',[
+                      col.abs.log10.floor,
+                      0
+                    ])
                   ])
-                ])
-        else
-          number = Arel::Nodes::NamedFunction.new('FORMAT',[col.abs]+params)
-        end
+          else
+            Arel::Nodes::NamedFunction.new('FORMAT',[col.abs]+params)
+          end
 
         repeated_char = (o.width == 0) ? Arel::Nodes.build_quoted('') : ArelExtensions::Nodes::Case.new().
           when(Arel::Nodes.build_quoted(o.width).abs-(number.length+sign_length)>0).
@@ -398,10 +408,34 @@ module ArelExtensions
         collector
       end
 
+      def visit_Aggregate_For_AggregateFunction o, collector
+        if !window_supported?
+            warn("Warning : ArelExtensions: Window Functions are not available in the current version of the DBMS.")
+            return collector
+        end
+
+        if !o.order.empty? || !o.group.empty?
+          collector << " OVER ("
+          if !o.group.empty?
+            collector << " PARTITION BY ("
+            visit o.group, collector
+            collector << ")"
+          end
+          if !o.order.empty?
+            collector << " ORDER BY ("
+            visit o.order, collector
+            collector << ")"
+          end
+          collector << ")"
+        end
+        collector
+      end
+
       def visit_ArelExtensions_Nodes_Std o, collector
         collector << (o.unbiased_estimator ? "STDDEV_SAMP(" : "STDDEV_POP(")
         visit o.left, collector
         collector << ")"
+        visit_Aggregate_For_AggregateFunction o, collector
         collector
       end
 
@@ -409,15 +443,35 @@ module ArelExtensions
         collector << (o.unbiased_estimator ? "VAR_SAMP(" : "VAR_POP(")
         visit o.left, collector
         collector << ")"
+        visit_Aggregate_For_AggregateFunction o, collector
         collector
       end
 
       # JSON if implemented only after 10.2.3 in MariaDb and 5.7 in MySql
       def json_supported?
-        Arel::Table.engine.connection.send(:mariadb?) &&
-        Arel::Table.engine.connection.send(:version) >= '10.2.3' ||
-        !Arel::Table.engine.connection.send(:mariadb?) &&
-        Arel::Table.engine.connection.send(:version) >= '5.7.0'
+        version_supported?('10.2.3', '5.7.0')
+      end
+
+      def window_supported?
+        version_supported?('10.2.3', '8.0')
+      end
+
+      def regexp_replace_supported?
+        version_supported?('10.0.5', '8.0')
+      end
+
+      def version_supported?(mariadb_v = '10.2.3', mysql_v = '5.7.0')
+        conn = Arel::Table.engine.connection
+        conn.send(:mariadb?) && \
+          (conn.respond_to?(:get_database_version) && conn.send(:get_database_version) >= mariadb_v || \
+          conn.respond_to?(:version) && conn.send(:version) >= mariadb_v || \
+          conn.instance_variable_get(:"@version") && conn.instance_variable_get(:"@version") >= mariadb_v) || \
+          !conn.send(:mariadb?) && \
+          (conn.respond_to?(:get_database_version) && conn.send(:get_database_version) >= mysql_v || \
+          conn.respond_to?(:version) && conn.send(:version) >= mysql_v || \
+          conn.instance_variable_get(:"@version") && conn.instance_variable_get(:"@version") >= mysql_v)
+        # ideally we should parse the instance_variable @full_version because @version contains only the supposedly
+        # corresponding mysql version of the current mariadb version (which is not very helpful most of the time)
       end
 
       def visit_ArelExtensions_Nodes_Json o,collector