active_record_extended_telescope 2.0.1

data/spec/sql_inspections/arel/aggregate_function_name_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Arel::Nodes::AggregateFunctionName do
+  describe "Custom Aggregate function" do
+    it "constructs an aggregate function based on a given name" do
+      query = described_class.new("MY_CUSTOM_AGG", [Arel.sql("id == me")])
+      expect(query.to_sql).to eq("MY_CUSTOM_AGG(id == me)")
+    end
+
+    it "can append multiple expressions" do
+      query = described_class.new("MY_CUSTOM_AGG", [Arel.sql("id == me"), Arel.sql("id == you")])
+      expect(query.to_sql).to eq("MY_CUSTOM_AGG(id == me, id == you)")
+    end
+
+    it "can append a distinct clause inside the aggregate" do
+      query = described_class.new("MY_CUSTOM_AGG", [Arel.sql("id == me")], true)
+      expect(query.to_sql).to eq("MY_CUSTOM_AGG(DISTINCT id == me)")
+    end
+
+    it "can append an order by clause when providing a ordering expression" do
+      order_expr = Arel.sql("id").desc
+      query      = described_class.new("MY_CUSTOM_AGG", [Arel.sql("id == me")], true).order_by([order_expr])
+      expect(query.to_sql).to eq("MY_CUSTOM_AGG(DISTINCT id == me ORDER BY id DESC)")
+    end
+
+    it "can append multiple ordering clauses" do
+      expr       = Arel.sql("id").desc
+      other_expr = Arel.sql("name").asc
+      query      = described_class.new("MY_CUSTOM_AGG", [Arel.sql("id == me")], true).order_by([expr, other_expr])
+      expect(query.to_sql).to eq("MY_CUSTOM_AGG(DISTINCT id == me ORDER BY id DESC, name ASC)")
+    end
+
+    it "can be aliased" do
+      alias_as = Arel.sql("new_name")
+      query    = described_class.new("MY_CUSTOM_AGG", [Arel.sql("id == me")], true).as(alias_as)
+      expect(query.to_sql).to eq("MY_CUSTOM_AGG(DISTINCT id == me) AS new_name")
+    end
+  end
+end

data/spec/sql_inspections/arel/array_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Array Column Predicates" do
+  let(:arel_table) { User.arel_table }
+
+  describe "Array Overlap" do
+    it "converts Arel overlap statement" do
+      query = arel_table.where(arel_table[:tags].overlap(["tag", "tag 2"])).to_sql
+      expect(query).to match_regex(/&& '\{"?tag"?,"tag 2"\}'/)
+    end
+
+    it "converts Arel overlap statement" do
+      query = arel_table.where(arel_table[:tag_ids].overlap([1, 2])).to_sql
+      expect(query).to match_regex(/&& '\{1,2\}'/)
+    end
+
+    it "works with count (and other predicates)" do
+      expect(User.where(arel_table[:tag_ids].overlap([1, 2])).count).to eq 0
+    end
+  end
+
+  describe "Array Contains" do
+    it "converts Arel contains statement and escapes strings" do
+      query = arel_table.where(arel_table[:tags].contains(["tag", "tag 2"])).to_sql
+      expect(query).to match_regex(/@> '\{"?tag"?,"tag 2"\}'/)
+    end
+
+    it "converts Arel contains statement with numbers" do
+      query = arel_table.where(arel_table[:tag_ids].contains([1, 2])).to_sql
+      expect(query).to match_regex(/@> '\{1,2\}'/)
+    end
+
+    it "works with count (and other predicates)" do
+      expect(User.where(arel_table[:tag_ids].contains([1, 2])).count).to eq 0
+    end
+  end
+
+  describe "Any Array Element" do
+    it "creates any predicates that contain a string value" do
+      query = arel_table.where(arel_table[:tags].any("tag")).to_sql
+      expect(query).to match_regex(/'tag' = ANY\("users"\."tags"\)/)
+    end
+
+    it "creates any predicates that contain a integer value" do
+      query = arel_table.where(arel_table[:tags].any(2)).to_sql
+      expect(query).to match_regex(/2 = ANY\("users"\."tags"\)/)
+    end
+  end
+
+  describe "All Array Elements" do
+    it "create all predicates that contain a string value" do
+      query = arel_table.where(arel_table[:tags].all("tag")).to_sql
+      expect(query).to match_regex(/'tag' = ALL\("users"\."tags"\)/)
+    end
+
+    it "create all predicates that contain a interger value" do
+      query = arel_table.where(arel_table[:tags].all(2)).to_sql
+      expect(query).to match_regex(/2 = ALL\("users"\."tags"\)/)
+    end
+  end
+end

data/spec/sql_inspections/arel/inet_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Inet Column Predicates" do
+  let(:arel_table) { User.arel_table }
+
+  describe "#inet_contained_within" do
+    it "converts Arel inet contained within statement" do
+      query = arel_table.where(arel_table[:ip].inet_contained_within(IPAddr.new("127.0.0.1"))).to_sql
+      expect(query).to match_regex(%r{<< '127\.0\.0\.1/32'})
+    end
+
+    it "works with count" do
+      expect(User.where(arel_table[:ip].inet_contained_within(IPAddr.new("127.0.0.1"))).count).to eq(0)
+    end
+  end
+
+  describe "#inet_contained_within_or_equals" do
+    it "converts Arel inet contained within statement" do
+      query = arel_table.where(arel_table[:ip].inet_contained_within_or_equals(IPAddr.new("127.0.0.1"))).to_sql
+      expect(query).to match_regex(%r{<<= '127\.0\.0\.1/32'})
+    end
+
+    it "works with count" do
+      expect(User.where(arel_table[:ip].inet_contained_within_or_equals(IPAddr.new("127.0.0.1"))).count).to eq(0)
+    end
+  end
+
+  describe "#inet_contains_or_equals" do
+    it "converts Arel inet contained within statement" do
+      query = arel_table.where(arel_table[:ip].inet_contains_or_equals(IPAddr.new("127.0.0.1"))).to_sql
+      expect(query).to match_regex(%r{>>= '127\.0\.0\.1/32'})
+    end
+
+    it "works with count" do
+      expect(User.where(arel_table[:ip].inet_contains_or_equals(IPAddr.new("127.0.0.1"))).count).to eq(0)
+    end
+  end
+
+  describe "#inet_contains" do
+    it "converts Arel inet contained within statement" do
+      query = arel_table.where(arel_table[:ip].inet_contains("127.0.0.1")).to_sql
+      expect(query).to match_regex(/>> '127\.0\.0\.1'/)
+    end
+
+    it "works with count" do
+      expect(User.where(arel_table[:ip].inet_contains("127.0.0.1")).count).to eq(0)
+    end
+  end
+
+  describe "#inet_contains_or_is_contained_within" do
+    it "converts Arel inet contained within statement" do
+      query = arel_table.where(arel_table[:ip].inet_contains_or_is_contained_within("127.0.0.1")).to_sql
+      expect(query).to match_regex(/&& '127\.0\.0\.1'/)
+
+      query = arel_table.where(arel_table[:ip].inet_contains_or_is_contained_within(IPAddr.new("127.0.0.1"))).to_sql
+      expect(query).to match_regex(%r{&& '127\.0\.0\.1/32'})
+    end
+
+    it "works with count" do
+      expect(User.where(arel_table[:ip].inet_contains_or_is_contained_within("127.0.0.1")).count).to eq(0)
+      expect(User.where(arel_table[:ip].inet_contains_or_is_contained_within(IPAddr.new("127.0.0.1"))).count).to eq(0)
+    end
+  end
+end

data/spec/sql_inspections/contains_sql_queries_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Contains SQL Queries" do
+  let(:contains_array_regex)      { /"users"\."tag_ids" @> '\{1,2\}'/ }
+  let(:contains_hstore_regex)     { /"users"\."data" @> '"nickname"=>"Dan"'/ }
+  let(:contains_jsonb_regex)      { /"users"\."jsonb_data" @> '\{"nickname":"Dan"}'/ }
+  let(:contained_in_array_regex)  { /"users"\."tag_ids" <@ '\{1,2\}'/ }
+  let(:contained_in_hstore_regex) { /"users"\."data" <@ '"nickname"=>"Dan"'/ }
+  let(:contained_in_jsonb_regex) { /"users"\."jsonb_data" <@ '\{"nickname":"Dan"}'/ }
+  let(:contains_equals_regex)     { /"users"\."ip" >>= '127.0.0.1'/ }
+  let(:equality_regex)            { /"users"\."tags" = '\{"?working"?\}'/ }
+
+  describe ".where.contains(:column => value)" do
+    it "generates the appropriate where clause for array columns" do
+      query = User.where.contains(tag_ids: [1, 2]).to_sql
+      expect(query).to match_regex(contains_array_regex)
+    end
+
+    it "generates the appropriate where clause for hstore columns" do
+      query = User.where.contains(data: { nickname: "Dan" }).to_sql
+      expect(query).to match_regex(contains_hstore_regex)
+    end
+
+    it "generates the appropriate where clause for jsonb columns" do
+      query = User.where.contains(jsonb_data: { nickname: "Dan" }).to_sql
+      expect(query).to match_regex(contains_jsonb_regex)
+    end
+
+    it "generates the appropriate where clause for hstore columns on joins" do
+      query = Tag.joins(:user).where.contains(users: { data: { nickname: "Dan" } }).to_sql
+      expect(query).to match_regex(contains_hstore_regex)
+    end
+
+    it "allows chaining" do
+      query = User.where.contains(tag_ids: [1, 2]).where(tags: ["working"]).to_sql
+      expect(query).to match_regex(contains_array_regex)
+      expect(query).to match_regex(equality_regex)
+    end
+
+    it "generates the appropriate where clause for array columns on joins" do
+      query = Tag.joins(:user).where.contains(users: { tag_ids: [1, 2] }).to_sql
+      expect(query).to match_regex(contains_array_regex)
+    end
+  end
+end

data/spec/sql_inspections/either_sql_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Either Methods SQL Queries" do
+  let(:contains_array_regex) { /"users"\."tag_ids" @> '\{1,2\}'/ }
+  let(:profile_l_outer_join) { /LEFT OUTER JOIN "profile_ls" ON "profile_ls"."user_id" = "users"."id"/ }
+  let(:profile_r_outer_join) { /LEFT OUTER JOIN "profile_rs" ON "profile_rs"."user_id" = "users"."id"/ }
+  let(:where_join_case) do
+    "WHERE ((CASE WHEN profile_ls.user_id IS NULL"\
+    " THEN profile_rs.user_id"\
+    " ELSE profile_ls.user_id END) "\
+    "= users.id)"
+  end
+
+  let(:order_case) do
+    "ORDER BY "\
+    "(CASE WHEN profile_ls.likes IS NULL"\
+    " THEN profile_rs.dislikes"\
+    " ELSE profile_ls.likes END)"
+  end
+
+  describe ".either_join/2" do
+    it "Should contain outer joins on the provided relationships" do
+      query = User.either_join(:profile_l, :profile_r).to_sql
+      expect(query).to match_regex(profile_l_outer_join)
+      expect(query).to match_regex(profile_r_outer_join)
+    end
+
+    it "Should contain a case statement that will conditionally alternative between tables" do
+      query = User.either_join(:profile_l, :profile_r).to_sql
+      expect(query).to include(where_join_case)
+    end
+  end
+
+  describe ".either_order/2" do
+    let(:ascended_order)  { User.either_order(:asc, profile_l: :likes, profile_r: :dislikes).to_sql }
+    let(:descended_order) { User.either_order(:desc, profile_l: :likes, profile_r: :dislikes).to_sql }
+
+    it "Should contain outer joins on the provided relationships" do
+      expect(ascended_order).to match_regex(profile_l_outer_join)
+      expect(ascended_order).to match_regex(profile_r_outer_join)
+      expect(descended_order).to match_regex(profile_l_outer_join)
+      expect(descended_order).to match_regex(profile_r_outer_join)
+    end
+
+    it "Should contain a relational ordering case statement for a relations column" do
+      expect(ascended_order).to include(order_case)
+      expect(ascended_order).to end_with("asc")
+
+      expect(descended_order).to include(order_case)
+      expect(descended_order).to end_with("desc")
+    end
+  end
+end

