n_plus_one_control 0.2.1 → 0.5.0

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in n_plus_one_control.gemspec
-gemspec

data/Rakefile

@@ -1,13 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList['tests/**/*_test.rb']
-end
-
-RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => [:spec, :test, :rubocop]

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "n_plus_one_control"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/n_plus_one_control.gemspec

@@ -1,47 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'n_plus_one_control/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "n_plus_one_control"
-  spec.version       = NPlusOneControl::VERSION
-  spec.authors       = ["palkan"]
-  spec.email         = ["dementiev.vm@gmail.com"]
-
-  spec.summary       = "RSpec and Minitest matchers to prevent N+1 queries problem"
-  spec.required_ruby_version = '>= 2.0.0'
-  spec.description   = %{
-    RSpec and Minitest matchers to prevent N+1 queries problem.
-
-    Evaluates code under consideration several times with different scale factors
-    to make sure that the number of DB queries behaves as expected (i.e. O(1) instead of O(N)).
-
-    Example:
-
-      ```ruby
-      context "N+1", :n_plus_one do
-        populate { |n| create_list(:post, n) }
-
-        specify do
-          expect { get :index }.to perform_constant_number_of_queries
-        end
-      end
-      ```
-  }
-  spec.homepage      = "http://github.com/palkan/n_plus_one_control"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "minitest", "~> 5.9"
-  spec.add_development_dependency "factory_girl", "~> 4.8.0"
-  spec.add_development_dependency "rubocop", "~> 0.49"
-  spec.add_development_dependency "activerecord", "~> 5.1"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "pry-byebug"
-end

data/spec/n_plus_one_control/executor_spec.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe NPlusOneControl::Executor do
-  let(:populate) do
-    ->(n) { create_list(:post, n) }
-  end
-
-  let(:observable) do
-    -> { Post.find_each(&:user) }
-  end
-
-  it "raises when block is missing" do
-    expect { described_class.call(population: populate) }
-      .to raise_error(ArgumentError, "Block is required!")
-  end
-
-  it "raises when populate is missing" do
-    expect { described_class.call(&observable) }
-      .to raise_error(ArgumentError, /population/)
-  end
-
-  it "returns correct counts for default scales" do
-    result = described_class.call(
-      population: populate,
-      &observable
-    )
-
-    expect(result.size).to eq 2
-    expect(result.first[0]).to eq 2
-    expect(result.first[1].size).to eq 3
-    expect(result.last[0]).to eq 3
-    expect(result.last[1].size).to eq 4
-  end
-
-  it "returns correct counts for custom scales" do
-    result = described_class.call(
-      population: populate,
-      scale_factors: [5, 10, 100],
-      &observable
-    )
-
-    expect(result.size).to eq 3
-    expect(result.first[0]).to eq 5
-    expect(result.first[1].size).to eq 6
-    expect(result.second[0]).to eq 10
-    expect(result.second[1].size).to eq 11
-    expect(result.last[0]).to eq 100
-    expect(result.last[1].size).to eq 101
-  end
-
-  it "returns correct counts with custom match" do
-    result = described_class.call(
-      population: populate,
-      matching: /users/,
-      &observable
-    )
-
-    expect(result.first[0]).to eq 2
-    expect(result.first[1].size).to eq 2
-    expect(result.last[0]).to eq 3
-    expect(result.last[1].size).to eq 3
-  end
-end

data/spec/n_plus_one_control/rspec_spec.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe NPlusOneControl::RSpec do
-  context "when no N+1", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect { Post.preload(:user).find_each { |p| p.user.name } }
-        .to perform_constant_number_of_queries
-    end
-  end
-
-  context "when has N+1", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect do
-        expect { Post.find_each { |p| p.user.name } }
-          .to perform_constant_number_of_queries
-      end.to raise_error(RSpec::Expectations::ExpectationNotMetError)
-    end
-  end
-
-  context "when context is missing" do
-    specify do
-      expect do
-        expect { subject }.to perform_constant_number_of_queries
-      end.to raise_error(/missing tag/i)
-    end
-  end
-
-  context "when populate is missing", :n_plus_one do
-    specify do
-      expect do
-        expect { subject }.to perform_constant_number_of_queries
-      end.to raise_error(/please provide populate/i)
-    end
-  end
-
-  context "when negated" do
-    specify do
-      expect do
-        expect { subject }.not_to perform_constant_number_of_queries
-      end.to raise_error(/support negation/i)
-    end
-  end
-
-  context "when verbose", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    around(:each) do |ex|
-      NPlusOneControl.verbose = true
-      ex.run
-      NPlusOneControl.verbose = false
-    end
-
-    specify do
-      expect do
-        expect { Post.find_each { |p| p.user.name } }
-          .to perform_constant_number_of_queries
-      end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /select .+ from/i)
-    end
-  end
-
-  context "with scale_factors", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect { Post.find_each { |p| p.user.name } }
-        .to perform_constant_number_of_queries.with_scale_factors(1, 1)
-    end
-  end
-
-  context "with matching", :n_plus_one do
-    populate { |n| create_list(:post, n) }
-
-    specify do
-      expect { Post.find_each { |p| p.user.name } }
-        .to perform_constant_number_of_queries.matching(/posts/)
-    end
-  end
-end

data/spec/n_plus_one_control_spec.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe NPlusOneControl do
-  it "has a version number" do
-    expect(NPlusOneControl::VERSION).not_to be nil
-  end
-end

data/spec/spec_helper.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "n_plus_one_control/rspec"
-require "benchmark"
-require "active_record"
-require "factory_girl"
-require "pry-byebug"
-
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-RSpec.configure do |config|
-  config.mock_with :rspec
-
-  config.order = :random
-  config.filter_run focus: true
-  config.run_all_when_everything_filtered = true
-
-  config.include FactoryGirl::Syntax::Methods
-
-  config.before(:each) do
-    ActiveRecord::Base.connection.begin_transaction(joinable: false)
-  end
-
-  config.after(:each) do
-    ActiveRecord::Base.connection.rollback_transaction
-  end
-end

data/spec/support/post.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-ActiveRecord::Schema.define do
-  create_table :posts do |t|
-    t.string :title
-    t.integer :user_id
-  end
-end
-
-class Post < ActiveRecord::Base
-  belongs_to :user
-end
-
-FactoryGirl.define do
-  factory :post do
-    title "Title"
-    user
-  end
-end

data/spec/support/user.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-ActiveRecord::Schema.define do
-  create_table :users do |t|
-    t.string :name
-  end
-end
-
-class User < ActiveRecord::Base
-  has_many :posts
-end
-
-FactoryGirl.define do
-  factory :user do
-    name "John"
-  end
-end

data/tests/minitest_test.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "test_helper"
-
-class TestMinitest < Minitest::Test
-  def test_no_n_plus_one_error
-    populate = ->(n) { create_list(:post, n) }
-
-    assert_perform_constant_number_of_queries(populate: populate) do
-      Post.preload(:user).find_each { |p| p.user.name }
-    end
-  end
-
-  def test_with_n_plus_one_error
-    populate = ->(n) { create_list(:post, n) }
-
-    e = assert_raises Minitest::Assertion do
-      assert_perform_constant_number_of_queries(populate: populate) do
-        Post.find_each { |p| p.user.name }
-      end
-    end
-
-    assert_match "Expected to make the same number of queries", e.message
-    assert_match "3 for N=2", e.message
-    assert_match "4 for N=3", e.message
-  end
-
-  def test_no_n_plus_one_error_with_scale_factors
-    populate = ->(n) { create_list(:post, n) }
-
-    assert_perform_constant_number_of_queries(
-      populate: populate,
-      scale_factors: [1, 1]
-    ) do
-      Post.find_each { |p| p.user.name }
-    end
-  end
-
-  def test_no_n_plus_one_error_with_matching
-    populate = ->(n) { create_list(:post, n) }
-
-    assert_perform_constant_number_of_queries(
-      populate: populate,
-      matching: /posts/
-    ) do
-      Post.find_each { |p| p.user.name }
-    end
-  end
-
-  def populate(n)
-    create_list(:post, n)
-  end
-
-  def test_fallback_to_populate_method
-    e = assert_raises Minitest::Assertion do
-      assert_perform_constant_number_of_queries do
-        Post.find_each { |p| p.user.name }
-      end
-    end
-
-    assert_match "Expected to make the same number of queries", e.message
-  end
-end

data/tests/test_helper.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require "minitest/autorun"
-require "minitest/pride"
-
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
-Thread.abort_on_exception = true
-
-require "n_plus_one_control/minitest"
-require "benchmark"
-require "active_record"
-require "factory_girl"
-require "pry-byebug"
-
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-
-Dir["#{File.dirname(__FILE__)}/../spec/support/**/*.rb"].each { |f| require f }
-
-module TransactionalTests
-  def setup
-    ActiveRecord::Base.connection.begin_transaction(joinable: false)
-    super
-  end
-
-  def teardown
-    super
-    ActiveRecord::Base.connection.rollback_transaction
-  end
-end
-
-Minitest::Test.prepend TransactionalTests
-Minitest::Test.include FactoryGirl::Syntax::Methods