mikewadhera-jetty-rails 0.9

data/History.txt

@@ -0,0 +1,45 @@
+== 0.8
+* reading config/web.xml file (not yet supporting config/web.xml.erb)
+* supporting /public/WEB-INF dir for custom web resources (config files and taglibs)
+
+== 0.7
+* Merb 1.0 support!
+* jruby-rack updated to the latest release (0.9.3)
+* jetty server update to 6.1.14
+* adding known issue with jruby-1.1.4 to the docs
+* JSP and JSP Expression Language support
+* some minor bugs
+
+== 0.6
+* load all java classes inside classes/ by default
+* command line args to customize lib/ and classes/ directories
+* -v showing jetty_rails version
+* each web application context has its own classloader (isolated classpaths)
+* upgraded to jruby-rack-0.9.2 (no more views being cached in development time)
+* minor changes and refactorings
+* improved docs for multi-server support
+
+== 0.5
+* load all jars inside lib/ by default
+* using GEM_PATH environment variable, if exists
+* fix signal handling (ctrl + c) for jetty_merb
+
+== 0.4
+* Merb support! jruby -S jetty_merb
+* Changed default ports to 3000 (rails) and 4000 (merb)
+* More specs
+
+== 0.3
+
+* Improved Documentation: rdoc and site.
+
+== 0.2
+
+* Running any rails applications with no extra classpath.
+* Command line options for jett_rails binary executable.
+  See: <tt>jruby -S jetty_rails --help</tt> for details.
+
+== 0.1
+
+* Initial release.
+* Running default rails applications inside Jetty.

data/Licenses.txt

@@ -0,0 +1,37 @@
+= Jetty Rails
+
+Jetty Rails is distributed under the terms of the MIT License.
+
+Copyright (c) 2008 Fabio Kung
+
+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 (jruby-rack-*.jar) is distributed under the terms of the 
+MIT license. See http://svn.codehaus.org/jruby-contrib/trunk/rack/LICENSE.txt
+for details.
+
+Jetty (jetty-*.jar) is distributed under the terms of the Apache 2.0 License. 
+See http://jetty.mortbay.org/jetty-6/LICENSE.txt for details.
+
+Servlet API 2.5, a.k.a JSR-154, (servlet-api-2.5-*.jar) is distributed 
+under the terms of the Berkeley License. See http://developers.sun.com/license/berkeley_license.html 
+for details.

data/Manifest.txt

@@ -0,0 +1,52 @@
+History.txt
+Licenses.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+TODO.txt
+bin/jetty_merb
+bin/jetty_rails
+config/hoe.rb
+config/requirements.rb
+jetty-libs/core-3.1.1.jar
+jetty-libs/jetty-6.1.14.jar
+jetty-libs/jetty-plus-6.1.14.jar
+jetty-libs/jetty-util-6.1.14.jar
+jetty-libs/jsp-2.1.jar
+jetty-libs/jsp-api-2.1.jar
+jetty-libs/servlet-api-2.5-6.1.14.jar
+lib/jetty_rails.rb
+lib/jetty_rails/adapters/abstract_adapter.rb
+lib/jetty_rails/adapters/merb_adapter.rb
+lib/jetty_rails/adapters/rails_adapter.rb
+lib/jetty_rails/config/command_line_reader.rb
+lib/jetty_rails/config/rdoc_fix.rb
+lib/jetty_rails/handler/delegate_on_errors_handler.rb
+lib/jetty_rails/handler/public_directory_handler.rb
+lib/jetty_rails/handler/web_app_handler.rb
+lib/jetty_rails/jars.rb
+lib/jetty_rails/runner.rb
+lib/jetty_rails/server.rb
+lib/jetty_rails/version.rb
+lib/jetty_rails/warbler_reader.rb
+lib/jruby-rack-0.9.4.jar
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/config.yml
+spec/jetty_merb_spec.rb
+spec/jetty_rails/config_file_spec.rb
+spec/jetty_rails/handler/delegate_on_errors_handler_spec.rb
+spec/jetty_rails/runner_spec.rb
+spec/jetty_rails_sample_1.yml
+spec/jetty_rails_sample_2.yml
+spec/jetty_rails_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+For more information on jetty-rails, see http://jetty-rails.rubyforge.org

data/README.txt

@@ -0,0 +1,140 @@
+= jetty-rails
+
+http://jetty-rails.rubyforge.net
+
+== DESCRIPTION:
+
+Jetty Rails aims to run Ruby on Rails and Merb applications with the Jetty Container, leveraging the power of JRuby and jruby-rack.
+
+{Jetty}[http://jetty.mortbay.com/jetty/] is an excellent Java Web Server, being and at the same time extremely lightweight. This makes jetty-rails a good alternative for JRuby on Rails or Merb development and deployment.
+
+The project has born from my own needs ({read more}[http://fabiokung.com/2008/05/14/jetty-rails-gem-simple-jruby-on-rails-development-with-servlet-containers/]). I needed to run {JForum}[http://jforum.net] in the same context of my JRuby on Rails application. I had also to integrate HttpSessions (avoiding single sign on) and use ServletContext in-memory cache store.
+
+== FEATURES:
+
+* Uses {JRuby Rack}[http://wiki.jruby.org/wiki/JRuby_Rack].
+* Loads all jars inside your application lib/ dir, by default.
+* Loads all classes inside your application classes/ dir, by default.
+* Supports rails and merb applications out of the box.
+
+== KNOWN ISSUES
+
+* Doesn't work with gems inside $HOME/.gem, because jruby-rack overwrites custom gem paths. Please install jruby in writable places, or install your gems with sudo <tt>jruby -S gem install NAME</tt>.
+
+* Doesn't work with JRuby 1.1.4: http://jira.codehaus.org/browse/JRUBY-2959
+
+* To generate coverage report with jruby (>= 1.1) follow instructions from http://www.ruby-forum.com/topic/146252 and run (inside jetty-rails root dir):
+jruby -S rake rcov
+
+* Hoe in jruby has an issue reading the ~/.hoerc file. Just remove it.
+
+== USAGE:
+
+=== Rails:
+
+  cd myrailsapp
+  jruby -S jetty_rails
+  
+help option shows usage details:
+  
+  jruby -S jetty_rails --help
+  
+=== Merb:
+
+  cd mymerbapp
+  jruby -S jetty_merb
+
+help option shows usage details:
+
+  jruby -S jetty_merb --help
+
+=== Merb:
+
+  cd mymerbapp
+  jruby -S jetty_merb
+
+help option shows usage details:
+
+  jruby -S jetty_merb --help
+
+
+== REQUIREMENTS:
+
+jetty-rails requires jruby (>=1.1). Please make sure you already have 
+it properly installed and inserted in your PATH environment variable.
+
+{Installing JRuby Instructions}[http://wiki.jruby.org/wiki/Getting_Started]
+
+== INSTALL:
+
+  jruby -S gem install jetty-rails
+  
+== BUGS AND NEW FEATURES
+
+Using Lighthouse: http://fabiokung.lighthouseapp.com/projects/12666-jetty-rails
+
+
+== MULTIPLE SERVERS:
+
+You can specify a configuration yaml file rather than command line switches. 
+The file also allows specifying multiple servers and / or application contexts for single jetty container.
+
+For example, you could set a context_path of /testA on port 8888 which is rails, /testB also that port which is merb.
+Or, you could have /testA on port 8888 and /testB on port 9999.
+
+ jruby -S jetty_rails -c path/to/config.yml
+
+The configuration options are inherited, so if you specify the environment to be "production" at the top level, 
+then any servers and application context will be "production" unless the choose to override the value.
+
+- server settings:
+  <tt>:port</tt>, <tt>:jruby_min_runtimes</tt>, <tt>:jruby_max_runtimes</tt>, <tt>:thread_pool_max</tt>, <tt>:thread_pool_min</tt>, <tt>:acceptor_size</tt>
+
+- application context settings:
+  <tt>:context_path</tt>, <tt>:base</tt>, <tt>:adapter</tt>, <tt>:environment</tt>, <tt>:lib_dir</tt>, <tt>:gem_path</tt>
+
+As part of the configuration you have some control over jruby & jetty.
+
+See spec/config.yml, spec/jetty_rails_sample_1.yml, and spec/jetty_rails_sample_2.yml for more examples.
+
+=== Rails:
+
+If -c is not specified, by default jetty_rails will look for a config/jetty_rails.yml relative to where it is started.
+
+Don't forget to add this into your config/environment.rb
+ActionController::AbstractRequest.relative_url_root = "/testA"
+
+
+=== JRuby Configuration
+
+You can tweak the JRuby runtimes per application context:
+
+  jruby_min_runtimes: 1
+  jruby_max_runtimes: 2
+
+
+=== Jetty Configuration
+
+You can also modify the jetty per server configurations:
+
+Thread pool will define the thread pool available to the jetty server using a QueuedThreadPool.
+
+  thread_pool_max: 40
+  thread_pool_min: 1
+
+
+The acceptor size is the number of acceptor threads available for that server's channel connector.
+
+  acceptor_size: 20
+
+See the jetty documentation for more information.
+
+
+== LICENSE:
+
+Jetty Rails is distributed under the terms of The MIT License.
+Copyright (c) 2008 Fabio Kung <fabio.kung@gmail.com>
+  
+Read more details in the bundled +Licenses.txt+ file. There are other 
+pieces of software bundled with jetty-rails. Before using jetty-rails, 
+make sure you agree with all of them.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/TODO.txt

@@ -0,0 +1,11 @@
+== TODO never ends...
+
+* Improve RDocs
+* integration test for lib_dir jars loading
+* read configuration from warble.rb
+* install custom resources from warbler configuration
+* add custom classes from warble.rb to the context classpath
+* add custom jars from warble.rb to the context classpath
+* support config/web.xml.erb
+* read any custom jetty.xml
+* support jetty-plus features (i.e.: jndi)

data/bin/jetty_merb

@@ -0,0 +1,41 @@
+#!/usr/bin/env jruby
+
+# == Synopsis
+#
+# jetty_merb: jetty server for merb applications
+#
+# == Usage
+#
+# jetty_merb [OPTION] ... BASEDIR
+#
+# -h, --help::
+#    show help
+#
+# --context-path PATH, -u PATH::
+#    change the application context path (default: '/')
+#
+# --port PORT, -p PORT::
+#    change server port (default: 4000)
+#
+# --environment ENV, -e ENV::
+#    change rails environment (default: development)
+#
+# --classes CLASSES_DIR::
+#    directory containing java classes used by the application (default: 'classes/')
+#
+# --lib LIB_DIR, --jars LIB_DIR::
+#    directory containing jars used by the application (default: 'lib/')
+#
+# --config FILE, -c FILE:: (optional)
+#	config file to use instead of command line switches (allows for multiple servers)
+#
+# BASEDIR (optional): directory to be run (default: current).
+
+require "java"
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../jetty-libs"
+require "jetty_rails"
+
+options = CommandLineReader.new.read(:merb)
+runner = JettyRails::Runner.new(options)
+runner.start

data/bin/jetty_rails

@@ -0,0 +1,41 @@
+#!/usr/bin/env jruby
+
+# == Synopsis
+#
+# jetty_rails: jetty server for rails applications
+#
+# == Usage
+#
+# jetty_rails [OPTION] ... BASEDIR
+#
+# -h, --help::
+#    show help
+#
+# --context-path PATH, -u PATH::
+#    change the application context path (default: '/')
+#
+# --port PORT, -p PORT::
+#    change server port (default: 3000)
+#
+# --environment ENV, -e ENV::
+#    change rails environment (default: development)
+#
+# --classes CLASSES_DIR::
+#    directory containing java classes used by the application (default: 'classes/')
+#
+# --lib LIB_DIR, --jars LIB_DIR::
+#    directory containing jars used by the application (default: 'lib/')
+#
+# --config FILE, -c FILE:: (optional)
+#	config file to use instead of command line switches (allows for multiple servers)
+#
+# BASEDIR (optional): directory to be run (default: current).
+
+require "java"
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../jetty-libs"
+require "jetty_rails"
+
+options = CommandLineReader.new.read(:rails)
+runner = JettyRails::Runner.new(options)
+runner.start

data/config/hoe.rb

@@ -0,0 +1,76 @@
+require 'jetty_rails/version'
+
+AUTHOR = 'Fabio Kung'  # can also be an array of Authors
+EMAIL = "fabio.kung@gmail.com"
+DESCRIPTION = "jetty server for rails applications"
+GEM_NAME = 'jetty-rails' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'jetty-rails' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+ ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = JettyRails::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'jetty-rails documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--exclude", "*.jar",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["spec/**/*_spec.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = EXTRA_DEPENDENCIES
+  p.rdoc_pattern = /^(lib|bin|ext).*[^\.jar]$|txt$/
+
+  # A hash of extra values to set in the gemspec.
+  # p.spec_extras = {
+    # :platform => "java"
+  # }
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,16 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+gem 'hoe', '<= 1.8.2'
+%w[rake hoe rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/jetty_rails/adapters/abstract_adapter.rb

@@ -0,0 +1,25 @@
+module JettyRails
+  module Adapters
+    class AbstractAdapter
+      attr_reader :config
+      
+      def initialize(config)
+        @config = config
+      end
+      
+      def base_init_params()
+        @base_init_params ||= { 
+          'public.root' => '/public',
+          'gem.path' => config[:gem_path] || ENV['GEM_PATH'] || 'tmp/war/WEB-INF/gems',
+          'jruby.initial.runtimes' => "#{config[:jruby_min_runtimes]}",
+          'jruby.min.runtimes' => "#{config[:jruby_min_runtimes]}",
+          'jruby.max.runtimes' => "#{config[:jruby_max_runtimes]}"
+        }
+      end
+      
+      def event_listeners
+        []
+      end
+    end
+  end
+end

data/lib/jetty_rails/adapters/merb_adapter.rb

@@ -0,0 +1,34 @@
+module JettyRails
+  module Adapters
+    
+    class MerbAdapter < AbstractAdapter
+      
+      def init_params
+        # please refer to goldspike and jruby-rack documentation
+        @merb_params ||= {
+          'merb.root' => '/',
+          'merb.environment' => config[:environment]
+        }.merge(base_init_params)
+      end
+      
+      def event_listeners
+        [ Rack::MerbServletContextListener.new, SignalHandler.new ]
+      end
+      
+      class SignalHandler
+        include Java::JavaxServlet::ServletContextListener
+        
+        def contextInitialized(cfg)
+          trap("INT") do
+            puts "\nbye!"
+            java.lang.System.exit(0)
+          end
+        end
+        
+        def contextDestroyed(cfg)
+        end
+      end
+      
+    end
+  end
+end

data/lib/jetty_rails/adapters/rails_adapter.rb

@@ -0,0 +1,22 @@
+module JettyRails
+  module Adapters
+    
+    class RailsAdapter < AbstractAdapter
+            
+      def init_params
+        # please refer to goldspike and jruby-rack documentation
+        # in: PoolingRackApplicationFactory 
+        @rails_params ||= {
+          'rails.root' => '/',
+          'rails.env' => config[:environment]
+        }.merge(base_init_params)
+      end
+      
+      def event_listeners
+        [ Rack::RailsServletContextListener.new ]
+      end
+      
+    end
+    
+  end
+end

data/lib/jetty_rails/config/command_line_reader.rb

@@ -0,0 +1,73 @@
+require 'getoptlong'
+require 'jetty_rails/config/rdoc_fix'
+
+
+class CommandLineReader
+
+  def default_config()
+    @@config ||= {
+      :rails => { 
+        :base => Dir.pwd,
+        :port => 3000,
+        :config_file => "#{File.join(Dir.pwd, 'config', 'jetty_rails.yml')}",
+        :adapter => :rails
+      },
+      :merb => {
+        :base => Dir.pwd,
+        :port => 4000,
+        :config_file => "#{File.join(Dir.pwd, 'config', 'jetty_merb.yml')}",
+        :adapter => :merb
+      }
+    }
+  end
+
+  def read(default_adapter = :rails)
+    config = default_config[default_adapter]
+    
+    opts = GetoptLong.new(
+      [ '--version', '-v', GetoptLong::NO_ARGUMENT ],
+      [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+      [ '--context-path', '-u', GetoptLong::REQUIRED_ARGUMENT ],
+      [ '--port', '-p', GetoptLong::REQUIRED_ARGUMENT ],
+      [ '--environment', '-e', GetoptLong::REQUIRED_ARGUMENT ],
+      [ '--lib', '--jars', GetoptLong::REQUIRED_ARGUMENT ],
+      [ '--classes', GetoptLong::REQUIRED_ARGUMENT ],
+      [ '--config', '-c', GetoptLong::OPTIONAL_ARGUMENT ]
+    )
+    
+    opts.each do |opt, arg|
+      case opt
+        when '--version'
+          require 'jetty_rails/version'
+          puts "JettyRails version #{JettyRails::VERSION::STRING} - http://jetty-rails.rubyforge.org"
+          exit(0)
+        when '--help'
+          RDoc::usage
+        when '--context-path'
+          config[:context_path] = arg
+        when '--port'
+          config[:port] = arg.to_i
+        when '--environment'
+          config[:environment] = arg
+        when '--classes'
+          config[:classes_dir] = arg
+        when '--lib'
+          config[:lib_dir] = arg
+    	  when '--config'
+    	    config[:config_file] = arg if !arg.nil? && arg != ""
+      end
+    end
+
+    config[:base] = ARGV.shift unless ARGV.empty?
+    
+    if File.exists?(config[:config_file])
+      config.merge!(YAML.load_file(config[:config_file]))
+      puts "Loaded #{config[:config_file]}"
+    end
+    
+    config
+  end  
+  
+end
+
+

data/lib/jetty_rails/config/rdoc_fix.rb

@@ -0,0 +1,28 @@
+require 'rdoc/usage'
+
+# fix to work with rubygems (use current file instead of main)
+def RDoc.usage_no_exit(*args)
+  comment = File.open(File.join(File.dirname(__FILE__), %w(.. .. .. bin), File.basename($0))) do |file|
+    find_comment(file)
+  end
+
+  comment = comment.gsub(/^\s*#/, '')
+
+  markup = SM::SimpleMarkup.new
+  flow_convertor = SM::ToFlow.new
+
+  flow = markup.convert(comment, flow_convertor)
+
+  format = "plain"
+
+  unless args.empty?
+    flow = extract_sections(flow, args)
+  end
+
+  options = RI::Options.instance
+  if args = ENV["RI"]
+    options.parse(args.split)
+  end
+  formatter = options.formatter.new(options, "")
+  formatter.display_flow(flow)
+end