trinidad 1.4.1 → 1.4.3

data/Gemfile

@@ -1,9 +1,22 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec :name => "trinidad"
 
-# for the integration tests :
-group :test do
-  gem "rails", "~> 3.2"
+# NOTE: allows testing with various jar versions
+if (jars = ENV['trinidad_jars']) && jars != 'false'
+  if jars =~ /\d\.\d\.\d/
+    # concrete version e.g. '1.0.8' or '>= 1.0.8'
+    gem 'trinidad_jars', jars
+  else
+    # pre-release version e.g. `export trinidad_jars=true`
+    gem 'trinidad_jars', :path => (jars == 'true' ? '.' : jars)
+  end
+end
+
+gem 'sinatra', :require => nil, :group => :test
+
+group :integration do
+  gem "rails", "~> 3.2.8"
   gem "jruby-openssl"
+  #eval(File.read("spec/integration/rails32/Gemfile"), binding)
 end

data/History.txt

@@ -1,3 +1,60 @@
+== Trinidad 1.4.3 (2012-09-20)
+
+* allow to keep (and configure) the jsp servlet (support for serving .jsp pages)
+* decreased jruby.runtime.acquire.timeout default from 10 to 5 seconds
+* removed Threads=MIN:MAX option from Rack::Handler (makes no sense right now)
+* trinidad (CLI) :
+  - added --runtimes option to allow specifying pool size on command-line
+  - deprecated libs_dir and classes_dir added java_lib and java_classes
+  - deprecated --apps option and use the same name as in config --apps_base
+  - now prints some more accurate defaults that are used
+* leverage Tomcat's default servlet for serving static asset files :
+  - use a customized default servlet to handle the public.root assets
+  - support for providing aliases (to achieve desired backward compatibility)
+  - support for allowing caching and tuning (asset) cache parameters
+* allow absolute paths with :default_web_xml / :web_xml configuration option
+* replace :libs_dir and :classes_dir with :java_lib and :java_classes options 
+  (backwards compatible) with sensible defaults *lib/java* and *lib/java/classes*
+* make sure application :work_dir is actually being set on the context
+  and change it by default to to [RAILS_ROOT]/tmp 
+* web application's :web_app_dir deprecated in favor of the :root_dir option
+* make sure the rack servlet loads on startup by default
+* allow init_params: to be configured with (rack/default) servlet options
+* allow for default (servlet) overrides using default_servlet:
+* better rack_servlet: configuration
+  - accepts a servlet instance (and assumes it is configured)
+  - 'rack' naming convention might be used to use custom servlet class
+  - support for servlet :mapping and :load_on_startup options
+* fix async_supported: option not propagating correctly into servlet
+* support for loading META-INF/context.xml from the (classes) class-path
+
+Requires JRuby-Rack >= 1.1.10 and thus includes the following features :
+
+ - Rails 3.1+ `render stream: true` support with HTTP chunked encoding
+ - initial compatibility with Rails master (getting torwards 4.0.0.beta)
+ - all Rack applications now support pooling runtimes (not just Rails)
+ - better and more predictable application pool initialization
+ - support for fully leveraging the Servlet API for parameters/cookies
+   this is useful for Java integration cases when a servlet/filter consumes
+   the input stream before Rails (e.g. valves such as AccessLogValve).
+   it is an experimental feature that might change in the future and 
+   currently requires setting 'jruby.rack.handler.env' param to 'servlet'
+
+== Trinidad_jars 1.1.0 (2012-09-20)
+
+* include java code compiled into trinidad-rb.jar for Trinidad
+* otherwise same as previous version (1.0.7) uses Tomcat 7.0.30
+
+== Trinidad 1.4.2 (2012-09-19) YANKED
+
+== Trinidad_jars 1.0.7 (2012-09-12)
+
+* Tomcat 7.0.30 http://tomcat.apache.org/tomcat-7.0-doc/changelog.html
+
+== Trinidad_jars 1.0.6 (2012-08-21)
+
+* Tomcat 7.0.29 http://tomcat.apache.org/tomcat-7.0-doc/changelog.html
+
 == Trinidad 1.4.1 (2012-08-17)
 
 * make sure file logging rotates correctly when file handler attempts rolling 

