redic 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 764359a897686829a6256da74c6cb9b09431c145
-  data.tar.gz: 326b89336c17823309e87f0892c674d1d3162649
+  metadata.gz: 1c3cb18b1fbaf7287872bb80f00dcf56ea80c876
+  data.tar.gz: f73a0f93ee0b747238614d6eefca1272b1df6e94
 SHA512:
-  metadata.gz: b15177f76ea1af68c1dd3b18689310df67d2ab867034df7e0039607236c283c5dff4e29189d1bc43c8e7989ced9a9a1bd502611cd5cdc9b1c84ac61b86244e79
-  data.tar.gz: ebd8fbb06218eff075bed70ffa38ef0b8c48a444c7e41189ba097cadf9ee10f53ce3f7234b7a946f296ab9f79737959a541f06f64c77416fcfc324343984efdc
+  metadata.gz: 5e1b59a35e39d75d09443205e334d55d18c00093de1902a807eb85989dd17ca898c8e6e6964dc25d688c522503739dc250ad5ff1a3c8a706d2df784dbf236cb7
+  data.tar.gz: c0f0d5cc628053da0b59b434168141a3789b642a6098ddc88dd067acfa35662f824a4f7001538141eea69c750a1679f2ff31df0c0099c53fa21e57f4202eb091

data/README.md

@@ -13,7 +13,7 @@ library for golang.
 ## Usage
 
 ```ruby
-# Accepts the same options as Redis.new
+# Accepts a Redis URL and defaults to "redis://127.0.0.1:6379".
 redis = Redic.new
 
 # Processes the command and returns the response.
@@ -23,12 +23,61 @@ assert_equal "bar", redis.call("GET", "foo")
 
 # Pipelining is implemented by buffering commands,
 # then calling Redic#run
-redis.write("SET", "foo", "bar")
-redis.write("GET", "foo")
+redis.pipe("SET", "foo", "bar")
+redis.pipe("GET", "foo")
 
 assert_equal ["OK", "bar"], redis.run
 ```
 
+## Differences with redis-rb
+
+Redic uses [hiredis][hiredis] for the connection and for parsing
+the replies. There are no alternative connection drivers. Unlike
+[redis-rb][redis-rb] it doesn't define all the Redis commands, and
+instead it acts as a transport layer. The lock provided is smaller
+than that of redis-rb, as it only wraps the writing and reading from
+the connection. So even if both clients are thread-safe by default,
+the peformance of a smaller lock is marginally better.
+
+## Limitations
+
+When a client enters a subscribed mode, further reads to retrieve the
+messages are not thread safe. It is very important to take this into
+account and to create a different client if you need to send different
+operations while a client is subscribed to a channel.
+
+```ruby
+# Example of pub/sub usage.
+c1 = Redic.new
+c2 = Redic.new
+
+# After this command, the client is no longer thread safe.
+c1.call("SUBSCRIBE", "foo")
+
+# That's why we need to publish from a different connection.
+c2.call("PUBLISH", "foo")
+
+# Note that this operation is not thread safe.
+assert_equal ["message", "foo", "value1"], c1.client.read
+```
+
+You can wrap thread unsafe operations in a mutex:
+
+```ruby
+redis = Redic.new
+
+mutex = Mutex.new
+
+mutex.synchronize do
+  redis.call("MONITOR")
+
+  # Display every command sent to Redis.
+  loop do
+    puts redis.client.read
+  end
+end
+```
+
 ## Installation
 
 You can install it using rubygems.

data/lib/redic.rb

@@ -2,11 +2,12 @@ require "redic/client"
 
 class Redic
   attr :url
+  attr :client
 
   def initialize(url = "redis://127.0.0.1:6379")
     @url = url
     @client = Redic::Client.new(url)
-    @buffer = []
+    @queue = []
   end
 
   def call(*args)
@@ -16,21 +17,21 @@ class Redic
     end
   end
 
-  def write(*args)
-    @buffer << args
+  def queue(*args)
+    @queue << args
   end
 
-  def run
+  def commit
     @client.connect do
-      @buffer.each do |args|
+      @queue.each do |args|
         @client.write(args)
       end
 
-      @buffer.map do
+      @queue.map do
         @client.read
       end
     end
   ensure
-    @buffer.clear
+    @queue.clear
   end
 end

data/makefile

@@ -1,2 +1,2 @@
-build:
-	RUBYLIB=./lib cutest test/*.rb
+test:
+	RUBYLIB=./lib cutest tests/*.rb

data/redic.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "redic"
-  s.version           = "0.0.4"
+  s.version           = "0.0.5"
   s.summary           = "Lightweight Redis Client"
   s.description       = "Lightweight Redis Client"
   s.authors           = ["Michel Martens", "Cyril David"]

data/tests/redic_test.rb

@@ -0,0 +1,118 @@
+require File.expand_path("../lib/redic", File.dirname(__FILE__))
+
+REDIS_URL = "redis://localhost:6379/3"
+
+prepare do
+  Redic.new(REDIS_URL).call("FLUSHDB")
+end
+
+setup do
+  Redic.new(REDIS_URL)
+end
+
+test "url" do |c|
+  assert_equal "redis://localhost:6379/3", c.url
+end
+
+test "normal commands" do |c|
+  c.call("SET", "foo", "bar")
+
+  assert_equal "bar", c.call("GET", "foo")
+end
+
+test "pipelining" do |c|
+  c.queue("SET", "foo", "bar")
+  c.queue("GET", "foo")
+
+  assert_equal ["OK", "bar"], c.commit
+end
+
+test "multi/exec" do |c|
+  c.queue("MULTI")
+  c.queue("SET", "foo", "bar")
+  c.queue("EXEC")
+
+  assert_equal ["OK", "QUEUED", ["OK"]], c.commit
+end
+
+test "runtime errors" do |c|
+  res = c.call("KABLAMMO")
+
+  assert res.is_a?(RuntimeError)
+end
+
+test "encoding" do |c|
+  Encoding.default_external = "UTF-8"
+
+  c.call("SET", "foo", "שלום")
+
+  assert_equal "Shalom שלום", "Shalom " + c.call("GET", "foo")
+
+end if defined?(Encoding)
+
+test "errors in pipeline" do |c|
+  c.queue("SET", "foo", "bar")
+  c.queue("INCR", "foo")
+  c.queue("GET", "foo")
+
+  res = c.commit
+
+  assert "OK" == res[0]
+  assert RuntimeError === res[1]
+  assert "bar" == res[2]
+end
+
+test "thread safety" do |c|
+  c.call("SET", "foo", 1)
+  c.call("SET", "bar", 2)
+
+  foos, bars = nil, nil
+
+  t1 = Thread.new do
+    foos = Array.new(100) { c.call("GET", "foo") }
+  end
+
+  t2 = Thread.new do
+    bars = Array.new(100) { c.call("GET", "bar") }
+  end
+
+  t1.join
+  t2.join
+
+  assert_equal ["1"], foos.uniq
+  assert_equal ["2"], bars.uniq
+end
+
+test "blocking commands" do |c1|
+  c2 = Redic.new
+  r = nil
+
+  t1 = Thread.new do
+    r = c1.call("BLPOP", "foo", 5)
+  end
+
+  t2 = Thread.new do
+    c2.call("RPUSH", "foo", "value")
+  end
+
+  t1.join
+  t2.join
+
+  assert_equal ["foo", "value"], r
+end
+
+test "pub/sub" do |c1|
+  c2 = Redic.new
+
+  assert_equal ["subscribe", "foo", 1], c1.call("SUBSCRIBE", "foo")
+
+  c2.call("PUBLISH", "foo", "value1")
+  c2.call("PUBLISH", "foo", "value2")
+
+  assert_equal ["message", "foo", "value1"], c1.client.read
+  assert_equal ["message", "foo", "value2"], c1.client.read
+
+  c1.call("UNSUBSCRIBE", "foo")
+
+  assert_equal "PONG", c1.call("PING")
+end

data/{test → tests}/unix_test.rb

@@ -11,16 +11,16 @@ test "normal commands" do |c|
 end
 
 test "pipelining" do |c|
-  c.write("SET", "foo", "bar")
-  c.write("GET", "foo")
+  c.queue("SET", "foo", "bar")
+  c.queue("GET", "foo")
 
-  assert_equal ["OK", "bar"], c.run
+  assert_equal ["OK", "bar"], c.commit
 end
 
 test "multi/exec" do |c|
-  c.write("MULTI")
-  c.write("SET", "foo", "bar")
-  c.write("EXEC")
+  c.queue("MULTI")
+  c.queue("SET", "foo", "bar")
+  c.queue("EXEC")
 
-  assert_equal ["OK", "QUEUED", ["OK"]], c.run
+  assert_equal ["OK", "QUEUED", ["OK"]], c.commit
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redic
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Michel Martens
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis
@@ -42,8 +42,8 @@ files:
 - lib/redic/connection.rb
 - makefile
 - redic.gemspec
-- test/redic_test.rb
-- test/unix_test.rb
+- tests/redic_test.rb
+- tests/unix_test.rb
 homepage: https://github.com/amakawa/redic
 licenses:
 - MIT

data/test/redic_test.rb

@@ -1,78 +0,0 @@
-require File.expand_path("../lib/redic", File.dirname(__FILE__))
-
-setup do
-  Redic.new
-end
-
-test "url" do |c|
-  assert_equal "redis://127.0.0.1:6379", c.url
-end
-
-test "normal commands" do |c|
-  c.call("SET", "foo", "bar")
-
-  assert_equal "bar", c.call("GET", "foo")
-end
-
-test "pipelining" do |c|
-  c.write("SET", "foo", "bar")
-  c.write("GET", "foo")
-
-  assert_equal ["OK", "bar"], c.run
-end
-
-test "multi/exec" do |c|
-  c.write("MULTI")
-  c.write("SET", "foo", "bar")
-  c.write("EXEC")
-
-  assert_equal ["OK", "QUEUED", ["OK"]], c.run
-end
-
-test "runtime errors" do |c|
-  res = c.call("KABLAMMO")
-
-  assert res.is_a?(RuntimeError)
-end
-
-test "encoding" do |c|
-  Encoding.default_external = "UTF-8"
-
-  c.call("SET", "foo", "שלום")
-
-  assert_equal "Shalom שלום", "Shalom " + c.call("GET", "foo")
-
-end if defined?(Encoding)
-
-test "errors in pipeline" do |c|
-  c.write("SET", "foo", "bar")
-  c.write("INCR", "foo")
-  c.write("GET", "foo")
-
-  res = c.run
-
-  assert "OK" == res[0]
-  assert RuntimeError === res[1]
-  assert "bar" == res[2]
-end
-
-test "thread safety" do |c|
-  c.call("SET", "foo", 1)
-  c.call("SET", "bar", 2)
-
-  foos, bars = nil, nil
-
-  t1 = Thread.new do
-    foos = Array.new(100) { c.call("GET", "foo") }
-  end
-
-  t2 = Thread.new do
-    bars = Array.new(100) { c.call("GET", "bar") }
-  end
-
-  t1.join
-  t2.join
-
-  assert_equal ["1"], foos.uniq
-  assert_equal ["2"], bars.uniq
-end