juno 0.2.3 → 0.2.4

data/.travis.yml

@@ -10,12 +10,10 @@ services:
   - couchdb
   - redis-server
 #  - cassandra
-#  - memcached
-#  - mongodb
+  - memcached
+  - mongodb
 before_install:
   - sudo apt-get install -qq libtokyocabinet8 libtokyocabinet-dev # tokyotyrant
-  - sudo /bin/bash /etc/init.d/mongodb start
-  - memcached -d -p 22122
 env:
   - "TASK=test:parallel"
   - "TASK=test:non_parallel"

data/Gemfile

@@ -17,7 +17,7 @@ gem 'dm-core'
 gem 'dm-migrations'
 gem 'dm-sqlite-adapter'
 gem 'fog'
-gem 'activerecord'
+gem 'activerecord', '>= 3.2.9'
 gem 'redis'
 gem 'mongo'
 gem 'couchrest'
@@ -35,6 +35,8 @@ else
   gem 'tokyocabinet'
   gem 'memcached'
   gem 'sqlite3'
+  gem 'ox'
+  gem 'bson_ext'
 end
 
 #gem 'cassandra'

data/README.md

@@ -7,7 +7,18 @@ Juno provides a standard interface for interacting with various kinds of key/val
 is based on Moneta and replaces it with a mostly compatible interface. The reason for the
 fork was that Moneta was unmaintained for a long time.
 
