activerecord-count_loader 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b18fe399d79f7718389245f46d6c8344489c7797
-  data.tar.gz: 41ce60a38bb937a114c0edcff1b79e183e1d94d5
+  metadata.gz: 8489adecb44640ee21f220153382a63fded5759d
+  data.tar.gz: 49b3d38e965877df8269225787e5d234356aad8d
 SHA512:
-  metadata.gz: fab66eaef7777f10c7ec1778ee58f1cc2588187d8194bcb4698b6c458452e7822fd9e5fd4c47dd054f2410dde1f234788d77f292d44e32777f69516ab4b63cf7
-  data.tar.gz: 7ae932c1f0ef58173a8f679863a6292e3a8f9195445476671857b29656d51b2e85aa20edaaceb6f2e45551b775ad1f208d3c683b7352fc42d8741e75dbd12244
+  metadata.gz: 455eafc3a74e192add146c9459bbec579ab4bc54d5021678ae2f9116a8c97af82df618dbaf5d58fbf6fb20d44c37cf283b4bff0daf90ab3cea6528da7aa95082
+  data.tar.gz: 2579d3db7c17e70aab0008fcbdac5978510e1a087974ab53b5144ef25acab4b83b18bc7b21e675727c950900b4ef1cf7fcbdaae23400bc2a952091e1851c780c

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 *.sqlite3
+test/config.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.1.5
+  - ruby-head

data/README.md

@@ -1,4 +1,4 @@
-# ActiveRecord::CountLoader
+# ActiveRecord::CountLoader [![Build Status](https://travis-ci.org/k0kubun/activerecord-count_loader.svg?branch=master)](https://travis-ci.org/k0kubun/activerecord-count_loader)
 
 N+1 count query killer for ActiveRecord.  
 ActiveRecord::CountLoader allows you to cache count of associated records by eager loading.
@@ -63,6 +63,12 @@ Since it is association, you can preload nested `count_loader` association.
 end
 ```
 
+## Testing
+
+```bash
+$ bundle exec rake
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/k0kubun/activerecord-count_loader/fork )

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib" << "test"
+  t.test_files = Dir.glob("test/**/*_test.rb")
+end
+
+task default: :test

data/activerecord-count_loader.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 1.9.2"
+  spec.required_ruby_version = ">= 2.1"
   spec.add_runtime_dependency "activerecord", ">= 3.2.0"
-  spec.add_development_dependency "rspec", "~> 3.0.0"
-  spec.add_development_dependency "factory_girl", "~> 4.2.0"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "minitest", ">= 5.4"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "erubis"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "pry"
 end

data/lib/active_record/count_loader/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module CountLoader
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/test/cases/associations/eager_load_test.rb

@@ -0,0 +1,20 @@
+require 'cases/helper'
+require 'models/favorite'
+require 'models/tweet'
+
+class EagerLoadTest < ActiveRecord::CountLoader::TestCase
+  def setup
+    tweet = Tweet.create
+    Favorite.create(tweet: tweet)
+  end
+
+  def teardown
+    [Tweet, Favorite].each(&:delete_all)
+  end
+
+  def test_eager_loaded_count_loader_raises_an_error
+    assert_raises ActiveRecord::EagerLoadCountLoaderError do
+      Tweet.eager_load(:favorites_count).to_a
+    end
+  end
+end

data/test/cases/associations/includes_test.rb

@@ -0,0 +1,30 @@
+require 'cases/helper'
+
+class IncludesTest < ActiveRecord::CountLoader::TestCase
+  def setup
+    tweets_count.times.map do |index|
+      tweet = Tweet.create
+      index.times { Favorite.create(tweet: tweet) }
+    end
+  end
+
+  def teardown
+    [Tweet, Favorite].each(&:delete_all)
+  end
+
+  def tweets_count
+    3
+  end
+
+  def test_includes_does_not_execute_n_1_queries
+    assert_queries(1 + tweets_count) { Tweet.all.map { |t| t.favorites.count } }
+    assert_queries(1 + tweets_count) { Tweet.all.map(&:favorites_count) }
+    assert_queries(2) { Tweet.includes(:favorites_count).map(&:favorites_count) }
+  end
+
+  def test_included_count_loader_counts_properly
+    expected = Tweet.all.map { |t| t.favorites.count }
+    assert_equal(Tweet.all.map(&:favorites_count), expected)
+    assert_equal(Tweet.includes(:favorites_count).map(&:favorites_count), expected)
+  end
+end

