bchiu-merb_cache_more 0.9.4

data/spec/cache_keys_spec.rb

@@ -0,0 +1,45 @@
+describe "cache key generator" do
+  
+  u1 = "/items/list"
+  q1 = "key1=val1&key2[a]=val2a&key3[]=val3a&key3[]=val3b"
+  p1 = Merb::Request.query_parse(q1, '&', true)
+
+  u2 = "http://www.google.com"
+  q2 = "q=cache:MrZoPWIJNhIJ:www.merbivore.com/+merb&hl=en&ct=clnk&cd=1"
+  p2 = Merb::Request.query_parse(q2, '&', true)
+
+  it "should return a default key" do
+    CACHE._cache.key_for({:key => u1, :format => nil, :params => nil}).should == "/items/list"
+    CACHE._cache.key_for({:key => u2, :format => nil, :params => nil}).should == "http://www.google.com"
+  end
+
+  it "should return a default key using params" do
+    CACHE._cache.key_for({:key => u1, :format => nil, :params => p1}).should == "/items/list/key1_val1_key2_aval2a_key3_val3a_val3b"
+    CACHE._cache.key_for({:key => u2, :format => nil, :params => p2}).should == "http://www.google.com/q_cache_MrZoPWIJNhIJ_www.merbivore.com%2F_merb_hl_en_ct_clnk_cd_1"
+  end
+
+  it "should return a snake key using params" do
+    CACHE._cache.key_for({:key => u1, :format => :snake, :params => p1}).should == "/items/list/val1_val2a_val3a_val3b"
+    CACHE._cache.key_for({:key => u2, :format => :snake, :params => p2}).should == "http://www.google.com/cache_MrZoPWIJNhIJ_www.merbivore.com%2F_merb_en_clnk_1"
+  end
+
+  it "should return a hash key using params" do
+    CACHE._cache.key_for({:key => u1, :format => :hash, :params => p1}).should match(/^\/items\/list\/[a-z0-9]{32}$/i)
+    CACHE._cache.key_for({:key => u2, :format => :hash, :params => p2}).should match(/^http\:\/\/www.google.com\/[a-z0-9]{32}$/i)
+  end
+
+  it "should return a tree key using params" do
+    CACHE._cache.key_for({:key => u1, :format => :tree, :params => p1}).should == "/items/list/val1/val2a/val3a/val3b"
+    CACHE._cache.key_for({:key => u2, :format => :tree, :params => p2}).should == "http://www.google.com/cache_MrZoPWIJNhIJ_www.merbivore.com%2F_merb/en/clnk/1"
+  end
+
+  it "should return a query key using params" do
+    CACHE._cache.key_for({:key => u1, :format => :query, :params => p1}).should == "/items/list/key1=val1&key2[a]=val2a&key3[]=val3a&key3[]=val3b"
+    CACHE._cache.key_for({:key => u2, :format => :query, :params => p2}).should == "http://www.google.com/q=cache%3AMrZoPWIJNhIJ%3Awww.merbivore.com%2F+merb&hl=en&ct=clnk&cd=1"
+  end
+
+  it "should return a custom key using params" do
+    CACHE._cache.key_for({:key => u1, :format => ":key1/:key2[a]_and_:key3[]", :params => p1}).should == "/items/list/val1/val2a_and_val3a"
+    CACHE._cache.key_for({:key => u2, :format => ":q/:hl_:ct_and_:cd", :params => p2}).should == "http://www.google.com/cache_MrZoPWIJNhIJ_www.merbivore.com%2F_merb/en_clnk_and_1"
+  end
+end

data/spec/cache_page_params_spec.rb

@@ -0,0 +1,79 @@
+describe "cache_page with params" do
+  
+  qs = "p1=abc&p2=456&p3=ghi"
+
+  it "should cache page (action5) with params in default format" do
+    c = get("/cache_controller/action5", {}, {:query_string => qs})
+    c.body.strip.should == "test action5"
+    c.cached_page?(:key => "/cache_controller/action5/p1_abc_p2_456_p3_ghi").should be_true
+  end
+  
+  it "should expire page (action5) with params in default format" do
+    c = get("/cache_controller/action5", {}, {:query_string => qs})
+    c.expire_page(:key => "/cache_controller/action5/p1_abc_p2_456_p3_ghi")
+    c.cached_page?(:key => "/cache_controller/action5/p1_abc_p2_456_p3_ghi").should be_false
+  end
+
+  it "should cache page (action5) with full path and params in default format" do
+    c = get("/cache_controller/action5/foo/bar", {}, {:query_string => qs})
+    c.body.strip.should == "test action5"
+    c.cached_page?(:key => "/cache_controller/action5/foo/bar/p1_abc_p2_456_p3_ghi").should be_true
+  end
+  
+  it "should expire page (action5) with full path and params in default format" do
+    c = get("/cache_controller/action5/foo/bar", {}, {:query_string => qs})
+    c.expire_page(:key => "/cache_controller/action5/foo/bar/p1_abc_p2_456_p3_ghi")
+    c.cached_page?(:key => "/cache_controller/action5/foo/bar/p1_abc_p2_456_p3_ghi").should be_false
+  end
+
+  it "should cache page (action18) with specific params" do
+    c = get("/cache_controller/action18", {}, {:query_string => qs})
+    c.cached_page?(:key => "/cache_controller/action18/p1_abc_p2_456").should be_true
+  end
+
+  it "should expire page (action18) with specific params" do
+    c = get("/cache_controller/action18", {}, {:query_string => qs})
+    c.expire_page(:key => "/cache_controller/action18/p1_abc_p2_456")
+    c.cached_page?(:key => "/cache_controller/action18/p1_abc_p2_456").should be_false
+  end
+  
+  it "should cache pages with params in every key format" do
+    c = get("/cache_controller/action19", {}, {:query_string => qs}) # snake
+    c.cached_page?(:key => "/cache_controller/action19/abc_456_ghi").should be_true
+  
+    c = get("/cache_controller/action20", {}, {:query_string => qs}) # tree
+    c.cached_page?(:key => "/cache_controller/action20/abc/456/ghi").should be_true
+  
+    c = get("/cache_controller/action21", {}, {:query_string => qs}) # hash
+    c.cached_page?(:key => "/cache_controller/action21/" + Digest::MD5.hexdigest("p1abcp2456p3ghi")).should be_true
+  
+    c = get("/cache_controller/action22", {}, {:query_string => qs}) # query
+    c.cached_page?(:key => "/cache_controller/action22/p1=abc&p2=456&p3=ghi").should be_true
+  
+    c = get("/cache_controller/action23", {}, {:query_string => qs}) # custom
+    c.cached_page?(:key => "/cache_controller/action23/abc/456_and_ghi").should be_true
+  end
+
+  it "should expire pages with params in every key format" do
+    CACHE.expire_page(:key => "/cache_controller/action19/abc_456_ghi")
+    CACHE.cached_page?(:key => "/cache_controller/action19/abc_456_ghi").should be_false
+
+    CACHE.expire_page(:key => "/cache_controller/action20/abc/456/ghi")
+    CACHE.cached_page?(:key => "/cache_controller/action20/abc/456/ghi").should be_false
+
+    CACHE.expire_page(:key => "/cache_controller/action21/" + Digest::MD5.hexdigest("p1abcp2456p3ghi"))
+    CACHE.cached_page?(:key => "/cache_controller/action21/" + Digest::MD5.hexdigest("p1abcp2456p3ghi")).should be_false
+
+    CACHE.expire_page(:key => "/cache_controller/action22/p1=abc&p2=456&p3=ghi")
+    CACHE.cached_page?(:key => "/cache_controller/action22/p1=abc&p2=456&p3=ghi").should be_false
+
+    CACHE.expire_page(:key => "/cache_controller/action23/abc/456_and_ghi")
+    CACHE.cached_page?(:key => "/cache_controller/action23/abc/456_and_ghi").should be_false
+  end
+
+  it "should expire all pages" do
+    CACHE.expire_all_pages
+    CACHE.cached_page?("action6").should be_false
+    Dir.glob(Merb::Controller._cache.config[:cache_html_directory] + '/*').should be_empty
+  end
+end

data/spec/cache_page_spec.rb

@@ -0,0 +1,150 @@
+describe "cache_page" do
+
+  it "should cache page (action5)" do
+    c = get("/cache_controller/action5")
+    c.body.strip.should == "test action5"
+    c.cached_page?("action5").should be_true
+  end
+
+  it "should expire page (action5)" do
+    CACHE.expire_page("action5")
+    CACHE.cached_page?("action5").should be_false
+  end
+
+  it "should cache page (action5) with full path" do
+    c = get("/cache_controller/action5/this/is/a/test")
+    c.cached_page?(:action => "action5", :params => %w(this is a test), :format => :tree).should be_true
+  end
+
+  it "should expire page (action5) with full path" do
+    CACHE.expire_page(:action => "action5",
+                      :controller => "cache_controller",
+                      :params => %w(this is a test))
+    CACHE.cached_page?(:key => "/cache_controller/action5/this/is/a/test").should be_false
+  end
+
+  it "should cache page (action6), use it and expire 3 seconds after" do
+    CACHE.expire_page :match => true, :action => "action6"
+    c = get("/cache_controller/action6")
+    now = Time.now.to_s
+    c.body.strip.should == now
+    c.cached_page?("action6").should be_true
+    sleep 1
+    c = get("/cache_controller/action6")
+    c.body.strip.should == now
+    sleep 2
+    c = get("/cache_controller/action6")
+    c.body.strip.should == Time.now.to_s
+  end
+
+  it "should cache page with full path (action6) and expire in 3 seconds" do
+    CACHE.expire_page "action6"
+    CACHE.cached_page?(:action => "action6", :params => %w(path to nowhere)).should be_false
+    c = get("/cache_controller/action6/path/to/nowhere/")
+    now = Time.now.to_s
+    c.body.strip.should == now
+    c.cached_page?(:action => "action6", :params => %w(path to nowhere), :format => :tree).should be_true
+    sleep 1
+    c = get("/cache_controller/action6/path/to/nowhere")
+    c.body.strip.should == now
+    sleep 2
+    c = get("/cache_controller/action6/path/to/nowhere")
+    c.body.strip.should == Time.now.to_s
+  end
+
+  it "should expire page in many ways" do
+    c = get("/cache_controller/action6")
+    CACHE.expire_page("action6")
+    CACHE.cached_page?("action6").should be_false
+
+    c = get("/cache_controller/action6")
+    CACHE.expire_page(:match => "/cache_control")
+    CACHE.cached_page?(:action => "action6").should be_false
+
+    c = get("/cache_controller/action6")
+    CACHE.expire_page(:action => "action6")
+    CACHE.cached_page?(:action => "action6").should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:action => "action6", :params => %w(id1 id2))
+    CACHE.cached_page?(:action => "action6", :params => %w(id1 id2)).should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:action => "action6", :match => true)
+    CACHE.cached_page?(:action => "action6", :params => %w(id1 id2)).should be_false
+
+    c = get("/cache_controller/action6")
+    CACHE.expire_page(:action => "action6", :controller => "cache_controller")
+    CACHE.cached_page?(:action => "action6", :controller => "cache_controller").should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:action => "action6", :params => %w(id1), :match => true)
+    CACHE.cached_page?(:action => "action6", :params => %w(id1 id2)).should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:action => "action6", :controller => "cache_controller", :match => true)
+    CACHE.cached_page?(:action => "action6", :params => %w(id1 id2)).should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:action => "action6", :controller => "cache_controller", :params => %w(id1), :match => true)
+    CACHE.cached_page?(:action => "action6", :params => %w(id1 id2)).should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:action => "action6", :controller => "cache_controller", :params => %w(id1 id2))
+    CACHE.cached_page?(:action => "action6", :controller => "cache_controller", :params => %w(id1 id2)).should be_false
+
+    c = get("/cache_controller/action6")
+    CACHE.expire_page(:key => "/cache_controller/action6")
+    CACHE.cached_page?(:key => "/cache_controller/action6").should be_false
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:key => "/cache_controller/action6", :params => %w(id1 id2))
+    CACHE.cached_page?(:key => "/cache_controller/action6", :params => %w(id1 id2)).should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:key => "/cache_controller/action6/id1", :match => true)
+    CACHE.cached_page?(:key => "/cache_controller/action6/id1/id2").should be_false
+
+    c = get("/cache_controller/action6/id1/id2")
+    CACHE.expire_page(:key => "/cache_controller/action6", :params => %w(id1), :match => true)
+    CACHE.cached_page?(:key => "/cache_controller/action6/id1/id2").should be_false
+  end
+
+  it "should respect original content-type" do
+    c = get("/cache_controller/action7.css")
+    c.body.should == "CSS"
+    c = get("/cache_controller/action7.css")
+    c.params[:format].should == "css"
+    c.cached_page?(:action => "action7", :extension => 'css').should be_true
+
+    c = get("/cache_controller/action7.js")
+    c.body.should == "JS"
+    c = get("/cache_controller/action7.js")
+    c.params[:format].should == "js"
+    c.cached_page?(:action => "action7", :extension => 'js').should be_true
+
+    c = get("/cache_controller/action7.xml")
+    c.body.should == "XML"
+    c = get("/cache_controller/action7.xml")
+    c.params[:format].should == "xml"
+    c.cached_page?(:action => "action7", :extension => 'xml').should be_true
+
+    c = get("/cache_controller/action7.jpg")
+    c.body.should == "JPG"
+    c = get("/cache_controller/action7.jpg")
+    c.params[:format].should == "jpg"
+    c.cached_page?(:action => "action7", :extension => 'jpg').should be_true
+
+    c = get("/cache_controller/action7.html")
+    c.body.should == "HTML"
+    c = get("/cache_controller/action7.html")
+    c.params[:format].should == "html"
+    c.cached_page?(:action => "action7").should be_true
+  end
+
+  it "should expire all pages" do
+    CACHE.expire_all_pages
+    CACHE.cached_page?("action6").should be_false
+    Dir.glob(Merb::Controller._cache.config[:cache_html_directory] + '/*').should be_empty
+  end
+
+end

data/spec/config/database.yml

@@ -0,0 +1,14 @@
+---
+:development: &defaults
+  :adapter: sqlite3
+  :database: tmp/merb_cache_more.sqlite3
+  :log_stream: log/sql.log
+  :log_level: 0
+
+:test:
+  <<: *defaults
+  :database: tmp/merb_cache_more.sqlite3
+
+:production:
+  <<: *defaults
+  :database: tmp/merb_cache_more.sqlite3

data/spec/merb_cache_more_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+Merb::Router.prepare do |r|
+  r.default_routes
+  r.match("/").to(:controller => "cache_controller", :action => "index")
+end
+
+CACHE = CacheController.new(Merb::Test::RequestHelper::FakeRequest.new)
+CACHE.expire_all
+
+puts "Using #{CACHE._cache.store.cache_store_type.inspect} store"
+
+require "cache_keys_spec"
+require "cache_action_spec"
+require "cache_action_params_spec"
+require "cache_page_spec"
+require "cache_page_params_spec"
+require "cache_fragment_spec"

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require "rubygems"
+require "merb-core"
+require "merb-haml"
+require "fileutils"
+require "merb-core/test"
+require "merb_cache_more"
+require File.dirname(__FILE__) / "cache_controller"
+
+def set_database_adapter(adapter)
+  config_file = File.dirname(__FILE__) / "config/database.yml"
+  config = IO.read(config_file)
+  config.gsub!(/:adapter:\s+.*$/, ":adapter: #{adapter}")
+  File.open(config_file, "w+") do |c| c.write(config) end
+end
+
+def use_cache_store(store, orm = nil)
+  Merb::Plugins.config[:merb_cache] = {
+    :store => store,
+    :cache_directory => File.dirname(__FILE__) / "tmp/cache",
+    :cache_html_directory => File.dirname(__FILE__) / "tmp/html",
+  }
+  FileUtils.rm_rf(Dir.glob(File.dirname(__FILE__) / "/tmp"))
+  case store
+  when "dummy"
+  when "file"
+  when "memory"
+  when "memcache"
+    require "memcache"
+  when "database"
+    case orm
+    when "datamapper"
+      Merb.environment = "test"
+      Merb.logger = Merb::Logger.new("log/merb_test.log")
+      set_database_adapter("sqlite3")
+      require "merb_datamapper"
+    when "activerecord"
+      Merb.logger = Merb::Logger.new("log/merb_test.log")
+      set_database_adapter("sqlite3")
+      require "merb_activerecord"
+    when "sequel"
+      set_database_adapter("sqlite")
+      require "merb_sequel"
+    else
+      raise "Unknown orm: #{orm}"
+    end
+  else
+    raise "Unknown cache store: #{store}"
+  end
+end
+
+store = "file"
+case ENV["STORE"] || store
+when "file"
+  use_cache_store "file"
+when "memory"
+  use_cache_store "memory"
+when "memcache"
+  use_cache_store "memcache"
+when "datamapper"
+  use_cache_store "database", "datamapper"
+when "sequel"
+  use_cache_store "database", "sequel"
+when "activerecord"
+  use_cache_store "database", "activerecord"
+when "dummy"
+  use_cache_store "dummy"
+else
+  puts "Invalid cache store: #{ENV["store"]}"
+  exit
+end
+
+FileUtils.mkdir_p(Merb::Plugins.config[:merb_cache][:cache_html_directory])
+FileUtils.mkdir_p(Merb::Plugins.config[:merb_cache][:cache_directory])
+
+Merb.start :environment => "test", :adapter => "runner"
+
+Spec::Runner.configure do |config|
+  config.include Merb::Test::RequestHelper  
+end

data/spec/views/cache_controller/action1.html.erb

@@ -0,0 +1,4 @@
+<%- cache('key1') do -%>
+  <%= Time.now %>
+<%- end -%>
+

data/spec/views/cache_controller/action2.html.haml

@@ -0,0 +1,4 @@
+- cache('key11') do
+= Time.now
+- end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: bchiu-merb_cache_more
+version: !ruby/object:Gem::Version 
+  version: 0.9.4
+platform: ruby
+authors: 
+- Ben Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+description: Extends merb-cache to use params, work with pagination, auto-cache all actions and use many key formats
+email: bchiu@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_cache_more
+- lib/merb_cache_more/cache-action.rb
+- lib/merb_cache_more/cache-fragment.rb
+- lib/merb_cache_more/cache-page.rb
+- lib/merb_cache_more/cache-store
+- lib/merb_cache_more/cache-store/database-activerecord.rb
+- lib/merb_cache_more/cache-store/database-datamapper.rb
+- lib/merb_cache_more/cache-store/database-sequel.rb
+- lib/merb_cache_more/cache-store/database.rb
+- lib/merb_cache_more/cache-store/dummy.rb
+- lib/merb_cache_more/cache-store/file.rb
+- lib/merb_cache_more/cache-store/memcache.rb
+- lib/merb_cache_more/cache-store/memory.rb
+- lib/merb_cache_more/merb-cache.rb
+- lib/merb_cache_more/merbtasks.rb
+- lib/merb_cache_more/request.rb
+- lib/merb_cache_more/request_helper.rb
+- lib/merb_cache_more.rb
+- spec/cache_action_params_spec.rb
+- spec/cache_action_spec.rb
+- spec/cache_controller.rb
+- spec/cache_fragment_spec.rb
+- spec/cache_keys_spec.rb
+- spec/cache_page_params_spec.rb
+- spec/cache_page_spec.rb
+- spec/config
+- spec/config/database.yml
+- spec/merb_cache_more_spec.rb
+- spec/spec_helper.rb
+- spec/views
+- spec/views/cache_controller
+- spec/views/cache_controller/action1.html.erb
+- spec/views/cache_controller/action2.html.haml
+has_rdoc: true
+homepage: http://github.com/bchiu/merb_cache_more
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Extends merb-cache to use params, work with pagination, auto-cache all actions and use many key formats
+test_files: []
+