inferx 0.1.6 → 0.1.7

data/lib/inferx.rb

@@ -9,10 +9,9 @@ class Inferx
   #   {https://github.com/redis/redis-rb redis}
   #
   # @option options [String] :namespace namespace of keys to be used to Redis
+  # @option options [Boolean] :manual whether save manually, defaults to false
   def initialize(options = {})
-    namespace = options.delete(:namespace)
-    redis = Redis.new(options)
-    @categories = Categories.new(redis, namespace)
+    @categories = Categories.new(Redis.new(options), options)
   end
 
   attr_reader :categories

data/lib/inferx/adapter.rb

@@ -2,10 +2,21 @@ class Inferx
   class Adapter
 
     # @param [Redis] redis an instance of Redis
-    # @param [String] namespace namespace of keys to be used to Redis
-    def initialize(redis, namespace = nil)
+    # @param [Hash] options
+    # @option options [String] :namespace namespace of keys to be used to Redis
+    # @option options [Boolean] :manual whether manual save, defaults to false
+    def initialize(redis, options = {})
       @redis = redis
-      @namespace = namespace
+      @options = options
+      @namespace = options[:namespace]
+      @manual = !!options[:manual]
+    end
+
+    # Determine if manual save.
+    #
+    # @return [Boolean] whether or not manual save
+    def manual?
+      @manual
     end
 
     # Get the key for access to categories.
@@ -39,7 +50,7 @@ class Inferx
     # @param [Array] args any arguments
     # @return [Object] a instance of the class
     def spawn(klass, *args)
-      klass.new(@redis, *args, @namespace)
+      klass.new(@redis, *args, @options)
     end
 
     protected

data/lib/inferx/categories.rb

@@ -28,6 +28,7 @@ class Inferx
     def add(*category_names)
       @redis.pipelined do
         category_names.each { |category_name| hsetnx(category_name, 0) }
+        @redis.save unless manual?
       end
     end
 
@@ -38,6 +39,7 @@ class Inferx
       @redis.pipelined do
         category_names.each { |category_name| hdel(category_name) }
         @redis.del(*category_names.map(&method(:make_category_key)))
+        @redis.save unless manual?
       end
     end
 

data/lib/inferx/category.rb

@@ -5,9 +5,11 @@ class Inferx
 
     # @param [Redis] redis an instance of Redis
     # @param [Symbol] name a category name
-    # @param [String] namespace namespace of keys to be used to Redis
-    def initialize(redis, name, namespace = nil)
-      super(redis, namespace)
+    # @param [Hash] options
+    # @option options [String] :namespace namespace of keys to be used to Redis
+    # @option options [Boolean] :manual whether manual save, defaults to false
+    def initialize(redis, name, options = {})
+      super(redis, options)
       @name = name
     end
 
@@ -63,7 +65,10 @@ class Inferx
           count + pair[1]
         end
 
-        hincrby(name, increase) if increase > 0
+        if increase > 0
+          hincrby(name, increase)
+          @redis.save unless manual?
+        end
       end
     end
 
@@ -87,7 +92,10 @@ class Inferx
         decrease += score if score < 0
       end
 
-      hincrby(name, -decrease) if decrease > 0
+      if decrease > 0
+        hincrby(name, -decrease)
+        @redis.save unless manual?
+      end
     end
 
     # Get total of scores.

data/lib/inferx/version.rb

@@ -1,3 +1,3 @@
 class Inferx
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/spec/inferx/adapter_spec.rb

@@ -8,12 +8,29 @@ describe Inferx::Adapter, '#initialize' do
     adapter.instance_eval { @redis }.should == redis
   end
 
-  context 'with a namespace' do
-    it 'sets the namespace to @namespace' do
-      adapter = described_class.new(redis_stub, 'example')
+  it 'sets nil to @namespace' do
+    adapter = described_class.new(redis_stub)
+    adapter.instance_eval { @namespace }.should be_nil
+  end
+
+  it 'sets false to @manual' do
+    adapter = described_class.new(redis_stub)
+    adapter.should_not be_manual
+  end
+
+  context 'with namespace option' do
+    it 'sets the value of namespace option to @namespace' do
+      adapter = described_class.new(redis_stub, :namespace => 'example')
       adapter.instance_eval { @namespace }.should == 'example'
     end
   end
+
+  context 'with manual option' do
+    it 'sets the value of manual option to @manual' do
+      adapter = described_class.new(redis_stub, :manual => true)
+      adapter.should be_manual
+    end
+  end
 end
 
 describe Inferx::Adapter, '#categories_key' do
@@ -37,9 +54,9 @@ describe Inferx::Adapter, '#make_categories_key' do
     adapter.categories_key.should == 'inferx:categories'
   end
 
-  context 'with a namespace' do
+  context 'with namespace' do
     it 'returns the key included the namespace' do
-      adapter = described_class.new(redis_stub, 'example')
+      adapter = described_class.new(redis_stub, :namespace => 'example')
       adapter.categories_key.should == 'inferx:example:categories'
     end
   end
@@ -51,9 +68,9 @@ describe Inferx::Adapter, '#make_category_key' do
     adapter.make_category_key(:red).should == 'inferx:categories:red'
   end
 
-  context 'with a namespace' do
+  context 'with namespace' do
     it 'returns the key included the namespace' do
-      adapter = described_class.new(redis_stub, 'example')
+      adapter = described_class.new(redis_stub, :namespace => 'example')
       adapter.make_category_key(:red).should == 'inferx:example:categories:red'
     end
   end
@@ -62,8 +79,8 @@ end
 describe Inferx::Adapter, '#spawn' do
   it 'calls constructor of the class with the instance variables and the arguments' do
     redis = redis_stub
-    adapter = described_class.new(redis, 'example')
-    klass = mock.tap { |m| m.should_receive(:new).with(redis, 'arg1', 'arg2', 'example') }
+    adapter = described_class.new(redis, :namespace => 'example')
+    klass = mock.tap { |m| m.should_receive(:new).with(redis, 'arg1', 'arg2', :namespace => 'example') }
     adapter.spawn(klass, 'arg1', 'arg2')
   end
 

data/spec/inferx/categories_spec.rb

@@ -10,9 +10,10 @@ end
 describe Inferx::Categories, '#initialize' do
   it 'calls Inferx::Adapter#initialize' do
     redis = redis_stub
-    categories = described_class.new(redis, 'example')
+    categories = described_class.new(redis, :namespace => 'example', :manual => true)
     categories.instance_eval { @redis }.should == redis
     categories.instance_eval { @namespace }.should == 'example'
+    categories.should be_manual
   end
 end
 
@@ -55,13 +56,13 @@ describe Inferx::Categories, '#get' do
     categories.get(:red)
   end
 
-  it 'calles Inferx::Category.new with the instance of Redis, the category name and the namepsace' do
+  it 'calles Inferx::Category.new with the instance of Redis, the category name and the options' do
     redis = redis_stub do |s|
       s.stub!(:hexists).and_return(true)
     end
 
-    Inferx::Category.should_receive(:new).with(redis, :red, 'example')
-    categories = described_class.new(redis, 'example')
+    Inferx::Category.should_receive(:new).with(redis, :red, :namespace => 'example', :manual => true)
+    categories = described_class.new(redis, :namespace => 'example', :manual => true)
     categories.get(:red)
   end
 
@@ -90,6 +91,7 @@ describe Inferx::Categories, '#add' do
   it 'calls Redis#hsetnx' do
     redis = redis_stub do |s|
       s.should_receive(:hsetnx).with('inferx:categories', :red, 0)
+      s.should_receive(:save)
     end
 
     categories = described_class.new(redis)
@@ -100,11 +102,24 @@ describe Inferx::Categories, '#add' do
     redis = redis_stub do |s|
       s.should_receive(:hsetnx).with('inferx:categories', :red, 0)
       s.should_receive(:hsetnx).with('inferx:categories', :green, 0)
+      s.should_receive(:save)
     end
 
     categories = described_class.new(redis)
     categories.add(:red, :green)
   end
+
+  context 'with manual save' do
+    it 'does not call Redis#save' do
+      redis = redis_stub do |s|
+        s.stub(:hsetnx)
+        s.should_not_receive(:save)
+      end
+
+      categories = described_class.new(redis, :manual => true)
+      categories.add(:red)
+    end
+  end
 end
 
 describe Inferx::Categories, '#remove' do
@@ -112,6 +127,7 @@ describe Inferx::Categories, '#remove' do
     redis = redis_stub do |s|
       s.should_receive(:hdel).with('inferx:categories', :red)
       s.should_receive(:del).with('inferx:categories:red')
+      s.should_receive(:save)
     end
 
     categories = described_class.new(redis)
@@ -123,11 +139,25 @@ describe Inferx::Categories, '#remove' do
       s.should_receive(:hdel).with('inferx:categories', :red)
       s.should_receive(:hdel).with('inferx:categories', :green)
       s.should_receive(:del).with('inferx:categories:red', 'inferx:categories:green')
+      s.should_receive(:save)
     end
 
     categories = described_class.new(redis)
     categories.remove(:red, :green)
   end
