jruby-rack-worker 0.8.0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2010-2012 Karol Bucek
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,234 @@
+# JRuby-Rack-Worker
+
+Thread based workers on top of [jruby-rack](http://github.com/jruby/jruby-rack).
+
+With out of the box thread-safe [JRuby](http://jruby.org) "adapters" for: 
+
+* [Resque](http://github.com/defunkt/resque) (>= 1.20.0)
+* [Delayed::Job](http://github.com/collectiveidea/delayed_job) (~> 2.1, >= 3.0)
+* [Navvy](http://github.com/jeffkreeftmeijer/navvy) (not-maintained)
+
+... but one can easily write/adapt his own worker loop.
+
+[![Build Status][0]](http://travis-ci.org/kares/jruby-rack-worker)
+
+## Motivation
+
+Ruby attempts to stay pretty close to UNIX and most popular workers have been 
+modeled the "spawn a background process" way. [JRuby](http://jruby.org) brings 
+Java to the table, where "Young Java Knights" are thought to use threads 
+whenever in a need to compute something parallel while serving requests.
+
+There's no right or wrong way of doing this. If you do expect chaos like Resque
+proclaims - have long running jobs that consume a lot of memory they have trouble 
+releasing (e.g. due C extensions) run a separate process for sure.
+But otherwise (after all C exts usually have a native Java alternative on JRuby) 
+having predictable thread-safely written workers, one should be fine with 
+running them concurrently as part of the application in a (daemon) thread.
+
+This does have the advantage of keeping the deployment simple and saving some
+precious memory (most notably with `threadsafe!` mode) that would have been 
+eaten by the separate process. Besides, your application might warm up faster 
+and start benefiting from JRuby's runtime optimalizations slightly sooner ...
+
+On the other hand your jobs should be fairly simple and complete "fast" (in a 
+rate of seconds rather than several minutes or hours) as they will live and 
+restart with the lifecycle of the deployed application and application server.
+
+
+## Setup
+
+Copy the *jruby-rack-worker.jar* into the *lib* folder or the directory being
+mapped to *WEB-INF/lib* (e.g. *lib/java*).
+
+Configure your worker in **web.xml**, you will need to add a context listener
+that will start (daemon) threads when your application boots and a script to be
+executed (should be an "endless" loop-ing script). Sample configuration :
+
+    <context-param>
+      <param-name>jruby.worker.script</param-name>
+      <param-value> 
+        <!-- any script with an end-less loop : ->
+        require 'delayed/jruby_worker'
+        Delayed::JRubyWorker.new.start
+      </param-value>
+    </context-param>
+
+    <listener>
+      <listener-class>org.kares.jruby.rack.WorkerContextListener</listener-class>
+    </listener>
+
+The `WorkerContextListener` needs to be executed (and thus configured) after the 
+`RailsServletContextListener`/`RackServletContextListener` as it expects the 
+JRuby-Rack environment to be booter and available.
+
+For built-in worker support (if you're happy with the defaults) simply specify
+the **jruby.worker** context parameter (optionally with custom params supported
+by the worker) e.g. :
+
+    <context-param>
+      <param-name>jruby.worker</param-name>
+      <param-value>resque</param-value>
+    </context-param>
+    <context-param>
+      <param-name>QUEUES</param-name>
+      <param-value>mails,posts</param-value>
+    </context-param>
+    <context-param>
+      <param-name>INTERVAL</param-name>
+      <param-value>2.5</param-value>
+    </context-param>
+
+    <listener>
+      <listener-class>org.kares.jruby.rack.WorkerContextListener</listener-class>
+    </listener>
+
+Sample deployment descriptor including optional parameters:
+[web.xml](/kares/jruby-rack-worker/blob/master/src/test/resources/sample.web.xml).
+
+### Warbler
+
+If you're using [Warbler](http://caldersphere.rubyforge.org/warbler) to assemble
+your application you might simply declare a gem dependency with Bundler as your
+gems will be scanned for jars and packaged correctly:
+
+    gem 'jruby-rack-worker', :platform => :jruby, :require => nil
+
+Otherwise copy the jar into your *warble.rb* configured `config.java_libs`.
+
+Warbler checks for a *config/web.xml.erb* thus configure the worker there, e.g. :
+
+```
+<!DOCTYPE web-app PUBLIC
+  "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
+  "http://java.sun.com/dtd/web-app_2_3.dtd">
+<web-app>
+<% webxml.context_params.each do |k,v| %>
+  <context-param>
+    <param-name><%= k %></param-name>
+    <param-value><%= v %></param-value>
+  </context-param>
+<% end %>
+
+  <filter>
+    <filter-name>RackFilter</filter-name>
+    <filter-class>org.jruby.rack.RackFilter</filter-class>
+  </filter>
+  <filter-mapping>
+    <filter-name>RackFilter</filter-name>
+    <url-pattern>/*</url-pattern>
+  </filter-mapping>
+
+  <listener>
+    <listener-class><%= webxml.servlet_context_listener %></listener-class>
+  </listener>
+
+<% if webxml.jndi then [webxml.jndi].flatten.each do |jndi| %>
+  <resource-ref>
+    <res-ref-name><%= jndi %></res-ref-name>
+    <res-type>javax.sql.DataSource</res-type>
+    <res-auth>Container</res-auth>
+  </resource-ref>
+<% end; end %>
+
+  <!-- jruby-rack-worker setup using the built-in libraries support : -->
+
+  <context-param>
+    <param-name>jruby.worker</param-name>
+    <param-value>delayed_job</param-value> <!-- or resque or navvy -->
+  </context-param>
+
+  <listener>
+    <listener-class>org.kares.jruby.rack.WorkerContextListener</listener-class>
+  </listener>
+
+</web-app>
+```
+
+If you're deploying a Rails application on JRuby it's highly **recommended** to 
+uncomment `config.threadsafe!`. Otherwise, if unsure or you're code is not 
+thread-safe yet you'll end up polling several JRuby runtimes in a single process, 
+in this case however each worker thread will use (block) an application runtime 
+from the pool (consider it while setting 
+`jruby.min.runtimes` and `jruby.max.runtimes` parameters).
+
+
+### Custom Workers
+
+There are a few gotchas to keep in mind when creating a custom worker, if you've
+got a worker spawning script (e.g. a rake task) start there to write the worker
+"starter" script. Some tips to keep in mind :
+
+ * avoid native gems such as daemons (in DJ's case this means avoiding the whole
+   `Delayed::Command` implementation)
+
+ * remove command line processing - all your configuration should happen in an
+   application initializer (or be configurable from *web.xml*)
+
+ * make sure the worker code is thread-safe in case your application is running
+   in `threadsafe!` mode (make sure no global state is changing by the worker or
+   class variables are not being used to store worker state)
+
+ * refactor your worker's exit code from a (process oriented) signal based `trap`
+   to an `at_exit` hook - which respects the JRuby environment your workers are 
+   going to be running in
+
+Keep in mind that if you do configure to use multiple threads the script will be
+loaded and executed for each thread, thus move your worker class definition into
+a separate file that you'll require from the script.
+
+See the [Delayed::Job](/kares/jruby-rack-worker/tree/master/src/main/ruby/delayed)
+JRuby "adapted" worker code for an inspiration.
+
+If you'd like to specify custom parameters you can do so in the deployment 
+descriptor as context init parameters or as java system properties, use the 
+following code to obtain them :
+
+```ruby
+require 'jruby/rack/worker/env'
+env = JRuby::Rack::Worker::ENV
+
+worker = MyWorker.new
+worker.queues = (env['QUEUES'] || 'all').split(',').map(&:strip)
+worker.loop
+```
+
+If you need a logger JRuby-Rack-Worker sets up one which will be Rails.logger for
+in Rails or a `STDOUT` logger otherwise by default :
+
+```ruby
+require 'jruby/rack/worker/logger'
+begin
+  worker = MyWorker.new
+  worker.logger = JRuby::Rack::Worker.logger
+  worker.start
+rescue => e
+  JRuby::Rack::Worker.log_error(e)
+end
+```
+
+
+## Build
+
+[JRuby](http://jruby.org) 1.6+ is required to build the project.
+
+The build is performed by [rake](http://rake.rubyforge.org) which should be part
+of your JRuby installation, if you're experiencing conflicts with another Ruby and
+it's `rake` executable use `jruby -S rake` instead.
+Besides you will need [ant](http://ant.apache.org/) installed for the Java part.
+
+Build the *jruby-rack-worker_[VERSION].jar* using :
+
+    rake jar
+
+Build the gem (includes the .jar packaged) :
+
+    rake gem
+
+
+## Copyright
+
+Copyright (c) 2012 [Karol Bucek](https://github.com/kares). 
+See LICENSE (http://www.apache.org/licenses/LICENSE-2.0) for details.
+
+[0]: https://secure.travis-ci.org/kares/jruby-rack-worker.png

data/lib/jruby/rack/worker.rb

@@ -0,0 +1,14 @@
+require 'jruby/rack/worker/version'
+
+module JRuby
+  module Rack
+    module Worker
+      unless const_defined?(:JAR_PATH)
+        JAR_PATH = File.expand_path("../../jruby-rack-worker_#{VERSION}.jar", File.dirname(__FILE__))
+      end
+      def self.load_jar(method = :load)
+        send(method, JAR_PATH) # load JAR_PATH
+      end
+    end
+  end
+end

data/lib/jruby/rack/worker/env.rb

@@ -0,0 +1,20 @@
+module JRuby
+  module Rack
+    module Worker
+      
+      ENV = Hash.new do |hash, key|
+        if hash.key? key = key.to_s
+          hash[key]
+        else
+          manager = self.manager
+          val = manager ? manager.getParameter(key) : nil
+          val = ::ENV[key] if val.nil?
+          hash[key] = val
+        end
+      end
+      
+      def self.manager; $worker_manager; end
+      
+    end
+  end
+end

data/lib/jruby/rack/worker/logger.rb

@@ -0,0 +1,43 @@
+module JRuby
+  module Rack
+    module Worker
+      
+      def self.log_error(e, logger = nil)
+        return unless ( logger ||= self.logger )
+        
+        message = "\n#{e.class} (#{e.message}):\n"
+        message << '  ' << e.backtrace.join("\n  ")
+        logger.error("#{message}\n\n")
+      end
+      
+      @@logger = nil
+      def self.logger
+        @@logger ||= begin
+          if defined?(Rails.logger)
+            Rails.logger
+          else
+            default_logger
+          end
+        end
+      end
+      
+      def self.logger=(logger)
+        if @@logger == false
+          require 'logger'
+          @@logger = Logger.new(nil)
+        else
+          @@logger = logger
+        end
+      end
+      
+      def self.logger?; !!@@logger; end
+      
+      protected
+      
+      def self.default_logger
+        require 'logger'; Logger.new(STDERR)
+      end
+      
+    end
+  end
+end

data/lib/jruby/rack/worker/version.rb

@@ -0,0 +1,7 @@
+module JRuby
+  module Rack
+    module Worker
+      VERSION = '0.8.0'
+    end
+  end
+end

data/lib/jruby_rack_worker.rb

@@ -0,0 +1,2 @@
+require 'jruby/rack/worker'
+JRuby::Rack::Worker.load_jar

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: jruby-rack-worker
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.8.0
+platform: ruby
+authors: 
+  - Karol Bucek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-30 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: jruby-rack
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.1.10
+    type: :runtime
+    version_requirements: *id001
+description: Implements a thread based worker pattern on top of JRuby-Rack. Useful if you'd like to run background workers within your (deployed) web-application (concurrently in 'native' threads) instead of using separate daemon processes. Provides (thread-safe) implementations for popular worker libraries such as Resque and Delayed::Job, but one can easily write their own 'daemon' scripts as well.
+email: 
+  - self@kares.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - README.md
+  - LICENSE
+  - lib/jruby_rack_worker.rb
+  - lib/jruby-rack-worker_0.8.0.jar
+  - lib/jruby/rack/worker.rb
+  - lib/jruby/rack/worker/env.rb
+  - lib/jruby/rack/worker/logger.rb
+  - lib/jruby/rack/worker/version.rb
+homepage: http://github.com/kares/jruby-rack-worker
+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: "[none]"
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Threaded Workers with JRuby-Rack
+test_files: []
+