chattyproc 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.rspec

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chattyproc.gemspec
+gemspec
+
+gem "rake"
+gem "rspec"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alan Johnson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Chattyproc
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chattyproc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chattyproc
+
+## Usage
+
+Right now ChattyProc only includes a single process communication method - a pipe server. The idea behind the pipe server is that a process can communicate back and forth with processes that it forks. Here's a quick example:
+
+    require "chattyproc"
+		
+		# Set up the pipe server
+		ps = ChattyProc::PipeServer.new
+		
+		# Fork a new process
+		fork do
+			# Mark this process as the callee
+			ps.callee!
+			
+			message = ps.read
+			ps.write("Hello #{message}")
+		end
+		
+		# Mark this process as the caller
+		ps.caller!
+		
+		# Send a message over to the other process
+		ps.write("Alan")
+		
+		# Print the response
+		response = ps.read
+		
+		# Wait for the child process to exit
+		Process.waitall
+		
+This style of pipe server is in use in [tconsole](http://github.com/commondream/tconsole) and has worked amazingly well. It's faster than DRb for communication between forked processes, and has shown itself to be less error prone.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/chattyproc.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chattyproc/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "chattyproc"
+  gem.version       = ChattyProc::VERSION
+  gem.authors       = ["Alan Johnson"]
+  gem.email         = ["alan@commondream.net"]
+  gem.description   = %q{Library for communicating between forked processes.}
+  gem.summary       = %q{Library for communicating between forked processes.}
+  gem.homepage      = "http://github.com/commondream/chattyproc"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/chattyproc.rb

@@ -0,0 +1,51 @@
+require "chattyproc/version"
+
+module ChattyProc
+  class PipeServer
+
+    # Public: Sets up a new PipeServer
+    def initialize
+      @callee = []
+      @caller = []
+      @callee[0], @caller[1] = IO.pipe
+      @caller[0], @callee[1] = IO.pipe
+
+      @me = nil
+    end
+
+    # Public: Identifies the current process as the callee process
+    def callee!
+      @me = @callee
+
+      @caller.each do |io|
+        io.close
+      end
+    end
+
+    # Public: Identifies the current process as the caller process
+    def caller!
+      @me = @caller
+
+      @callee.each do |io|
+        io.close
+      end
+    end
+
+    # Public: Writes a message to the appropriate pipe. The message can be
+    # anything that will Marshal cleanly.
+    def write(message)
+      encoded_message = [Marshal.dump(message)].pack("m0")
+      @me[1].puts(encoded_message)
+    end
+
+    # Public: Reads a message from the appropriate pipe and unmarshalls it
+    def read
+      raw_message = @me[0].gets
+
+      return nil if raw_message.nil?
+
+      Marshal.load(raw_message.unpack("m")[0])
+    end
+  end
+
+end

data/lib/chattyproc/version.rb

@@ -0,0 +1,3 @@
+module ChattyProc
+  VERSION = "1.0.0"
+end

data/spec/pipe_server_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe ChattyProc::PipeServer do
+  before do
+    @ps = ChattyProc::PipeServer.new
+  end
+
+  it "can send and respond to messages" do
+    test_message = "This is a test"
+    fork do
+      @ps.callee!
+
+      message = @ps.read
+      @ps.write(message)
+    end
+
+    @ps.caller!
+    @ps.write(test_message)
+    response = @ps.read
+
+    expect(response).to eq(test_message)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "rubygems"
+require "bundler/setup"
+
+require "chattyproc"

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: chattyproc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Alan Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies: []
+description: Library for communicating between forked processes.
+email:
+- alan@commondream.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chattyproc.gemspec
+- lib/chattyproc.rb
+- lib/chattyproc/version.rb
+- spec/pipe_server_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/commondream/chattyproc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Library for communicating between forked processes.
+test_files:
+- spec/pipe_server_spec.rb
+- spec/spec_helper.rb
+has_rdoc: