moneta 0.7.8 → 0.7.9

data/lib/moneta/adapters/memcached/native.rb

@@ -8,6 +8,8 @@ module Moneta
       include Defaults
       include ExpiresSupport
 
+      supports :create, :increment
+
       # @param [Hash] options
       # @option options [String] :server ('127.0.0.1:11211') Memcached server
       # @option options [String] :namespace Key namespace

data/lib/moneta/adapters/mongo.rb

@@ -12,6 +12,8 @@ module Moneta
       include Defaults
       include ExpiresSupport
 
+      supports :create, :increment
+
       # @param [Hash] options
       # @option options [String] :collection ('moneta') MongoDB collection name
       # @option options [String] :host ('127.0.0.1') MongoDB server host

data/lib/moneta/adapters/pstore.rb

@@ -7,6 +7,8 @@ module Moneta
     class PStore
       include Defaults
 
+      supports :create, :increment
+
       # @param [Hash] options
       # @option options [String] :file PStore file
       def initialize(options = {})

data/lib/moneta/adapters/redis.rb

@@ -8,6 +8,8 @@ module Moneta
       include Defaults
       include ExpiresSupport
 
+      supports :create, :increment
+
       # @param [Hash] options
       # @option options [Integer] :expires Default expiration time
       # @option options Other options passed to `Redis#new`
@@ -56,9 +58,7 @@ module Moneta
 
       # (see Proxy#increment)
       def increment(key, amount = 1, options = {})
-        value = @redis.incrby(key, amount)
-        update_expires(key, options)
-        value
+        @redis.incrby(key, amount)
       end
 
       # (see Proxy#clear)

data/lib/moneta/adapters/sequel.rb

@@ -7,6 +7,8 @@ module Moneta
     class Sequel
       include Defaults
 
+      supports :create, :increment
+
       # @param [Hash] options
       # @option options [String] :db Sequel database
       # @option options [String/Symbol] :table (:moneta) Table name

data/lib/moneta/adapters/sqlite.rb

@@ -8,6 +8,8 @@ module Moneta
       include Defaults
       include IncrementSupport
 
+      supports :create
+
       # @param [Hash] options
       # @option options [String] :file Database file
       # @option options [String] :table ('moneta') Table name

data/lib/moneta/adapters/tokyocabinet.rb

@@ -9,14 +9,13 @@ module Moneta
       # @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]
         if options[:type] == :bdb
           @hash = ::TokyoCabinet::BDB.new
-          @hash.open(file, ::TokyoCabinet::BDB::OWRITER | ::TokyoCabinet::BDB::OCREAT)
+          @hash.open(options[:file], ::TokyoCabinet::BDB::OWRITER | ::TokyoCabinet::BDB::OCREAT)
         else
           @hash = ::TokyoCabinet::HDB.new
-          @hash.open(file, ::TokyoCabinet::HDB::OWRITER | ::TokyoCabinet::HDB::OCREAT)
+          @hash.open(options[:file], ::TokyoCabinet::HDB::OWRITER | ::TokyoCabinet::HDB::OCREAT)
         end or raise @hash.errmsg(@hash.ecode)
       end
 

data/lib/moneta/adapters/yaml.rb

@@ -4,7 +4,7 @@ module Moneta
   module Adapters
     # YAML::Store backend
     # @api public
-    class YAML < Moneta::Adapters::PStore
+    class YAML < PStore
       protected
 
       def new_store(options)

data/lib/moneta/cache.rb

@@ -101,5 +101,10 @@ module Moneta
       @cache.close
       @backend.close
     end
+
+    # (see Proxy#features)
+    def features
+      @features ||= ((@cache.features + [:create, :increment]) & @backend.features).freeze
+    end
   end
 end

data/lib/moneta/expires.rb

@@ -12,6 +12,7 @@ module Moneta
     # @param [Hash] options
     # @option options [String] :expires Default expiration time
     def initialize(adapter, options = {})
+      raise 'Store already supports feature :expires' if adapter.supports?(:expires)
       super
       self.default_expires = options[:expires]
     end

data/lib/moneta/mixins.rb

@@ -45,7 +45,7 @@ module Moneta
     # @return [OptionMerger]
     # @api public
     def expires(expires)
-      with(:expires => expires, :only => [:store, :create, :increment])
+      with(:expires => expires, :only => [:store, :create])
     end
   end
 
