trinidad_worker_extension 0.2.0 → 0.3.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - jruby-18mode
+  - jruby-19mode
+branches:
+  only:
+    - master
+services:
+  - redis-server
+

data/Gemfile

@@ -1,4 +1,5 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 gemspec
 
-gem 'resque', :group => :test
+gem 'resque', :group => :test
+gem 'json', :group => :test # due MultiJson

data/LICENSE

@@ -1,5 +1,5 @@
 
-Copyright (c) 2012 Karol Bucek
+Copyright (c) 2013 Karol Bucek
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,7 +3,7 @@
 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 
+Built upon https://github.com/kares/jruby-rack-worker thus supports popular
 worker libraries such as **Resque** and **Delayed::Job**.
 
 ## Install
@@ -30,6 +30,12 @@ Or install it yourself as a plain old gem :
 
 Like all extensions set it up in the configuration file (e.g. *trinidad.yml*).
 
+**NOTE:** The extension will not be configuring workers threads to start when
+running in **rackup** mode (e.g. `rails s`) because it expects JRuby-Rack to be
+not loaded in the embedded mode. Running Trinidad using `rackup` is mostly
+suitable for development/testing thus this is not seen as a limitation (simply
+start `trinidad -e staging` to check whether your workers are doing fine).
+
 ### Delayed::Job
 
 ```yaml
@@ -86,7 +92,7 @@ The following start script will be executed in each Thread http://git.io/XglTpw
 ```
 
 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 
+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
@@ -100,5 +106,5 @@ worker.queues = (env['QUEUES']).split(',')
 
 ## Copyright
 
-Copyright (c) 2012 [Karol Bucek](https://github.com/kares). 
+Copyright (c) 2013 [Karol Bucek](https://github.com/kares).
 See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/Rakefile

@@ -10,5 +10,6 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = ['--color', "--format documentation"]
 end
+task :test => :spec
 
 task :default => :spec

data/lib/trinidad_worker_extension.rb

@@ -8,11 +8,11 @@ module Trinidad
 
       def configure(context)
         if ! options || options.size == 0
-          context.logger.info "no worker(s) seems to be configured"
+          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 " +
+            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 ]
@@ -24,12 +24,17 @@ module Trinidad
       end
 
       protected
-      
+
       def configure_worker(context, name, config)
-        config = config.dup
-        params = {}
+        config = config.dup; params = {}
         if script = config.delete(:script)
-          params['jruby.worker.script'] = script
+          if File.exists?(script)
+            context.logger.warn "Seems you've set :script to an actual file path: " <<
+            "'#{script}' please use :script_path instead to make this warning go away"
+            params['jruby.worker.script.path'] = script
+          else
+            params['jruby.worker.script'] = script
+          end
         end
         if script_path = config.delete(:script_path)
           params['jruby.worker.script.path'] = script_path
@@ -38,7 +43,7 @@ module Trinidad
           if name
             params['jruby.worker'] = name.to_s
           else
-            context.logger.warn "not-starting any workers due missing configuration " + 
+            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
@@ -57,22 +62,26 @@ module Trinidad
         context.add_lifecycle_listener listener = WorkerLifecycle.new(params)
         listener
       end
-      
+
       CONTEXT_LISTENER = 'org.kares.jruby.rack.WorkerContextListener'
-      
+
       class WorkerLifecycle < Trinidad::Lifecycle::Base
-        
+
         attr_reader :context_parameters
-        
+
         def initialize(params)
           @context_parameters = params || {}
-          if @context_parameters.empty?
-            raise ArgumentError, "no context parameters"
-          end
+          raise ArgumentError, "no context parameters" if @context_parameters.empty?
         end
-        
+
         def configure_start(event)
           context = event.lifecycle
+          configure = context.findApplicationListeners.any? # in rackup mode empty
+          configure ||= Java::JavaLang::Boolean.getBoolean('trinidad.extensions.worker')
+          unless configure
+            context.logger.info "Skipped configuration of worker extension (due rackup mode)"
+            return
+          end
           add_context_parameters(context)
           add_class_loader_jar_url(context)
           # NOTE: it's important for this listener to be added after
@@ -81,9 +90,9 @@ module Trinidad
           # right after #before_start but before the actual #start !
           add_application_listener(context)
         end
-        
+
         protected
-        
+
         def add_context_parameters(context)
           app_params = context.find_application_parameters
           context_parameters.each do |name, value|
@@ -98,7 +107,7 @@ module Trinidad
             end
           end
         end
-        
+
         def add_class_loader_jar_url(context)
           jar_file = java.io.File.new JRuby::Rack::Worker::JAR_PATH
           class_loader = context.loader.class_loader
@@ -106,16 +115,16 @@ module Trinidad
             class_loader.addURL jar_file.to_url
           end
         end
-        
+
         def add_application_listener(context)
           listener = CONTEXT_LISTENER
           unless context.find_application_listeners.include?(listener)
             context.add_application_listener listener
           end
         end
-        
+
       end
-      
+
     end
   end
 end

data/lib/trinidad_worker_extension/version.rb

@@ -1,7 +1,7 @@
 module Trinidad
   module Extensions
     module Worker
-      VERSION = '0.2.0'
+      VERSION = '0.3.0'
     end
   end
 end

data/spec/app/trinidad.rb

@@ -1,15 +1,14 @@
 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
+    'LOGGING' => 'debug'
   }
+  
+  config[:extensions] = { :worker => worker_config }
 end

data/spec/spec_helper.rb

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

data/spec/trinidad_worker_extension_spec.rb

@@ -2,7 +2,7 @@ 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
@@ -11,9 +11,9 @@ describe Trinidad::Extensions::WorkerWebAppExtension do
     web_app = create_web_app; context = create_web_app_context(web_app)
 
     Trinidad::Extensions.configure_webapp_extensions(web_app.extensions, tomcat, context)
-    
+
     it_includes_worker_lifecycle_listener(context)
-    
+
     listener = worker_lifecycle_listener_for(context)
     params = listener.context_parameters
     expect( params['jruby.worker'] ).to eql 'delayed_job'
@@ -25,22 +25,22 @@ describe Trinidad::Extensions::WorkerWebAppExtension do
   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)
-    
+
     it_includes_worker_lifecycle_listener(context)
-    
+
     listener = worker_lifecycle_listener_for(context)
     params = listener.context_parameters
     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'
+    expect( params['LOGGING'] ).to eql 'debug'
   end
-  
+
   describe 'WorkerLifecycle', :integration => true do
-    
+
     before do
       Trinidad.configure! { load File.join(APP_DIR, 'trinidad.rb') }
       @web_app = create_web_app; @context = create_web_app_context(@web_app)
@@ -51,11 +51,11 @@ describe Trinidad::Extensions::WorkerWebAppExtension do
       @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 and init params" do
       class_name = 'org.kares.jruby.rack.WorkerContextListener'
       expect( @context.find_application_listeners ).to include class_name
@@ -70,29 +70,29 @@ describe Trinidad::Extensions::WorkerWebAppExtension do
       expect( @context.servlet_context.get_init_parameter('jruby.worker') ).to eql 'resque'
       expect( @context.servlet_context.get_init_parameter('QUEUES') ).to eql 'low,normal'
     end
-    
+
   end
-  
+
   def it_includes_worker_lifecycle_listener(context)
     expect( worker_lifecycle_listener_for(context) ).to_not be nil
   end
-  
+
   def worker_lifecycle_listener_for(context)
     listeners = context.find_lifecycle_listeners
     klass = Trinidad::Extensions::WorkerWebAppExtension::WorkerLifecycle
     listeners.find { |l| l.is_a?(klass) }
   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
@@ -113,5 +113,5 @@ describe Trinidad::Extensions::WorkerWebAppExtension do
     context.addLifecycleListener lifecycle if lifecycle
     context
   end
-      
+
 end

data/trinidad_worker_extension.gemspec

@@ -21,9 +21,8 @@ Gem::Specification.new do |gem|
   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_dependency 'trinidad', ">= 1.4.4"
+  gem.add_dependency 'jruby-rack-worker', ">= 0.9"
+  gem.add_development_dependency 'rspec', '~> 2.11'
   gem.add_development_dependency 'rake'
 end

metadata

@@ -2,7 +2,7 @@
 name: trinidad_worker_extension
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
   - Karol Bucek
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-29 00:00:00 Z
+date: 2013-06-06 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: trinidad
@@ -19,7 +19,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: 1.4.1
+            version: 1.4.4
     requirement: *id001
     prerelease: false
     type: :runtime
@@ -30,7 +30,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: "0.7"
+            version: "0.9"
     requirement: *id002
     prerelease: false
     type: :runtime
@@ -41,12 +41,12 @@ dependencies:
       requirements: 
         - - ~>
           - !ruby/object:Gem::Version 
-            version: "2.10"
+            version: "2.11"
     requirement: *id003
     prerelease: false
     type: :development
   - !ruby/object:Gem::Dependency 
-    name: mocha
+    name: rake
     version_requirements: &id004 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
@@ -56,17 +56,6 @@ dependencies:
     requirement: *id004
     prerelease: false
     type: :development
-  - !ruby/object:Gem::Dependency 
-    name: rake
-    version_requirements: &id005 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    requirement: *id005
-    prerelease: false
-    type: :development
 description: |-
   Trinidad background worker extension built upon 
     JRuby-Rack-Worker which provides threaded workers along side your (JRuby-Rack)
@@ -84,6 +73,7 @@ extra_rdoc_files:
   - LICENSE
 files: 
   - .gitignore
+  - .travis.yml
   - Gemfile
   - LICENSE
   - README.md