nice_cache 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjFlNDA4NmZhMmFmMDc0ZDZjNGQyNjJkMDVjY2M3ZjhkMjQ4NWFmOA==
+  data.tar.gz: !binary |-
+    NGNkZDZhZmE5NmVhMGY4NTVkODQzMGIwYmVlN2E2ZjViNjY4NWY2Ng==
+SHA512:
+  metadata.gz: !binary |-
+    NTY0ZTg0ZDAwN2YyNDcwY2Y1NWNhZjZkMTBjMzNiZmNmNmUyZWYyMDg3ODA4
+    Y2ExZWY1N2FlMGY3ZjE2ZjNhOGM0YTI2ZDhlMzkwYjdiYjVkMzdiMjFhZTYw
+    MWExMDBjMmJhYzQ4ZjBiYWNjYzJlZDNmOTU3NmEyNzgxMzZkM2U=
+  data.tar.gz: !binary |-
+    OWE0ZGQ4MTJjYWE2Y2ZhN2QzYjVjYzE5MTE1MDk5OTY5OWVjNGUxODgzOGI2
+    ZWI5NDY1Zjk4ZmRlMDgyMjI4OTk5OTA1NzkwZmQ1YWE1ZWVlMDBiNmJhMmRj
+    ZmFiNmZiNzY3NWFmMTc0NzQ2YjQ1YjlhYzA5MjgzZjQ4MzJhM2Y=

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/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nice_cache.gemspec
+gemspec
+
+gem 'rake'
+
+group :development do
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+end
+
+group :test do
+  gem 'json', platforms: [:jruby, :rbx, :ruby_19]
+  gem 'libnotify'
+  gem 'mime-types', platforms: :jruby
+  gem 'rspec'
+  gem 'mock_redis'
+  gem 'simplecov', require: false
+end
+
+group :development, :test do
+  gem 'pry-debugger', platforms: :ruby_19
+  gem 'pry-byebug', platforms: :ruby_20
+end

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Taian Su
+
+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,28 @@
+# NiceCache
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nice_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nice_cache
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/nice_cache/fork )
+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/lib/nice_cache/fragment.rb

@@ -0,0 +1,95 @@
+require_relative 'tag'
+
+module NiceCache
+  class Fragment
+    attr_reader :name, :data
+
+    def self.find(name)
+      new.find(name)
+    end
+
+    def self.key(name)
+      "Fragment:#{name}"
+    end
+
+    def self.tags_for(name)
+      "TagsFor:#{name}"
+    end
+
+    def initialize(data = nil, tag_names = nil)
+      create(data, tag_names) if data && tag_names
+    end
+
+    def create(data, tag_names)
+      @name = stringify(tag_names)
+      @data = data
+      attach_tags(tag_names)
+      save_to_redis
+    end
+
+    def find(name)
+      @name = name
+      @data = data_from_redis
+      self
+    end
+
+    def tags
+      Tag.find(redis_tag_names)
+    end
+
+    def attach_with(tag)
+      redis.sadd(attached_tags, tag.name)
+    end
+
+    def destroy
+      tags.each do |tag|
+        tag.remove_from(self)
+      end
+
+      redis.srem(NiceCache.all_fragments_key, @name)
+      redis.del attached_tags
+      redis.del fragment_key
+    end
+
+    def ==(other)
+      [name, data] == [other.name, other.data]
+    rescue
+      false
+    end
+
+    private
+
+    def attach_tags(tag_names)
+      Tag.find(tag_names).map{ |tag| tag.attach_on(self) }
+    end
+
+    def stringify(tag_names)
+      tag_names.map{ |tag| tag.to_s.capitalize }.join("-")
+    end
+
+    def attached_tags
+      self.class.tags_for(@name)
+    end
+
+    def fragment_key
+      self.class.key(@name)
+    end
+
+    def redis_tag_names
+      redis.smembers(attached_tags)
+    end
+
+    def save_to_redis
+      redis.sadd(NiceCache.all_fragments_key, @name)
+      redis.set(fragment_key, @data)
+    end
+
+    def data_from_redis
+      redis.get(fragment_key)
+    end
+
+    def redis
+      NiceCache.redis
+    end
+  end
+end

data/lib/nice_cache/tag.rb

@@ -0,0 +1,63 @@
+require_relative 'fragment'
+
+module NiceCache
+  class Tag
+    attr_reader :name
+
+    def self.find(*tag_names)
+      Array(tag_names).flatten.map{ |tag_symbol| new(tag_symbol) }
+    end
+
+    def self.key(name)
+      "Tag:#{name}"
+    end
+
+    def initialize(name)
+      @name = name.to_s
+    end
+
+    def attach_on(fragment)
+      redis.sadd(tag_key, fragment.name)
+      fragment.attach_with(self)
+      self
+    end
+
+    def fragments
+      fragment_keys.map{ |fragment_key| Fragment.find(fragment_key) }
+    end
+
+    def tag_key
+      self.class.key(@name)
+    end
+
+    def remove_from(fragment)
+      redis.srem(tag_key, fragment.name)
+    end
+
+    def sweep
+      fragments.map(&:destroy)
+      destroy
+    end
+
+    def ==(other)
+      name == other.name
+    rescue
+      false
+    end
+
+    private
+
+    def redis
+      NiceCache.redis
+    end
+
+    def destroy
+      redis.del tag_key
+    end
+
+    def fragment_keys
+      redis.smembers(tag_key)
+    end
+
+  end
+end

data/lib/nice_cache/version.rb

@@ -0,0 +1,3 @@
+module NiceCache
+  VERSION = "0.1.0"
+end

data/lib/nice_cache.rb

@@ -0,0 +1,55 @@
+require 'redis-namespace'
+require_relative "nice_cache/fragment"
+require_relative "nice_cache/tag"
+
+module NiceCache
+
+  def self.config(&block)
+    block.call(self)
+  end
+
+  def self.redis
+    @redis ||= namespaced_redis
+  end
+
+  def self.redis=(custom_redis)
+    @redis = namespaced_redis(custom_redis)
+  end
+
+  def self.cache(data, tags)
+    tag_names = tags.is_a?(Hash) ? tags[:tags] : Array(tags)
+    Fragment.new(data, tag_names)
+    self
+  end
+
+  def self.sweep_tags(*tag_names)
+    Tag.find(tag_names).map do |tag|
+      tag.sweep
+    end
+  end
+
+  def self.sweep_fragments(*fragment_names)
+    fragment_names.map do |fragment_name|
+      Fragment.find(fragment_name).destroy
+    end
+  end
+
+  def self.all_fragments_key
+    "AllFragments"
+  end
+
+  def self.cleanup
+    fragments.map(&:destroy)
+  end
+
+  def self.fragments
+    # O(N), N is number of fragment keys in NiceCache
+    redis.smembers(all_fragments_key).map { |name| Fragment.find(name) }
+  end
+
+  private
+  def self.namespaced_redis(redis = nil)
+    redis ||= Redis.current
+    Redis::Namespace.new(:NiceCache, redis: redis)
+  end
+end

data/nice_cache.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nice_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nice_cache"
+  spec.version       = NiceCache::VERSION
+  spec.authors       = ["Taian Su"]
+  spec.email         = ["me@taian.su"]
+  spec.summary       = %q{Tag based caching with Redis.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/optimis/nice_cache"
+  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_dependency 'redis', '~> 3.0'
+  spec.add_dependency 'redis-namespace', '~> 1.4'
+end

data/spec/nice_cache/fragment_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'mock_redis'
+
+describe NiceCache::Fragment do
+
+  subject(:fragment) { NiceCache::Fragment.new("Some Data", [:Year2014, :Month01, :Date01]) }
+
+  after :all do
+    puts "=== Clean up redis ==="
+    puts Benchmark.measure {
+      NiceCache.cleanup
+    }
+  end
+
+  before :all do
+    NiceCache.config do |options|
+      options.redis = REDIS # => from spec/spec_helper.rb
+    end
+  end
+
+  describe "#new" do
+    it "has correct name" do
+      expect(fragment.name).to eq "Year2014-Month01-Date01"
+    end
+
+    it "has correct data" do
+      expect(fragment.data).to eq "Some Data"
+    end
+  end
+
+  describe "#find" do
+    let(:fetch_fragment) { NiceCache::Fragment.find("Year2014-Month01-Date01") }
+
+    it "find correct data with fragment name" do
+      expect(fetch_fragment.data).to eq "Some Data"
+    end
+  end
+
+  it "get correct #tags" do
+    expect(fragment.tags.length).to eq 3
+  end
+
+  it "can compare with any classes" do
+    expect(fragment == []).to be_false
+  end
+end
+

data/spec/nice_cache/tag_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'mock_redis'
+
+describe NiceCache::Tag do
+
+  subject(:tag) { NiceCache::Tag.new(:"Year2014") }
+
+  after :all do
+    puts "=== Clean up redis ==="
+    puts Benchmark.measure {
+      NiceCache.cleanup
+    }
+  end
+
+  before :all do
+    NiceCache.config do |options|
+      options.redis = REDIS # => from spec/spec_helper.rb
+    end
+  end
+
+  it "have correct name" do
+    expect(tag.name).to eq "Year2014"
+  end
+
+  describe "#attach_on and #fragments" do
+    it "get correct #fragments after #attach_on" do
+      fragment = NiceCache::Fragment.new("Some Data", [:"Year2014", :"Month01", :"Date01"])
+      tag.attach_on(fragment)
+      expect(tag.fragments).to eq [fragment]
+    end
+  end
+
+  it "can compare with any classes" do
+    expect(tag == []).to be_false
+  end
+end

data/spec/nice_cache_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'benchmark'
+
+describe NiceCache do
+
+  it "change redis from #config" do
+    NiceCache.config do |options|
+      options.redis = REDIS # => from spec/spec_helper.rb
+    end
+
+    expect(NiceCache.redis.redis.class).to eq REDIS.class
+  end
+
+  after :all do
+    puts "=== Clean up redis ==="
+    puts Benchmark.measure {
+      NiceCache.cleanup
+    }
+  end
+
+  before :each do
+    NiceCache.cache("Some Data", tags: [:Year2014, :Month01, :Date01])
+  end
+
+  it "cleanup all the fragments and tags" do
+     NiceCache::Fragment.find("Year2014-Month01-Date01")
+     expect(NiceCache.redis.keys("*")).to_not be_empty
+     NiceCache.cleanup
+     expect(NiceCache.redis.keys("*")).to be_empty
+  end
+
+  let(:found_fragment) { NiceCache::Fragment.find("Year2014-Month01-Date01") }
+
+  it "cache fragment to #fragments" do
+    expect(NiceCache.fragments).to eq [found_fragment]
+  end
+
+  it "remove fragment" do
+    NiceCache.sweep_fragments("Year2014-Month01-Date01")
+    expect(NiceCache.fragments).to eq []
+  end
+
+  context "multiple fragments" do
+    before :each do
+      NiceCache.cache("Other Data", tags: [:Year2014, :Month02, :Date01])
+    end
+
+    it "get correct #fragments length" do
+      expect(NiceCache.fragments.length).to eq 2
+    end
+
+    it "sweep only one matched fragment" do
+      p Benchmark.measure {
+        NiceCache.sweep_tags(:Month02)
+        expect(NiceCache.fragments.length).to eq 1
+      }
+    end
+
+    it "sweep both of matching fragments" do
+      p Benchmark.measure {
+        NiceCache.sweep_tags(:Year2014)
+        expect(NiceCache.fragments.length).to eq 0
+      }
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+SimpleCov.start
+
+GEM_ROOT = File.expand_path('../../', __FILE__)
+$LOAD_PATH.unshift File.join(GEM_ROOT, 'lib')
+
+require 'nice_cache'
+Dir[File.join(GEM_ROOT, 'spec', 'support', '**/*.rb')].each { |f| require f }
+
+require 'mock_redis'
+require 'redis-namespace'
+REDIS = MockRedis.new
+# REDIS = Redis.new
+
+require 'pry'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: nice_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taian Su
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: ''
+email:
+- me@taian.su
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- License.txt
+- README.md
+- Rakefile
+- lib/nice_cache.rb
+- lib/nice_cache/fragment.rb
+- lib/nice_cache/tag.rb
+- lib/nice_cache/version.rb
+- nice_cache.gemspec
+- spec/nice_cache/fragment_spec.rb
+- spec/nice_cache/tag_spec.rb
+- spec/nice_cache_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/optimis/nice_cache
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Tag based caching with Redis.
+test_files:
+- spec/nice_cache/fragment_spec.rb
+- spec/nice_cache/tag_spec.rb
+- spec/nice_cache_spec.rb
+- spec/spec_helper.rb