@@ -54,6 +54,34 @@ module Moneta
   module Defaults
     include OptionSupport
 
+    # @api private
+    module ClassMethods
+      # Returns features list
+      #
+      # @return [Array<Symbol>] list of features
+      def features
+        @features ||= superclass.respond_to?(:features) ? superclass.features : [].freeze
+      end
+
+      # Declares that this adapter supports the given feature.
+      #
+      # @example
+      #   class MyAdapter
+      #     include Moneta::Defaults
+      #     supports :create
+      #     def create(key, value, options = {})
+      #       # implement create!
+      #     end
+      #   end
+      def supports(*features)
+        @features = (self.features + features).uniq.freeze
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
     # Exists the value with key
     #
     # @param [Object] key
@@ -76,6 +104,8 @@ module Moneta
     # @param [Object] key
     # @param [Integer] amount
     # @param [Hash] options
+    # @option options [String] :prefix Prefix key (See {Transformer})
+    # @option options Other options as defined by the adapters or middleware
     # @return [Object] value from store
     # @api public
     def increment(key, amount = 1, options = {})
@@ -91,6 +121,8 @@ module Moneta
     # @param [Object] key
     # @param [Integer] amount
     # @param [Hash] options
+    # @option options [String] :prefix Prefix key (See {Transformer})
+    # @option options Other options as defined by the adapters or middleware
     # @return [Object] value from store
     # @api public
     def decrement(key, amount = 1, options = {})
@@ -110,6 +142,9 @@ module Moneta
     #   block and return its return value.
     #   @param [Object] key
     #   @param [Hash] options
+    #   @option options [Integer] :expires Update expiration time (See {Expires})
+    #   @option options [Boolean] :raw Raw access without value transformation (See {Transformer})
+    #   @option options [String] :prefix Prefix key (See {Transformer})
     #   @return [Object] value from store
     #
     # @overload fetch(key, default, options = {})
@@ -117,6 +152,9 @@ module Moneta
     #   @param [Object] key
     #   @param [Object] default Default value
     #   @param [Hash] options
+    #   @option options [Integer] :expires Update expiration time (See {Expires})
+    #   @option options [Boolean] :raw Raw access without value transformation (See {Transformer})
+    #   @option options [String] :prefix Prefix key (See {Transformer})
     #   @return [Object] value from store
     #
     # @api public
@@ -157,11 +195,28 @@ module Moneta
     # @param [Object] key
     # @param [Object] value
     # @param [Hash] options
+    # @option options [Integer] :expires Update expiration time (See {Expires})
+    # @option options [Boolean] :raw Raw access without value transformation (See {Transformer})
+    # @option options [String] :prefix Prefix key (See {Transformer})
     # @return [Boolean] key was set
     # @api public
     def create(key, value, options = {})
       raise NotImplementedError, 'create is not supported'
     end
+
+    # Returns features list
+    #
+    # @return [Array<Symbol>] list of features
+    def features
+      self.class.features
+    end
+
+    # Return true if adapter supports the given feature.
+    #
+    # @return [Boolean]
+    def supports?(feature)
+      features.include?(feature)
+    end
   end
 
   # @api private
@@ -173,6 +228,10 @@ module Moneta
       store(key, value.to_s, options)
       value
     end
+
+    def self.included(base)
+      base.supports(:increment) if base.respond_to?(:supports)
+    end
   end
 
   # Implements simple create using key? and store.
@@ -190,6 +249,10 @@ module Moneta
         true
       end
     end
+
+    def self.included(base)
+      base.supports(:create) if base.respond_to?(:supports)
+    end
   end
 
   # @api private
@@ -293,5 +356,9 @@ module Moneta
         raise ArgumentError, ":expires must be Numeric or false, got #{value.inspect}"
       end
     end
+
+    def self.included(base)
+      base.supports(:expires) if base.respond_to?(:supports)
+    end
   end
 end

data/lib/moneta/proxy.rb

@@ -83,5 +83,10 @@ module Moneta
       adapter.clear(options)
       self
     end
+
+    # (see Default#features)
+    def features
+      @features ||= (self.class.features + adapter.features).uniq.freeze
+    end
   end
 end

data/lib/moneta/server.rb

@@ -92,7 +92,7 @@ module Moneta
     def handle(client)
       method, *args = read(client)
       case method
-      when :key?, :load, :delete, :increment, :create
+      when :key?, :load, :delete, :increment, :create, :features
         write(client, @store.send(method, *args))
       when :store, :clear
         @store.send(method, *args)

data/lib/moneta/stack.rb

@@ -67,6 +67,13 @@ module Moneta
       last
     end
 
+    # (see Proxy#create)
+    def create(key, value, options = {})
+      last = false
+      @stack.each {|s| last = s.create(key, value, options) }
+      last
+    end
+
     # (see Proxy#delete)
     def delete(key, options = {})
       @stack.inject(nil) do |value, s|
@@ -86,5 +93,14 @@ module Moneta
       @stack.each {|s| s.close }
       nil
     end
+
+    # (see Proxy#features)
+    def features
+      @features ||=
+        begin
+          features = @stack.map(&:features)
+          features.inject(features.first, &:&).freeze
+        end
+    end
   end
 end

data/lib/moneta/synchronize.rb

@@ -74,6 +74,7 @@ module Moneta
     # @param [Moneta store] store The store we want to lock
     # @param [Object] lock Key of the lock entry
     def initialize(store, lock)
+      raise 'Store must support feature :create' unless store.supports?(:create)
       @store, @lock = store, lock
     end
 
@@ -94,7 +95,7 @@ module Moneta
   #     semaphore = Moneta::Semaphore.new(store, 'semaphore', 2)
   #     semaphore.synchronize do
   #       # Synchronized access
-  #       ...
+  #       # ...
   #     end
   #
   # @api public
@@ -103,6 +104,7 @@ module Moneta
     # @param [Object] counter Key of the counter entry
     # @param [Fixnum] max Maximum number of threads which are allowed to enter the critical section
     def initialize(store, counter, max = 1)
+      raise 'Store must support feature :increment' unless store.supports?(:increment)
       @store, @counter, @max = store, counter, max
       @store.increment(@counter, 0, :expires => false) # Ensure that counter exists
     end

data/lib/moneta/version.rb

@@ -1,5 +1,5 @@
 module Moneta
   # Moneta version number
   # @api public
-  VERSION = '0.7.8'
+  VERSION = '0.7.9'
 end

data/lib/moneta/weak.rb

@@ -1,10 +1,17 @@
 module Moneta
   # Adds weak create support to the underlying store
   #
-  # @note The increment method will not be thread or multi-process safe (this is meant by weak)
+  # @note The create method will not be thread or multi-process safe (this is meant by weak)
   # @api public
   class WeakCreate < Proxy
     include CreateSupport
+
+    # @param [Moneta store] adapter The underlying store
+    # @param [Hash] options
+    def initialize(adapter, options = {})
+      raise 'Store already supports feature :create' if adapter.supports?(:create)
+      super
+    end
   end
 
   # Adds weak increment support to the underlying store
@@ -13,5 +20,12 @@ module Moneta
   # @api public
   class WeakIncrement < Proxy
     include IncrementSupport
+
+    # @param [Moneta store] adapter The underlying store
+    # @param [Hash] options
+    def initialize(adapter, options = {})
+      raise 'Store already supports feature :increment' if adapter.supports?(:increment)
+      super
+    end
   end
 end

data/lib/moneta/wrapper.rb

@@ -41,5 +41,10 @@ module Moneta
     def close
       wrap(:close) { super }
     end
+
+    # (see Proxy#features)
+    def features
+      wrap(:features) { super }
+    end
   end
 end

data/script/benchmarks

@@ -46,6 +46,7 @@ class MonetaBenchmarks
     :GDBM => { :file => "#{DIR}/gdbm" },
     :HBase => {},
     :HashFile => { :dir => "#{DIR}/hashfile" },
+    :KyotoCabinet => { :file => 'kyotocabinet.kch' },
     :LRUHash => {},
     :LevelDB => { :dir => "#{DIR}/leveldb" },
     :LocalMemCache => { :file => "#{DIR}/lmc" },
@@ -60,6 +61,7 @@ class MonetaBenchmarks
     :Sequel => { :db => 'sqlite:/' },
     :Sqlite => { :file => ':memory:' },
     :TDB => { :file => "#{DIR}/tdb" },
+    :TokyoCabinet => { :file => 'tokyocabinet' },
   }
 
   CONFIGS = {

data/script/generate-specs

@@ -2,27 +2,19 @@
 
 PATH = File.expand_path(File.join(__FILE__, '..', '..', 'spec'))
 
-class Array
-  def without(*x)
-    a = dup
-    x.each {|y| a.delete(y) }
-    a
-  end
-
-  def with(*x)
-    a = dup
-    x.each {|y| a << y }
-    a
-  end
-end
-
 class Specs
-  attr_reader :key, :value, :specs
+  attr_reader :key, :value, :specs, :features
 
   def initialize(options = {})
     @specs = options.delete(:specs).to_a
     @key = options.delete(:key)     || %w(object string hash boolean nil integer)
     @value = options.delete(:value) || %w(object string hash boolean nil integer)
+    @features = []
+    [:expires, :expires_native, :increment, :create].each do |feature|
+      @features << feature if @specs.include?(feature)
+    end
+    @features.sort_by!(&:to_s)
+    @features.uniq!
   end
 
   def new(options)
@@ -46,15 +38,15 @@ class Specs
   end
 
   def without_increment
-    new(:specs => specs.without(:increment).with(:not_increment))
+    new(:specs => specs - [:increment] + [:not_increment])
   end
 
   def without_persist
-    new(:specs => specs.without(:persist).without(:multiprocess).with(:not_persist))
+    new(:specs => specs - [:persist, :multiprocess] + [:not_persist])
   end
 
   def without_multiprocess
-    new(:specs => specs.without(:multiprocess))
+    new(:specs => specs - [:multiprocess])
   end
 
   def with_expires
@@ -71,45 +63,45 @@ class Specs
   def with_native_expires
     a = specs.dup
     a << :create_expires if a.include?(:create)
-    new(:specs => a.with(:expires))
+    new(:specs => a + [:expires])
   end
 
   def without_marshallable
-    new(:specs => specs.without(:marshallable_value, :marshallable_key))
+    new(:specs => specs - [:marshallable_value, :marshallable_key])
   end
 
   def without_transform
-    new(:specs => specs.without(:marshallable_value, :marshallable_key, :transform_value))
+    new(:specs => specs - [:marshallable_value, :marshallable_key, :transform_value])
   end
 
   def returnsame
-    new(:specs => specs.without(:returndifferent).with(:returnsame))
+    new(:specs => specs - [:returndifferent] + [:returnsame])
   end
 
   def without_marshallable_key
-    new(:specs => specs.without(:marshallable_key))
+    new(:specs => specs - [:marshallable_key])
   end
 
   def without_marshallable_value
-    new(:specs => specs.without(:marshallable_value))
+    new(:specs => specs - [:marshallable_value])
   end
 
   def without_store
-    new(:specs => specs.without(:store, :transform_value, :marshallable_value))
+    new(:specs => specs - [:store, :transform_value, :marshallable_value])
   end
 
   def with_default_expires
-    new(:specs => specs.with(:default_expires))
+    new(:specs => specs + [:default_expires])
   end
 
   def without_create
-    new(:specs => specs.without(:create, :create_expires).with(:not_create))
+    new(:specs => specs - [:create, :create_expires] + [:not_create])
   end
 end
 
-ADAPTER_SPECS = Specs.new(:specs => [:null, :store, :returndifferent, :increment, :persist, :multiprocess, :create], :key => %w(string), :value => %w(string))
-STANDARD_SPECS = Specs.new(:specs => [:null, :store, :returndifferent, :marshallable_key, :marshallable_value, :transform_value, :increment, :persist, :multiprocess, :create])
-TRANSFORMER_SPECS = Specs.new(:specs => [:null, :store, :returndifferent, :transform_value, :increment, :create])
+ADAPTER_SPECS = Specs.new(:specs => [:null, :store, :returndifferent, :increment, :persist, :multiprocess, :create, :features], :key => %w(string), :value => %w(string))
+STANDARD_SPECS = Specs.new(:specs => [:null, :store, :returndifferent, :marshallable_key, :marshallable_value, :transform_value, :increment, :persist, :multiprocess, :create, :features])
+TRANSFORMER_SPECS = Specs.new(:specs => [:null, :store, :returndifferent, :transform_value, :increment, :create, :features])
 
 header = "# Generated by #{File.basename(__FILE__)}\n"
 
@@ -338,6 +330,16 @@ end
     :options => ':file => File.join(make_tempdir, "simple_tokyocabinet_with_expires"), :expires => true',
     :specs => STANDARD_SPECS.without_multiprocess.with_expires
   },
