trinidad_worker_extension 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/app/log/*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'resque', :group => :test

data/LICENSE

@@ -0,0 +1,26 @@
+
+Copyright (c) 2012 Karol Bucek
+
+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.
+
+== Additional Bundled Software
+
+JRuby::Rack::Worker is licensed under the Apache License, Version 2.0.
+See http://www.apache.org/licenses/LICENSE-2.0 for details.

data/README.md

@@ -0,0 +1,104 @@
+# Trinidad Worker Extension
+
+Background Workers for [Trinidad](https://github.com/trinidad/trinidad/) running
+as background (daemon) threads along side your Rack/Rails deployed application.
+
+Built upon https://github.com/kares/jruby-rack-worker thus supports popular 
+worker libraries such as **Resque** and **Delayed::Job**.
+
+## Install
+
+Along with Trinidad in your application's *Gemfile* :
+
+```ruby
+  group :server do
+    platform :jruby do
+      gem 'trinidad', :require => false
+      gem 'trinidad_worker_extension', :require => false
+    end
+  end
+```
+
+    $ bundle
+
+Or install it yourself as a plain old gem :
+
+    $ gem install trinidad_worker_extension
+
+
+## Configure
+
+Like all extensions set it up in the configuration file (e.g. *trinidad.yml*).
+
+### Delayed::Job
+
+```yaml
+---
+  # ...
+  extensions:
+    worker:
+      delayed_job:
+        # all settings here are optional
+        thread_count: 1
+        thread_priority: NORM
+        # DJ specifics (optional as well) :
+        QUEUE: mailers,tasks
+        READ_AHEAD: 3 # default 5
+        SLEEP_DELAY: 2.5 # default 5
+        #MIN_PRIORITY: 1
+        #MAX_PRIORITY: 5
+```
+
+The following start script will be executed in each Thread http://git.io/yLSgLA
+
+### Resque
+
+```ruby
+Trinidad.configure do |config|
+  config[:extensions] = {
+    :worker =>
+      :resque => {
+        :thread_priority => 4, # bit bellow NORM (5)
+        'QUEUES' => ['*'],
+        'INTERVAL' => 2.5, # default is 5.0
+        'VERBOSE' => true, # verbose logging
+        #'VVERBOSE' => true, # very_verbose logging
+      }
+  }
+end
+```
+
+The following start script will be executed in each Thread http://git.io/XglTpw
+
+### Custom Worker
+
+```yaml
+---
+  # ...
+  extensions:
+    worker:
+      custom:
+        #script: require 'my_worker'; MyWorker.start
+        script.path: "lib/my_worker/start_worker.rb"
+        # all settings here are optional
+        #thread_count: 1
+        #thread_priority: NORM
+```
+
+If you'd like to specify custom parameters you can do so within the configuration
+file or the deployment descriptor as context init parameters or as java system 
+properties, use the following code to obtain them in your code :
+
+```ruby
+require 'jruby/rack/worker/env'
+env = JRuby::Rack::Worker::ENV
+
+worker = MyWorker.new
+worker.queues = (env['QUEUES']).split(',')
+# ...
+```
+
+## Copyright
+
+Copyright (c) 2012 [Karol Bucek](https://github.com/kares). 
+See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'bundler/gem_helper'
+rescue LoadError => e
+  require('rubygems') && retry
+  raise e
+end
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color', "--format documentation"]
+end
+
+task :default => :spec

data/lib/trinidad_worker_extension.rb

@@ -0,0 +1,79 @@
+require 'trinidad'
+require 'trinidad_worker_extension/version'
+require 'jruby/rack/worker'
+
+module Trinidad
+  module Extensions
+    class WorkerWebAppExtension < WebAppExtension
+
+      def configure(context)
+        if ! options || options.size == 0
+          context.logger.info "no worker(s) seems to be configured"
+        else
+          worker_config = options.first
+          if options.size > 1
+            context.logger.info "currently only 1 worker configuration per " +
+            "web-app is supported, will use first: #{worker_config.inspect}"
+          end
+          if worker_config.is_a?(Array) # [ key, val ]
+            configure_worker context, worker_config[0], worker_config[1]
+          else
+            configure_worker context, nil, worker_config
+          end
+        end
+      end
+
+      protected
+      
+      def configure_worker(context, name, config)
+        config = config.dup
+        if script = config.delete(:script)
+          context.add_parameter 'jruby.worker.script', script
+        end
+        if script_path = config.delete(:script_path)
+          context.add_parameter 'jruby.worker.script.path', script_path
+        end
+        if script.nil? && script_path.nil?
+          if name
+            context.add_parameter('jruby.worker', name.to_s)
+          else
+            context.logger.warn "not-starting any workers due missing configuration " + 
+            "either set :script or :script_path if you're not using a built-in worker"
+            return
+          end
+        end
+        config.each do |key, value|
+          case key.to_s
+          when 'thread_count'
+            context.add_parameter('jruby.worker.thread.count', value.to_s)
+          when 'thread_priority'
+            context.add_parameter('jruby.worker.thread.priority', value.to_s)
+          else
+            value = value.join(',') if value.respond_to?(:join)
+            context.add_parameter(key.to_s, value.to_s)
+          end
+        end
+        context.add_lifecycle_listener listener = WorkerLifecycle.new
+        listener
+      end
+      
+      CONTEXT_LISTENER = 'org.kares.jruby.rack.WorkerContextListener'
+      
+      class WorkerLifecycle < Trinidad::Lifecycle::Base
+        
+        def configure_start(event)
+          context = event.lifecycle
+          jar_file = java.io.File.new JRuby::Rack::Worker::JAR_PATH
+          context.loader.class_loader.addURL jar_file.to_url
+          # NOTE: it's important for this listener to be added after
+          # the Rack setup as it expectd to find the RackFactory ...
+          # that's why we hook into #configure_start which happens
+          # right after #before_start but before the actual #start !
+          context.add_application_listener CONTEXT_LISTENER
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/trinidad_worker_extension/version.rb

@@ -0,0 +1,7 @@
+module Trinidad
+  module Extensions
+    module Worker
+      VERSION = '0.1.0'
+    end
+  end
+end

data/spec/app/config.ru

@@ -0,0 +1,2 @@
+ use Rack::CommonLogger
+ run Proc.new { [200, {'Content-Type' => 'text/plain'}, 'OK'] }

data/spec/app/trinidad.rb

@@ -0,0 +1,15 @@
+Trinidad.configure do |config|
+  config[:jruby_min_runtimes] = 1
+  config[:jruby_max_runtimes] = 1
+  
+  worker_config = {}
+  worker_config[:resque] = {
+    :thread_priority => 'MIN',
+    'QUEUES' => ['low', 'normal'],
+    'INTERVAL' => 1.5,
+    'VERBOSE' => true
+  }
+  config[:extensions] = {
+    :worker => worker_config
+  }
+end

data/spec/app/trinidad.yml

@@ -0,0 +1,17 @@
+---
+  environment: production
+  port: 4444
+  trap: false
+  extensions:
+    worker:
+      delayed_job: # jruby.worker
+        #script: "require 'sample/resque_worker'; Sample::ResqueWorker.start"
+        #script_path: sample/start_resque_worker.rb
+        thread_count: 2 # jruby.worker.thread.count
+        # DJ specific :
+        #QUEUE: all
+        READ_AHEAD: 3
+        SLEEP_DELAY: 3.0
+      another: # (will be ignored)
+        script: " puts 'started another worker' "
+        thread_priority: MIN # jruby.worker.thread.priority

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  require('rubygems') && retry
+  raise e
+end
+
+require 'rspec'
+require 'mocha'
+
+lib = File.expand_path('../lib', File.dirname(__FILE__))
+$: << lib unless $:.include?(lib)
+require 'trinidad_worker_extension'

data/spec/trinidad_worker_extension_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+require 'yaml'
+
+describe Trinidad::Extensions::WorkerWebAppExtension do
+  
+  APP_DIR = File.expand_path('app', File.dirname(__FILE__))
+
+  it "configures (delayed) worker" do
+    options = YAML.load( File.read(File.join(APP_DIR, 'trinidad.yml')) )
+    Trinidad.configure!(options)
+    web_app = create_web_app; context = create_web_app_context(web_app)
+
+    Trinidad::Extensions.configure_webapp_extensions(web_app.extensions, tomcat, context)
+    
+    params = parameters(context)
+    expect( params['jruby.worker'] ).to eql 'delayed_job'
+    expect( params['jruby.worker.thread.count'] ).to eql '2'
+    expect( params['READ_AHEAD'] ).to eql '3'
+    expect( params['SLEEP_DELAY'] ).to eql '3.0'
+    
+    it_includes_worker_lifecycle_listener(context)
+  end
+
+  it "configures (resque) worker" do
+    Trinidad.configure! { load File.join(APP_DIR, 'trinidad.rb') }
+    web_app = create_web_app; context = create_web_app_context(web_app)
+    
+    Trinidad::Extensions.configure_webapp_extensions(web_app.extensions, tomcat, context)
+    
+    params = parameters(context)
+    expect( params['jruby.worker'] ).to eql 'resque'
+    expect( params['jruby.worker.thread.priority'] ).to eql 'MIN'
+    expect( params['QUEUES'] ).to eql 'low,normal'
+    expect( params['INTERVAL'] ).to eql '1.5'
+    expect( params['VERBOSE'] ).to eql 'true'
+    
+    it_includes_worker_lifecycle_listener(context)
+  end
+  
+  describe 'WorkerLifecycle' do
+    
+    before do
+      Trinidad.configure! { load File.join(APP_DIR, 'trinidad.rb') }
+      @web_app = create_web_app; @context = create_web_app_context(@web_app)
+      # sets up the worker lifecycle listener :
+      Trinidad::Extensions.configure_webapp_extensions(@web_app.extensions, tomcat, @context)
+      listeners = @context.find_lifecycle_listeners
+      klass = Trinidad::Extensions::WorkerWebAppExtension::WorkerLifecycle
+      @lifecycle = listeners.find { |l| l.is_a?(klass) }
+      # do what Trinidad server startup would :
+      @context.add_lifecycle_listener(@web_app.define_lifecycle)
+      
+      #@event = mock('event'); @event.stub!(:lifecycle).and_return @context
+      @context.start
+    end
+    
+    it "configures worker context listener" do
+      class_name = 'org.kares.jruby.rack.WorkerContextListener'
+      expect( @context.find_application_listeners ).to include class_name
+    end
+    
+  end
+  
+  def it_includes_worker_lifecycle_listener(context)
+    listeners = context.find_lifecycle_listeners
+    klass = Trinidad::Extensions::WorkerWebAppExtension::WorkerLifecycle
+    expect( listeners.find { |l| l.is_a?(klass) } ).to_not be nil
+  end
+  
+  protected
+  
+  def parameters(context)
+    context.find_parameters.inject({}) do |hash, name|
+      hash[name] = context.find_parameter(name); hash
+    end
+  end
+  
+  private
+  
+  def tomcat
+    @tomcat ||= org.apache.catalina.startup.Tomcat.new
+  end
+
+  def create_web_app(config = {})
+    Trinidad::WebApp.create({ :context_path => '/', :root_dir => APP_DIR }.merge(config))
+  end
+
+  def create_web_app_context(context_dir = APP_DIR, web_app_or_context_path = '/')
+    context_path, lifecycle = web_app_or_context_path, nil
+    if web_app_or_context_path.is_a?(Trinidad::WebApp)
+      context_path = web_app_or_context_path.context_path
+      lifecycle = web_app_or_context_path.define_lifecycle
+    end
+    context = tomcat.addWebapp(context_path, context_dir.to_s)
+    context_config = org.apache.catalina.startup.ContextConfig.new
+    context.addLifecycleListener context_config
+    context.addLifecycleListener lifecycle if lifecycle
+    context
+  end
+      
+end

data/trinidad_worker_extension.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "trinidad_worker_extension/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "trinidad_worker_extension"
+  gem.version     = Trinidad::Extensions::Worker::VERSION
+  gem.authors     = ["Karol Bucek"]
+  gem.email       = ["self@kares.org"]
+  gem.homepage    = "http://github.com/kares/trinidad_worker_extension"
+  gem.summary     = %q{Background Worker Extension for Trinidad}
+  gem.description = %q{Trinidad background worker extension built upon 
+  JRuby-Rack-Worker which provides threaded workers along side your (JRuby-Rack)
+  application. Includes (thread-safe) out-of-the-box implementations for popular
+  worker libraries such as Resque and Delayed::Job but customized 'daemon' 
+  scripts can be used as well.}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- test/* spec/*`.split("\n")
+  
+  gem.extra_rdoc_files = %w[ README.md LICENSE ]
+  
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'trinidad', ">= 1.4.1"
+  gem.add_dependency 'jruby-rack-worker', ">= 0.7"
+  gem.add_development_dependency 'rspec', '~> 2.10'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: trinidad_worker_extension
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Bucek
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trinidad
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: jruby-rack-worker
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: mocha
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: ! "Trinidad background worker extension built upon \n  JRuby-Rack-Worker\
+  \ which provides threaded workers along side your (JRuby-Rack)\n  application. Includes\
+  \ (thread-safe) out-of-the-box implementations for popular\n  worker libraries such\
+  \ as Resque and Delayed::Job but customized 'daemon' \n  scripts can be used as\
+  \ well."
+email:
+- self@kares.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/trinidad_worker_extension.rb
+- lib/trinidad_worker_extension/version.rb
+- spec/app/config.ru
+- spec/app/trinidad.rb
+- spec/app/trinidad.yml
+- spec/spec_helper.rb
+- spec/trinidad_worker_extension_spec.rb
+- trinidad_worker_extension.gemspec
+homepage: http://github.com/kares/trinidad_worker_extension
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Background Worker Extension for Trinidad
+test_files:
+- spec/app/config.ru
+- spec/app/trinidad.rb
+- spec/app/trinidad.yml
+- spec/spec_helper.rb
+- spec/trinidad_worker_extension_spec.rb