active_record_extended_telescope 2.0.1

data/spec/sql_inspections/window_sql_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Active Record WINDOW Query inspection" do
+  describe "#define_window" do
+    context "when there is a single defined window" do
+      it "should only contain a single defined window statement at the bottom" do
+        query = Tag.define_window(:w_test).partition_by(:user_id).to_sql
+        expect(query).to eq('SELECT "tags".* FROM "tags" WINDOW w_test AS (PARTITION BY user_id)')
+      end
+
+      it "should return a single defined window with a defined ORDER BY" do
+        query = Tag.define_window(:w_test).partition_by(:user_id, order_by: { tags: { user_id: :desc } }).to_sql
+        expect(query).to end_with("WINDOW w_test AS (PARTITION BY user_id ORDER BY tags.user_id DESC)")
+      end
+
+      it "should place the window function below the WHERE and GROUP BY statements" do
+        query = Tag.define_window(:w_test).partition_by(:user_id).where(id: 1).group(:user_id).to_sql
+        expect(query).to eq('SELECT "tags".* FROM "tags" WHERE "tags"."id" = 1 GROUP BY "tags"."user_id" WINDOW w_test AS (PARTITION BY user_id)')
+      end
+    end
+
+    context "when there are multiple defined windows" do
+      it "should only contain a single defined window statement at the bottom" do
+        query =
+          Tag
+          .define_window(:test).partition_by(:user_id)
+          .define_window(:other_window).partition_by(:id)
+          .to_sql
+
+        expect(query).to end_with("WINDOW test AS (PARTITION BY user_id), other_window AS (PARTITION BY id)")
+      end
+
+      it "should contain each windows order by statements" do
+        query =
+          Tag
+          .define_window(:test).partition_by(:user_id, order_by: :id)
+          .define_window(:other_window).partition_by(:id, order_by: { tags: :user_id })
+          .to_sql
+
+        expect(query).to end_with("WINDOW test AS (PARTITION BY user_id ORDER BY id), other_window AS (PARTITION BY id ORDER BY tags.user_id ASC)")
+      end
+    end
+  end
+
+  describe "#window_select" do
+    let(:query_base)   { Tag.define_window(:w).partition_by(:user_id, order_by: :id) }
+    let(:expected_end) { "WINDOW w AS (PARTITION BY user_id ORDER BY id)" }
+
+    context "when using no argument window methods" do
+      [:row_to_number, :rank, :dense_rank, :percent_rank, :cume_dist].each do |window_function|
+        context "#{window_function.to_s.upcase}()" do
+          let(:expected_function) { "#{window_function.to_s.upcase}()" }
+          let(:query) do
+            query_base.select_window(window_function, over: :w, as: :window_response).to_sql
+          end
+
+          it "appends the function to the select query" do
+            expected_start = "SELECT (#{expected_function} OVER w) AS \"window_response\""
+            expect(query).to start_with(expected_start).and(end_with(expected_end))
+          end
+        end
+      end
+    end
+
+    context "when using an argument based window method" do
+      let(:argument_list) { ["a", 1, :sauce] }
+
+      { ntile: 1, lag: 2, lead: 3, first_value: 1, last_value: 1, nth_value: 2 }.each_pair do |window_function, arg_count|
+        context "#{window_function.to_s.upcase}/#{arg_count}" do
+          let(:arguments)         { argument_list.first(arg_count) }
+          let(:expected_function) { "#{window_function.to_s.upcase}(#{arguments.join(', ')})" }
+          let(:query) do
+            query_base.select_window(window_function, *arguments, over: :w, as: :window_response).to_sql
+          end
+
+          it "appends the function to the select query" do
+            expected_start = "SELECT (#{expected_function} OVER w) AS \"window_response\""
+            expect(query).to start_with(expected_start).and(end_with(expected_end))
+          end
+        end
+      end
+    end
+
+    context "when not providing a partition by value" do
+      it "should construct a window function" do
+        query =
+          Tag
+          .define_window(:no_args).partition_by(order_by: { tag_number: :desc })
+          .select_window(:row_number, over: :no_args, as: :my_row)
+          .to_sql
+
+        expect(query).to eq("SELECT (ROW_NUMBER() OVER no_args) AS \"my_row\" FROM \"tags\" WINDOW no_args AS (ORDER BY tag_number DESC)")
+      end
+    end
+  end
+end

data/spec/sql_inspections/with_cte_sql_spec.rb

@@ -0,0 +1,95 @@
+# 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.+users.+FROM.+WHERE.+users.+personal_id.+ = 1\)/ }
+
+  it "should contain WITH statement that creates the CTE table" do
+    query = User.with(personal_id_one: User.where(personal_id: 1))
+                .joins("JOIN personal_id_one ON personal_id_one.id = users.id")
+                .to_sql
+    expect(query).to match_regex(with_personal_query)
+  end
+
+  it "will maintain the CTE table when merging" do
+    query = User.all
+                .merge(User.with(personal_id_one: User.where(personal_id: 1)))
+                .joins("JOIN personal_id_one ON personal_id_one.id = users.id")
+                .to_sql
+
+    expect(query).to match_regex(with_personal_query)
+  end
+
+  it "will pipe Children CTE's into the Parent relation" do
+    personal_id_one_query = User.where(personal_id: 1)
+    personal_id_two_query = User.where(personal_id: 2)
+
+    sub_query       = personal_id_two_query.with(personal_id_one: personal_id_one_query)
+    query           = User.all.with(personal_id_two: sub_query)
+    expected_order  = User.with(
+      personal_id_one: personal_id_one_query,
+      personal_id_two: personal_id_two_query
+    )
+
+    expect(query.to_sql).to eq(expected_order.to_sql)
+  end
+
+  context "when multiple CTE's" do
+    let(:chained_with) do
+      User.with(personal_id_one: User.where(personal_id: 1))
+          .with(personal_id_two: User.where(personal_id: 2))
+          .joins("JOIN personal_id_one ON personal_id_one.id = users.id")
+          .joins("JOIN personal_id_two ON personal_id_two.id = users.id")
+          .to_sql
+    end
+
+    let(:with_arguments) do
+      User.with(personal_id_one: User.where(personal_id: 1), personal_id_two: User.where(personal_id: 2))
+          .joins("JOIN personal_id_one ON personal_id_one.id = users.id")
+          .joins("JOIN personal_id_two ON personal_id_two.id = users.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.+users.+FROM.+WHERE.+users.+personal_id.+ = 1\)/
+    end
+
+    let(:with_recursive) do
+      User.with
+          .recursive(personal_id_one: User.where(personal_id: 1))
+          .joins("JOIN personal_id_one ON personal_id_one.id = users.id")
+          .to_sql
+    end
+
+    it "generates an expression with recursive" do
+      query = User.with
+                  .recursive(personal_id_one: User.where(personal_id: 1))
+                  .joins("JOIN personal_id_one ON personal_id_one.id = users.id")
+                  .to_sql
+
+      expect(query).to match_regex(with_recursive_personal_query)
+    end
+
+    it "will maintain the CTE table when merging" do
+      sub_query = User.with.recursive(personal_id_one: User.where(personal_id: 1))
+      query     = User.merge(sub_query)
+                      .joins("JOIN personal_id_one ON personal_id_one.id = users.id")
+                      .to_sql
+
+      expect(query).to match_regex(with_recursive_personal_query)
+    end
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "database_cleaner"
+
+DatabaseCleaner.strategy = :truncation
+
+RSpec.configure do |config|
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end
+
+class User < ApplicationRecord
+  has_many :hm_tags, class_name: "Tag"
+  has_one :profile_l, class_name: "ProfileL"
+  has_one :profile_r, class_name: "ProfileR"
+  # attributes
+  # t.string   "tags",         array: true
+  # t.integer  "number",       default: 0
+  # t.string   "name"
+  # t.integer  "personal_id"
+  # t.hstore   "data"
+  # t.jsonb    "jsonb_data"
+  # t.inet     "ip"
+  # t.cidr     "subnet"
+  #
+end
+
+class StiRecord < ApplicationRecord
+  # t.string "type"
+end
+
+class AdminSti < StiRecord; end
+
+module Namespaced
+  def self.table_name_prefix
+    "namespaced_"
+  end
+
+  class Record < ApplicationRecord
+    # attributes
+    # t.inet :ip
+    # t.cidr :subnet
+    #
+  end
+end
+
+class Tag < ApplicationRecord
+  belongs_to :user
+  # attributes: tag_number
+end
+
+class ProfileL < ApplicationRecord
+  belongs_to :user
+  has_one :version, as: :versionable, class_name: "VersionControl"
+  # attributes
+  # t.integer :likes
+  #
+end
+
+class ProfileR < ApplicationRecord
+  belongs_to :user
+  has_one :version, as: :versionable, class_name: "VersionControl"
+  # attributes
+  # t.integer :dislikes
+  #
+end
+
+class VersionControl < ApplicationRecord
+  belongs_to :versionable, polymorphic: true, optional: false
+  # attributes
+  # t.jsonb :source, default: {}, null: false
+  #
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: active_record_extended_telescope
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- George Protacio-Karaszi
+- Dan McClain
+- Olivier El Mekki
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: ar_outer_joins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Adds extended functionality to Activerecord Postgres implementation
+email:
+- georgekaraszi@gmail.com
+- git@danmcclain.net
+- olivier@el-mekki.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/active_record_extended.rb
+- lib/active_record_extended/active_record.rb
+- lib/active_record_extended/active_record/relation_patch.rb
+- lib/active_record_extended/arel.rb
+- lib/active_record_extended/arel/aggregate_function_name.rb
+- lib/active_record_extended/arel/nodes.rb
+- lib/active_record_extended/arel/predications.rb
+- lib/active_record_extended/arel/sql_literal.rb
+- lib/active_record_extended/arel/visitors/postgresql_decorator.rb
+- lib/active_record_extended/patch/5_1/where_clause.rb
+- lib/active_record_extended/patch/5_2/where_clause.rb
+- lib/active_record_extended/predicate_builder/array_handler_decorator.rb
+- lib/active_record_extended/query_methods/any_of.rb
+- lib/active_record_extended/query_methods/either.rb
+- lib/active_record_extended/query_methods/inet.rb
+- lib/active_record_extended/query_methods/json.rb
+- lib/active_record_extended/query_methods/select.rb
+- lib/active_record_extended/query_methods/unionize.rb
+- lib/active_record_extended/query_methods/where_chain.rb
+- lib/active_record_extended/query_methods/window.rb
+- lib/active_record_extended/query_methods/with_cte.rb
+- lib/active_record_extended/utilities/order_by.rb
+- lib/active_record_extended/utilities/support.rb
+- lib/active_record_extended/version.rb
+- lib/active_record_extended_telescope.rb
+- spec/active_record_extended_spec.rb
+- spec/query_methods/any_of_spec.rb
+- spec/query_methods/array_query_spec.rb
+- spec/query_methods/either_spec.rb
+- spec/query_methods/hash_query_spec.rb
+- spec/query_methods/inet_query_spec.rb
+- spec/query_methods/json_spec.rb
+- spec/query_methods/select_spec.rb
+- spec/query_methods/unionize_spec.rb
+- spec/query_methods/window_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/aggregate_function_name_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/json_sql_spec.rb
+- spec/sql_inspections/unionize_sql_spec.rb
+- spec/sql_inspections/window_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
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+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: Adds extended functionality to Activerecord Postgres implementation
+test_files:
+- spec/active_record_extended_spec.rb
+- spec/query_methods/any_of_spec.rb
+- spec/query_methods/array_query_spec.rb
+- spec/query_methods/either_spec.rb
+- spec/query_methods/hash_query_spec.rb
+- spec/query_methods/inet_query_spec.rb
+- spec/query_methods/json_spec.rb
+- spec/query_methods/select_spec.rb
+- spec/query_methods/unionize_spec.rb
+- spec/query_methods/window_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/aggregate_function_name_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/json_sql_spec.rb
+- spec/sql_inspections/unionize_sql_spec.rb
+- spec/sql_inspections/window_sql_spec.rb
+- spec/sql_inspections/with_cte_sql_spec.rb
+- spec/support/database_cleaner.rb
+- spec/support/models.rb