ffi-rzmq 2.0.1 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4e271f6dc0fcbad07111b4b23c969f192eb6d57
-  data.tar.gz: d5a508626d471997f3568646cd05a95a70ad19f1
+  metadata.gz: 691dd239d1036375a2f06806953e89e7674d6c19
+  data.tar.gz: 74f1929b8be63e5d38b884e24a6bacab02fe90e9
 SHA512:
-  metadata.gz: 72b0886538590486c2e8c64e4e03eeab7259c39a9720b0ae763f7c4d0e149cda5926ddbc1710b39ecbf4cfeee0f348d1c85e1816c437764ac99becb7be784286
-  data.tar.gz: 0ca81c180fb1a7a8c7dd7767f7200589ec91fb42553c49eac03a2b91c5e51a95f002c64503e2d79fe77cee74adb0331a9adda1107ffd498effaa10ce2b471f01
+  metadata.gz: e78fb2755c2325b4de8fe3922d8c14b45a1171488ab26897c868f72e7b233b755ba1eb44bdacbd6ee4023d4228f9e57718bf86a0cf1cf427d3fb04b480d8876d
+  data.tar.gz: 3bc7c5bfb8d9212959a41fb8e7a00d3f73873fe5e8d68abded9f20aa182d4b6cd4d74a7d6d7e14030e5d66e5ef191cf22f1614cdffc217cc523df1cc17f91a66

data/History.txt

@@ -1,3 +1,24 @@
+== 2.0.4
+  * Screwed up the release managment. Had wrong version in version.rb. Fixed.
+  
+== 2.0.3
+  * Updated specs to use RSpec 3.x syntax. Never again... if they change it
+    then I'm dumping rspec.
+    
+  * Now loading version.rb during startup so that ZMQ::VERSION returns a string.
+  
+  * Modified README to point most people to the Ruby gem that wraps the CZMQ
+    library. It's a much higher-level library that makes writing zeromq apps
+    very easy. This gem is for writing low-level code which most people don't
+    want or need to do. This gem is going into maintenance mode only.
+  
+
+== 2.0.2 
+
+  * Updated README to make it clearer which versions of libzmq are supported.
+  
+  * Updated README to use a newer example.
+
 == 2.0.1 / 20140122
   * Fix setsockopt with string parameters for options that have very strict
     requirements (like CURVE_SECRETKEY) (37aed3c)

data/README.rdoc

@@ -2,6 +2,22 @@ ffi-rzmq
     by Chuck Remes
     http://www.zeromq.org/bindings:ruby-ffi
 
+== FUTURE SUPPORT
+
+Most people writing Zeromq applications in Ruby should be using the rbczmq
+project. It wraps the CZMQ binding which is a much higher-level library
+for writing Zeromq code. Find the Ruby gem here:
+
+    http://github.com/methodmissing/rbczmq
+    
+Few projects need to write the low-level zeromq code that this gem allows.
+With the release of ffi-rzmq 2.0.3, this library is going into permanent 
+maintenance mode. As new versions of libzmq are released, interested parties
+should send pull requests to this project or its related project
+ffi-rzmq-core to support new features.
+
+The original README text follows...
+
 == DESCRIPTION:
 
 This gem wraps the ZeroMQ networking library using the ruby FFI (foreign
@@ -9,11 +25,18 @@ function interface). It's a pure ruby wrapper so this gem can be loaded
 and run by any ruby runtime that supports FFI. That's all of them:
 MRI 1.9.x, Rubinius and JRuby.
 
-This single gem supports 0mq 2.2.x and 3.2.x 0mq APIs. The 0mq project started
+The Ruby API provided by this gem is *NOT* very Ruby-like. It very closely
+tracks the libzmq C API. However, the contributors to this project have
+done all of the hard work to wrap up all of libzmq and make it accessible
+from Ruby. If you want it to be more Ruby-like (e.g. raise Exceptions instead
+of returning integer codes) then *wrap this library* with your own and release
+it as a gem. We will all be grateful!
+
+This single gem supports 0mq 3.2.x and 4.x APIs. The 0mq project started
 making backward-incompatible changes to the API with the 3.1.x release.
 The gem auto-configures itself to expose the API conforming to the loaded
-C library. 0mq API 3.0 is *not* supported; the 0mq community voted to
-abandon it.
+C library. 0mq 2.x is no longer supported. 0mq API 3.0 is *not* supported; 
+the 0mq community voted to abandon it.
 
 The impetus behind this library was to provide support for ZeroMQ in
 JRuby which has native threads. Unlike MRI, which has a GIL, JRuby and
@@ -36,7 +59,7 @@ than using a C extension.
 == FEATURES/PROBLEMS:
 
 This gem needs more tests. This gem has been battle tested by myself
-and others for over a year, so I am fairly confident that it is solid.
+and others for years, so I am fairly confident that it is solid.
 However, it is inevitable that there will be bugs, so please open
 issues for them here or fork this project, fix them, and send me a pull
 request.
@@ -56,62 +79,71 @@ All features are implemented.
 
 == SYNOPSIS:
 
-0mq API v2 client code:
+0mq API v3.2-4 client code:
 
   require 'rubygems'
   require 'ffi-rzmq'
 
   if ARGV.length < 3
-    puts "usage: local_lat <connect-to> <message-size> <roundtrip-count>"
+    puts "usage: ruby local_lat.rb <connect-to> <message-size> <roundtrip-count>"
     exit
   end
-
+  
   bind_to = ARGV[0]
   message_size = ARGV[1].to_i
   roundtrip_count = ARGV[2].to_i
 
   ctx = ZMQ::Context.new
-  s = ctx.socket ZMQ::REP
-  rc = s.setsockopt(ZMQ::HWM, 100)
-  rc = s.bind(bind_to)
+  s   = ctx.socket ZMQ::REP
+  rc  = s.setsockopt(ZMQ::SNDHWM, 100)
+  rc  = s.setsockopt(ZMQ::RCVHWM, 100)
+  rc  = s.bind(bind_to)
 
-  msg = ""
   roundtrip_count.times do
-    rc = s.recv_string msg
+    msg = ""
+    rc  = s.recv_string msg
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
-    rc = s.send_string msg, 0
+    rc  = s.send_string msg, 0
   end
 
-
-0mq API v2 server code:
+0mq API v3.2-4 server code:
 
   require 'rubygems'
   require 'ffi-rzmq'
 
   if ARGV.length < 3
-    puts "usage: remote_lat <connect-to> <message-size> <roundtrip-count>"
+    puts "usage: ruby remote_lat.rb <connect-to> <message-size> <roundtrip-count>"
     exit
   end
-
+  
+  def assert(rc)
+    raise "Last API call failed at #{caller(1)}" unless rc >= 0
+  end
+  
   connect_to = ARGV[0]
   message_size = ARGV[1].to_i
   roundtrip_count = ARGV[2].to_i
 
   ctx = ZMQ::Context.new
-  s = ctx.socket ZMQ::REQ
-  rc = s.connect(connect_to)
+  s   = ctx.socket ZMQ::REQ
+  rc  = s.connect(connect_to)
 
   msg = "#{ '3' * message_size }"
 
-  start_time = Time.now
+  time_start = Time.now
 
-  msg = ""
   roundtrip_count.times do
-    rc = s.send_string msg, 0
-    rc = s.recv_string msg
+    assert(s.send_string(msg, 0))
+  
+    msg = ''
+    assert(s.recv_string(msg, 0))
+  
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
   end
 
+  time_end = Time.now
+  puts "Time #{( time_end - time_start )}"
+
 == Better Examples
 
 I highly recommend visiting the Learn Ruby 0mq project for a bunch of good code examples.
@@ -139,7 +171,7 @@ It will crash randomly and you will be sad.
 
 == INSTALL:
 
-Make sure the ZeroMQ library is already installed on your system.
+Make sure the ZeroMQ library is already installed on your system. We recommend 'brew' or 'macports' to get it.
 
  % gem install ffi-rzmq # should grab the latest release
 

data/Rakefile

@@ -4,3 +4,18 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
 task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'ffi-rzmq'
+  ARGV.clear
+  IRB.start
+end
+
+task :pryconsole do
+  require 'pry'
+  require 'ffi-rzmq'
+  ARGV.clear
+  Pry.start
+end

data/lib/ffi-rzmq.rb

@@ -66,6 +66,6 @@ end  # module ZMQ
 require 'ffi-rzmq-core'
 
 # the order of files is important
-%w(util exceptions context message socket poll_items poll_item poll device).each do |file|
+%w(util exceptions context message socket poll_items poll_item poll device version).each do |file|
   require ZMQ.libpath(['ffi-rzmq', file])
 end

data/lib/ffi-rzmq/version.rb

@@ -1,3 +1,3 @@
 module ZMQ
-  VERSION = "2.0.1"
+  VERSION = "2.0.4"
 end

data/spec/context_spec.rb

@@ -11,31 +11,31 @@ module ZMQ
       include APIHelper
 
       it "should return nil for negative io threads" do
-        Context.create(-1).should be_nil
+        expect(Context.create(-1)).to eq(nil)
       end
       
       it "should default to requesting 1 i/o thread when no argument is passed" do
         ctx = Context.create
-        ctx.io_threads.should == 1
+        expect(ctx.io_threads).to eq(1)
       end
 
       it "should set the :pointer accessor to non-nil" do
         ctx = Context.create
-        ctx.pointer.should_not be_nil
+        expect(ctx.pointer).not_to be_nil
       end
 
       it "should set the :context accessor to non-nil" do
         ctx = Context.create
-        ctx.context.should_not be_nil
+        expect(ctx.context).not_to be_nil
       end
 
       it "should set the :pointer and :context accessors to the same value" do
         ctx = Context.create
-        ctx.pointer.should == ctx.context
+        expect(ctx.pointer).to eq(ctx.context)
       end
       
       it "should define a finalizer on this object" do
-        ObjectSpace.should_receive(:define_finalizer)
+        expect(ObjectSpace).to receive(:define_finalizer)
         ctx = Context.create
       end
     end # context initializing
@@ -45,31 +45,31 @@ module ZMQ
       include APIHelper
 
       it "should raise a ContextError exception for negative io threads" do
-        lambda { Context.new(-1) }.should raise_exception(ZMQ::ContextError)
+        expect { Context.new(-1) }.to raise_exception(ZMQ::ContextError)
       end
       
       it "should default to requesting 1 i/o thread when no argument is passed" do
         ctx = Context.new
-        ctx.io_threads.should == 1
+        expect(ctx.io_threads).to eq(1)
       end
 
       it "should set the :pointer accessor to non-nil" do
         ctx = Context.new
-        ctx.pointer.should_not be_nil
+        expect(ctx.pointer).not_to be_nil
       end
 
       it "should set the :context accessor to non-nil" do
         ctx = Context.new
-        ctx.context.should_not be_nil
+        expect(ctx.context).not_to be_nil
       end
 
       it "should set the :pointer and :context accessors to the same value" do
         ctx = Context.new
-        ctx.pointer.should == ctx.context
+        expect(ctx.pointer).to eq(ctx.context)
       end
       
       it "should define a finalizer on this object" do
-        ObjectSpace.should_receive(:define_finalizer)
+        expect(ObjectSpace).to receive(:define_finalizer)
         Context.new 1
       end
     end # context initializing
@@ -79,13 +79,13 @@ module ZMQ
       it "should set the context to nil when terminating the library's context" do
         ctx = Context.new # can't use a shared context here because we are terminating it!
         ctx.terminate
-        ctx.pointer.should be_nil
+        expect(ctx.pointer).to be_nil
       end
       
       it "should call the correct library function to terminate the context" do
         ctx = Context.new
 
-        LibZMQ.should_receive(:zmq_ctx_destroy).with(ctx.pointer).and_return(0)
+        expect(LibZMQ).to receive(:zmq_ctx_destroy).with(ctx.pointer).and_return(0)
         ctx.terminate
       end
     end # context terminate
@@ -94,8 +94,8 @@ module ZMQ
     context "when allocating a socket" do
       it "should return nil when allocation fails" do
         ctx = Context.new
-        LibZMQ.stub(:zmq_socket => nil)
-        ctx.socket(ZMQ::REQ).should be_nil
+        allow(LibZMQ).to receive(:zmq_socket).and_return(nil)
+        expect(ctx.socket(ZMQ::REQ)).to be_nil
       end
     end # context socket
 

data/spec/device_spec.rb

@@ -63,16 +63,16 @@ module ZMQ
 
       res = ''
       rc = puller.recv_string(res, ZMQ::DONTWAIT)
-      res.should == "hello"
+      expect(res).to eq("hello")
 
       pusher.close
       puller.close
     end
 
     it "should raise an ArgumentError when trying to pass non-socket objects into the device" do
-      lambda {
+      expect {
         Device.new(1,2)
-      }.should raise_exception(ArgumentError)
+      }.to raise_exception(ArgumentError)
     end
   end
 end

data/spec/message_spec.rb

@@ -9,12 +9,12 @@ module ZMQ
     context "when initializing with an argument" do
 
       it "calls zmq_msg_init_data()" do
-        LibZMQ.should_receive(:zmq_msg_init_data)
+        expect(LibZMQ).to receive(:zmq_msg_init_data)
         message = Message.new "text"
       end
 
       it "should *not* define a finalizer on this object" do
-        ObjectSpace.should_not_receive(:define_finalizer)
+        expect(ObjectSpace).not_to receive(:define_finalizer)
         Message.new "text"
       end
     end # context initializing with arg
@@ -22,12 +22,12 @@ module ZMQ
     context "when initializing *without* an argument" do
 
       it "calls zmq_msg_init()" do
-        LibZMQ.should_receive(:zmq_msg_init).and_return(0)
+        expect(LibZMQ).to receive(:zmq_msg_init).and_return(0)
         message = Message.new
       end
 
       it "should *not* define a finalizer on this object" do
-        ObjectSpace.should_not_receive(:define_finalizer)
+        expect(ObjectSpace).not_to receive(:define_finalizer)
         Message.new "text"
       end
     end # context initializing with arg
@@ -37,14 +37,14 @@ module ZMQ
       it "calls zmq_msg_init_data()" do
         message = Message.new "text"
 
-        LibZMQ.should_receive(:zmq_msg_init_data)
+        expect(LibZMQ).to receive(:zmq_msg_init_data)
         message.copy_in_string("new text")
       end
 
       it "correctly finds the length of binary data by ignoring encoding" do
         message = Message.new
         message.copy_in_string("\x83\x6e\x04\x00\x00\x44\xd1\x81")
-        message.size.should == 8
+        expect(message.size).to eq(8)
       end
     end
 
@@ -54,7 +54,7 @@ module ZMQ
         message = Message.new "text"
         copy = Message.new
 
-        LibZMQ.should_receive(:zmq_msg_copy)
+        expect(LibZMQ).to receive(:zmq_msg_copy)
         copy.copy(message)
       end
     end # context copy
@@ -65,7 +65,7 @@ module ZMQ
         message = Message.new "text"
         copy = Message.new
 
-        LibZMQ.should_receive(:zmq_msg_move)
+        expect(LibZMQ).to receive(:zmq_msg_move)
         copy.move(message)
       end
     end # context move
@@ -75,7 +75,7 @@ module ZMQ
       it "calls zmq_msg_size()" do
         message = Message.new "text"
 
-        LibZMQ.should_receive(:zmq_msg_size)
+        expect(LibZMQ).to receive(:zmq_msg_size)
         message.size
       end
     end # context size
@@ -85,7 +85,7 @@ module ZMQ
       it "calls zmq_msg_data()" do
         message = Message.new "text"
 
-        LibZMQ.should_receive(:zmq_msg_data)
+        expect(LibZMQ).to receive(:zmq_msg_data)
         message.data
       end
     end # context data
@@ -95,7 +95,7 @@ module ZMQ
       it "calls zmq_msg_close() the first time" do
         message = Message.new "text"
 
-        LibZMQ.should_receive(:zmq_msg_close)
+        expect(LibZMQ).to receive(:zmq_msg_close)
         message.close
       end
 
@@ -103,7 +103,7 @@ module ZMQ
         message = Message.new "text"
         message.close
 
-        LibZMQ.should_not_receive(:zmq_msg_close)
+        expect(LibZMQ).not_to receive(:zmq_msg_close)
         message.close
       end
     end # context close
@@ -116,7 +116,7 @@ module ZMQ
     context "when initializing with an argument" do
 
       it "should define a finalizer on this object" do
-        ObjectSpace.should_receive(:define_finalizer)
+        expect(ObjectSpace).to receive(:define_finalizer)
         ManagedMessage.new "text"
       end
     end # context initializing