arel_toolkit 0.2.0 → 0.3.0

data/lib/arel/sql_to_arel/pg_query_visitor.rb

@@ -6,7 +6,7 @@
 # rubocop:disable Metrics/ParameterLists
 
 require 'pg_query'
-require_relative './frame_options'
+require_relative './pg_query_visitor/frame_options'
 
 module Arel
   module SqlToArel
@@ -15,13 +15,21 @@ module Arel
       MIN_MAX_EXPR = 'MinMaxExpr'.freeze
 
       attr_reader :object
+      attr_reader :binds
+      attr_reader :sql
 
-      def accept(sql)
+      def accept(sql, binds = [])
         tree = PgQuery.parse(sql).tree
-        raise 'https://github.com/mvgijssel/arel_toolkit/issues/33' if tree.length > 1
 
-        @object = tree.first
-        visit object, :top
+        @object = tree
+        @binds = binds
+        @sql = sql
+
+        Result.new visit(object, :top)
+      rescue ::StandardError => e
+        raise e.class, e.message, e.backtrace if e.is_a?(Arel::SqlToArel::Error)
+
+        boom e.message, e.backtrace
       end
 
       private
@@ -72,7 +80,7 @@ module Arel
           Arel::Nodes::NullIf.new(left, right)
 
         when PgQuery::AEXPR_OF
-          raise 'https://github.com/mvgijssel/arel_toolkit/issues/34'
+          boom 'https://github.com/mvgijssel/arel_toolkit/issues/34'
 
         when PgQuery::AEXPR_IN
           left = visit(lexpr)
@@ -91,7 +99,7 @@ module Arel
           escape = nil
 
           if right.is_a?(Array)
-            raise "Don't know how to handle length `#{right.length}`" if right.length != 2
+            boom "Don't know how to handle length `#{right.length}`" if right.length != 2
 
             right, escape = right
           end
@@ -110,7 +118,7 @@ module Arel
           escape = nil
 
           if right.is_a?(Array)
-            raise "Don't know how to handle length `#{right.length}`" if right.length != 2
+            boom "Don't know how to handle length `#{right.length}`" if right.length != 2
 
             right, escape = right
           end
@@ -129,7 +137,7 @@ module Arel
           escape = nil
 
           if right.is_a?(Array)
-            raise "Don't know how to handle length `#{right.length}`" if right.length != 2
+            boom "Don't know how to handle length `#{right.length}`" if right.length != 2
 
             right, escape = right
           end
@@ -164,10 +172,10 @@ module Arel
           Arel::Nodes::NotBetweenSymmetric.new left, Arel::Nodes::And.new(right)
 
         when PgQuery::AEXPR_PAREN
-          raise 'https://github.com/mvgijssel/arel_toolkit/issues/35'
+          boom 'https://github.com/mvgijssel/arel_toolkit/issues/35'
 
         else
-          raise "Unknown Expr type `#{kind}`"
+          boom "Unknown Expr type `#{kind}`"
         end
       end
 
@@ -176,7 +184,7 @@ module Arel
       end
 
       def visit_A_Indirection(arg:, indirection:)
-        Arel::Nodes::Indirection.new(visit(arg, :operator), visit(indirection, :operator))
+        Arel::Nodes::Indirection.new(visit(arg), visit(indirection, :operator))
       end
 
       def visit_A_Star
@@ -205,7 +213,7 @@ module Arel
                    Arel::Nodes::Not.new(args)
 
                  else
-                   raise "? Boolop -> #{boolop}"
+                   boom "? Boolop -> #{boolop}"
                  end
 
         if context
@@ -238,7 +246,7 @@ module Arel
           Arel::Nodes::NotEqual.new(arg, Arel::Nodes::Unknown.new)
 
         else
-          raise '?'
+          boom '?'
         end
       end
 
@@ -269,8 +277,19 @@ module Arel
         Arel::Nodes::Coalesce.new args
       end
 
-      def visit_ColumnRef(context = nil, fields:)
-        UnboundColumnReference.new visit(fields, context).join('.')
+      def visit_ColumnRef(fields:)
+        visited_fields = visit(fields)
+
+        if fields.length == 2
+          table_reference, column_reference = fields
+          table_reference = visit(table_reference, :operator)
+          table = Arel::Table.new(table_reference)
+
+          column_reference = visit(column_reference, :operator)
+          table[column_reference]
+        else
+          Arel::Nodes::UnboundColumnReference.new visited_fields.join('.')
+        end
       end
 
       def visit_CommonTableExpr(ctename:, ctequery:)