+
+  context 'with manual save' do
+    it 'does not call Redis#save' do
+      redis = redis_stub do |s|
+        s.stub!(:hdel)
+        s.stub!(:del)
+        s.should_not_receive(:save)
+      end
+
+      categories = described_class.new(redis, :manual => true)
+      categories.remove(:red)
+    end
+  end
 end
 
 describe Inferx::Categories, '#each' do

data/spec/inferx/category_spec.rb

@@ -4,9 +4,10 @@ require 'inferx/category'
 describe Inferx::Category, '#initialize' do
   it 'calls Inferx::Adapter#initialize' do
     redis = redis_stub
-    category = described_class.new(redis, :red, 'example')
+    category = described_class.new(redis, :red, :namespace => 'example', :manual => true)
     category.instance_eval { @redis }.should == redis
     category.instance_eval { @namespace }.should == 'example'
+    category.should be_manual
   end
 
   it 'sets the category name to the name attribute' do
@@ -94,6 +95,7 @@ describe Inferx::Category, '#train' do
       s.should_receive(:zincrby).with('inferx:categories:red', 2, 'apple')
       s.should_receive(:zincrby).with('inferx:categories:red', 3, 'strawberry')
       s.should_receive(:hincrby).with('inferx:categories', :red, 5)
+      s.should_receive(:save)
     end
 
     category = described_class.new(redis, :red)
@@ -104,12 +106,26 @@ describe Inferx::Category, '#train' do
     it 'does not call Redis#hincrby' do
       redis = redis_stub do |s|
         s.should_not_receive(:hincrby)
+        s.should_not_receive(:save)
       end
 
       category = described_class.new(redis, :red)
       category.train(%w())
     end
   end
+
+  context 'with manual save' do
+    it 'does not call Redis#save' do
+      redis = redis_stub do |s|
+        s.stub!(:zincrby)
+        s.stub!(:hincrby)
+        s.should_not_receive(:save)
+      end
+
+      category = described_class.new(redis, :red, :manual => true)
+      category.train(%w(apple strawberry apple strawberry strawberry))
+    end
+  end
 end
 
 describe Inferx::Category, '#untrain' do
@@ -119,6 +135,7 @@ describe Inferx::Category, '#untrain' do
       s.should_receive(:zincrby).with('inferx:categories:red', -3, 'strawberry')
       s.should_receive(:zremrangebyscore).with('inferx:categories:red', '-inf', 0).and_return(%w(3 -2 1))
       s.should_receive(:hincrby).with('inferx:categories', :red, -3)
+      s.should_receive(:save)
     end
 
     category = described_class.new(redis, :red)
@@ -131,12 +148,27 @@ describe Inferx::Category, '#untrain' do
         s.stub!(:zincrby)
         s.stub!(:zremrangebyscore).and_return(%w(-2 -3 2))
         s.should_not_receive(:hincrby)
+        s.should_not_receive(:save)
       end
 
       category = described_class.new(redis, :red)
       category.untrain(%w(apple strawberry apple strawberry strawberry))
     end
   end
+
+  context 'with manual save' do
+    it 'does not call Redis#save' do
+      redis = redis_stub do |s|
+        s.stub!(:zincrby)
+        s.stub!(:zremrangebyscore).and_return(%w(3 -2 1))
+        s.stub!(:hincrby)
+        s.should_not_receive(:save)
+      end
+
+      category = described_class.new(redis, :red, :manual => true)
+      category.untrain(%w(apple strawberry apple strawberry strawberry))
+    end
+  end
 end
 
 describe Inferx::Category, '#size' do

data/spec/inferx_spec.rb

@@ -12,10 +12,10 @@ describe Inferx do
 end
 
 describe Inferx, '#initialize' do
-  it "calls #{described_class}::Categories.new with a connection of Redis and the namespace option" do
+  it "calls #{described_class}::Categories.new with a connection of Redis and the options" do
     redis = redis_stub
-    Inferx::Categories.should_receive(:new).with(redis, 'example')
-    described_class.new(:namespace => 'example')
+    Inferx::Categories.should_receive(:new).with(redis, :namespace => 'example', :manual => true)
+    described_class.new(:namespace => 'example', :manual => true)
   end
 
   it "sets an instance of #{described_class}::Categories to the categories attribute" do

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 def redis_stub
   stub.tap do |s|
     s.stub!(:pipelined).and_return { |&block| block.call }
+    s.stub!(:save)
     yield s if block_given?
     Redis.stub!(:new).and_return(s) if defined? Redis
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inferx
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-03 00:00:00.000000000 Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis