kv_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ba53100a2cf7afe3647d85d91eb49ea1cfa6102
+  data.tar.gz: ebb121477c37edf9bf0b2f976f7320c3d093403b
+SHA512:
+  metadata.gz: f27f5d3bde4ccf1255943ba2a4fb3a6c3b1fa24ed9e0c930d001841a0a70bf08a46f07dbc207b9b29b9afe4d26008f668cd4aa21fb020755485f4f2f221071f6
+  data.tar.gz: b079019e07e33a2e3e2a749a31011ab48baa5a538b0579f704ff7bcd3798a7390228fee4fe2d4dd479b4f441e1697db3693c972a3f88e3b3a7aa7825789e84f8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kv_cache.gemspec
+gemspec
+
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 azhao1981
+
+MIT License
+
+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.md

@@ -0,0 +1,56 @@
+# KvCache
+
+kv_cache is a tool caching keys and values in a ruby project.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kv_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kv_cache
+
+## Usage
+
+```
+require 'kv_cache'
+
+class City < ActiveRecord::Base
+  attr_accessible :name, :province
+  include KvCache
+  
+  # kv_cache :method_name, expire_time, :key, values_lambda
+  scope :guangxi, ->{ puts "fecth from db" 
+                      Store.call {where(province: "guangxi")} }
+  
+  after_save :kv_cache_reset
+
+  def kv_cache_reset
+    Store.delete(self.province)
+  end
+end
+
+  # some code 
+  City.guangxi  # first call will :
+  			    # fecth from db
+  			    # select * from cities where province = 'guangxi'
+  cs = City.guangxi  # will just return result above
+  cs.first.save      # will kv_cache_reset("guangxi") 
+  City.guangxi  # fecth from db again
+  
+```
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kv_cache.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kv_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kv_cache"
+  spec.version       = KvCache::VERSION
+  spec.authors       = ["azhao1981"]
+  spec.email         = ["azhao.1981@gmail.com"]
+  spec.description   = %q{Since using kv_cache, Mami need't to warry my db crashing anymore. :)}
+  spec.summary       = %q{cache your data that you don't need to fetch from db.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "dalli"
+end

data/lib/kv_cache/store.rb

@@ -0,0 +1,42 @@
+# -*- encoding : utf-8 -*-
+require "dalli"
+
+module KvCache
+  class Store
+    class << self
+      # call yield if key is not exist
+      def call(key,expire_time)
+        res = storer.get(key)
+        return res if res
+
+        res = yield
+
+        storer.set(key, res, expire_time)
+
+        res
+      end
+
+      # delete key 
+      def delete(*keys)
+        keys.each { |e| storer.delete(e) }
+      end
+
+      # like Dalli for memcached
+      # #get, #set is Necessary！！
+      def storer
+        @@_storer ||= defalt_storer
+      end
+
+      def defalt_storer
+        opts = { :namespace => "app_v1", :compress => true }
+        Dalli::Client.new('127.0.0.1:11211', opts)
+      end
+
+      # opts = { :namespace => "app_v2", :compress => true }
+      # KvCache::Store.storer = Dalli::Client.new('127.0.0.1:11211', opts)
+      def storer=(_storer)
+        @@_storer = _storer
+      end
+    end
+  end
+end

data/lib/kv_cache/version.rb

@@ -0,0 +1,3 @@
+module KvCache
+  VERSION = "0.0.1"
+end

data/lib/kv_cache.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+require "kv_cache/version"
+require "kv_cache/store"
+
+module KvCache
+end

data/spec/kv_store/store_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+
+describe "KvCache::Store" do
+  it "hello" do
+    KvCache::Store.new.should be_kind_of(KvCache::Store)
+  end
+
+  it "#call second time will get data from cache " do
+    call_time = 0
+    KvCache::Store.delete("hello")
+    res = KvCache::Store.call("hello", 20) do 
+      call_time += 1
+      90
+    end
+
+    call_time.should == 1
+    res.should == 90
+
+    res = KvCache::Store.call("hello", 20) do 
+      call_time += 1
+      90
+    end
+
+    call_time.should == 1
+    res.should == 90
+
+    KvCache::Store.delete("hello")
+
+    res = KvCache::Store.call("hello", 20) do 
+      call_time += 1
+      90
+    end
+
+    call_time.should == 2
+    res.should == 90
+    KvCache::Store.delete("hello")
+  end
+
+  it "#call will still exec after storer are changed " do
+    call_time = 0
+    KvCache::Store.delete("hello")
+    res = KvCache::Store.call("hello", 20) do 
+      call_time += 1
+      90
+    end
+
+    call_time.should == 1
+    res.should == 90
+
+    res = KvCache::Store.call("hello", 20) do 
+      call_time += 1
+      90
+    end
+
+    call_time.should == 1
+    res.should == 90
+
+    opts = { :namespace => "app_v2", :compress => true }
+    KvCache::Store.storer = Dalli::Client.new('127.0.0.1:11211', opts)
+
+    res = KvCache::Store.call("hello", 20) do 
+      call_time += 1
+      90
+    end
+
+    KvCache::Store.delete("hello")
+    call_time.should == 2
+    res.should == 90
+    KvCache::Store.delete("hello")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# 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
+
+require 'kv_cache'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: kv_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- azhao1981
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-20 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: dalli
+  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'
+description: Since using kv_cache, Mami need't to warry my db crashing anymore. :)
+email:
+- azhao.1981@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kv_cache.gemspec
+- lib/kv_cache.rb
+- lib/kv_cache/store.rb
+- lib/kv_cache/version.rb
+- spec/kv_store/store_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.11
+signing_key: 
+specification_version: 4
+summary: cache your data that you don't need to fetch from db.
+test_files:
+- spec/kv_store/store_spec.rb
+- spec/spec_helper.rb
+has_rdoc: