machinist-caching 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--tty

data/Gemfile

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in machinist-caching.gemspec
+gemspec
+
+gem 'machinist', :git => 'https://github.com/notahat/machinist.git'

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/machinist/caching.rb

@@ -0,0 +1,17 @@
+require 'machinist'
+
+module Machinist
+  module Caching
+    autoload :Machinable, 'machinist/caching/machinable'
+    autoload :Shop,       'machinist/caching/shop'
+    autoload :Warehouse,  'machinist/caching/warehouse'
+
+    module ActiveRecord
+      autoload :Blueprint, 'machinist/caching/active_record/blueprint'
+    end
+  end
+
+  module Machinable #:nodoc:
+    extend Machinist::Caching::Machinable
+  end
+end

data/lib/machinist/caching/active_record.rb

@@ -0,0 +1,16 @@
+require 'machinist/caching'
+require 'machinist/active_record'
+
+module Machinist #:nodoc:
+  module ActiveRecord
+    class Blueprint
+      include Machinist::Caching::ActiveRecord::Blueprint
+    end
+  end
+end
+
+module ActiveRecord #:nodoc:
+  class Base
+    extend Machinist::Caching::Machinable
+  end
+end

data/lib/machinist/caching/active_record/blueprint.rb

@@ -0,0 +1,17 @@
+module Machinist
+  module Caching
+    module ActiveRecord
+      module Blueprint
+        # Box an object for storage in the warehouse.
+        def box(object)
+          object.id
+        end
+
+        # Unbox an object from the warehouse.
+        def unbox(id)
+          @klass.find(id)
+        end
+      end
+    end
+  end
+end

data/lib/machinist/caching/machinable.rb

@@ -0,0 +1,20 @@
+module Machinist
+  module Caching
+    module Machinable
+      # Construct and save an object from a blueprint, if the class allows saving.
+      #
+      # :call-seq:
+      #   make!([count], [blueprint_name], [attributes = {}])
+      #
+      # A cached object will be returned from the shop if possible. See
+      # Machinist::Caching::Shop.
+      #
+      # Arguments are the same as for make.
+      def make!(*args)
+        decode_args_to_make(*args) do |blueprint, attributes|
+          Shop.instance.buy(blueprint, attributes)
+        end
+      end
+    end
+  end
+end

data/lib/machinist/caching/shop.rb

@@ -0,0 +1,45 @@
+require 'singleton'
+
+module Machinist
+  module Caching
+    # The shop takes care of caching database objects.
+    #
+    # Calling make! on a class requests objects from the shop; you don't
+    # normally access the shop directly.
+    #
+    # Read more about object caching on the
+    # wiki[http://wiki.github.com/notahat/machinist/object-caching].
+    class Shop
+      include Singleton
+
+      attr_accessor :warehouse
+
+      def initialize #:nodoc:
+        reset!
+      end
+
+      # Throw out the entire collection of cached objects.
+      def reset!
+        self.warehouse = Warehouse.new
+      end
+
+      # Buy a (possibly cached) object from the shop.
+      #
+      # This is just like constructing an object by calling Blueprint#make!,
+      # but it will return a previously cached object if one is available.
+      def buy(blueprint, attributes = {})
+        raise BlueprintCantSaveError.new(blueprint) unless blueprint.respond_to?(:make!)
+
+        cached = warehouse[blueprint, attributes]
+
+        if cached.nil?
+          blueprint.make!(attributes).tap do |object|
+            warehouse[blueprint, attributes] = blueprint.box(object)
+          end
+        else
+          blueprint.unbox(cached)
+        end
+      end
+    end
+  end
+end

data/lib/machinist/caching/warehouse.rb

@@ -0,0 +1,27 @@
+module Machinist
+  module Caching
+    # A Warehouse is a hash supports lists as keys.
+    #
+    # It's used for storing cached objects created by Machinist::Caching::Shop.
+    #
+    #     warehouse[klass, attributes] = object
+    #     warehouse[klass, attributes] # => object
+    class Warehouse
+      attr_accessor :shelf
+
+      def initialize #:nodoc:
+        self.shelf = Hash.new{|hash, key| hash[key] = {}}
+      end
+
+      # Assign a value for the given list of keys.
+      def []=(klass, attributes, object)
+        shelf[klass][attributes] = object
+      end
+
+      # Return the value for the given list of keys.
+      def [](klass, attributes)
+        shelf[klass][attributes]
+      end
+    end
+  end
+end

data/machinist-caching.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = "machinist-caching"
+  s.version     = "0.0.1"
+  s.authors     = ["Tomas D'Stefano", "Gabriel Sobrinho"]
+  s.email       = ["tomas_stefano@successoft.com", "gabriel.sobrinho@gmail.com"]
+  s.homepage    = "https://github.com/tomas-stefano/machinist-caching"
+  s.summary     = %q{Object caching for machinist}
+  s.description = %q{Object caching for machinist}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec', '>= 2.6.0'
+  s.add_development_dependency 'activerecord', '>= 3.0'
+  s.add_development_dependency 'mysql', '>= 2.8.1'
+end

data/spec/machinist/caching/active_record/blueprint_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Machinist::Caching::ActiveRecord::Blueprint do
+  let :blueprint do
+    Machinist::ActiveRecord::Blueprint.new(Post) {}
+  end
+
+  let :post do
+    Post.make!
+  end
+
+  it 'should box object using id' do
+    blueprint.box(post).should == post.id
+  end
+
+  it 'should unbox object using id' do
+    blueprint.unbox(post.id).should == post
+  end
+end

data/spec/machinist/caching/machinable_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Machinist::Caching::Machinable do
+  it 'should buy objects from the shop' do
+    post_a = Post.make!
+    post_b = Post.make!
+
+    post_a.should == post_b
+  end
+end

data/spec/machinist/caching/shop_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Machinist::Caching::Shop do
+  let :shop do
+    Machinist::Caching::Shop.instance
+  end
+
+  it 'should cache an object' do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) {}
+
+    object_a = shop.buy(blueprint)
+    object_b = shop.buy(blueprint)
+
+    object_a.should == object_b
+  end
+
+  it 'should cache an object with attributes' do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) {}
+
+    object_a = shop.buy(blueprint, :title => 'Lorem ipsum')
+    object_b = shop.buy(blueprint, :title => 'Lorem ipsum')
+
+    object_a.should == object_b
+  end
+
+  it 'should not confuse objects with different blueprints' do
+    blueprint_a = Machinist::ActiveRecord::Blueprint.new(Post) {}
+    blueprint_b = Machinist::ActiveRecord::Blueprint.new(Post) {}
+
+    object_a = shop.buy(blueprint_a, :title => 'Lorem ipsum')
+    object_b = shop.buy(blueprint_b, :title => 'Lorem ipsum')
+
+    object_a.should_not == object_b
+  end
+
+  it 'should not confuse objects with same blueprint but different attributes' do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) {}
+
+    object_a = shop.buy(blueprint, :title => 'Lorem ipsum')
+    object_b = shop.buy(blueprint, :title => 'Lorem ipsum dolor sit amet')
+
+    object_a.should_not == object_b
+  end
+end

data/spec/machinist/caching/warehouse_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Machinist::Caching::Warehouse do
+  let :warehouse do
+    Machinist::Caching::Warehouse.new
+  end
+
+  it 'should return nil for a new key' do
+    warehouse['klass', 'attributes'].should == nil
+  end
+
+  it 'should store and retrieve values' do
+    warehouse['klass', 'attributes'] = 'object'
+    warehouse['klass', 'attributes'].should == 'object'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rspec'
+require 'machinist/caching/active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "mysql",
+  :database => "machinist",
+  :username => "root",
+  :password => ""
+)
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.column :title, :string
+    t.column :body,  :text
+  end
+end
+
+class Post < ActiveRecord::Base
+end
+
+Post.blueprint do
+  title { 'Lorem ipsum' }
+  body  { 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit.' }
+end
+
+RSpec.configure do |config|
+  config.before do
+    Machinist::Caching::Shop.instance.reset!
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: machinist-caching
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tomas D'Stefano
+- Gabriel Sobrinho
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.8.1
+  type: :development
+  version_requirements: *id003
+description: Object caching for machinist
+email: 
+- tomas_stefano@successoft.com
+- gabriel.sobrinho@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Rakefile
+- lib/machinist/caching.rb
+- lib/machinist/caching/active_record.rb
+- lib/machinist/caching/active_record/blueprint.rb
+- lib/machinist/caching/machinable.rb
+- lib/machinist/caching/shop.rb
+- lib/machinist/caching/warehouse.rb
+- machinist-caching.gemspec
+- spec/machinist/caching/active_record/blueprint_spec.rb
+- spec/machinist/caching/machinable_spec.rb
+- spec/machinist/caching/shop_spec.rb
+- spec/machinist/caching/warehouse_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/tomas-stefano/machinist-caching
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Object caching for machinist
+test_files: 
+- spec/machinist/caching/active_record/blueprint_spec.rb
+- spec/machinist/caching/machinable_spec.rb
+- spec/machinist/caching/shop_spec.rb
+- spec/machinist/caching/warehouse_spec.rb
+- spec/spec_helper.rb