hiredis 0.2.0 → 0.3.0

data/Rakefile

@@ -1,57 +1,11 @@
 require 'rake'
-require 'rake/gempackagetask'
 require 'rake/testtask'
-
-gem 'rake-compiler', '~> 0.7.1'
 require "rake/extensiontask"
 
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
-require 'hiredis/version'
-
-GEM = 'hiredis'
-GEM_VERSION = Hiredis::VERSION
-AUTHORS = ['Pieter Noordhuis']
-EMAIL = "pcnoordhuis@gmail.com"
-HOMEPAGE = "http://github.com/pietern/hiredis-rb"
-SUMMARY = "Ruby extension that wraps Hiredis (blocking connection and reply parsing)"
-
-spec = Gem::Specification.new do |s|
-  s.name = GEM
-  s.version = GEM_VERSION
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["COPYING"]
-  s.summary = SUMMARY
-  s.description = s.summary
-  s.authors = AUTHORS
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
-  s.require_path = 'lib'
-  s.extensions = FileList["ext/**/extconf.rb"]
-
-  ext_files = Dir.glob("ext/**/*.{rb,c,h}")
-  lib_files = Dir.glob("lib/**/*.rb")
-  hiredis_files = Dir.glob("vendor/hiredis/*.{c,h}") -
-        Dir.glob("vendor/hiredis/example*") +
-        Dir.glob("vendor/hiredis/COPYING") +
-        Dir.glob("vendor/hiredis/Makefile")
-  s.files = %w(COPYING Rakefile) + ext_files + lib_files + hiredis_files
-
-  s.add_runtime_dependency "rake-compiler", "~> 0.7.1"
-  s.add_runtime_dependency "redis", "~> 2.1.1"
-end
-
-desc "create a gemspec file"
-task :gemspec do
-  File.open("#{GEM}.gemspec", "w") do |file|
-    file.puts spec.to_ruby
-  end
-end
-
 Rake::ExtensionTask.new('hiredis_ext') do |task|
   # Pass --with-foo-config args to extconf.rb
   task.config_options = ARGV[1..-1]
-  task.lib_dir = File.join(*['lib', 'hiredis'])
+  task.lib_dir = File.join(*['lib', 'hiredis', 'ext'])
 end
 
 namespace :hiredis do

data/ext/hiredis_ext/connection.c

@@ -28,24 +28,43 @@ static void parent_context_free(redisParentContext *pc) {
     free(pc);
 }
 
+static void parent_context_raise(redisParentContext *pc) {
+    int err;
+    char errstr[1024];
+
+    /* Copy error and free context */
+    err = pc->context->err;
+    snprintf(errstr,sizeof(errstr),"%s",pc->context->errstr);
+    parent_context_try_free(pc);
+
+    switch(err) {
+    case REDIS_ERR_IO:
+        /* Raise native Ruby I/O error */
+        rb_sys_fail(0);
+        break;
+    case REDIS_ERR_EOF:
+        /* Raise our own EOF error */
+        rb_raise(error_eof,"%s",errstr);
+        break;
+    default:
+        /* Raise something else */
+        rb_raise(rb_eRuntimeError,"%s",errstr);
+    }
+}
+
 static VALUE connection_parent_context_alloc(VALUE klass) {
     redisParentContext *pc = malloc(sizeof(*pc));
     pc->context = NULL;
     return Data_Wrap_Struct(klass, parent_context_mark, parent_context_free, pc);
 }
 
-static VALUE connection_connect(VALUE self, VALUE _host, VALUE _port) {
+static VALUE connection_generic_connect(VALUE self, redisContext *c) {
     redisParentContext *pc;
-    redisContext *c;
-    char *host = StringValuePtr(_host);
-    int port = NUM2INT(_port);
     int err;
     char errstr[1024];
 
     Data_Get_Struct(self,redisParentContext,pc);
-    parent_context_try_free(pc);
 
-    c = redisConnect(host,port);
     if (c->err) {
         /* Copy error and free context */
         err = c->err;
@@ -66,6 +85,79 @@ static VALUE connection_connect(VALUE self, VALUE _host, VALUE _port) {
     return Qnil;
 }
 
+static struct timeval __timeout_from_robj(VALUE usecs) {
+    int s = NUM2INT(usecs)/1000000;
+    int us = NUM2INT(usecs)-(s*1000000);
+    struct timeval timeout = { s, us };
+    return timeout;
+}
+
+static VALUE connection_connect(int argc, VALUE *argv, VALUE self) {
+    redisParentContext *pc;
+    redisContext *c;
+    VALUE *_host = NULL;
+    VALUE *_port = NULL;
+    VALUE *_timeout = NULL;
+    char *host;
+    int port;
+    struct timeval timeout;
+
+    if (argc == 2 || argc == 3) {
+        _host = &argv[0];
+        _port = &argv[1];
+        if (argc == 3)
+            _timeout = &argv[2];
+    } else {
+        rb_raise(rb_eArgError, "invalid number of arguments");
+        return Qnil;
+    }
+
+    Data_Get_Struct(self,redisParentContext,pc);
+    parent_context_try_free(pc);
+
+    host = StringValuePtr(*_host);
+    port = NUM2INT(*_port);
+    if (_timeout != NULL) {
+        timeout = __timeout_from_robj(*_timeout);
+        c = redisConnectWithTimeout(host,port,timeout);
+    } else {
+        c = redisConnect(host,port);
+    }
+
+    return connection_generic_connect(self,c);
+}
+
+static VALUE connection_connect_unix(int argc, VALUE *argv, VALUE self) {
+    redisParentContext *pc;
+    redisContext *c;
+    VALUE *_path = NULL;
+    VALUE *_timeout = NULL;
+    char *path;
+    struct timeval timeout;
+
+    if (argc == 1 || argc == 2) {
+        _path = &argv[0];
+        if (argc == 2)
+            _timeout = &argv[1];
+    } else {
+        rb_raise(rb_eArgError, "invalid number of arguments");
+        return Qnil;
+    }
+
+    Data_Get_Struct(self,redisParentContext,pc);
+    parent_context_try_free(pc);
+
+    path = StringValuePtr(*_path);
+    if (_timeout != NULL) {
+        timeout = __timeout_from_robj(*_timeout);
+        c = redisConnectUnixWithTimeout(path,timeout);
+    } else {
+        c = redisConnectUnix(path);
+    }
+
+    return connection_generic_connect(self,c);
+}
+
 static VALUE connection_is_connected(VALUE self) {
     redisParentContext *pc;
     Data_Get_Struct(self,redisParentContext,pc);
@@ -145,33 +237,13 @@ static int __get_reply(redisParentContext *pc, VALUE *reply) {
 static VALUE connection_read(VALUE self) {
     redisParentContext *pc;
     VALUE reply;
-    int err;
-    char errstr[1024];
 
     Data_Get_Struct(self,redisParentContext,pc);
     if (!pc->context)
         rb_raise(rb_eRuntimeError, "not connected");
 
-    if (__get_reply(pc,&reply) == -1) {
-        /* Copy error and free context */
-        err = pc->context->err;
-        snprintf(errstr,sizeof(errstr),"%s",pc->context->errstr);
-        parent_context_try_free(pc);
-
-        switch(err) {
-        case REDIS_ERR_IO:
-            /* Raise native Ruby I/O error */
-            rb_sys_fail(0);
-            break;
-        case REDIS_ERR_EOF:
-            /* Raise our own EOF error */
-            rb_raise(error_eof,"%s",errstr);
-            break;
-        default:
-            /* Raise something else */
-            rb_raise(rb_eRuntimeError,"%s",errstr);
-        }
-    }
+    if (__get_reply(pc,&reply) == -1)
+        parent_context_raise(pc);
 
     return reply;
 }
@@ -181,17 +253,13 @@ static VALUE connection_set_timeout(VALUE self, VALUE usecs) {
     int s = NUM2INT(usecs)/1000000;
     int us = NUM2INT(usecs)-(s*1000000);
     struct timeval timeout = { s, us };
-    char errstr[1024];
 
     Data_Get_Struct(self,redisParentContext,pc);
     if (!pc->context)
         rb_raise(rb_eRuntimeError, "not connected");
 
-    if (redisSetTimeout(pc->context,timeout) == REDIS_ERR) {
-        snprintf(errstr,sizeof(errstr),"%s",pc->context->errstr);
-        parent_context_try_free(pc);
-        rb_raise(rb_eRuntimeError,"%s",errstr);
-    }
+    if (redisSetTimeout(pc->context,timeout) == REDIS_ERR)
+        parent_context_raise(pc);
 
     return usecs;
 }
@@ -202,7 +270,8 @@ VALUE error_eof;
 void InitConnection(VALUE mod) {
     klass_connection = rb_define_class_under(mod, "Connection", rb_cObject);
     rb_define_alloc_func(klass_connection, connection_parent_context_alloc);
-    rb_define_method(klass_connection, "connect", connection_connect, 2);
+    rb_define_method(klass_connection, "connect", connection_connect, -1);
+    rb_define_method(klass_connection, "connect_unix", connection_connect_unix, -1);
     rb_define_method(klass_connection, "connected?", connection_is_connected, 0);
     rb_define_method(klass_connection, "disconnect", connection_disconnect, 0);
     rb_define_method(klass_connection, "timeout=", connection_set_timeout, 1);

data/ext/hiredis_ext/extconf.rb

@@ -18,4 +18,4 @@ system("cd #{bundled_hiredis_dir} && make static") if File.directory?(bundled_hi
 
 need_header('hiredis.h')
 need_library('hiredis', 'redisReplyReaderCreate')
-create_makefile('hiredis/hiredis_ext')
+create_makefile('hiredis/ext/hiredis_ext')

data/ext/hiredis_ext/hiredis_ext.c

@@ -4,8 +4,10 @@
 #include "hiredis_ext.h"
 
 VALUE mod_hiredis;
+VALUE mod_ext;
 void Init_hiredis_ext() {
     mod_hiredis = rb_define_module("Hiredis");
-    InitReader(mod_hiredis);
-    InitConnection(mod_hiredis);
+    mod_ext = rb_define_module_under(mod_hiredis,"Ext");
+    InitReader(mod_ext);
+    InitConnection(mod_ext);
 }

data/ext/hiredis_ext/hiredis_ext.h

@@ -10,7 +10,6 @@ extern VALUE mod_hiredis;
 /* Defined in reader.c */
 extern redisReplyObjectFunctions redisExtReplyObjectFunctions;
 extern VALUE klass_reader;
-extern ID ivar_hiredis_error; /* ivar used to store error reply ("-ERR message") */
 extern void InitReader(VALUE module);
 
 /* Defined in connection.c */

data/ext/hiredis_ext/reader.c

@@ -6,9 +6,6 @@ static VALUE enc_klass;
 static ID enc_default_external = 0;
 static ID str_force_encoding = 0;
 
-/* Singleton method to test if the reply contains an error. */
-ID ivar_hiredis_error;
-
 /* Add VALUE to parent when the redisReadTask has a parent.
  * Note that the parent should always be of type T_ARRAY. */
 static void *tryParentize(const redisReadTask *task, VALUE v) {
@@ -20,10 +17,6 @@ static void *tryParentize(const redisReadTask *task, VALUE v) {
     return (void*)v;
 }
 
-static VALUE object_contains_error(VALUE self) {
-    return Qtrue;
-}
-
 static void *createStringObject(const redisReadTask *task, char *str, size_t len) {
     VALUE v, enc;
     v = rb_str_new(str,len);
@@ -36,17 +29,6 @@ static void *createStringObject(const redisReadTask *task, char *str, size_t len
 
     if (task->type == REDIS_REPLY_ERROR) {
         v = rb_funcall(rb_eRuntimeError,rb_intern("new"),1,v);
-        rb_ivar_set(v,ivar_hiredis_error,v);
-
-        if (task && task->parent != NULL) {
-            /* Also make the parent respond to this method. Redis currently
-             * only emits nested multi bulks of depth 2, so we don't need
-             * to cascade setting this ivar. Make sure to only set the first
-             * error reply on the parent. */
-            VALUE parent = (VALUE)task->parent->obj;
-            if (!rb_ivar_defined(parent,ivar_hiredis_error))
-                rb_ivar_set(parent,ivar_hiredis_error,v);
-        }
     }
 
     return tryParentize(task,v);
@@ -93,7 +75,6 @@ static VALUE reader_allocate(VALUE klass) {
 
 static VALUE reader_feed(VALUE klass, VALUE str) {
     void *reader;
-    unsigned int size;
 
     if (TYPE(str) != T_STRING)
         rb_raise(rb_eTypeError, "not a string");
@@ -122,7 +103,6 @@ void InitReader(VALUE mod) {
     rb_define_alloc_func(klass_reader, reader_allocate);
     rb_define_method(klass_reader, "feed", reader_feed, 1);
     rb_define_method(klass_reader, "gets", reader_gets, 0);
-    ivar_hiredis_error = rb_intern("@__hiredis_error");
 
     /* If the Encoding class is present, #default_external should be used to
      * determine the encoding for new strings. The "enc_default_external"

data/lib/hiredis.rb

@@ -1,10 +1,2 @@
-require 'hiredis/version'
-require 'hiredis/connection'
-
-# Make redis-rb use the Hiredis Connection class
-class Redis
-  Connection = ::Hiredis::Connection
-end
-
-# Load redis
-require 'redis'
+require "hiredis/version"
+require "hiredis/connection"

data/lib/hiredis/connection.rb

@@ -1,17 +1,10 @@
-require 'hiredis/hiredis_ext'
-
 module Hiredis
-  class Connection
-    # Raise CONNRESET on EOF
-    alias :_read :read
-    def read
-      reply = _read
-      error = reply.instance_variable_get(:@__hiredis_error)
-      raise error if error
-
-      reply
-    rescue EOFError
-      raise Errno::ECONNRESET
-    end
+  begin
+    require "hiredis/ext/connection"
+    Connection = Ext::Connection
+  rescue LoadError
+    warn "WARNING: could not load hiredis extension, using (slower) pure Ruby implementation."
+    require "hiredis/ruby/connection"
+    Connection = Ruby::Connection
   end
 end

data/lib/hiredis/ext/connection.rb

@@ -0,0 +1,16 @@
+require "hiredis/ext/hiredis_ext"
+require "hiredis/version"
+
+module Hiredis
+  module Ext
+    class Connection
+      # Raise CONNRESET on EOF
+      alias :_read :read
+      def read
+        _read
+      rescue EOFError
+        raise Errno::ECONNRESET
+      end
+    end
+  end
+end

data/lib/hiredis/ext/reader.rb

@@ -0,0 +1,2 @@
+require "hiredis/ext/hiredis_ext"
+require "hiredis/version"

data/lib/hiredis/reader.rb

@@ -1 +1,10 @@
-require 'hiredis/hiredis_ext'
+module Hiredis
+  begin
+    require "hiredis/ext/reader"
+    Reader = Ext::Reader
+  rescue LoadError
+    warn "WARNING: could not load hiredis extension, using (slower) pure Ruby implementation."
+    require "hiredis/ruby/reader"
+    Reader = Ruby::Reader
+  end
+end

data/lib/hiredis/ruby/connection.rb

@@ -0,0 +1,113 @@
+require "socket"
+require "timeout"
+require "hiredis/ruby/reader"
+require "hiredis/version"
+
+module Hiredis
+  module Ruby
+    class Connection
+
+      def initialize
+        @sock = nil
+      end
+
+      def connected?
+        !! @sock
+      end
+
+      def connect(host, port, usecs = 0)
+        @reader = ::Hiredis::Ruby::Reader.new
+
+        begin
+          begin
+            Timeout.timeout(usecs.to_f / 1_000_000) do
+              @sock = TCPSocket.new(host, port)
+              @sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+            end
+          rescue Timeout::Error
+            raise Errno::ETIMEDOUT
+          end
+        rescue SocketError => error
+          # Raise RuntimeError when host cannot be resolved
+          if error.message.start_with?("getaddrinfo:")
+            raise error.message
+          else
+            raise error
+          end
+        end
+      end
+
+      def connect_unix(path, usecs = 0)
+        @reader = ::Hiredis::Ruby::Reader.new
+
+        begin
+          Timeout.timeout(usecs.to_f / 1_000_000) do
+            @sock = UNIXSocket.new(path)
+          end
+        rescue Timeout::Error
+          raise Errno::ETIMEDOUT
+        end
+      end
+
+      def disconnect
+        @sock.close
+      rescue
+      ensure
+        @sock = nil
+      end
+
+      def timeout=(usecs)
+        raise "not connected" unless connected?
+
+        secs   = Integer(usecs / 1_000_000)
+        usecs  = Integer(usecs - (secs * 1_000_000)) # 0 - 999_999
+
+        optval = [secs, usecs].pack("l_2")
+
+        begin
+          @sock.setsockopt Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval
+          @sock.setsockopt Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval
+        rescue Errno::ENOPROTOOPT
+        end
+      end
+
+      COMMAND_DELIMITER = "\r\n".freeze
+
+      def write(args)
+        command = []
+        command << "*#{args.size}"
+        args.each do |arg|
+          arg = arg.to_s
+          command << "$#{string_size arg}"
+          command << arg
+        end
+
+        @sock.syswrite(command.join(COMMAND_DELIMITER) + COMMAND_DELIMITER)
+      end
+
+      def read
+        raise "not connected" unless connected?
+
+        while (reply = @reader.gets) == false
+          @reader.feed @sock.sysread(1024)
+        end
+
+        reply
+      rescue EOFError
+        raise Errno::ECONNRESET
+      end
+
+    protected
+
+      if "".respond_to?(:bytesize)
+        def string_size(string)
+          string.to_s.bytesize
+        end
+      else
+        def string_size(string)
+          string.to_s.size
+        end
+      end
+    end
+  end
+end