data/spec/sql_inspections/json_sql_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "JSON Methods SQL Queries" do
+  let(:single_with)      { /^WITH .all_others. AS(?!.*WITH \w?)/mi }
+  let(:override_with)    { /^WITH .all_others. AS \(.+WHERE .users.\..id. = 10\)/mi }
+
+  describe ".select_row_to_json" do
+    context "when a subquery contains a CTE table" do
+      let(:cte_person) { User.with(all_others: User.where.not(id: 1)).where(id: 2) }
+
+      it "should push the CTE to the callee's level" do
+        query = User.select_row_to_json(cte_person, as: :results).to_sql
+        expect(query).to match_regex(single_with)
+      end
+
+      it "should favor the parents CTE table if names collide" do
+        query = User.with(all_others: User.where(id: 10))
+        query = query.select_row_to_json(cte_person, as: :results).to_sql
+
+        expect(query).to match_regex(single_with)
+        expect(query).to match_regex(override_with)
+      end
+    end
+
+    context "When adding cast_with: option" do
+      it "should wrap the row_to_json expression with to_jsonb" do
+        query = User.select_row_to_json(User.where(id: 10), cast_with: :to_jsonb, key: :convert_this, as: :results).to_sql
+        expect(query).to match_regex(/SELECT \(SELECT TO_JSONB\(ROW_TO_JSON\("convert_this"\)\) FROM \(.+\).+\) AS "results"/)
+      end
+
+      it "should cast object to an array" do
+        query = User.select_row_to_json(User.where(id: 10), cast_with: :array, key: :convert_this, as: :results).to_sql
+        expect(query).to match_regex(/SELECT \(ARRAY\(SELECT ROW_TO_JSON\("convert_this"\) FROM \(.+\).+\)\) AS "results"/)
+      end
+
+      it "should cast object to an aggregated array" do
+        query = User.select_row_to_json(User.where(id: 10), cast_with: :array_agg, key: :convert_this, as: :results).to_sql
+        expect(query).to match_regex(/SELECT \(ARRAY_AGG\(\(SELECT TO_JSONB\(ROW_TO_JSON\("convert_this"\)\) FROM \(.+\).+\)\)\) AS "results"/)
+      end
+
+      context "When multiple cast_with options are used" do
+        it "should cast query with to_jsonb and as an Array" do
+          query = User.select_row_to_json(User.where(id: 10), cast_with: [:to_jsonb, :array], key: :convert_this, as: :results).to_sql
+          expect(query).to match_regex(/SELECT \(ARRAY\(SELECT TO_JSONB\(ROW_TO_JSON\("convert_this"\)\) FROM \(.+\).+\)\) AS "results"/)
+        end
+
+        it "should cast query as a distinct Aggregated Array" do
+          query = User.select_row_to_json(User.where(id: 10), cast_with: [:array_agg, :distinct], key: :convert_this, as: :results).to_sql
+          expect(query).to match_regex(/SELECT \(ARRAY_AGG\(DISTINCT \(SELECT TO_JSONB\(ROW_TO_JSON\("convert_this"\)\) FROM \(.+\).+\)\)\) AS "results"/)
+        end
+      end
+    end
+
+    context "when the subquery is a STI record type" do
+      it "should not append sti 'type IN(..)' where clauses to the nested query" do
+        query = User.select_row_to_json(AdminSti.where(id: 10), cast_with: :array, key: :convert_this, as: :results).to_sql
+        expect(query).to match_regex(/SELECT \(ARRAY\(SELECT ROW_TO_JSON\("convert_this"\) FROM \(.*\) convert_this\)\) AS .+/)
+      end
+    end
+  end
+
+  describe ".json_build_object" do
+    context "when a subquery contains a CTE table" do
+      let(:cte_person) { User.with(all_others: User.where.not(id: 1)).where(id: 2) }
+
+      it "should push the CTE to the callee's level" do
+        query = User.json_build_object(:userss, cte_person).to_sql
+        expect(query).to match_regex(single_with)
+      end
+
+      it "should favor the parents CTE table if names collide" do
+        query = User.with(all_others: User.where(id: 10))
+        query = query.json_build_object(:users, cte_person).to_sql
+
+        expect(query).to match_regex(single_with)
+        expect(query).to match_regex(override_with)
+      end
+    end
+  end
+end

data/spec/sql_inspections/unionize_sql_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Union SQL Queries" do
+  let(:user)       { User.where(id: 1) }
+  let(:other_user) { User.where("id = 2") }
+
+  shared_examples_for "unions" do
+    it { is_expected.to eq("( (#{user.to_sql}) #{described_union} (#{other_user.to_sql}) )") }
+  end
+
+  shared_examples_for "piping nest CTE tables" do
+    let(:cte_user)      { User.with(all_others: User.where.not(id: 1)).where(id: 2) }
+    let(:method)        { raise "Required to override this method!" }
+    let(:single_with)   { /^WITH .all_others. AS(?!.*WITH \w?)/mi }
+    let(:override_with) { /^WITH .all_others. AS \(.+WHERE .users.\..id. = 10\)/mi }
+
+    it "should push the CTE to the callee's level" do
+      query = User.send(method.to_sym, cte_user, other_user).to_sql
+      expect(query).to match_regex(single_with)
+    end
+
+    it "should favor the parents CTE table if names collide" do
+      query = User.with(all_others: User.where(id: 10))
+      query = query.send(method.to_sym, cte_user, other_user).to_sql
+
+      expect(query).to match_regex(single_with)
+      expect(query).to match_regex(override_with)
+    end
+  end
+
+  describe ".union" do
+    let!(:described_union)     { "UNION" }
+    subject(:described_method) { User.union(user, other_user).to_union_sql }
+    it_behaves_like "unions"
+    it_behaves_like "piping nest CTE tables" do
+      let!(:method) { :union }
+    end
+  end
+
+  describe ".union.all" do
+    let!(:described_union)     { "UNION ALL" }
+    subject(:described_method) { User.union.all(user, other_user).to_union_sql }
+    it_behaves_like "unions"
+    it_behaves_like "piping nest CTE tables" do
+      let!(:method) { :union_all }
+    end
+  end
+
+  describe ".union.except" do
+    let!(:described_union)     { "EXCEPT" }
+    subject(:described_method) { User.union.except(user, other_user).to_union_sql }
+    it_behaves_like "unions"
+    it_behaves_like "piping nest CTE tables" do
+      let!(:method) { :union_except }
+    end
+  end
+
+  describe "union.intersect" do
+    let!(:described_union)     { "INTERSECT" }
+    subject(:described_method) { User.union.intersect(user, other_user).to_union_sql }
+    it_behaves_like "unions"
+    it_behaves_like "piping nest CTE tables" do
+      let!(:method) { :union_intersect }
+    end
+  end
+
+  describe "union.as" do
+    context "when a union.as has been called" do
+      subject(:described_method) do
+        User.select("happy_users.id").union(user, other_user).union.as(:happy_users).to_sql
+      end
+
+      it "should alias the union from clause to 'happy_users'" do
+        expect(described_method).to match_regex(/FROM \(+.+\) UNION \(.+\)+ happy_users$/)
+        expect(described_method).to match_regex(/^SELECT (happy_users\.id|"happy_users"\."id") FROM.+happy_users$/)
+      end
+    end
+
+    context "when user.as hasn't been called" do
+      subject(:described_method) { User.select(:id).union(user, other_user).to_sql }
+
+      it "should retain the actual class calling table name as the union alias" do
+        expect(described_method).to match_regex(/FROM \(+.+\) UNION \(.+\)+ users$/)
+        expect(described_method).to match_regex(/^SELECT "users"\."id" FROM.+users$/)
+      end
+    end
+  end
+
+  describe "union.order" do
+    context "when rendering with .to_union_sql" do
+      subject(:described_method) { User.union(user, other_user).union.order(:id, name: :desc).to_union_sql }
+
+      it "Should append an 'ORDER BY' to the end of the union statements" do
+        expect(described_method).to match_regex(/^\(+.+\) UNION \(.+\) \) ORDER BY id, name DESC$/)
+      end
+    end
+
+    context "when rendering with .to_sql" do
+      subject(:described_method) { User.union(user, other_user).union.order(:id, name: :desc).to_sql }
+
+      it "Should append an 'ORDER BY' to the end of the union statements" do
+        expect(described_method).to match_regex(/FROM \(+.+\) UNION \(.+\) \) ORDER BY id, name DESC\) users$/)
+      end
+    end
+
+    context "when a there are multiple union statements" do
+      let(:query_regex) { /(?<=\)\s(ORDER BY)) id/ }
+
+      it "should only append an order by to the very end of a union statements" do
+        query = User.union.order(id: :asc, tags: :desc)
+                    .union(user.order(id: :asc, tags: :desc))
+                    .union(user.order(:id, :tags))
+                    .union(other_user.order(id: :desc, tags: :desc))
+                    .to_union_sql
+
+        index = query.index(query_regex)
+        expect(index).to be_truthy
+        expect(query[index..-1]).to eq(" id ASC, tags DESC")
+      end
+    end
+  end
+end