RubyGems - activerecord-precount - Versions diffs - 0.4.0 - Mend

activerecord-precount 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (96) hide show

checksums.yaml +7 -0
data/.gitignore +19 -0
data/.travis.yml +28 -0
data/Gemfile +6 -0
data/LICENSE +22 -0
data/README.md +91 -0
data/Rakefile +14 -0
data/activerecord-precount.gemspec +31 -0
data/benchmark.rb +42 -0
data/ci/Gemfile.activerecord-4.1.x +4 -0
data/ci/Gemfile.activerecord-4.2.x +4 -0
data/ci/travis.rb +14 -0
data/lib/active_record/associations/builder/count_loader.rb +13 -0
data/lib/active_record/associations/count_loader.rb +27 -0
data/lib/active_record/associations/preloader/count_loader.rb +41 -0
data/lib/active_record/precount/base_extension.rb +7 -0
data/lib/active_record/precount/extend.rb +18 -0
data/lib/active_record/precount/has_many_extension.rb +25 -0
data/lib/active_record/precount/join_dependency_extension.rb +23 -0
data/lib/active_record/precount/preloader_extension.rb +15 -0
data/lib/active_record/precount/reflection_extension.rb +50 -0
data/lib/active_record/precount/relation_extension.rb +42 -0
data/lib/active_record/precount/version.rb +5 -0
data/lib/activerecord-precount.rb +8 -0
data/sample/.gitignore +16 -0
data/sample/Gemfile +19 -0
data/sample/README.md +6 -0
data/sample/Rakefile +6 -0
data/sample/app/assets/images/.keep +0 -0
data/sample/app/assets/javascripts/application.js +16 -0
data/sample/app/assets/stylesheets/application.css +15 -0
data/sample/app/controllers/application_controller.rb +13 -0
data/sample/app/controllers/concerns/.keep +0 -0
data/sample/app/helpers/application_helper.rb +2 -0
data/sample/app/mailers/.keep +0 -0
data/sample/app/models/.keep +0 -0
data/sample/app/models/concerns/.keep +0 -0
data/sample/app/models/favorite.rb +4 -0
data/sample/app/models/tweet.rb +6 -0
data/sample/app/models/user.rb +4 -0
data/sample/app/views/application/index.html.erb +49 -0
data/sample/app/views/layouts/application.html.erb +14 -0
data/sample/bin/bundle +3 -0
data/sample/bin/rails +8 -0
data/sample/bin/rake +8 -0
data/sample/bin/spring +18 -0
data/sample/config.ru +4 -0
data/sample/config/application.rb +30 -0
data/sample/config/boot.rb +4 -0
data/sample/config/database.yml +11 -0
data/sample/config/environment.rb +5 -0
data/sample/config/environments/development.rb +40 -0
data/sample/config/environments/production.rb +82 -0
data/sample/config/environments/test.rb +39 -0
data/sample/config/initializers/assets.rb +8 -0
data/sample/config/initializers/backtrace_silencers.rb +7 -0
data/sample/config/initializers/cookies_serializer.rb +3 -0
data/sample/config/initializers/filter_parameter_logging.rb +4 -0
data/sample/config/initializers/inflections.rb +16 -0
data/sample/config/initializers/mime_types.rb +4 -0
data/sample/config/initializers/session_store.rb +3 -0
data/sample/config/initializers/wrap_parameters.rb +14 -0
data/sample/config/locales/en.yml +23 -0
data/sample/config/routes.rb +3 -0
data/sample/config/secrets.yml +22 -0
data/sample/db/migrate/20141122002518_create_tweets.rb +10 -0
data/sample/db/migrate/20141122002548_create_favorites.rb +10 -0
data/sample/db/migrate/20141122002555_create_users.rb +8 -0
data/sample/db/schema.rb +35 -0
data/sample/db/seeds.rb +12 -0
data/sample/lib/assets/.keep +0 -0
data/sample/lib/tasks/.keep +0 -0
data/sample/log/.keep +0 -0
data/sample/public/404.html +67 -0
data/sample/public/422.html +67 -0
data/sample/public/500.html +66 -0
data/sample/public/favicon.ico +0 -0
data/sample/public/robots.txt +5 -0
data/sample/vendor/assets/javascripts/.keep +0 -0
data/sample/vendor/assets/stylesheets/.keep +0 -0
data/test/cases/associations/eager_load_test.rb +20 -0
data/test/cases/associations/includes_test.rb +30 -0
data/test/cases/associations/precount_test.rb +36 -0
data/test/cases/associations/preload_test.rb +30 -0
data/test/cases/db_config.rb +24 -0
data/test/cases/helper.rb +4 -0
data/test/cases/test_case.rb +86 -0
data/test/config.example.yml +140 -0
data/test/config.rb +5 -0
data/test/models/favorite.rb +3 -0
data/test/models/tweet.rb +4 -0
data/test/schema/schema.rb +16 -0
data/test/support/autorun.rb +5 -0
data/test/support/config.rb +43 -0
data/test/support/connection.rb +15 -0
metadata +293 -0

data/sample/public/422.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/sample/public/500.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/sample/public/favicon.ico ADDED Viewed

File without changes

data/sample/public/robots.txt ADDED Viewed

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-agent: *
+# Disallow: /

data/sample/vendor/assets/javascripts/.keep ADDED Viewed

File without changes

data/sample/vendor/assets/stylesheets/.keep ADDED Viewed

File without changes

data/test/cases/associations/eager_load_test.rb ADDED Viewed

@@ -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 ADDED Viewed

@@ -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/precount_test.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'cases/helper'
+class PrecountTest < 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_precount_has_many_does_not_execute_n_1_queries
+    assert_equal(Tweet.reflections['favs_count'].present?, false)
+    assert_queries(1 + tweets_count) { Tweet.all.map { |t| t.favs.count } }
+    assert_queries(2) { Tweet.precount(:favs).map(&:favs_count) }
+  end
+  def test_precount_has_many_with_count_loader_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.precount(:favorites).map(&:favorites_count) }
+  end
+  def test_precount_has_many_counts_properly
+    expected = Tweet.all.map { |t| t.favorites.count }
+    assert_equal(Tweet.all.map(&:favorites_count), expected)
+    assert_equal(Tweet.precount(:favorites).map(&:favorites_count), expected)
+  end
+end

data/test/cases/associations/preload_test.rb ADDED Viewed

@@ -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/db_config.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'config'
+require 'active_record'
+require 'activerecord-precount'
+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/helper.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require 'cases/db_config'
+require 'support/autorun'
+require 'cases/test_case'

data/test/cases/test_case.rb ADDED Viewed

@@ -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 ADDED Viewed

@@ -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