data/LICENSE

@@ -1,6 +1,6 @@
 == Trinidad
 
-Copyright (c) 2009-2012 David Calavera
+Copyright (c) 2012 Team Trinidad and contributors http://github.com/trinidad
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -21,7 +21,8 @@ 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
+== Tomcat
 
-Apache Tomcat is licensed according to the terms of Apache License, Version 2.0 (current). 
-See http://www.apache.org/licenses/LICENSE-2.0 for details.
+Apache Tomcat (Copyright 1999-2012 The Apache Software Foundation) 
+is licensed under the Apache License, Version 2.0.
+See http://www.apache.org/licenses/LICENSE-2.0 for details.

data/README.md

@@ -30,7 +30,7 @@ gem 'trinidad', :require => nil
 
 **Rails**
 
-If you have Trinidad in your Gemfile you can start it with `rails server`:
+If you have Trinidad in your *Gemfile* you can start it with `rails server`:
 
 ```
 $ rails s trinidad
@@ -73,24 +73,41 @@ Or you can set Trinidad by default in your `config.ru` file:
 #\ -s trinidad
 ```
 
+We do recommend to use the plain `trinidad` command for running applications 
+(in production), since it supports runtime pooling while the rackup mode does
+not, it also provides you with better Java integration possibilities.
+
+Also note that Trinidad does not mimic JRuby-Rack's behavior of starting a pool
+for Rails but booting plain Rack applications in a thread-safe manner  by 
+default (this is due backwards compatibility). Currently, runtime pooling is the 
+default with Trinidad and stays the same no matter the type of the application
+you're running. We expect this default to most likely change in future versions
+of Trinidad as thread-safe gets more adopted by the release of Rails 4.0.
+
 ## Configuration
 
 Trinidad allows you to configure parameters from the command line, the following 
 is a list of the currently supported options (try `trinidad -h`):
 
 ```
-  * -p, --port PORT               =>  port to bind to.
-  * -e, --env ENVIRONMENT         =>  rails environment.
-  * -c, --context CONTEXT         =>  application context path.
-  * --lib, --jars LIBS_DIR        =>  directory containing jars.
-  * --classes CLASSES_DIR         =>  directory containing classes.
-  * -r, --rackup [RACKUP_FILE]    =>  run a provided rackup file instead of a rails application, by default it's config.ru.
-  * --public PUBLIC_DIR           =>  specify the public directory for your application, by default it's 'public'.
-  * -t, --threadsafe              =>  shortcut to work in threadsafe mode. Setting jruby_min_runtimes and jruby_max_runtimes to 1 in the configuration file the server behaves as the same way.
-  * -l, --load EXTENSION_NAMES    =>  load extensions to use their command line options.
-  * --address HOST                =>  set the server host.
-  * -g, --log LEVEL               =>  set the log level, default INFO.
-  * --apps APPS_BASE_DIRECTORY    =>  set the applications base directory.
+  * -d, --dir ROOT_DIR            =>  web application root directory
+  * -e, --env ENVIRONMENT         =>  rack (rails) environment
+  * --rackup [RACKUP_FILE]        =>  rackup configuration file
+  * --public PUBLIC_DIR           =>  web application public root
+  * -c, --context CONTEXT         =>  application context path
+  * --monitor MONITOR_FILE        =>  monitor for application re-deploys
+  * -t, --threadsafe              =>  force thread-safe mode (use single runtime)
+  * --runtimes MIN:MAX            =>  use given number of min/max jruby runtimes
+  * -f, --config [CONFIG_FILE]    =>  configuration file
+  * --address ADDRESS             =>  host address
+  * -p, --port PORT               =>  port to bind to
+  * -s, --ssl [SSL_PORT]          =>  enable secure socket layout
+  * -a, --ajp [AJP_PORT]          =>  enable the AJP web protocol
+  * --java_lib LIB_DIR            =>  contains .jar files used by the app
+  * --java_classes CLASSES_DIR    =>  contains java classes used by the app
+  * -l, --load EXTENSION_NAMES    =>  load options for extensions
+  * --apps_base APPS_BASE_DIR     =>  set applications base directory
+  * -g, --log LEVEL               =>  set logging level
 ```
 
 You can also specify a default *web.xml* to configure your web application. 
@@ -128,6 +145,7 @@ configuration - the file `config/trinidad.rb` is loaded by default if exists.
 Trinidad.configure do |config|
   config.port = 4242
   config.address = '0.0.0.0'
+  #config[:custom] = 'custom'
 end
 ```
 
@@ -162,12 +180,57 @@ If this is not enough you can still configure a Java logging library e.g. SLF4J,
 just make sure you tell Trinidad to use it as well, if needed, using the 
 **jruby.rack.logging** context parameter in *web.xml*.
 
+### Context Configuration
+
+For slightly advanced (and "dirty" XML :)) application configuration Trinidad 
+also supports the exact same *context.xml* format as Tomcat. Each web app is 
+represented as a context instance and might be configured as such. You do not 
+need to repeat configuring the same parameters you have already setup with the 
+Trinidad configuration. This is meant to be mostly for those familiar with 
+Tomcat internals.
+Currently the application's *context.xml* is expected to be located on the 
+class-path under your *[classes]/META-INF* directory.
+
+Context Doc: http://tomcat.apache.org/tomcat-7.0-doc/config/context.html
+
+### Serving Assets
+
+Trinidad uses Tomcat's built-in capabilities to server your public files. 
+We do recommend compiling assets up front and disabling the asset server (in 
+production) if you're using the asset pipeline in a Rails application.
+If you do not put a web-server such as Apache in front of Trinidad you might
+want to configure the resource caching (on by default for env != development)
+for maximum performance e.g. by default it's configured as follows :
+
+```yml
+---
+  public: 
+    root: public # same as the above "public: public" setting
+    cached: true # enable (in-memory) asset caching on for env != 'development'
+    cache_ttl: 5000 # cache TTL in millis (might want to increase this)
+    cache_max_size: 10240 # the maximum cache size in kB
+    cache_object_max_size: 512 # max size for a cached object (asset) in kB
+    #aliases: # allows to "link" other directories into the public root e.g. :
+      #/home: /var/local/www
+```
+
+Note that this configuration applies to (server-side) resource caching on top 
+of the "public" file-system. You do not need to worry about client side caching, 
+it is handled out of the box with *ETag* and *Last-Modified* headers being set.
+
+You might also "mount" file-system directories as aliases to your resources
+root to be served by your application (as if they were in the public folder).
+
+**NOTE:** In development mode if you ever happen to `rake assets:precompile` 
+make sure to remove your *public/assets* directory later, otherwise requests
+such as **/assets/application.js?body=1.0** might not hit the Rails runtime.
+
 ## Hot Deployment
 
 Trinidad supports monitoring a file to reload applications, when the file 
 *tmp/restart.txt* is updated (e.g. `touch tmp/restart.txt`), the server reloads 
-the application the file belongs. 
-The file monitor can be customized with the `monitor` configuration option.
+the application the monitor file belongs to. 
+This monitor file can be customized with the `monitor` configuration option.
 
 Since version **1.4.0** Trinidad supports 2 reload strategies :
 
@@ -239,18 +302,27 @@ end
 Trinidad allows to extend itself with more (not just Tomcat) features, 
 here is a list of the available extensions that are "officially supported":
 
-* Database Connection Pooling: http://github.com/trinidad/trinidad_dbpool_extension
-* Daemonize Trinidad, based on Akuma: http://github.com/trinidad/trinidad_daemon_extension
-* Init Services (for Unix and Windows), based on Commons Daemon: http://github.com/trinidad/trinidad_init_services
-* Logging, enhance Trinidad's logging system: http://github.com/trinidad/trinidad_logging_extension
-* Application and Server Lifecycle Management: http://github.com/trinidad/trinidad_lifecycle_extension
-* Trinidad's Management Console and REST API: http://github.com/trinidad/trinidad_sandbox_extension
-* Scheduler, based on Quartz: http://github.com/trinidad/trinidad_scheduler_extension
-* Valves - components inserted into the request pipeline (e.g. Access Log): http://github.com/trinidad/trinidad_valve_extension
+* Database Connection Pooling: 
+  http://github.com/trinidad/trinidad_dbpool_extension
+* Daemonize Trinidad, based on Akuma: 
+  http://github.com/trinidad/trinidad_daemon_extension
+* Init Services (for Unix and Windows), based on Commons Daemon: 
+  http://github.com/trinidad/trinidad_init_services
+* Logging, enhance Trinidad's logging system: 
+  http://github.com/trinidad/trinidad_logging_extension
+* Application and Server Lifecycle Management: 
+  http://github.com/trinidad/trinidad_lifecycle_extension
+* Trinidad's Management Console and REST API: 
+  http://github.com/trinidad/trinidad_sandbox_extension
+* Scheduler, based on Quartz: 
+  http://github.com/trinidad/trinidad_scheduler_extension
+* Valves - components inserted into the request pipeline (e.g. Access Log): 
+  http://github.com/trinidad/trinidad_valve_extension
 
 You can find further information on how to write extensions in the wiki: 
 http://wiki.github.com/trinidad/trinidad/extensions
 
 ## Copyright
 
-Copyright (c) 2011-2012 David Calavera. See LICENSE for details.
+Copyright (c) 2012 [Team Trinidad](https://github.com/trinidad). 
+See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/Rakefile

@@ -1,41 +1,101 @@
-require 'rubygems'
-require 'rake'
+begin
+  require 'bundler/gem_helper'
+rescue LoadError
+  require 'rubygems'
+  require 'bundler/gem_helper'
+end
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color', "--format documentation"]
+end
 
-def version(file, constant)
- line = File.read(file)[/^\s*#{constant}\s*=\s*.*/]
- line.match(/.*#{constant}\s*=\s*['"](.*)['"]/)[1]
+desc "Remove all build artifacts"
+task :clear do
+  sh "rm -rf pkg/"
 end
+task :clean => :clear
 
-def build(gemspec_file, gem_file)
-  mkdir_p 'pkg'
-  sh "gem build #{gemspec_file}"
-  mv gem_file, 'pkg'
+desc "Clear all jar artifacts"
+task :clear_jars => [ 'tomcat:clear', 'tomcat-core:clear', 'trinidad-rb:clear' ] do
 end
+task :clean_jars => :clear_jars
 
-def release(name, gem_file, version)
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
+['trinidad', 'trinidad_jars'].each do |name|
+  gem_helper = Bundler::GemHelper.new(Dir.pwd, name)
+  def gem_helper.version_tag
+    "#{name}-#{version}" # override "v#{version}"
   end
-  sh "git commit --allow-empty -a -m 'Release #{name} #{version}'"
-  sh "git tag #{name}-#{version}"
-  sh "git push origin master --tags"
-  sh "gem push pkg/#{gem_file}"
-end
+  version = gem_helper.send(:version)
+  version_tag = gem_helper.version_tag
+  namespace name do
+    desc "Build #{name}-#{version}.gem into the pkg directory"
+    task('build') { gem_helper.build_gem }
 
-{
-  :build => 'Build all Trinidad gems',
-  :install => 'Install all Trinidad gems',
-  :release => 'Release all Trinidad gems'
-}.each do |task, desc|
-  desc desc
-  task task => ["trinidad_jars:#{task}", "trinidad:#{task}"]
+    desc "Build and install #{name}-#{version}.gem into system gems"
+    task('install') { gem_helper.install_gem }
+
+    desc "Create tag #{version_tag} and build and push #{name}-#{version}.gem to Rubygems"
+    task('release') { gem_helper.release_gem }
+  end
 end
 
-require 'rspec/core/rake_task'
+TOMCAT_CORE_JAR = File.expand_path('../trinidad-libs/tomcat-core.jar', __FILE__)
+TRINIDAD_RB_JAR = File.expand_path('../trinidad-libs/trinidad-rb.jar', __FILE__)
 
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ['--color', "--format documentation"]
+module TrinidadRakeHelpers
+  
+  def javac(source_dir, target_dir, class_path = TOMCAT_CORE_JAR)
+    FileUtils.mkdir target_dir unless File.exist?(target_dir)
+    sh 'javac -Xlint:deprecation -Xlint:unchecked -g -source 1.6 -target 1.6 ' + 
+       "-classpath #{class_path} -d #{target_dir} " +
+       Dir["#{source_dir}/**/*.java"].join(" ")
+  end
+  
+  def jar(entries, jar_path)
+    work_dir = Dir.pwd
+    if entries.is_a?(String) && File.directory?(entries)
+      work_dir = entries
+      entries = Dir.entries(entries) - [ '.', '..' ]
+    end
+    Dir.chdir(work_dir) do
+      update = File.exist?(jar_path)
+      log "#{update ? 'updating' : 'creating'} #{jar_path}"
+      options = update ? '-uvf' : '-cvf'
+      %x{jar #{options} #{jar_path} #{entries.join(' ')}}
+    end
+  end
+  
+  def log(msg)
+    puts msg
+  end
+  
 end
 
-task :default => :spec
+namespace :'trinidad-rb' do
+  include TrinidadRakeHelpers
+  
+  TRINIDAD_RB_TARGET_DIR = File.expand_path('../target/trinidad-rb', __FILE__)
+  
+  task :compile do
+    javac "src/trinidad-rb/java", TRINIDAD_RB_TARGET_DIR
+  end
+  
+  task :jar => :compile do
+    rm TRINIDAD_RB_JAR if File.exist?(TRINIDAD_RB_JAR)
+    jar TRINIDAD_RB_TARGET_DIR, TRINIDAD_RB_JAR
+  end
+  
+  task :clear do
+    rm_r TRINIDAD_RB_TARGET_DIR if File.exist?(TRINIDAD_RB_TARGET_DIR)
+    rm TRINIDAD_RB_JAR if File.exist?(TRINIDAD_RB_JAR)
+  end
+  task :clean => :clear
+  
+end
+
+task :build   => 'trinidad:build'
+task :install => 'trinidad:install'
+task :release => 'trinidad:release'

data/lib/rack/handler/trinidad.rb

@@ -11,9 +11,7 @@ module Rack
     class Trinidad < Rack::Handler::Servlet
       def self.run(app, options={})
         opts = parse_options(options)
-
-        servlet = create_servlet(app)
-        opts[:servlet] = {:instance => servlet, :name => 'RackServlet'}
+        opts[:rack_servlet] = create_servlet(app)
 
         ::Trinidad::CommandLineParser.load(opts)
         server = ::Trinidad::Server.new
@@ -25,14 +23,14 @@ module Rack
         {
           "Host=HOST"       => "Hostname to listen on (default: localhost)",
           "Port=PORT"       => "Port to listen on (default: 8080)",
-          "Threads=MIN:MAX" => "min:max threads to use (default 1:1, threadsafe)",
+          #"Threads=MIN:MAX" => "min:max runtimes to use (default 1:1, threadsafe)",
         }
       end
 
       def self.parse_options(options = {})
         # some libs use :Port, :port and :Host, :host, unify this
         opts = {}
-        options.each {|k, v| opts[k.to_s.downcase.to_sym] = v}
+        options.each { |k, v| opts[k.to_s.downcase.to_sym] = v }
 
         # this is rack's configuration file but also the trinidad's configuration.
         # Removing it we allow to load trinidad's default configuration.

data/lib/trinidad.rb

@@ -1,17 +1,18 @@
 require 'java'
 
 require 'jruby-rack'
+require 'trinidad/jars'
 
 require 'trinidad/version'
-require 'trinidad/extensions'
+
 require 'trinidad/configuration'
 require 'trinidad/command_line_parser'
-require 'trinidad/jars'
+require 'trinidad/extensions'
 require 'trinidad/logging'
 require 'trinidad/server'
+require 'trinidad/web_app'
 require 'trinidad/lifecycle/base'
 require 'trinidad/lifecycle/host'
 require 'trinidad/lifecycle/web_app/shared'
 require 'trinidad/lifecycle/web_app/default'
 require 'trinidad/lifecycle/web_app/war'
-require 'trinidad/web_app'