data/test/cases/associations/preload_test.rb

@@ -0,0 +1,30 @@
+require 'cases/helper'
+
+class PreloadTest < ActiveRecord::CountLoader::TestCase
+  def setup
+    tweets_count.times.map do |index|
+      tweet = Tweet.create
+      index.times { Favorite.create(tweet: tweet) }
+    end
+  end
+
+  def teardown
+    [Tweet, Favorite].each(&:delete_all)
+  end
+
+  def tweets_count
+    3
+  end
+
+  def test_preload_does_not_execute_n_1_queries
+    assert_queries(1 + tweets_count) { Tweet.all.map { |t| t.favorites.count } }
+    assert_queries(1 + tweets_count) { Tweet.all.map(&:favorites_count) }
+    assert_queries(2) { Tweet.preload(:favorites_count).map(&:favorites_count) }
+  end
+
+  def test_preloaded_count_loader_counts_properly
+    expected = Tweet.all.map { |t| t.favorites.count }
+    assert_equal(Tweet.all.map(&:favorites_count), expected)
+    assert_equal(Tweet.preload(:favorites_count).map(&:favorites_count), expected)
+  end
+end

data/test/cases/helper.rb

@@ -0,0 +1,27 @@
+require 'config'
+
+require 'support/autorun'
+
+require 'active_record'
+require 'activerecord-count_loader'
+require 'cases/test_case'
+
+require 'support/config'
+require 'support/connection'
+
+# Connect to the database
+ARTest.connect
+
+def load_schema
+  # silence verbose schema loading
+  original_stdout = $stdout
+  $stdout = StringIO.new
+
+  adapter_name = ActiveRecord::Base.connection.adapter_name.downcase
+
+  load SCHEMA_ROOT + "/schema.rb"
+ensure
+  $stdout = original_stdout
+end
+
+load_schema

data/test/cases/test_case.rb

@@ -0,0 +1,86 @@
+module ActiveRecord::CountLoader
+  class TestCase < Minitest::Test
+    def teardown
+      SQLCounter.clear_log
+    end
+
+    def capture_sql
+      SQLCounter.clear_log
+      yield
+      SQLCounter.log_all.dup
+    end
+
+    def assert_sql(*patterns_to_match)
+      SQLCounter.clear_log
+      yield
+      SQLCounter.log_all
+    ensure
+      failed_patterns = []
+      patterns_to_match.each do |pattern|
+        failed_patterns << pattern unless SQLCounter.log_all.any?{ |sql| pattern === sql }
+      end
+      assert failed_patterns.empty?, "Query pattern(s) #{failed_patterns.map{ |p| p.inspect }.join(', ')} not found.#{SQLCounter.log.size == 0 ? '' : "\nQueries:\n#{SQLCounter.log.join("\n")}"}"
+    end
+
+    def assert_queries(num = 1, options = {})
+      ignore_none = options.fetch(:ignore_none) { num == :any }
+      SQLCounter.clear_log
+      x = yield
+      the_log = ignore_none ? SQLCounter.log_all : SQLCounter.log
+      if num == :any
+        assert_operator the_log.size, :>=, 1, "1 or more queries expected, but none were executed."
+      else
+        mesg = "#{the_log.size} instead of #{num} queries were executed.#{the_log.size == 0 ? '' : "\nQueries:\n#{the_log.join("\n")}"}"
+        assert_equal num, the_log.size, mesg
+      end
+      x
+    end
+
+    def assert_no_queries(options = {}, &block)
+      options.reverse_merge! ignore_none: true
+      assert_queries(0, options, &block)
+    end
+  end
+
+  class SQLCounter
+    class << self
+      attr_accessor :ignored_sql, :log, :log_all
+      def clear_log; self.log = []; self.log_all = []; end
+    end
+
+    self.clear_log
+
+    self.ignored_sql = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL, or better yet, use a different notification for the queries
+    # instead examining the SQL content.
+    oracle_ignored     = [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im, /^\s*select .* from all_constraints/im, /^\s*select .* from all_tab_cols/im]
+    mysql_ignored      = [/^SHOW TABLES/i, /^SHOW FULL FIELDS/, /^SHOW CREATE TABLE /i]
+    postgresql_ignored = [/^\s*select\b.*\bfrom\b.*pg_namespace\b/im, /^\s*select\b.*\battname\b.*\bfrom\b.*\bpg_attribute\b/im, /^SHOW search_path/i]
+    sqlite3_ignored =    [/^\s*SELECT name\b.*\bFROM sqlite_master/im]
+
+    [oracle_ignored, mysql_ignored, postgresql_ignored, sqlite3_ignored].each do |db_ignored_sql|
+      ignored_sql.concat db_ignored_sql
+    end
+
+    attr_reader :ignore
+
+    def initialize(ignore = Regexp.union(self.class.ignored_sql))
+      @ignore = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name]
+
+      self.class.log_all << sql
+      self.class.log << sql unless ignore =~ sql
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe('sql.active_record', SQLCounter.new)
+end

data/test/config.example.yml

@@ -0,0 +1,140 @@
+default_connection: <%= defined?(JRUBY_VERSION) ? 'jdbcsqlite3' : 'sqlite3' %>
+
+with_manual_interventions: false
+
+connections:
+  jdbcderby:
+    arunit:  activerecord_unittest
+    arunit2: activerecord_unittest2
+
+  jdbch2:
+    arunit:  activerecord_unittest
+    arunit2: activerecord_unittest2
+
+  jdbchsqldb:
+    arunit:  activerecord_unittest
+    arunit2: activerecord_unittest2
+
+  jdbcmysql:
+    arunit:
+      username: rails
+      encoding: utf8
+    arunit2:
+      username: rails
+      encoding: utf8
+
+  jdbcpostgresql:
+    arunit:
+      username: <%= ENV['user'] || 'rails' %>
+    arunit2:
+      username: <%= ENV['user'] || 'rails' %>
+
+  jdbcsqlite3:
+    arunit:
+      database: <%= FIXTURES_ROOT %>/fixture_database.sqlite3
+      timeout:  5000
+    arunit2:
+      database: <%= FIXTURES_ROOT %>/fixture_database_2.sqlite3
+      timeout:  5000
+
+  db2:
+    arunit:
+      adapter:  ibm_db
+      host:     localhost
+      username: arunit
+      password: arunit
+      database: arunit
+    arunit2:
+      adapter:  ibm_db
+      host:     localhost
+      username: arunit
+      password: arunit
+      database: arunit2
+
+  firebird:
+    arunit:
+      host: localhost
+      username: rails
+      password: rails
+      charset: UTF8
+    arunit2:
+      host: localhost
+      username: rails
+      password: rails
+      charset: UTF8
+
+  frontbase:
+    arunit:
+      host: localhost
+      username: rails
+      session_name: unittest-<%= $$ %>
+    arunit2:
+      host: localhost
+      username: rails
+      session_name: unittest-<%= $$ %>
+
+  mysql:
+    arunit:
+      username: rails
+      encoding: utf8
+    arunit2:
+      username: rails
+      encoding: utf8
+
+  mysql2:
+    arunit:
+      username: rails
+      encoding: utf8
+    arunit2:
+      username: rails
+      encoding: utf8
+
+  openbase:
+    arunit:
+      username: admin
+    arunit2:
+      username: admin
+
+  oracle:
+     arunit:
+       adapter: oracle_enhanced
+       database: <%= ENV['ARUNIT_DB_NAME'] || 'orcl' %>
+       username: <%= ENV['ARUNIT_USER_NAME'] || 'arunit' %>
+       password: <%= ENV['ARUNIT_PASSWORD'] || 'arunit' %>
+       emulate_oracle_adapter: true
+     arunit2:
+       adapter: oracle_enhanced
+       database: <%= ENV['ARUNIT_DB_NAME'] || 'orcl' %>
+       username: <%= ENV['ARUNIT2_USER_NAME'] || 'arunit2' %>
+       password: <%= ENV['ARUNIT2_PASSWORD'] || 'arunit2' %>
+       emulate_oracle_adapter: true
+
+  postgresql:
+    arunit:
+      min_messages: warning
+    arunit2:
+      min_messages: warning
+
+  sqlite3:
+    arunit:
+      database: <%= FIXTURES_ROOT %>/fixture_database.sqlite3
+      timeout:  5000
+    arunit2:
+      database: <%= FIXTURES_ROOT %>/fixture_database_2.sqlite3
+      timeout:  5000
+
+  sqlite3_mem:
+    arunit:
+      adapter: sqlite3
+      database: ':memory:'
+    arunit2:
+      adapter: sqlite3
+      database: ':memory:'
+
+  sybase:
+    arunit:
+      host: database_ASE
+      username: sa
+    arunit2:
+      host: database_ASE
+      username: sa

