cachew 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: bee898b623cf6399bb9a8b2d281400561ef965ba
+  data.tar.gz: 2630810c58528c2e8c0f430740cf1bc16cd76bc3
+SHA512: 
+  metadata.gz: 372ff7e2c634a068d861d33b22b45b57afd0f3ffa14f35c9e9867d33f904049214ce058e3c745f7dd8585a62d4712b5f0ffb0e5f564f554bdfbb2ee2272363ab
+  data.tar.gz: b64586d8a75d0e07b784cf5870c3d5421a055b0ad567150d6449905b98610a49cbb41ae33c082a86e1f80906d8b0fe4256838ae66433bbf947a2348568b24413

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/.rubocop.yml

@@ -0,0 +1,36 @@
+# Avoid long parameter lists
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+MethodLength:
+  CountComments: false
+  Max: 15
+
+ClassLength:
+  CountComments: false
+  Max: 100
+
+CyclomaticComplexity:
+  Max: 6
+
+BlockNesting:
+  Max: 3
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Encoding:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+BracesAroundHashParameters:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+EmptyLines:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gem "rake"
+gem "rspec"
+gem "guard-rspec"
+gem "rubocop"
+gem "coveralls", :require => false
+gem "simplecov", :require => false
+
+platforms :rbx do
+  gem "racc"
+  gem "rubinius-coverage", "~> 2.0"
+  gem "rubysl", "~> 2.0"
+end
+
+# Specify your gem's dependencies in cachew.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aleksey V Zapparov
+
+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,48 @@
+# Cachew
+
+Simple (and unified) cache interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cachew'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cachew
+
+## Usage
+
+``` ruby
+# With HashAdapter
+cache = Cachew.new({})
+
+cache.has?(:foo)           # => false
+cache.fetch(:foo) { :bar } # => :bar
+
+cache.has?(:foo)           # => true
+cache.fetch(:foo) { :moo } # => :bar
+
+
+# With (default) NullAdapter
+cache = Cachew.new
+
+cache.has?(:foo)           # => false
+cache.fetch(:foo) { :bar } # => :bar
+
+cache.has?(:foo)           # => false
+cache.fetch(:foo) { :moo } # => :moo
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/cachew/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,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new
+
+task :default => [:spec, :rubocop]

data/cachew.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cachew/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cachew"
+  spec.version       = Cachew::VERSION
+  spec.authors       = ["Aleksey V Zapparov"]
+  spec.email         = ["ixti@member.fsf.org"]
+  spec.summary       = "cachew-#{Cachew::VERSION}"
+  spec.description   = "Unified cache interface."
+  spec.homepage      = "https://github.com/ixti/cachew"
+  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.5"
+end

data/lib/cachew.rb

@@ -0,0 +1,19 @@
+require "cachew/version"
+require "cachew/adapters"
+
+# Unified cache interface
+class Cachew
+  extend Forwardable
+
+  attr_reader :adapter
+
+  def initialize(store = nil)
+    @adapter = Adapters.build_adapter_for store
+  end
+
+  def fetch(key)
+    has?(key) ? get(key) : set(key, yield)
+  end
+
+  def_delegators :adapter, :set, :get, :has?
+end

data/lib/cachew/adapters.rb

@@ -0,0 +1,15 @@
+require "cachew/adapters/base_adapter"
+require "cachew/adapters/hash_adapter"
+require "cachew/adapters/null_adapter"
+
+class Cachew
+  module Adapters
+    def self.build_adapter_for(store)
+      case store
+      when BaseAdapter  then store
+      when Hash         then HashAdapter.new(store)
+      else                   NullAdapter.new
+      end
+    end
+  end
+end

data/lib/cachew/adapters/base_adapter.rb

@@ -0,0 +1,5 @@
+class Cachew
+  module Adapters
+    BaseAdapter = Struct.new(:store)
+  end
+end

data/lib/cachew/adapters/hash_adapter.rb

@@ -0,0 +1,17 @@
+class Cachew
+  module Adapters
+    class HashAdapter < BaseAdapter
+      def set(key, value)
+        store[key] = value
+      end
+
+      def get(key)
+        store[key]
+      end
+
+      def has?(key)
+        store.key?(key)
+      end
+    end
+  end
+end

data/lib/cachew/adapters/null_adapter.rb

@@ -0,0 +1,17 @@
+class Cachew
+  module Adapters
+    class NullAdapter < BaseAdapter
+      def set(_, value)
+        value
+      end
+
+      def get(_)
+        nil
+      end
+
+      def has?(_)
+        false
+      end
+    end
+  end
+end

data/lib/cachew/version.rb

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

data/spec/lib/cachew/adapters/hash_adapter_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Cachew::Adapters::HashAdapter do
+  let(:adapter) { described_class.new({}) }
+
+  describe "#set" do
+    it "returns back given value" do
+      expect(adapter.set(:foo, :bar)).to be :bar
+    end
+
+    it "sets value in the underlying store Hash" do
+      adapter.set(:foo, :bar)
+      expect(adapter.store).to eq :foo => :bar
+    end
+  end
+
+  describe "#get" do
+    it "returns nil if value does not exists" do
+      expect(adapter.get(:foo)).to be_nil
+    end
+
+    it "returns saved value if exists" do
+      adapter.store[:foo] = :bar
+      expect(adapter.get(:foo)).to be :bar
+    end
+  end
+
+  describe "#has?" do
+    it "returns true even if stored value is nil" do
+      adapter.store[:foo] = nil
+      expect(adapter.has?(:foo)).to be_true
+    end
+  end
+end

data/spec/lib/cachew/adapters/null_adapter_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Cachew::Adapters::NullAdapter do
+  let(:adapter) { described_class.new }
+
+  describe "#set" do
+    it "returns back given value" do
+      expect(adapter.set(:foo, :bar)).to be :bar
+    end
+  end
+
+  describe "#get" do
+    it "always returns nil" do
+      adapter.set(:foo, :bar)
+      expect(adapter.get :foo).to be_nil
+    end
+  end
+
+  describe "#has?" do
+    it "always returns false" do
+      adapter.set(:foo, :bar)
+      expect(adapter.has? :foo).to be_false
+    end
+  end
+end

data/spec/lib/cachew/adapters_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Cachew::Adapters do
+  describe ".build_adapter_for" do
+    context "with Hash instance" do
+      it "returns HashAdapter" do
+        adapter = described_class.build_adapter_for :foo => :bar
+        expect(adapter).to be_a Cachew::Adapters::HashAdapter
+      end
+    end
+
+    context "with instance of BaseAdapter" do
+      it "returns adapter as is" do
+        adapter = Cachew::Adapters::HashAdapter.new :foo => :bar
+        expect(described_class.build_adapter_for adapter).to be adapter
+      end
+    end
+
+    it "returns NullAdapter if can't find better candidate" do
+      expect(described_class.build_adapter_for "test")
+        .to be_a Cachew::Adapters::NullAdapter
+    end
+  end
+end

data/spec/lib/cachew_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Cachew do
+  describe ".new" do
+    it "initiates with NullAdapter by default" do
+      expect(described_class.new.adapter).to be_a Cachew::Adapters::BaseAdapter
+    end
+
+    it "calls Adapters.build_adapter_for with given store" do
+      store = { :foo => :bar }
+      expect(Cachew::Adapters).to receive(:build_adapter_for).with store
+      described_class.new store
+    end
+  end
+
+  describe "#set" do
+    subject(:cachew) { described_class.new.set }
+    specify { expect { cachew.adapter.to receive :set } }
+  end
+
+  describe "#get" do
+    subject(:cachew) { described_class.new.get }
+    specify { expect { cachew.adapter.to receive :get } }
+  end
+
+  describe "#has?" do
+    subject(:cachew) { described_class.new.has? }
+    specify { expect { cachew.adapter.to receive :has? } }
+  end
+
+  describe "#fetch" do
+    let(:cachew) { described_class.new :foo => :bar }
+
+    it "calls has?" do
+      expect(cachew).to receive(:has?)
+      cachew.fetch(:foo) { :moo }
+    end
+
+    context "when adapter has? key" do
+      it "calls get" do
+        expect(cachew).to receive(:get)
+        cachew.fetch(:foo) { :moo }
+      end
+    end
+
+    context "when adapter does not has? key" do
+      it "calls set" do
+        expect(cachew).to receive(:set)
+        cachew.fetch(:bar) { :moo }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "simplecov"
+require "coveralls"
+
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+
+require "cachew"
+
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: cachew
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aleksey V Zapparov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-02-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.5"
+  type: :development
+  version_requirements: *id001
+description: Unified cache interface.
+email: 
+- ixti@member.fsf.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rubocop.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cachew.gemspec
+- lib/cachew.rb
+- lib/cachew/adapters.rb
+- lib/cachew/adapters/base_adapter.rb
+- lib/cachew/adapters/hash_adapter.rb
+- lib/cachew/adapters/null_adapter.rb
+- lib/cachew/version.rb
+- spec/lib/cachew/adapters/hash_adapter_spec.rb
+- spec/lib/cachew/adapters/null_adapter_spec.rb
+- spec/lib/cachew/adapters_spec.rb
+- spec/lib/cachew_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ixti/cachew
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id002 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: cachew-0.1.0
+test_files: 
+- spec/lib/cachew/adapters/hash_adapter_spec.rb
+- spec/lib/cachew/adapters/null_adapter_spec.rb
+- spec/lib/cachew/adapters_spec.rb
+- spec/lib/cachew_spec.rb
+- spec/spec_helper.rb
+has_rdoc: