blunt-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa23a41b5b4323f62abb654de3248b0284d53f39
+  data.tar.gz: 39d07e022f2c23a94dc970140ce9caa009b41335
+SHA512:
+  metadata.gz: a3446dc8ab676bcf121f8e6dae706f41dc815238711ddfaa3adf48941d6b96f57d25fd6bf72f48d8667deed52742f8a0dfd6566ea2d2a8bf513915c8be0685d2
+  data.tar.gz: da6241b12fd898a9feb20ac033e94100d85800c1dce0773aa6b785415c31f82eee3d81e6cbc22a04a405c83ec287a9d1f2bbfadfb9bcb03697286c283bd0d975

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    blunt_cache (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blunt_cache!
+  bundler (~> 1.6)
+  rake
+  rspec (~> 3.1)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Roman Exempliarov
+
+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,39 @@
+# BluntCache
+Simple in-memory cache service for ruby.
+
+## Usage
+
+    # set/get by key
+    BluntCache.set "key", data
+    data = BluntCache.get "key"
+
+    # executes block if not set or expired
+    data = BluntCache.fetch "key" do
+      do_something
+    end
+
+    # time to live can be provided (dafault is 60 sec)
+    BluntCache.set "key", expire: 120 data
+    BluntCache.fetch "key", expire: 120 do
+      do_something
+    end
+
+    # inherit it for namespacing and extending
+    class MyCache < BluntCache
+      @expire_default = 30
+    end
+
+    MyCache.set "1", "2"
+    BluntCache.set "1", "3"
+    MyCache.get "1" #2
+
+## Why? When to use?
+
+* It is fast.
+* Use it when you don't want to execute seralization-deseralization cycle with real cache (Redis or Memcache).
+* Use it when you not able (or don't want) to use external cache service (you or your admin are lazy, when using Heroku or other cloud services, etc).
+
+## Limitations
+
+* Keep in mind that values are stored in memory even if they are expired. As for replaced values, let's just belive in Ruby GC abilities. So, Ruby workers can bloat.
+* Keep in mind that Cache IS NOT shared between workers (e.g. Unicorn, Puma cluster workers) and IS shared between threads (Puma).

data/blunt_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 'blunt_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blunt-cache"
+  spec.version       = BluntCache::VERSION
+  spec.authors       = ["Roman Exempliarov"]
+  spec.email         = ["urvala@gmail.com"]
+  spec.summary       = %q{Simple in-memory cache service for ruby.}
+  spec.description   = %q{Simple in-memory cache service for ruby.}
+  spec.homepage      = "https://github.com/appelsin/blunt_cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/blunt_cache.rb

@@ -0,0 +1,46 @@
+# In-memory cache service.
+class BluntCache
+  @expire_default = 60
+
+  # Store +data+ in cache by +key+ for +:expire+ seconds (default is 60 sec)
+  def self.set(key, data, expire: nil)
+    self.timestamp[key] = Time.now + (expire || self.expire_default)
+    self.data[key] = data
+    data
+  end
+
+  # Get +key+ from cache. Returns nil if not set or expired.
+  def self.get(key)
+    self.timestamp[key].is_a?(Time) && Time.now < self.timestamp[key] ? self.data[key] : nil
+  end
+
+  # Get +key+ from cache. Executes +block+, stores it's result and returns it if not set or expired.
+  def self.fetch(key, expire: nil, &block)
+    result = self.get key
+    if result.nil?
+      self.set key, block.call, expire: expire
+    else
+      result
+    end
+  end
+
+  # Clear cache
+  def self.flush
+    @data = {}
+    @timestamp = {}
+  end
+
+protected
+
+  def self.data
+    @data||= {}
+  end
+
+  def self.timestamp
+    @timestamp||= {}
+  end
+
+  def self.expire_default
+    @expire_default||=60
+  end
+end

data/lib/blunt_cache/version.rb

@@ -0,0 +1,3 @@
+class BluntCache
+  VERSION = "0.1.0"
+end

data/spec/blunt_cache_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe BluntCache do
+
+  class MyCache < BluntCache
+  end
+
+  class ShortCache < BluntCache
+    @expire_default = 0.1
+  end
+
+  [BluntCache, MyCache, ShortCache].each do |c|
+    context '#{c.name}' do
+      it 'stores data' do
+        expect { c.set("1", "1_val") }.not_to raise_error
+        result = nil
+        expect { result = c.get("1") }.not_to raise_error
+        expect(result).to eq "1_val"
+        expect { c.set("1", "1_val_2") }.not_to raise_error
+        expect { result = c.get("1") }.not_to raise_error
+        expect(result).to eq "1_val_2"
+      end
+
+      it 'returns nil on no data' do
+        result = "value"
+        expect { result = c.get("2") }.not_to raise_error
+        expect(result).to eq nil
+      end
+
+      it 'returns value before expiration and nil after expiration' do
+        expect { c.set("3", "3_val", expire: 0.1) }.not_to raise_error
+        result = nil
+        expect { result = c.get("3") }.not_to raise_error
+        expect(result).to eq "3_val"
+        sleep(0.09)
+        expect { result = c.get("3") }.not_to raise_error
+        expect(result).to eq "3_val"
+        sleep(0.02)
+        expect { result = c.get("3") }.not_to raise_error
+        expect(result).to eq nil
+      end
+
+      it 'evals block in fetch if cache not set' do
+        expect(c.get("4")).to eq nil
+        result = nil
+        expect { result = c.fetch("4") do "4_val" end }.not_to raise_error
+        expect(result).to eq "4_val"
+        expect(c.get("4")).to eq "4_val"
+        expect { result = c.fetch("4") do "4_val_2" end }.not_to raise_error
+        expect(result).to eq "4_val"
+      end
+
+      it 'returns value before expiration and re-executes block after expiration (fetch)' do
+        result = nil
+        expect { result = c.fetch "6", expire: 0.1 do "6_val" end }.not_to raise_error
+        expect(result).to eq "6_val"
+        expect { result = c.fetch "6" do "6_val_2" end }.not_to raise_error
+        expect(result).to eq "6_val"
+        sleep(0.11)
+        expect { result = c.fetch "6" do "6_val_3" end }.not_to raise_error
+        expect(result).to eq "6_val_3"
+      end
+    end
+  end
+
+  it 'can be namespaced by inheritance' do
+    expect { result = MyCache.set "7", "7_val" }.not_to raise_error
+    expect(BluntCache.get "7").to eq nil
+    expect(ShortCache.get "7").to eq nil
+    expect(MyCache.get "7").to eq "7_val"
+  end
+
+  it 'uses overrided @expire_default when inherited' do
+    expect { result = ShortCache.set "8", "8_val" }.not_to raise_error
+    expect(ShortCache.get "8").to eq "8_val"
+    sleep(0.11)
+    expect(ShortCache.get "8").to eq nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'blunt_cache'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: blunt-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Exempliarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Simple in-memory cache service for ruby.
+email:
+- urvala@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- blunt_cache.gemspec
+- lib/blunt_cache.rb
+- lib/blunt_cache/version.rb
+- spec/blunt_cache_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/appelsin/blunt_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.4.7
+signing_key: 
+specification_version: 4
+summary: Simple in-memory cache service for ruby.
+test_files:
+- spec/blunt_cache_spec.rb
+- spec/spec_helper.rb