sinatra-diskcache 0.0.3 → 1.0.0

data/.gitignore

@@ -1 +1,2 @@
 *.swp
+*.gem

data/README.md

@@ -2,7 +2,77 @@
 
 Allows to cache heavy-load query results on the disk.
 
+## Depends on
+
+Nope. It doesn't have any dependencies.
+
 ## Install
 
     gem install sinatra-diskcache
 
+## Usage
+
+Oh, it's pretty easy and straightforward. Look, I'll show you.
+
+```ruby
+require 'sinatra'
+require 'sinatra/diskcache'
+
+# ... something clever here ...
+
+get '/something' do
+    result = diskcache 'somefile' do |file| # this block will be invoked only in case of absence of 'somefile'
+        f = File.open file, 'w'
+
+        # heavy load here
+        sleep 5
+
+        f.write 'something to be cached'
+        f.close
+    end
+
+    send_file result # or transfer it anyhow else
+end
+```
+
+Basically, that's all. For more detailed example you can look [here](https://github.com/pixe1f10w/scalls/).
+
+## Avalilable options
+
+* *diskcache_enabled*
+
+Serves for activation/deactivasion of module. Defaults to 'true'.
+
+* *diskcache_logging*
+
+Activates/deactivates logging, mostly for debug. Defaults to 'true' in development environments.
+
+* *diskcache_expiry_enabled*
+
+Enabled cache file expiration. Period of expiration should be set by *diskcache_expiry_period* (see below). Defaults to 'true'.
+
+* *diskcache_expiry_period*
+
+See above. Value in seconds. Defaults to 3600 (1 hour).
+
+* *diskcache_empty_cleanup*
+
+Enables empty cache file deletion. Default to 'true'.
+
+* *diskcache_path*
+
+Declares the directory where cache files will be stored. Defaults to './diskcache'.
+
+* *diskcache_full_paths*
+
+Enables usage of absolute paths to cached files. Full file path will be passed to processing block and returned by 'diskcache' method. In the example above both 'result' and 'file' variables will have value of '/full/path/to/cached/file'.
+
+Defaults to 'true'.
+
+## License
+
+Copyright © Ilia Zhirov - 2012.
+
+Licensed under terms of [MIT license](http://www.opensource.org/licenses/mit-license.php).
+
+Feel free to fork it, fix any bugs, add features and send me a pull requests. Bug reports are also welcome.

data/lib/sinatra/diskcache.rb

@@ -21,7 +21,7 @@ module Sinatra
                 end
             rescue => e
                 throw e if settings.development? or settings.show_exceptions
-                
+
                 if block_given?
                     block.call path_to filename
                     return resulting_name filename
@@ -45,7 +45,7 @@ module Sinatra
             def cache_get filename
                 filepath = path_to filename
 
-                if not ( File.size? filename ) and settings.diskcache_empty_cleanup
+                if not ( File.size? filepath ) and settings.diskcache_empty_cleanup
                     cache_log "#{filename} is empty, wiping"
                     File.delete filepath
                     nil
@@ -65,7 +65,7 @@ module Sinatra
                 end
             end
         end
-        
+
         def self.registered app
             app.helpers DiskCache::Helpers
 

data/lib/sinatra/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module DiskCache
-    VERSION = "0.0.3"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-diskcache
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies: []
 description: Allows to cache heavy-load query results on the disk
 email: