opsb-ziggy 0.1.0 → 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Oliver Searle-Barnes
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -1,17 +1,19 @@
 ziggy
 =====
 
-Cache any method on any class using rails.cache
+Cache any method on any class using Rails.cache
 
 Install
 -------
 
-$ gem sources -a http://gems.github.com (you only have to do this once)
-$ sudo gem install opsb-ziggy
+    $ gem sources -a http://gems.github.com (you only have to do this once)
+    $ sudo gem install opsb-ziggy
 
 Introduction
 ------------
 
+ziggy will cache methods and then expire them. The results from method invocations are stored in and read from the Rails.cache using Rails.cache.write(key, value) and Rails.cache.read(key).
+
 ### Cache a method
 
 	class TwitterUser
@@ -46,6 +48,8 @@ Introduction
 
 ### expire_after
 
+The default expire_after time is 2.5.minutes, to customise do
+
 	class TwitterUser
 	  include Ziggy
 	  cached :timeline, :expire_after => 1.5.minutes
@@ -60,7 +64,7 @@ Introduction
 
 ### Customise key
 
-The method name and arguments are always used as the base of the cache key. Using a block you can differentiate the keys based on further criteria e.g. screen_name.
+The method name and arguments are always used as the base of the cache key. You can customise the start of the cache key using a block.
 
     class TwitterUser
       include Ziggy
@@ -76,8 +80,6 @@ The method name and arguments are always used as the base of the cache key. Usin
 
 ### Different options for different methods
 
-The method name and arguments are always used as the base of the cache key. You can customise the start of the cache key using a block.
-
 	class TwitterUser
 	  include Ziggy
 	  cached :timeline, :expire_after => 1.minutes { |twitterUser| twitterUser.screen_name }

data/RakeFile

@@ -0,0 +1,15 @@
+task :default => [:gemspec]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ziggy"
+    gemspec.summary = "Cache any method on any class"
+    gemspec.description = "ziggy can be used to cache any method on any class and allows custom keys and expiration times"
+    gemspec.email = "oliver@opsb.co.uk"
+    gemspec.homepage = "http://github.com/opsb/ziggy"
+    gemspec.authors = ["Oliver Searle-Barnes"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

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

data/lib/ziggy.rb

@@ -1,4 +1,4 @@
-module Ziggy2
+module Ziggy
 
   def self.included(base)
     base.extend ClassMethods

data/ziggy.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ziggy}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oliver Searle-Barnes"]
@@ -10,10 +10,14 @@ Gem::Specification.new do |s|
   s.description = %q{ziggy can be used to cache any method on any class and allows custom keys and expiration times}
   s.email = %q{oliver@opsb.co.uk}
   s.extra_rdoc_files = [
-    "README.markdown"
+    "LICENSE",
+     "README.markdown"
   ]
   s.files = [
-    "README.markdown",
+    "LICENSE",
+     "README.markdown",
+     "RakeFile",
+     "VERSION.yml",
      "lib/ziggy.rb",
      "ziggy.gemspec"
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: opsb-ziggy
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Oliver Searle-Barnes
@@ -20,9 +20,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README.markdown
 files: 
+- LICENSE
 - README.markdown
+- RakeFile
+- VERSION.yml
 - lib/ziggy.rb
 - ziggy.gemspec
 has_rdoc: true