jruby-rack-worker 0.2-jruby

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 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,116 @@
+JRuby Rack Worker
+=================
+
+Java based thread worker implementation over [jruby-rack](http://github.com/nicksieger/jruby-rack).
+
+Motivation
+----------
+
+While migrating a rails application to [JRuby](http://jruby.org) I found myself
+stuck with [Delayed::Job](http://github.com/collectiveidea/delayed_job). I wanted
+to deploy the application without having to spawn a separate daemon process in
+another *ruby* (as *jruby* is not daemonizable the [daemons](http://daemons.rubyforge.org) way).
+
+Well, why not spawn a "daemon" thread looping over the jobs from the servlet
+container ... after all the java world is inherently thread-oriented !
+
+This does have the advantage of keeping the deployment simple and saving some
+precious memory (assuming `threadsafe!` mode of course) that would have been
+eaten by the separate process. Besides Your daemons start benefiting from
+JRuby's (as well as Java's) runtime optimalizations !
+
+On the other hand Your jobs should be simple and complete "fast" (in a rate of
+seconds rather than several minutes or hours) as they will restart and live with
+the lifecycle of the deployed application / application server.
+
+Java purist might objects the servlet specification does not advise spawning
+daemon threads in a servlet container, objection noted. Whether this style of
+asynchronous processing suits Your limits, needs and taste is entirely up to U !
+
+
+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 the worker in Your `web.xml`, You'll need to add a servlet context
+listener that will start threads when You 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>
+        require 'delayed/jruby_worker'
+        Delayed::JRubyWorker.new.start
+      </param-value>
+    </context-param>
+
+    <listener>
+      <listener-class>org.kares.jruby.rack.WorkerContextListener</listener-class>
+    </listener>
+
+<strong>
+Script loading from WEB-INF/lib/*.jar files is not working thus make sure
+(in case of the above example) that You copy all Your .rb files to the load path
+(e.g. in case of the above example copy `src/main/ruby/delayed/jruby_worker.rb`
+to `RAILS_ROOT/lib/delayed/jruby_worker.rb` ) ...
+</strong>
+
+**NOTE**: The `WorkerContextListener` needs to be executed (and thus configured)
+after the `RailsServletContextListener`/`RackServletContextListener` as it expects
+the jruby-rack environment to be available.
+
+**NOTE**: If You're not using `threadsafe!` than You really **should** ...
+
+**NOTE**: If You're still not using `threadsafe!` mode than You're polling several
+(non-thread-safe) jruby runtimes instances while serving requests, the *workers
+run as part of Your application* thus each worker thread will remove and use an
+application runtime from Your instance pool (consider it while setting the
+`jruby.min.runtimes`/`jruby.max.runtimes` parameters) !
+
+Sample Rails `web.xml` usable with [Warbler](http://caldersphere.rubyforge.org/warbler)
+including optional configuration parameters
+[web.xml](/kares/jruby-rack-worker/blob/master/src/test/resources/warbler.web.xml).
+
+
+Build
+=====
+
+[JRuby](http://jruby.org) 1.5+ 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 of the bare `rake` command.
+
+Build the `jruby-rack-worker.jar` using :
+
+    rake jar
+
+Run the tests with :
+
+    rake test
+
+
+Worker Migration
+================
+
+There are a few gotchas to keep in mind when migrating a worker such as
+[Delayed::Job](http://github.com/collectiveidea/delayed_job) to JRuby, You'll most
+probably need to start by looking at Your worker spawning script (such as `script/delayed_job`) :
+
+ * 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
+   initializer or the `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 `at_exit` - respects better the JRuby servlet environment Your workers be
+   running in
+
+See the [Delayed::Job](/kares/jruby-rack-worker/tree/master/src/main/ruby/delayed)
+JRuby "migrated" worker code for inspiration.

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

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

data/lib/jruby_rack_worker.rb

@@ -0,0 +1,2 @@
+require 'jruby/rack/worker/version'
+require File.expand_path("jruby-rack-worker_#{JRuby::Rack::Worker::VERSION}.jar", File.dirname(__FILE__))

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: jruby-rack-worker
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.2"
+platform: jruby
+authors: 
+  - Karol Bucek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 +02:00
+default_executable: 
+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.0.1
+    type: :runtime
+    version_requirements: *id001
+description: Implements a thread based worker using JRuby-Rack (a.k.a. Delayed Job for Java). Usable in servlet containers.
+email: 
+  - self@kares.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - README.md
+  - LICENSE
+  - lib/jruby-rack-worker_0.2.jar
+  - lib/jruby_rack_worker.rb
+  - lib/jruby/rack/worker/version.rb
+has_rdoc: true
+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: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Simple Worker for JRuby-Rack
+test_files: []
+