elephas 0.1.0

data/spec/elephas/providers/hash_spec.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+#
+# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Elephas::Providers::Hash do
+  subject { ::Elephas::Providers::Hash.new }
+  let!(:value) { subject.write("KEY", ::Elephas::Entry.ensure("VALUE", "KEY", {:ttl => 3600})) }
+
+  describe "#initialize" do
+    it "should create a store with an empty hash" do
+      expect(::Elephas::Providers::Hash.new.data).to eq({})
+    end
+
+    it "should create a store with an given hash" do
+      expect(::Elephas::Providers::Hash.new({:a => :b}).data).to eq({:a => :b})
+    end
+
+    it "should ensure that the store is an Hash" do
+      expect(::Elephas::Providers::Hash.new(nil).data).to eq({})
+      expect(::Elephas::Providers::Hash.new("INVALID").data).to eq({})
+    end
+  end
+
+  describe "#read" do
+    it "fetch data from the hash" do
+      expect(subject.read("KEY")).to be_a(::Elephas::Entry)
+      expect(subject.read("KEY").value).to eq("VALUE")
+    end
+
+    it "return nil for missing or expired values" do
+      subject.data["KEY"].updated_at = Time.now.to_f - 3700
+
+      expect(subject.read("KEY")).to be_nil
+      expect(subject.read("INVALID")).to be_nil
+    end
+  end
+
+  describe "#write" do
+    it "should save data to the hash" do
+      expect(subject.data["KEY"]).to be_a(::Elephas::Entry)
+      expect(subject.data["KEY"].key).to eq("KEY")
+      expect(subject.data["KEY"].value).to eq("VALUE")
+    end
+
+    it "should save data and update TTL" do
+      updated_at = value.updated_at
+
+      expect(subject.write("KEY", value)).to eq(value)
+      expect(value.updated_at).not_to eq(updated_at)
+    end
+  end
+
+  describe "#delete" do
+    it "should delete a stored value and return true" do
+      expect(subject.delete("KEY")).to be_true
+      expect(subject.data["KEY"]).to be_nil
+    end
+
+    it "should return false if the value doesn't exists" do
+      expect(subject.delete("INVALID")).to be_false
+    end
+  end
+
+  describe "#exists?" do
+    it "returns true for valid keys" do
+      expect(subject.exists?("KEY")).to be_true
+    end
+
+    it "returns false for invalid or expired keys" do
+      subject.data["KEY"].updated_at = Time.now.to_f - 3700
+
+      expect(subject.exists?("KEY")).to be_false
+      expect(subject.exists?("INVALID")).to be_false
+    end
+  end
+end

data/spec/elephas/providers/ruby_on_rails_spec.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+#
+# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Elephas::Providers::RubyOnRails do
+  class TempRailsCache < Hash # This class simulate the presence of Rails
+    def read(key)
+      self[key]
+    end
+
+    def write(key, value, options = {})
+      self[key] = value
+    end
+
+    def exist?(key)
+      self.has_key?(key)
+    end
+  end
+
+  class Rails
+    def self.cache
+      @cache ||= TempRailsCache.new
+    end
+  end
+
+  subject { ::Elephas::Providers::RubyOnRails.new }
+  let!(:value) { subject.write("KEY", ::Elephas::Entry.ensure("VALUE", "KEY", {:ttl => 3600})) }
+
+  describe "#read" do
+    it "fetch data from the cache" do
+      expect(subject.read("KEY")).to be_a(::Elephas::Entry)
+      expect(subject.read("KEY").value).to eq("VALUE")
+    end
+
+    it "return nil for missing or expired values" do
+      Rails.cache.read("KEY").updated_at = Time.now.to_f - 3700
+
+      expect(subject.read("KEY")).to be_nil
+      expect(subject.read("INVALID")).to be_nil
+    end
+  end
+
+  describe "#write" do
+    it "should save data to the hash" do
+      expect(Rails.cache.read("KEY")).to be_a(::Elephas::Entry)
+      expect(Rails.cache.read("KEY").key).to eq("KEY")
+      expect(Rails.cache.read("KEY").value).to eq("VALUE")
+    end
+
+    it "should save data and update TTL" do
+      value = Rails.cache.read("KEY")
+      updated_at = value.updated_at
+
+      expect(subject.write("KEY", value)).to eq(value)
+      expect(value.updated_at).not_to eq(updated_at)
+    end
+  end
+
+  describe "#delete" do
+    it "should delete a stored value and return true" do
+      expect(subject.delete("KEY")).to be_true
+      expect(Rails.cache.read("KEY")).to be_nil
+    end
+
+    it "should return false if the value doesn't exists" do
+      expect(subject.delete("INVALID")).to be_false
+    end
+  end
+
+  describe "#exists?" do
+    it "returns true for valid keys" do
+      expect(subject.exists?("KEY")).to be_true
+    end
+
+    it "returns false for invalid or expired keys" do
+      Rails.cache.read("KEY").updated_at = Time.now.to_f - 3700
+
+      expect(subject.exists?("KEY")).to be_false
+      expect(subject.exists?("INVALID")).to be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+#
+# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "rubygems"
+require "coverage_helper"
+require "bundler/setup"
+require "elephas"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: elephas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Shogun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cowtech-extensions
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: A storage agnostic caching framework.
+email:
+- shogun_panda@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- doc/Elephas.html
+- doc/Elephas/Cache.html
+- doc/Elephas/Entry.html
+- doc/Elephas/Exceptions.html
+- doc/Elephas/Providers.html
+- doc/Elephas/Providers/Base.html
+- doc/Elephas/Providers/Hash.html
+- doc/Elephas/Providers/RubyOnRails.html
+- doc/Elephas/Version.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- elephas.gemspec
+- lib/elephas.rb
+- lib/elephas/cache.rb
+- lib/elephas/entry.rb
+- lib/elephas/provider.rb
+- lib/elephas/providers/hash.rb
+- lib/elephas/providers/ruby_on_rails.rb
+- lib/elephas/version.rb
+- spec/coverage_helper.rb
+- spec/elephas/cache_spec.rb
+- spec/elephas/entry_spec.rb
+- spec/elephas/provider_spec.rb
+- spec/elephas/providers/hash_spec.rb
+- spec/elephas/providers/ruby_on_rails_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ShogunPanda/elephas
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2608788952293416880
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2608788952293416880
+requirements: []
+rubyforge_project: elephas
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A storage agnostic caching framework.
+test_files:
+- spec/coverage_helper.rb
+- spec/elephas/cache_spec.rb
+- spec/elephas/entry_spec.rb
+- spec/elephas/provider_spec.rb
+- spec/elephas/providers/hash_spec.rb
+- spec/elephas/providers/ruby_on_rails_spec.rb
+- spec/spec_helper.rb
+has_rdoc: