munna 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 081e73bfd8f97bc0892e612f1aaa2c4181d60b58
-  data.tar.gz: ce07091638d9e7c174cdf9a47f0a2755597fe20c
+  metadata.gz: 18d02948e6426b1492c72e4856414458efbdc506
+  data.tar.gz: 10ffc7cb7b37cac78ec12af8d841b746fbe0adc2
 SHA512:
-  metadata.gz: 8c41b1cef5c5e2614ba15876a86875d716a7087854549b3bf347fe0539c9c8f06e89a8498787399924681fb737bd22759e6ede62595866e34689c1b3f0e93c31
-  data.tar.gz: aab933212c79a8991626d031f06d1aa2d447640c53c6df249a31e3e0d45ed84bc8af88bc5256f46dcd7b6e911f38ad0dc27a105813b32593ce436920f1261e5a
+  metadata.gz: 7b2d9b24b2f4512e638b0786c53a9777aeb9c2771a7194cf2daa0cc150ecab1e5b6b9f2b9d2ce9e0503bbebf05e369d89a536b4e425e97a1c71271ea9918df3c
+  data.tar.gz: fc087b37ee4d7220e9b3471e96fdd4b1728f0485487a7c1225f5f1c5027a6f70547f895a41a75658d5bff8b48549078460e3d386dd249866c5313fbf57a77e24

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,29 +1,80 @@
 # Munna
 
-TODO: Write a gem description
+Simple cache wrapper for rails ActiveRecord, Object, ... to speed up your site
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'munna'
+	gem 'munna'
 
-And then execute:
+### Usage
 
-    $ bundle
+#### ActiveRecord
 
-Or install it yourself as:
+``` ruby
+class Profile < ActiveRecord::Base
+	after_destroy :clear_cache
 
-    $ gem install munna
+	def clear_cache
+		User.delete_cached :list_with_profiles
+	end
+end
 
-## Usage
+class User < ActiveRecord::Base
+	has_many :profiles
 
-TODO: Write usage instructions here
+	def self.list_with_profiles
+		cache.join(:profiles)
+			.group('users.id')
+			.select('users.*, count(users.id)')
+	end
 
-## Contributing
+	# get random 5 rows, cache for 10.hours
+	def self.list_by_random
+		cached_for 10.hours {
+			order('rand(id)').limit(5)
+		}
+	end
+end
+```
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+``` ruby
+User.cached.all # get all users at the first time, after that fetch from cache
+```
+
+#### Advanced Options
+Everything in rails can be cached through **cached**, **cached_for** and remove through **delete_cached**
+
+##### 1. cached vs delete_cached
+
+| cached                     									 | delete_cached                   		 |
+| -------------------------------------------- | ----------------------------------- |
+| Anything.cached(opts).function   						 | Anything.delete_cached.function 		 |
+| Anything.cached(:name, opts).function 			 | Anything.delete_cached :name 			 |
+| Anything.cached([:name, :id], opts).function | Anything.delete_cached [:name, :id] |
+| Anything.cached {}                           | Anything.delete_cached caller_name   |
+| Anything.cached(:name, opts) { ... }         | Anything.delete_cached :name        |
+| Anything.cached([:name, :id], opts) { ... }  | Anything.delete_cached [:name, :id] |
+
+
+##### 2. cached_for: is the quite similar to cached, with shortcut for expires_in
+``` ruby
+Anything.cached_for(10.hours, opts).function
+Anything.cached_for(10.hours, opts) {}
+```
+
+* ***opts*** is optional, you can ignore it
+* ***caller_name*** is the function name that line belong to
+
+##### 3. opts: is a ```Hash```, has options
+	* expires_in: time to expire
+	* key: cached key for save and use for ***delete_cached***
+
+#### 4. cache support
+``` ruby
+Munna.cache.values # => list all key in memcached
+Munna.cache.clear # => clear all value, key in memcached
+Munna.cache.get_matched /xxx/ # => get values with satify regex
+Munna.cache.delete_matched /xxx/ # => delete values with satify regex
+```

data/lib/munna/cache.rb

@@ -4,7 +4,7 @@ module Munna
 	class Cache
 		include Singleton
 
-		def initalize
+		def initialize
 			values
 		end
 

data/lib/munna/extensions/basic_method.rb

@@ -5,8 +5,8 @@ module Munna
 				Proxy::Write.builder(munna_perform, self, Helper.normalize_params(opts), &block)
 			end
 
-			def cached_for(expires_in, opts={}, &block)
-				cached(opts.merge(:expires_in => expires_in), &block)
+			def cached_for(expires_in, *opts, &block)
+				Proxy::Write.builder(munna_perform, self, Helper.normalize_params(opts).merge(:expires_in => expires_in), &block)
 			end
 
 			def delete_cached(*opts)

data/lib/munna/perform/base.rb

@@ -9,8 +9,8 @@ module Munna
 
 			def perform_write
 				Munna.cache.write cached_key
-				Rails.cache.fetch(cached_key, @opts) do
-					normalize(@execute.value)
+				Rails.cache.fetch cached_key, @opts do
+					normalize @execute.value
 				end
 			end
 

data/lib/munna/proxy/base.rb

@@ -1,11 +1,6 @@
 module Munna
 	module Proxy
 		class Base
-			def self.builder(kclass, target, options={}, &block)
-				instance = new kclass, target, options, &block
-				block.present? ? instance.__perform__(Execute.new target, block) : instance
-			end
-
 			def initialize(kclass, target, options={}, &block)
 				@kclass = kclass
 				@target = target
@@ -21,7 +16,12 @@ module Munna
 			end
 		end
 
-		class Write < Base; end
+		class Write < Base
+			def self.builder(kclass, target, options={}, &block)
+				instance = new kclass, target, options, &block
+				block.present? ? instance.__perform__(Execute.new target, block) : instance
+			end
+		end
 
 		class Delete < Base
 			def self.builder(kclass, target, options={}, &block)

data/lib/munna/version.rb

@@ -1,3 +1,3 @@
 module Munna
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/munna.rb

@@ -9,15 +9,11 @@ module Munna
 			Cache.instance
 		end
 
-		def get_key(fragments)
-			if [Symbol, String].include? fragments.class
-				fragments.to_s
+		def get_key(params)
+			if [Symbol, String].include? params.class
+				params
 			else
-				key = ''
-				fragments.each do |fragment|
-					key += '/' + (fragment.is_a?(Array) ? fragment.join('-') : fragment.to_s)
-				end
-				key[1..-1]
+				(params.map {|v| v.is_a?(Array) ? v.join('-') : v}).join('/')
 			end
 		end
 	end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: munna
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - |
@@ -9,48 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Optimize rails's expensive action with cache through Cache
@@ -60,7 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -80,6 +81,7 @@ files:
 - lib/munna/version.rb
 - lib/rake/munna.rake
 - munna.gemspec
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -90,18 +92,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Add cache for your object
-test_files: []
+test_files:
+- spec/spec_helper.rb