redis_pipeline 0.0.5 → 1.0.0

data/README.md

@@ -22,7 +22,7 @@ Create the configuration yaml file
 
     rails generate redis_pipeline
 
-Populate the configuration file with the redis uri and batch size.
+Populate the configuration file with the redis uri and batch size. The configuration file is stored at `config/redis_pipeline.yml`
 
 * uri defaults to `redis://localhost:6379` if you don't have a configuration file
 * batch size defaults to 1000 if you don't have a configuration file
@@ -32,28 +32,37 @@ Populate the configuration file with the redis uri and batch size.
 Create a new pipeline 
 
 ```ruby
- pipeline =  RedisPipeline::RedisPineline.new('redis_uri')
+ pipeline =  RedisPipeline::RedisPineline.new
 ```
 
-Queue up commands with add_commands either as a single string 
+Queue up commands by adding them. You can add a single command as a string. Within a command the | character is used to separate the parts of the command.
 
 ```ruby
- pipeline.add_commands('set|hello|world')
+ pipeline.add_command('set|hello|world')
 ```
 
-or an array
+Or pass an array of commands.
 
 ```ruby
 	array = ['hset|gem|first_name|redis', '|hset|gem|last_name|pipeline']
-	pipeline.add_commands(array)
+	pipeline.add_command(array)
 ```
 
-Send them with execute_commands. Commands are sent using redis-rb's pipelined mode in batches, the size of which are controlled by your configuration. Returns false if there is an error
+The shovel operator works as well.
 
 ```ruby
-  pipeline.execute_commands
+ pipeline << 'set|hello|world'
+ pipeline << ['hset|gem|first_name|redis', '|hset|gem|last_name|pipeline']
 ```
 
+Send the commands to redis with <tt>execute</tt>. Commands are sent using redis-rb's pipelined mode in batches, the size of which are controlled by your configuration. Returns false if there is an error, true if all commands succeed.
+
+```ruby
+  pipeline.execute
+```
+
+See the pipeline errors by iterating through `pipeline.errors`.
+
 ## Contributing
 
 1. Fork it

data/lib/redis_pipeline/commands.rb

@@ -0,0 +1,4 @@
+module RedisPipeline
+  class Commands < Array    
+  end
+end

data/lib/redis_pipeline/errors.rb

@@ -0,0 +1,4 @@
+module RedisPipeline
+  class Errors < Array    
+  end
+end

data/lib/redis_pipeline/redis_pipeline.rb

@@ -7,39 +7,50 @@ module RedisPipeline
 
     attr_reader :errors
 
+    # Instantiates and configures a redis pipeline.
     def initialize()
       configure
-      @redis = open_redis_connection
-      @commands = []
-      @errors = []
+      self.redis = open_redis_connection
+      self.commands = Commands.new
+      self.errors = Errors.new
     end
     
-    def add_commands(new_commands)
-      new_commands = [new_commands] if new_commands.class == String
-      @commands.concat(new_commands)
-    end
-    
-    def execute_commands
-      response = true
+    # Sends each command to the redis pipline, where it is processed.
+    # Commands are removed from the command collection when sent to the pipeline.
+    # Returns <tt>true</tt> if all commands succeed. Returns <tt>false</tt> if any command fails.
+    def execute
       begin
-        while @commands.length > 0
+        while commands.length > 0
           pipeline_commands(command_batch)
         end
       rescue => error
-        @errors << error.message
-        response = false
+        errors << error.message
       end
-      response
+      
+      errors.empty?
     end
     
+    # Adds commands to the piplined. Pass either a single command in a string or an array of commands
+    #   pipeline.add_command('set|hello|world') => [all_commands]
+    #   pipeline.add_command(['hset|gem|first_name|redis', '|hset|gem|last_name|pipeline']) => [all_commands]
+    # Within a command the | character is used to separate the parts of the command.
+    # Returns an array of all commands that have been added.
+    #   commands are removed from the array when they are executed
+    def <<(new_commands)
+      new_commands = [new_commands] if !new_commands.respond_to?(:each)
+      commands.concat(new_commands)
+    end
+    alias_method :add_command, :<<
+
     private
       
