moneta 0.7.0 → 0.7.1

data/lib/active_support/cache/moneta_store.rb

@@ -1,5 +1,6 @@
 module ActiveSupport
   module Cache
+    # @api public
     class MonetaStore < Store
       def initialize(options = nil)
         raise ArgumentError, 'Option :store is required' unless @store = options.delete(:store)

data/lib/moneta.rb

@@ -31,8 +31,8 @@ module Moneta
     autoload :LocalMemCache,   'moneta/adapters/localmemcache'
     autoload :LRUHash,         'moneta/adapters/lruhash'
     autoload :Memcached,       'moneta/adapters/memcached'
-    autoload :MemcachedDalli,  'moneta/adapters/memcached_dalli'
-    autoload :MemcachedNative, 'moneta/adapters/memcached_native'
+    autoload :MemcachedDalli,  'moneta/adapters/memcached/dalli'
+    autoload :MemcachedNative, 'moneta/adapters/memcached/native'
     autoload :Memory,          'moneta/adapters/memory'
     autoload :Mongo,           'moneta/adapters/mongo'
     autoload :Null,            'moneta/adapters/null'
@@ -47,30 +47,33 @@ module Moneta
   end
 
   # Create new Moneta store with default proxies
-  # which works in most cases if you don't want fine
-  # control over the proxy chain. It uses Marshal on the
+  #
+  # This works in most cases if you don't want fine
+  # control over the proxy stack. It uses Marshal on the
   # keys and values. Use Moneta#build if you want to have fine control!
   #
   # @param [Symbol] name Name of adapter (See Moneta::Adapters)
   # @param [Hash] options
-  #
-  # Options:
-  # * :expires - If true or integer, ensure that store supports expiration by inserting
-  #   Moneta::Expires if the underlying adapter doesn't support it natively
-  # * :threadsafe - If true, ensure that the store is thread safe by inserting Moneta::Lock
-  # * :logger - If true or Hash, add logger to chain (Hash is passed to logger as options)
-  # * :compress - If true, compress value with zlib, or specify custom compress, e.g. :quicklz
-  # * :serializer - Serializer used for key and value, disable with nil (default :marshal)
-  # * :key_serializer - Serializer used for key, disable with nil (default options[:serializer] if not provided)
-  # * :value_serializer - Serializer used for key, disable with nil (default options[:serializer] if not provided)
-  # * :prefix - Key prefix used for namespacing (default none)
-  # * All other options passed to the adapter
+  # @return [Moneta store] newly created Moneta store
+  # @option options [Boolean/Integer] :expires Ensure that store supports expiration by inserting
+  #                                            `Moneta::Expires` if the underlying adapter doesn't support it natively
+  #                                            and set default expiration time
+  # @option options [Boolean] :threadsafe (false) Ensure that the store is thread safe by inserting Moneta::Lock
+  # @option options [Boolean/Hash] :logger (false) Add logger to proxy stack (Hash is passed to logger as options)
+  # @option options [Boolean/Symbol] :compress (false) If true, compress value with zlib, or specify custom compress, e.g. :quicklz
+  # @option options [Symbol] :serializer (:marshal) Serializer used for key and value, disable with nil
+  # @option options [Symbol] :key_serializer (options[:serializer]) Serializer used for key, disable with nil
+  # @option options [Symbol] :value_serializer (options[:serializer]) Serializer used for value, disable with nil
+  # @option options [String] :prefix Key prefix used for namespacing (default none)
+  # @option options All other options passed to the adapter
   #
   # Supported adapters:
   # * :HashFile (Store which spreads the entries using a md5 hash, e.g. cache/42/391dd7535aebef91b823286ac67fcd)
   # * :File (normal file store)
   # * :Memcached (Memcached store)
   # * ... (All other adapters from Moneta::Adapters)
+  #
+  # @api public
   def self.new(name, options = {})
     expires = options.delete(:expires)
     logger = options.delete(:logger)
@@ -88,11 +91,14 @@ module Moneta
       # FIXME: Couch should work only with :marshal but this raises an error on 1.9
       transformer[:key] << :base64
       transformer[:value] << :base64
+    when :Riak
+      # Riak accepts only utf-8 keys over the http interface
+      # We use base64 encoding therefore.
+      transformer[:key] << :base64
     when :Memcached, :MemcachedDalli, :MemcachedNative
-      # Memcached accept only base64 keys, expires already supported
+      # Memcached supports expires already
       options[:expires] = expires if Integer === expires
       expires = false
-      transformer[:key] << :base64
     when :PStore, :YAML, :Null
       # For PStore and YAML only the key has to be a string
       transformer.delete(:value) if transformer[:value] == [:marshal]
@@ -117,13 +123,17 @@ module Moneta
     end
   end
 
-  # Build your own store chain!
+  # Configure your own Moneta proxy stack!
+  #
+  # @return [Moneta store] newly created Moneta store
   #
   # @example Moneta builder
   #   Moneta.build do
   #     use :Expires
   #     adapter :Memory
   #   end
+  #
+  # @api public
   def self.build(&block)
     Builder.new(&block).build.last
   end

data/lib/moneta/adapters/activerecord.rb

@@ -14,10 +14,8 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :table - Table name (default moneta)
-      # * :connection - ActiveRecord connection
+      # @option options [String] :table ('moneta') Table name
+      # @option options [Hash]   :connection ActiveRecord connection configuration
       def initialize(options = {})
         table = options[:table] || 'moneta'
         @table = self.class.tables[table] ||=
@@ -43,39 +41,33 @@ module Moneta
       end
 
       def load(key, options = {})
-        record = @table.where(:k => key).first
+        record = @table.select(:v).where(:k => key).first
         record && record.v
       end
 
       def store(key, value, options = {})
-        @table.transaction do
-          record = @table.where(:k => key).first_or_initialize
-          record.update_attributes(:v => value)
-          value
-        end
+        record = @table.select(:k).where(:k => key).first_or_initialize
+        record.v = value
+        record.save
+        value
       end
 
       def delete(key, options = {})
-        @table.transaction do
-          if record = @table.where(:k => key).first
-            record.destroy
-            record.v
-          end
+        if record = @table.where(:k => key).first
+          record.destroy
+          record.v
         end
       end
 
       def increment(key, amount = 1, options = {})
-        @table.transaction do
-          record = @table.where(:k => key).first_or_initialize
-          record.lock!
-          value = record.v
-          intvalue = value.to_i
-          raise 'Tried to increment non integer value' unless value == nil || intvalue.to_s == value.to_s
-          intvalue += amount
-          record.v = intvalue.to_s
-          record.save!
-          intvalue
-        end
+        record = @table.where(:k => key).lock.first_or_initialize
+        value = record.v
+        intvalue = value.to_i
+        raise 'Tried to increment non integer value' unless value == nil || intvalue.to_s == value.to_s
+        intvalue += amount
+        record.v = intvalue.to_s
+        record.save
+        intvalue
       end
 
       def clear(options = {})

data/lib/moneta/adapters/cassandra.rb

@@ -11,13 +11,11 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :keyspace - Cassandra keyspace (default 'moneta')
-      # * :column_family - Cassandra column family (default 'moneta')
-      # * :host - Server host name (default 127.0.0.1)
-      # * :port - Server port (default 9160)
-      # * :expires - Default expiration time (default none)
+      # @option options [String] :keyspace ('moneta') Cassandra keyspace
+      # @option options [String] :column_family ('moneta') Cassandra column family
+      # @option options [String] :host ('127.0.0.1') Server host name
+      # @option options [Integer] :port (9160) Server port
+      # @option options [String] :expires Default expiration time
       def initialize(options = {})
         options[:host] ||= '127.0.0.1'
         options[:port] ||=  9160

data/lib/moneta/adapters/client.rb

@@ -10,11 +10,9 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :port - TCP port (default 9000)
-      # * :host - Hostname (default empty)
-      # * :file - Unix socket file name (default none)
+      # @option options [Integer] :port (9000) TCP port
+      # @option options [String] :host ('127.0.0.1') Hostname
+      # @option options [String] :file Unix socket file name as alternative to `:port` and `:host`
       def initialize(options = {})
         @socket = options[:file] ? UNIXSocket.open(options[:file]) :
           TCPSocket.open(options[:host] || '127.0.0.1', options[:port] || DEFAULT_PORT)

data/lib/moneta/adapters/cookie.rb

@@ -1,5 +1,7 @@
 module Moneta
   module Adapters
+    # Cookie backend used by `Rack::MonetaCookies`
+    # @api public
     class Cookie < Memory
       attr_reader :cookies
 

data/lib/moneta/adapters/couch.rb

@@ -8,9 +8,7 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :db - Couch database (default moneta)
+      # @option options [String] :db ('moneta') Couch database
       def initialize(options = {})
         options[:db] ||= 'moneta'
         @db = ::CouchRest.database!(options[:db])

data/lib/moneta/adapters/datamapper.rb

@@ -15,14 +15,12 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :setup - Datamapper setup string
-      # * :repository - Repository name (default :moneta)
-      # * :table - Table name (default :moneta)
+      # @option options [String] :setup Datamapper setup string
+      # @option options [String/Symbol] :repository (:moneta) Repository name
+      # @option options [String/Symbol] :table (:moneta) Table name
       def initialize(options = {})
         raise ArgumentError, 'Option :setup is required' unless options[:setup]
-        @repository = options.delete(:repository) || :moneta
+        @repository = (options.delete(:repository) || :moneta).to_sym
         Store.storage_names[@repository] = (options.delete(:table) || :moneta).to_s
         ::DataMapper.setup(@repository, options[:setup])
         context { Store.auto_upgrade! }

data/lib/moneta/adapters/dbm.rb

@@ -8,9 +8,7 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :file - Database file
+      # @option options [String] :file Database file
       def initialize(options = {})
         raise ArgumentError, 'Option :file is required' unless options[:file]
         @hash = ::DBM.new(options[:file])

data/lib/moneta/adapters/file.rb

@@ -7,6 +7,10 @@ module Moneta
     class File < Base
       include Mixins::IncrementSupport
 
+      # Constructor
+      #
+      # @param [Hash] options
+      # @option options [String] :dir Directory where files will be stored
       def initialize(options = {})
         raise ArgumentError, 'Option :dir is required' unless @dir = options[:dir]
         FileUtils.mkpath(@dir)

data/lib/moneta/adapters/fog.rb

@@ -8,10 +8,8 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :dir - Fog directory
-      # * Other options passed to Fog::Storage#new
+      # @option options [String] :dir Fog directory
+      # @option options Other options passed to `Fog::Storage#new`
       def initialize(options = {})
         raise ArgumentError, 'Option :dir is required' unless dir = options.delete(:dir)
         storage = ::Fog::Storage.new(options)

data/lib/moneta/adapters/gdbm.rb

@@ -8,9 +8,7 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :file - Database file
+      # @option options [String] :file Database file
       def initialize(options = {})
         raise ArgumentError, 'Option :file is required' unless options[:file]
         @hash = ::GDBM.new(options[:file])

data/lib/moneta/adapters/hbase.rb

@@ -8,13 +8,11 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :host - Server host name (default 127.0.0.1)
-      # * :port - Server port (default 9090)
-      # * :table - Table name (default moneta)
-      # * :column_family - Column family (default moneta)
-      # * :column - Column (default value)
+      # @option options [String] :host ('127.0.0.1') Server host name
+      # @option options [Integer] :port (9090) Server port
+      # @option options [String] :table ('moneta') Table name
+      # @option options [String] :column_family ('moneta') Column family
+      # @option options [String] :column ('value') Column
       def initialize(options = {})
         options[:host] ||= '127.0.0.1'
         options[:port] ||= '9090'

data/lib/moneta/adapters/leveldb.rb

@@ -8,10 +8,8 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :dir - Database path
-      # * All other options passed to LevelDB::DB#new
+      # @option options [String] :dir - Database path
+      # @option options All other options passed to `LevelDB::DB#new`
       def initialize(options = {})
         raise ArgumentError, 'Option :dir is required' unless options[:dir]
         @hash = ::LevelDB::DB.new(options[:dir])

data/lib/moneta/adapters/localmemcache.rb

@@ -10,9 +10,7 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :file - Database file
+      # @option options [String] :file Database file
       def initialize(options = {})
         raise ArgumentError, 'Option :file is required' unless options[:file]
         @hash = ::LocalMemCache.new(:filename => options[:file])

data/lib/moneta/adapters/lruhash.rb

@@ -11,9 +11,7 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :max_size - Maximum byte size of hash values (default 1024000)
+      # @option options [Integer] :max_size (1024000) Maximum total byte size of hash values
       def initialize(options = {})
         @max_size = options[:max_size] || 1024000
         clear

data/lib/moneta/adapters/memcached.rb

@@ -1,10 +1,10 @@
 module Moneta
   module Adapters
     begin
-      require 'moneta/adapters/memcached_native'
+      require 'moneta/adapters/memcached/native'
       Memcached = MemcachedNative
     rescue LoadError
-      require 'moneta/adapters/memcached_dalli'
+      require 'moneta/adapters/memcached/dalli'
       Memcached = MemcachedDalli
     end
   end

data/lib/moneta/adapters/{memcached_dalli.rb → memcached/dalli.rb}

@@ -8,14 +8,12 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :server - Memcached server (default localhost:11211)
-      # * :expires - Default expiration time (default none)
-      # * Other options passed to Dalli::Client#new
+      # @option options [String] :server ('127.0.0.1:11211') Memcached server
+      # @option options [String] :expires Default expiration time
+      # @option options Other options passed to `Dalli::Client#new`
       def initialize(options = {})
         options[:expires_in] = options.delete(:expires)
-        server = options.delete(:server) || 'localhost:11211'
+        server = options.delete(:server) || '127.0.0.1:11211'
         @cache = ::Dalli::Client.new(server, options)
       end
 

data/lib/moneta/adapters/{memcached_native.rb → memcached/native.rb}

@@ -8,16 +8,17 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :server - Memcached server (default localhost:11211)
-      # * :namespace - Key namespace
-      # * :expires - Default expiration time (default 604800)
-      # * Other options passed to Memcached#new
+      # @option options [String] :server ('127.0.0.1:11211') Memcached server
+      # @option options [String] :namespace Key namespace
+      # @option options [String] :expires (604800) Default expiration time
+      # @option options Other options passed to `Memcached#new`
       def initialize(options = {})
-        server = options.delete(:server) || 'localhost:11211'
+        server = options.delete(:server) || '127.0.0.1:11211'
         @expires = options.delete(:expires) || 604800
         options.merge!(:prefix_key => options.delete(:namespace)) if options[:namespace]
+        # We don't want a limitation on the key charset. Therefore we use the binary protocol.
+        # It is also faster.
+        options[:binary_protocol] = true unless options.include?(:binary_protocol)
         @cache = ::Memcached.new(server, options)
       end
 

data/lib/moneta/adapters/mongo.rb

@@ -8,15 +8,13 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :collection - MongoDB collection name (default moneta)
-      # * :host - MongoDB server host (default localhost)
-      # * :port - MongoDB server port (default mongodb default port)
-      # * :db - MongoDB database (default moneta)
+      # @option options [String] :collection ('moneta') MongoDB collection name
+      # @option options [String] :host ('127.0.0.1') MongoDB server host
+      # @option options [Integer] :port (MongoDB default port) MongoDB server port
+      # @option options [String] :db ('moneta') MongoDB database
       def initialize(options = {})
         collection = options.delete(:collection) || 'moneta'
-        host = options.delete(:host) || 'localhost'
+        host = options.delete(:host) || '127.0.0.1'
         port = options.delete(:port) || ::Mongo::Connection::DEFAULT_PORT
         db = options.delete(:db) || 'moneta'
         connection = ::Mongo::Connection.new(host, port, options)
@@ -24,17 +22,18 @@ module Moneta
       end
 
       def load(key, options = {})
-        value = @collection.find_one('_id' => key)
+        value = @collection.find_one('_id' => ::BSON::Binary.new(key))
         value && value['value'].to_s
       end
 
       def delete(key, options = {})
         value = load(key, options)
-        @collection.remove('_id' => key) if value
+        @collection.remove('_id' => ::BSON::Binary.new(key)) if value
         value
       end
 
       def store(key, value, options = {})
+        key = ::BSON::Binary.new(key)
         @collection.update({ '_id' => key },
                            { '_id' => key, 'value' => ::BSON::Binary.new(value) },
                            { :upsert => true })