+  'simple_kyotocabinet' => {
+    :store => :KyotoCabinet,
+    :options => ':file => File.join(make_tempdir, "simple_kyotocabinet.kch")',
+    :specs => STANDARD_SPECS.without_multiprocess
+  },
+  'simple_kyotocabinet_with_expires' => {
+    :store => :KyotoCabinet,
+    :options => ':file => File.join(make_tempdir, "simple_kyotocabinet_with_expires.kch"), :expires => true',
+    :specs => STANDARD_SPECS.without_multiprocess.with_expires
+  },
   'simple_sqlite' => {
     :store => :Sqlite,
     :options => ':file => File.join(make_tempdir, "simple_sqlite")',
@@ -478,16 +480,16 @@ end
   'weak_create' => {
     :build => %{Moneta.build do
   use :WeakCreate
-  adapter :Memory
+  adapter :Couch, :db => 'weak_create'
 end},
-    :specs => STANDARD_SPECS.without_transform.without_persist.returnsame
+    :specs => ADAPTER_SPECS.without_increment
   },
   'weak_increment' => {
     :build => %{Moneta.build do
   use :WeakIncrement
-  adapter :Memory
+  adapter :Couch, :db => 'weak_increment'
 end},
-    :specs => STANDARD_SPECS.without_transform.without_persist.returnsame
+    :specs => ADAPTER_SPECS.without_create
   },
   'expires_memory' => {
     :build => %{Moneta.build do
@@ -618,13 +620,11 @@ end},
   'stack_memory_file' => {
     :build => %{Moneta.build do
   use(:Stack) do
-    add(Moneta.new(:Null))
-    add(Moneta::Adapters::Null.new)
     add { adapter :Memory }
     add { adapter :File, :dir => File.join(make_tempdir, "stack_memory_file") }
   end
 end},
-    :specs => STANDARD_SPECS.without_increment.without_create.returnsame.without_transform.stringkeys_only.stringvalues_only
+    :specs => ADAPTER_SPECS.returnsame
   },
   'lock' => {
     :build => %{Moneta.build do
@@ -1289,6 +1289,10 @@ end}
     :build => 'Moneta::Adapters::Sqlite.new(:file => File.join(make_tempdir, "adapter_sqlite"))',
     :specs => ADAPTER_SPECS
   },
+  'adapter_kyotocabinet' => {
+    :build => 'Moneta::Adapters::KyotoCabinet.new(:file => File.join(make_tempdir, "adapter_kyotocabinet.kch"))',
+    :specs => ADAPTER_SPECS.without_multiprocess
+  },
   'adapter_tokyocabinet_bdb' => {
     :build => 'Moneta::Adapters::TokyoCabinet.new(:file => File.join(make_tempdir, "adapter_tokyocabinet_bdb"), :type => :bdb)',
     :specs => ADAPTER_SPECS.without_multiprocess
@@ -1496,6 +1500,10 @@ it 'has method #raw' do
   store.raw.should equal(store.raw.raw)
 end
 
+it 'has method #expires' do
+  store.expires(10).default_options.should == {:store=>{:expires=>10},:create=>{:expires=>10}}
+end
+
 it 'has method #prefix' do
   store.prefix('a').default_options.should == {:store=>{:prefix=>'a'},:load=>{:prefix=>'a'},:create=>{:prefix=>'a'},
                                                :delete=>{:prefix=>'a'},:key? => {:prefix=>'a'},:increment=>{:prefix=>'a'}}
@@ -2166,6 +2174,21 @@ it 'might raise exception on invalid value' do
   end
 end}
 
+SPECS['features'] = %{it 'should report correct features' do
+  store.features.sort_by(&:to_s).should == features
+end
+
+it 'should have frozen features' do
+  store.features.frozen?.should be_true
+end
+
+it 'should have #supports?' do
+  features.each do |f|
+    store.supports?(f).should be_true
+  end
+  store.supports?(:unknown).should be_false
+end}
+
 specs_code = "#{header}\n"
 SPECS.each do |key, code|
   specs_code << "#################### #{key} ####################\n\n" <<
@@ -2205,6 +2228,10 @@ describe_moneta #{name.inspect} do
     @log ||= File.open(File.join(make_tempdir, '#{name}.log'), 'a')
   end
 
+  def features
+    #{specs.features.to_a.inspect}
+  end
+
   #{preamble}def new_store
     #{build.gsub("\n", "\n    ")}
   end