sinatra-simplecache 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8322dbc5868b8340fb2728fc8b451c16b918fd6f
-  data.tar.gz: aa27a293f6fb17070e8b49daa9a8df6b1e3d0624
+  metadata.gz: b78abec2742d26290b181e67e53a2a65976f6cae
+  data.tar.gz: edfa96bed9423298cf47f195273f494dacfdd39e
 SHA512:
-  metadata.gz: 206d2be8312f58f232ab9bf107246d561d9c0e326c99e20531e7ba0f1956d36f1afb05418ed389e806693aa7931de2c71cacbcae2e167b7eeaedb18af8aa47b8
-  data.tar.gz: 2b4e0cdb1250883ca876e5a7edf6efa818d4196c67ea39ae46c86e6a3d40ff0fd0710f7b0f8f4921085c71d8abf1fd3988ebbf0688cb5dff92d86888e27c4d8c
+  metadata.gz: 4ef941d40b97062c4dad36e8aedb35f8a35b7c0c19321d2b655c292b36067e6ff7fbb4cd2146668c195efcd879a4dec9b8e162f856717668461ddfce87d7caf2
+  data.tar.gz: 02cde8e9a7247e50f968796bbefcbe62c4ddb3443d28362bae92aa2f26f0d235ca09150dcca27373e6f64b085f2b365d9e2a2da13d23e6f55d1795035865aec6

data/README.md

@@ -1,6 +1,6 @@
 # Sinatra::Simplecache
 
-TODO: Write a gem description
+Simple cache helpers for Sinatra.
 
 ## Installation
 
@@ -18,7 +18,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Modular Application:
+
+``` ruby
+require 'sinatra/base'
+require 'sinatra/simplecache'
+require 'erubis'
+
+class TestApp < Sinatra::Base
+  helpers Sinatra::SimpleCache
+  set :erb, escape_html: true
+
+  get '/' do
+    cache(key: "index", expire: 10) { erb :index, locals: { _time: Time.now }}
+  end
+
+  run! if app_file == $0
+end
+```
+
+`sinatra-simplecache` provide `cache` helper method.
+This helper method take two args,
+
+* options
+  - key: cache key
+  - expire: set expire time(Time or Numeric)
+* block
+  - evaluate Template, RDB/KVS Query etc.
 
 ## Contributing
 

data/lib/sinatra/simplecache/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module SimpleCache
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/sinatra/simplecache.rb

@@ -3,8 +3,7 @@ require "sinatra/base"
 
 module Sinatra
   module SimpleCache
-    # Example.
-    #
+    # @example
     #  For operation cache:
     #   @@users = MySQL.query("...").to_a
     #   //=> @@users = cache(key: "users", expire: 0.6) { MySQL.query("...").to_a }
@@ -17,19 +16,24 @@ module Sinatra
     #    @@sidebar = cache(key: "sidebar", expire: 1) { slim: sidebar }
     #    slim :detail, :locales = { :sidebar => @@sidebar }
     #
+    # @param [Hash] opts Must specified :key and :expire
+    # @option opts [String] :key Cache key
+    # @option opts [Numeric] :expire(Infinity) Expire time
+    # @yield Evaluate template, RDB/KVS query etc
+    # @return [String] Block evaluated value, or cached value.
     def cache(opts={}, &block)
-      @@entries ||= {}
+      @@__entries__ ||= {}
 
       now = Time.now.to_f
-      expire = opts[:expire] ? (opts[:expire] + now) : (@@inf ||= 1/0.0)
+      (expire = opts[:expire]) ? (expire + now) : (@@inf ||= 1/0.0)
       key = opts[:key] || (defined?(Sinatra) && request.path) || abort("set key")
 
-      if (e = @@entries[key]) && (e[:expire] > now)
+      if (e = @@__entries__[key]) && (e[:expire] > now)
         return e[:value]
       end
 
       value = block.call
-      @@entries[key] = {
+      @@__entries__[key] = {
         expire: expire,
         value: value
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-simplecache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - yoppi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -92,3 +92,4 @@ signing_key:
 specification_version: 4
 summary: Simple cache helper for Sinatra
 test_files: []
+has_rdoc: