erector_cache 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Grockit
+
+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.rdoc

@@ -0,0 +1,17 @@
+= erector_cache
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Grockit. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "erector_cache"
+    gem.summary = %Q{Caching for your Erector}
+    gem.description = %Q{Caching for your Erector}
+    gem.email = "mmol@grockit.com"
+    gem.homepage = "http://github.com/grockit/erector_cache"
+    gem.authors = ["Grockit"]
+    gem.add_development_dependency "rspec", ">= 1.2.6"
+    gem.add_dependency "lawnchair", ">=0.6.8"
+    gem.add_dependency "erector", "=0.8.1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "erector_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/erector_cache/widget.rb

@@ -0,0 +1,82 @@
+module ErectorCache
+  module Widget
+    def self.included(base)
+      base.module_eval do
+        cattr_accessor :expire_in
+        extend ClassMethods
+        class_inheritable_array :key_components
+        include InstanceMethods
+        alias_method_chain :_render_via, :caching
+      end
+    end
+
+    module ClassMethods
+      def cache_with(*components)
+        self.key_components = components
+      end
+      
+      def cache_for(ttl)
+        self.expire_in = ttl
+      end
+      
+      def expire!(hash={})
+        hash = Hash.new("*").merge(hash)
+        
+        search_key = self.key_components.inject(["Lawnchair", self.to_s]) do |collection, part|
+          k_prime = part.is_a?(Hash) ? part.keys.first : part
+          collection << k_prime
+          collection << hash[k_prime]
+        end.join(":")
+        
+        LAWNCHAIR.redis.keys(search_key).split.each{|key| LAWNCHAIR.redis.del(key) }
+      end
+      
+      def cache_key(hash)
+        self.key_components.inject([self.to_s]) do |collection, part|
+          object = part.is_a?(Hash) ? hash[part.keys.first] : hash[part]
+
+          if part.is_a?(Hash)
+            key = part.keys.first
+            value = Array(part[key]).map do |p| 
+              if p.is_a?(Proc)
+                p.call(object)
+              else
+                object.send(p)
+              end
+            end.join("-")
+          else
+            key = part
+            value = object.to_param
+          end
+          collection << [key, value]
+        end.flatten.join(":")
+      end
+      
+    end
+
+    module InstanceMethods
+      def cache_key
+        key_data = {}
+        self.class.key_components.each do |part|
+          part = part.keys.first if part.is_a?(Hash)
+          key_data[part] = self.instance_variable_get("@#{part}")
+        end
+        return self.class.cache_key(key_data)
+      end
+      
+      def _render_via_with_caching(parent, options={})
+        if self.class.key_components.blank?
+          _render_via_without_caching(parent, options)
+        else
+          options = {:expire_in => @expire_in || 1.hour}
+          cached_fragment = LAWNCHAIR.cache(cache_key, options) do
+            parent.capture { _render_via_without_caching(parent, options) }
+          end
+          parent.output << cached_fragment
+        end
+      end
+    end
+  end
+end
+
+Erector::Widget.send(:include, ErectorCache::Widget)

data/lib/erector_cache.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'action_controller'
+require 'erector'
+require 'erector/rails'
+require 'erector_cache/fragment'
+require 'erector_cache/widget'

data/spec/erector_cache/fragment_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/erector_cache/widget_spec.rb

@@ -0,0 +1,153 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+class Turtle < Erector::Widget
+  cache_with :name
+  
+  def content
+    div "Cool stuff below"
+    widget NinjaTurtle, :name => @name, :weapon => @weapon, :master => @master
+  end
+end
+
+class Master
+  def initialize(name)
+    @name = name
+  end
+  
+  def name
+    @name
+  end
+  
+  def to_param
+    name
+  end
+end
+
+class NinjaTurtle < Turtle
+  cache_with :weapon, :master => lambda {|m| m.name }
+  cache_for 25.years
+  
+  def content
+    span "Weapon: #{@weapon}"
+    span "Cached at: #{Time.now.to_s(:db)}"
+  end
+end
+
+describe ErectorCache::Widget do
+  before do
+    @splinter = Master.new("Splinter")
+  end
+  
+  describe "ClassMethods" do
+    describe ".cache_with" do
+      it "sets the attributes to cache instances of this widget with" do
+        Turtle.key_components.should == [:name]
+      end
+
+      it "inherits parent classes cache key components" do
+        component_parts = NinjaTurtle.key_components.map{|c| c.is_a?(Hash) ? c.keys.first : c}
+        component_parts.should == [:name, :weapon, :master]
+      end
+    end
+    
+    describe ".expire!" do
+      it "expires the cache" do
+        render_template do |controller|
+          controller.render_widget Turtle, :name => "Leonardo", :weapon => "Katanas", :master => @splinter
+        end
+        expected_cached_at_time = @output.match(/Cached at: (.*)</)[1]
+
+        sleep 1
+         
+        render_template do |controller|
+          controller.render_widget Turtle, :name => "Leonardo", :weapon => "Katanas", :master => @splinter, :slogan => "Turtle Power!"
+        end
+        @output.should include expected_cached_at_time
+        
+        NinjaTurtle.expire!(:weapon => "Katanas")
+
+        sleep 1
+        
+        render_template do |controller|
+          controller.render_widget Turtle, :name => "Leonardo", :weapon => "Katanas", :master => @splinter
+        end
+        @output.should_not include expected_cached_at_time
+      end
+    end
+    
+    describe ".cache_for" do
+      it "sets appropriate ttl" do
+        Turtle.expire_in.should == 25.years
+      end
+    end
+  end
+  
+  describe "InstanceMethods" do
+    describe "#cache_key" do
+      it "builds a simple cache key for an instance properly" do
+        widget = Turtle.new(:name => "Yertle")
+        widget.cache_key.should == "Turtle:name:Yertle"
+      end
+      
+      it "builds a complex cache key" do
+        widget = NinjaTurtle.new(:name => "Leonardo", :master => @splinter, :weapon => "Dual Katanas")
+        widget.cache_key.should == "NinjaTurtle:name:Leonardo:weapon:Dual Katanas:master:Splinter"
+      end
+    end
+    
+    describe "_render_via_with_caching" do
+      context "when there is a cache_with set" do
+        it "stores the widgets output in LAWNCHAIR" do
+          now = Time.now
+
+          render_template do |controller|
+            controller.render_widget Turtle, :name => "Leonardo", :weapon => "Dual Katanas", :master => @splinter
+          end
+          
+          @output.should include("Weapon: Dual Katanas")
+          expected_cached_at_time = @output.match(/Cached at: (.*)</)[1]
+          
+          sleep 1
+          
+          render_template do |controller|
+            controller.render_widget Turtle, :name => "Leonardo", :weapon => "Dual Katanas", :master => @splinter
+          end
+          
+          @output.should include("Cached at: #{expected_cached_at_time}")
+        end
+      end
+      
+      context "when there is NO cache_with set" do
+        class People < Erector::Widget
+          def content
+            widget Sheriff, :name => "Boss Hogg", :attitude => "Bad", :boys => ["good", "ol'"], :belly => :round
+          end
+        end
+        
+        class Sheriff < Erector::Widget
+          def content
+            div do
+              div "Last failed to catch #{@boys.join('-')} boys: #{Time.now.to_s(:db)}"
+              div "Name: #{@name}"
+            end
+          end
+        end
+        
+        it "calls _render_via_without_caching" do
+          render_template do |controller|
+            controller.render_widget People
+          end
+          @output.should include("Name: Boss Hogg")
+          expected_cached_at_time = @output.match(/boys: (.*)</)[1]
+          sleep 1
+          
+          render_template do |controller|
+            controller.render_widget People
+          end
+          @output.should_not include(expected_cached_at_time)
+        end
+      end
+    end
+    
+  end
+end

data/spec/erector_cache_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ErectorCache" do
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'erector_cache'
+require 'spec'
+require 'spec/autorun'
+require "lawnchair"
+LAWNCHAIR = Lawnchair
+LAWNCHAIR.connectdb(Redis.new(:db => 3))
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    LAWNCHAIR.flushdb
+  end
+end
+
+class FixtureTemplate < ActionView::Base
+
+  def initialize
+    ActionView::Base.module_eval do
+      def protect_against_forgery?
+        false
+      end
+    end
+    @controller = ActionController::Base.new
+    @controller.logger = Logger.new("/tmp/foo")
+    request = create_request
+    response = create_response
+    @controller.send(:assign_shortcuts, request, response)
+    @controller.instance_variable_set(:@url, ActionController::UrlRewriter.new(request, {}))
+    if respond_to?(:output_buffer)
+      self.output_buffer = ""
+    end
+  end
+
+  def controller
+    @controller
+  end
+
+  def create_request
+    env = {}
+    env['REQUEST_URI'] = "/foo"
+    env['action_controller.request.request_parameters'] = {}
+    ActionController::Request.new(env)
+  end
+
+  def create_response
+    response = ActionController::Response.new
+    response.template = ActionView::Base.new([],{},controller)
+    response
+  end
+end
+
+def render_template
+  @output = yield FixtureTemplate.new.controller
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: erector_cache
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Grockit
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-14 00:00:00 -07: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 
+        hash: 19
+        segments: 
+        - 1
+        - 2
+        - 6
+        version: 1.2.6
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: lawnchair
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 6
+        - 8
+        version: 0.6.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: erector
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 8
+        - 1
+        version: 0.8.1
+  type: :runtime
+  version_requirements: *id003
+description: Caching for your Erector
+email: mmol@grockit.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/erector_cache.rb
+- lib/erector_cache/fragment.rb
+- lib/erector_cache/widget.rb
+- spec/erector_cache/fragment_spec.rb
+- spec/erector_cache/widget_spec.rb
+- spec/erector_cache_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grockit/erector_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Caching for your Erector
+test_files: 
+- spec/erector_cache/fragment_spec.rb
+- spec/erector_cache/widget_spec.rb
+- spec/erector_cache_spec.rb
+- spec/spec_helper.rb