@@ -283,6 +302,15 @@ module Arel
         Arel::Nodes::CurrentOfExpression.new(cursor_name)
       end
 
+      def visit_DefElem(defname:, arg:, defaction:)
+        case defname
+        when 'savepoint_name'
+          visit(arg)
+        else
+          boom "Unknown defname `#{defname}` with defaction `#{defaction}`"
+        end
+      end
+
       def visit_DeleteStmt(
         relation:,
         using_clause: nil,
@@ -356,8 +384,48 @@ module Arel
                when [PG_CATALOG, 'similar_escape']
                  args
 
+               when [PG_CATALOG, 'date_part']
+                 field, expression = args
+                 [Arel::Nodes::ExtractFrom.new(expression, field)]
+
+               when [PG_CATALOG, 'timezone']
+                 timezone, expression = args
+
+                 [Arel::Nodes::AtTimeZone.new(maybe_add_grouping(expression), timezone)]
+
+               # https://www.postgresql.org/docs/10/functions-string.html
+               when [PG_CATALOG, 'position']
+                 string, substring = args
+                 [Arel::Nodes::Position.new(substring, string)]
+
+               when [PG_CATALOG, 'overlay']
+                 string, substring, start, length = args
+                 [Arel::Nodes::Overlay.new(string, substring, start, length)]
+
+               when [PG_CATALOG, 'ltrim']
+                 string, substring = args
+                 [Arel::Nodes::Trim.new('leading', substring, string)]
+
+               when [PG_CATALOG, 'rtrim']
+                 string, substring = args
+                 [Arel::Nodes::Trim.new('trailing', substring, string)]
+
+               when [PG_CATALOG, 'btrim']
+                 string, substring = args
+                 [Arel::Nodes::Trim.new('both', substring, string)]
+
+               when [PG_CATALOG, 'substring']
+                 string, pattern, escape = args
+                 [Arel::Nodes::Substring.new(string, pattern, escape)]
+
+               when [PG_CATALOG, 'overlaps']
+                 start1, end1, start2, end2 = args
+                 [Arel::Nodes::Overlaps.new(start1, end1, start2, end2)]
+
                else
-                 raise "Don't know how to handle `#{function_names}`" if function_names.length > 1
+                 if function_names.length > 1
+                   boom "Don't know how to handle function names `#{function_names}`"
+                 end
 
                  Arel::Nodes::NamedFunction.new(function_names.first, args)
                end
@@ -383,8 +451,8 @@ module Arel
       end
 
       def visit_IndexElem(name:, ordering:, nulls_ordering:)
-        raise "Unknown ordering `#{ordering}`" unless ordering.zero?
-        raise "Unknown nulls ordering `#{ordering}`" unless nulls_ordering.zero?
+        boom "Unknown ordering `#{ordering}`" unless ordering.zero?
+        boom "Unknown nulls ordering `#{ordering}`" unless nulls_ordering.zero?
 
         Arel.sql(name)
       end
@@ -418,7 +486,7 @@ module Arel
         end
 
         insert_statement.returning = visit(returning_list, :select)
-        insert_statement.on_conflict = visit(on_conflict_clause) if on_conflict_clause
+        insert_statement.conflict = visit(on_conflict_clause) if on_conflict_clause
         insert_manager
       end
 
@@ -481,10 +549,17 @@ module Arel
         when 1
           Arel::Nodes::Least.new visit(args)
         else
-          raise "Unknown Op -> #{op}"
+          boom "Unknown Op -> #{op}"
         end
       end
 
+      def visit_NamedArgExpr(arg:, name:, argnumber:)
+        arg = visit(arg)
+        boom '' unless argnumber == -1
+
+        Arel::Nodes::NamedArgument.new(name, arg)
+      end
+
       def visit_Null(**_)
         Arel.sql 'NULL'
       end
@@ -509,16 +584,18 @@ module Arel
         conflict
       end
 
-      def visit_ParamRef(_args)
-        Arel::Nodes::BindParam.new(nil)
+      def visit_ParamRef(number:)
+        value = (binds[number - 1] unless binds.empty?)
+
+        Arel::Nodes::BindParam.new(value)
       end
 
       def visit_RangeFunction(is_rowsfrom:, functions:, lateral: false, ordinality: false)
-        raise 'https://github.com/mvgijssel/arel_toolkit/issues/36' unless is_rowsfrom == true
+        boom 'https://github.com/mvgijssel/arel_toolkit/issues/36' unless is_rowsfrom == true
 
         functions = functions.map do |function_array|
           function, empty_value = function_array
-          raise 'https://github.com/mvgijssel/arel_toolkit/issues/37' unless empty_value.nil?
+          boom 'https://github.com/mvgijssel/arel_toolkit/issues/37' unless empty_value.nil?
 
           visit(function)
         end
@@ -545,8 +622,8 @@ module Arel
         )
       end
 
-      def visit_RawStmt(context, stmt:)
-        visit(stmt, context)
+      def visit_RawStmt(context, **args)
+        visit(args.fetch(:stmt), context)
       end
 
       def visit_ResTarget(context, val: nil, name: nil)
@@ -562,12 +639,13 @@ module Arel
         when :insert
           name
         when :update
-          Arel::Nodes::Equality.new(
-            Arel.sql(visit_String(str: name)),
-            visit(val),
-          )
+          relation = nil
+          column = Arel::Attribute.new(relation, name)
+          value = visit(val)
+
+          Nodes::Assignment.new(Nodes::UnqualifiedColumn.new(column), value)
         else
-          raise "Unknown context `#{context}`"
+          boom "Unknown context `#{context}`"
         end
       end
 
@@ -600,11 +678,27 @@ module Arel
         select_statement = select_manager.ast
 
         froms, join_sources = generate_sources(from_clause)
+        if froms
+          froms = froms.first if froms.length == 1
+          select_core.froms = froms
+        end
+
         select_core.from = froms if froms
         select_core.source.right = join_sources
 
         select_core.projections = visit(target_list, :select) if target_list
-        select_core.wheres = [visit(where_clause)] if where_clause
+
+        if where_clause
+          where_clause = visit(where_clause)
+          where_clause = if where_clause.is_a?(Arel::Nodes::And)
+                           where_clause
+                         else
+                           Arel::Nodes::And.new([where_clause])
+                         end
+
+          select_core.wheres = [where_clause]
+        end
+
         select_core.groups = visit(group_clause) if group_clause
         select_core.havings = [visit(having_clause)] if having_clause
         select_core.windows = visit(window_clause) if window_clause
@@ -616,7 +710,7 @@ module Arel
         elsif distinct_clause.nil?
           select_core.set_quantifier = nil
         else
-          raise "Unknown distinct clause `#{distinct_clause}`"
+          boom "Unknown distinct clause `#{distinct_clause}`"
         end
 
         select_statement.limit = ::Arel::Nodes::Limit.new visit(limit_count) if limit_count
@@ -636,8 +730,10 @@ module Arel
                 Arel.sql(value.to_sql)
               when Arel::Nodes::BindParam
                 value
+              when Arel::Nodes::Quoted
+                value.value
               else
-                raise "Unknown value `#{value}`"
+                boom "Unknown value `#{value}`"
               end
             end
           end
@@ -667,7 +763,7 @@ module Arel
                   end
                 else
                   # https://www.postgresql.org/docs/10/queries-union.html
-                  raise "Unknown combining queries op `#{op}`"
+                  boom "Unknown combining queries op `#{op}`"
                 end
 
         unless union.nil?
@@ -723,7 +819,7 @@ module Arel
         when :operator
           str
         when :const
-          Arel.sql "'#{str}'"
+          Arel::Nodes.build_quoted str
         else
           "\"#{str}\""
         end
@@ -735,7 +831,7 @@ module Arel
         operator = if oper_name
                      operator = visit(oper_name, :operator)
                      if operator.length > 1
-                       raise 'https://github.com/mvgijssel/arel_toolkit/issues/39'
+                       boom 'https://github.com/mvgijssel/arel_toolkit/issues/39'
                      end
 
                      operator.first
@@ -744,24 +840,51 @@ module Arel
         generate_sublink(sub_link_type, subselect, testexpr, operator)
       end
 
+      def visit_TransactionStmt(kind:, options: nil)
+        Arel::Nodes::Transaction.new(
+          kind,
+          (visit(options) if options),
+        )
+      end
+
       def visit_TypeCast(arg:, type_name:)
         arg = visit(arg)
         type_name = visit(type_name)
 
-        Arel::Nodes::TypeCast.new(arg, type_name)
+        Arel::Nodes::TypeCast.new(maybe_add_grouping(arg), type_name)
       end
 
-      def visit_TypeName(names:, typemod:)
+      def visit_TypeName(names:, typemod:, array_bounds: [])
+        array_bounds = visit(array_bounds)
+
         names = names.map do |name|
           visit(name, :operator)
         end
 
         names = names.reject { |name| name == PG_CATALOG }
 
-        raise 'https://github.com/mvgijssel/arel_toolkit/issues/40' if typemod != -1
-        raise 'https://github.com/mvgijssel/arel_toolkit/issues/41' if names.length > 1
+        boom 'https://github.com/mvgijssel/arel_toolkit/issues/40' if typemod != -1
+        boom 'https://github.com/mvgijssel/arel_toolkit/issues/41' if names.length > 1
+        if array_bounds != [] && array_bounds != [-1]
+          boom 'https://github.com/mvgijssel/arel_toolkit/issues/86'
+        end
 
-        names.first
+        type_name = names.first
+        type_name = case type_name
+                    when 'int4'
+                      'integer'
+                    when 'float4'
+                      'real'
+                    when 'float8'
+                      'double precision'
+                    when 'timestamptz'
+                      'timestamp with time zone'
+                    else
+                      type_name
+                    end
+
+        type_name << '[]' if array_bounds == [-1]
+        type_name
       end
 
       def visit_UpdateStmt(
@@ -786,6 +909,19 @@ module Arel
         update_manager
       end
 
+      def visit_VariableSetStmt(kind:, name:, args: [], is_local: false)
+        Arel::Nodes::VariableSet.new(
+          kind,
+          visit(args),
+          name,
+          is_local,
+        )
+      end
+
+      def visit_VariableShowStmt(name:)
+        Arel::Nodes::VariableShow.new(name)
+      end
+
       def visit_WindowDef(
         partition_clause: [],
         order_clause: [],
@@ -819,13 +955,20 @@ module Arel
       end
 
       def generate_operator(left, right, operator)
+        left = maybe_add_grouping(left)
+        right = maybe_add_grouping(right)
+
         case operator
 
         # https://www.postgresql.org/docs/10/functions-math.html
         when '+'
           Arel::Nodes::Addition.new(left, right)
         when '-'
-          Arel::Nodes::Subtraction.new(left, right)
+          if left.nil?
+            Arel::Nodes::UnaryOperation.new(:'-', right)
+          else
+            Arel::Nodes::Subtraction.new(left, right)
+          end
         when '*'
           Arel::Nodes::Multiplication.new(left, right)
         when '/'
@@ -849,9 +992,17 @@ module Arel
         when '|'
           Arel::Nodes::BitwiseOr.new(left, right)
         when '#'
-          Arel::Nodes::BitwiseXor.new(left, right)
+          if left.nil?
+            Arel::Nodes::UnaryOperation.new(:'#', right)
+          else
+            Arel::Nodes::BitwiseXor.new(left, right)
+          end
         when '~'
-          Arel::Nodes::BitwiseNot.new(right)
+          if left.nil?
+            Arel::Nodes::BitwiseNot.new(right)
+          else
+            Arel::Nodes::Regexp.new(left, right, true)
+          end
         when '<<'
           Arel::Nodes::BitwiseShiftLeft.new(left, right)
         when '>>'
@@ -881,8 +1032,48 @@ module Arel
         when '||'
           Arel::Nodes::Concat.new(left, right)
 
+        # https://www.postgresql.org/docs/9.3/functions-net.html
+        when '<<='
+          Arel::Nodes::ContainedWithinEquals.new(left, right)
+        when '>>='
+          Arel::Nodes::ContainsEquals.new(left, right)
+
+        # https://www.postgresql.org/docs/9.4/functions-json.html
+        when '->'
+          Arel::Nodes::JsonGetObject.new(left, right)
+        when '->>'
+          Arel::Nodes::JsonGetField.new(left, right)
+        when '#>'
+          Arel::Nodes::JsonPathGetObject.new(left, right)
+        when '#>>'
+          Arel::Nodes::JsonPathGetField.new(left, right)
+
+        # https://www.postgresql.org/docs/9.4/functions-json.html#FUNCTIONS-JSONB-OP-TABLE
+        when '?'
+          Arel::Nodes::JsonbKeyExists.new(left, right)
+        when '?|'
+          if left.nil?
+            Arel::Nodes::UnaryOperation.new(:'?|', right)
+          else
+            Arel::Nodes::JsonbAnyKeyExists.new(left, right)
+          end
+        when '?&'
+          Arel::Nodes::JsonbAllKeyExists.new(left, right)
+
+        # https://www.postgresql.org/docs/9.3/functions-matching.html#FUNCTIONS-POSIX-TABLE
+        when '~*'
+          Arel::Nodes::Regexp.new(left, right, false)
+        when '!~'
+          Arel::Nodes::NotRegexp.new(left, right, true)
+        when '!~*'
+          Arel::Nodes::NotRegexp.new(left, right, false)
+
         else
-          raise "Unknown operator `#{operator}`"
+          if left.nil?
+            Arel::Nodes::UnaryOperation.new(operator, right)
+          else
+            Arel::Nodes::InfixOperation.new(operator, left, right)
+          end
         end
       end
 
@@ -972,27 +1163,55 @@ module Arel
           generate_operator(testexpr, Arel::Nodes::All.new(subselect), operator)
 
         when PgQuery::SUBLINK_TYPE_ANY
-          generate_operator(testexpr, Arel::Nodes::Any.new(subselect), operator)
+          if operator.nil?
+            Arel::Nodes::In.new(testexpr, subselect)
+          else
+            generate_operator(testexpr, Arel::Nodes::Any.new(subselect), operator)
+          end
 
         when PgQuery::SUBLINK_TYPE_ROWCOMPARE
-          raise 'https://github.com/mvgijssel/arel_toolkit/issues/42'
+          boom 'https://github.com/mvgijssel/arel_toolkit/issues/42'
 
         when PgQuery::SUBLINK_TYPE_EXPR
           Arel::Nodes::Grouping.new(subselect)
 
         when PgQuery::SUBLINK_TYPE_MULTIEXPR
-          raise 'https://github.com/mvgijssel/arel_toolkit/issues/43'
+          boom 'https://github.com/mvgijssel/arel_toolkit/issues/43'
 
         when PgQuery::SUBLINK_TYPE_ARRAY
           Arel::Nodes::ArraySubselect.new(subselect)
 
         when PgQuery::SUBLINK_TYPE_CTE
-          raise 'https://github.com/mvgijssel/arel_toolkit/issues/44'
+          boom 'https://github.com/mvgijssel/arel_toolkit/issues/44'
 
         else
-          raise "Unknown sublinktype: #{type}"
+          boom "Unknown sublinktype: #{type}"
         end
       end
+
+      def maybe_add_grouping(node)
+        case node
+        when Arel::Nodes::Binary
+          Arel::Nodes::Grouping.new(node)
+        else
+          node
+        end
+      end
+
+      def boom(message, backtrace = nil)
+        new_message = <<~STRING
+
+
+          SQL: #{sql}
+          BINDS: #{binds}
+          message: #{message}
+
+        STRING
+
+        raise(Arel::SqlToArel::Error, new_message, backtrace) if backtrace
+
+        raise Arel::SqlToArel::Error, new_message
+      end
     end
   end
 end

data/lib/arel/sql_to_arel/result.rb

@@ -0,0 +1,17 @@
+module Arel
+  module SqlToArel
+    class Result < Array
+      def to_sql
+        map(&:to_sql).join('; ')
+      end
+
+      def to_formatted_sql
+        map(&:to_formatted_sql).join('; ')
+      end
+
+      def map(&block)
+        Result.new super
+      end
+    end
+  end
+end

data/lib/arel/sql_to_arel.rb

@@ -1,8 +1,9 @@
+require 'arel/sql_to_arel/result'
+require 'arel/sql_to_arel/error'
 require 'arel/sql_to_arel/pg_query_visitor'
-require 'arel/sql_to_arel/unbound_column_reference'
 
 module Arel
-  def self.sql_to_arel(sql)
-    SqlToArel::PgQueryVisitor.new.accept(sql)
+  def self.sql_to_arel(sql, binds: [])
+    SqlToArel::PgQueryVisitor.new.accept(sql, binds)
   end
 end

data/lib/arel_toolkit/version.rb

@@ -1,3 +1,3 @@
 module ArelToolkit
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/arel_toolkit.rb

@@ -2,6 +2,8 @@ require 'arel_toolkit/version'
 require 'arel'
 require 'arel/extensions'
 require 'arel/sql_to_arel'
+require 'arel/middleware'
+require 'arel/sql_formatter'
 
 module ArelToolkit
 end