moneta 0.7.0 → 0.7.1

data/lib/moneta/adapters/pstore.rb

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

data/lib/moneta/adapters/redis.rb

@@ -8,10 +8,8 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :expires - Default expiration time (default none)
-      # * Other options passed to Redis#new
+      # @option options [String] :expires Default expiration time
+      # @option options Other options passed to `Redis#new`
       def initialize(options = {})
         @expires = options.delete(:expires)
         @redis = ::Redis.new(options)

data/lib/moneta/adapters/riak.rb

@@ -11,11 +11,9 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :bucket - Bucket name (default moneta)
-      # * :content_type - Default content type (default application/octet-stream)
-      # * All other options passed to Riak::Client#new
+      # @option options [String] :bucket ('moneta') Bucket name
+      # @option options [String] :content_type ('application/octet-stream') Default content type
+      # @option options All other options passed to `Riak::Client#new`
       def initialize(options = {})
         bucket = options.delete(:bucket) || 'moneta'
         @content_type = options.delete(:content_type) || 'application/octet-stream'

data/lib/moneta/adapters/sdbm.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 = ::SDBM.new(options[:file])
@@ -20,16 +18,6 @@ module Moneta
         @hash.close
         nil
       end
-
-      def store(key, value, options = {})
-        super
-        value
-      rescue SDBMError
-        # SDBM is not very robust!
-        # You shouldn't put to much data into it, otherwise
-        # it might raise a SDBMError.
-        value
-      end
     end
   end
 end

data/lib/moneta/adapters/sequel.rb

@@ -8,11 +8,9 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :db - Sequel database
-      # * :table - Table name (default :moneta)
-      # * All other options passed to Sequel#connect
+      # @option options [String] :db Sequel database
+      # @option options [String/Symbol] :table (:moneta) Table name
+      # @option options All other options passed to `Sequel#connect`
       def initialize(options = {})
         raise ArgumentError, 'Option :db is required' unless db = options.delete(:db)
         table = options.delete(:table) || :moneta

data/lib/moneta/adapters/sqlite.rb

@@ -10,10 +10,8 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :file - Database file
-      # * :table - Table name (default moneta)
+      # @option options [String] :file Database file
+      # @option options [String] :table ('moneta') Table name
       def initialize(options = {})
         raise ArgumentError, 'Option :file is required' unless options[:file]
         table = options[:table] || 'moneta'

data/lib/moneta/adapters/tokyocabinet.rb

@@ -8,10 +8,8 @@ module Moneta
       # Constructor
       #
       # @param [Hash] options
-      #
-      # Options:
-      # * :file - Database file
-      # * :type - Database type (default :hdb, :bdb and :hdb possible)
+      # @option options [String] :file Database file
+      # @option options [Symbol] :type (:hdb) Database type (:bdb and :hdb possible)
       def initialize(options = {})
         file = options[:file]
         raise ArgumentError, 'Option :file is required' unless options[:file]

data/lib/moneta/base.rb

@@ -19,6 +19,8 @@ module Moneta
     # Not every Moneta store implements this method,
     # a NotImplementedError if it is not supported.
     #
+    # This method also accepts negative amounts.
+    #
     # @param [Object] key
     # @param [Integer] amount
     # @param [Hash] options
@@ -28,7 +30,23 @@ module Moneta
       raise NotImplementedError, 'increment is not supported'
     end
 
+    # Atomically decrement integer value with key
+    #
+    # This is just syntactic sugar for calling #increment with a negative value.
+    #
+    # This method also accepts negative amounts.
+    #
+    # @param [Object] key
+    # @param [Integer] amount
+    # @param [Hash] options
+    # @return [Object] value from store
+    # @api public
+    def decrement(key, amount = 1, options = {})
+      increment(key, -amount, options)
+    end
+
     # Explicitly close the store
+    # @return nil
     # @api public
     def close
     end
@@ -50,9 +68,11 @@ module Moneta
     def fetch(key, default = nil, options = nil)
       if block_given?
         raise ArgumentError, 'Only one argument accepted if block is given' if options
-        load(key, default || {}) || yield(key)
+        result = load(key, default || {})
+        result == nil ? yield(key) : result
       else
-        load(key, options || {}) || default
+        result = load(key, options || {})
+        result == nil ? default : result
       end
     end
 

data/lib/moneta/builder.rb

@@ -1,5 +1,5 @@
 module Moneta
-  # Builder implements the DSL to build a chain of store proxies
+  # Builder implements the DSL to build a stack of Moneta store proxies
   # @api private
   class Builder
     # @api private
@@ -17,7 +17,7 @@ module Moneta
       instance_eval(&block)
     end
 
-    # Add proxy to chain
+    # Add proxy to stack
     #
     # @param [Symbol or Class] proxy Name of proxy class or proxy class
     # @param [Hash] options Options hash
@@ -28,7 +28,7 @@ module Moneta
       nil
     end
 
-    # Add adapter to chain
+    # Add adapter to stack
     #
     # @param [Symbol] name Name of adapter class
     # @param [Hash] options Options hash

data/lib/moneta/cache.rb

@@ -1,7 +1,7 @@
 module Moneta
   # Combines two stores. One is used as cache, the other as backend.
   #
-  # @example Add cache to chain
+  # @example Add `Moneta::Cache` to proxy stack
   #   Moneta.build do
   #     use(:Cache) do
   #      backend { adapter :File, :dir => 'data' }

data/lib/moneta/expires.rb

@@ -10,61 +10,53 @@ module Moneta
     #
     # @param [Moneta store] adapter The underlying store
     # @param [Hash] options
-    #
-    # Options:
-    # * :expires - Default expiration time (default none)
+    # @option options [String] :expires Default expiration time
     def initialize(adapter, options = {})
       super
       @expires = options[:expires]
     end
 
     def key?(key, options = {})
-      load(key, options) != nil
+      load_entry(key, options) != nil
     end
 
     def load(key, options = {})
-      if options.include?(:raw)
-        super
-      else
-        value = check_expired(key, super)
-        if value && options.include?(:expires)
-          store(key, value, options)
-        else
-          value
-        end
-      end
+      return super if options.include?(:raw)
+      value, expires = load_entry(key, options)
+      value
     end
 
     def store(key, value, options = {})
-      if options.include?(:raw)
-        super
+      return super if options.include?(:raw)
+      if expires = (options.delete(:expires) || @expires)
+        super(key, [value, Time.now.to_i + expires], options)
       else
-        if expires = (options.delete(:expires) || @expires)
-          super(key, [value, Time.now.to_i + expires], options)
-        else
-          super(key, [value], options)
-        end
-        value
+        super(key, [value], options)
       end
+      value
     end
 
     def delete(key, options = {})
-      if options.include?(:raw)
-        super
-      else
-        check_expired(key, super, false)
-      end
+      return super if options.include?(:raw)
+      value, expires = super
+      value if !expires || Time.now.to_i <= expires
     end
 
-    protected
+    private
 
-    def check_expired(key, value, delete_expired = true)
-      value, expires = value
-      if expires && Time.now.to_i > expires
-        delete(key) if delete_expired
-        nil
-      else
-        value
+    def load_entry(key, options)
+      new_expires = options.delete(:expires)
+      if entry = @adapter.load(key, options)
+        value, expires = entry
+        if expires && Time.now.to_i > expires
+          delete(key)
+          nil
+        elsif new_expires
+          @adapter.store(key, [value, Time.now.to_i + new_expires], options)
+          entry
+        else
+          entry
+        end
       end
     end
   end

data/lib/moneta/lock.rb

@@ -8,9 +8,7 @@ module Moneta
     #
     # @param [Moneta store] adapter The underlying store
     # @param [Hash] options
-    #
-    # Options:
-    # * :mutex - Mutex object (default Mutex.new)
+    # @option options [String] :mutex (Mutex.new) Mutex object
     def initialize(adapter, options = {})
       super
       @lock = options[:mutex] || Mutex.new

data/lib/moneta/logger.rb

@@ -37,11 +37,9 @@ module Moneta
     #
     # @param [Moneta store] adapter The underlying store
     # @param [Hash] options
-    #
-    # Options:
-    # * :logger - Callable logger object (default Moneta::Logger::Format)
-    # * :logprefix - Prefix string (default 'Moneta ')
-    # * :logout - Output (default STDOUT)
+    # @option options [Object] :logger (Moneta::Logger::Format) Callable logger object
+    # @option options [String] :logprefix ('Moneta ') Prefix string
+    # @option options [IO] :logout (STDOUT) Output
     def initialize(adapter, options = {})
       super
       @logger = options[:logger] || Format.new(options)

data/lib/moneta/net.rb

