workers 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in workers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chad Remesch
+
+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,29 @@
+# Workers
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'workers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,13 @@
+require "bundler/gem_tasks"
+
+desc 'Start an IRB console with Workers loaded'
+task :console do
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+  require 'workers'
+  require 'irb'
+
+  ARGV.clear
+
+  IRB.start
+end

data/lib/workers/event.rb

@@ -0,0 +1,11 @@
+module Workers
+  class Event
+    attr_accessor :command
+    attr_accessor :data
+
+    def initialize(command, data)
+      @command = command
+      @data = data
+    end
+  end
+end

data/lib/workers/helpers.rb

@@ -0,0 +1,23 @@
+module Workers
+  module Helpers
+    def log_debug(msg, e = nil)
+      @logger.debug(concat_e(msg, e))
+    end
+
+    def log_info(msg, e = nil)
+      @logger.info(concat_e(msg, e))
+    end
+
+    def log_warn(msg, e = nil)
+      @logger.warn(concat_e(msg, e))
+    end
+
+    def log_error(msg, e = nil)
+      @logger.error(concat_e(msg, e))
+    end
+
+    def concat_e(msg, e = nil)
+      return e ? "#{msg}\nEXCEPTION: #{e.message}\n#{e.backtrace.join("\n")}\n--" : msg
+    end
+  end
+end

data/lib/workers/log_proxy.rb

@@ -0,0 +1,25 @@
+module Workers
+  class LogProxy
+    attr_accessor :logger
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def debug(msg)
+      @logger.debug(msg) if @logger
+    end
+
+    def info(msg)
+      @logger.info(msg) if @logger
+    end
+
+    def warn(msg)
+      @logger.warn(msg) if @logger
+    end
+
+    def error(msg)
+      @logger.error(msg) if @logger
+    end
+  end
+end

data/lib/workers/pool.rb

@@ -0,0 +1,37 @@
+module Workers
+  class Pool
+    include Workers::Helpers
+
+    DEFAULT_POOL_SIZE = 20
+
+    def initialize(options = {})
+      @size = options[:size] || Workers::Pool::DEFAULT_POOL_SIZE
+      @logger = Workers::LogProxy.new(options[:logger])
+      @input_queue = Queue.new
+      @workers = []
+      @size.times { @workers << Workers::Worker.new(:input_queue => @input_queue) }
+    end
+
+    def perform(options = {}, &block)
+      enqueue(:perform, block)
+
+      return nil
+    end
+
+    def shutdown(options = {}, &block)
+      @size.times { enqueue(:shutdown, block) }
+
+      return nil
+    end
+
+    def join(max_wait = nil)
+      return @workers.map { |w| w.join(max_wait) }
+    end
+
+    private
+
+    def enqueue(command, data)
+      @input_queue.push(Event.new(command, data))
+    end
+  end
+end

data/lib/workers/version.rb

@@ -0,0 +1,3 @@
+module Workers
+  VERSION = "0.0.1"
+end

data/lib/workers/worker.rb

@@ -0,0 +1,69 @@
+module Workers
+  class Worker
+    include Workers::Helpers
+
+    def initialize(options = {})
+      @logger = Workers::LogProxy.new(options[:logger])
+      @input_queue = options[:input_queue] || Queue.new
+      @thread = Thread.new { start_event_loop }
+    end
+
+    def perform(options = {}, &block)
+      enqueue(:perform, block)
+
+      return nil
+    end
+
+    def shutdown(options = {}, &block)
+      enqueue(:shutdown, block)
+
+      return nil
+    end
+
+    def join(max_wait = nil)
+      raise "Worker can't join itself!" if @thread == Thread.current
+
+      return true if !@thread.join(max_wait).nil?
+
+      @thread.kill and return false
+    end
+
+    private
+
+    def enqueue(command, data)
+      @input_queue.push(Event.new(command, data))
+    end
+
+    def start_event_loop
+      while true
+        event = @input_queue.pop # Blocking.
+
+        case event.command
+        when :shutdown
+          try_callback(event.data) do |e|
+            log_error("Worker failed run 'shutdown' callback.", e)
+          end
+          return
+        when :perform
+          try_callback(event.data) do |e|
+            log_error("Worker failed run 'perform' callback.", e)
+          end
+        else
+          process_event(event)
+        end
+      end
+    end
+
+    def try_callback(callback, &block)
+      begin
+        callback.call
+      rescue Exception => e
+        block.call(e)
+      end
+    end
+
+    def process_event(event)
+      raise 'Subclass and override if you need custom commands.'
+    end
+  end
+end

data/lib/workers.rb

@@ -0,0 +1,8 @@
+require 'thread'
+
+require 'workers/version'
+require 'workers/helpers'
+require 'workers/worker'
+require 'workers/pool'
+require 'workers/event'
+require 'workers/log_proxy'

data/workers.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workers/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "workers"
+  gem.version       = Workers::VERSION
+  gem.authors       = ["Chad Remesch"]
+  gem.email         = ["chad@remesch.com"]
+  gem.description   = %q{Simple to use Ruby workers for performing work in background threads.}
+  gem.summary       = %q{Simple to use Ruby workers featuring high performance, simple to use API, customizable workers, and thread pooling.}
+  gem.homepage      = "https://github.com/chadrem/workers"
+
+  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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: workers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chad Remesch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-12 00:00:00.000000000 Z
+dependencies: []
+description: Simple to use Ruby workers for performing work in background threads.
+email:
+- chad@remesch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/workers.rb
+- lib/workers/.pool.rb.swp
+- lib/workers/.worker.rb.swp
+- lib/workers/event.rb
+- lib/workers/helpers.rb
+- lib/workers/log_proxy.rb
+- lib/workers/pool.rb
+- lib/workers/version.rb
+- lib/workers/worker.rb
+- workers.gemspec
+homepage: https://github.com/chadrem/workers
+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: Simple to use Ruby workers featuring high performance, simple to use API,
+  customizable workers, and thread pooling.
+test_files: []