elephas 3.0.1 → 4.0.0

data/doc/js/full_list.js

@@ -17,6 +17,7 @@ function fullListSearch() {
   searchCache = [];
   $('#full_list li').each(function() {
     var link = $(this).find('.object_link a');
+    if (link.length === 0) return;
     var fullName = link.attr('title').split(' ')[0];
     searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
   });
@@ -41,7 +42,7 @@ function fullListSearch() {
       $('#full_list li').removeClass('found').each(function() {
 
         var link = $(this).find('.object_link a');
-        link.text(link.text());
+        if (link.length > 0) link.text(link.text());
       });
       if (clicked) {
         clicked.parents('ul').each(function() {
@@ -110,6 +111,10 @@ clicked = null;
 function linkList() {
   $('#full_list li, #full_list li a:last').click(function(evt) {
     if ($(this).hasClass('toggle')) return true;
+    if ($(this).find('.object_link a').length === 0) {
+      $(this).children('a.toggle').click();
+      return false;
+    }
     if (this.tagName.toLowerCase() == "li") {
       var toggle = $(this).children('a.toggle');
       if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {

data/doc/method_list.html

@@ -48,281 +48,211 @@
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Entry.html#%3D%3D-instance_method" title="Elephas::Entry#== (method)">#==</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Cache.html#backend-instance_method" title="Elephas::Cache#backend (method)">#backend</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/Hash.html#data-instance_method" title="Elephas::Backends::Hash#data (method)">#data</a></span>
-    
-      <small>Elephas::Backends::Hash</small>
-    
+    <small>Elephas::Backends::Hash</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Backends/Base.html#delete-instance_method" title="Elephas::Backends::Base#delete (method)">#delete</a></span>
-    
-      <small>Elephas::Backends::Base</small>
-    
+    <small>Elephas::Backends::Base</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/RubyOnRails.html#delete-instance_method" title="Elephas::Backends::RubyOnRails#delete (method)">#delete</a></span>
-    
-      <small>Elephas::Backends::RubyOnRails</small>
-    
+    <small>Elephas::Backends::RubyOnRails</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Cache.html#delete-instance_method" title="Elephas::Cache#delete (method)">#delete</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/Hash.html#delete-instance_method" title="Elephas::Backends::Hash#delete (method)">#delete</a></span>
-    
-      <small>Elephas::Backends::Hash</small>
-    
+    <small>Elephas::Backends::Hash</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Entry.html#ensure-class_method" title="Elephas::Entry.ensure (method)">ensure</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/Base.html#exists%3F-instance_method" title="Elephas::Backends::Base#exists? (method)">#exists?</a></span>
-    
-      <small>Elephas::Backends::Base</small>
-    
+    <small>Elephas::Backends::Base</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Backends/Hash.html#exists%3F-instance_method" title="Elephas::Backends::Hash#exists? (method)">#exists?</a></span>
-    
-      <small>Elephas::Backends::Hash</small>
-    
+    <small>Elephas::Backends::Hash</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Cache.html#exists%3F-instance_method" title="Elephas::Cache#exists? (method)">#exists?</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Backends/RubyOnRails.html#exists%3F-instance_method" title="Elephas::Backends::RubyOnRails#exists? (method)">#exists?</a></span>
-    
-      <small>Elephas::Backends::RubyOnRails</small>
-    
+    <small>Elephas::Backends::RubyOnRails</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Entry.html#hash-instance_method" title="Elephas::Entry#hash (method)">#hash</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Entry.html#hashify_key-class_method" title="Elephas::Entry.hashify_key (method)">hashify_key</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/Hash.html#initialize-instance_method" title="Elephas::Backends::Hash#initialize (method)">#initialize</a></span>
-    
-      <small>Elephas::Backends::Hash</small>
-    
+    <small>Elephas::Backends::Hash</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Cache.html#initialize-instance_method" title="Elephas::Cache#initialize (method)">#initialize</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Entry.html#initialize-instance_method" title="Elephas::Entry#initialize (method)">#initialize</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Entry.html#key-instance_method" title="Elephas::Entry#key (method)">#key</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/Base.html#now-instance_method" title="Elephas::Backends::Base#now (method)">#now</a></span>
-    
-      <small>Elephas::Backends::Base</small>
-    
+    <small>Elephas::Backends::Base</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Cache.html#prefix-instance_method" title="Elephas::Cache#prefix (method)">#prefix</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Cache.html#read-instance_method" title="Elephas::Cache#read (method)">#read</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Backends/RubyOnRails.html#read-instance_method" title="Elephas::Backends::RubyOnRails#read (method)">#read</a></span>
-    
-      <small>Elephas::Backends::RubyOnRails</small>
-    
+    <small>Elephas::Backends::RubyOnRails</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/Hash.html#read-instance_method" title="Elephas::Backends::Hash#read (method)">#read</a></span>
-    
-      <small>Elephas::Backends::Hash</small>
-    
+    <small>Elephas::Backends::Hash</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Backends/Base.html#read-instance_method" title="Elephas::Backends::Base#read (method)">#read</a></span>
-    
-      <small>Elephas::Backends::Base</small>
-    
+    <small>Elephas::Backends::Base</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Entry.html#refresh-instance_method" title="Elephas::Entry#refresh (method)">#refresh</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Cache.html#setup_options-instance_method" title="Elephas::Cache#setup_options (method)">#setup_options</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Entry.html#ttl-instance_method" title="Elephas::Entry#ttl (method)">#ttl</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Entry.html#updated_at-instance_method" title="Elephas::Entry#updated_at (method)">#updated_at</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Cache.html#use-instance_method" title="Elephas::Cache#use (method)">#use</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Entry.html#valid%3F-instance_method" title="Elephas::Entry#valid? (method)">#valid?</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Entry.html#value-instance_method" title="Elephas::Entry#value (method)">#value</a></span>
-    
-      <small>Elephas::Entry</small>
-    
+    <small>Elephas::Entry</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Backends/Base.html#write-instance_method" title="Elephas::Backends::Base#write (method)">#write</a></span>
-    
-      <small>Elephas::Backends::Base</small>
-    
+    <small>Elephas::Backends::Base</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/RubyOnRails.html#write-instance_method" title="Elephas::Backends::RubyOnRails#write (method)">#write</a></span>
-    
-      <small>Elephas::Backends::RubyOnRails</small>
-    
+    <small>Elephas::Backends::RubyOnRails</small>
   </li>
   
 
   <li class="r2 ">
     <span class='object_link'><a href="Elephas/Cache.html#write-instance_method" title="Elephas::Cache#write (method)">#write</a></span>
-    
-      <small>Elephas::Cache</small>
-    
+    <small>Elephas::Cache</small>
   </li>
   
 
   <li class="r1 ">
     <span class='object_link'><a href="Elephas/Backends/Hash.html#write-instance_method" title="Elephas::Backends::Hash#write (method)">#write</a></span>
-    
-      <small>Elephas::Backends::Hash</small>
-    
+    <small>Elephas::Backends::Hash</small>
   </li>
   
 

data/doc/top-level-namespace.html

@@ -6,13 +6,13 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.5.2
+    &mdash; Documentation by YARD 0.8.6.1
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
 
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Apr 13 12:09:03 2013 by
+  Generated on Sun May 19 15:44:47 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.5.2 (ruby-1.9.3).
+  0.8.6.1 (ruby-1.9.3).
 </div>
 
   </body>

data/elephas.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 1.9.3"
 
-  gem.add_dependency("lazier", "~> 2.8.1")
+  gem.add_dependency("lazier", "~> 3.0.1")
 end

data/lib/elephas/backends/base.rb

@@ -56,8 +56,8 @@ module Elephas
       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)
+          i18n_setup(:elephas, ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../../locales/")) if !@i18n
+          raise ArgumentError.new(i18n.unimplemented)
         end
     end
   end

data/lib/elephas/backends/hash.rb

@@ -9,7 +9,7 @@ module Elephas
     # This is a simple backend, which uses an hash for storing the values.
     #
     # @attribute data
-    #   @return [Hash] The internal hash used by the backend.
+    #   @return [HashWithIndifferentAccess] The internal hash used by the backend.
     class Hash < Base
       attr_accessor :data
 
@@ -17,7 +17,7 @@ module Elephas
       #
       # @param data [Hash] The initial data stored.
       def initialize(data = nil)
-        @data = data && data.is_a?(::Hash) ? data : {}
+        @data = data.ensure_hash({}).with_indifferent_access
       end
 
       # Reads a value from the cache.
@@ -25,7 +25,7 @@ module Elephas
       # @param key [String] The key to lookup.
       # @return [Entry|NilClass] The read value or `nil`.
       def read(key)
-        self.exists?(key) ? @data[key.ensure_string] : nil
+        exists?(key) ? @data[key] : nil
       end
 
       # Writes a value to the cache.
@@ -38,7 +38,7 @@ module Elephas
       def write(key, value, options = {})
         entry = ::Elephas::Entry.ensure(value, key, options)
         entry.refresh
-        @data[key.ensure_string] = entry
+        @data[key] = entry
         entry
       end
 
@@ -47,7 +47,6 @@ module Elephas
       # @param key [String] The key to delete.
       # @return [Boolean] `true` if the key was in the cache, `false` otherwise.
       def delete(key)
-        key = key.ensure_string
         rv = @data.has_key?(key)
         @data.delete(key)
         rv
@@ -58,7 +57,6 @@ module Elephas
       # @param key [String] The key to lookup.
       # @return [Boolean] `true` if the key is in the cache, `false` otherwise.
       def exists?(key)
-        key = key.ensure_string
         @data.has_key?(key) && @data[key].valid?(self)
       end
     end

data/lib/elephas/backends/ruby_on_rails.rb

@@ -13,7 +13,7 @@ module Elephas
       # @param key [String] The key to lookup.
       # @return [Entry|NilClass] The read value or `nil`.
       def read(key)
-        self.exists?(key) ? Rails.cache.read(key) : nil
+        exists?(key) ? Rails.cache.read(key) : nil
       end
 
       # Writes a value to the cache.
@@ -35,7 +35,6 @@ module Elephas
       # @param key [String] The key to delete.
       # @return [Boolean] `true` if the key was in the cache, `false` otherwise.
       def delete(key)
-        key = key.ensure_string
         rv = Rails.cache.exist?(key)
         Rails.cache.delete(key)
         rv
@@ -46,7 +45,6 @@ module Elephas
       # @param key [String] The key to lookup.
       # @return [Boolean] `true` if the key is in the cache, `false` otherwise.
       def exists?(key)
-        key = key.ensure_string
         Rails.cache.exist?(key) && Rails.cache.read(key).valid?(self)
       end
     end

data/lib/elephas/cache.rb

@@ -56,7 +56,7 @@ module Elephas
       rv = nil
 
       # Get options
-      options = self.setup_options(options, key)
+      options = setup_options(options, key)
 
       # Check if the storage has the value (if we don't have to skip the cache)
       rv = choose_backend(options).read(options[:hash]) if options[:force] == false && options[:ttl] > 0
@@ -83,7 +83,7 @@ module Elephas
     # @see .setup_options
     # @return [Object] The value itself.
     def write(key, value, options = {})
-      choose_backend(options).write(key, value, self.setup_options(options, key))
+      choose_backend(options).write(key, value, setup_options(options, key))
     end
 
     # Deletes a value from the cache.
@@ -119,8 +119,7 @@ module Elephas
     # @param key [String] The key to associate to this options.
     # @return [Hash] An options hash.
     def setup_options(options, key)
-      options = {} if !options.is_a?(::Hash)
-      options = {ttl: 1.hour * 1000, force: false, as_entry: false}.merge(options)
+      options = {ttl: 1.hour * 1000, force: false, as_entry: false}.merge(options.ensure_hash({}))
 
       # Sanitize options.
       options = sanitize_options(options, key)
@@ -143,7 +142,7 @@ module Elephas
       def compute_value(options, &block)
         rv = block.call(options)
         rv = ::Elephas::Entry.ensure(rv, options[:complete_key], options) # Make sure is an entry
-        self.write(rv.hash, rv, options) if !rv.value.nil? && options[:ttl] > 0 # We have a value and we have to store it
+        write(rv.hash, rv, options) if !rv.value.nil? && options[:ttl] > 0 # We have a value and we have to store it
         rv
       end
 
@@ -153,10 +152,11 @@ module Elephas
       # @param key [String] The key to associate to this options.
       # @return [Hash] An options hash.
       def sanitize_options(options, key)
-        options[:key] ||= key.ensure_string
+        options[:key] ||= key
         options[:ttl] == options[:ttl].blank? ? 1.hour * 1000 : [options[:ttl].to_integer, 0].max
         options[:force] = options[:force].to_boolean
         options[:prefix] = options[:prefix].present? ? options[:prefix] : self.prefix
+
         options
       end
 
@@ -164,7 +164,7 @@ module Elephas
       #
       # @param options [Backends::Base|Hash] The backend to use. Defaults to the current backend.
       def choose_backend(options)
-        backend = (options.is_a?(Hash) ? options.symbolize_keys[:backend] : options)
+        backend = options.ensure_hash({}).symbolize_keys[:backend]
         backend.is_a?(Elephas::Backends::Base) ? backend : self.backend
       end
   end

data/lib/elephas/entry.rb

@@ -35,7 +35,7 @@ module Elephas
       @hash = hash.present? ? hash : self.class.hashify_key(key)
       @value = value
       @ttl = ttl
-      self.refresh
+      refresh
     end
 
     # Refreshes the entry.
@@ -54,7 +54,7 @@ module Elephas
     # @param backend [Backends::Base] The backend to use for the check.
     # @return [Boolean] `true` if the entry is still valid, `false` otherwise.
     def valid?(backend)
-      backend.now - self.updated_at < self.ttl / 1000
+      backend.now - updated_at < self.ttl / 1000
     end
 
     # Compares to another Entry.
@@ -70,7 +70,7 @@ module Elephas
     # @param key [String] The key to hashify.
     # @return [String] An unique hash for the key.
     def self.hashify_key(key)
-      Digest::SHA2.hexdigest(key.ensure_string)
+      Digest::SHA2.hexdigest(key)
     end
 
     # Ensures that the value is an Entry.
@@ -83,10 +83,10 @@ module Elephas
       rv = value
 
       if !rv.is_a?(::Elephas::Entry) then
-        options = {} if !options.is_a?(Hash)
+        options = options.ensure_hash({})
 
         ttl = [options[:ttl].to_integer, 0].max
-        hash = options[:hash] || ::Elephas::Entry.hashify_key(key.ensure_string)
+        hash = options[:hash] || ::Elephas::Entry.hashify_key(key)
 
         rv = ::Elephas::Entry.new(key, rv, hash, ttl)
       end

data/lib/elephas/version.rb

@@ -11,13 +11,13 @@ module Elephas
   # @see http://semver.org
   module Version
     # The major version.
-    MAJOR = 3
+    MAJOR = 4
 
     # The minor version.
     MINOR = 0
 
     # The patch version.
-    PATCH = 1
+    PATCH = 0
 
     # The current version of elephas.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

data/spec/elephas/cache_spec.rb

@@ -6,7 +6,7 @@
 
 require "spec_helper"
 
-describe ::Elephas::Cache do
+describe Elephas::Cache do
   let(:entry) { ::Elephas::Entry.ensure("VALUE", ::Elephas::Cache.new(nil).prefix + "[KEY]", {ttl: 3600}) }
   let(:reference) { ::Elephas::Cache.new(::Elephas::Backends::Hash.new) }
 

data/spec/elephas/entry_spec.rb

@@ -84,7 +84,6 @@ describe Elephas::Entry do
     it "should compute a good hash" do
       expect(::Elephas::Entry.hashify_key("HASH 1")).to eq("88e1f3572122e2605c1fab09efa8d4e99f5a064ae0230ca0aeced839796aba35")
       expect(::Elephas::Entry.hashify_key("HASH 2")).to eq("38589cee32e00f700cf958dfe98f17d6da231700c41586e3c32b00314bb3cb58")
-      expect(::Elephas::Entry.hashify_key(nil)).to eq("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855")
     end
   end
 

data/spec/elephas/providers/hash_spec.rb

@@ -16,7 +16,7 @@ describe Elephas::Backends::Hash do
     end
 
     it "should create a store with an given hash" do
-      expect(::Elephas::Backends::Hash.new({a: :b}).data).to eq({a: :b})
+      expect(::Elephas::Backends::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

@@ -12,13 +12,13 @@ describe Elephas::Backends::RubyOnRails do
       self[key]
     end
 
-    def write(key, value, options = {})
-      self.delete(key)
+    def write(key, value, _)
+      delete(key)
       self[key] = value
     end
 
     def exist?(key)
-      self.has_key?(key)
+      has_key?(key)
     end
   end