active_record_extended 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e7c1bd1aaee6cd16497cd2f64bed3f06907a31ac48059da909dc33c0f4caa26
-  data.tar.gz: 5d1e21f8547272af210b11c7590e7094e69eeaad6714a50f76566b04eef3003e
+  metadata.gz: d3332acf1ce7aa530fcbaddc871d5bdfc4560f71794fc4efbdd33653c6ea1eb5
+  data.tar.gz: 73df494665607c73c5ddb2999aa0e021e166fc436a1cd75784cd1ffa30e1fe9e
 SHA512:
-  metadata.gz: 320aa807eded4abeb5f519b7e58b66a4cdaba77f62eaa0549bffeddc000bf6426726733337dd3dfc18e1c651594c7f2fb4f09c32f4d9bbe640a71abe16ce5fda
-  data.tar.gz: 3e8ffdc9e76ea8eb5ec47dba4d8d795bbcda5f780879213fc385074dea024ab01851b4b552631cb1011b2b83a949416348efbd749c442255e76b00e4ebcd9f38
+  metadata.gz: 94c04d0fb830fd9e4b7f0b21bea2fb7a3b753903f4fb41ffb71fc72ed147ac3247507438411a37bf74235aaea943c2f98b5b5141467cf09b663dd9930269d2f0
+  data.tar.gz: 3c5915ec558d623704dc4b824f052639dc25df2a0c0385f143eb597f4984f4beab1ef1d4083c7fbbf696ac0314b3ddd860640f8ecdc601681a4b042fe0224256

data/lib/active_record_extended/active_record.rb

@@ -2,10 +2,16 @@
 
 require "active_record"
 require "active_record/relation"
+require "active_record/relation/merger"
 require "active_record/relation/query_methods"
 
 require "active_record_extended/predicate_builder/array_handler_decorator"
-Dir["#{File.dirname(__FILE__)}/query_methods/**/*.rb"].each { |f| require File.expand_path(f) }
+
+require "active_record_extended/query_methods/where_chain"
+require "active_record_extended/query_methods/with_cte"
+require "active_record_extended/query_methods/any_of"
+require "active_record_extended/query_methods/either"
+require "active_record_extended/query_methods/inet"
 
 if ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR <= 1
   if ActiveRecord::VERSION::MINOR.zero?

data/lib/active_record_extended/arel.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 require "active_record_extended/arel/nodes"

data/lib/active_record_extended/query_methods/with_cte.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module ActiveRecordExtended
+  module QueryMethods
+    module MergerCTE
+      def normal_values
+        super + [:with]
+      end
+    end
+
+    module QueryDelegationCTE
+      delegate :with, to: :all
+    end
+
+    module WithCTE
+      class WithChain
+        def initialize(scope)
+          @scope = scope
+        end
+
+        def recursive(*args)
+          @scope.tap do |scope|
+            scope.with_values    += args
+            scope.recursive_value = true
+          end
+        end
+      end
+
+      def with_values
+        @values[:with] || []
+      end
+
+      def with_values?
+        !(@values[:with].nil? || @values[:with].empty?)
+      end
+
+      def with_values=(values)
+        @values[:with] = values
+      end
+
+      def recursive_value=(value)
+        raise ImmutableRelation if @loaded
+        @values[:recursive] = value
+      end
+
+      def recursive_value
+        @values[:recursive]
+      end
+      alias recursive_value? recursive_value
+
+      def with(opts = :chain, *rest)
+        return WithChain.new(spawn) if opts == :chain
+        opts.blank? ? self : spawn.with!(opts, *rest)
+      end
+
+      def with!(opts = :chain, *rest)
+        return WithChain.new(self) if opts == :chain
+        self.with_values += [opts] + rest
+        self
+      end
+
+      def build_arel(*aliases)
+        super.tap do |arel|
+          build_with(arel) if with_values?
+        end
+      end
+
+      def build_with_hashed_value(with_value)
+        with_value.map do |name, expression|
+          select =
+            case expression
+            when String
+              Arel::Nodes::SqlLiteral.new("(#{expression})")
+            when ActiveRecord::Relation, Arel::SelectManager
+              Arel::Nodes::SqlLiteral.new("(#{expression.to_sql})")
+            end
+          next if select.nil?
+          Arel::Nodes::As.new(Arel::Nodes::SqlLiteral.new(PG::Connection.quote_ident(name.to_s)), select)
+        end
+      end
+
+      def build_with(arel)
+        with_statements = with_values.flat_map do |with_value|
+          case with_value
+          when String, Arel::Nodes::As
+            with_value
+          when Hash
+            build_with_hashed_value(with_value)
+          end
+        end.compact
+
+        return if with_statements.empty?
+        recursive_value? ? arel.with(:recursive, with_statements) : arel.with(with_statements)
+      end
+    end
+  end
+end
+
+ActiveRecord::Relation.prepend(ActiveRecordExtended::QueryMethods::WithCTE)
+ActiveRecord::Relation::Merger.prepend(ActiveRecordExtended::QueryMethods::MergerCTE)
+ActiveRecord::Querying.prepend(ActiveRecordExtended::QueryMethods::QueryDelegationCTE)

data/lib/active_record_extended/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordExtended
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/query_methods/any_of_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "spec_helper"
+
 RSpec.describe "Active Record Any / None of Methods" do
   let!(:one)       { Person.create!(personal_id: 1) }
   let!(:two)       { Person.create!(personal_id: 2) }

data/spec/query_methods/with_cte_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Active Record With CTE Query Methods" do
+  let!(:person_one)  { Person.create! }
+  let!(:person_two)  { Person.create! }
+  let!(:profile_one) { ProfileL.create!(person_id: person_one.id, likes: 200) }
+  let!(:profile_two) { ProfileL.create!(person_id: person_two.id, likes: 500) }
+
+  describe ".with/1" do
+    context "when using as a standalone query" do
+      it "should only return a person with less than 300 likes" do
+        query = Person.with(profile: ProfileL.where("likes < 300"))
+                      .joins("JOIN profile ON profile.id = people.id")
+
+        expect(query).to match_array([person_one])
+      end
+
+      it "should return anyone with likes greater than or equal to 200" do
+        query = Person.with(profile: ProfileL.where("likes >= 200"))
+                      .joins("JOIN profile ON profile.id = people.id")
+
+        expect(query).to match_array([person_one, person_two])
+      end
+    end
+
+    context "when merging in query" do
+      let!(:version_one) { VersionControl.create!(versionable: profile_one, source: { help: "me" }) }
+      let!(:version_two) { VersionControl.create!(versionable: profile_two, source: { help: "no one" }) }
+
+      it "will maintain the CTE table when merging into existing AR queries" do
+        sub_query = ProfileL.with(version_controls: VersionControl.where.contains(source: { help: "me" }))
+        query     = Person.joins(profile_l: :version).merge(sub_query)
+
+        expect(query).to match_array([person_one])
+      end
+    end
+  end
+end

data/spec/sql_inspections/with_cte_sql_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Active Record WITH CTE tables" do
+  let(:with_personal_query) { /WITH.+personal_id_one.+AS \(SELECT.+people.+FROM.+WHERE.+people.+personal_id.+ = 1\)/ }
+
+  it "should contain WITH statement that creates the CTE table" do
+    query = Person.with(personal_id_one: Person.where(personal_id: 1))
+                  .joins("JOIN personal_id_one ON personal_id_one.id = people.id")
+                  .to_sql
+    expect(query).to match_regex(with_personal_query)
+  end
+
+  it "will maintain the CTE table when merging" do
+    query = Person.all
+                  .merge(Person.with(personal_id_one: Person.where(personal_id: 1)))
+                  .joins("JOIN personal_id_one ON personal_id_one.id = people.id")
+                  .to_sql
+
+    expect(query).to match_regex(with_personal_query)
+  end
+
+  context "when multiple CTE's" do
+    let(:chained_with) do
+      Person.with(personal_id_one: Person.where(personal_id: 1))
+            .with(personal_id_two: Person.where(personal_id: 2))
+            .joins("JOIN personal_id_one ON personal_id_one.id = people.id")
+            .joins("JOIN personal_id_two ON personal_id_two.id = people.id")
+            .to_sql
+    end
+
+    let(:with_arguments) do
+      Person.with(personal_id_one: Person.where(personal_id: 1), personal_id_two: Person.where(personal_id: 2))
+            .joins("JOIN personal_id_one ON personal_id_one.id = people.id")
+            .joins("JOIN personal_id_two ON personal_id_two.id = people.id")
+            .to_sql
+    end
+    it "Should only contain a single WITH statement" do
+      expect(with_arguments.scan(/WITH/).count).to eq(1)
+      expect(with_arguments.scan(/AS/).count).to eq(2)
+    end
+
+    it "Should only contain a single WITH statement when chaining" do
+      expect(chained_with.scan(/WITH/).count).to eq(1)
+      expect(chained_with.scan(/AS/).count).to eq(2)
+    end
+  end
+
+  context "when chaining the recursive method" do
+    let(:with_recursive_personal_query) do
+      /WITH.+RECURSIVE.+personal_id_one.+AS \(SELECT.+people.+FROM.+WHERE.+people.+personal_id.+ = 1\)/
+    end
+
+    let(:with_recursive) do
+      Person.with
+            .recursive(personal_id_one: Person.where(personal_id: 1))
+            .joins("JOIN personal_id_one ON personal_id_one.id = people.id")
+            .to_sql
+    end
+
+    it "generates an expression with recursive" do
+      expect(with_recursive).to match_regex(with_recursive_personal_query)
+    end
+  end
+end

data/spec/support/models.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 class Person < ActiveRecord::Base
@@ -13,8 +12,14 @@ end
 
 class ProfileL < ActiveRecord::Base
   belongs_to :person
+  has_one :version, as: :versionable, class_name: "VersionControl"
 end
 
 class ProfileR < ActiveRecord::Base
   belongs_to :person
+  has_one :version, as: :versionable, class_name: "VersionControl"
+end
+
+class VersionControl < ActiveRecord::Base
+  belongs_to :versionable, polymorphic: true, optional: false
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_extended
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - George Protacio-Karaszi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2018-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -160,6 +160,7 @@ files:
 - lib/active_record_extended/query_methods/either.rb
 - lib/active_record_extended/query_methods/inet.rb
 - lib/active_record_extended/query_methods/where_chain.rb
+- lib/active_record_extended/query_methods/with_cte.rb
 - lib/active_record_extended/version.rb
 - spec/active_record_extended_spec.rb
 - spec/query_methods/any_of_spec.rb
@@ -167,12 +168,14 @@ files:
 - spec/query_methods/either_spec.rb
 - spec/query_methods/hash_query_spec.rb
 - spec/query_methods/inet_query_spec.rb
+- spec/query_methods/with_cte_spec.rb
 - spec/spec_helper.rb
 - spec/sql_inspections/any_of_sql_spec.rb
 - spec/sql_inspections/arel/array_spec.rb
 - spec/sql_inspections/arel/inet_spec.rb
 - spec/sql_inspections/contains_sql_queries_spec.rb
 - spec/sql_inspections/either_sql_spec.rb
+- spec/sql_inspections/with_cte_sql_spec.rb
 - spec/support/database_cleaner.rb
 - spec/support/models.rb
 homepage: https://github.com/georgekaraszi/ActiveRecordExtended
@@ -206,11 +209,13 @@ test_files:
 - spec/query_methods/either_spec.rb
 - spec/query_methods/hash_query_spec.rb
 - spec/query_methods/inet_query_spec.rb
+- spec/query_methods/with_cte_spec.rb
 - spec/spec_helper.rb
 - spec/sql_inspections/any_of_sql_spec.rb
 - spec/sql_inspections/arel/array_spec.rb
 - spec/sql_inspections/arel/inet_spec.rb
 - spec/sql_inspections/contains_sql_queries_spec.rb
 - spec/sql_inspections/either_sql_spec.rb
+- spec/sql_inspections/with_cte_sql_spec.rb
 - spec/support/database_cleaner.rb
 - spec/support/models.rb