interprocess_attribute 0.1.0

data/.pryrc

@@ -0,0 +1 @@
+require "./lib/interprocess_attribute"

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  # UNIXSocket#recvmsg is not implemented on Rubinius yet.
+  # - rbx-19mode
+
+notifications:
+  email: true 

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+group :default, :development do
+  gem 'rake'
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'pry'
+end
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    interprocess_attribute (0.1.0)
+      ichannel (~> 5.1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.8)
+    ichannel (5.1.1)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (10.0.3)
+    redcarpet (2.2.2)
+    slop (3.3.3)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  interprocess_attribute!
+  pry
+  rake
+  redcarpet
+  yard

data/README.md

@@ -0,0 +1,158 @@
+__OVERVIEW__
+
+
+| Project         | interprocess\_attribute    
+|:----------------|:--------------------------------------------------
+| Homepage        | https://github.com/robgleeson/interprocess_attribute
+| Documentation   | http://rubydoc.info/gems/interprocess_attribute/frames 
+| CI              | [![Build Status](https://travis-ci.org/robgleeson/interprocess_attribute.png)](https://travis-ci.org/robgleeson/ichannel)
+| Author          | Robert Gleeson             
+
+
+__DESCRIPTION__
+
+interprocess\_attribute persists attributes between processes. That's to say 
+you can change the 'name' attribute to "Rob" in the child process and see that 
+change propagate in the parent process with very little code.
+
+Attributes are defined through the `interprocess_attribute` method. It 
+behaves just like the `attr_accessor` method in that it defines a getter and 
+a setter. The difference is that attributes set through interprocess\_attribute
+persist between processes.
+
+__EXAMPLES__
+
+__1.__
+
+The example shows a simple scenario of how you might use interprocess\_attribute
+to persist the 'name' attribute among a parent process & a subprocess. A monkey
+patch on Class is used but it is opt-in and can be avoided if you really want.
+
+```ruby
+require "interprocess_attribute"
+require "interprocess_attribute/core_ext/class"
+class Person
+  interprocess_attribute :name  
+end
+
+person = Person.new
+pid = fork do
+  person.name = "Rob"
+end
+Process.wait pid
+p person.name # => "Rob"
+```
+
+__2.__
+
+Monkey-patching Class is not everybodys cup of tea, so in that case there is 
+a module you can use with extend(…).
+
+```ruby
+require "interprocess_attribute"
+class Person
+  extend InterProcessAttribute
+  interprocess_attribute :name
+  interprocess_attribute :age
+end
+
+person = Person.new
+pid = fork do
+  person.name = "Rob"
+  person.age = 27
+end
+Process.wait pid
+p person.name # => "Rob"
+p person.age # => 27
+```
+__3.__
+
+So far all these examples have defined public attributes but it might just be that
+you don't want to expose attributes at all, you could just want persistence, 
+and to compensate for that it is possible to mark attributes as private or 
+protected:
+
+```ruby
+class Person
+  extend InterProcessAttribute
+  interprocess_attribute :name, {visibility: :private}
+
+  def initialize
+    self.name = "Rob"
+  end
+end
+
+person = Person.new
+person.name = "John" # NoMethodError
+```
+
+__4.__
+
+The last example is a bit like inception: what happens when you fork inside a
+fork and both of those forks call a setter? The behavior for this case is to 
+discard all values but the last one to be set. For example, `person.name` will 
+be "Rob" here:
+
+```ruby
+class Person
+  extend InterProcessAttribute
+  interprocess_attribute :name
+end
+
+person = Person.new
+pid = fork do
+  person.name = "John"
+  pid = fork do
+    person.name = "Rob"
+  end
+  Process.wait pid
+end
+Process.wait pid
+p person.name # => "Rob"
+```
+
+__GOTCHAS__
+
+__1.__
+
+Methods that mutate the receiver won't have their changes persist between 
+processes. You must use the setter if you want persistence. For example:
+
+```ruby
+class Person
+  extend InterProcessAttribute
+  interprocess_attribute :name
+end
+
+person = Person.new
+person.name = "John"
+person.name.sub! /J/, "" # does not persist
+person.name = person.name.sub! /J/, "" # persists
+```
+
+__2.__
+
+The transport of Ruby objects happens through serialization and communication 
+on a UNIXSocket. The serializer being used is Marshal, and it can serialize 
+most Ruby objects but there is a few it can't, so be wary.
+
+__PLATFORM SUPPORT__
+
+_supported_
+
+  * CRuby (1.9+)
+
+_unsupported_
+  
+  * CRuby 1.8
+  * MacRuby
+  * JRuby
+  * Rubinius (support for Rubinius will come sometime in the future).
+
+__INSTALL__
+
+    $ gem install interprocess_attribute
+
+__LICENSE__
+
+MIT. See LICENSE.txt.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+desc 'Run the test suite.'
+task :test do
+  $LOAD_PATH.unshift 'lib'
+  Dir["test/*_test.rb"].each do |file|
+    require_relative file
+  end
+end
+task :default => :test

data/interprocess_attribute.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "interprocess_attribute"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Robert Gleeson"]
+  gem.email         = ["rob@flowof.info"]
+  gem.description   = %q{Attributes that persist between processes}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/robgleeson/interprocess_attribute"
+
+  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"]
+  gem.add_runtime_dependency 'ichannel', '~> 5.1.1'
+end

data/lib/interprocess_attribute/core_ext/class.rb

@@ -0,0 +1,3 @@
+class Class
+  include InterProcessAttribute
+end

data/lib/interprocess_attribute.rb

@@ -0,0 +1,43 @@
+require "ichannel"
+module InterProcessAttribute
+  #
+  # @param [#to_s] name
+  #   The name of the attribute.
+  #
+  # @param [Hash] opts
+  #   @option opts [#to_s] :visibility
+  #     "public", "protected", or "private"
+  #
+  # @example
+  #   class Person
+  #     extend InterProcessAttribute
+  #     interprocess_attribute :name, {visibility: :private}
+  #
+  #     def initialize
+  #       self.name = "Rob"
+  #     end
+  #   end
+  #
+  #   person = Person.new
+  #   person.name = "Rob"
+  #   p person.name # => "Rob"
+  #
+  def interprocess_attribute(name, opts = {visibility: "public"})
+    class_eval do
+      channel = IChannel.new Marshal
+      define_method name do
+        while channel.readable?
+          instance_variable_set "@#{name}", channel.get
+        end
+        instance_variable_get "@#{name}"
+      end
+      send opts[:visibility], name.to_sym
+
+      define_method "#{name}=" do |value|
+        channel.put value
+        instance_variable_set "@#{name}", value
+      end
+      send opts[:visibility], "#{name}=".to_sym
+    end
+  end
+end

data/test/interprocess_attribute_test.rb

@@ -0,0 +1,61 @@
+require_relative "setup"
+class InterProcessAttributeTest < Test::Unit::TestCase
+  class Person
+    interprocess_attribute :name
+    interprocess_attribute :age
+    interprocess_attribute :height, {visibility: :private}
+    interprocess_attribute :weight, {visibility: :protected}
+  end
+
+  def test_defaults
+    person = Person.new
+    assert_equal nil, person.name
+    assert_equal nil, person.age
+  end
+
+  def test_inception
+    person = Person.new
+    pid = fork do
+      person.name = "Rob"
+      pid = fork do
+        person.name = "John"
+      end
+      Process.wait pid
+    end
+    Process.wait pid
+    assert_equal "John", person.name
+  end
+
+  def test_persistence_to_parent
+    person = Person.new
+    pid = fork do
+      person.name = "Rob"
+      person.age = 27
+    end
+    Process.wait pid
+    assert_equal "Rob", person.name
+    assert_equal 27, person.age
+  end
+
+  def test_persistence_to_child
+    person = Person.new
+    person.name = "John"
+    pid = fork do
+      if person.name == "John"
+        person.name = true
+      end
+    end
+    Process.wait pid
+    assert_equal true, person.name
+  end
+
+  def test_visibility
+    is_public = Person.public_instance_methods.include? :name
+    assert is_public
+    is_private = Person.private_instance_methods.include? :height
+    assert is_private
+    is_protected = Person.protected_instance_methods.include? :weight
+    assert is_protected
+  end
+
+end

data/test/setup.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+require 'pry'
+require 'test/unit'
+require 'interprocess_attribute'
+require 'interprocess_attribute/core_ext/class'
+Dir["test/support/**/*.rb"].each do |file|
+  require "./#{file}"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: interprocess_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ichannel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+description: Attributes that persist between processes
+email:
+- rob@flowof.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .pryrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- interprocess_attribute.gemspec
+- lib/interprocess_attribute.rb
+- lib/interprocess_attribute/core_ext/class.rb
+- test/interprocess_attribute_test.rb
+- test/setup.rb
+homepage: https://github.com/robgleeson/interprocess_attribute
+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'
+      segments:
+      - 0
+      hash: 3577632575707106316
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3577632575707106316
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Attributes that persist between processes
+test_files:
+- test/interprocess_attribute_test.rb
+- test/setup.rb
+has_rdoc: