sinatra-cache 0.3.4 → 0.3.5

data/README.rdoc

@@ -374,6 +374,17 @@ Report it here: http://github.com/kematzy/sinatra-cache/issues
 
 * Work out and include instructions on how to use a '../public/custom/cache/dir' with Passenger.
 
+* Enable time-based / date-based cache expiry and regeneration of the cached-pages. [ht oakleafs]
+
+* Enable .gz version of the cached file, further reducing the processing on the server. [ht oakleafs]
+  It would be killer to have <b>an extra .gz file next to the cached file</b>. That way, in Apache, you set it up like that:
+    
+      RewriteCond %{HTTP:Accept-Encoding} gzip
+      RewriteCond %{REQUEST_FILENAME}.gz$ -f
+      RewriteRule ^(.*)$ $1.gz [L,QSA]
+  
+  And it should serve the compressed file if available.
+
 * Write more tests to ensure everything is very solid.
 
 * Any other improvements you or I can think of.

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/lib/sinatra/cache.rb

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

data/lib/sinatra/templates.rb

@@ -15,12 +15,15 @@ module Sinatra
       def render(engine, data, options={}, locals={}, &block) 
         # merge app-level options
         options = settings.send(engine).merge(options) if settings.respond_to?(engine)
+        options[:outvar] ||= '@_out_buf'
         
         # extract generic options
-        locals = options.delete(:locals) || locals || {}
-        views = options.delete(:views) || settings.views || "./views"
-        layout = options.delete(:layout)
-        layout = :layout if layout.nil? || layout == true
+        locals          = options.delete(:locals) || locals         || {}
+        views           = options.delete(:views)  || settings.views || "./views"
+        @default_layout = :layout if @default_layout.nil?
+        layout          = options.delete(:layout)
+        layout          = @default_layout if layout.nil? or layout == true
+        content_type    = options.delete(:content_type) || options.delete(:default_content_type)
         
         # set the cache related options
         cache_enabled = settings.respond_to?(:cache_enabled) ? settings.send(:cache_enabled) : false
@@ -30,8 +33,11 @@ module Sinatra
         cache_option = true if cache_option.nil?
         
         # compile and render template
-        template = compile_template(engine, data, options, views)
-        output = template.render(self, locals, &block)
+        layout_was      = @default_layout
+        @default_layout = false
+        template        = compile_template(engine, data, options, views)
+        output          = template.render(self, locals, &block)
+        @default_layout = layout_was
         
         # render layout
         if layout
@@ -48,6 +54,9 @@ module Sinatra
         # rendering without a layout
         (cache_enabled && cache_option && settings.send(:environment) == settings.cache_environment) ? 
             cache_write_file(cache_file_path, output.gsub(/\n\r?$/,"") ) : output
+            
+        output.extend(ContentTyped).content_type = content_type if content_type
+        output
       end
       
   end #/module Templates

data/sinatra-cache.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-cache}
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kematzy"]
-  s.date = %q{2010-05-14}
+  s.date = %q{2010-11-15}
   s.description = %q{A Sinatra Extension that makes Page and Fragment Caching easy.}
   s.email = %q{kematzy@gmail.com}
   s.extra_rdoc_files = [
@@ -32,13 +32,16 @@ Gem::Specification.new do |s|
      "spec/fixtures/apps/base/views/index.erb",
      "spec/fixtures/apps/base/views/layout.erb",
      "spec/fixtures/apps/base/views/params.erb",
+     "spec/fixtures/apps/partials/views/home/index.erb",
+     "spec/fixtures/apps/partials/views/layout.erb",
+     "spec/fixtures/apps/partials/views/shared/_header.erb",
      "spec/sinatra/cache_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kematzy/sinatra-cache}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Sinatra Extension that makes Page and Fragment Caching easy.}
   s.test_files = [
     "spec/sinatra/cache_spec.rb",
@@ -49,7 +52,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, [">= 1.0"])
       s.add_runtime_dependency(%q<sinatra-outputbuffer>, [">= 0.1.0"])
       s.add_development_dependency(%q<sinatra-tests>, [">= 0.1.6"])

data/spec/fixtures/apps/partials/views/home/index.erb

@@ -0,0 +1,4 @@
+<% content_for :section_header do %>
+  <h1>HELLO from [content_for(:section_header)]</h1>
+<% end %>
+<h2>HELLO FROM [FILE <%= __FILE__ %>]</h2>

data/spec/fixtures/apps/partials/views/layout.erb

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <title>Sinatra::Cache</title>
+    <%= cache_timestamp %>
+  </head>
+  <body>
+    <%= partial("shared/header") %>
+    
+    <%= yield %>
+  </body>
+</html>

data/spec/fixtures/apps/partials/views/shared/_header.erb

@@ -0,0 +1,3 @@
+<div id="header">
+  <%= yield_content :section_header %>
+</div>

data/spec/sinatra/cache_spec.rb

@@ -426,7 +426,7 @@ describe "Sinatra" do
               end
               
               it "should output the correct CSS as expected" do 
-                body.should == "body { color: red; }"
+                body.should == "body { color: red; }\n"
               end
               
               it "should automatically create the cache /css output directory" do 
@@ -656,6 +656,183 @@ describe "Sinatra" do
       
     end #/ with caching enabled
     
+    describe "EDGE cases" do 
+      
+      describe "Using nested buffers" do 
+        
+        it "should use Sinatra v1.1" do
+          Sinatra::VERSION.should == '1.1.0'
+        end
+        
+        require 'sinatra/outputbuffer'
+        
+        class MyPartialsTestApp < Sinatra::Base 
+          register(Sinatra::Tests)
+          
+          enable :raise_errors
+          
+          register(Sinatra::OutputBuffer)
+          register(Sinatra::Cache)
+          
+          # need to set the root of the app for the default :cache_fragments_output_dir to work
+          set :root, ::APP_ROOT
+          set :app_dir, "#{APP_ROOT}/apps/partials"
+          set :public, "#{fixtures_path}/public"
+          set :views, "#{APP_ROOT}/apps/partials/views"
+
+          set :cache_enabled, true
+          set :cache_environment, :test
+          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
+            
+            ##
+            # Renders ERB partials 
+            #  
+            # ==== Examples
+            # 
+            #   <%= partial('shared/header') %>  => renders app/views/shared/_header.erb
+            # 
+            #   <%= partial('snippets/snippet') %>  => renders app/views/snippets/_snippet.erb
+            # 
+            # 
+            # @api public
+            def partial(template, *args) 
+              template_array = template.to_s.split('/')
+              template = template_array[0..-2].join('/') + "/_#{template_array[-1]}"
+              options = args.last.is_a?(Hash) ? args.pop : {}
+              options.merge!(:layout => false, :cache => false) # add support for Sinatra::Cache
+              # options[:outvar] = '@_out_buf'
+              if collection = options.delete(:collection) then
+                collection.inject([]) do |buffer, member|
+                  buffer << erb(:"#{template}", options.merge(:layout => false, :locals => { template_array[-1].to_sym => member } ) )
+                end.join("\n")
+              else
+                erb(:"#{template}", options)
+              end
+            rescue Errno::ENOENT => e
+              out = "ERROR: The partial [views/#{template.to_s}] is missing."
+              out << " Please create it to remove this error. [ Exception: #{h e.inspect}]" if self.class.development? || self.class.test?
+              out
+            rescue Exception => e
+              if self.class.production?
+                #  TODO:: must store the error in the log somehow. 
+                "<!-- ERROR: rendering the partial [#{template.to_s}] -->" 
+              else
+                throw e
+              end
+            end
+            
+          end
+          
+          get('/') { erb(:"home/index") }
+          # get('/erb/?') { erb(:index, :layout => false) }
+          
+          # complex regex URL, matches
+          get %r{^/params/?([\s\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?} do
+            @captures = params[:captures].nil? ? [] : params[:captures].compact
+            erb(:params)
+          end
+          get('/file-extensions.*') do 
+            @vars = { :framework => "Sinatra", :url => "www.sinatrarb.com" }
+            case params[:splat].first.to_sym
+            when :json
+              erb(@vars.to_json, :layout => false )
+            when :yaml
+              erb(@vars.to_yaml,:layout => false) 
+            else
+              # direct output, should NOT be Cached
+              @vars.inspect
+              # @vars.inspect
+            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)
+          end
+          get '/css/no/cache.css' do 
+            content_type 'text/css'
+            sass(:css, :style => :compact, :cache => false)
+          end
+          
+          # enable :method_override
+          post('/post/?') { erb("POST", :layout => false) }
+          put('/put/?') { erb('PUT', :layout => false) }
+          delete('/delete/?') { erb('DELETE', :layout => false) }
+          
+          get %r{^/fragments/?([\s\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?} do
+            erb(:fragments, :layout => false, :cache => false) 
+          end
+          get %r{^/sharedfragments/?([\s\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?/?([\w-]+)?} do
+            erb(:fragments_shared, :layout => false, :cache => false) 
+          end
+          
+        end
+        
+        def app; ::MyPartialsTestApp.new ; end
+        
+        describe "basic Page caching" do 
+          
+          describe "GET requests for" do 
+            
+            describe "the Home page - ['/' => /index.html] (with layout)" do 
+              
+              before(:each) do 
+                @cache_file = "#{test_cache_path('system/cache')}/index.html"
+                get('/')
+              end
+              
+              after(:each) do
+                FileUtils.rm(@cache_file) if @delete_cached_test_files
+              end
+              
+              it "should render the expected output" do 
+                # <html>
+                #   <head>
+                #     <title>Sinatra::Cache</title>
+                #     <!-- page cached: 2010-11-15 18:21:06 -->
+                #   </head>
+                #   <body>
+                #     <div id="header">
+                #       <h1>HELLO from [content_for(:section_header)]</h1>
+                #     </div>
+                #     <h2>HELLO FROM [FILE ../sinatra-cache/spec/fixtures/apps/partials/views/home/index.erb]</h2>
+                #   </body>
+                # </html>
+                body.should have_tag('html > head > title', 'Sinatra::Cache') 
+                body.should match(/<!-- page cached: \d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d -->/)
+                body.should have_tag('html > body > div#header > h1', /HELLO from \[content_for\(:section_header\)\]/)
+                body.should have_tag('html > body > h2', /HELLO FROM \[/)
+              end
+              
+              it "should create a cached file in the cache output directory" do 
+                test(?f, @cache_file).should == true
+              end
+              
+            end #/ GET ['/' => /index.html]
+            
+          end #/ GET requests
+          
+        end #/ basic Page caching
+        
+        
+      end #/ Using nested buffers
+      
+    end #/ EDGE cases
+    
+    
   end #/ Cache
   
 end #/ Sinatra

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-cache
 version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - kematzy
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 +08:00
+date: 2010-11-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
@@ -34,9 +37,11 @@ dependencies:
   name: sinatra-outputbuffer
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 0
         - 1
@@ -48,9 +53,11 @@ dependencies:
   name: sinatra-tests
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
         - 1
@@ -62,9 +69,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 1
         - 3
@@ -97,6 +106,9 @@ files:
 - spec/fixtures/apps/base/views/index.erb
 - spec/fixtures/apps/base/views/layout.erb
 - spec/fixtures/apps/base/views/params.erb
+- spec/fixtures/apps/partials/views/home/index.erb
+- spec/fixtures/apps/partials/views/layout.erb
+- spec/fixtures/apps/partials/views/shared/_header.erb
 - spec/sinatra/cache_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -109,23 +121,27 @@ rdoc_options:
 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.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Sinatra Extension that makes Page and Fragment Caching easy.