cached_belongs_to 0.0.1

data/.autotest

@@ -0,0 +1,6 @@
+require 'autotest/growl'
+
+Autotest.add_hook :initialize do |at|
+  at.add_exception 'test.log'
+end
+

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Padilla
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# CachedBelongsTo
+
+[![Build Status](https://secure.travis-ci.org/crowdint/cached_belongs_to.png)](http://travis-ci.org/crowdint/cached_belongs_to)
+
+Back in the 80's disk space was precious. That's why we came out with table "normalization" for relational databases.
+
+While this concept is still valid, disk space has become ridicously cheap, and,
+there's a lot of cases where performance is more important than disk space.
+
+## Can't you just use eager loading?
+
+You could! But, eager loading still loads the models into memory. Such a memory waste, specially if the parent models are big.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cached_belongs_to'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cached_belongs_to
+
+## Usage
+
+Just use it as you would use `belongs_to`. Add the `:caches` option to specify the
+fields in the association that you want to cache.
+
+    #
+    # table: authors
+    #
+    # name:string
+    #
+    class Author
+      has_many :books
+    end
+
+    class Book
+      cached_belongs_to :author, :caches => :name
+    end
+
+You will need a database field in the books table to hold the cached value:
+
+    class AddCachedBelongsToBooks < ActiveRecord::Migration
+      def change
+        add_column :books, :author_name, :string
+      end
+    end
+
+And, that's it. Everytime you hange the Author, it will come back and update
+the cached fields on the Book model.
+
+So, now on your views you can just call:
+
+    book.author_name
+
+And won't pay the price of loading the whole Author model in memory, nor the query
+time.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+# About the Author
+
+[Crowd Interactive](http://www.crowdint.com) is an American web design and development company that happens to work in Colima, Mexico.
+We specialize in building and growing online retail stores. We don’t work with everyone – just companies we believe in. Call us today to see if there’s a fit.
+Find more info [here](http://www.crowdint.com)!

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new
+
+Cucumber::Rake::Task.new
+
+task :default => [ :spec, :cucumber ]

data/cached_belongs_to.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cached_belongs_to/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Padilla"]
+  gem.email         = ["david@crowdint.com"]
+  gem.description   = %q{Denormalize your belongs_to associations}
+  gem.summary       = %q{Denormalize your belongs_to associations}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cached_belongs_to"
+  gem.require_paths = ["lib"]
+  gem.version       = CachedBelongsTo::VERSION
+
+  gem.add_dependency 'activerecord', '~> 3.2'
+
+  gem.add_development_dependency 'autotest'
+  gem.add_development_dependency 'autotest-growl'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/config/cucumber.yml

@@ -0,0 +1,4 @@
+<%
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'}  --strict --tags ~@wip --require features/step_definitions --require features/support"
+%>
+default: <%= std_opts %> --drb --color features

data/features/step_definitions/active_record_model_steps.rb

@@ -0,0 +1,39 @@
+Given /^model "(.*?)" exists with attributes:$/ do |model_class_name, attributes|
+  klass = Class.new(ActiveRecord::Base)
+  suppress_warnings { Object.const_set model_class_name, klass }
+
+  ActiveRecord::Schema.define(:version => 0) do
+    create_table model_class_name.tableize, :force => true do |t|
+      attributes.hashes.each do |row|
+        t.send(row["type"], row["attribute"])
+      end
+    end
+  end
+end
+
+Given /^a (.*?) exists:$/ do |model_name, table|
+  @models ||= {}
+  @models[model_name] = model_name.constantize.new
+  table.rows_hash.each do |attribute, value|
+    @models[model_name].send("#{attribute}=", value)
+  end
+  @models[model_name].save!
+end
+
+Given /^that (.*?) belongs to that (.*?)$/ do |child, parent|
+  @models[parent].send(child.underscore.pluralize).send(:push, @models[child])
+
+  #@models[child].send("#{parent.underscore}=", @models[parent])
+end
+
+When /^I save the (.*?)$/ do |model_name|
+  @models[model_name].save!
+end
+
+When /^I change the (.*?)'s name to "(.*?)"$/ do |model_name, new_name|
+  @models[model_name].name = new_name
+end
+
+Given /^(.*?) has many (.*?)$/ do |parent, child|
+  parent.constantize.send(:has_many, child.underscore)
+end

data/features/step_definitions/cached_belongs_to_steps.rb

@@ -0,0 +1,7 @@
+Given /^(.*?) cached_belongs_to (.*?) with cached: "(.*?)"$/ do |model1, model2, cached_attribute|
+  model1.constantize.send(:cached_belongs_to, model2.underscore.to_sym, :caches => cached_attribute)
+end
+
+Then /^(.*?)'s author name should be "(.*?)"$/ do |model_name, author_name|
+  @models[model_name].reload.author_name.should == author_name
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'cached_belongs_to'
+require './spec/support/warnings.rb'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new("test.log")
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"

data/features/update_cached_attributes_after_save_child_record.feature

@@ -0,0 +1,20 @@
+Feature: Update cached attributes after saving the child record
+
+  Scenario:
+    Given model "Author" exists with attributes:
+      | attribute | type   |
+      | name      | string |
+    And model "Book" exists with attributes:
+      | attribute   | type    |
+      | title       | string  |
+      | author_id   | integer |
+      | author_name | string  |
+    And Book cached_belongs_to Author with cached: "name"
+    And Author has many Books
+    And a Author exists:
+      | name | John Mellencamp |
+    And a Book exists:
+      | title | Treasure Island |
+    And that Book belongs to that Author
+    When I save the Book
+    Then Book's author name should be "John Mellencamp"

data/features/update_cached_attributes_after_save_parent_record.feature

@@ -0,0 +1,21 @@
+Feature: Update cached attributes after saving the parent record
+
+  Scenario:
+    Given model "Author" exists with attributes:
+      | attribute | type   |
+      | name      | string |
+    And model "Book" exists with attributes:
+      | attribute   | type    |
+      | title       | string  |
+      | author_id   | integer |
+      | author_name | string  |
+    And Book cached_belongs_to Author with cached: "name"
+    And Author has many Books
+    And a Author exists:
+      | name | John Mellencamp |
+    And a Book exists:
+      | title | Treasure Island |
+    And that Book belongs to that Author
+    When I change the Author's name to "Deeprak Chopa"
+    And I save the Author
+    Then Book's author name should be "Deeprak Chopa"

data/lib/cached_belongs_to.rb

@@ -0,0 +1,45 @@
+require "cached_belongs_to/version"
+require 'active_record'
+
+module CachedBelongsTo
+  module ClassMethods
+    def cached_belongs_to(*args)
+      caches = Array(args[1].delete(:caches))
+      klass  = args[0]
+
+      belongs_to(*args)
+      children_hook_name = "cached_belongs_to_#{name.underscore}_after_save".to_sym
+      create_cached_belongs_to_child_hooks(caches, klass, children_hook_name)
+      create_cached_belongs_to_parent_hooks(caches, klass, children_hook_name)
+    end
+
+    def create_cached_belongs_to_child_hooks(*args, caches, klass, children_hook_name)
+      define_method children_hook_name do
+        caches.each do |attr|
+          send("#{klass}_#{attr}=", send(klass).send(attr)) if send(klass)
+        end
+      end
+
+      before_save children_hook_name
+    end
+
+    def create_cached_belongs_to_parent_hooks(caches, parent_class_name, children_hook_name)
+      method_name = "cached_belongs_to_#{parent_class_name}_after_save".to_sym
+      has_many_association = self.name.underscore.pluralize.to_sym
+      parent_class = parent_class_name.to_s.camelize.constantize
+
+      parent_class.send(:define_method, method_name) do
+        send(has_many_association).reload.each do |child|
+          caches.each do |attr|
+            child.send(children_hook_name)
+            child.save
+          end
+        end
+      end
+
+      parent_class.send(:after_save, method_name)
+    end
+  end
+end
+
+ActiveRecord::Base.extend(CachedBelongsTo::ClassMethods)

data/lib/cached_belongs_to/version.rb

@@ -0,0 +1,3 @@
+module CachedBelongsTo
+  VERSION = "0.0.1"
+end

data/spec/cached_belongs_to_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe CachedBelongsTo do
+  let(:book_class) do
+    klass = Class.new(ActiveRecord::Base)
+    suppress_warnings { Object.const_set 'Book', klass }
+    klass
+  end
+
+  let(:author_class) do
+    klass = Class.new(ActiveRecord::Base)
+    suppress_warnings { Object.const_set 'Author', klass }
+    klass
+  end
+
+  before do
+    author_class
+  end
+
+  it "Adds the cached_belongs_to class method to ActiveRecord models" do
+    book_class.should respond_to(:cached_belongs_to)
+  end
+
+  context "cached_belongs_to" do
+    before do
+      book_class.send(:cached_belongs_to, :author, { :caches => :name })
+    end
+
+    it "creates the belongs_to association as usual" do
+      book_class.new.should respond_to(:author)
+    end
+
+    it "defines the cached_belongs_to_book_after_save" do
+      book_class.new.should respond_to(:cached_belongs_to_book_after_save)
+    end
+
+    it "defines the cached_belongs_to_author_after_save" do
+      author_class.new.should respond_to(:cached_belongs_to_author_after_save)
+    end
+  end
+
+  context "cached_belongs_to_book_after_save" do
+    before do
+      book_class.send(:cached_belongs_to, :author, { :caches => :name })
+    end
+
+    it "assigns all the cached values from the parent association to the cached attributes" do
+      author = author_class.new :name => 'John Mellencamp'
+      book   = book_class.new
+      book.author = author
+
+      book.stub(:author).and_return author
+
+      book.cached_belongs_to_book_after_save
+      book.author_name.should eq author.name
+    end
+  end
+
+  context "cached_belongs_to_author_after_save" do
+    before do
+      book_class.send(:cached_belongs_to, :author, { :caches => :name })
+      author_class.send(:has_many, :books)
+    end
+
+    it "assigns all the cached values from the parent association to the cached attributes" do
+      author = author_class.new :name => 'John Mellencamp'
+      book   = book_class.new
+
+      author.stub_chain(:books, :reload).and_return([ book ])
+      book.should_receive(:cached_belongs_to_book_after_save)
+      book.should_receive :save
+
+      author.cached_belongs_to_author_after_save
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'cached_belongs_to'
+require 'logger'
+
+require 'support/warnings'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new("test.log")
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table "books" do |t|
+    t.string "title"
+    t.integer "author_id"
+    t.string "author_name"
+  end
+
+  create_table "authors" do |t|
+    t.string "name"
+  end
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/warnings.rb

@@ -0,0 +1,9 @@
+module Kernel
+  def suppress_warnings
+    original_verbosity = $VERBOSE
+    $VERBOSE = nil
+    result = yield
+    $VERBOSE = original_verbosity
+    return result
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: cached_belongs_to
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Padilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Denormalize your belongs_to associations
+email:
+- david@crowdint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cached_belongs_to.gemspec
+- config/cucumber.yml
+- features/step_definitions/.gitkeep
+- features/step_definitions/active_record_model_steps.rb
+- features/step_definitions/cached_belongs_to_steps.rb
+- features/support/env.rb
+- features/update_cached_attributes_after_save_child_record.feature
+- features/update_cached_attributes_after_save_parent_record.feature
+- lib/cached_belongs_to.rb
+- lib/cached_belongs_to/version.rb
+- spec/cached_belongs_to_spec.rb
+- spec/spec_helper.rb
+- spec/support/warnings.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -552693176683226932
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -552693176683226932
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Denormalize your belongs_to associations
+test_files:
+- features/step_definitions/.gitkeep
+- features/step_definitions/active_record_model_steps.rb
+- features/step_definitions/cached_belongs_to_steps.rb
+- features/support/env.rb
+- features/update_cached_attributes_after_save_child_record.feature
+- features/update_cached_attributes_after_save_parent_record.feature
+- spec/cached_belongs_to_spec.rb
+- spec/spec_helper.rb
+- spec/support/warnings.rb