join_cache 0.2.0 → 0.2.1

data/README.markdown

@@ -2,6 +2,8 @@
 
 Faster ActiveRecord associations using Rails cache.
 
+[![Gem Version](https://badge.fury.io/rb/join_cache.png)](http://badge.fury.io/rb/join_cache)
+
 ## What?
 
 Let's say you scaffolded your Rails app and ended up with this:
@@ -16,7 +18,7 @@ Retrieving the teams of one employee generates an inner join:
 
 ```ruby
 bob.teams
-Team Load SELECT "teams".* FROM "teams" INNER JOIN "employees_teams" ON "teams"."id" = "employees_teams"."team_id" WHERE "employees_teams"."employee_id" = ?  [["employee_id", 1]]
+=> Team Load SELECT "teams".* FROM "teams" INNER JOIN "employees_teams" ON "teams"."id" = "employees_teams"."team_id" WHERE "employees_teams"."employee_id" = ?  [["employee_id", 1]]
 ```
 
 The gem join_cache generates methods to store the team ids in cache:
@@ -35,7 +37,7 @@ bob.cached_teams
 In your gemfile:
 
 ```ruby
-gem 'joined_table'
+gem 'join_cache'
 ```
 
 In your model:
@@ -49,6 +51,35 @@ end
 
 It also works with `has_many :through` associations!
 
+```ruby
+class Physician < ActiveRecord::Base
+  has_many :appointments
+  has_many :patients, through: :appointments
+  include JoinCache
+end
+
+freud.patients
+=> Patient Load SELECT "patients".* FROM "patients" INNER JOIN "appointments" ON "patients"."id" = "appointments"."patient_id" WHERE "appointments"."physician_id" = ?  [["physician_id", 1]]
+
+freud.cached_patient_ids
+=> [4, 8, 15, 16, 23, 42]
+
+freud.cached_patients
+=> Patient.where(id: [4, 8, 15, 16, 23, 42])
+=> Patient Load SELECT "patients".* FROM "patients" WHERE "patients"."id" IN (4, 8, 15, 16, 23, 42)
+```
+
+Take a look at this [example app](https://github.com/KevinBongart/join_cache_example).
+
+## Performance
+
+I ran [a very scientific study](http://i0.kym-cdn.com/photos/images/original/000/234/765/b7e.jpg) using Heroku, PostgreSQL, the [example app](https://github.com/KevinBongart/join_cache_example), its seeds.rb and speed.rake files.
+Shorter means better:
+
+![](http://f.cl.ly/items/3j0N0Y3j3d3B352x3009/screenshot%20320.png)
+
+See? 30% faster!
+
 ## TODO
 
 * [Support callbacks: after_add and after_remove](https://github.com/KevinBongart/join_cache/issues/2)

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/join_cache.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "join_cache"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Bongart"]
-  s.date = "2013-10-17"
+  s.date = "2013-10-22"
   s.email = "contact@kevinbongart.net"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -25,8 +25,69 @@ Gem::Specification.new do |s|
     "VERSION",
     "join_cache.gemspec",
     "lib/join_cache.rb",
-    "test/helper.rb",
-    "test/test_join_cache.rb"
+    "test/dummy/.gitignore",
+    "test/dummy/.rspec",
+    "test/dummy/Gemfile",
+    "test/dummy/Gemfile.lock",
+    "test/dummy/README.rdoc",
+    "test/dummy/Rakefile",
+    "test/dummy/app/assets/images/.keep",
+    "test/dummy/app/assets/javascripts/application.js",
+    "test/dummy/app/assets/stylesheets/application.css",
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/controllers/concerns/.keep",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/mailers/.keep",
+    "test/dummy/app/models/.keep",
+    "test/dummy/app/models/appointment.rb",
+    "test/dummy/app/models/assemblies_parts.rb",
+    "test/dummy/app/models/assembly.rb",
+    "test/dummy/app/models/concerns/.keep",
+    "test/dummy/app/models/part.rb",
+    "test/dummy/app/models/patient.rb",
+    "test/dummy/app/models/physician.rb",
+    "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/bin/bundle",
+    "test/dummy/bin/rails",
+    "test/dummy/bin/rake",
+    "test/dummy/config.ru",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/database.yml",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/filter_parameter_logging.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/initializers/wrap_parameters.rb",
+    "test/dummy/config/locales/en.yml",
+    "test/dummy/config/routes.rb",
+    "test/dummy/db/migrate/20131022000628_create_physicians.rb",
+    "test/dummy/db/migrate/20131022000639_create_patients.rb",
+    "test/dummy/db/migrate/20131022000722_create_appointments.rb",
+    "test/dummy/db/migrate/20131022011147_create_assemblies.rb",
+    "test/dummy/db/migrate/20131022011202_create_parts.rb",
+    "test/dummy/db/migrate/20131022011217_create_assemblies_parts.rb",
+    "test/dummy/db/schema.rb",
+    "test/dummy/db/seeds.rb",
+    "test/dummy/lib/assets/.keep",
+    "test/dummy/lib/tasks/.keep",
+    "test/dummy/log/.keep",
+    "test/dummy/public/404.html",
+    "test/dummy/public/422.html",
+    "test/dummy/public/500.html",
+    "test/dummy/public/favicon.ico",
+    "test/dummy/public/robots.txt",
+    "test/dummy/spec/models/has_and_belongs_to_many_spec.rb",
+    "test/dummy/spec/models/has_many_through_spec.rb",
+    "test/dummy/spec/spec_helper.rb",
+    "test/dummy/vendor/assets/javascripts/.keep",
+    "test/dummy/vendor/assets/stylesheets/.keep"
   ]
   s.homepage = "http://github.com/KevinBongart/join_cache"
   s.licenses = ["MIT"]

data/lib/join_cache.rb

@@ -24,13 +24,11 @@ module JoinCache
       cached_ids_name = "cached_#{singular_name}_ids"             # cached_team_ids
       primary_key     = association.foreign_key                   # employee_id
       foreign_key     = association.association_foreign_key       # team_id
-      join_table      = association.join_table                    # employees_teams
-      join_model      = join_table.classify.pluralize.constantize # EmployeesTeams
 
       # cached_team_ids
       define_method(cached_ids_name) do
         Rails.cache.fetch("#{cache_key}/#{cached_ids_name}") do
-          join_model.where(primary_key => id).pluck(foreign_key.to_sym)
+          send(foreign_key.pluralize.to_sym)
         end
       end
 
@@ -67,13 +65,11 @@ module JoinCache
       cached_ids_name = "cached_#{singular_name}_ids"             # cached_patient_ids
       primary_key     = self.name.foreign_key                     # employee_id
       foreign_key     = association.foreign_key                   # patient_id
-      join_table      = association.options[:through]             # appointments
-      join_model      = join_table.to_s.classify.constantize      # Appointment
 
       # cached_patient_ids
       define_method(cached_ids_name) do
         Rails.cache.fetch("#{cache_key}/#{cached_ids_name}") do
-          join_model.where(primary_key => id).pluck(foreign_key.to_sym)
+          send(foreign_key.pluralize.to_sym)
         end
       end
 

data/test/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/test/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/test/dummy/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.0.0'
+gem 'sqlite3'
+gem 'join_cache', path: '../..'
+
+group :development, :test do
+  gem 'rspec-rails', '~> 2.0'
+end

data/test/dummy/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: ../../../join_cache
+  specs:
+    join_cache (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.14)
+    builder (3.1.4)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  join_cache!
+  rails (= 4.0.0)
+  rspec-rails (~> 2.0)
+  sqlite3

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/appointment.rb

@@ -0,0 +1,4 @@
+class Appointment < ActiveRecord::Base
+  belongs_to :physician
+  belongs_to :patient
+end

data/test/dummy/app/models/assemblies_parts.rb

@@ -0,0 +1,4 @@
+class AssembliesParts < ActiveRecord::Base
+  belongs_to :assembly
+  belongs_to :part
+end

data/test/dummy/app/models/assembly.rb

@@ -0,0 +1,4 @@
+class Assembly < ActiveRecord::Base
+  has_and_belongs_to_many :parts
+  include JoinCache
+end

data/test/dummy/app/models/part.rb

@@ -0,0 +1,4 @@
+class Part < ActiveRecord::Base
+  has_and_belongs_to_many :parts
+  include JoinCache
+end

data/test/dummy/app/models/patient.rb

@@ -0,0 +1,5 @@
+class Patient < ActiveRecord::Base
+  has_many :appointments
+  has_many :physicians, through: :appointments
+  include JoinCache
+end

data/test/dummy/app/models/physician.rb

@@ -0,0 +1,5 @@
+class Physician < ActiveRecord::Base
+  has_many :appointments
+  has_many :patients, through: :appointments
+  include JoinCache
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,4 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end