posix_mq 0.8.0pre → 1.0.0

data/ChangeLog

@@ -1,5 +1,92 @@
 ChangeLog from http://bogomips.org/ruby_posix_mq.git
 
+   commit 90b66d0a4390e7794247d43b49160a50a9028caa
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Tue Mar 1 09:07:05 2011 +0000
+   
+       posix_mq 1.0.0 - kinder, gentler message queues
+       
+       There is one backwards-incompatible API change:
+       
+         POSIX_MQ#send returns +true+ on success instead of +nil+
+         for consistency with POSIX_MQ#trysend.
+       
+       This release adds the POSIX_MQ#trysend, POSIX_MQ#tryreceive and
+       POSIX_MQ#tryshift interfaces to avoid exceptions on common
+       EAGAIN errors for users of non-blocking queues.
+       
+       Bugfixes: non-blocking behavior changes to a shared descriptor
+       in a different process are reflected immediately in the child
+       (this won't fix race conditions in your code, however).
+       Minor bugfixes for posix-mq-rb(1) and quieted warnings for
+       1.9.3dev.
+   
+   commit c44a8335b2f7ff60cf74730ac697a5e00829cc66
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Tue Mar 1 08:57:16 2011 +0000
+   
+       make methods that should be private, private
+       
+       So private we won't mention them in the commit message!
+   
+   commit c885c2d30b69925f6dd9f36e74c247e650db327b
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Tue Mar 1 08:52:34 2011 +0000
+   
+       remove unused tryinit function
+       
+       Something I considered but decided wasn't worth doing.
+   
+   commit d64ac2686c3c1ff1eea4534100dca8fd73228a62
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Tue Mar 1 08:51:28 2011 +0000
+   
+       POSIX_MQ#send returns +true+ on success
+       
+       This is to be consistent with POSIX_MQ#trysend
+   
+   commit ae1acbcc32aef9efd23daed0611e2919aa0e5037
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Tue Mar 1 08:40:44 2011 +0000
+   
+       finalize try* interfaces
+       
+       Consider them good enough for a 1.0.0 release
+   
+   commit a589cb81d02ce77fa7c7a027328a2cf714878773
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Sun Feb 27 11:43:28 2011 +0000
+   
+       posix-mq-rb: always prefer write-in-full behavior
+       
+       In case somebody made the receiving pipe non-blocking,
+       we want the command-line tool to succeed.
+   
+   commit 89c26cdaf25463c891a8ce915fefa1a181b3ac64
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Sun Feb 27 11:40:40 2011 +0000
+   
+       fix warnings and enable them for tests
+       
+       Cleaner code anyways.
+   
+   commit 5af56c9047dae680bde185c8a2b82de03b63e032
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Sun Feb 27 11:37:23 2011 +0000
+   
+       posix-mq-rb: use IO#binmode to get binary IOs
+       
+       Avoids warnings this way
+   
+   commit 316a435ff6c5b1bd9e0298aee096d16fb015405d
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Sun Feb 27 11:27:51 2011 +0000
+   
+       doc: note that the try* interfaces are not final
+       
+       But they'll be pushed to the site for greater
+       visibility.
+   
    commit 330846614470a64f34b671852ce4bf0f789aeb62
    Author: Eric Wong <normalperson@yhbt.net>
    Date:   Sun Feb 27 11:11:19 2011 +0000

data/GIT-VERSION-FILE

@@ -1 +1 @@
-GIT_VERSION = 0.8.0pre
+GIT_VERSION = 1.0.0

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v0.8.0pre.GIT
+DEF_VER=v1.0.0.GIT
 
 LF='
 '

data/LATEST

@@ -1,25 +1,17 @@
-=== posix_mq 0.8.0pre - kinder, gentler and less exceptional / 2011-02-27 11:13 UTC
+=== posix_mq 1.0.0 - kinder, gentler message queues / 2011-03-01 09:17 UTC
 
-  This adds trysend, tryreceive, and tryshift interfaces to avoid
-  exceptions on common EAGAIN errors for non-blocking users.  EAGAIN
-  during non-blocking messages is common when there are multiple
-  readers/writer threads/processes working on the same queue.
+  There is one backwards-incompatible API change:
 
-  trysend is like send, except it returns true for success and false for
-  EAGAIN.  send (still) returns nil, which I now consider a mistake but
-  won't change until post-1.0...
+    POSIX_MQ#send returns +true+ on success instead of +nil+
+    for consistency with POSIX_MQ#trysend.
 
-  tryreceive and tryshift are like receive and shift respectively,
-  but they return nil for EAGAIN and the same return values
-  for their non-shift variants.
+  This release adds the POSIX_MQ#trysend, POSIX_MQ#tryreceive and
+  POSIX_MQ#tryshift interfaces to avoid exceptions on common
+  EAGAIN errors for users of non-blocking queues.
 
-  None of these methods call mq_setattr() beforehand to set the
-  non-blocking flag, it assumes the user set it once before they were ever
-  called and never changes it.  Checking/setting the non-blocking flag
-  every time is needless overhead and still subject to race conditions if
-  multiple processes/queues keep flipping flag on the same queue
-  descriptor.
-
-  These interfaces are not yet final, feedback is appreciated
-  at ruby.posix.mq@librelist.org.
+  Bugfixes: non-blocking behavior changes to a shared descriptor
+  in a different process are reflected immediately in the child
+  (this won't fix race conditions in your code, however).
+  Minor bugfixes for posix-mq-rb(1) and quieted warnings for
+  1.9.3dev.
 

data/NEWS

@@ -1,3 +1,20 @@
+=== posix_mq 1.0.0 - kinder, gentler message queues / 2011-03-01 09:17 UTC
+
+  There is one backwards-incompatible API change:
+
+    POSIX_MQ#send returns +true+ on success instead of +nil+
+    for consistency with POSIX_MQ#trysend.
+
+  This release adds the POSIX_MQ#trysend, POSIX_MQ#tryreceive and
+  POSIX_MQ#tryshift interfaces to avoid exceptions on common
+  EAGAIN errors for users of non-blocking queues.
+
+  Bugfixes: non-blocking behavior changes to a shared descriptor
+  in a different process are reflected immediately in the child
+  (this won't fix race conditions in your code, however).
+  Minor bugfixes for posix-mq-rb(1) and quieted warnings for
+  1.9.3dev.
+
 === posix_mq 0.8.0pre - kinder, gentler and less exceptional / 2011-02-27 11:13 UTC
 
   This adds trysend, tryreceive, and tryshift interfaces to avoid

data/bin/posix-mq-rb

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
 # -*- encoding: binary -*-
-Encoding.default_external = Encoding::BINARY if defined?(Encoding)
 $stderr.sync = $stdout.sync = true
+$stdout.binmode
+$stderr.binmode
+$stdin.binmode
 
 require 'posix_mq'
 require 'optparse'
@@ -70,7 +72,7 @@ ARGV.options do |x|
       }
     end
   end
-  x.on('-q', "quiet warnings and errors") { $stderr.reopen("/dev/null", "w") }
+  x.on('-q', "quiet warnings and errors") { $stderr.reopen("/dev/null", "wb") }
   x.on('-h', '--help', 'Show this help message.') { puts x; exit }
   x.parse!
 end
@@ -99,14 +101,14 @@ begin
     exit
   when :receive
     buf, prio = mq.receive("", timeout)
-    $stderr.syswrite("priority=#{prio}\n") if priority
-    $stdout.syswrite(buf)
+    $stderr.write("priority=#{prio}\n") if priority
+    $stdout.write(buf)
   when :send
     ARGV << $stdin.read if ARGV.empty?
     ARGV.each { |msg| mq.send(msg, priority, timeout) }
   when :attr
     mq_attr = mq.attr
-    $stdout.syswrite(
+    $stdout.write(
       "flags=#{mq_attr.flags}\n" \
       "maxmsg=#{mq_attr.maxmsg}\n" \
       "msgsize=#{mq_attr.msgsize}\n" \

data/ext/posix_mq/posix_mq.c

@@ -509,9 +509,10 @@ static void setup_send_buffer(struct rw_args *x, VALUE buffer)
 }
 
 static VALUE _send(int sflags, int argc, VALUE *argv, VALUE self);
+
 /*
  * call-seq:
- *	mq.send(string [,priority[, timeout]])	=> nil
+ *	mq.send(string [,priority[, timeout]])	=> true
  *
  * Inserts the given +string+ into the message queue with an optional,
  * unsigned integer +priority+.  If the optional +timeout+ is specified,
@@ -524,7 +525,7 @@ static VALUE _send(int sflags, int argc, VALUE *argv, VALUE self);
  */
 static VALUE my_send(int argc, VALUE *argv, VALUE self)
 {
-	_send(0, argc, argv, self);
+	return _send(0, argc, argv, self);
 }
 
 static VALUE _send(int sflags, int argc, VALUE *argv, VALUE self)
@@ -549,7 +550,7 @@ static VALUE _send(int sflags, int argc, VALUE *argv, VALUE self)
 		rb_sys_fail("mq_send");
 	}
 
-	return (sflags & PMQ_TRY) ? Qtrue : Qnil;
+	return Qtrue;
 }
 
 /*
@@ -558,6 +559,10 @@ static VALUE _send(int sflags, int argc, VALUE *argv, VALUE self)
  *
  * Inserts the given +string+ into the message queue with a
  * default priority of 0 and no timeout.
+ *
+ * Returns itself so its calls may be chained.  This use is only
+ * recommended only for users who expect blocking behavior from
+ * the queue.
  */
 static VALUE send0(VALUE self, VALUE buffer)
 {
@@ -983,21 +988,14 @@ static VALUE setnonblock(VALUE self, VALUE nb)
 	return nb;
 }
 
-static VALUE tryinit(int argc, VALUE *argv, VALUE self)
-{
-	init(argc, argv, self);
-	setnonblock(self, Qtrue);
-
-	return self;
-}
-
 /*
  * call-seq:
  *	mq.trysend(string [,priority[, timeout]]) => +true+ or +false+
  *
  * Exactly like POSIX_MQ#send, except it returns +false+ instead of raising
- * +Errno::EAGAIN+ when non-blocking operation is desired and returns +true+
+ * Errno::EAGAIN when non-blocking operation is desired and returns +true+
  * on success instead of +nil+.
+ *
  * This does not guarantee non-blocking behavior, the message queue must
  * be made non-blocking before calling this method.
  */
@@ -1011,7 +1009,7 @@ static VALUE trysend(int argc, VALUE *argv, VALUE self)
  *	mq.tryshift([buffer [, timeout]])	=> message or nil
  *
  * Exactly like POSIX_MQ#shift, except it returns +nil+ instead of raising
- * +Errno::EAGAIN+ when non-blocking operation is desired.
+ * Errno::EAGAIN when non-blocking operation is desired.
  *
  * This does not guarantee non-blocking behavior, the message queue must
  * be made non-blocking before calling this method.
@@ -1026,7 +1024,7 @@ static VALUE tryshift(int argc, VALUE *argv, VALUE self)
  *	mq.tryreceive([buffer [, timeout]])	=> [ message, priority ] or nil
  *
  * Exactly like POSIX_MQ#receive, except it returns +nil+ instead of raising
- * +Errno::EAGAIN+ when non-blocking operation is desired.
+ * Errno::EAGAIN when non-blocking operation is desired.
  *
  * This does not guarantee non-blocking behavior, the message queue must
  * be made non-blocking before calling this method.
@@ -1062,7 +1060,7 @@ void Init_posix_mq_ext(void)
 
 	rb_define_singleton_method(cPOSIX_MQ, "unlink", s_unlink, 1);
 
-	rb_define_method(cPOSIX_MQ, "initialize", init, -1);
+	rb_define_private_method(cPOSIX_MQ, "initialize", init, -1);
 	rb_define_method(cPOSIX_MQ, "send", my_send, -1);
 	rb_define_method(cPOSIX_MQ, "<<", send0, 1);
 	rb_define_method(cPOSIX_MQ, "trysend", trysend, -1);
@@ -1078,8 +1076,8 @@ void Init_posix_mq_ext(void)
 	rb_define_method(cPOSIX_MQ, "name", name, 0);
 	rb_define_method(cPOSIX_MQ, "notify=", setnotify, 1);
 	rb_define_method(cPOSIX_MQ, "nonblock=", setnonblock, 1);
-	rb_define_method(cPOSIX_MQ, "notify_exec", setnotify_exec, 2);
-	rb_define_method(cPOSIX_MQ, "notify_cleanup", notify_cleanup, 0);
+	rb_define_private_method(cPOSIX_MQ, "notify_exec", setnotify_exec, 2);
+	rb_define_private_method(cPOSIX_MQ, "notify_cleanup", notify_cleanup, 0);
 	rb_define_method(cPOSIX_MQ, "nonblock?", nonblock_p, 0);
 #ifdef MQD_TO_FD
 	rb_define_method(cPOSIX_MQ, "to_io", to_io, 0);

data/lib/posix_mq.rb

@@ -51,16 +51,16 @@ class POSIX_MQ
     block.arity == 1 or
       raise ArgumentError, "arity of notify block must be 1"
     r, w = IO.pipe
-    self.notify_exec(w, Thread.new(r, w, self) do |r, w, mq|
+    notify_exec(w, Thread.new(block) do |blk|
       begin
         begin
           r.read(1) or raise Errno::EINTR
         rescue Errno::EINTR, Errno::EAGAIN
           retry
         end
-        block.call(mq)
+        blk.call(self)
       ensure
-        mq.notify_cleanup
+        notify_cleanup
         r.close rescue nil
         w.close rescue nil
       end

data/test/test_posix_mq.rb

@@ -1,6 +1,5 @@
 # -*- encoding: binary -*-
 require 'test/unit'
-require 'posix_mq'
 require 'thread'
 require 'fcntl'
 $stderr.sync = $stdout.sync = true
@@ -9,6 +8,8 @@ begin
   require "dl/func"
 rescue LoadError
 end
+$-w = true
+require 'posix_mq'
 
 class Test_POSIX_MQ < Test::Unit::TestCase
 
@@ -154,7 +155,7 @@ class Test_POSIX_MQ < Test::Unit::TestCase
       @mq = mq
       assert mq.kind_of?(POSIX_MQ)
       assert_equal @path, mq.name
-      assert_nil mq.send("HI", 0)
+      assert_equal true, mq.send("HI", 0)
       assert_equal 1, mq.attr.curmsgs
       assert_nil mq.close
       assert_raises(IOError) { mq.close }
@@ -207,21 +208,21 @@ class Test_POSIX_MQ < Test::Unit::TestCase
 
   def test_send_receive
     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
-    assert_nil @mq.send("hello", 0)
+    assert_equal true, @mq.send("hello", 0)
     assert_equal [ "hello", 0 ], @mq.receive
   end
 
   def test_send_receive_buf
     buf = ""
     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
-    assert_nil @mq.send("hello", 0)
+    assert_equal true, @mq.send("hello", 0)
     assert_equal [ "hello", 0 ], @mq.receive(buf)
     assert_equal "hello", buf
   end
 
   def test_send_receive_prio
     @mq = POSIX_MQ.new @path, IO::CREAT|IO::RDWR, 0666
-    assert_nil @mq.send("hello", 2)
+    assert_equal true, @mq.send("hello", 2)
     assert_equal [ "hello", 2 ], @mq.receive
   end
 
@@ -402,7 +403,7 @@ class Test_POSIX_MQ < Test::Unit::TestCase
   end if POSIX_MQ.method_defined?(:notify)
 
   def test_bad_open_mode
-    assert_raises(ArgumentError) { mq = POSIX_MQ.new(@path, "rw") }
+    assert_raises(ArgumentError) { POSIX_MQ.new(@path, "rw") }
   end
 
   def test_bad_open_attr

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: posix_mq
 version: !ruby/object:Gem::Version 
-  hash: 961915908
-  prerelease: 5
+  hash: 23
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 8
   - 0
-  - pre
-  version: 0.8.0pre
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ruby POSIX MQ hackers
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 +00:00
+date: 2011-03-01 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,14 +102,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: qrp