arel_extensions 2.1.5 → 2.1.6

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,7 +252,18 @@ 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.
+        type =
+          o.col_type.nil? && !o.expressions[0].return_type.nil? \
+          ? o.expressions[0].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('

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
@@ -705,6 +710,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.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

data/test/with_ar/all_agnostic_test.rb

@@ -73,6 +73,8 @@ module ArelExtensions
         @neg = User.where(id: u.id)
         u = User.create age: 15, name: 'Justin', created_at: d, score: 11.0
         @justin = User.where(id: u.id)
+        u = User.create age: nil, name: 'nilly', created_at: nil, score: nil
+        @nilly = User.where(id: u.id)
 
         @age = User.arel_table[:age]
         @name = User.arel_table[:name]
@@ -149,7 +151,7 @@ module ArelExtensions
       def test_rand
         assert 42 != User.select(Arel.rand.as('res')).first.res
         assert 0 <= User.select(Arel.rand.abs.as('res')).first.res
-        assert_equal 9, User.order(Arel.rand).limit(50).count
+        assert_equal 10, User.order(Arel.rand).limit(50).count
       end
 
       def test_round
@@ -186,6 +188,49 @@ module ArelExtensions
         assert User.group(:score).count(:id).values.all?{|e| !e.nil?}
       end
 
+      def test_rollup
+        skip "sqlite not supported" if $sqlite
+        at = User.arel_table
+        # single
+        q = User.select(at[:name], at[:age].sum).group(Arel::Nodes::RollUp.new([at[:name]]))
+        assert q.to_a.length > 0
+
+        # multi
+        q = User.select(at[:name], at[:score], at[:age].sum).group(Arel::Nodes::RollUp.new([at[:score], at[:name]]))
+        assert q.to_a.length > 0
+
+        # hybrid
+        q = User.select(at[:name], at[:score], at[:age].sum).group(at[:score], Arel::Nodes::RollUp.new([at[:name]]))
+        assert q.to_a.length > 0
+
+        ## Using Arel.rollup which is less verbose than the original way
+
+        # simple
+        q = User.select(at[:name], at[:age].sum).group(Arel.rollup(at[:name]))
+        assert q.to_a.length > 0
+
+        # multi
+        q = User.select(at[:name], at[:score], at[:age].sum).group(Arel.rollup([at[:score], at[:name]]))
+        assert q.to_a.length > 0
+
+        # hybrid
+        q = User.select(at[:name], at[:score], at[:age].sum).group(at[:score], Arel.rollup([at[:name]]))
+        assert q.to_a.length > 0
+
+        ## Using at[:col].rollup which is handy for single column rollups
+
+        # simple
+        q = User.select(at[:name], at[:age].sum).group(at[:name].rollup)
+        assert q.to_a.length > 0
+
+        q = User.select(at[:name], at[:score], at[:age].sum).group(at[:name].rollup, at[:score].rollup)
+        assert q.to_a.length > 0
+
+        # hybrid
+        q = User.select(at[:name], at[:score], at[:age].sum).group(at[:name], at[:score].rollup)
+        assert q.to_a.length > 0
+      end
+
       # String Functions
       def test_concat
         assert_equal 'Camille Camille', t(@camille, @name + ' ' + @name)
@@ -294,16 +339,16 @@ module ArelExtensions
         skip "Sqlite version can't load extension for regexp" if $sqlite && $load_extension_disabled
         skip 'SQL Server does not know about REGEXP without extensions' if @env_db == 'mssql'
         assert_equal 1, User.where(@name =~ '^M').count
-        assert_equal 7, User.where(@name !~ '^L').count
+        assert_equal 8, User.where(@name !~ '^L').count
         assert_equal 1, User.where(@name =~ /^M/).count
-        assert_equal 7, User.where(@name !~ /^L/).count
+        assert_equal 8, User.where(@name !~ /^L/).count
       end
 
       def test_imatches
         # puts User.where(@name.imatches('m%')).to_sql
         assert_equal 1, User.where(@name.imatches('m%')).count
         assert_equal 4, User.where(@name.imatches_any(['L%', '%e'])).count
-        assert_equal 7, User.where(@name.idoes_not_match('L%')).count
+        assert_equal 8, User.where(@name.idoes_not_match('L%')).count
       end
 
       def test_replace
@@ -328,8 +373,8 @@ module ArelExtensions
         skip "Sqlite version can't load extension for soundex" if $sqlite && $load_extension_disabled
         skip "PostgreSql version can't load extension for soundex" if @env_db == 'postgresql'
         assert_equal 'C540', t(@camille, @name.soundex)
-        assert_equal 9, User.where(@name.soundex.eq(@name.soundex)).count
-        assert_equal 9, User.where(@name.soundex == @name.soundex).count
+        assert_equal 10, User.where(@name.soundex.eq(@name.soundex)).count
+        assert_equal 10, User.where(@name.soundex == @name.soundex).count
       end
 
       def test_change_case
@@ -374,6 +419,23 @@ module ArelExtensions
         assert_equal 'true', t(@neg, @comments.not_blank.then('true', 'false'))
       end
 
+      # This test repeats a lot of `test_blank` cases.
+      def test_present
+        if @env_db == 'postgresql'
+          assert_includes [true, 't'], t(@myung, @name.present) # depends of adapter
+          assert_includes [false, 'f'], t(@myung, @comments.present)
+        end
+        assert_equal 1, @myung.where(@name.present).count
+        assert_equal 0, @myung.where(@comments.present).count
+        assert_equal 0, @sophie.where(@comments.present).count
+        assert_equal 0, @camille.where(@comments.present).count
+
+        assert_equal 1, @neg.where(@comments.present).count
+        assert_equal 'true', t(@myung, @name.present.then('true', 'false'))
+        assert_equal 'false', t(@myung, @comments.present.then('true', 'false'))
+        assert_equal 'true', t(@neg, @comments.present.then('true', 'false'))
+      end
+
       def test_format
         assert_equal '2016-05-23', t(@lucas, @created_at.format('%Y-%m-%d'))
         assert_equal '2014/03/03 12:42:00', t(@lucas, @updated_at.format('%Y/%m/%d %H:%M:%S'))
@@ -565,6 +627,24 @@ module ArelExtensions
         assert_equal 'Laure10', t(@laure, @comments.coalesce('Laure') + 10)
       end
 
+      def test_coalesce_blank
+        assert_equal 'Myung', t(@myung, @comments.coalesce_blank('Myung').coalesce_blank('ignored'))
+        assert_equal 'Myung', t(@myung, @comments.coalesce_blank('', ' ', '   ').coalesce_blank('Myung'))
+        assert_equal 'Myung', t(@myung, @comments.coalesce_blank('', ' ', '   ', 'Myung'))
+        assert_equal '2016-05-23', t(@myung, @created_at.coalesce_blank(Date.new(2022, 1, 1)).format('%Y-%m-%d'))
+        assert_equal 'Laure', t(@laure, @comments.coalesce_blank('Laure'))
+        assert_equal 100, t(@test, @age.coalesce_blank(100))
+        assert_equal 20, t(@test, @age.coalesce_blank(20))
+        assert_equal 20, t(@test, @age.coalesce_blank(10) + 10)
+        assert_equal 'Laure10', t(@laure, @comments.coalesce_blank('Laure') + 10)
+
+        skip 'mssql does not support null in case results' if @env_db == 'mssql'
+
+        assert_equal 'Camille concat', t(@camille, @name.coalesce_blank(Arel.null, 'default') + ' concat')
+        assert_equal 'Myung', t(@myung, @comments.coalesce_blank(Arel.null, 'Myung'))
+        assert_equal 'Camille', t(@camille, @name.coalesce_blank(Arel.null, 'default'))
+      end
+
       # Comparators
       def test_number_comparator
         assert_equal 2, User.where(@age < 6).count
@@ -577,7 +657,7 @@ module ArelExtensions
       def test_date_comparator
         d = Date.new(2016, 5, 23)
         assert_equal 0, User.where(@created_at < d).count
-        assert_equal 9, User.where(@created_at >= d).count
+        assert_equal 10, User.where(@created_at >= d).count
       end
 
       def test_date_duration
@@ -690,6 +770,26 @@ module ArelExtensions
         end
       end
 
+      def test_if_present
+        assert_nil t(@myung, @comments.if_present)
+        assert_equal 0, t(@myung, @comments.if_present.count)
+        assert_equal 20.16, t(@myung, @score.if_present)
+        assert_equal '2016-05-23', t(@myung, @created_at.if_present.format('%Y-%m-%d'))
+        assert_nil t(@laure, @comments.if_present)
+
+        assert_nil t(@nilly, @duration.if_present.format('%Y-%m-%d'))
+
+        # NOTE: here we're testing the capacity to format a nil value,
+        # however, @comments is a text field, and not a date/datetime field,
+        # so Postgres will rightfully complain when we format the text:
+        # we need to cast it first.
+        if @env_db == 'postgresql'
+          assert_nil t(@laure, @comments.cast(:date).if_present.format('%Y-%m-%d'))
+        else
+          assert_nil t(@laure, @comments.if_present.format('%Y-%m-%d'))
+        end
+      end
+
       def test_is_null
         # puts User.where(@age.is_null).select(@name).to_sql
         # puts @age.is_null
@@ -725,7 +825,7 @@ module ArelExtensions
       def test_math_minus
         d = Date.new(2016, 5, 20)
         # Datediff
-        assert_equal 9, User.where((@created_at - @created_at).eq(0)).count
+        assert_equal 10, User.where((@created_at - @created_at).eq(0)).count
         assert_equal 3, @laure.select((@created_at - d).as('res')).first.res.abs.to_i
         # Substraction
         assert_equal 0, User.where((@age - 10).eq(50)).count
@@ -845,8 +945,8 @@ module ArelExtensions
 
       def test_subquery_with_order
         skip if ['mssql'].include?(@env_db) && Arel::VERSION.to_i < 10
-        assert_equal 9, User.where(name: User.select(:name).order(:name)).count
-        assert_equal 9, User.where(@ut[:name].in(@ut.project(@ut[:name]).order(@ut[:name]))).count
+        assert_equal 10, User.where(name: User.select(:name).order(:name)).count
+        assert_equal 10, User.where(@ut[:name].in(@ut.project(@ut[:name]).order(@ut[:name]))).count
         if !['mysql'].include?(@env_db) # MySql can't have limit in IN subquery
           assert_equal 2, User.where(name: User.select(:name).order(:name).limit(2)).count
           # assert_equal 6, User.where(name: User.select(:name).order(:name).offset(2)).count

data/version_v1.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = '1.3.5'.freeze
+  VERSION = '1.3.6'.freeze
 end

data/version_v2.rb

@@ -1,3 +1,3 @@
 module ArelExtensions
-  VERSION = '2.1.5'.freeze
+  VERSION = '2.1.6'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arel_extensions
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.1.6
 platform: ruby
 authors:
 - Yann Azoury
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-25 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -40,20 +40,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.9'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.3.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.3.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +72,7 @@ files:
 - ".rubocop.yml"
 - Gemfile
 - MIT-LICENSE.txt
+- NEWS.md
 - README.md
 - Rakefile
 - SQL_Challenges.md
@@ -94,8 +81,8 @@ files:
 - arel_extensions.gemspec
 - functions.html
 - gemfiles/rails3.gemfile
-- gemfiles/rails4.gemfile
-- gemfiles/rails5_0.gemfile
+- gemfiles/rails4_2.gemfile
+- gemfiles/rails5.gemfile
 - gemfiles/rails5_1_4.gemfile
 - gemfiles/rails5_2.gemfile
 - gemfiles/rails6.gemfile
@@ -150,7 +137,9 @@ files:
 - lib/arel_extensions/nodes/rand.rb
 - lib/arel_extensions/nodes/repeat.rb
 - lib/arel_extensions/nodes/replace.rb
+- lib/arel_extensions/nodes/rollup.rb
 - lib/arel_extensions/nodes/round.rb
+- lib/arel_extensions/nodes/select.rb
 - lib/arel_extensions/nodes/soundex.rb
 - lib/arel_extensions/nodes/std.rb
 - lib/arel_extensions/nodes/substring.rb