letterbox 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ecf23c81ad7a2ac948f6edae443c34bc3cf7308
+  data.tar.gz: 6b9a922d23fb715ff34f729ac3738f1521f9df8f
+SHA512:
+  metadata.gz: c61dd0d80333f89d8485b24b491dfcdf0f78dd0933d0420c27b70cfcf3d69184bef5a4350ae96d1c30acaf55c77f260508957bb846cc6effff36f13653eae3aa
+  data.tar.gz: 2496e1beee3debd2e3a9b0ac8399e91cde000ff95e1d778e87c3eade851ba8ac9ac427e5f4e3a8a3774e568d461e5ba98defa5cc320a8b1fce44db5507850247

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Craig Little
+
+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,61 @@
+# Letterbox
+
+A short-lived actor framework using Celluloid.
+
+## Installation
+
+With Bundler:
+```ruby
+gem 'letterbox'
+```
+
+Otherwise:
+```ruby
+gem install letterbox
+```
+
+## Usage
+
+When instantiating a `Letterbox::Exchange` you must provide a class
+that will do the work. The work class' constructor should accept one
+argument (the "payload") and implement a `perform` method that performs
+the desired work.
+
+You can send work to a particular address by specifying a payload and
+the address that should do the work. All work sent to a particular
+address will be processed serially.
+
+Work spread across multiple mailboxes will be processed concurrently.
+
+Empty addresses are cleaned up automatically once there is no more work
+to be done.
+
+```ruby
+module MyWork
+
+  attr_reader :payload
+
+  def initialize(payload)
+    @payload = payload
+  end
+
+  def perform
+    sleep rand
+    puts "Working on: #{payload}"
+  end
+
+end
+
+e = Letterbox::Exchange.new(MyWork)
+
+# spread 100 units of work across 10 addresses
+100.times { |i| e.dispatch("payload #{i}", "a#{i % 10}") }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/letterbox/fork )
+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 a new Pull Request

data/Rakefile

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

data/letterbox.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path('../lib/letterbox/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'letterbox'
+  spec.version       = Letterbox::VERSION
+  spec.authors       = ['Craig Little']
+  spec.email         = ['craiglttl@gmail.com']
+  spec.description   = %q{Short-lived actor framework using Celluloid}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/craiglittle/letterbox'
+  spec.license       = 'MIT'
+
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files`.split($\)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+
+  spec.add_runtime_dependency 'celluloid', '~> 0.15'
+
+  spec.add_development_dependency 'rake'
+end

data/lib/letterbox.rb

@@ -0,0 +1,2 @@
+require 'letterbox/exchange'
+require 'letterbox/version'

data/lib/letterbox/address.rb

@@ -0,0 +1,22 @@
+require 'celluloid'
+
+module Letterbox
+  class Address
+
+    include Celluloid
+
+    attr_reader :exchange, :unit_of_work
+
+    def initialize(exchange, unit_of_work)
+      @exchange     = exchange
+      @unit_of_work = unit_of_work
+    end
+
+    def process(payload)
+      unit_of_work.new(payload).perform
+
+      exchange.async.completed_by(name)
+    end
+
+  end
+end

data/lib/letterbox/directory.rb

@@ -0,0 +1,55 @@
+require 'celluloid'
+
+module Letterbox
+  class Directory
+
+    attr_reader :registry, :number_of_units
+
+    def initialize
+      @registry        = Celluloid::Registry.new
+      @number_of_units = Hash.new(0)
+    end
+
+    def send_to(address, &new_address)
+      registry.set(address, new_address.call) unless registry.get(address)
+
+      track_unit(address)
+
+      registry.get(address)
+    end
+
+    def completed_by(address)
+      untrack_unit(address)
+
+      if empty?(address)
+        registry.get(address).terminate
+        registry.delete(address)
+
+        untrack_address(address)
+      end
+    end
+
+    def number_outstanding
+      number_of_units.values.reduce(:+)
+    end
+
+    private
+
+    def track_unit(address)
+      number_of_units[address.to_sym] += 1
+    end
+
+    def untrack_unit(address)
+      number_of_units[address.to_sym] -= 1
+    end
+
+    def untrack_address(address)
+      number_of_units.delete(address.to_sym)
+    end
+
+    def empty?(address)
+      number_of_units[address.to_sym] == 0
+    end
+
+  end
+end

data/lib/letterbox/exchange.rb

@@ -0,0 +1,29 @@
+require 'celluloid'
+
+require 'letterbox/directory'
+require 'letterbox/address'
+
+module Letterbox
+  class Exchange
+
+    extend Forwardable
+
+    include Celluloid
+
+    attr_reader :unit_of_work, :directory
+
+    def initialize(unit_of_work)
+      @unit_of_work = unit_of_work
+      @directory    = Directory.new
+    end
+
+    def dispatch(payload, address)
+      directory.send_to(address) {
+        Address.new_link(Actor.current, unit_of_work)
+      }.async.process(payload)
+    end
+
+    delegate [:completed_by, :number_outstanding] => :directory
+
+  end
+end

data/lib/letterbox/version.rb

@@ -0,0 +1,3 @@
+module Letterbox
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: letterbox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Craig Little
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Short-lived actor framework using Celluloid
+email:
+- craiglttl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- letterbox.gemspec
+- lib/letterbox.rb
+- lib/letterbox/address.rb
+- lib/letterbox/directory.rb
+- lib/letterbox/exchange.rb
+- lib/letterbox/version.rb
+homepage: https://github.com/craiglittle/letterbox
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Short-lived actor framework using Celluloid
+test_files: []