kematzy-sinatra-cache 0.2.1 → 0.2.2

data/README.textile

@@ -2,26 +2,43 @@ h1. Sinatra::Cache
 
 Adds a very *simple* Page Caching functionality to "Sinatra":http://www.sinatrarb.com/
 
-<div style="background: #EED367; padding: 10px 5px; border: 1px solid #D7C36C; text-align: center;">
-*NB!* Unfinished work, so use with care.
-<br>
+<hr>
+
+h3. *PLEASE KEEP THIS IN MIND* 
+
+This is *unfinished work*, so use with care.
 
 If you find it lacking or badly coded, please feel free to fork and improve. I'll be very happy :)
-</div>
+
+<hr>
 
 
-h3. TODOs
+h3. TODO's
 
-* Improve the logging output to the standard Sinatra output (if we are having :logging enabled )
-* Add fragment and action (?) caching...
-* Enable the options functionality for the <tt>:cache</tt> & <tt>:cache_expire</tt> methods, so that they can take custom extensions and more
 
+= Make caching an option of the normal <tt>erb()/haml()/sass()</tt> methods, sort of like this:
+<pre><code>
+  erb(:index, :cache => true/false)
+  
+  # alternatively enable caching by setting a global config like this
+  set :cache_enabled_for :all || :only/except => ['/','/contact',...]
+  
+</code></pre>
 
-h3. Configuration
 
-*Example 1:*
+= Improve the logging output to the standard Sinatra output (if we are having :logging enabled )
 
-Sinatra 'classic' app.
+= Add fragment caching...
+
+= Enable the options functionality for the <tt>:cache</tt> & <tt>:cache_expire</tt> methods, so that they can take custom extensions and more
+
+
+<hr>
+
+
+h3. CONFIGURATION
+
+*Example 1: Sinatra 'classic' app.*
 
   <pre><code>
   <snip....>
@@ -32,41 +49,43 @@ Sinatra 'classic' app.
   # sets the default extension for cached files
   set :cache_page_extension, '.html'
   # sets the Cache dir to the root of the /public directory.
-  set :cache_dir, '' 
+  set :cache_output_dir, '' # was :cache_dir
   ...
   </code></pre>
 
-*Example 2:*
-
-Sinatra 'sub-classed' app.
+*Example 2: Sinatra 'sub-classed' app.*
     
 <pre><code>
   <snip....>
   require 'sinatra/cache'
-
-  class MyApp < Sinatra::Base
   
+  class MyApp < Sinatra::Base
+    
     register Sinatra::Cache
-
+    
     # toggle for the cache functionality.
     set :cache_enabled, true
     # sets the default extension for cached files
     set :cache_page_extension, '.html'
-    # sets the Cache dir to the root of the /public directory.
-    set :cache_dir, '' 
-  
+    # sets the Cache output dir to the root of the /public directory.
+    set :cache_output_dir, '' # was :cache_dir
+    
     <snip....>
 </code></pre>
-    
 
-h3. Usage
+
+<hr>
+
+
+h3. USAGE
+
 
 Basic Page Caching into static HTML files
 
 <pre><code>
   get '/contact' do
     # NB!  options is currently not working
-    cache( erb( :contact ), :options => 'go here' )
+    cache( erb( :contact ), :options => 'should go here' )
   end
 </code></pre>
 
@@ -82,11 +101,14 @@ Expiring old pages (ie: after POST or PUT events)
 See the "test":test/ and "test/fixtures":test/fixtures/ directories for more examples.
 
 
-h3. Default Options
+<hr>
+
+
+h3. DEFAULT OPTIONS
 
 * <tt>:cache_enabled</tt> => toggle for the cache functionality. Default is: <tt>true</tt>
 * <tt>:cache_page_extension</tt> => sets the default extension for cached files. Default is: <tt>.html</tt>
-* <tt>:cache_dir</tt> => sets cache directory where cached files are stored. Default is: ''(empty) == root of /public.<br>
+* <tt>:cache_output_dir</tt> => sets cache directory where cached files are stored. Default is: ''(empty) == root of /public.<br>
     set to empty, since the ideal 'system/cache/' does not currently work with Passenger & mod_rewrite :(
 * <tt>:cache_logging</tt> => toggle for logging the cache calls. Default is: <tt>true</tt>
 * <tt>:cache_logging_level</tt> => sets the level of the cache logger. Default is: <tt>:info</tt>.<br>

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 1
+:patch: 2

data/lib/sinatra/cache.rb

@@ -9,7 +9,7 @@ module Sinatra
   # 
   module Cache
     
-    VERSION = 'Sinatra::Cache v0.2.1'
+    VERSION = 'Sinatra::Cache v0.2.2'
     def self.version; VERSION; end
     
     
@@ -30,7 +30,7 @@ module Sinatra
         return content unless options.cache_enabled
         
         unless content.nil?
-          content = "#{page_cached_timestamp}#{content}\n"
+          content = "#{content}\n#{page_cached_timestamp}"
           path = cache_page_path(request.path_info,opts)
           FileUtils.makedirs(File.dirname(path))
           open(path, 'wb+') { |f| f << content }
@@ -94,9 +94,9 @@ module Sinatra
         def cache_page_path(path,opts={})
           # test if given a full path rather than relative path, otherwise join the public path to cache_dir 
           # and ensure it is a full path
-          cache_dir = (options.cache_dir == File.expand_path(options.cache_dir)) ? 
-              options.cache_dir : File.expand_path("#{options.public}/#{options.cache_dir}")
-          cache_dir = cache_dir[0..-2] if cache_dir[-1,1] == '/'
+          cache_dir = (options.cache_output_dir == File.expand_path(options.cache_output_dir)) ? 
+              options.cache_output_dir : File.expand_path("#{options.public}/#{options.cache_output_dir}")
+          cache_dir = cache_output_dir[0..-2] if cache_dir[-1,1] == '/'
           "#{cache_dir}/#{cache_file_name(path,opts)}"
         end
         
@@ -127,7 +127,7 @@ module Sinatra
       app.helpers(Cache::Helpers)
       app.set :cache_enabled, true
       app.set :cache_page_extension, '.html'
-      app.set :cache_dir, ''
+      app.set :cache_output_dir, ''
       app.set :cache_logging, true
       app.set :cache_logging_level, :info
     end

data/test/cache_test.rb

@@ -40,7 +40,7 @@ describe "Sinatra::Cache" do
       
       set :cache_enabled, false
       set :cache_page_extension, '.cache.html'
-      set :cache_dir, 'system/cache'
+      set :cache_output_dir, 'system/cache'
       set :cache_logging, false
       set :cache_logging_level, :info
       
@@ -228,8 +228,8 @@ describe "Sinatra::Cache" do
         assert_equal('.html', @default_app.options.cache_page_extension)
       end
       
-      it "the :cache_dir option should be correct ('') " do 
-        assert_equal('', @default_app.options.cache_dir)
+      it "the :cache_output_dir option should be correct ('') " do 
+        assert_equal('', @default_app.options.cache_output_dir)
       end
       
       it "the :cache_logging option should be correct (true)" do 
@@ -252,8 +252,8 @@ describe "Sinatra::Cache" do
         assert_equal('.cache.html', @custom_app.options.cache_page_extension)
       end
       
-      it "the :cache_dir option should be correct ('system/cache') " do 
-        assert_equal('system/cache', @custom_app.options.cache_dir)
+      it "the :cache_output_dir option should be correct ('system/cache') " do 
+        assert_equal('system/cache', @custom_app.options.cache_output_dir)
       end
       
       it "the :cache_logging option should be correct (true)" do 
@@ -288,9 +288,9 @@ describe "Sinatra::Cache" do
         request = Rack::MockRequest.new(@default_app)
         response = request.get('/cache')
         assert response
-        assert_match(/^<!-- page cached: \d+-\d+-\d+ \d+:\d+:\d+ -->\nHello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n/, response.body)
+        assert_match(/^Hello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n/, response.body)
         assert(test(?f, "#{public_fixtures_path}/cache.html"))
-        assert_match(/^<!-- page cached: \d+-\d+-\d+ \d+:\d+:\d+ -->\nHello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n/, File.read("#{public_fixtures_path}/cache.html"))
+        assert_match(/^Hello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n/, File.read("#{public_fixtures_path}/cache.html"))
       end
       
       it "should expire the /cache page" do 
@@ -334,7 +334,7 @@ describe "Sinatra::Cache" do
             
             set :cache_enabled, true
             set :cache_page_extension, '.cache.html'
-            set :cache_dir, 'system/cache'
+            set :cache_output_dir, 'system/cache'
             set :cache_logging, true
             set :cache_logging_level, :info
             
@@ -360,9 +360,9 @@ describe "Sinatra::Cache" do
           request = Rack::MockRequest.new(@custom_enabled_app)
           response = request.get('/cache')
           assert response
-          assert_match(/^<!-- page cached: \d+-\d+-\d+ \d+:\d+:\d+ -->\nHello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n/, response.body)
+          assert_match(/^Hello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n<!-- page cached: \d+-\d+-\d+ \d+:\d+:\d+ -->\n$/, response.body)
           assert(test(?f, "#{public_fixtures_path}/system/cache/cache.cache.html"))
-          assert_match(/^<!-- page cached: \d+-\d+-\d+ \d+:\d+:\d+ -->\nHello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n/, File.read("#{public_fixtures_path}/system/cache/cache.cache.html"))
+          assert_match(/^Hello World from Sinatra Version=\[\d\.\d\.\d(\.\d)?\]\n<!-- page cached: \d+-\d+-\d+ \d+:\d+:\d+ -->\n$/, File.read("#{public_fixtures_path}/system/cache/cache.cache.html"))
         end
         
         it "should expire the /cache page" do 
@@ -392,7 +392,7 @@ describe "Sinatra::Cache" do
     describe "should respond to" do 
       
       [
-        "cache_dir", "cache_dir=","cache_dir?", "cache_enabled","cache_enabled=", "cache_enabled?",
+        "cache_output_dir", "cache_output_dir=","cache_output_dir?", "cache_enabled","cache_enabled=", "cache_enabled?",
         "cache_logging","cache_logging=","cache_logging?","cache_logging_level","cache_logging_level=","cache_logging_level?",
         "cache_page_extension","cache_page_extension=","cache_page_extension?"
       ].each do |m|
@@ -412,11 +412,11 @@ describe "Sinatra::Cache" do
     before do
       Sinatra::Base.register(Sinatra::Cache)
     end
-
+    
     describe "should respond to" do 
       
       [
-        "cache_dir", "cache_dir=","cache_dir?", "cache_enabled","cache_enabled=", "cache_enabled?",
+        "cache_output_dir", "cache_output_dir=","cache_output_dir?", "cache_enabled","cache_enabled=", "cache_enabled?",
         "cache_logging","cache_logging=","cache_logging?","cache_logging_level","cache_logging_level=","cache_logging_level?",
         "cache_page_extension","cache_page_extension=","cache_page_extension?"
       ].each do |m|
@@ -431,20 +431,4 @@ describe "Sinatra::Cache" do
     
   end #/Sinatra::Default
   
-  # it "should description" do 
-  #   assert_equal('Sinatra::Application', Sinatra::Application.methods.sort)
-  # end
-  # it "should description1" do 
-  #   assert_equal('Sinatra::Base', Sinatra::Base.methods.sort)
-  # end
-  # it "should description2" do 
-  #   assert_equal('@default_app', @default_app.methods.sort)
-  # end
-  # 
-  # it "should description3" do 
-  #   assert_equal('Sinatra::Default', Sinatra::Default.methods.sort)
-  # end
-  
-  
-  
 end #/Sinatra::Cache

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kematzy-sinatra-cache
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - kematzy