sinatra-cache 0.3.1 → 0.3.2

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/sinatra/cache.rb

@@ -4,7 +4,7 @@ require 'sinatra/outputbuffer'
 
 module Sinatra
   module Cache
-    VERSION = '0.3.1' unless const_defined?(:VERSION)
+    VERSION = '0.3.2' unless const_defined?(:VERSION)
     def self.version; "Sinatra::Cache v#{VERSION}"; end
   end #/ Cache
 end #/ Sinatra

data/lib/sinatra/templates.rb

@@ -26,7 +26,7 @@ module Sinatra
         cache_enabled = settings.respond_to?(:cache_enabled) ? settings.send(:cache_enabled) : false
         cache_output_dir = settings.send(:cache_output_dir)  if settings.respond_to?(:cache_output_dir)
         # raise Exception, "The Sinatra::Cache cache_output_dir variable is pointing to a non-existant directory cache_output_dir=[#{cache_output_dir}]" unless test(?d, cache_output_dir)
-        cache_option = options.delete(:cache)
+        cache_option = options[:cache]
         cache_option = true if cache_option.nil?
         
         # compile and render template
@@ -39,7 +39,7 @@ module Sinatra
             options = options.merge(:views => views, :layout => false)
             output = render(engine, layout, options, locals) { output }
             # Cache the content or just return it
-            (cache_enabled && settings.send(:environment) == settings.cache_environment) ? 
+            (cache_enabled && cache_option && settings.send(:environment) == settings.cache_environment) ?
                 cache_write_file(cache_file_path, output.gsub(/\n\r?$/,"")) : output
           rescue Errno::ENOENT
           end

data/sinatra-cache.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-cache}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kematzy"]
-  s.date = %q{2010-03-02}
+  s.date = %q{2010-04-27}
   s.description = %q{A Sinatra Extension that makes Page and Fragment Caching easy.}
   s.email = %q{kematzy@gmail.com}
   s.extra_rdoc_files = [

data/spec/sinatra/cache_spec.rb

@@ -21,8 +21,16 @@ describe "Sinatra" do
       
       set :cache_enabled, true
       set :cache_environment, :test
-      set :cache_output_dir, "#{public_fixtures_path}/system/cache"
-      set :cache_fragments_output_dir, "#{public_fixtures_path}/system/cache_fragments"
+      set :cache_output_dir, "#{test_cache_path('system/cache')}"
+      set :cache_fragments_output_dir, "#{test_cache_path('system/cache')}_fragments"
+      
+      # NB! Although without tests, the positioning of the custom method in relation to other 
+      # Cache related declaration has no effect.
+      helpers do 
+        def uncached_erb(template, options={}) 
+          erb(template, options.merge(:cache => false ))
+        end
+      end
       
       get('/') { erb(:index) }
       get('/erb/?') { erb(:index, :layout => false) }
@@ -46,6 +54,11 @@ describe "Sinatra" do
         end
       end
       
+      ## NO CACHING 
+      get('/uncached/erb'){ erb(:index, :cache => false) }
+      get('/uncached/erb/no/layout'){ erb(:index, :cache => false, :layout => false ) }
+      get('/uncached/uncached_erb'){ uncached_erb(:index) }
+      
       get '/css/screen.css' do 
         content_type 'text/css'
         sass(:css, :style => :compact)
@@ -144,11 +157,11 @@ describe "Sinatra" do
         end
         
         it "should set :cache_output_dir to '../public/system/cache'" do 
-          MyTestApp.cache_output_dir.should == "#{public_fixtures_path}/system/cache"
+          MyTestApp.cache_output_dir.should == "#{test_cache_path('system/cache')}"
         end
         
         it "should set :cache_fragments_output_dir to '../public/system/cache_fragments'" do 
-          MyTestApp.cache_fragments_output_dir.should == "#{public_fixtures_path}/system/cache_fragments"
+          MyTestApp.cache_fragments_output_dir.should == "#{test_cache_path('system/cache')}_fragments"
         end
         
         it "should set :cache_logging to true" do 
@@ -215,7 +228,7 @@ describe "Sinatra" do
           describe "the Home page - ['/' => /index.html] (with layout)" do 
             
             before(:each) do 
-              @cache_file = "#{public_fixtures_path}/system/cache/index.html"
+              @cache_file = "#{test_cache_path('system/cache')}/index.html"
               get('/')
             end
             
@@ -238,7 +251,7 @@ describe "Sinatra" do
           describe "a basic URL without a trailing slash - ['/erb' => /erb.html] (ERB without layout)" do 
             
             before(:each) do 
-              @cache_file = "#{public_fixtures_path}/system/cache/erb.html"
+              @cache_file = "#{test_cache_path('system/cache')}/erb.html"
               get('/erb')
             end
             
@@ -259,7 +272,7 @@ describe "Sinatra" do
           describe "a basic URL with a trailing slash - ['/erb/' => /erb/index.html]" do 
             
             before(:each) do 
-              @cache_file = "#{public_fixtures_path}/system/cache/erb/index.html"
+              @cache_file = "#{test_cache_path('system/cache')}/erb/index.html"
               get('/erb/')
             end
             
@@ -281,7 +294,7 @@ describe "Sinatra" do
             
             before(:each) do 
               ext =  '.yaml'
-              @cache_file = "#{public_fixtures_path}/system/cache/file-extensions#{ext}"
+              @cache_file = "#{test_cache_path('system/cache')}/file-extensions#{ext}"
               get("/file-extensions#{ext}") 
             end
             
@@ -317,14 +330,14 @@ describe "Sinatra" do
                 
                 before(:each) do 
                   @file_url = file_url
-                  @cache_file = "#{public_fixtures_path}/system/cache#{file_url}"
+                  @cache_file = "#{test_cache_path('system/cache')}#{file_url}"
                   @cache_file << ".html" if File.extname(@file_url) == '' 
                   # puts "when the URL=[#{url}] the @cache_file=[#{@cache_file}] [#{__FILE__}:#{__LINE__}]"
                   get(url)
                 end
                 
                 after(:each) do 
-                  FileUtils.remove_dir("#{public_fixtures_path}/system/cache/params") if @delete_cached_test_files
+                  FileUtils.remove_dir("#{test_cache_path('system/cache')}/params") if @delete_cached_test_files
                 end
                 
                 it "should render the expected output" do 
@@ -343,12 +356,66 @@ describe "Sinatra" do
             
           end #/ URLs with multiple levels and/or with ?params attached
           
+          describe "with :cache => false, :layout => false " do 
+            
+            before(:each) do 
+              @cache_file = "#{test_cache_path('system/cache')}/uncached/erb/no/layout.html"
+              get('/uncached/erb/no/layout')
+            end
+            
+            it "should output the correct HTML as expected" do 
+              body.should have_tag('h1', 'HOME')
+            end
+            
+            it "should NOT cache the output" do 
+              test(?d, File.dirname(@cache_file) ).should == false  # testing for directory
+              test(?f, @cache_file).should == false
+            end
+            
+          end #/ with :cache => false, :layout => false 
+          
+          describe "with :cache => false" do 
+            
+            before(:each) do 
+              @cache_file = "#{test_cache_path('system/cache')}/uncached/erb.html"
+              get('/uncached/erb')
+            end
+            
+            it "should output the correct HTML as expected" do 
+              body.should have_tag('h1', 'HOME')
+            end
+            
+            it "should NOT cache the output" do 
+              test(?d, File.dirname(@cache_file) ).should == false  # testing for directory
+              test(?f, @cache_file).should == false
+            end
+            
+          end #/ with :cache => false
+          
+          describe "URLs with custom erb helpers, like :admin_erb().." do 
+            
+            before(:each) do 
+              @cache_file = "#{test_cache_path('system/cache')}/uncached/uncached_erb.html"
+              get('/uncached/uncached_erb')
+            end
+            
+            it "should output the correct HTML as expected" do 
+              body.should have_tag('html > body > h1', 'HOME')
+            end
+            
+            it "should NOT cache the output" do 
+              test(?d, File.dirname(@cache_file) ).should == false  # testing for directory
+              test(?f, @cache_file).should == false
+            end
+            
+          end #/ URLs with custom erb helpers, like :admin_erb()..
+          
           describe "CSS URLs with dynamic .sass files" do 
             
             describe "the URL ['/css/screen.css' => /css/screen.css]" do 
               
               before(:each) do 
-                @cache_file = "#{public_fixtures_path}/system/cache/css/screen.css"
+                @cache_file = "#{test_cache_path('system/cache')}/css/screen.css"
                 FileUtils.remove_dir(File.dirname(@cache_file), :force => true )
                 get('/css/screen.css')
               end
@@ -375,7 +442,7 @@ describe "Sinatra" do
             describe "URLs with ':cache => false' - ['/css/no/cache.css' => /css/no/cache.css]" do 
               
               before(:each) do 
-                @cache_file = "#{public_fixtures_path}/system/cache/css/no/cache.css"
+                @cache_file = "#{test_cache_path('system/cache')}/css/no/cache.css"
                 get('/css/no/cache.css')
               end
               
@@ -399,7 +466,7 @@ describe "Sinatra" do
           describe "POST '/post'" do 
             
             before(:each) do 
-              @cache_file = "#{public_fixtures_path}/system/cache/post.html"
+              @cache_file = "#{test_cache_path('system/cache')}/post.html"
               post('/post', :test => {:name => "test-#{Time.now.strftime("%Y-%d-%m %H:%M:%S")}", :content => "with content" })
             end
             
@@ -416,7 +483,7 @@ describe "Sinatra" do
           describe "PUT '/put'" do 
             
             before(:each) do 
-              @cache_file = "#{public_fixtures_path}/system/cache/put.html"
+              @cache_file = "#{test_cache_path('system/cache')}/put.html"
               put('/put', { :test => { :name => "test" }, :_method => "put" })
             end
             
@@ -433,7 +500,7 @@ describe "Sinatra" do
           describe "DELETE '/delete'" do 
             
             before(:each) do 
-              @cache_file = "#{public_fixtures_path}/system/cache/delete.html"
+              @cache_file = "#{test_cache_path('system/cache')}/delete.html"
               delete('/delete') #, { :test => { :name => "test" }, :_method => "put" })
             end
             
@@ -456,7 +523,7 @@ describe "Sinatra" do
         describe "using NOT shared fragments" do 
           
           after(:all) do
-            FileUtils.rm_r("#{public_fixtures_path}/system/cache_fragments/fragments") if @delete_cached_test_files
+            FileUtils.rm_r("#{test_cache_path('system/cache')}_fragments/fragments") if @delete_cached_test_files
           end
           
           %w(
@@ -482,7 +549,7 @@ describe "Sinatra" do
               
               # the cached fragment has already been found if we get this far, 
               # but just for good measure do we check for the existence of the fragment file.
-              test(?f, "#{public_fixtures_path}/system/cache_fragments/#{dir_structure}/test_fragment.html").should == true
+              test(?f, "#{test_cache_path('system/cache')}_fragments/#{dir_structure}/test_fragment.html").should == true
             end
           end
           
@@ -491,7 +558,7 @@ describe "Sinatra" do
         describe "using shared fragments" do 
           
           after(:all) do
-            FileUtils.rm_r("#{public_fixtures_path}/system/cache_fragments/sharedfragments") if @delete_cached_test_files
+            FileUtils.rm_r("#{test_cache_path('system/cache')}_fragments/sharedfragments") if @delete_cached_test_files
           end
           
           describe "when requesting the first URL" do 
@@ -518,7 +585,7 @@ describe "Sinatra" do
               
               # the cached fragment has already been found if we get this far, 
               # but just for good measure do we check for the existence of the fragment file.
-              test(?f, "#{public_fixtures_path}/system/cache_fragments/#{dir_structure}/test_fragment.html").should == true
+              test(?f, "#{test_cache_path('system/cache')}_fragments/#{dir_structure}/test_fragment.html").should == true
               
               # should use the cached fragment rather than cache a new fragment
               url = '/sharedfragments/2010/02/another-article-02'
@@ -540,23 +607,23 @@ describe "Sinatra" do
           
           it "should expire the page ['/params/cache/expire/' => ../cache/params/cache/expire/index.html]" do 
             get('/params/cache/expire/')
-            test(?f,"#{public_fixtures_path}/system/cache/params/cache/expire/index.html" ).should == true
+            test(?f,"#{test_cache_path('system/cache')}/params/cache/expire/index.html" ).should == true
             lambda { 
               erb_app "<% cache_expire('/params/cache/expire/') %>"
             }.should_not raise_error(Exception)
             
-            test(?f,"#{public_fixtures_path}/system/cache/params/cache/expire/index.html" ).should == false
+            test(?f,"#{test_cache_path('system/cache')}/params/cache/expire/index.html" ).should == false
             
           end
           
           it "should expire the page ['/params/cache/expired' => ../cache/params/cache/expired.html]" do 
             get('/params/cache/expired')
-            test(?f,"#{public_fixtures_path}/system/cache/params/cache/expired.html" ).should == true
+            test(?f,"#{test_cache_path('system/cache')}/params/cache/expired.html" ).should == true
             lambda { 
               erb_app "<% cache_expire('/params/cache/expired') %>"
             }.should_not raise_error(Exception)
             
-            test(?f,"#{public_fixtures_path}/system/cache/params/cache/expired.html" ).should == false
+            test(?f,"#{test_cache_path('system/cache')}/params/cache/expired.html" ).should == false
             
           end
           
@@ -566,20 +633,20 @@ describe "Sinatra" do
           
           it "should expire the fragment ['/fragments/cache/expire/' => ../cache_fragments/fragments/cache/expire/test_fragment.html]" do 
             get('/fragments/cache/expire/')
-            test(?f,"#{public_fixtures_path}/system/cache_fragments/fragments/cache/expire/test_fragment.html" ).should == true
+            test(?f,"#{test_cache_path('system/cache')}_fragments/fragments/cache/expire/test_fragment.html" ).should == true
             lambda { 
               erb_app "<% cache_expire('/fragments/cache/expire/',:fragment => :test_fragment) %>"
             }.should_not raise_error(Exception)
-            test(?f,"#{public_fixtures_path}/system/cache/params/cache_fragments/expire/test_fragment.html" ).should == false
+            test(?f,"#{test_cache_path('system/cache')}/params/cache_fragments/expire/test_fragment.html" ).should == false
           end
           
           it "should expire the fragment ['/fragments/cache/expired' => ../cache_fragments/fragments/cache/expired/test_fragment.html]" do 
             get('/fragments/cache/expired')
-            test(?f,"#{public_fixtures_path}/system/cache_fragments/fragments/cache/expired/test_fragment.html" ).should == true
+            test(?f,"#{test_cache_path('system/cache')}_fragments/fragments/cache/expired/test_fragment.html" ).should == true
             lambda { 
               erb_app "<% cache_expire('/fragments/cache/expired',:fragment => :test_fragment) %>"
             }.should_not raise_error(Exception)
-            test(?f,"#{public_fixtures_path}/system/cache/params/cache_fragments/expired/test_fragment.html" ).should == false
+            test(?f,"#{test_cache_path('system/cache')}/params/cache_fragments/expired/test_fragment.html" ).should == false
           end
           
         end #/ Pages

data/spec/spec_helper.rb

@@ -44,6 +44,10 @@ def public_fixtures_path
   "#{fixtures_path}/public"
 end
 
+def test_cache_path(ext='')
+  "/tmp/sinatra-cache/#{ext}"
+end
+
 class MyTestApp < Sinatra::Base 
   
   set :app_dir, "#{APP_ROOT}/apps/base"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - kematzy
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-02 00:00:00 +08:00
+date: 2010-04-27 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency