elephas 1.1.3 → 2.0.0

data/lib/elephas/provider.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 
@@ -11,13 +11,14 @@ module Elephas
     # The base provider, with all methods a valid provider should override.
     module Base
       extend ActiveSupport::Concern
+      include Lazier::I18n
 
       # Reads a value from the cache.
       #
       # @param key [String] The key to lookup.
       # @return [Entry|NilClass] The read value or `nil`.
       def read(key)
-        raise ArgumentError.new("A Elephas::Providers subclass must override this method.")
+        unimplemented
       end
 
       # Writes a value to the cache.
@@ -28,7 +29,7 @@ module Elephas
       # @see Elephas::Cache.setup_options
       # @return [Object] The value itself.
       def write(key, value, options = {})
-        raise ArgumentError.new("A Elephas::Providers subclass must override this method.")
+        unimplemented
       end
 
       # Deletes a value from the cache.
@@ -36,7 +37,7 @@ module Elephas
       # @param key [String] The key to delete.
       # @return [TrueClass|FalseClass] `true` if the key was in the cache, `false` otherwise.
       def delete(key)
-        raise ArgumentError.new("A Elephas::Providers subclass must override this method.")
+        unimplemented
       end
 
       # Checks if a key exists in the cache.
@@ -44,7 +45,7 @@ module Elephas
       # @param key [String] The key to lookup.
       # @return [TrueClass|FalseClass] `true` if the key is in the cache, `false` otherwise.
       def exists?(key)
-        raise ArgumentError.new("A Elephas::Providers subclass must override this method.")
+        unimplemented
       end
 
       # Returns the current time for comparing with entries TTL.
@@ -53,6 +54,13 @@ module Elephas
       def now
         ::Time.now.to_f
       end
+
+      private
+        # Marks a method as unimplemented.
+        def unimplemented
+          self.i18n_setup(:elephas, ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/")) if !@i18n
+          raise ArgumentError.new(self.i18n.unimplemented)
+        end
     end
   end
 end

data/lib/elephas/providers/hash.rb

@@ -1,23 +1,23 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 
 module Elephas
   module Providers
     # This is a simple providers, which uses an hash for storing the values.
+    #
+    # @attribute data
+    #   @return [Hash] The internal hash used by the provider.
     class Hash
       include Elephas::Providers::Base
-
-      # The internal hash used by the provider.
       attr_accessor :data
 
       # Initialize the provider
       # @param data [Hash] The initial data stored.
       def initialize(data = nil)
-        data = {} if !data || !data.is_a?(::Hash)
-        @data = data
+        @data = data && data.is_a?(::Hash) ? data : {}
       end
 
       # Reads a value from the cache.
@@ -36,10 +36,10 @@ module Elephas
       # @see Elephas::Cache.setup_options
       # @return [Object] The value itself.
       def write(key, value, options = {})
-        fvalue = ::Elephas::Entry.ensure(value, key, options)
-        fvalue.refresh
-        @data[key.ensure_string] = fvalue
-        value
+        entry = ::Elephas::Entry.ensure(value, key, options)
+        entry.refresh
+        @data[key.ensure_string] = entry
+        entry
       end
 
       # Deletes a value from the cache.
@@ -47,9 +47,9 @@ module Elephas
       # @param key [String] The key to delete.
       # @return [Boolean] `true` if the key was in the cache, `false` otherwise.
       def delete(key)
-        fkey = key.ensure_string
-        rv = @data.has_key?(fkey)
-        @data.delete(fkey)
+        key = key.ensure_string
+        rv = @data.has_key?(key)
+        @data.delete(key)
         rv
       end
 
@@ -58,8 +58,8 @@ module Elephas
       # @param key [String] The key to lookup.
       # @return [Boolean] `true` if the key is in the cache, `false` otherwise.
       def exists?(key)
-        fkey = key.ensure_string
-        @data.has_key?(fkey) && @data[fkey].valid?
+        key = key.ensure_string
+        @data.has_key?(key) && @data[key].valid?
       end
     end
   end

data/lib/elephas/providers/ruby_on_rails.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 
@@ -26,11 +26,10 @@ module Elephas
       # @see Elephas::Cache.setup_options
       # @return [Object] The value itself.
       def write(key, value, options = {})
-        fvalue = ::Elephas::Entry.ensure(value, key, options)
-        fvalue.refresh
-
-        Rails.cache.write(key, value, :expires_in => fvalue.ttl)
-        value
+        entry = ::Elephas::Entry.ensure(value, key, options)
+        entry.refresh
+        Rails.cache.write(key, entry, expires_in: entry.ttl)
+        entry
       end
 
       # Deletes a value from the cache.
@@ -38,9 +37,9 @@ module Elephas
       # @param key [String] The key to delete.
       # @return [Boolean] `true` if the key was in the cache, `false` otherwise.
       def delete(key)
-        fkey = key.ensure_string
-        rv = Rails.cache.exist?(fkey)
-        Rails.cache.delete(fkey)
+        key = key.ensure_string
+        rv = Rails.cache.exist?(key)
+        Rails.cache.delete(key)
         rv
       end
 
@@ -49,8 +48,8 @@ module Elephas
       # @param key [String] The key to lookup.
       # @return [Boolean] `true` if the key is in the cache, `false` otherwise.
       def exists?(key)
-        fkey = key.ensure_string
-        Rails.cache.exist?(fkey) && Rails.cache.read(fkey).valid?
+        key = key.ensure_string
+        Rails.cache.exist?(key) && Rails.cache.read(key).valid?
       end
     end
   end

data/lib/elephas/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 
@@ -11,13 +11,13 @@ module Elephas
   # @see http://semver.org
   module Version
     # The major version.
-    MAJOR = 1
+    MAJOR = 2
 
     # The minor version.
-    MINOR = 1
+    MINOR = 0
 
     # The patch version.
-    PATCH = 3
+    PATCH = 0
 
     # The current version of elephas.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

data/lib/elephas.rb

@@ -1,11 +1,9 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 
-$KCODE='UTF8' if RUBY_VERSION < '1.9'
-
 require "lazier"
 require "digest/sha2"
 Lazier.load!("boolean", "math", "object")

data/locales/en.yml

@@ -0,0 +1,9 @@
+# encoding: utf-8
+#
+# This file is part of the elephas gem. Copyright (C) 2013 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.
+#
+
+---
+  elephas:
+    unimplemented: "A Elephas::Providers subclass must override this method."

data/locales/it.yml

@@ -0,0 +1,9 @@
+# encoding: utf-8
+#
+# This file is part of the elephas gem. Copyright (C) 2013 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.
+#
+
+---
+  elephas:
+    unimplemented: "Una sottoclasse di Elephas::Providers deve effettuare l'override di questo metodo."

data/spec/coverage_helper.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 

data/spec/elephas/cache_spec.rb

@@ -1,13 +1,13 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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::Cache do
-  let(:entry) { ::Elephas::Entry.ensure("VALUE", ::Elephas::Cache.default_prefix + "[KEY]", {:ttl => 3600}) }
+  let(:entry) { ::Elephas::Entry.ensure("VALUE", ::Elephas::Cache.default_prefix + "[KEY]", {ttl: 3600}) }
 
   describe ".use" do
     before(:each) do
@@ -20,9 +20,9 @@ describe ::Elephas::Cache do
     end
 
     it "should skip the provider if requested to" do
-      ::Elephas::Cache.use("KEY", {:ttl => 0}) do "VALUE" end
+      ::Elephas::Cache.use("KEY", {ttl: 0}) do "VALUE" end
       ::Elephas::Cache.provider.should_not_receive(:read)
-      ::Elephas::Cache.use("KEY", {:force => true}) do "VALUE" end
+      ::Elephas::Cache.use("KEY", {force: true}) do "VALUE" end
       ::Elephas::Cache.provider.should_not_receive(:read)
     end
 
@@ -44,7 +44,7 @@ describe ::Elephas::Cache do
       ::Elephas::Cache.use("KEY") do "VALUE" end
 
       expect(::Elephas::Cache.use("KEY")).to eq("VALUE")
-      value = ::Elephas::Cache.use("KEY", {:as_entry => true})
+      value = ::Elephas::Cache.use("KEY", {as_entry: true})
       expect(value).to be_a(::Elephas::Entry)
       expect(value.value).to eq("VALUE")
     end
@@ -81,28 +81,28 @@ describe ::Elephas::Cache do
   describe "setup_options" do
     it "should set good defaults for options" do
       hashes = {
-        :base => ::Elephas::Entry.hashify_key("#{::Elephas::Cache.default_prefix}[KEY]"),
-        :alternative => ::Elephas::Entry.hashify_key("prefix[KEY]")
+        base: ::Elephas::Entry.hashify_key("#{::Elephas::Cache.default_prefix}[KEY]"),
+        alternative: ::Elephas::Entry.hashify_key("prefix[KEY]")
       }
       
       options_hashes = [
         nil,
         "A",
-        {:ttl => 2.hour},
-        {:force => true},
-        {:as_entry => true},
-        {:prefix => "prefix", :hash => hashes[:alternative]},
-        {:hash => "hash"}
+        {ttl: 2.hour},
+        {force: true},
+        {as_entry: true},
+        {prefix: "prefix", hash: hashes[:alternative]},
+        {hash: "hash"}
       ]
 
       reference_hashes = [
-        {:key => "KEY", :ttl => 1.hour * 1000, :force => false, :as_entry => false, :prefix => ::Elephas::Cache.default_prefix, :complete_key => "#{::Elephas::Cache.default_prefix}[KEY]", :hash => hashes[:base]},
-        {:key => "KEY", :ttl => 1.hour * 1000, :force => false, :as_entry => false, :prefix => ::Elephas::Cache.default_prefix, :complete_key => "#{::Elephas::Cache.default_prefix}[KEY]", :hash => hashes[:base]},
-        {:key => "KEY", :ttl => 2.hour, :force => false, :as_entry => false, :prefix => ::Elephas::Cache.default_prefix, :complete_key => "#{::Elephas::Cache.default_prefix}[KEY]", :hash => hashes[:base]},
-        {:key => "KEY", :ttl => 1.hour * 1000, :force => true, :as_entry => false, :prefix => ::Elephas::Cache.default_prefix, :complete_key => "#{::Elephas::Cache.default_prefix}[KEY]", :hash => hashes[:base]},
-        {:key => "KEY", :ttl => 1.hour * 1000, :force => false, :as_entry => true, :prefix => ::Elephas::Cache.default_prefix, :complete_key => "#{::Elephas::Cache.default_prefix}[KEY]", :hash => hashes[:base]},
-        {:key => "KEY", :ttl => 1.hour * 1000, :force => false, :as_entry => false, :prefix => "prefix", :complete_key => "prefix[KEY]", :hash => hashes[:alternative]},
-        {:key => "KEY", :ttl => 1.hour * 1000, :force => false, :as_entry => false, :prefix => ::Elephas::Cache.default_prefix, :complete_key => "#{::Elephas::Cache.default_prefix}[KEY]", :hash => "hash"}
+        {key: "KEY", ttl: 1.hour * 1000, force: false, as_entry: false, prefix: ::Elephas::Cache.default_prefix, complete_key: "#{::Elephas::Cache.default_prefix}[KEY]", hash: hashes[:base]},
+        {key: "KEY", ttl: 1.hour * 1000, force: false, as_entry: false, prefix: ::Elephas::Cache.default_prefix, complete_key: "#{::Elephas::Cache.default_prefix}[KEY]", hash: hashes[:base]},
+        {key: "KEY", ttl: 2.hour, force: false, as_entry: false, prefix: ::Elephas::Cache.default_prefix, complete_key: "#{::Elephas::Cache.default_prefix}[KEY]", hash: hashes[:base]},
+        {key: "KEY", ttl: 1.hour * 1000, force: true, as_entry: false, prefix: ::Elephas::Cache.default_prefix, complete_key: "#{::Elephas::Cache.default_prefix}[KEY]", hash: hashes[:base]},
+        {key: "KEY", ttl: 1.hour * 1000, force: false, as_entry: true, prefix: ::Elephas::Cache.default_prefix, complete_key: "#{::Elephas::Cache.default_prefix}[KEY]", hash: hashes[:base]},
+        {key: "KEY", ttl: 1.hour * 1000, force: false, as_entry: false, prefix: "prefix", complete_key: "prefix[KEY]", hash: hashes[:alternative]},
+        {key: "KEY", ttl: 1.hour * 1000, force: false, as_entry: false, prefix: ::Elephas::Cache.default_prefix, complete_key: "#{::Elephas::Cache.default_prefix}[KEY]", hash: "hash"}
       ]
 
       options_hashes.each_with_index do |options, i|

data/spec/elephas/entry_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 

data/spec/elephas/provider_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 

data/spec/elephas/providers/hash_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 
@@ -8,7 +8,7 @@ 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})) }
+  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
@@ -16,7 +16,7 @@ describe Elephas::Providers::Hash do
     end
 
     it "should create a store with an given hash" do
-      expect(::Elephas::Providers::Hash.new({:a => :b}).data).to eq({:a => :b})
+      expect(::Elephas::Providers::Hash.new({a: :b}).data).to eq({a: :b})
     end
 
     it "should ensure that the store is an Hash" do

data/spec/elephas/providers/ruby_on_rails_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 
@@ -28,7 +28,7 @@ describe Elephas::Providers::RubyOnRails do
   end
 
   subject { ::Elephas::Providers::RubyOnRails.new }
-  let!(:value) { subject.write("KEY", ::Elephas::Entry.ensure("VALUE", "KEY", {:ttl => 3600})) }
+  let!(:value) { subject.write("KEY", ::Elephas::Entry.ensure("VALUE", "KEY", {ttl: 3600})) }
 
   describe "#read" do
     it "fetch data from the cache" do

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the elephas gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
+# This file is part of the elephas gem. Copyright (C) 2013 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.
 #
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elephas
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lazier
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 10.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 10.0.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.5
 description: A storage agnostic caching framework.
 email:
 - shogun_panda@me.com
@@ -155,7 +155,6 @@ files:
 - 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
@@ -183,6 +182,8 @@ files:
 - lib/elephas/providers/hash.rb
 - lib/elephas/providers/ruby_on_rails.rb
 - lib/elephas/version.rb
+- locales/en.yml
+- locales/it.yml
 - spec/coverage_helper.rb
 - spec/elephas/cache_spec.rb
 - spec/elephas/entry_spec.rb
@@ -190,7 +191,7 @@ files:
 - spec/elephas/providers/hash_spec.rb
 - spec/elephas/providers/ruby_on_rails_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/ShogunPanda/elephas
+homepage: http://sw.cow.tc/elephas
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -201,19 +202,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -3114060091249618626
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3114060091249618626
 requirements: []
 rubyforge_project: elephas
 rubygems_version: 1.8.24