juno 0.2.1 → 0.2.2

data/Gemfile

@@ -24,6 +24,7 @@ gem 'couchrest'
 gem 'sequel'
 gem 'dalli'
 gem 'riak-client'
+gem 'hashery'
 
 if defined?(JRUBY_VERSION)
   gem 'jdbc-sqlite3'

data/README.md

@@ -11,6 +11,7 @@ Out of the box, it supports:
 
 * Memory:
     * In-memory store (:Memory)
+    * LRU hash (:LRUHash)
     * LocalMemCache (:LocalMemCache)
     * Memcached store (:Memcached, :MemcachedNative and :MemcachedDalli)
 * Relational Databases:
@@ -38,10 +39,12 @@ Out of the box, it supports:
     * Fog cloud storage which supports Amazon S3, Rackspace, etc. (:Fog)
     * Storage which doesn't store anything (:Null)
 
-Special proxies:
-* Juno::Expires to add expiration support to stores
-* Juno::Stack to stack multiple stores
-* Juno::Proxy basic proxy class
+In addition it supports proxies (Similar to [Rack middlewares](http://rack.rubyforge.org/)) which
+add additional features to storage backends:
+
+* Juno::Proxy proxy base class
+* Juno::Expires to add expiration support to stores which don't support it natively
+* Juno::Stack to stack multiple stores (Read returns result from first where the key is found, writes go to all stores)
 * Juno::Transformer transforms keys and values (Marshal, YAML, JSON, Base64, MD5, ...)
 * Juno::Cache combine two stores, one as backend and one as cache (e.g. Juno::Adapters::File + Juno::Adapters::Memory)
 
@@ -115,13 +118,14 @@ The Cassandra, Memcached and Redis backends supports expires values directly:
 
 ~~~ ruby
 cache = Juno::Adapters::Memcached.new
-# Expires in 10 seconds
-cache.store(key, value, :expires => 10)
 
 # Or using the builder...
 cache = Juno.build do
   adapter :Memcached
 end
+
+# Expires in 60 seconds
+cache.store(key, value, :expires => 60)
 ~~~
 
 You can add the expires feature to other backends using the Expires proxy:
@@ -130,9 +134,8 @@ You can add the expires feature to other backends using the Expires proxy:
 # Using the :expires option
 cache = Juno.new(:File, :dir => '...', :expires => true)
 
-# or using the proxy...
+# or manually by using the proxy...
 cache = Juno::Expires.new(Juno::Adapters::File.new(:dir => '...'))
-cache.store(key, value, :expires => 10)
 
 # or using the builder...
 cache = Juno.build do
@@ -144,5 +147,5 @@ end
 Authors
 -------
 
-* Moneta originally by wycats
 * Juno by Daniel Mendler
+* Moneta originally by wycats

data/SPEC.md

@@ -6,10 +6,6 @@ The purpose of the juno specification is to create a general-purpose API for int
 
 Juno ships with a set of executable specs which you can use to verify spec-compliance with your juno adapter.
 
-# Juno Library
-
-Juno ships with proof-of-concept adapters for over a dozen key-value stores, including in-memory, memcache, database-backed and S3. These adapters are meant as proofs-of-concept, and while the juno project intends to maintain them (and will accept patches to improve them), you should not consider them the core of the project.
-
 # Requirements for a Juno Adapter
 
 (See RFC 2119 for use of MUST, SHOULD, MAY, MUST NOT, and SHOULD NOT)
@@ -32,10 +28,6 @@ Return the value stored in the key-value-store under the provided key. Adapters
 
 Store the value in the key-value-store under the provided key. Adapters MAY serialize the value using Ruby's Marshal system, and MUST NOT store a reference to the original value in the store, unless Ruby disallows duplication of the original value. Adapters SHOULD NOT simply call <code>dup</code> on the value, unless the value stores no references to other Object. For example, an adapter MAY store a <code>dup</code> of a String, but SHOULD NOT store a <code>dup</code> of <code>["hello", "world"]</code>.
 
-### <code>fetch(key[Object]) => Object</code>
-
-Return the value stored in the key-value-store under the provided key. If no value is stored under the provided key, the adapter MUST raise an IndexError.
-
 ### <code>fetch(key[Object], &block) => Object</code>
 
 Return the value stored in the key-value-store under the provided key. If no value is stored under the provided key, the adapter MUST yield to the block, and return the value. The adapter MUST NOT store the value returned from the block in the key-value-store.
@@ -65,16 +57,13 @@ Completely empty all keys and values from the key-value-store. Adapters MAY allo
 The following methods may all take an additional Hash as a final argument. This allows the client to send additional options which can be specified by the adapter (and which may be specified by extensions to this specification).
 
 * fetch
+* load
 * store
 * delete
 * key?
 * clear
 
-In the case of methods with optional arguments, the Hash MUST be provided as the final argument, and all optional arguments MUST be specified.
-
-Keys in this Hash MUST be Strings or Symbols. If they are Strings, they MUST be prefixed with a unique namespace. Namespaces MUST be separated from the name of the key with a single ".". The namespace SHOULD be the name of the gem that exposes the key.
-
-Keys in this Hash MUST NOT be Symbols unless this specification or an official extension to this specification defines a Symbol key.
+In the case of methods with optional arguments, the Hash MUST be provided as the final argument. Keys in this Hash MUST be Symbols.
 
 # Key Equality
 

data/lib/juno.rb

@@ -17,6 +17,7 @@ module Juno
     autoload :Fog,             'juno/adapters/fog'
     autoload :GDBM,            'juno/adapters/gdbm'
     autoload :LocalMemCache,   'juno/adapters/localmemcache'
+    autoload :LRUHash,         'juno/adapters/lruhash'
     autoload :Memcached,       'juno/adapters/memcached'
     autoload :MemcachedDalli,  'juno/adapters/memcached_dalli'
     autoload :MemcachedNative, 'juno/adapters/memcached_native'
@@ -38,11 +39,10 @@ module Juno
     transformer = {:key => :marshal, :value => :marshal}
     raise 'Name must be Symbol' unless Symbol === name
     case name
-    when :Sequel, :ActiveRecord, :Couch, :Mongo
+    when :Sequel, :ActiveRecord, :Couch
       # Sequel accept only base64 keys and values
       # FIXME: ActiveRecord and Couch should work only with :marshal but this
       # raises an error on 1.9
-      # Mongo accepts only valid UTF-8 strings
       transformer = {:key => [:marshal, :base64], :value => [:marshal, :base64]}
     when :Memcached, :MemcachedDalli, :MemcachedNative
       # Memcached accept only base64 keys, expires already supported

data/lib/juno/adapters/lruhash.rb

@@ -0,0 +1,12 @@
+require 'hashery/lru_hash'
+
+module Juno
+  module Adapters
+    class LRUHash < Memory
+      def initialize(options = {})
+        raise 'No option :max_size specified' unless options[:max_size]
+        @memory = Hashery::LRUHash.new(options[:max_size])
+      end
+    end
+  end
+end

data/lib/juno/adapters/mongo.rb

@@ -18,7 +18,7 @@ module Juno
 
       def load(key, options = {})
         value = @collection.find_one('_id' => key)
-        value ? value['data'] : nil
+        value ? value['data'].to_s : nil
       end
 
       def delete(key, options = {})
@@ -29,8 +29,8 @@ module Juno
 
       def store(key, value, options = {})
         @collection.update({ '_id' => key },
-                      { '_id' => key, 'data' => value },
-                      { :upsert => true })
+                           { '_id' => key, 'data' => ::BSON::Binary.new(value) },
+                           { :upsert => true })
         value
       end
 

data/lib/juno/cache.rb

@@ -1,4 +1,14 @@
 module Juno
+  # Combines two stores. One is used as cache, the other as backend.
+  #
+  # Example:
+  #
+  #   Juno.build do
+  #     use(:Cache) do
+  #      backend { adapter :File, :dir => 'data' }
+  #      cache { adapter :Memory }
+  #     end
+  #   end
   class Cache < Base
     class DSL
       def initialize(options, &block)

data/lib/juno/expires.rb

@@ -1,4 +1,5 @@
 module Juno
+  # Adds expiration support to the underlying store
   class Expires < Proxy
     def key?(key, options = {})
       !!load(key, options)

data/lib/juno/proxy.rb

@@ -1,4 +1,5 @@
 module Juno
+  # Proxy base class
   class Proxy < Base
     attr_reader :adapter
 

data/lib/juno/stack.rb

@@ -1,4 +1,16 @@
 module Juno
+  # Combines multiple stores. Reads return the result from the first store,
+  # writes go to all stores.
+  #
+  # Example:
+  #
+  #   Juno.build do
+  #     use(:Stack) do
+  #       add { adapter :Redis }
+  #       add { adapter :File, :dir => 'data' }
+  #       add { adapter :File, :dir => 'replicate' }
+  #     end
+  #   end
   class Stack < Base
     class DSL
       attr_reader :stack

data/lib/juno/transformer.rb

@@ -1,4 +1,12 @@
 module Juno
+  # Transforms keys and values (Marshal, YAML, JSON, Base64, MD5, ...).
+  #
+  # Example:
+  #
+  #   Juno.build do
+  #     transformer :key => [:marshal, :escape], :value => [:marshal]
+  #     adapter :File, :dir => 'data'
+  #   end
   class Transformer < Proxy
     VALUE_TRANSFORMER = {
       :marshal => { :load => '::Marshal.load(VALUE)',          :dump => '::Marshal.dump(VALUE)' },

data/lib/juno/version.rb

@@ -1,3 +1,3 @@
 module Juno
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/adapter_lruhash_spec.rb

@@ -0,0 +1,42 @@
+# Generated file
+require 'helper'
+
+begin
+  Juno::Adapters::LRUHash.new(:max_size => 10).close
+
+  describe "adapter_lruhash" do
+    before do
+      @store = Juno::Adapters::LRUHash.new(:max_size => 10)
+      @store.clear
+    end
+
+    after do
+      @store.close.should == nil if @store
+    end
+
+    it_should_behave_like 'null_objectkey_objectvalue'
+    it_should_behave_like 'null_objectkey_stringvalue'
+    it_should_behave_like 'null_objectkey_hashvalue'
+    it_should_behave_like 'null_stringkey_objectvalue'
+    it_should_behave_like 'null_stringkey_stringvalue'
+    it_should_behave_like 'null_stringkey_hashvalue'
+    it_should_behave_like 'null_hashkey_objectvalue'
+    it_should_behave_like 'null_hashkey_stringvalue'
+    it_should_behave_like 'null_hashkey_hashvalue'
+    it_should_behave_like 'store_objectkey_objectvalue'
+    it_should_behave_like 'store_objectkey_stringvalue'
+    it_should_behave_like 'store_objectkey_hashvalue'
+    it_should_behave_like 'store_stringkey_objectvalue'
+    it_should_behave_like 'store_stringkey_stringvalue'
+    it_should_behave_like 'store_stringkey_hashvalue'
+    it_should_behave_like 'store_hashkey_objectvalue'
+    it_should_behave_like 'store_hashkey_stringvalue'
+    it_should_behave_like 'store_hashkey_hashvalue'
+
+  end
+rescue LoadError => ex
+  puts "Test adapter_lruhash not executed: #{ex.message}"
+rescue Exception => ex
+  puts "Test adapter_lruhash not executed: #{ex.message}"
+  #puts "#{ex.backtrace.join("\n")}"
+end

data/spec/generate.rb

@@ -11,6 +11,15 @@ TESTS = {
     :options => ':expires => true',
     :specs => EXPIRES_SPECS,
   },
+  'simple_lruhash' => {
+    :store => :LRUHash,
+    :options => ':max_size => 10',
+  },
+  'simple_lruhash_with_expires' => {
+    :store => :LRUHash,
+    :options => ':expires => true, :max_size => 10',
+    :specs => EXPIRES_SPECS,
+  },
   'simple_file' => {
     :store => :File,
     :options => ':dir => File.join(make_tempdir, "simple_file")'
@@ -510,6 +519,10 @@ end
     :build => 'Juno::Adapters::Memory.new',
     :specs => [:null, :store]
   },
+  'adapter_lruhash' => {
+    :build => 'Juno::Adapters::LRUHash.new(:max_size => 10)',
+    :specs => [:null, :store]
+  },
   'adapter_mongo' => {
     :build => 'Juno::Adapters::Mongo.new(:db => "adapter_mongo")',
     :specs => ADAPTER_SPECS

data/spec/simple_lruhash_spec.rb

@@ -0,0 +1,52 @@
+# Generated file
+require 'helper'
+
+begin
+  Juno.new(:LRUHash, :max_size => 10).close
+
+  describe "simple_lruhash" do
+    before do
+      @store = Juno.new(:LRUHash, :max_size => 10)
+      @store.clear
+    end
+
+    after do
+      @store.close.should == nil if @store
+    end
+
+    it_should_behave_like 'null_objectkey_objectvalue'
+    it_should_behave_like 'null_objectkey_stringvalue'
+    it_should_behave_like 'null_objectkey_hashvalue'
+    it_should_behave_like 'null_stringkey_objectvalue'
+    it_should_behave_like 'null_stringkey_stringvalue'
+    it_should_behave_like 'null_stringkey_hashvalue'
+    it_should_behave_like 'null_hashkey_objectvalue'
+    it_should_behave_like 'null_hashkey_stringvalue'
+    it_should_behave_like 'null_hashkey_hashvalue'
+    it_should_behave_like 'store_objectkey_objectvalue'
+    it_should_behave_like 'store_objectkey_stringvalue'
+    it_should_behave_like 'store_objectkey_hashvalue'
+    it_should_behave_like 'store_stringkey_objectvalue'
+    it_should_behave_like 'store_stringkey_stringvalue'
+    it_should_behave_like 'store_stringkey_hashvalue'
+    it_should_behave_like 'store_hashkey_objectvalue'
+    it_should_behave_like 'store_hashkey_stringvalue'
+    it_should_behave_like 'store_hashkey_hashvalue'
+    it_should_behave_like 'returndifferent_objectkey_objectvalue'
+    it_should_behave_like 'returndifferent_objectkey_stringvalue'
+    it_should_behave_like 'returndifferent_objectkey_hashvalue'
+    it_should_behave_like 'returndifferent_stringkey_objectvalue'
+    it_should_behave_like 'returndifferent_stringkey_stringvalue'
+    it_should_behave_like 'returndifferent_stringkey_hashvalue'
+    it_should_behave_like 'returndifferent_hashkey_objectvalue'
+    it_should_behave_like 'returndifferent_hashkey_stringvalue'
+    it_should_behave_like 'returndifferent_hashkey_hashvalue'
+    it_should_behave_like 'marshallable_key'
+
+  end
+rescue LoadError => ex
+  puts "Test simple_lruhash not executed: #{ex.message}"
+rescue Exception => ex
+  puts "Test simple_lruhash not executed: #{ex.message}"
+  #puts "#{ex.backtrace.join("\n")}"
+end

data/spec/simple_lruhash_with_expires_spec.rb

@@ -0,0 +1,53 @@
+# Generated file
+require 'helper'
+
+begin
+  Juno.new(:LRUHash, :expires => true, :max_size => 10).close
+
+  describe "simple_lruhash_with_expires" do
+    before do
+      @store = Juno.new(:LRUHash, :expires => true, :max_size => 10)
+      @store.clear
+    end
+
+    after do
+      @store.close.should == nil if @store
+    end
+
+    it_should_behave_like 'null_objectkey_objectvalue'
+    it_should_behave_like 'null_objectkey_stringvalue'
+    it_should_behave_like 'null_objectkey_hashvalue'
+    it_should_behave_like 'null_stringkey_objectvalue'
+    it_should_behave_like 'null_stringkey_stringvalue'
+    it_should_behave_like 'null_stringkey_hashvalue'
+    it_should_behave_like 'null_hashkey_objectvalue'
+    it_should_behave_like 'null_hashkey_stringvalue'
+    it_should_behave_like 'null_hashkey_hashvalue'
+    it_should_behave_like 'store_objectkey_objectvalue'
+    it_should_behave_like 'store_objectkey_stringvalue'
+    it_should_behave_like 'store_objectkey_hashvalue'
+    it_should_behave_like 'store_stringkey_objectvalue'
+    it_should_behave_like 'store_stringkey_stringvalue'
+    it_should_behave_like 'store_stringkey_hashvalue'
+    it_should_behave_like 'store_hashkey_objectvalue'
+    it_should_behave_like 'store_hashkey_stringvalue'
+    it_should_behave_like 'store_hashkey_hashvalue'
+    it_should_behave_like 'returndifferent_objectkey_objectvalue'
+    it_should_behave_like 'returndifferent_objectkey_stringvalue'
+    it_should_behave_like 'returndifferent_objectkey_hashvalue'
+    it_should_behave_like 'returndifferent_stringkey_objectvalue'
+    it_should_behave_like 'returndifferent_stringkey_stringvalue'
+    it_should_behave_like 'returndifferent_stringkey_hashvalue'
+    it_should_behave_like 'returndifferent_hashkey_objectvalue'
+    it_should_behave_like 'returndifferent_hashkey_stringvalue'
+    it_should_behave_like 'returndifferent_hashkey_hashvalue'
+    it_should_behave_like 'marshallable_key'
+    it_should_behave_like 'expires_stringkey_stringvalue'
+
+  end
+rescue LoadError => ex
+  puts "Test simple_lruhash_with_expires not executed: #{ex.message}"
+rescue Exception => ex
+  puts "Test simple_lruhash_with_expires not executed: #{ex.message}"
+  #puts "#{ex.backtrace.join("\n")}"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: juno
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-24 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies: []
 description: A unified interface to key/value stores (moneta replacement)
 email:
@@ -44,6 +44,7 @@ files:
 - lib/juno/adapters/fog.rb
 - lib/juno/adapters/gdbm.rb
 - lib/juno/adapters/localmemcache.rb
+- lib/juno/adapters/lruhash.rb
 - lib/juno/adapters/memcached.rb
 - lib/juno/adapters/memcached_dalli.rb
 - lib/juno/adapters/memcached_native.rb
@@ -75,6 +76,7 @@ files:
 - spec/adapter_fog_spec.rb
 - spec/adapter_gdbm_spec.rb
 - spec/adapter_localmemcache_spec.rb
+- spec/adapter_lruhash_spec.rb
 - spec/adapter_memcached_dalli_spec.rb
 - spec/adapter_memcached_native_spec.rb
 - spec/adapter_memcached_spec.rb
@@ -119,6 +121,8 @@ files:
 - spec/simple_hashfile_with_expires_spec.rb
 - spec/simple_localmemcache_spec.rb
 - spec/simple_localmemcache_with_expires_spec.rb
+- spec/simple_lruhash_spec.rb
+- spec/simple_lruhash_with_expires_spec.rb
 - spec/simple_memcached_dalli_spec.rb
 - spec/simple_memcached_native_spec.rb
 - spec/simple_memcached_spec.rb
@@ -187,6 +191,7 @@ test_files:
 - spec/adapter_fog_spec.rb
 - spec/adapter_gdbm_spec.rb
 - spec/adapter_localmemcache_spec.rb
+- spec/adapter_lruhash_spec.rb
 - spec/adapter_memcached_dalli_spec.rb
 - spec/adapter_memcached_native_spec.rb
 - spec/adapter_memcached_spec.rb
@@ -231,6 +236,8 @@ test_files:
 - spec/simple_hashfile_with_expires_spec.rb
 - spec/simple_localmemcache_spec.rb
 - spec/simple_localmemcache_with_expires_spec.rb
+- spec/simple_lruhash_spec.rb
+- spec/simple_lruhash_with_expires_spec.rb
 - spec/simple_memcached_dalli_spec.rb
 - spec/simple_memcached_native_spec.rb
 - spec/simple_memcached_spec.rb