zchannel 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 649b93103c675d5dfa973d8951dc11179815045b
-  data.tar.gz: 8abcb7c009b2e86e41246daf914442e7eb09a53c
+  metadata.gz: 1ddefd25411898f9e157391b0024f2c20dc481f1
+  data.tar.gz: 00821b76dbee39af1210d7fe6d09b4eee3c4df46
 SHA512:
-  metadata.gz: b66421c435e26cb6ad0f8023becaeac8b70518655401c4f501b80db464f2106a7fda73b9866c1a23507bcf9c0582173fb4d5479b25346fea5a41515389d2dfd2
-  data.tar.gz: 83171424257774572cc16bddf0093c2ef517dc6b1062f941c7127d2c4016b98b66bfd6779fffa9c579561eef7680ba7493b447cbe7947001097057e6bd766731
+  metadata.gz: 16c44b7dd8784fc7313db3136498c1ded8f61c41a5ef2843b63a9ae273e1aa53474f882fc166344131dae445966d0af626e16ff12f1bf46b27f990440654d689
+  data.tar.gz: 835f2f8b041dd696880281c50beca1a5c69478da550e28082fd12b34d7ed61c9b88228c9e3396228d62d9b5afcb1a0171beda458bca537384cf551919b797f1e

data/.travis.yml

@@ -1,17 +1,13 @@
+script: ruby -S rake
+
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - rbx-19mode
-# - ruby-head
+  - 2.2
+  - ruby-head
 
 env:
-  - REDIS=1 SERIALIZER=YAML
-  - REDIS=1 SERIALIZER=Marshal
-  - REDIS=1 SERIALIZER=JSON
-
-services:
-  - redis-server
+  - SERIALIZER=YAML
+  - SERIALIZER=Marshal
+  - SERIALIZER=JSON
 
 notifications:
-  email: true 
+  email: true

data/.yardopts

@@ -1,5 +1,3 @@
 -m markdown -M redcarpet
 -
 README.md
-LICENSE.txt
-ChangeLog.txt

data/Gemfile

@@ -1,3 +1,7 @@
 source 'http://rubygems.org'
 gemspec
 gem "test-unit"
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+end

data/README.md

@@ -1,12 +1,15 @@
+[![Build Status](https://travis-ci.org/jazzonmymind/zchannel.rb.svg?branch=master)](https://travis-ci.org/jazzonmymind/zchannel.rb)
+[![Code Climate](https://codeclimate.com/github/jazzonmymind/zchannel.rb/badges/gpa.svg)](https://codeclimate.com/github/jazzonmymind/zchannel.rb)
+
 __zchannel__
 
 zchannel is a library that assists with InterProcess Communication, or
 IPC for short. It provides a high level and easy to use API for sending
-Ruby objects between processes that are running on the same machine.
-A channel is implemented on top of an unbound UNIXSocket, and objects
-are serialized with a serializer of your choosing although the examples
-use the "Marshal" serializer, which is available without any extra
-dependencies.
+Ruby objects between processes that are running on the same machine and
+who have a parent-child relationship. A channel is implemented on top of an
+unbound UNIXSocket. Objects are serialized on write and deserialized on
+read using a serializer of your choice. The examples use the "Marshal"
+serializer, which is available without any extra dependencies.
 
 __Examples__
 

data/lib/zchannel/unix_socket.rb

@@ -1,10 +1,10 @@
 require 'socket'
 class ZChannel::UNIXSocket
-  SEP = '_$_'  if respond_to? :private_constant
+  SEP = "\x00"  if respond_to? :private_constant
 
   #
   # @param [#dump,#load] serializer
-  #   An object who implements `.dump` and `.load` methods
+  #   Any object that implements "dump" and "load" methods.
   #
   # @return [ZChannel::UNIXSocket]
   #
@@ -16,20 +16,18 @@ class ZChannel::UNIXSocket
 
   #
   # @return [Boolean]
-  #   Returns true when a channel is closed
+  #   Returns true when a channel is closed.
   #
   def closed?
     @reader.closed? and @writer.closed?
   end
 
-  #
-  # Close the channel
   #
   # @raise [IOError]
-  #   When a channel is already closed
+  #   Raises IOError when a channel is already closed.
   #
   # @return [Boolean]
-  #   Returns true on success
+  #   Returns true when a channel is closed successfully.
   #
   def close
     if closed?
@@ -41,29 +39,34 @@ class ZChannel::UNIXSocket
     end
   end
 
+  #
+  # Perform a blocking write.
   #
   # @raise [IOError]
   #   (see #send!)
   #
   # @param [Object] object
-  #   An object to add to a channel
+  #   An object to write to a channel.
   #
   def send(object)
     send!(object, nil)
   end
+  alias_method :write, :send
 
   #
-  # @param
-  #   (see ZChannel::UNIXSocket#send)
+  # Perform a write with a timeout.
+  #
+  # @param [Object] object
+  #   An object to write to a channel.
   #
-  # @param [Fixnum] timeout
-  #   Number of seconds to wait before raising an exception
+  # @param [Float, Fixnum] timeout
+  #   The number of seconds to wait before raising an exception.
   #
   # @raise [IOError]
-  #   When channel is closed
+  #   Raises an IOError when a channel is closed.
   #
   # @raise [ZChannel::TimeoutError]
-  #   When a write doesn't finish within the timeout
+  #   Raises a ZChannel::TimeoutError when a write doesn't finish within the specified timeout.
   #
   def send!(object, timeout = 0.1)
     if @writer.closed?
@@ -77,30 +80,32 @@ class ZChannel::UNIXSocket
       raise ZChannel::TimeoutError, "timeout, waited #{timeout} seconds"
     end
   end
+  alias_method :write!, :send!
 
   #
-  # Perform a blocking read
+  # Perform a blocking read.
   #
   # @raise
-  #   (see ZChannel::UNIXSocket#recv)
+  #   (see ZChannel::UNIXSocket#recv!)
   #
   # @return [Object]
   #
   def recv
     recv!(nil)
   end
+  alias_method :read, :recv
 
   #
-  # Perform a read with a timeout
+  # Perform a read with a timeout.
   #
-  # @param [Fixnum] timeout
-  #   Number of seconds to wait before raising an exception
+  # @param [Float, Fixnum] timeout
+  #   The number of seconds to wait before raising an exception.
   #
   # @raise [IOError]
-  #   When channel is closed
+  #   Raises an IOError when a channel is closed.
   #
   # @raise [ZChannel::TimeoutError]
-  #   When a read doesn't finish within the timeout
+  #   Raises ZChannel::TimeoutError when a read doesn't finish within the specified timeout.
   #
   # @return [Object]
   #
@@ -116,9 +121,12 @@ class ZChannel::UNIXSocket
       raise ZChannel::TimeoutError, "timeout, waited #{timeout} seconds"
     end
   end
+  alias_method :read!, :recv!
 
   #
   # @return [Object]
+  #   Reads from a channel until there are no messages left, and
+  #   then returns the last read message.
   #
   def last_msg
     @last_msg = recv while readable?
@@ -127,6 +135,7 @@ class ZChannel::UNIXSocket
 
   #
   # @return [Boolean]
+  #   Returns true when a channel has messages waiting to be read.
   #
   def readable?
     if closed?

data/lib/zchannel/version.rb

@@ -1,3 +1,3 @@
 module ZChannel
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/setup.rb

@@ -1,3 +1,5 @@
 require 'bundler/setup'
 require 'test/unit'
+require 'json'
+require 'yaml'
 Bundler.require :default, :test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zchannel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - jazzonmymind
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies: []
 description: Provides a high level and easy to use API for sending objects between
   Ruby processes
@@ -57,4 +57,3 @@ specification_version: 4
 summary: Provides a high level and easy to use API for sending objects between Ruby
   processes
 test_files: []
-has_rdoc: