n_1_finder 0.0.2

data/spec/secrets.yml.example

@@ -0,0 +1,9 @@
+:pg:
+  :username: XXX
+  :password: XXX
+  :database: XXX
+
+:mysql:
+  :username: XXX
+  :password: XXX
+  :database: XXX

data/spec/shared_examples/adapter.rb

@@ -0,0 +1,37 @@
+RSpec.shared_examples 'adapter' do
+  let(:service) { described_class.new(nil) }
+
+  describe '#exec' do
+    before do
+      allow(service).to receive(:set_trap)
+      allow(service).to receive(:remove_trap)
+    end
+    subject { service.exec(&block) }
+
+    context 'when success executed block' do
+      let(:block) { -> { 'OK' } }
+
+      it 'returns passed block execution result' do
+        expect(subject).to eq 'OK'
+      end
+
+      it 'clears after self' do
+        expect(service).to receive(:remove_trap)
+        subject
+      end
+    end
+
+    context 'when block raises an error' do
+      let(:block) { -> { raise 'error' } }
+
+      it 'returns passed block execution result' do
+        expect { subject }.to raise_error 'error'
+      end
+
+      it 'clears after self' do
+        expect(service).to receive(:remove_trap)
+        expect { subject }.to raise_error 'error'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+require 'pry-nav'
+require 'bundler/setup'
+Bundler.setup
+
+require 'support/orm_helpers'
+require 'active_record'
+require 'sequel'
+require 'support/n_1_helpers.rb'
+require 'support/test_active_record_models'
+require 'support/test_active_record_migration'
+require 'support/test_sequel_models'
+require 'support/test_sequel_migration'
+require 'support/test_no_connection_models'
+require 'n_1_finder'
+
+include ORMHelpers
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.around(:each, type: :active_record_mysql) do |example|
+    use_active_record(:mysql) { example.run }
+  end
+
+  config.around(:each, type: :active_record_pg) do |example|
+    use_active_record(:pg) { example.run }
+  end
+
+  config.around(:each, type: :active_record_sqlite) do |example|
+    use_active_record(:sqlite) { example.run }
+  end
+
+  config.around(:each, type: :sequel_mysql) do |example|
+    use_sequel(:mysql) { example.run }
+  end
+
+  config.around(:each, type: :sequel_pg) do |example|
+    use_sequel(:pg) { example.run }
+  end
+
+  config.around(:each, type: :sequel_sqlite) do |example|
+    use_sequel(:sqlite) { example.run }
+  end
+
+  config.around(:each, type: :no_connection) do |example|
+    use_no_connection { example.run }
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/support/n_1_helpers.rb

@@ -0,0 +1,56 @@
+module N1Helpers
+  def populate_database
+    users = create_new_users
+    posts = create_new_posts(users)
+    documents = create_new_documents(posts)
+    create_new_links(documents)
+  end
+
+  def n_1_heavy_block
+    proc do
+      users = users_class.all.to_a               # 1 query
+      posts = users.map(&:posts).to_a.flatten    # 2 queries, N+1 should be detected
+      documents = posts.map(&:document).to_a     # 4 queries, N+1 should be detected
+      documents.map(&:links).map(&:to_a).flatten # 4 queries, N+1 should be detected
+    end
+  end
+
+  private
+
+  def create_new_users
+    [
+      users_class.create,
+      users_class.create
+    ]
+  end
+
+  def create_new_posts(users)
+    user_1, user_2 = users
+    [
+      posts_class.create(user_id: user_1.id),
+      posts_class.create(user_id: user_1.id),
+      posts_class.create(user_id: user_2.id),
+      posts_class.create(user_id: user_2.id)
+    ]
+  end
+
+  def create_new_documents(posts)
+    post_1_user_1, post_2_user_1, post_1_user_2, post_2_user_2 = posts
+    [
+      documents_class.create(post_id: post_1_user_1.id),
+      documents_class.create(post_id: post_2_user_1.id),
+      documents_class.create(post_id: post_1_user_2.id),
+      documents_class.create(post_id: post_2_user_2.id)
+    ]
+  end
+
+  def create_new_links(documents)
+    document_1, document_2, document_3, document_4 = documents
+    [
+      links_class.create(document_id: document_1.id),
+      links_class.create(document_id: document_2.id),
+      links_class.create(document_id: document_3.id),
+      links_class.create(document_id: document_4.id)
+    ]
+  end
+end

data/spec/support/orm_helpers.rb

