arel_toolkit 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff1c5420d091c5e2df0fb1bbc6350fb9a7454893855c6091eb25b3d7ae5ba46c
-  data.tar.gz: 1b98b3c7b2bc7488af08cc9b58d6f1b2d92dfe0a3cda7f7bdb01a61e2fa1a193
+  metadata.gz: 28d6dfc92b5aebf97e6a22fa4ded2583f5d2184b1f0a8afc7ea4bc1951805b6d
+  data.tar.gz: 9c72d8926233ec968b2c864886a422848bb0fd85c7e2828e86db0b9cee21144a
 SHA512:
-  metadata.gz: 772871812878e1ac7c4989a4d14c2414675b327ed5b1b5a140841bb699a0f590fc7f04f3ea1de6dfefb0166541b5260c7a01360d41869948e8a1a7b7d77cd6b6
-  data.tar.gz: b996389ef2016ba70449d44491496882ff246e01e43801e086b1db4831901acfe7e4a10c5df5a323e5167b74f9333dc5ff8d62e6d66b61bf3da84a650c978a06
+  metadata.gz: 7aaab2a35e519f4c85ce56135efa0374b8806318791913c351b797972827e0c10a5e4b9d17f6d21d8abed7508db17170a199ec4186dc16a9036a4e460a767ca0
+  data.tar.gz: 127121759494230ea9d82b7499812f942c44026f4ff7d22dc08b45d0b5a60ce1505b11bc4c6136391005aef17ef2932565e6266c189fd521c0869dac455bdf47

data/.github/workflows/develop.yml

@@ -47,8 +47,10 @@ jobs:
     - name: Rebase
       if: matrix.rebase
       run: |
-        git config --global user.email "ci@github.com"
-        git config --global user.name "GitHub CI"
+        export GIT_AUTHOR_NAME=${CI_COMMIT_AUTHOR_NAME=GithubCI}
+        export GIT_AUTHOR_EMAIL=${CI_COMMIT_AUTHOR_EMAIL=ci@github.comm}
+        export GIT_COMMITTER_NAME=${GIT_AUTHOR_NAME}
+        export GIT_COMMITTER_EMAIL=${GIT_AUTHOR_EMAIL}
         git fetch origin $GITHUB_REF
         git rebase $GITHUB_SHA
 

data/Appraisals

@@ -7,3 +7,7 @@ end
 
 appraise 'default' do
 end
+
+appraise 'active_record_6' do
+  gem 'activerecord', '~> 6.0.0'
+end

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [v0.4.3](https://github.com/mvgijssel/arel_toolkit/tree/v0.4.3) (2020-11-09)
+
+[Full Changelog](https://github.com/mvgijssel/arel_toolkit/compare/v0.4.2...v0.4.3)
+
+**Implemented enhancements:**
+
+- Upgrade active\_record to 6 [\#167](https://github.com/mvgijssel/arel_toolkit/pull/167) ([khaleksa](https://github.com/khaleksa))
+- Bump json from 2.2.0 to 2.3.1 [\#166](https://github.com/mvgijssel/arel_toolkit/pull/166) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump activesupport from 5.2.3 to 5.2.4.3 [\#165](https://github.com/mvgijssel/arel_toolkit/pull/165) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update rake requirement from ~\> 10.0 to ~\> 13.0 [\#161](https://github.com/mvgijssel/arel_toolkit/pull/161) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump nokogiri from 1.10.4 to 1.10.8 [\#160](https://github.com/mvgijssel/arel_toolkit/pull/160) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Adds cache mechanism to middleware [\#154](https://github.com/mvgijssel/arel_toolkit/pull/154) ([Willianvdv](https://github.com/Willianvdv))
+
 ## [v0.4.2](https://github.com/mvgijssel/arel_toolkit/tree/v0.4.2) (2020-01-08)
 
 [Full Changelog](https://github.com/mvgijssel/arel_toolkit/compare/v0.4.1...v0.4.2)

data/Gemfile.lock

@@ -1,22 +1,21 @@
 PATH
   remote: .
   specs:
-    arel_toolkit (0.4.2)
-      activerecord (~> 5.2.0)
-      arel (~> 9.0.0)
+    arel_toolkit (0.4.3)
+      activerecord
       pg (~> 1.1.4)
-      pg_query (~> 1.1.0)
+      pg_query (~> 1.2.0)
 
 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)
+    activemodel (5.2.4.3)
+      activesupport (= 5.2.4.3)
+    activerecord (5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
       arel (>= 9.0)
-    activesupport (5.2.3)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -36,7 +35,7 @@ GEM
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     database_cleaner (1.7.0)
     debug_inspector (0.0.3)
     diff-lcs (1.3)
@@ -77,11 +76,11 @@ GEM
       guard (~> 2.0)
       rubocop (~> 0.20)
     hirb (0.7.3)
-    i18n (1.7.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     interception (0.5)
     jaro_winkler (1.5.3)
-    json (2.2.0)
+    json (2.3.1)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -90,11 +89,11 @@ GEM
     memory_profiler (0.9.14)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.13.0)
+    minitest (5.14.1)
     multi_json (1.14.1)
     multipart-post (2.1.1)
     nenv (0.3.0)
-    nokogiri (1.10.4)
+    nokogiri (1.10.8)
       mini_portile2 (~> 2.4.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -105,7 +104,7 @@ GEM
     parser (2.6.3.0)
       ast (~> 2.4.0)
     pg (1.1.4)
-    pg_query (1.1.1)
+    pg_query (1.2.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -125,7 +124,7 @@ GEM
       pry (>= 0.9.11)
     public_suffix (4.0.1)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rake-compiler (1.0.7)
       rake
     rb-fsevent (0.10.3)
@@ -170,7 +169,7 @@ GEM
     stackprof (0.2.13)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
     yard (0.9.20)
@@ -197,7 +196,7 @@ DEPENDENCIES
   pry-nav
   pry-rescue
   pry-stack_explorer
-  rake (~> 10.0)
+  rake (~> 13.0)
   rake-compiler (~> 1.0)
   rspec (~> 3.8)
   rubocop (= 0.71.0)
@@ -206,4 +205,4 @@ DEPENDENCIES
   stackprof (~> 0.2)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/arel_toolkit.gemspec

@@ -25,15 +25,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.extensions    = ['ext/pg_result_init/extconf.rb']
 
-  spec.add_dependency 'arel', '~> 9.0.0'
-  spec.add_dependency 'activerecord', '~> 5.2.0'
+  spec.add_dependency 'activerecord'
   spec.add_dependency 'pg', '~> 1.1.4'
-  spec.add_dependency 'pg_query', '~> 1.1.0'
+  spec.add_dependency 'pg_query', '~> 1.2.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'dpl', '~> 1.10.11'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rake-compiler', '~> 1.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'approvals', '~> 0.0.24'

data/gemfiles/active_record_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.0.0'
+
+gemspec path: '../'

data/gemfiles/active_record_6.gemfile.lock

@@ -0,0 +1,210 @@
+PATH
+  remote: ..
+  specs:
+    arel_toolkit (0.4.2)
+      activerecord
+      pg (~> 1.1.4)
+      pg_query (~> 1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    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)
+    ast (2.4.1)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    database_cleaner (1.7.0)
+    debug_inspector (0.0.3)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    dpl (1.10.15)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    github_changelog_generator (1.15.2)
+      activesupport
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+      retriable (~> 3.0)
+    guard (2.16.2)
+      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.8.5)
+      concurrent-ruby (~> 1.0)
+    interception (0.5)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    memory_profiler (0.9.14)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    nenv (0.3.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.19.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pg (1.1.4)
+    pg_query (1.2.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.1.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    pry-rescue (1.5.2)
+      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.6)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rake-compiler (1.1.1)
+      rake
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    retriable (3.1.2)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    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)
+    ruby2_keywords (0.0.2)
+    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.16)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    yard (0.9.25)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0.0)
+  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.0.2

data/gemfiles/arel_gems.gemfile.lock

@@ -32,10 +32,9 @@ PATH
   remote: ..
   specs:
     arel_toolkit (0.4.2)
-      activerecord (~> 5.2.0)
-      arel (~> 9.0.0)
+      activerecord
       pg (~> 1.1.4)
-      pg_query (~> 1.1.0)
+      pg_query (~> 1.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -155,7 +154,7 @@ GEM
       ast (~> 2.4.0)
     pg (1.1.4)
     pg_array_parser (0.0.9)
-    pg_query (1.1.1)
+    pg_query (1.2.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -189,7 +188,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rake-compiler (1.0.7)
       rake
     rb-fsevent (0.10.3)
@@ -272,7 +271,7 @@ DEPENDENCIES
   pry-nav
   pry-rescue
   pry-stack_explorer
-  rake (~> 10.0)
+  rake (~> 13.0)
   rake-compiler (~> 1.0)
   rspec (~> 3.8)
   rspec-rails (~> 3.8.0)

data/gemfiles/default.gemfile.lock

@@ -2,10 +2,9 @@ PATH
   remote: ..
   specs:
     arel_toolkit (0.4.2)
-      activerecord (~> 5.2.0)
-      arel (~> 9.0.0)
+      activerecord
       pg (~> 1.1.4)
-      pg_query (~> 1.1.0)
+      pg_query (~> 1.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -105,7 +104,7 @@ GEM
     parser (2.6.3.0)
       ast (~> 2.4.0)
     pg (1.1.4)
-    pg_query (1.1.1)
+    pg_query (1.2.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -125,7 +124,7 @@ GEM
       pry (>= 0.9.11)
     public_suffix (4.0.1)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rake-compiler (1.0.7)
       rake
     rb-fsevent (0.10.3)
@@ -197,7 +196,7 @@ DEPENDENCIES
   pry-nav
   pry-rescue
   pry-stack_explorer
-  rake (~> 10.0)
+  rake (~> 13.0)
   rake-compiler (~> 1.0)
   rspec (~> 3.8)
   rubocop (= 0.71.0)

data/lib/arel/extensions.rb

@@ -115,6 +115,7 @@ require 'arel/extensions/active_model_attribute_with_cast_value'
 require 'arel/extensions/exists'
 require 'arel/extensions/bind_param'
 require 'arel/extensions/node'
+require 'arel/extensions/top'
 
 module Arel
   module Extensions

data/lib/arel/extensions/delete_statement.rb

@@ -27,7 +27,7 @@ module Arel
       def visit_Arel_Nodes_DeleteStatement(o, collector)
         if o.with
           collector = visit o.with, collector
-          collector << SPACE
+          collector << ' '
         end
 
         collector << 'DELETE FROM '
@@ -39,8 +39,8 @@ module Arel
         end
 
         if o.wheres.any?
-          collector << WHERE
-          collector = inject_join o.wheres, collector, AND
+          collector << ' WHERE '
+          collector = inject_join o.wheres, collector, ' AND '
         end
 
         unless o.returning.empty?

data/lib/arel/extensions/function.rb

@@ -46,7 +46,7 @@ module Arel
         end
 
         if o.orders.any?
-          collector << SPACE unless o.within_group
+          collector << ' ' unless o.within_group
           collector << 'ORDER BY '
           collector = inject_join o.orders, collector, ', '
         end

data/lib/arel/extensions/infer.rb

@@ -16,7 +16,7 @@ module Arel
         if o.name
           collector << 'ON CONSTRAINT '
           collector << o.left
-          collector << SPACE
+          collector << ' '
         end
 
         if o.right

data/lib/arel/extensions/insert_statement.rb

@@ -30,7 +30,7 @@ module Arel
       def visit_Arel_Nodes_InsertStatement(o, collector)
         if o.with
           collector = visit o.with, collector
-          collector << SPACE
+          collector << ' '
         end
 
         collector << 'INSERT INTO '

data/lib/arel/extensions/select_core.rb

@@ -6,6 +6,22 @@ module Arel
   module Nodes
     class SelectCore < Arel::Nodes::Node
       attr_accessor :into
+      attr_accessor :top
+
+      private
+
+      def hash
+        [
+          @source, @set_quantifier, @projections, @optimizer_hints,
+          @wheres, @groups, @havings, @windows, @comment, @top, @into
+        ].hash
+      end
+
+      def eql?(other)
+        super &&
+          top == other.top &&
+          into == other.into
+      end
     end
   end
 
@@ -14,11 +30,9 @@ module Arel
       def visit_Arel_Nodes_SelectCore(o, collector)
         collector << 'SELECT'
 
-        collector = maybe_visit o.top, collector
-
         collector = maybe_visit o.set_quantifier, collector
 
-        collect_nodes_for o.projections, collector, SPACE
+        collect_nodes_for o.projections, collector, ' '
 
         maybe_visit o.into, collector
 
@@ -27,13 +41,13 @@ module Arel
           collector = visit o.source, collector
         end
 
-        collect_nodes_for o.wheres, collector, WHERE, AND
-        collect_nodes_for o.groups, collector, GROUP_BY
+        collect_nodes_for o.wheres, collector, ' WHERE ', ' AND '
+        collect_nodes_for o.groups, collector, ' GROUP BY '
         unless o.havings.empty?
           collector << ' HAVING '
-          inject_join o.havings, collector, AND
+          inject_join o.havings, collector, ' AND '
         end
-        collect_nodes_for o.windows, collector, WINDOW
+        collect_nodes_for o.windows, collector, ' WINDOW '
 
         collector
       end

data/lib/arel/extensions/top.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Top < Unary
+    end
+  end
+end

data/lib/arel/extensions/update_statement.rb

@@ -30,7 +30,7 @@ module Arel
       def visit_Arel_Nodes_UpdateStatement(o, collector)
         if o.with
           collector = visit o.with, collector
-          collector << SPACE
+          collector << ' '
         end
 
         wheres = if o.orders.empty? && o.limit.nil?

data/lib/arel/middleware/cache_accessor.rb

@@ -0,0 +1,35 @@
+module Arel
+  module Middleware
+    class CacheAccessor
+      attr_reader :cache
+
+      def initialize(cache)
+        @cache = cache
+      end
+
+      def read(original_sql)
+        cache.read cache_key(original_sql)
+      end
+
+      def write(transformed_sql:, transformed_binds:, original_sql:, original_binds:)
+        # To play it safe, the order of binds was changed and therefore we won't reuse the query
+        return if transformed_binds != original_binds
+
+        cache.write(cache_key(original_sql), transformed_sql)
+      end
+
+      def cache_key_for_sql(sql)
+        Digest::SHA256.hexdigest(sql)
+      end
+
+      def cache_key(sql)
+        # An important aspect of this cache key method is that it includes hashes of all active
+        # middlewares. If multiple Arel middleware chains that are using the same cache backend,
+        # this cache key mechanism will prevent cache entries leak in the wrong chain.
+
+        active_middleware_cache_key = Arel.middleware.current.map(&:hash).join('&') || 0
+        active_middleware_cache_key + '|' + cache_key_for_sql(sql)
+      end
+    end
+  end
+end

data/lib/arel/middleware/chain.rb

@@ -1,81 +1,90 @@
+require_relative './no_op_cache'
+require_relative './cache_accessor'
+
 module Arel
   module Middleware
     class Chain
-      attr_reader :executing_middleware
+      attr_reader :executing_middleware_depth
       attr_reader :executor
+      attr_reader :cache
+
+      MAX_RECURSION_DEPTH = 10
 
       def initialize(
         internal_middleware = [],
         internal_context = {},
-        executor_class = Arel::Middleware::DatabaseExecutor
+        executor_class = Arel::Middleware::DatabaseExecutor,
+        cache: nil
       )
         @internal_middleware = internal_middleware
         @internal_context = internal_context
         @executor = executor_class.new(internal_middleware)
-        @executing_middleware = false
+        @executing_middleware_depth = 0
+        @cache = cache || NoOpCache
+      end
+
+      def cache_accessor
+        @cache_accessor ||= CacheAccessor.new @cache
       end
 
       def execute(sql, binds = [], &execute_sql)
         return execute_sql.call(sql, binds).to_casted_result if internal_middleware.length.zero?
 
-        check_middleware_recursion(sql)
-
-        updated_context = context.merge(original_sql: sql)
-        enhanced_arel = Arel.enhance(Arel.sql_to_arel(sql, binds: binds))
-
-        result = executor.run(enhanced_arel, updated_context, execute_sql)
+        if (cached_sql = cache_accessor.read(sql))
+          return execute_sql.call(cached_sql, binds).to_casted_result
+        end
 
-        result.to_casted_result
+        execute_with_middleware(sql, binds, execute_sql).to_casted_result
       rescue ::PgQuery::ParseError
         execute_sql.call(sql, binds)
       ensure
-        @executing_middleware = false
+        @executing_middleware_depth -= 1
       end
 
       def current
         internal_middleware.dup
       end
 
-      def apply(middleware, &block)
+      def apply(middleware, cache: @cache, &block)
         new_middleware = Array.wrap(middleware)
-        continue_chain(new_middleware, internal_context, &block)
+        continue_chain(new_middleware, internal_context, cache: cache, &block)
       end
       alias only apply
 
       def none(&block)
-        continue_chain([], internal_context, &block)
+        continue_chain([], internal_context, cache: cache, &block)
       end
 
-      def except(without_middleware, &block)
+      def except(without_middleware, cache: @cache, &block)
         without_middleware = Array.wrap(without_middleware)
         new_middleware = internal_middleware - without_middleware
-        continue_chain(new_middleware, internal_context, &block)
+        continue_chain(new_middleware, internal_context, cache: cache, &block)
       end
 
-      def insert_before(new_middleware, existing_middleware, &block)
+      def insert_before(new_middleware, existing_middleware, cache: @cache, &block)
         new_middleware = Array.wrap(new_middleware)
         index = internal_middleware.index(existing_middleware)
         updated_middleware = internal_middleware.insert(index, *new_middleware)
-        continue_chain(updated_middleware, internal_context, &block)
+        continue_chain(updated_middleware, internal_context, cache: cache, &block)
       end
 
-      def prepend(new_middleware, &block)
+      def prepend(new_middleware, cache: @cache, &block)
         new_middleware = Array.wrap(new_middleware)
         updated_middleware = new_middleware + internal_middleware
-        continue_chain(updated_middleware, internal_context, &block)
+        continue_chain(updated_middleware, internal_context, cache: cache, &block)
       end
 
-      def insert_after(new_middleware, existing_middleware, &block)
+      def insert_after(new_middleware, existing_middleware, cache: @cache, &block)
         new_middleware = Array.wrap(new_middleware)
         index = internal_middleware.index(existing_middleware)
         updated_middleware = internal_middleware.insert(index + 1, *new_middleware)
-        continue_chain(updated_middleware, internal_context, &block)
+        continue_chain(updated_middleware, internal_context, cache: cache, &block)
       end
 
-      def append(new_middleware, &block)
+      def append(new_middleware, cache: @cache, &block)
         new_middleware = Array.wrap(new_middleware)
         updated_middleware = internal_middleware + new_middleware
-        continue_chain(updated_middleware, internal_context, &block)
+        continue_chain(updated_middleware, internal_context, cache: cache, &block)
       end
 
       def context(new_context = nil, &block)
@@ -85,7 +94,7 @@ module Arel
 
         return internal_context if new_context.nil?
 
-        continue_chain(internal_middleware, new_context, &block)
+        continue_chain(internal_middleware, new_context, cache: @cache, &block)
       end
 
       def to_sql(type, &block)
@@ -109,8 +118,23 @@ module Arel
 
       private
 
-      def continue_chain(middleware, context, &block)
-        new_chain = Arel::Middleware::Chain.new(middleware, context)
+      def execute_with_middleware(sql, binds, execute_sql)
+        check_middleware_recursion(sql)
+
+        updated_context = context.merge(
+          original_sql: sql,
+          original_binds: binds,
+          cache_accessor: cache_accessor,
+        )
+
+        arel = Arel.sql_to_arel(sql, binds: binds)
+        enhanced_arel = Arel.enhance(arel)
+
+        executor.run(enhanced_arel, updated_context, execute_sql)
+      end
+
+      def continue_chain(middleware, context, cache:, &block)
+        new_chain = Arel::Middleware::Chain.new(middleware, context, cache: cache)
         maybe_execute_block(new_chain, &block)
       end
 
@@ -125,7 +149,7 @@ module Arel
       end
 
       def check_middleware_recursion(sql)
-        if executing_middleware
+        if executing_middleware_depth > MAX_RECURSION_DEPTH
           message = <<~ERROR
             Middleware is being called from within middleware, aborting execution
             to prevent endless recursion. You can do the following if you want to execute SQL
@@ -140,7 +164,7 @@ module Arel
 
           raise message
         else
-          @executing_middleware = true
+          @executing_middleware_depth += 1
         end
       end
     end

data/lib/arel/middleware/database_executor.rb

@@ -11,12 +11,12 @@ module Arel
         @middleware = middleware
       end
 
-      def run(enhanced_arel, context, final_block)
+      def run(arel, context, final_block)
         @index = 0
         @context = context
         @final_block = final_block
 
-        result = call(enhanced_arel)
+        result = call(arel)
         check_return_type result
         result
       ensure
@@ -46,7 +46,16 @@ module Arel
 
       def execute_sql(next_arel)
         sql, binds = next_arel.to_sql_and_binds
+
+        context[:cache_accessor].write(
+          transformed_sql: sql,
+          transformed_binds: binds,
+          original_sql: context[:original_sql],
+          original_binds: context[:original_binds],
+        )
+
         sql_result = final_block.call(sql, binds)
+
         check_return_type sql_result
         sql_result
       end

data/lib/arel/middleware/no_op_cache.rb

@@ -0,0 +1,9 @@
+module Arel
+  module Middleware
+    module NoOpCache
+      def self.read(key); end
+
+      def self.write(key, sql); end
+    end
+  end
+end

data/lib/arel_toolkit.rb

@@ -5,6 +5,7 @@ require 'pg_search' if Gem.loaded_specs.key?('pg_search')
 require 'rails/railtie' if Gem.loaded_specs.key?('railties')
 require 'arel'
 require 'active_record'
+require 'active_record/connection_adapters/postgresql_adapter'
 
 require 'arel_toolkit/version'
 

data/lib/arel_toolkit/version.rb

@@ -1,3 +1,3 @@
 module ArelToolkit
-  VERSION = '0.4.2'.freeze
+  VERSION = '0.4.3'.freeze
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: arel_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - maarten
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: arel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 9.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 9.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -437,6 +423,8 @@ files:
 - ext/pg_result_init/pg_result_init.c
 - ext/pg_result_init/pg_result_init.h
 - gemfiles/.bundle/config
+- gemfiles/active_record_6.gemfile
+- gemfiles/active_record_6.gemfile.lock
 - gemfiles/arel_gems.gemfile
 - gemfiles/arel_gems.gemfile.lock
 - gemfiles/default.gemfile
@@ -548,6 +536,7 @@ files:
 - lib/arel/extensions/table.rb
 - lib/arel/extensions/time_with_precision.rb
 - lib/arel/extensions/to_sql.rb
+- lib/arel/extensions/top.rb
 - lib/arel/extensions/transaction.rb
 - lib/arel/extensions/tree_manager.rb
 - lib/arel/extensions/trim.rb
@@ -565,8 +554,10 @@ files:
 - lib/arel/extensions/with_ordinality.rb
 - lib/arel/middleware.rb
 - lib/arel/middleware/active_record_extension.rb
+- lib/arel/middleware/cache_accessor.rb
 - lib/arel/middleware/chain.rb
 - lib/arel/middleware/database_executor.rb
+- lib/arel/middleware/no_op_cache.rb
 - lib/arel/middleware/postgresql_adapter.rb
 - lib/arel/middleware/railtie.rb
 - lib/arel/middleware/result.rb
@@ -587,7 +578,7 @@ homepage: https://github.com/mvgijssel/arel_toolkit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -603,7 +594,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Collection of tools for Arel
 test_files: []