arel_extensions 2.1.5 → 2.1.7

data/lib/arel_extensions/visitors/mssql.rb

@@ -49,6 +49,82 @@ module ArelExtensions
         'YYYY-MM-DDTHH:MM:SS:MMM' => 126
       }.freeze
 
+      # Quoting in JRuby + AR < 5 requires special handling for MSSQL.
+      #
+      # It relied on @connection.quote, which in turn relied on column type for
+      # quoting. We need only to rely on the value type.
+      #
+      # It didn't handle numbers correctly: `quote(1, nil)` translated into
+      # `N'1'` which we don't want.
+      #
+      # The following is adapted from activerecord/lib/active_record/connection_adapters/abstract/quoting.rb
+      #
+      if RUBY_PLATFORM == 'java' && ActiveRecord::VERSION::MAJOR < 5
+        def quote_string(s)
+          s.gsub('\\', '\&\&').gsub("'", "''") # ' (for ruby-mode)
+        end
+
+        def quoted_binary(value) # :nodoc:
+          "'#{quote_string(value.to_s)}'"
+        end
+
+        def quoted_date(value)
+          if value.acts_like?(:time)
+            if ActiveRecord::Base.default_timezone == :utc
+              value = value.getutc if value.respond_to?(:getutc) && !value.utc?
+            else
+              value = value.getlocal if value.respond_to?(:getlocal)
+            end
+          end
+
+          result = value.to_s(:db)
+          if value.respond_to?(:usec) && value.usec > 0
+            result << '.' << sprintf('%06d', value.usec)
+          else
+            result
+          end
+        end
+
+        def quoted_true
+          'TRUE'
+        end
+
+        def quoted_false
+          'FALSE'
+        end
+
+        def quoted_time(value) # :nodoc:
+          value = value.change(year: 2000, month: 1, day: 1)
+          quoted_date(value).sub(/\A\d{4}-\d{2}-\d{2} /, "")
+        end
+
+        def quote value, column = nil
+          case value
+          when Arel::Nodes::SqlLiteral
+            value
+          when String, Symbol, ActiveSupport::Multibyte::Chars
+            "'#{quote_string(value.to_s)}'"
+          when true      
+            quoted_true
+          when false     
+            quoted_false
+          when nil       
+            'NULL'
+          # BigDecimals need to be put in a non-normalized form and quoted.
+          when BigDecimal
+            value.to_s('F')
+          when Numeric, ActiveSupport::Duration
+            value.to_s
+          when Date, Time
+            "'#{quoted_date(value)}'"
+          when Class
+            "'#{value}'"
+          else
+            raise TypeError, "can't quote #{value.class.name}"
+          end
+        end
+      end
+
       # Math Functions
       def visit_ArelExtensions_Nodes_Ceil o, collector
         collector << 'CEILING('
@@ -279,6 +355,10 @@ module ArelExtensions
       end
 
       def visit_ArelExtensions_Nodes_Format o, collector
+        visit_ArelExtensions_Nodes_FormattedDate o, collector
+      end
+
+      def visit_ArelExtensions_Nodes_FormattedDate o, collector
         f = ArelExtensions::Visitors::strftime_to_format(o.iso_format, LOADED_VISITOR::DATE_FORMAT_DIRECTIVES)
         if fmt = LOADED_VISITOR::DATE_CONVERT_FORMATS[f]
           collector << "CONVERT(VARCHAR(#{f.length})"
@@ -487,6 +567,11 @@ module ArelExtensions
         collector
       end
 
+      def visit_Arel_Nodes_RollUp(o, collector)
+        collector << "ROLLUP"
+        grouping_array_or_grouping_element o, collector
+      end
+
       # TODO;
       def visit_ArelExtensions_Nodes_GroupConcat o, collector
         collector << '(STRING_AGG('
@@ -647,6 +732,18 @@ module ArelExtensions
         collector << ')'
         collector
       end
+
+      # Utilized by GroupingSet, Cube & RollUp visitors to
+      # handle grouping aggregation semantics
+      def grouping_array_or_grouping_element(o, collector)
+        if o.expr.is_a? Array
+          collector << "( "
+          visit o.expr, collector
+          collector << " )"
+        else
+          visit o.expr, collector
+        end
+      end
     end
   end
 end

data/lib/arel_extensions/visitors/mysql.rb

@@ -14,6 +14,52 @@ module ArelExtensions
         '%M' => '%i', '%S' => '%S', '%L' =>   '', '%N' => '%f', '%z' => ''
       }.freeze
 
+      # 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 = ", ")
+          if nodes&.any?
+            collector << spacer
+            inject_join nodes, collector, connector
+          end
+        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"
+
+          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, " "
+
+          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
+
+          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 "
+
+          if o.respond_to?(:comment)
+            maybe_visit o.comment, collector 
+          else
+            collector
+          end
+        end
 
       # Math functions
       def visit_ArelExtensions_Nodes_Log10 o, collector
@@ -138,6 +184,11 @@ module ArelExtensions
         collector
       end
 
+      def visit_Arel_Nodes_RollUp(o, collector)
+        visit o.expr, collector
+        collector << " WITH ROLLUP"
+      end
+
       def visit_ArelExtensions_Nodes_GroupConcat o, collector
         collector << 'GROUP_CONCAT('
         collector = visit o.left, collector
@@ -201,28 +252,22 @@ module ArelExtensions
       end
 
       def visit_ArelExtensions_Nodes_Format o, collector
-        case o.col_type
+        # One use case we met is
+        # `case…when…then(valid_date).else(Arel.null).format(…)`.
+        #
+        # In this case, `o.col_type` is `nil` but we have a legitimate type in
+        # the expression to be formatted.  The following is a best effort to
+        # infer the proper type.
+        first = o.expressions[0]
+        type =
+          o.col_type.nil? \
+            && (first.respond_to?(:return_type) && !first&.return_type.nil?) \
+          ? first&.return_type \
+          : o.col_type
+
+        case type
         when :date, :datetime, :time
-          fmt = ArelExtensions::Visitors::strftime_to_format(o.iso_format, DATE_FORMAT_DIRECTIVES)
-          collector << 'DATE_FORMAT('
-          collector << 'CONVERT_TZ(' if o.time_zone
-          collector = visit o.left, collector
-          case o.time_zone
-          when Hash
-            src_tz, dst_tz = o.time_zone.first
-            collector << COMMA
-            collector = visit Arel.quoted(src_tz), collector
-            collector << COMMA
-            collector = visit Arel.quoted(dst_tz), collector
-            collector << ')'
-          when String
-            collector << COMMA << "'UTC'" << COMMA
-            collector = visit Arel.quoted(o.time_zone), collector
-            collector << ')'
-          end
-          collector << COMMA
-          collector = visit Arel.quoted(fmt), collector
-          collector << ')'
+          visit_ArelExtensions_Nodes_FormattedDate o, collector
         when :integer, :float, :decimal
           collector << 'FORMAT('
           collector = visit o.left, collector
@@ -237,6 +282,29 @@ module ArelExtensions
         collector
       end
 
+      def visit_ArelExtensions_Nodes_FormattedDate o, collector
+        fmt = ArelExtensions::Visitors::strftime_to_format(o.iso_format, DATE_FORMAT_DIRECTIVES)
+        collector << 'DATE_FORMAT('
+        collector << 'CONVERT_TZ(' if o.time_zone
+        collector = visit o.left, collector
+        case o.time_zone
+        when Hash
+          src_tz, dst_tz = o.time_zone.first
+          collector << COMMA
+          collector = visit Arel.quoted(src_tz), collector
+          collector << COMMA
+          collector = visit Arel.quoted(dst_tz), collector
+          collector << ')'
+        when String
+          collector << COMMA << "'UTC'" << COMMA
+          collector = visit Arel.quoted(o.time_zone), collector
+          collector << ')'
+        end
+        collector << COMMA
+        collector = visit Arel.quoted(fmt), collector
+        collector << ')'
+      end
+
       def visit_ArelExtensions_Nodes_DateDiff o, collector
         case o.right_node_type
         when :ruby_date, :ruby_time, :date, :datetime, :time

data/lib/arel_extensions/visitors/oracle.rb

@@ -126,6 +126,11 @@ module ArelExtensions
       collector
       end
 
+      def visit_Arel_Nodes_RollUp(o, collector)
+        collector << "ROLLUP"
+        grouping_array_or_grouping_element o, collector
+      end
+
       def visit_ArelExtensions_Nodes_GroupConcat o, collector
         collector << '(LISTAGG('
         collector = visit o.left, collector