-Out of the box, it supports:
+Juno is very feature rich:
+
+* Supports for a lot of backends (See below)
+* Supports proxies (Similar to [Rack middlewares](http://rack.rubyforge.org/))
+* Custom serialization via `Juno::Transformer` proxy (Marshal/JSON/YAML and many more)
+* Custom key transformation via `Juno::Transformer` proxy
+* Expiration for all stores (Added via proxy if not supported natively)
+
+Supported backends
+------------------
+
+Out of the box, it supports the following backends:
 
 * Memory:
     * In-memory store (:Memory)
@@ -39,14 +50,27 @@ Out of the box, it supports:
     * Fog cloud storage which supports Amazon S3, Rackspace, etc. (:Fog)
     * Storage which doesn't store anything (:Null)
 
+Supported serializers:
+
+* Marshal
+* YAML
+* JSON (via multi_json)
+* MessagePack
+* BSON
+* Ox
+
+Proxies
+-------
+
 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)
+* `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)
+* `Juno::Lock` to make store thread safe
 
 The Juno API is purposely extremely similar to the Hash API. In order so support an
 identical API across stores, it does not support iteration or partial matches.
@@ -60,8 +84,8 @@ Links
     * Latest Gem: <http://rubydoc.info/gems/juno/frames>
     * GitHub master: <http://rubydoc.info/github/minad/juno/master/frames>
 
-Store API
----------
+Juno API
+--------
 
 ~~~
 #initialize(options)              options differs per-store, and is used to set up the store
@@ -144,6 +168,14 @@ cache = Juno.build do
 end
 ~~~
 
+Alternatives
+------------
+
+* [Moneta](https://github.com/wycats/moneta): Juno is based on Moneta, but Juno supports more features and more backends and is actively developed
+* [Horcrux](https://github.com/technoweenie/horcrux): Used at github, supports batch operations but only Memcached backend
+* [ToyStore](https://github.com/jnunemaker/toystore): ORM mapper for key/value stores
+* [ToyStore Adapter](https://github.com/jnunemaker/adapter): Adapter to key/value stores used by ToyStore, Juno can be used directly with the ToyStore Memory adapter
+
 Authors
 -------
 

data/benchmarks/run.rb

@@ -1,9 +1,14 @@
 #!/usr/bin/env ruby
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'benchmark'
 require 'juno'
-require 'dm-core'
 
-DataMapper.setup(:default, :adapter => :in_memory)
+begin
+  require 'dm-core'
+  DataMapper.setup(:default, :adapter => :in_memory)
+rescue LoadError
+end
 
 # Hacked arrays
 # Array modifications
@@ -37,7 +42,7 @@ stores = {
   :Redis => { },
   :MemcachedDalli => { :server => "localhost:11211", :namespace => 'juno_dalli' },
   :MemcachedNative => { :server => "localhost:11211", :namespace => 'juno_native' },
-  #:MongoDB => { :host => 'localhost', :port => 27017, :db => 'juno_bench' },
+  :Mongo => { :host => 'localhost', :port => 27017, :db => 'juno_bench' },
   :LocalMemCache => { :file => "bench.lmc" },
   :DBM => { :file => "bench.dbm" },
   :SDBM => { :file => "bench.sdbm" },
@@ -51,7 +56,7 @@ stores = {
   :DataMapper => { :setup => "sqlite3::memory:" },
   :ActiveRecord => { :connection => { :adapter  => 'sqlite3', :database => ':memory:' } },
   :Sequel => { :db => "sqlite:/" },
-  # :Couch => {:db => "couch_test"},
+  :Couch => {:db => "couch_test"},
 }
 
 stats, keys, data, errors, summary = {}, [], HackedArray.new, HackedArray.new, HackedArray.new
@@ -93,10 +98,17 @@ puts "Lenght Stats   % 10i % 10i % 10i % 10i " % [vlen_min, vlen_max, vlen_ttl,
 
 
 stores.each do |name, options|
+  begin
+    @cache = Juno.new(name, options)
+    @cache['test'] = 'test'
+    @cache.clear
+  rescue Exception => ex
+    puts "#{name} not benchmarked - #{ex.message}"
+    next
+  end
   puts "======================================================================"
   puts name
   puts "----------------------------------------------------------------------"
-  @cache = Juno.new(name, options)
   stats[name] = {
     :writes => [],
     :reads => [],

data/lib/juno/adapters/activerecord.rb

@@ -2,6 +2,8 @@ require 'active_record'
 
 module Juno
   module Adapters
+    # ActiveRecord as key/value stores
+    # @api public
     class ActiveRecord < Base
       def self.tables
         @tables ||= {}
@@ -9,18 +11,28 @@ module Juno
 
       attr_reader :table
 
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :table - Table name (default juno)
+      # * :connection - ActiveRecord connection
       def initialize(options = {})
         table = options[:table] || 'juno'
-        @table = self.class.tables[table] ||= begin
-                                                c = Class.new(::ActiveRecord::Base)
-                                                c.table_name = table
-                                                c
-                                              end
+        @table = self.class.tables[table] ||=
+          begin
+            c = Class.new(::ActiveRecord::Base)
+            c.table_name = table
+            c.primary_key = :k
+            c
+          end
         @table.establish_connection(options[:connection]) if options[:connection]
         unless @table.table_exists?
-          @table.connection.create_table(@table.table_name) do |t|
-            t.binary :k, :null => false
-            t.binary :v
+          @table.connection.create_table(@table.table_name, :id => false) do |t|
+            # Do not use binary columns (Issue #17)
+            t.string :k, :null => false
+            t.string :v
           end
           @table.connection.add_index(@table.table_name, :k, :unique => true)
         end
@@ -39,19 +51,16 @@ module Juno
         @table.transaction do
           record = @table.find_by_k(key)
           if record
-            value = record.v
             record.destroy
-            value
+            record.v
           end
         end
       end
 
       def store(key, value, options = {})
         @table.transaction do
-          record = @table.find_by_k(key)
-          record ||= @table.new(:k => key)
-          record.v = value
-          record.save!
+          record = @table.find_or_initialize_by_k(key)
+          record.update_attributes(:v => value)
           value
         end
       end

data/lib/juno/adapters/cassandra.rb

@@ -5,7 +5,18 @@ require 'cassandra'
 
 module Juno
   module Adapters
+    # Cassandra backend
+    # @api public
     class Cassandra < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :keyspace - Cassandra keyspace (default Juno)
+      # * :column_family - Cassandra column family (default :Juno)
+      # * :host - Server host name (default 127.0.0.1)
+      # * :port - Server port (default 9160)
       def initialize(options = {})
         options[:keyspace] ||= 'Juno'
         options[:host]     ||= '127.0.0.1'

data/lib/juno/adapters/couch.rb

@@ -2,8 +2,17 @@ require 'couchrest'
 
 module Juno
   module Adapters
+    # CouchDB backend
+    # @api public
     class Couch < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :db - Couch database
       def initialize(options = {})
+        raise 'No option :db specified' unless options[:db]
         @db = ::CouchRest.database!(options[:db])
       end
 

data/lib/juno/adapters/datamapper.rb

@@ -3,6 +3,8 @@ require 'dm-migrations'
 
 module Juno
   module Adapters
+    # Datamapper backend
+    # @api public
     class DataMapper < Base
       class Store
         include ::DataMapper::Resource
@@ -10,6 +12,14 @@ module Juno
         property :v, Object, :lazy => false
       end
 
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :setup - Datamapper setup string
+      # * :repository - Repository name (default :juno)
+      # * :table - Table name (default :juno)
       def initialize(options = {})
         raise 'No option :setup specified' unless options[:setup]
         @repository = options.delete(:repository) || :juno

data/lib/juno/adapters/dbm.rb

@@ -2,7 +2,15 @@ require 'dbm'
 
 module Juno
   module Adapters
+    # DBM backend (Berkeley DB)
+    # @api public
     class DBM < Memory
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :file - Database file
       def initialize(options = {})
         raise 'No option :file specified' unless options[:file]
         @memory = ::DBM.new(options[:file])

data/lib/juno/adapters/file.rb

@@ -2,6 +2,8 @@ require 'fileutils'
 
 module Juno
   module Adapters
+    # Filesystem backend
+    # @api public
     class File < Base
       def initialize(options = {})
         raise 'No option :dir specified' unless @dir = options[:dir]

data/lib/juno/adapters/fog.rb

@@ -2,7 +2,16 @@ require 'fog'
 
 module Juno
   module Adapters
+    # Fog backend (Cloud storage services)
+    # @api public
     class Fog < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :dir - Fog directory
+      # * Other options passed to Fog::Storage#new
       def initialize(options = {})
         raise 'No option :dir specified' unless dir = options.delete(:dir)
         storage = ::Fog::Storage.new(options)

data/lib/juno/adapters/gdbm.rb

@@ -2,7 +2,15 @@ require 'gdbm'
 
 module Juno
   module Adapters
+    # GDBM backend
+    # @api public
     class GDBM < Memory
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :file - Database file
       def initialize(options = {})
         raise 'No option :file specified' unless options[:file]
         @memory = ::GDBM.new(options[:file])

data/lib/juno/adapters/localmemcache.rb

@@ -2,7 +2,15 @@ require 'localmemcache'
 
 module Juno
   module Adapters
+    # LocalMemCache backend
+    # @api public
     class LocalMemCache < Memory
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :file - Database file
       def initialize(options = {})
         raise 'No option :file specified' unless options[:file]
         @memory = ::LocalMemCache.new(:filename => options[:file])

data/lib/juno/adapters/lruhash.rb

@@ -2,7 +2,15 @@ require 'hashery/lru_hash'
 
 module Juno
   module Adapters
+    # LRUHash backend
+    # @api public
     class LRUHash < Memory
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :max_size - Maximum size of hash (default 1024)
       def initialize(options = {})
         @memory = Hashery::LRUHash.new(options[:max_size] || 1024)
       end

data/lib/juno/adapters/memcached_dalli.rb

@@ -2,7 +2,16 @@ require 'dalli'
 
 module Juno
   module Adapters
+    # Memcached backend (using gem dalli)
+    # @api public
     class MemcachedDalli < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :server - Memcached server (default localhost:11211)
+      # * Other options passed to Dalli::Client#new
       def initialize(options = {})
         server = options.delete(:server) || 'localhost:11211'
         @cache = ::Dalli::Client.new(server, options)

data/lib/juno/adapters/memcached_native.rb

@@ -2,7 +2,17 @@ require 'memcached'
 
 module Juno
   module Adapters
+    # Memcached backend (using gem memcached)
+    # @api public
     class MemcachedNative < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :server - Memcached server (default localhost:11211)
+      # * :namespace - Key namespace
+      # * Other options passed to Memcached#new
       def initialize(options = {})
         server = options.delete(:server) || 'localhost:11211'
         options.merge!(:prefix_key => options.delete(:namespace)) if options[:namespace]

data/lib/juno/adapters/memory.rb

@@ -1,5 +1,7 @@
 module Juno
   module Adapters
+    # Memory backend using a hash to store the entries
+    # @api public
     class Memory < Base
       def initialize(options = {})
         @memory = {}

data/lib/juno/adapters/mongo.rb

@@ -2,7 +2,18 @@ require 'mongo'
 
 module Juno
   module Adapters
+    # MongoDB backend
+    # @api public
     class Mongo < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :collection - MongoDB collection name (default juno)
+      # * :host - MongoDB server host (default localhost)
+      # * :port - MongoDB server port (default mongodb default port)
+      # * :db - MongoDB database (default juno)
       def initialize(options = {})
         collection = options.delete(:collection) || 'juno'
         host = options.delete(:host) || 'localhost'

data/lib/juno/adapters/null.rb

@@ -1,5 +1,7 @@
 module Juno
   module Adapters
+    # Null backend which doesn't store anything
+    # @api public
     class Null < Base
       def initialize(options = {})
       end

data/lib/juno/adapters/pstore.rb

@@ -2,7 +2,15 @@ require 'pstore'
 
 module Juno
   module Adapters
+    # PStore backend
+    # @api public
     class PStore < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :file - PStore file
       def initialize(options = {})
         raise 'No option :file specified' unless options[:file]
         FileUtils.mkpath(::File.dirname(options[:file]))
@@ -38,8 +46,7 @@ module Juno
 
       if RUBY_VERSION > '1.9'
         def new_store(options)
-          # Create a thread-safe pstore by default
-          ::PStore.new(options[:file], options.include?(:thread_safe) ? options[:thread_safe] : true)
+          ::PStore.new(options[:file], options[:threadsafe])
         end
       else
         def new_store(options)

data/lib/juno/adapters/redis.rb

@@ -2,7 +2,12 @@ require 'redis'
 
 module Juno
   module Adapters
+    # Redis backend
+    # @api public
     class Redis < Base
+      # Constructor
+      #
+      # @param [Hash] options passed to Redis#new
       def initialize(options = {})
         @redis = ::Redis.new(options)
       end

data/lib/juno/adapters/riak.rb

@@ -5,7 +5,16 @@ require 'riak'
 
 module Juno
   module Adapters
+    # Riak backend
+    # @api public
     class Riak < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :bucket - Bucket name (default juno)
+      # * All other options passed to Riak::Client#new
       def initialize(options = {})
         bucket = options.delete(:bucket) || 'juno'
         @bucket = ::Riak::Client.new(options).bucket(bucket)

data/lib/juno/adapters/sdbm.rb

@@ -2,7 +2,15 @@ require 'sdbm'
 
 module Juno
   module Adapters
+    # SDBM backend
+    # @api public
     class SDBM < Memory
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :file - Database file
       def initialize(options = {})
         raise 'No option :file specified' unless options[:file]
         @memory = ::SDBM.new(options[:file])

data/lib/juno/adapters/sequel.rb

@@ -2,7 +2,17 @@ require 'sequel'
 
 module Juno
   module Adapters
+    # Sequel backend
+    # @api public
     class Sequel < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :db - Sequel database
+      # * :table - Table name (default :juno)
+      # * All other options passed to Sequel#connect
       def initialize(options = {})
         raise 'No option :db specified' unless db = options.delete(:db)
         @table = options.delete(:table) || :juno

data/lib/juno/adapters/sqlite.rb

@@ -2,7 +2,16 @@ require 'sqlite3'
 
 module Juno
   module Adapters
+    # Sqlite3 backend
+    # @api public
     class Sqlite < Base
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :file - Database file
+      # * :table - Table name (default juno)
       def initialize(options = {})
         raise 'No option :file specified' unless options[:file]
         table = options[:table] || 'juno'

data/lib/juno/adapters/tokyocabinet.rb

@@ -2,14 +2,26 @@ require 'tokyocabinet'
 
 module Juno
   module Adapters
+    # TokyoCabinet backend
+    # @api public
     class TokyoCabinet < Memory
+      # Constructor
+      #
+      # @param [Hash] options
+      #
+      # Options:
+      # * :file - Database file
+      # * :type - Database type (default :hdb, :bdb and :hdb possible)
       def initialize(options = {})
         file = options[:file]
         raise 'No option :file specified' unless options[:file]
-        @memory = ::TokyoCabinet::HDB.new
-        unless @memory.open(file, ::TokyoCabinet::HDB::OWRITER | ::TokyoCabinet::HDB::OCREAT)
-          raise @memory.errmsg(@memory.ecode)
-        end
+        if options[:type] == :bdb
+          @memory = ::TokyoCabinet::BDB.new
+          @memory.open(file, ::TokyoCabinet::BDB::OWRITER | ::TokyoCabinet::BDB::OCREAT)
+        else
+          @memory = ::TokyoCabinet::HDB.new
+          @memory.open(file, ::TokyoCabinet::HDB::OWRITER | ::TokyoCabinet::HDB::OCREAT)
+        end or raise @memory.errmsg(@memory.ecode)
       end
 
       def key?(key, options = {})

data/lib/juno/adapters/yaml.rb

@@ -2,6 +2,8 @@ require 'yaml/store'
 
 module Juno
   module Adapters
+    # YAML::Store backend
+    # @api public
     class YAML < Juno::Adapters::PStore
       protected
 

data/lib/juno/base.rb

@@ -1,5 +1,6 @@
 module Juno
   # Simple interface to key/value stores with Hash-like interface.
+  # @api public
   class Base
     # Explicitly close the store
     # @api public

data/lib/juno/builder.rb

@@ -1,4 +1,6 @@
 module Juno
+  # Builder implements the DSL to build a chain of store proxies
+  # @api private
   class Builder
     def build
       klass, options, block = @proxies.first

data/lib/juno/cache.rb

@@ -9,6 +9,8 @@ module Juno
   #      cache { adapter :Memory }
   #     end
   #   end
+  #
+  # @api public
   class Cache < Base
     class DSL
       def initialize(options, &block)

data/lib/juno/expires.rb

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