twirl 0.1.0 → 0.2.0

data/lib/twirl/cluster.rb

@@ -1,6 +1,7 @@
 require "forwardable"
 require "kjess"
 require "twirl/item"
+require "twirl/mirror"
 require "twirl/instrumenters/noop"
 
 module Twirl
@@ -30,6 +31,9 @@ module Twirl
     # Private: What should be used to instrument all the things.
     attr_reader :instrumenter
 
+    # Private: What handles dumping and loading values.
+    attr_reader :encoder
+
     # Private: What errors should be considered retryable.
     attr_reader :retryable_errors
 
@@ -47,6 +51,7 @@ module Twirl
     #                                  before rotating to the next client (default: 100)
     #           :retries - The Number of times a command should be retried (default: 5).
     #           :instrumenter - Where to send instrumention (defaults: noop).
+    #           :encoder - What to use to dump/load vlues (defaults: mirror).
     def initialize(clients, options = {})
       @client_index = 0
       @command_count = 0
@@ -54,6 +59,7 @@ module Twirl
       @retries = options.fetch(:retries, 5)
       @commands_per_client = options.fetch(:commands_per_client, 100)
       @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
+      @encoder = options.fetch(:encoder, Mirror)
       @retryable_errors = options.fetch(:retryable_errors, RetryableErrors)
     end
 
@@ -73,11 +79,16 @@ module Twirl
       with_retries { |tries|
         @instrumenter.instrument("op.twirl") { |payload|
           payload[:op] = :set
-          payload[:bytes] = item.size
+          payload[:bytes] = item.to_s.size
           payload[:queue_name] = queue_name
           payload[:retry] = tries != @retries
 
-          client.set(queue_name, item, expiration)
+          value = if item
+            @encoder.dump(item)
+          else
+            nil
+          end
+          client.set(queue_name, value, expiration)
         }
       }
     end
@@ -244,6 +255,7 @@ module Twirl
 
           if value = client.send(op, queue_name, *args)
             payload[:bytes] = value.size
+            value = @encoder.load(value) if value
             Item.new queue_name, value, client, @instrumenter
           else
             rotate_for_next_op
@@ -304,6 +316,7 @@ module Twirl
       }
     end
 
+    # Private: Retries an operation a number of times if it raises exception.
     def with_retries
       tries = @retries
       begin

data/lib/twirl/mirror.rb

@@ -0,0 +1,19 @@
+module Twirl
+  class Mirror
+    def self.dump(value)
+      value
+    end
+
+    def self.load(value)
+      value
+    end
+
+    def dump(value)
+      value
+    end
+
+    def load(value)
+      value
+    end
+  end
+end

data/lib/twirl/version.rb

@@ -1,3 +1,3 @@
 module Twirl
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/cluster_test.rb

@@ -15,6 +15,7 @@ class ClusterTest < Minitest::Test
     assert_equal [KJess::NetworkError, KJess::ServerError],
       cluster.retryable_errors
     assert_equal Twirl::Instrumenters::Noop, cluster.instrumenter
+    assert_equal Twirl::Mirror, cluster.encoder
   end
 
   def test_initialize_shuffles_clients
@@ -31,6 +32,12 @@ class ClusterTest < Minitest::Test
     assert_equal instrumenter, cluster.instrumenter
   end
 
+  def test_overriding_encoder
+    encoder = Object.new
+    cluster = Twirl::Cluster.new([], encoder: encoder)
+    assert_equal encoder, cluster.encoder
+  end
+
   def test_overriding_retryable_errors
     retryable_errors = StandardError
     cluster = Twirl::Cluster.new([], retryable_errors: retryable_errors)
@@ -466,4 +473,32 @@ class ClusterTest < Minitest::Test
       end
     end
   end
+
+  def test_values_dumped_and_loaded_by_encoder
+    encoder = Minitest::Mock.new
+    encoder.expect :dump, :dump, ["data"]
+    encoder.expect :load, :load, ["data"]
+
+    cluster = build(:mock_cluster, encoder: encoder)
+    cluster[0].expect :set, true, ["testing", :dump, 0]
+    cluster.set("testing", "data")
+
+    cluster[0].expect :get, "data", ["testing", {}]
+    assert_equal :load, cluster.get("testing").value
+
+    encoder.verify
+  end
+
+  def test_nil_values_not_dumped_or_loaded
+    encoder = Minitest::Mock.new
+
+    cluster = build(:mock_cluster, encoder: encoder)
+    cluster[0].expect :set, true, ["testing", nil, 0]
+    cluster.set("testing", nil)
+
+    cluster[0].expect :get, nil, ["testing", {}]
+    assert_nil cluster.get("testing")
+
+    encoder.verify
+  end
 end

data/test/mirror_test.rb

@@ -0,0 +1,24 @@
+require "helper"
+require "twirl/mirror"
+
+class MirrorTest < Minitest::Test
+  def test_dump
+    data = "data"
+    assert_equal data, Twirl::Mirror.dump(data)
+  end
+
+  def test_load
+    data = "data"
+    assert_equal data, Twirl::Mirror.load(data)
+  end
+
+  def test_dump
+    data = "data"
+    assert_equal data, Twirl::Mirror.new.dump(data)
+  end
+
+  def test_load
+    data = "data"
+    assert_equal data, Twirl::Mirror.new.load(data)
+  end
+end

data/twirl.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["nunemaker@gmail.com"]
   spec.description   = %q{Wrapper for kjess that works with multiple kestrel instances intelligently.}
   spec.summary       = %q{Wrapper for kjess that works with multiple kestrel instances intelligently.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/jnunemaker/twirl"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kjess
@@ -65,6 +65,7 @@ files:
 - lib/twirl/instrumenters/memory.rb
 - lib/twirl/instrumenters/noop.rb
 - lib/twirl/item.rb
+- lib/twirl/mirror.rb
 - lib/twirl/server.rb
 - lib/twirl/version.rb
 - script/bootstrap
@@ -80,10 +81,11 @@ files:
 - test/instrumenters/noop_test.rb
 - test/integration/cluster_test.rb
 - test/item_test.rb
+- test/mirror_test.rb
 - test/support/fake_udp_socket.rb
 - test/twirl_test.rb
 - twirl.gemspec
-homepage: ''
+homepage: https://github.com/jnunemaker/twirl
 licenses:
 - MIT
 post_install_message: 
@@ -117,5 +119,6 @@ test_files:
 - test/instrumenters/noop_test.rb
 - test/integration/cluster_test.rb
 - test/item_test.rb
+- test/mirror_test.rb
 - test/support/fake_udp_socket.rb
 - test/twirl_test.rb