@@ -446,6 +451,10 @@ module ArelExtensions
       end
 
       def visit_ArelExtensions_Nodes_Format o, collector
+        visit_ArelExtensions_Nodes_FormattedDate o, collector
+      end
+
+      def visit_ArelExtensions_Nodes_FormattedDate o, collector
         fmt = ArelExtensions::Visitors::strftime_to_format(o.iso_format, DATE_FORMAT_DIRECTIVES)
         collector << 'TO_CHAR('
         collector << 'CAST(' if o.time_zone
@@ -705,6 +714,18 @@ module ArelExtensions
         collector << ')'
         collector
       end
+
+      # Utilized by GroupingSet, Cube & RollUp visitors to
+      # handle grouping aggregation semantics
+      def grouping_array_or_grouping_element(o, collector)
+        if o.expr.is_a? Array
+          collector << "( "
+          visit o.expr, collector
+          collector << " )"
+        else
+          visit o.expr, collector
+        end
+      end
     end
   end
 end

data/lib/arel_extensions/visitors/postgresql.rb

@@ -174,6 +174,10 @@ module ArelExtensions
       end
 
       def visit_ArelExtensions_Nodes_Format o, collector
+        visit_ArelExtensions_Nodes_FormattedDate o, collector
+      end
+
+      def visit_ArelExtensions_Nodes_FormattedDate o, collector
         fmt = ArelExtensions::Visitors::strftime_to_format(o.iso_format, DATE_FORMAT_DIRECTIVES)
         collector << 'TO_CHAR('
         collector << '(' if o.time_zone

data/lib/arel_extensions/visitors/to_sql.rb

@@ -289,6 +289,26 @@ module ArelExtensions
         collector
       end
 
+      def visit_ArelExtensions_Nodes_FormattedDate o, collector
+        case o.col_type
+        when :date, :datetime, :time
+          collector << 'STRFTIME('
+          collector = visit o.right, collector
+          collector << COMMA
+          collector = visit o.left, collector
+          collector << ')'
+        when :integer, :float, :decimal
+          collector << 'FORMAT('
+          collector = visit o.left, collector
+          collector << COMMA
+          collector = visit o.right, collector
+          collector << ')'
+        else
+          collector = visit o.left, collector
+        end
+        collector
+      end
+
       # comparators
 
       def visit_ArelExtensions_Nodes_Cast o, collector

data/lib/arel_extensions/visitors.rb

@@ -19,6 +19,14 @@ if defined?(Arel::Visitors::SQLServer)
   end
 end
 
+if defined?(Arel::Visitors::DepthFirst)
+  class Arel::Visitors::DepthFirst
+    def visit_Arel_SelectManager o
+        visit o.ast
+    end
+  end
+end
+
 if defined?(Arel::Visitors::MSSQL)
   class Arel::Visitors::MSSQL
     include ArelExtensions::Visitors::MSSQL

data/lib/arel_extensions.rb

@@ -78,6 +78,8 @@ require 'arel_extensions/nodes/case'
 require 'arel_extensions/nodes/soundex'
 require 'arel_extensions/nodes/cast'
 require 'arel_extensions/nodes/json'
+require 'arel_extensions/nodes/rollup'
+require 'arel_extensions/nodes/select'
 
 # It seems like the code in lib/arel_extensions/visitors.rb that is supposed
 # to inject ArelExtension is not enough. Different versions of the sqlserver
@@ -132,6 +134,10 @@ module Arel
     ArelExtensions::Nodes::Rand.new
   end
 
+  def self.rollup(*args)
+    Arel::Nodes::RollUp.new(args)
+  end
+
   def self.shorten s
     Base64.urlsafe_encode64(Digest::MD5.new.digest(s)).tr('=', '').tr('-', '_')
   end
@@ -277,4 +283,14 @@ class Arel::Attributes::Attribute
     collector = engine.connection.visitor.accept self, collector
     collector.value
   end
+
+  def rollup
+    Arel::Nodes::RollUp.new([self])
+  end
+end
+
+class Arel::Nodes::Node
+  def rollup
+    Arel::Nodes::RollUp.new([self])
+  end
 end