@@ -3,7 +3,12 @@ module Moneta
   module Net
     DEFAULT_PORT = 9000
 
-    class Error < Exception; end
+    class Error < RuntimeError; end
+
+    def pack(o)
+      s = Marshal.dump(o)
+      [s.bytesize].pack('N') << s
+    end
 
     def read(io)
       size = io.read(4).unpack('N').first
@@ -11,8 +16,7 @@ module Moneta
     end
 
     def write(io, o)
-      s = Marshal.dump(o)
-      io.write([s.bytesize].pack('N') << s)
+      io.write(pack(o))
     end
   end
 end

data/lib/moneta/proxy.rb

@@ -6,7 +6,7 @@ module Moneta
 
     # Constructor
     #
-    # @param [Moneta store] underlying adapter
+    # @param [Moneta store] adapter underlying adapter
     # @param [Hash] options
     def initialize(adapter, options = {})
       @adapter = adapter
@@ -78,6 +78,7 @@ module Moneta
     end
 
     # Close this store
+    # @return nil
     # @api public
     def close
       @adapter.close

data/lib/moneta/server.rb

@@ -4,45 +4,57 @@ module Moneta
   # Moneta server
   # @api public
   class Server
-    TIMEOUT = 1
-    include Net
-
     # Constructor
     #
     # @param [Hash] options
-    #
-    # Options:
-    # * :port - TCP port (default 9000)
-    # * :file - Unix socket file name (default none)
+    # @option options [Integer] :port (9000) TCP port
+    # @option options [String] :file Alternative Unix socket file name
     def initialize(store, options = {})
       @store = store
-      @server = options[:file] ? UNIXServer.open(options[:file]) :
-        TCPServer.open(options[:port] || DEFAULT_PORT)
+      @server =
+        if @file = options[:file]
+          UNIXServer.open(@file)
+        else
+          TCPServer.open(options[:port] || DEFAULT_PORT)
+        end
       @clients = [@server]
+      @running = false
+    end
+
+    def running?
+      @running
+    end
+
+    def run
+      raise 'Already running' if @running
+      @stop = false
       @running = true
-      @thread = Thread.new do
-        mainloop while @running
-        File.unlink(options[:file]) if options[:file]
+      begin
+        until @stop
+          mainloop
+        end
+      ensure
+        File.unlink(@file) if @file
       end
     end
 
     def stop
-      if @thread
-        @running = false
-        @server.close
-        @server = nil
-        @thread.join
-        @thread = nil
-      end
+      raise 'Not running' unless @running
+      @stop = true
+      @server.close
+      @server = nil
     end
 
     private
 
+    include Net
+    TIMEOUT = 1
+
     def mainloop
       client = accept
       handle(client) if client
     rescue Exception => ex
-      puts "#{ex.message}\n#{ex.backtrace.join("\n")}"
+      puts ex.message
       write(client, Error.new(ex.message)) if client
     end
 
@@ -72,7 +84,7 @@ module Moneta
         write(client, @store.send(method, *args))
       when :store, :clear
         @store.send(method, *args)
-        write(client, nil)
+        client.write(@nil ||= pack(nil))
       else
         raise 'Invalid method call'
       end

data/lib/moneta/shared.rb

@@ -14,11 +14,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 Server hostname
+    # @option options [String] :file Unix socket file name
     def initialize(options = {}, &block)
       @options = options
       @builder = Builder.new(&block)
@@ -27,7 +25,8 @@ module Moneta
     def close
       if @server
         @server.stop
-        @server = nil
+        @thread.join
+        @server = @thread = nil
       end
       if @adapter
         @adapter.close
@@ -38,18 +37,23 @@ module Moneta
     private
 
     def wrap(*args)
-      tries ||= 0
       @adapter ||= Adapters::Client.new(@options)
       yield
     rescue Exception => ex
       puts "Failed to connect: #{ex.message}"
       begin
+        # TODO: Implement this using forking (MRI) and threading (JRuby)
+        # to get maximal performance
         @adapter = Lock.new(@builder.build.last)
         @server = Server.new(@adapter, @options)
+        @thread = Thread.new { @server.run }
+        sleep 0.1 until @server.running?
       rescue Exception => ex
         puts "Failed to start server: #{ex.message}"
+        @adapter.close if @adapter
         @adapter = nil
       end
+      tries ||= 0
       if (tries += 1) > 2
         raise
       else