moneta 0.7.1 → 0.7.2

data/.yardopts

@@ -0,0 +1 @@
+- README.md SPEC.md CHANGES LICENSE

data/CHANGES

@@ -1,18 +1,29 @@
+master
+
+* Renamed WithOptions to OptionSupport
+* Refactored Base in Defaults mixin
+* Removed Transformer option :quiet
+* Transformer might raise an exception if an invalid value is transformed
+* Expires middleware only wraps Arrays and nils in an Array if
+  no expiration time is given (backward compatible change)
+* Moneta middlewares are not allowed to modify option hash given to functions
+  like #load and #store
+
 0.7.1
 
-  * Memcached: Use binary protocol and no base64 encoding of the keys
-  * Transformer: Remove newlines from base64 encodes values
-  * Server: Add method #run which will block and #running? to allow forking
-  * SDBM: #store might raise errors (Don't use SDBM, it is unstable!)
-  * Add #decrement method
-  * Fix #fetch to handle false correctly
-  * Fix Expires middleware to handle boolean and nil values correctly
-  * Base64 encode Riak keys since Riak needs valid UTF-8 for the REST interface
+* Memcached: Use binary protocol and no base64 encoding of the keys
+* Transformer: Remove newlines from base64 encodes values
+* Server: Add method #run which will block and #running? to allow forking
+* SDBM: #store might raise errors (Don't use SDBM, it is unstable!)
+* Add #decrement method
+* Fix #fetch to handle false correctly
+* Fix Expires middleware to handle boolean and nil values correctly
+* Base64 encode Riak keys since Riak needs valid UTF-8 for the REST interface
 
 0.7.0
 
-  * Major rewrite by Daniel Mendler
+* Major rewrite by Daniel Mendler
 
 0.6.0
 
-  * First public release by Yehuda Katz
+* First public release by Yehuda Katz

data/README.md

@@ -303,7 +303,7 @@ store['key']    # returns nil
 store['subkey'] # returns 'value'
 
 # Set expiration time for all keys
-short_lived_store = long_lived_store.expires(60)
+short_lived_store = store.expires(60)
 short_lived_store['key'] = 'value'
 ~~~
 

data/SPEC.md

@@ -1,16 +1,8 @@
 # Moneta Specification
 
-The purpose of the moneta specification is to create a general-purpose API for interacting with key-value stores. In general, libraries that need to interact with key-value stores should be able to specify that they can use any "moneta-compliant store".
-
-# Moneta Executable Specs
-
-Moneta ships with a set of executable specs which you can use to verify spec-compliance with your moneta adapter.
-
-# Requirements for a Moneta Adapter
-
 (See RFC 2119 for use of MUST, SHOULD, MAY, MUST NOT, and SHOULD NOT)
 
-A Moneta adapter must expose a class with the following characteristics:
+The purpose of the moneta specification is to create a general-purpose API for interacting with key-value stores. In general, libraries that need to interact with key-value stores should be able to specify that they can use any "moneta-compliant store". Moneta ships with a set of executable specs which you can use to verify spec-compliance with your moneta adapter.
 
 ## Class Methods
 
@@ -62,9 +54,9 @@ This method MUST accept negative values, but the result MUST be unsigned.
 
 Completely empty all keys and values from the key-value-store. Adapters MAY allow a namespace during initialization, which can scope this operation to a particular subset of keys. After calling <code>clear</code>, a <code>[]</code> operation MUST return nil for every possible key, and a <code>key?</code> query MUST return false for every possible key.
 
-# Additional Options Hashes
+## Additional Options Hashes
 
-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).
+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). The methods MUST NOT modify the supplied option hash.
 
 * fetch
 * load
@@ -76,6 +68,6 @@ The following methods may all take an additional Hash as a final argument. This
 
 In the case of methods with optional arguments, the Hash MUST be provided as the final argument. Keys in this Hash MUST be Symbols.
 
-# Atomicity
+## Atomicity
 
 The base Moneta specification does not specify any atomicity guarantees. However, extensions to this spec may specify extensions that define additional guarantees for any of the defined operations.

data/lib/moneta.rb

@@ -1,13 +1,15 @@
 module Moneta
-  autoload :Base,              'moneta/base'
   autoload :Builder,           'moneta/builder'
   autoload :Cache,             'moneta/cache'
+  autoload :Defaults,          'moneta/mixins'
   autoload :Expires,           'moneta/expires'
+  autoload :HashAdapter,       'moneta/mixins'
+  autoload :IncrementSupport,  'moneta/mixins'
   autoload :Lock,              'moneta/lock'
   autoload :Logger,            'moneta/logger'
-  autoload :Mixins,            'moneta/mixins'
-  autoload :Net,               'moneta/net'
+  autoload :Net,               'moneta/mixins'
   autoload :OptionMerger,      'moneta/optionmerger'
+  autoload :OptionSupport,     'moneta/mixins'
   autoload :Proxy,             'moneta/proxy'
   autoload :Server,            'moneta/server'
   autoload :Shared,            'moneta/shared'
@@ -21,15 +23,15 @@ module Moneta
     autoload :Client,          'moneta/adapters/client'
     autoload :Cookie,          'moneta/adapters/cookie'
     autoload :Couch,           'moneta/adapters/couch'
-    autoload :DataMapper,      'moneta/adapters/datamapper'
     autoload :DBM,             'moneta/adapters/dbm'
+    autoload :DataMapper,      'moneta/adapters/datamapper'
     autoload :File,            'moneta/adapters/file'
     autoload :Fog,             'moneta/adapters/fog'
     autoload :GDBM,            'moneta/adapters/gdbm'
     autoload :HBase,           'moneta/adapters/hbase'
+    autoload :LRUHash,         'moneta/adapters/lruhash'
     autoload :LevelDB,         'moneta/adapters/leveldb'
     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'

data/lib/moneta/adapters/activerecord.rb

@@ -4,15 +4,15 @@ module Moneta
   module Adapters
     # ActiveRecord as key/value stores
     # @api public
-    class ActiveRecord < Base
+    class ActiveRecord
+      include Defaults
+
       def self.tables
         @tables ||= {}
       end
 
       attr_reader :table
 
-      # Constructor
-      #
       # @param [Hash] options
       # @option options [String] :table ('moneta') Table name
       # @option options [Hash]   :connection ActiveRecord connection configuration
@@ -36,15 +36,18 @@ module Moneta
         end
       end
 
+      # (see Proxy#key?)
       def key?(key, options = {})
         !@table.where(:k => key).empty?
       end
 
+      # (see Proxy#load)
       def load(key, options = {})
         record = @table.select(:v).where(:k => key).first
         record && record.v
       end
 
+      # (see Proxy#store)
       def store(key, value, options = {})
         record = @table.select(:k).where(:k => key).first_or_initialize
         record.v = value
@@ -52,6 +55,7 @@ module Moneta
         value
       end
 
+      # (see Proxy#delete)
       def delete(key, options = {})
         if record = @table.where(:k => key).first
           record.destroy
@@ -59,6 +63,7 @@ module Moneta
         end
       end
 
+      # (see Proxy#increment)
       def increment(key, amount = 1, options = {})
         record = @table.where(:k => key).lock.first_or_initialize
         value = record.v
@@ -70,6 +75,7 @@ module Moneta
         intvalue
       end
 
+      # (see Proxy#clear)
       def clear(options = {})
         @table.delete_all
         self

data/lib/moneta/adapters/cassandra.rb

@@ -7,15 +7,15 @@ module Moneta
   module Adapters
     # Cassandra backend
     # @api public
-    class Cassandra < Base
-      # Constructor
-      #
+    class Cassandra
+      include Defaults
+
       # @param [Hash] options
       # @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
+      # @option options [Integer] :expires Default expiration time
       def initialize(options = {})
         options[:host] ||= '127.0.0.1'
         options[:port] ||=  9160
@@ -44,6 +44,7 @@ module Moneta
         @client.keyspace = keyspace
       end
 
+      # (see Proxy#key?)
       def key?(key, options = {})
         if @client.exists?(@cf, key)
           if options.include?(:expires) && (value = load(key))
@@ -55,6 +56,7 @@ module Moneta
         end
       end
 
+      # (see Proxy#load)
       def load(key, options = {})
         value = @client.get(@cf, key)
         if value
@@ -66,11 +68,13 @@ module Moneta
         end
       end
 
+      # (see Proxy#store)
       def store(key, value, options = {})
         @client.insert(@cf, key, {'value' => value}, :ttl => (options[:expires] || @expires))
         value
       end
 
+      # (see Proxy#delete)
       def delete(key, options = {})
         if value = load(key, options)
           @client.remove(@cf, key)
@@ -78,6 +82,7 @@ module Moneta
         end
       end
 
+      # (see Proxy#clear)
       def clear(options = {})
         @client.each_key(@cf) do |key|
           delete(key)

data/lib/moneta/adapters/client.rb

@@ -4,11 +4,10 @@ module Moneta
   module Adapters
     # Moneta client backend
     # @api public
-    class Client < Base
+    class Client
       include Net
+      include Defaults
 
-      # Constructor
-      #
       # @param [Hash] options
       # @option options [Integer] :port (9000) TCP port
       # @option options [String] :host ('127.0.0.1') Hostname
@@ -18,38 +17,45 @@ module Moneta
           TCPSocket.open(options[:host] || '127.0.0.1', options[:port] || DEFAULT_PORT)
       end
 
+      # (see Proxy#key?)
       def key?(key, options = {})
         write(@socket, [:key?, key, options])
         read_result
       end
 
+      # (see Proxy#load)
       def load(key, options = {})
         write(@socket, [:load, key, options])
         read_result
       end
 
+      # (see Proxy#store)
       def store(key, value, options = {})
         write(@socket, [:store, key, value, options])
         read_result
         value
       end
 
+      # (see Proxy#delete)
       def delete(key, options = {})
         write(@socket, [:delete, key, options])
         read_result
       end
 
+      # (see Proxy#increment)
       def increment(key, amount = 1, options = {})
         write(@socket, [:increment, key, amount, options])
         read_result
       end
 
+      # (see Proxy#clear)
       def clear(options = {})
         write(@socket, [:clear, options])
         read_result
         self
       end
 
+      # (see Proxy#close)
       def close
         @socket.close
         nil

data/lib/moneta/adapters/cookie.rb

@@ -10,6 +10,7 @@ module Moneta
         @options, @cookies = options, {}
       end
 
+      # (see Proxy#store)
       def store(key, value, options = {})
         cookie = @options.merge(options)
         cookie[:value] = value
@@ -18,11 +19,13 @@ module Moneta
         super
       end
 
+      # (see Proxy#delete)
       def delete(key, options = {})
         @cookies[key] = nil
         super
       end
 
+      # (see Proxy#clear)
       def clear(options = {})
         @hash.each_key { |key| @cookies[key] = nil }
         super

data/lib/moneta/adapters/couch.rb

@@ -4,9 +4,9 @@ module Moneta
   module Adapters
     # CouchDB backend
     # @api public
-    class Couch < Base
-      # Constructor
-      #
+    class Couch
+      include Defaults
+
       # @param [Hash] options
       # @option options [String] :db ('moneta') Couch database
       def initialize(options = {})
@@ -14,18 +14,21 @@ module Moneta
         @db = ::CouchRest.database!(options[:db])
       end
 
+      # (see Proxy#key?)
       def key?(key, options = {})
         @db.get(key) != nil
       rescue RestClient::ResourceNotFound
         false
       end
 
+      # (see Proxy#load)
       def load(key, options = {})
         @db.get(key)['value']
       rescue RestClient::ResourceNotFound
         nil
       end
 
+      # (see Proxy#store)
       def store(key, value, options = {})
         doc = {'_id' => key, 'value' => value}
         begin
@@ -38,6 +41,7 @@ module Moneta
         value
       end
 
+      # (see Proxy#delete)
       def delete(key, options = {})
         value = @db.get(key)
         @db.delete_doc('_id' => value['_id'], '_rev' => value['_rev'])
@@ -46,6 +50,7 @@ module Moneta
         nil
       end
 
+      # (see Proxy#clear)
       def clear(options = {})
         @db.recreate!
         self

data/lib/moneta/adapters/datamapper.rb

@@ -5,15 +5,15 @@ module Moneta
   module Adapters
     # Datamapper backend
     # @api public
-    class DataMapper < Base
+    class DataMapper
+      include Defaults
+
       class Store
         include ::DataMapper::Resource
         property :k, Text, :key => true
         property :v, Text, :lazy => false
       end
 
-      # Constructor
-      #
       # @param [Hash] options
       # @option options [String] :setup Datamapper setup string
       # @option options [String/Symbol] :repository (:moneta) Repository name
@@ -26,10 +26,12 @@ module Moneta
         context { Store.auto_upgrade! }
       end
 
+      # (see Proxy#key?)
       def key?(key, options = {})
         context { Store.get(key) != nil }
       end
 
+      # (see Proxy#load)
       def load(key, options = {})
         context do
           record = Store.get(key)
@@ -37,6 +39,7 @@ module Moneta
         end
       end
 
+      # (see Proxy#store)
       def store(key, value, options = {})
         context do
           if record = Store.get(key)
@@ -48,6 +51,7 @@ module Moneta
         end
       end
 
+      # (see Proxy#delete)
       def delete(key, options = {})
         context do
           if record = Store.get(key)
@@ -58,6 +62,7 @@ module Moneta
         end
       end
 
+      # (see Proxy#clear)
       def clear(options = {})
         context { Store.all.destroy! }
         self

data/lib/moneta/adapters/dbm.rb

@@ -5,8 +5,6 @@ module Moneta
     # DBM backend (Berkeley DB)
     # @api public
     class DBM < Memory
-      # Constructor
-      #
       # @param [Hash] options
       # @option options [String] :file Database file
       def initialize(options = {})
@@ -14,6 +12,7 @@ module Moneta
         @hash = ::DBM.new(options[:file])
       end
 
+      # (see Proxy#close)
       def close
         @hash.close
         nil