arel_toolkit 0.3.0 → 0.4.4

data/gemfiles/default.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gemspec path: "../"

data/gemfiles/default.gemfile.lock

@@ -0,0 +1,208 @@
+PATH
+  remote: ..
+  specs:
+    arel_toolkit (0.4.3)
+      activerecord
+      pg (~> 1.1.4)
+      pg_query (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    approvals (0.0.24)
+      nokogiri (~> 1.6)
+      thor (~> 0.18)
+    arel (9.0.0)
+    ast (2.4.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    database_cleaner (1.7.0)
+    debug_inspector (0.0.3)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dpl (1.10.12)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    github_changelog_generator (1.15.0)
+      activesupport
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+      retriable (~> 3.0)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rake (1.0.0)
+      guard
+      rake
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    hirb (0.7.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    interception (0.5)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    memory_profiler (0.9.14)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    nenv (0.3.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pg (1.1.4)
+    pg_query (1.3.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-alias (0.0.1)
+      binding_of_caller
+      pry
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    pry-rescue (1.5.0)
+      interception (>= 0.5)
+      pry (>= 0.12.0)
+    pry-stack_explorer (0.4.9.3)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    public_suffix (4.0.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rake-compiler (1.0.7)
+      rake
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    retriable (3.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby_dep (1.5.0)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    stackprof (0.2.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2.0)
+  approvals (~> 0.0.24)
+  arel_toolkit!
+  bundler (~> 2.0)
+  database_cleaner (~> 1.7.0)
+  dpl (~> 1.10.11)
+  github_changelog_generator (~> 1.15)
+  guard (~> 2.15)
+  guard-rake (~> 1.0.0)
+  guard-rspec (~> 4.7)
+  guard-rubocop (~> 1.3.0)
+  memory_profiler (~> 0.9)
+  pry
+  pry-alias
+  pry-doc
+  pry-nav
+  pry-rescue
+  pry-stack_explorer
+  rake (~> 13.0)
+  rake-compiler (~> 1.0)
+  rspec (~> 3.8)
+  rubocop (= 0.71.0)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
+  stackprof (~> 0.2)
+
+BUNDLED WITH
+   2.1.4

data/lib/arel/enhance.rb

@@ -0,0 +1,17 @@
+require_relative './enhance/node'
+require_relative './enhance/path'
+require_relative './enhance/path_node'
+require_relative './enhance/query'
+require_relative './enhance/query_methods'
+require_relative './enhance/visitor'
+
+module Arel
+  module Enhance
+  end
+
+  def self.enhance(object)
+    return object if object.is_a?(Arel::Enhance::Node)
+
+    Arel::Enhance::Visitor.new.accept(object)
+  end
+end

data/lib/arel/enhance/context_enhancer/arel_table.rb

@@ -0,0 +1,92 @@
+module Arel
+  module Enhance
+    module ContextEnhancer
+      class ArelTable
+        # rubocop:disable Metrics/PerceivedComplexity
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/AbcSize
+        def self.call(node)
+          context = node.context.merge!(
+            range_variable: false, column_reference: false, alias: false,
+          )
+          parent_object = node.parent.object
+
+          # Using Arel::Table as SELECT ... FROM <table>
+          if parent_object.is_a?(Arel::Nodes::JoinSource)
+            context[:range_variable] = true
+
+          # NOTE: only applies to ActiveRecord generated Arel
+          # which does not use Arel::Table#alias but Arel::TableAlias instead
+          # Using Arel::Table as SELECT ... FROM <table> AS alias
+          elsif parent_object.is_a?(Arel::Nodes::TableAlias) &&
+                node.parent.parent.object.is_a?(Arel::Nodes::JoinSource)
+            context[:range_variable] = true
+
+          # Using Arel::Table as SELECT ... FROM [<table>]
+          elsif parent_object.is_a?(Array) &&
+                node.parent.parent.object.is_a?(Arel::Nodes::JoinSource)
+            context[:range_variable] = true
+
+          # NOTE: only applies to ActiveRecord generated Arel
+          # which does not use Arel::Table#alias but Arel::TableAlias instead
+          # Using Arel::Table as SELECT ... FROM [<table> AS alias]
+          elsif parent_object.is_a?(Arel::Nodes::TableAlias) &&
+                node.parent.parent.object.is_a?(Array) &&
+                node.parent.parent.parent.object.is_a?(Arel::Nodes::JoinSource)
+            context[:range_variable] = true
+
+          # Using Arel::Table as SELECT ... INNER JOIN <table> ON TRUE
+          elsif parent_object.is_a?(Arel::Nodes::Join)
+            context[:range_variable] = true
+
+          # Using Arel::Table as an attribute SELECT <table>.id ...
+          elsif parent_object.is_a?(Arel::Attributes::Attribute)
+            context[:column_reference] = true
+
+          # Using Arel::Table in an INSERT INTO <table>
+          elsif parent_object.is_a?(Arel::Nodes::InsertStatement)
+            context[:range_variable] = true
+
+          # Using Arel::Table in an UPDATE <table> ...
+          elsif parent_object.is_a?(Arel::Nodes::UpdateStatement)
+            context[:range_variable] = true
+
+          # Arel::Table in UPDATE ... FROM [<table>]
+          elsif parent_object.is_a?(Array) &&
+                node.parent.parent.object.is_a?(Arel::Nodes::UpdateStatement)
+            context[:range_variable] = true
+
+          # Using Arel::Table in an DELETE FROM <table>
+          elsif parent_object.is_a?(Arel::Nodes::DeleteStatement)
+            context[:range_variable] = true
+
+          # Arel::Table in DELETE ... USING [<table>]
+          elsif parent_object.is_a?(Array) &&
+                node.parent.parent.object.is_a?(Arel::Nodes::DeleteStatement)
+            context[:range_variable] = true
+
+          # Using Arel::Table as an "alias" for WITH <table> AS (SELECT 1) SELECT 1
+          elsif parent_object.is_a?(Arel::Nodes::As) &&
+                node.parent.parent.parent.object.is_a?(Arel::Nodes::With)
+            context[:alias] = true
+
+          # Using Arel::Table as an "alias" for WITH RECURSIVE <table> AS (SELECT 1) SELECT 1
+          elsif parent_object.is_a?(Arel::Nodes::As) &&
+                node.parent.parent.parent.object.is_a?(Arel::Nodes::WithRecursive)
+            context[:alias] = true
+
+          # Using Arel::Table as an "alias" for SELECT INTO <table> ...
+          elsif parent_object.is_a?(Arel::Nodes::Into)
+            context[:alias] = true
+
+          else
+            raise "Unknown AST location for table #{node.inspect}, #{node.root_node.to_sql}"
+          end
+        end
+        # rubocop:enable Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/AbcSize
+      end
+    end
+  end
+end

data/lib/arel/enhance/node.rb

@@ -0,0 +1,232 @@
+module Arel
+  module Enhance
+    class Node
+      attr_reader :object
+      attr_reader :parent
+      attr_reader :local_path
+      attr_reader :fields
+      attr_reader :children
+      attr_reader :root_node
+      attr_reader :context
+
+      def initialize(object)
+        @object = object
+        @root_node = self
+        @fields = []
+        @children = {}
+        @dirty = false
+        @context = {}
+      end
+
+      def inspect
+        recursive_inspect('')
+      end
+
+      def value
+        return unless value?
+
+        @fields.first
+      end
+
+      def each(&block)
+        return enum_for(:each) unless block_given?
+
+        yield self
+
+        children.each_value do |child|
+          child.each(&block)
+        end
+      end
+
+      def value?
+        children.empty?
+      end
+
+      def dirty?
+        root_node.instance_values.fetch('dirty')
+      end
+
+      def remove
+        mutate(nil, remove: true)
+      end
+
+      def replace(new_arel_node)
+        mutate(new_arel_node)
+      end
+
+      def add(path_node, node)
+        node.local_path = path_node
+        node.parent = self
+        node.root_node = root_node
+        @children[path_node.value.to_s] = node
+      end
+
+      def to_sql(engine = Table.engine)
+        return nil if children.empty?
+
+        if object.respond_to?(:to_sql)
+          object.to_sql(engine)
+        else
+          collector = Arel::Collectors::SQLString.new
+          collector = engine.connection.visitor.accept object, collector
+          collector.value
+        end
+      end
+
+      def to_sql_and_binds(engine = Table.engine)
+        object.to_sql_and_binds(engine)
+      end
+
+      def method_missing(name, *args, &block)
+        child = @children[name.to_s]
+        return super if child.nil?
+
+        child
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        child = @children[method.to_s]
+        child.present? || super
+      end
+
+      def [](key)
+        @children.fetch(key.to_s)
+      end
+
+      def child_at_path(path_items)
+        selected_node = self
+        path_items.each do |path_item|
+          selected_node = selected_node[path_item]
+          return nil if selected_node.nil?
+        end
+        selected_node
+      end
+
+      def query(**kwargs)
+        Arel::Enhance::Query.call(self, kwargs)
+      end
+
+      def full_path
+        the_path = [local_path]
+        current_parent = parent
+
+        while current_parent
+          the_path.unshift current_parent.local_path
+          current_parent = current_parent.parent
+        end
+
+        the_path.compact
+      end
+
+      protected
+
+      attr_writer :local_path
+      attr_writer :parent
+      attr_writer :root_node
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def recursive_inspect(string, indent = 1)
+        string << "<#{inspect_name} #{full_path.inspect}\n"
+        string << "#{spacing(indent)}sql = #{to_sql}\n" unless to_sql.nil?
+        string << "#{spacing(indent)}parent = #{parent.nil? ? nil.inspect : parent.inspect_name}"
+        string << "\n" unless children.length.zero?
+        children.each do |key, child|
+          string << "#{spacing(indent)}#{key} =\n"
+          string << spacing(indent + 1)
+          child.recursive_inspect(string, indent + 2)
+        end
+        string << "\n" if children.length.zero? && value?
+        string << "#{spacing(indent)}value = #{value.inspect}" if value?
+
+        string << if children.length.zero?
+                    ">\n"
+                  else
+                    "#{spacing(indent - 1)}>\n"
+                  end
+      end
+
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+      attr_writer :object
+
+      def inspect_name
+        "Node(#{object.class.name})"
+      end
+
+      def spacing(indent)
+        indent.times.reduce('') do |memo|
+          memo << '  '
+          memo
+        end
+      end
+
+      def deep_copy_object
+        # https://github.com/mvgijssel/arel_toolkit/issues/97
+        new_object = Marshal.load(Marshal.dump(object))
+        self.object = new_object
+
+        recursive_update_object(new_object)
+      end
+
+      def recursive_update_object(arel_tree)
+        children.each_value do |child|
+          tree_child = arel_tree.send(*child.local_path.method)
+          child.object = tree_child
+          child.recursive_update_object(tree_child)
+        end
+      end
+
+      def mark_as_dirty
+        return if dirty?
+
+        @dirty = true
+        deep_copy_object
+      end
+
+      private
+
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/AbcSize
+      def mutate(new_node, remove: false)
+        root_node.mark_as_dirty
+
+        parent_object = parent.object
+        new_arel_node = new_node.is_a?(Arel::Enhance::Node) ? new_node.object : new_node
+        new_arel_node = [] if remove && object.is_a?(Array)
+
+        if parent_object.respond_to?("#{local_path.value}=")
+          parent_object.send("#{local_path.value}=", new_arel_node)
+
+        elsif parent_object.instance_values.key?(local_path.value)
+          parent_object.instance_variable_set("@#{local_path.value}", new_arel_node)
+
+        elsif local_path.arguments? && parent_object.respond_to?(local_path.method[0])
+          if remove
+            parent_object.delete_at(local_path.value)
+
+          else
+            parent_object[local_path.value] = new_arel_node
+          end
+        else
+          raise "Don't know how to replace `#{local_path.value}` in #{parent_object.inspect}"
+        end
+
+        if new_node.is_a?(Arel::Enhance::Node)
+          parent.add(local_path, new_node)
+          parent[local_path.value]
+        else
+          new_parent_tree = Visitor.new.accept_with_root(parent_object, parent)
+          parent.parent.add(parent.local_path, new_parent_tree)
+          new_parent_tree[local_path.value]
+        end
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end