join_cache 0.1.0 → 0.1.1

data/README.markdown

@@ -0,0 +1,61 @@
+# join_cache
+
+Faster ActiveRecord associations using Rails cache.
+
+## What?
+
+Let's say you scaffolded your Rails app and ended up with this:
+
+```ruby
+class Employee < ActiveRecord::Base
+  has_and_belongs_to_many :teams
+end
+```
+
+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]]
+```
+
+The gem join_cache generates methods to store the team ids in cache:
+
+```ruby
+bob.cached_team_ids
+=> [4, 8, 15, 16, 23, 42]
+
+bob.cached_teams
+=> Team.where(id: [4, 8, 15, 16, 23, 42])
+=> Team Load SELECT "teams".* FROM "teams" WHERE "teams"."id" IN (4, 8, 15, 16, 23, 42)
+```
+
+## Usage
+
+In your gemfile:
+
+```ruby
+gem 'joined_table'
+```
+
+In your model:
+
+```ruby
+class Employee < ActiveRecord::Base
+  has_and_belongs_to_many :teams
+  include JoinCache # make sure to add this *after* listing the associations
+end
+```
+
+## Contributing to join_cache
+
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+
+## Copyright
+
+Copyright (c) 2013 Kevin Bongart. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/join_cache.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "join_cache"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Bongart"]
@@ -13,14 +13,14 @@ Gem::Specification.new do |s|
   s.email = "contact@kevinbongart.net"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "join_cache.gemspec",

data/lib/join_cache.rb

@@ -18,15 +18,19 @@ module JoinCache
     # => Team.where(id: [4, 8, 15, 16, 23, 42])
     #
     reflect_on_all_associations(:has_and_belongs_to_many).each do |association|
-      singular_name   = association.name.to_s.singularize # team
-      plural_name     = association.plural_name           # teams
-      cached_name     = "cached_#{plural_name}"           # cached_teams
-      cached_ids_name = "cached_#{singular_name}_ids"     # cached_team_ids
+      singular_name   = association.name.to_s.singularize         # team
+      plural_name     = association.plural_name                   # teams
+      cached_name     = "cached_#{plural_name}"                   # cached_teams
+      cached_ids_name = "cached_#{singular_name}_ids"             # cached_team_ids
+      primary_key     = association.class_name.foreign_key        # employee_id
+      foreign_key     = 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
-          send(plural_name).pluck(self.class.name.foreign_key.to_sym)
+          join_model.where(primary_key => id).pluck(foreign_key.to_sym)
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: join_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -81,13 +81,13 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files:
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - join_cache.gemspec
@@ -109,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2964477634214236973
+      hash: 3755351500618496333
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= join_cache
-
-Faster ActiveRecord associations using Rails cache.
-
-== Contributing to join_cache
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2013 Kevin Bongart. See LICENSE.txt for
-further details.
-