data/test/config.rb

@@ -0,0 +1,5 @@
+TEST_ROOT       = File.expand_path(File.dirname(__FILE__))
+ASSETS_ROOT     = TEST_ROOT + "/assets"
+FIXTURES_ROOT   = TEST_ROOT + "/fixtures"
+MIGRATIONS_ROOT = TEST_ROOT + "/migrations"
+SCHEMA_ROOT     = TEST_ROOT + "/schema"

data/test/models/favorite.rb

@@ -0,0 +1,3 @@
+class Favorite < ActiveRecord::Base
+  belongs_to :tweet
+end

data/test/models/tweet.rb

@@ -0,0 +1,3 @@
+class Tweet < ActiveRecord::Base
+  has_many :favorites, count_loader: true
+end

data/test/schema/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define do
+  create_table :favorites, force: true do |t|
+    t.integer  :tweet_id
+    t.integer  :user_id
+    t.datetime :created_at
+    t.timestamps
+  end
+
+  create_table :tweets, force: true do |t|
+    t.integer  :in_reply_to_tweet_id
+    t.integer  :user_id
+    t.timestamps
+  end
+end

data/test/support/autorun.rb

@@ -0,0 +1,5 @@
+gem 'minitest'
+
+require 'minitest'
+
+Minitest.autorun

data/test/support/config.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+require 'erubis'
+require 'fileutils'
+require 'pathname'
+
+module ARTest
+  class << self
+    def config
+      @config ||= read_config
+    end
+
+    private
+
+    def config_file
+      Pathname.new(ENV['ARCONFIG'] || TEST_ROOT + '/config.yml')
+    end
+
+    def read_config
+      unless config_file.exist?
+        FileUtils.cp TEST_ROOT + '/config.example.yml', config_file
+      end
+
+      erb = Erubis::Eruby.new(config_file.read)
+      expand_config(YAML.parse(erb.result(binding)).transform)
+    end
+
+    def expand_config(config)
+      config['connections'].each do |adapter, connection|
+        dbs = [['arunit', 'activerecord_unittest'], ['arunit2', 'activerecord_unittest2']]
+        dbs.each do |name, dbname|
+          unless connection[name].is_a?(Hash)
+            connection[name] = { 'database' => connection[name] }
+          end
+
+          connection[name]['database'] ||= dbname
+          connection[name]['adapter']  ||= adapter
+        end
+      end
+
+      config
+    end
+  end
+end

data/test/support/connection.rb

@@ -0,0 +1,15 @@
+module ARTest
+  def self.connection_name
+    ENV['ARCONN'] || config['default_connection']
+  end
+
+  def self.connection_config
+    config['connections'][connection_name]
+  end
+
+  def self.connect
+    puts "Using #{connection_name}"
+    ActiveRecord::Base.configurations = connection_config
+    ActiveRecord::Base.establish_connection :arunit
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-count_loader
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,35 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '5.4'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -186,6 +187,19 @@ files:
 - sample/public/robots.txt
 - sample/vendor/assets/javascripts/.keep
 - sample/vendor/assets/stylesheets/.keep
+- test/cases/associations/eager_load_test.rb
+- test/cases/associations/includes_test.rb
+- test/cases/associations/preload_test.rb
+- test/cases/helper.rb
+- test/cases/test_case.rb
+- test/config.example.yml
+- test/config.rb
+- test/models/favorite.rb
+- test/models/tweet.rb
+- test/schema/schema.rb
+- test/support/autorun.rb
+- test/support/config.rb
+- test/support/connection.rb
 homepage: https://github.com/k0kubun/activerecord-count_loader
 licenses:
 - MIT
@@ -198,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="