@@ -0,0 +1,89 @@
+require 'yaml'
+
+module ORMHelpers
+  SECRETS = YAML.load(File.open('spec/secrets.yml'))
+
+  DB_PARAMS = {
+    active_record: {
+      sqlite: {
+        adapter: 'sqlite3',
+        database: ':memory:'
+      },
+      pg: {
+        adapter: 'postgresql',
+        host: 'localhost',
+        username: SECRETS[:pg][:username].to_s,
+        password: SECRETS[:pg][:password].to_s,
+        database: SECRETS[:pg][:database].to_s
+      },
+      mysql: {
+        adapter: 'mysql',
+        host: 'localhost',
+        username: SECRETS[:mysql][:username].to_s,
+        password: SECRETS[:mysql][:password].to_s,
+        database: SECRETS[:mysql][:database].to_s
+      }
+    },
+    sequel: {
+      sqlite: {
+        adapter: 'sqlite',
+        database: ':memory:'
+      },
+      pg: {
+        adapter: 'postgres',
+        host: 'localhost',
+        username: SECRETS[:pg][:username].to_s,
+        password: SECRETS[:pg][:password].to_s,
+        database: SECRETS[:pg][:database].to_s
+      },
+      mysql: {
+        adapter: 'mysql',
+        host: 'localhost',
+        username: SECRETS[:mysql][:username].to_s,
+        password: SECRETS[:mysql][:password].to_s,
+        database: SECRETS[:mysql][:database].to_s
+      }
+    }
+  }.freeze
+
+  def connect_sequel(adapter)
+    Sequel::Model.db = Sequel.connect(DB_PARAMS[:sequel][adapter])
+    TestSequelMigration.up
+  end
+
+  def connect_active_record(adapter)
+    ActiveRecord::Base.establish_connection(DB_PARAMS[:active_record][adapter])
+    silence_stream(STDOUT) { TestActiveRecordMigration.up }
+  end
+
+  def use_active_record(adapter)
+    N1Finder.orm = :active_record
+    connect_active_record(adapter)
+
+    extend TestActiveRecordModels
+    extend N1Helpers
+
+    ActiveRecord::Base.transaction do
+      yield
+      raise ActiveRecord::Rollback
+    end
+  end
+
+  def use_sequel(adapter)
+    N1Finder.orm = :sequel
+    connect_sequel(adapter)
+
+    extend TestSequelModels
+    extend N1Helpers
+
+    Sequel::Model.db.transaction(rollback: :always) do
+      yield
+    end
+  end
+
+  def use_no_connection
+    N1Finder.instance_variable_set(:@orm, :no_connection)
+    extend TestNoConnectionModels
+    yield
+  end
+end

data/spec/support/test_active_record_migration.rb

@@ -0,0 +1,46 @@
+class TestActiveRecordMigration < ActiveRecord::Migration
+  class << self
+    def up
+      create_users
+      create_posts
+      create_documents
+      create_links
+    end
+
+    private
+
+    def create_users
+      without_exists_error { create_table :users }
+    end
+
+    def create_posts
+      without_exists_error do
+        create_table :posts do |t|
+          t.integer :user_id
+        end
+      end
+    end
+
+    def create_documents
+      without_exists_error do
+        create_table :documents do |t|
+          t.integer :post_id
+        end
+      end
+    end
+
+    def create_links
+      without_exists_error do
+        create_table :links do |t|
+          t.integer :document_id
+        end
+      end
+    end
+
+    def without_exists_error
+      yield
+    rescue ActiveRecord::StatementInvalid => error
+      raise error unless error.message.include?('already exists')
+    end
+  end
+end

data/spec/support/test_active_record_models.rb

@@ -0,0 +1,56 @@
+module TestActiveRecordModels
+  def users_class
+    @users_class ||= begin
+      posts = posts_class
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'users'
+
+        def self.name
+          'User'
+        end
+
+        has_many :posts, anonymous_class: posts
+      end
+    end
+  end
+
+  def posts_class
+    @posts_class ||= begin
+      documents = documents_class
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'posts'
+
+        def self.name
+          'Post'
+        end
+
+        has_one :document, anonymous_class: documents
+      end
+    end
+  end
+
+  def documents_class
+    @documents_class ||= begin
+      links = links_class
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'documents'
+
+        def self.name
+          'Document'
+        end
+
+        has_many :links, anonymous_class: links
+      end
+    end
+  end
+
+  def links_class
+    @links_class ||= Class.new(ActiveRecord::Base) do
+      self.table_name = 'links'
+
+      def self.name
+        'Link'
+      end
+    end
+  end
+end

data/spec/support/test_no_connection_models.rb

@@ -0,0 +1,57 @@
+module TestNoConnectionModels
+  module BaseNoConnectionModel
+    def self.included(base)
+      base.include InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+      def id
+      end
+    end
+
+    module ClassMethods
+      def create(*)
+        new
+      end
+
+      def all
+      end
+    end
+  end
+
+  def users_class
+    Class.new do
+      include BaseNoConnectionModel
+
+      def posts
+        []
+      end
+    end
+  end
+
+  def posts_class
+    Class.new do
+      include BaseNoConnectionModel
+
+      def document
+      end
+    end
+  end
+
+  def documents_class
+    Class.new do
+      include BaseNoConnectionModel
+
+      def links
+        []
+      end
+    end
+  end
+
+  def links_class
+    Class.new do
+      include BaseNoConnectionModel
+    end
+  end
+end

data/spec/support/test_sequel_migration.rb

@@ -0,0 +1,39 @@
+class TestSequelMigration
+  class << self
+    def up
+      create_users
+      create_posts
+      create_documents
+      create_links
+    end
+
+    private
+
+    def create_users
+      Sequel::Model.db.create_table? :users do
+        primary_key :id
+      end
+    end
+
+    def create_posts
+      Sequel::Model.db.create_table? :posts do
+        primary_key :id
+        Integer :user_id
+      end
+    end
+
+    def create_documents
+      Sequel::Model.db.create_table? :documents do
+        primary_key :id
+        Integer :post_id
+      end
+    end
+
+    def create_links
+      Sequel::Model.db.create_table? :links do
+        primary_key :id
+        Integer :document_id
+      end
+    end
+  end
+end