activerecord-arel_depth_first 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ece1725783c7780a7fa2607153d6efc6598034165d88bb67932efa1f6a3da1fa
+  data.tar.gz: ce282ec1610453ea89c359fe70dcc372f319d5b2153d6376235f3e8b25dc89c0
+SHA512:
+  metadata.gz: 35201b02f64ae2726702dfe5483c369c767538348bc90c01f2eb97a264954c31a182f09fa0a68063e55a39eb180df1a31ee190b5f292b590780aa3d276ee070e
+  data.tar.gz: d3e279b9413e7ec185ae0a631f29b7c57a6a98a8307d6f323b4feca03e4e0d15459a4495b5cf04c039bc9b48f921b868f89751140164349ceb1e8628187c6dd8

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2004-2022 David Heinemeier Hansson
+
+Arel originally copyright (c) 2007-2016 Nick Kallen, Bryan Helmkamp, Emilio Tagua, Aaron Patterson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+Active Record Arel DepthFirst Visitor
+=====================================
+
+This gem re-introduces Arel code that was removed from Rails 6.1: https://github.com/rails/rails/pull/36492 . The code existed in the arel gem from 4.0.0 to 9.0.0, and the rails gem from 4.0.0 to 6.0.0. 
+
+It provides a DepthFirst visitor for Arel that allows you to traverse the Arel AST, 
+e.g. for visualizations.
+
+Installation
+------------
+
+Include this gem into your Gemfile:
+
+```ruby
+gem 'activerecord-arel_depth_first'
+```
+
+Example
+-------
+
+This visitor makes the Arel AST enumerable, so you can do a depth-first 
+iteration over it:
+
+``` ruby
+User.some_arbitrary_scope.arel.ast.each do |node|
+  case node
+  when Arel::Table
+    # do something for table nodes
+  when Arel::Nodes::Equality
+    # do something for equality nodes
+  else 
+    # and so on ...
+  end
+end
+```
+
+## License
+
+activerecord-arel_depth_first is released under the [MIT License](MIT-LICENSE).

data/lib/activerecord-arel_depth_first/nodes/node.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Node
+      include Enumerable
+
+      # Iterate through AST, nodes will be yielded depth-first
+      def each(&block)
+        return enum_for(:each) unless block_given?
+
+        ::Arel::Visitors::DepthFirst.new(block).accept self
+      end
+    end
+  end
+end

data/lib/activerecord-arel_depth_first/visitors/depth_first.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Visitors
+    class DepthFirst < Arel::Visitors::Visitor
+      def initialize(block = nil)
+        @block = block || Proc.new
+        super()
+      end
+
+      private
+        def visit(o, _ = nil)
+          super
+          @block.call o
+        end
+
+        def unary(o)
+          visit o.expr
+        end
+        alias :visit_Arel_Nodes_Else              :unary
+        alias :visit_Arel_Nodes_Group             :unary
+        alias :visit_Arel_Nodes_Cube              :unary
+        alias :visit_Arel_Nodes_RollUp            :unary
+        alias :visit_Arel_Nodes_GroupingSet       :unary
+        alias :visit_Arel_Nodes_GroupingElement   :unary
+        alias :visit_Arel_Nodes_Grouping          :unary
+        alias :visit_Arel_Nodes_Having            :unary
+        alias :visit_Arel_Nodes_Lateral           :unary
+        alias :visit_Arel_Nodes_Limit             :unary
+        alias :visit_Arel_Nodes_Not               :unary
+        alias :visit_Arel_Nodes_Offset            :unary
+        alias :visit_Arel_Nodes_On                :unary
+        alias :visit_Arel_Nodes_Ordering          :unary
+        alias :visit_Arel_Nodes_Ascending         :unary
+        alias :visit_Arel_Nodes_Descending        :unary
+        alias :visit_Arel_Nodes_UnqualifiedColumn :unary
+        alias :visit_Arel_Nodes_OptimizerHints    :unary
+        alias :visit_Arel_Nodes_ValuesList        :unary
+
+        def function(o)
+          visit o.expressions
+          visit o.alias
+          visit o.distinct
+        end
+        alias :visit_Arel_Nodes_Avg    :function
+        alias :visit_Arel_Nodes_Exists :function
+        alias :visit_Arel_Nodes_Max    :function
+        alias :visit_Arel_Nodes_Min    :function
+        alias :visit_Arel_Nodes_Sum    :function
+
+        def visit_Arel_Nodes_NamedFunction(o)
+          visit o.name
+          visit o.expressions
+          visit o.distinct
+          visit o.alias
+        end
+
+        def visit_Arel_Nodes_Count(o)
+          visit o.expressions
+          visit o.alias
+          visit o.distinct
+        end
+
+        def visit_Arel_Nodes_Case(o)
+          visit o.case
+          visit o.conditions
+          visit o.default
+        end
+
+        def nary(o)
+          o.children.each { |child| visit child }
+        end
+        alias :visit_Arel_Nodes_And :nary
+
+        def binary(o)
+          # left/right were renamed to relation/wheres from DeleteStatement in rails 7.0.0: 
+          # https://github.com/rails/rails/commit/0f917da01a49f45c696bc0e32d14e4da811d8e6d
+          if o.is_a?(Arel::Nodes::DeleteStatement)
+            visit o.relation
+            visit o.wheres
+          else
+            visit o.left
+            visit o.right
+          end
+        end
+        alias :visit_Arel_Nodes_As                 :binary
+        alias :visit_Arel_Nodes_Assignment         :binary
+        alias :visit_Arel_Nodes_Between            :binary
+        alias :visit_Arel_Nodes_Concat             :binary
+        alias :visit_Arel_Nodes_DeleteStatement    :binary
+        alias :visit_Arel_Nodes_DoesNotMatch       :binary
+        alias :visit_Arel_Nodes_Equality           :binary
+        alias :visit_Arel_Nodes_FullOuterJoin      :binary
+        alias :visit_Arel_Nodes_GreaterThan        :binary
+        alias :visit_Arel_Nodes_GreaterThanOrEqual :binary
+        alias :visit_Arel_Nodes_In                 :binary
+        alias :visit_Arel_Nodes_InfixOperation     :binary
+        alias :visit_Arel_Nodes_JoinSource         :binary
+        alias :visit_Arel_Nodes_InnerJoin          :binary
+        alias :visit_Arel_Nodes_LessThan           :binary
+        alias :visit_Arel_Nodes_LessThanOrEqual    :binary
+        alias :visit_Arel_Nodes_Matches            :binary
+        alias :visit_Arel_Nodes_NotEqual           :binary
+        alias :visit_Arel_Nodes_NotIn              :binary
+        alias :visit_Arel_Nodes_NotRegexp          :binary
+        alias :visit_Arel_Nodes_IsNotDistinctFrom  :binary
+        alias :visit_Arel_Nodes_IsDistinctFrom     :binary
+        alias :visit_Arel_Nodes_Or                 :binary
+        alias :visit_Arel_Nodes_OuterJoin          :binary
+        alias :visit_Arel_Nodes_Regexp             :binary
+        alias :visit_Arel_Nodes_RightOuterJoin     :binary
+        alias :visit_Arel_Nodes_TableAlias         :binary
+        alias :visit_Arel_Nodes_When               :binary
+
+        def visit_Arel_Nodes_StringJoin(o)
+          visit o.left
+        end
+
+        def visit_Arel_Attribute(o)
+          visit o.relation
+          visit o.name
+        end
+        alias :visit_Arel_Attributes_Integer :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Float :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_String :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Time :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Boolean :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Attribute :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Decimal :visit_Arel_Attribute
+
+        def visit_Arel_Table(o)
+          visit o.name
+        end
+
+        def terminal(o)
+        end
+        alias :visit_ActiveSupport_Multibyte_Chars :terminal
+        alias :visit_ActiveSupport_StringInquirer  :terminal
+        alias :visit_Arel_Nodes_Lock               :terminal
+        alias :visit_Arel_Nodes_Node               :terminal
+        alias :visit_Arel_Nodes_SqlLiteral         :terminal
+        alias :visit_Arel_Nodes_BindParam          :terminal
+        alias :visit_Arel_Nodes_Window             :terminal
+        alias :visit_Arel_Nodes_True               :terminal
+        alias :visit_Arel_Nodes_False              :terminal
+        alias :visit_BigDecimal                    :terminal
+        alias :visit_Class                         :terminal
+        alias :visit_Date                          :terminal
+        alias :visit_DateTime                      :terminal
+        alias :visit_FalseClass                    :terminal
+        alias :visit_Float                         :terminal
+        alias :visit_Integer                       :terminal
+        alias :visit_NilClass                      :terminal
+        alias :visit_String                        :terminal
+        alias :visit_Symbol                        :terminal
+        alias :visit_Time                          :terminal
+        alias :visit_TrueClass                     :terminal
+
+        def visit_Arel_Nodes_InsertStatement(o)
+          visit o.relation
+          visit o.columns
+          visit o.values
+        end
+
+        def visit_Arel_Nodes_SelectCore(o)
+          visit o.projections
+          visit o.source
+          visit o.wheres
+          visit o.groups
+          visit o.windows
+          visit o.havings
+        end
+
+        def visit_Arel_Nodes_SelectStatement(o)
+          visit o.cores
+          visit o.orders
+          visit o.limit
+          visit o.lock
+          visit o.offset
+        end
+
+        def visit_Arel_Nodes_UpdateStatement(o)
+          visit o.relation
+          visit o.values
+          visit o.wheres
+          visit o.orders
+          visit o.limit
+        end
+
+        def visit_Arel_Nodes_Comment(o)
+          visit o.values
+        end
+
+        def visit_Array(o)
+          o.each { |i| visit i }
+        end
+        alias :visit_Set :visit_Array
+
+        def visit_Hash(o)
+          o.each { |k, v| visit(k); visit(v) }
+        end
+
+        DISPATCH = dispatch_cache
+
+        def get_dispatch_cache
+          DISPATCH
+        end
+    end
+  end
+end

data/lib/activerecord-arel_depth_first.rb

@@ -0,0 +1,4 @@
+require "arel"
+require "activerecord-arel_depth_first/nodes/node"
+require "activerecord-arel_depth_first/visitors/depth_first"
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-arel_depth_first
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Tieg Zaharia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: tieg.zaharia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/activerecord-arel_depth_first.rb
+- lib/activerecord-arel_depth_first/nodes/node.rb
+- lib/activerecord-arel_depth_first/visitors/depth_first.rb
+homepage: https://github.com/tidelift/activerecord-arel_depth_first
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A DepthFirst visitor for Arel (removed from Rails in 6.1).
+test_files: []