-      attr_accessor :commands, :redis
+      attr_writer :errors
+      attr_accessor :redis, :commands
       
       def command_batch
         command_batch = []
-        @commands.first(@settings[:batch_size]).count.times do 
-          command_batch << @commands.shift
+        commands.first(@settings[:batch_size]).count.times do 
+          command_batch << commands.shift
         end
         command_batch
       end
@@ -54,10 +65,10 @@ module RedisPipeline
       end
       
       def pipeline_commands(command_batch)
-        @redis.pipelined do 
+        redis.pipelined do 
           command_batch.each do |command|
             redis_args = command.split("|")
-            @redis.send(*redis_args)
+            redis.send(*redis_args)
           end
         end
       end

data/lib/redis_pipeline/version.rb

@@ -1,3 +1,3 @@
 module RedisPipeline
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/lib/redis_pipeline.rb

@@ -3,6 +3,8 @@ require 'redis'
 require 'active_support/inflector'
 require 'gem_configurator'
 require_relative 'redis_pipeline/redis_pipeline'
+require_relative 'redis_pipeline/commands'
+require_relative 'redis_pipeline/errors'
 
 require 'bundler'
 Bundler.require

data/redis_pipeline.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "redis_pipeline"
   gem.require_paths = ["lib"]
   gem.version       = RedisPipeline::VERSION
-  gem.add_dependency('gem_configurator')
+  gem.add_dependency('gem_configurator', '~> 1.0.0')
   gem.add_dependency              'redis' 
   gem.add_development_dependency  'rake'  
 end

data/test/test_redis_pipeline.rb

@@ -23,28 +23,40 @@ class TestRedisPipeline < Test::Unit::TestCase
   
   def test_add_commands_adds_array_of_commands_as_seperate_commands
     commands = ["hset|person:0|first_name|joe", "hest|person:0|last_name|smith"]
-    @pipeline.add_commands(commands)
+    @pipeline.add_command(commands)
+    assert_equal commands.length, @pipeline.send(:commands).length
+  end
+
+  def test_shovel_command_adds_array_of_commands_as_seperate_commands
+    commands = ["hset|person:0|first_name|joe", "hest|person:0|last_name|smith"]
+    @pipeline << commands
     assert_equal commands.length, @pipeline.send(:commands).length
   end
   
   def test_add_commands_adds_string_as_single_command
     commands = "hset|person:0 first_name joe"
-    @pipeline.add_commands(commands)
+    @pipeline.add_command(commands)
+    assert_equal 1, @pipeline.send(:commands).length
+  end
+
+  def test_shovel_command_adds_string_as_single_command
+    commands = "hset|person:0 first_name joe"
+    @pipeline << commands
     assert_equal 1, @pipeline.send(:commands).length
   end
   
   def test_add_commands_queues_commands_at_end
     commands = ["hset|person:0|first_name|joe", "hest|person:0|last_name|smith"]
-    @pipeline.add_commands(commands)
+    @pipeline.add_command(commands)
     last_command = "hset|person:1|first_name|jane"
-    @pipeline.add_commands(last_command)
+    @pipeline.add_command(last_command)
     assert_equal commands[0], @pipeline.send(:commands).first
     assert_equal last_command, @pipeline.send(:commands).last
   end
   
   def test_command_batch_returns_batch_size_number_of_items
     full_command_set = three_batches_of_commands
-    @pipeline.add_commands(full_command_set)
+    @pipeline.add_command(full_command_set)
     single_batch = @pipeline.send(:command_batch)
     
     upper_limit = (@pipeline.settings[:batch_size] - 1)
@@ -52,7 +64,7 @@ class TestRedisPipeline < Test::Unit::TestCase
   end
   
   def test_command_batch_takes_batch_size_items_out_of_commands
-    @pipeline.add_commands(three_batches_of_commands)
+    @pipeline.add_command(three_batches_of_commands)
     count = @pipeline.send(:commands).length
     @pipeline.send(:command_batch)
     assert_equal (count - @pipeline.settings[:batch_size]), @pipeline.send(:commands).length
@@ -61,39 +73,39 @@ class TestRedisPipeline < Test::Unit::TestCase
   def test_execute_sends_commands_to_redis
     uri_parsed = URI.parse(@uri)
     redis = Redis.new(:host => uri_parsed.host, :port => uri_parsed.port, :password => uri_parsed.password)    
-    @pipeline.add_commands(three_batches_of_commands)
+    @pipeline.add_command(three_batches_of_commands)
     
     first_command = @pipeline.send(:commands).first.split("|")
     last_command = @pipeline.send(:commands).last.split("|")
     assert_equal Hash.new(), redis.send("hgetall", first_command[1])
     assert_equal Hash.new(), redis.send("hgetall", last_command[1])
     
-    @pipeline.execute_commands
+    @pipeline.execute
     assert_equal first_command.last, redis.send("hget", *first_command[1..-2])
     assert_equal last_command.last, redis.send("hget", *last_command[1..-2])
   end
   
   def test_after_execute_no_items_in_command
-    @pipeline.add_commands(three_batches_of_commands)
-    @pipeline.execute_commands
+    @pipeline.add_command(three_batches_of_commands)
+    @pipeline.execute
     assert_equal 0, @pipeline.send(:commands).length
   end
   
   def test_execute_commands_returns_true_if_successful
-    @pipeline.add_commands(three_batches_of_commands)
-    assert @pipeline.execute_commands
+    @pipeline.add_command(three_batches_of_commands)
+    assert @pipeline.execute
   end
   
   def test_execute_commands_returns_false_if_error
     mismatched_commands = ['set|"string_key"|"string_value"', 'hget|"string_key"|"string_not_a_hash"']
-    @pipeline.add_commands(mismatched_commands)
-    assert_equal false, @pipeline.execute_commands
+    @pipeline.add_command(mismatched_commands)
+    assert_equal false, @pipeline.execute
   end
   
   def test_execute_commands_populates_errors_if_error
     mismatched_commands = ['set|"string_key"|"string_value"', 'hget|"string_key"|"string_not_a_hash"']
-    @pipeline.add_commands(mismatched_commands)
-    @pipeline.execute_commands
+    @pipeline.add_command(mismatched_commands)
+    @pipeline.execute
     assert_equal 1, @pipeline.errors.count, "#{@pipeline.errors.inspect}"
     assert_equal 'ERR Operation against a key holding the wrong kind of value', @pipeline.errors[0]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-31 00:00:00.000000000Z
+date: 2012-09-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_configurator
-  requirement: &2161477740 !ruby/object:Gem::Requirement
+  requirement: &2169692560 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2161477740
+  version_requirements: *2169692560
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2161477320 !ruby/object:Gem::Requirement
+  requirement: &2169692140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161477320
+  version_requirements: *2169692140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2161476900 !ruby/object:Gem::Requirement
+  requirement: &2169691680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161476900
+  version_requirements: *2169691680
 description: Send commands to a redis server in pipelined batches
 email:
 - iwhitney@ssa-i.org
@@ -62,6 +62,8 @@ files:
 - lib/generators/redis_pipeline/install/install_generator.rb
 - lib/generators/redis_pipeline/install/templates/redis_pipeline.example.yml
 - lib/redis_pipeline.rb
+- lib/redis_pipeline/commands.rb
+- lib/redis_pipeline/errors.rb
 - lib/redis_pipeline/redis_pipeline.rb
 - lib/redis_pipeline/version.rb
 - redis_pipeline.gemspec