trinidad 0.3.0

data/History.txt

@@ -0,0 +1,19 @@
+== 0.3.0 (2009-07-07)
+
+* project renamed due to tomcat legal issues
+
+== 0.2.0 (2009-06-23)
+
+* custom configuration from a yaml file
+* load options from a custom web.xml
+
+== 0.1.2
+
+* Autoload application custom jars and classes.
+* Added some specs.
+* Server refactor.
+
+== 0.1
+
+* Initial release.
+* Running default rails applications.

data/LICENSE

@@ -0,0 +1,26 @@
+== Trinidad
+
+Copyright (c) 2009 David Calavera
+
+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
+
+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.

data/README.rdoc

@@ -0,0 +1,36 @@
+= trinidad
+
+Trinidad allows you to run a rails application within an embedded Apache Tomcat container.
+
+This project was initially called "Tomcat-rails" but due to legal issues with the ASF and the Tomcat trademark it has been renamed.
+
+== INSTALL:
+
+  jgem install trinidad
+  jgem install calavera-trinidad -s http://gems.github.com
+
+== USAGE:
+
+  cd myrailsapp
+  jruby -S trinidad
+  
+== CONFIGURATION:
+
+Trinidad allows you to configure some parameters when the server is started from the command line, the following is a list of the currently supported options:
+
+  * -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.
+
+The server can also be configured from a yaml file. If a file is not especified, the server tries to load the file <em>config/tomcat.yml</em>. Within this file you can add other options like jruby.min.runtimes(:jruby_min_runtimes) or jruby.max.runtimes(:jruby_max_runtimes).
+
+  jruby -S trinidad -f
+  jruby -S trinidad --config my_custom_configuration.yml
+
+You can also specify a default web.xml to config your web application. By default the server tries to load the file <em>config/web.xml</em> but you can modify this path adding the option <em>default_web_xml</em> within your configuration file. 
+
+== Copyright
+
+Copyright (c) 2009 David Calavera<calavera@apache.org>. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "trinidad"
+    gem.summary = %Q{Simple library to run rails applications into an embedded Tomcat}
+    gem.email = "david.calavera@gmail.com"
+    gem.homepage = "http://calavera.github.com/trinidad"
+    gem.authors = ["David Calavera"]
+    gem.rubyforge_project = 'trinidad'
+
+    gem.files = FileList['bin/*', 'lib/**/*.rb', 'trinidad-libs/*.jar', 'History.txt', 'LICENSE', 'Rakefile', 'README.rdoc', 'VERSION']      
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = ['--options', "spec/spec.opts"]
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = ['--options', "spec/spec.opts"]
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "trinidad #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/trinidad/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/bin/trinidad

@@ -0,0 +1,9 @@
+#!/usr/bin/env jruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../trinidad-libs')
+
+require "trinidad"
+
+opts = Trinidad::CommandLineParser.parse
+Trinidad::Server.new(opts).start

data/lib/trinidad/command_line_parser.rb

@@ -0,0 +1,66 @@
+module Trinidad
+  require 'optparse'
+  
+  class CommandLineParser
+    def self.parse
+      default_options = {
+        :port => 3000,
+        :environment => 'development',
+        :context_path => '/',
+        :libs_dir => 'lib',
+        :classes_dir => 'classes',
+        :config => 'config/tomcat.yml'
+      }
+      
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Trinidad server default options:'
+        opts.separator ''
+
+        opts.on('-e', '--env ENVIRONMENT', 'Rails environment', 
+            "default: #{default_options[:environment]}") do |v| 
+          default_options[:environment] = v
+        end
+        
+        opts.on('-p', '--port PORT', 'Port to bind to', 
+            "default: #{default_options[:port]}") do |v| 
+          default_options[:port] = v
+        end
+        
+        opts.on('-c', '--context CONTEXT_PATH', 'The application context path', 
+            "default: #{default_options[:context_path]}") do |v| 
+          default_options[:context_path] = v
+        end
+        
+        opts.on('--lib', '--jars LIBS_DIR', 'Directory containing jars used by the application', 
+            "default: #{default_options[:libs_dir]}") do |v| 
+          default_options[:libs_dir] = v
+        end
+        
+        opts.on('--classes', '--classes CLASSES_DIR', 'Directory containing classes used by the application', 
+            "default: #{default_options[:classes_dir]}") do |v| 
+          default_options[:classes_dir] = v
+        end        
+
+        opts.on('-f', '--config [CONFIG_FILE]', 'Configuration file',
+            "default: #{default_options[:config]}") do |v|
+          default_options[:config] = v if v
+          default_options.merge! YAML.load_file(default_options[:config])
+        end
+        
+        opts.on('-v', '--version', 'display the current version') do
+          puts File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+          exit
+        end
+        
+        opts.on('-h', '--help', 'display the help') do
+          puts opts
+          exit
+        end
+          
+        opts.parse!(ARGV)
+      end
+      
+        default_options
+    end
+  end
+end

data/lib/trinidad/jars.rb

@@ -0,0 +1,26 @@
+module Trinidad
+  
+  require "servlet-api-2.5-6.1.14"
+  require "core-3.1.1"
+  require "jsp-api-2.1"
+  require "jsp-2.1"
+  require 'tomcat-core'
+  require 'jetty-util-6.1.14'
+  
+  require "jruby-rack-0.9.4"
+  
+  module Tomcat
+    include_package 'org.apache.catalina'
+    include_package 'org.apache.catalina.startup'
+    include_package 'org.apache.catalina.core'
+    include_package 'org.apache.catalina.deploy'
+    include_package 'org.apache.catalina.loader'
+    
+    include_package 'org.apache.naming.resources'
+  end
+  
+  module Rack
+    include_package "org.jruby.rack"
+    include_package "org.jruby.rack.rails"
+  end
+end

data/lib/trinidad/server.rb

@@ -0,0 +1,48 @@
+module Trinidad
+  class Server
+    
+    @@defaults = {
+      :environment => 'development',
+      :context_path => '/',
+      :libs_dir => 'lib',
+      :classes_dir => 'classes',
+      :default_web_xml => 'config/web.xml',
+      :port => 3000,
+      :jruby_min_runtimes => 1,
+      :jruby_max_runtimes => 5
+    }
+    
+    def initialize(config = {})
+      load_config(config)
+      load_tomcat_server
+      create_web_app      
+    end
+    
+    def load_config(config)
+      @config = @@defaults.merge!(config)
+      @config[:web_app_dir] = Dir.pwd
+    end
+    
+    def load_tomcat_server
+      @tomcat = Trinidad::Tomcat::Tomcat.new
+      @tomcat.setPort(@config[:port].to_i)
+    end
+    
+    def create_web_app
+      web_app = WebApp.new(@tomcat.addWebapp(@config[:context_path].to_s, @config[:web_app_dir]), @config)
+
+      web_app.load_default_web_xml
+      web_app.add_rack_filter
+      web_app.add_context_loader
+      web_app.add_init_params
+      web_app.add_web_dir_resources
+      
+      web_app.add_rack_context_listener
+    end
+
+    def start
+      @tomcat.start
+      @tomcat.getServer().await
+    end
+  end
+end

data/lib/trinidad/web_app.rb

@@ -0,0 +1,103 @@
+module Trinidad
+  class WebApp
+    attr_reader :context, :config
+    
+    def initialize(context, config)
+      @context = context
+      @config = config
+    end
+    
+    def add_rack_filter
+      unless rack_filter_configured?
+        filter_def = Trinidad::Tomcat::FilterDef.new
+        filter_def.setFilterName('RackFilter')
+        filter_def.setFilterClass('org.jruby.rack.RackFilter')
+
+        pattern = @config[:context_path][-1..-1] != '/' ? @config[:context_path] : @config[:context_path][0..-2]
+        filter_map = Trinidad::Tomcat::FilterMap.new
+        filter_map.setFilterName('RackFilter')
+        filter_map.addURLPattern("#{pattern}/*")
+
+        @context.addFilterDef(filter_def)
+        @context.addFilterMap(filter_map)
+      end
+    end
+    
+    def add_context_loader
+      class_loader = org.jruby.util.JRubyClassLoader.new(JRuby.runtime.jruby_class_loader)
+      add_application_libs(class_loader)
+      add_application_classes(class_loader)
+      
+      loader = Trinidad::Tomcat::WebappLoader.new(class_loader)
+
+      loader.container = @context
+      @context.loader = loader
+    end
+    
+    def add_init_params
+      [:jruby_min_runtimes, :jruby_max_runtimes].each do |param|
+        param_name = param.to_s.gsub(/_/, '.')
+        @context.addParameter(param_name, @config[param].to_s) unless @context.findParameter(param_name)
+      end
+      
+      @context.addParameter('jruby.initial.runtimes', @config[:jruby_min_runtimes].to_s) unless @context.findParameter('jruby.initial.runtimes')
+      @context.addParameter('rails.env', @config[:environment].to_s) unless @context.findParameter('rails.env')
+      @context.addParameter('rails.root', '/') unless @context.findParameter('rails.root')
+      @context.addParameter('public.root', '/public') unless @context.findParameter('public.root')
+    end
+    
+    def add_web_dir_resources
+      @context.setDocBase(File.join(@config[:web_app_dir], "public/"))
+    end
+    
+    def add_rack_context_listener
+      unless rack_listener_configured?
+        @context.addApplicationListener('org.jruby.rack.rails.RailsServletContextListener')
+      end
+    end
+    
+    def add_application_libs(class_loader)
+      resources_dir = File.join(@config[:web_app_dir], @config[:libs_dir], '**', '*.jar')
+      
+      Dir[resources_dir].each do |resource|
+        class_loader.addURL(java.io.File.new(resource).to_url)
+      end
+    end
+    
+    def add_application_classes(class_loader)
+      resources_dir = File.join(@config[:web_app_dir], @config[:classes_dir])
+      class_loader.addURL(java.io.File.new(resources_dir).to_url)
+    end
+
+    def load_default_web_xml
+      default_web_xml = File.expand_path(File.join(@config[:web_app_dir], @config[:default_web_xml]))
+      
+      if File.exist?(default_web_xml)
+        @context.setDefaultWebXml(default_web_xml)
+        @context.setDefaultContextXml(default_web_xml)
+
+        context_config = Trinidad::Tomcat::ContextConfig.new
+        context_config.setDefaultWebXml(default_web_xml)
+
+        @context.addLifecycleListener(context_config)
+      end
+    end
+
+    def rack_filter_configured?
+      return false if @context.getDefaultWebXml().nil?
+
+      web_xml = IO.read(@context.getDefaultWebXml())
+
+      return web_xml.include?('<servlet-class>org.jruby.rack.RackServlet') ||
+              web_xml.include?('<filter-class>org.jruby.rack.RackFilter')
+    end
+
+    def rack_listener_configured?
+      return false if @context.getDefaultWebXml().nil?
+
+      web_xml = IO.read(@context.getDefaultWebXml())
+
+      return web_xml.include?('<listener-class>org.jruby.rack.rails.RailsServletContextListener')
+    end
+  end
+end

data/lib/trinidad.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "java"
+require 'rubygems'
+
+require 'trinidad/command_line_parser'
+require 'trinidad/jars'
+require 'trinidad/server'
+require 'trinidad/web_app'
+
+module Trinidad
+  TRINIDAD_LIBS = File.dirname(__FILE__) + "/../trinidad-libs" unless defined?(TRINIDAD_LIBS)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../trinidad-libs')
+
+require 'java'
+require 'trinidad'

data/spec/trinidad/command_line_parser_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Trinidad::CommandLineParser do
+  it "should override classes option" do
+    ARGV = "--classes my_classes".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:classes_dir].should == 'my_classes'
+  end
+  
+  it "should override libs option with lib option" do
+    ARGV = "--lib my_libs".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:libs_dir].should == 'my_libs'
+  end
+  
+  it "should override libs option with jar option" do
+    ARGV = "--jars my_jars".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:libs_dir].should == 'my_jars'
+  end
+  
+  it "should override the config file when it's especified" do
+    ARGV = "-f #{File.join(File.dirname(__FILE__), '..', 'web_app_mock', 'tomcat.yml')}".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:environment].should == 'production'
+  end
+  
+end

data/spec/trinidad/web_app_spec.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Trinidad::WebApp do
+  before do
+    @tomcat = Trinidad::Tomcat::Tomcat.new
+    tomcat_web_app = @tomcat.addWebapp('/', File.dirname(__FILE__) + '/../../')
+    config = {
+      :libs_dir => 'lib',
+      :classes_dir => 'classes',
+      :default_web_xml => 'config/web.xml',
+      :web_app_dir => File.join(File.dirname(__FILE__), '..', 'web_app_mock'),
+      :jruby_min_runtimes => 2,
+      :jruby_max_runtimes => 6,
+      :context_path => '/'
+    }
+    @web_app = Trinidad::WebApp.new(tomcat_web_app, config)
+  end
+  
+  it "should load custom jars" do 
+    class_loader = org.jruby.util.JRubyClassLoader.new(JRuby.runtime.jruby_class_loader)
+    @web_app.add_application_libs(class_loader)
+    
+    resource = class_loader.find_class('org.ho.yaml.Yaml')
+    resource.should_not == nil
+  end
+
+  it "should load custom classes" do
+    class_loader = org.jruby.util.JRubyClassLoader.new(JRuby.runtime.jruby_class_loader)
+    @web_app.add_application_classes(class_loader)
+    
+    resource = class_loader.find_class('HelloTomcat')
+    resource.should_not == nil    
+  end
+
+  it "should start application context without errors" do
+    start_context
+  end
+
+  it "should add a filter from the default web.xml" do
+    start_context_with_web_xml
+    @web_app.context.findFilterDefs().size().should == 1
+  end
+
+  it "shouldn't duplicate init params" do
+    start_context_with_web_xml
+    lambda { @web_app.add_init_params }.should_not raise_error
+  end
+  
+  it "should load init params" do
+    @web_app.add_init_params
+    
+    @web_app.context.findParameter('jruby.min.runtimes').should == '2'
+    @web_app.context.findParameter('jruby.max.runtimes').should == '6'
+  end
+
+  it "should configure rack filter" do
+    @web_app.add_rack_filter
+    @web_app.context.findFilterDefs().size().should == 1
+  end
+
+  it "should configure rack listener" do
+    @web_app.add_rack_context_listener
+    @web_app.context.findApplicationListeners().size().should == 1
+  end
+
+  it "should have rack filter already configured" do
+    @web_app.load_default_web_xml
+    @web_app.rack_filter_configured?().should == true
+
+    @web_app.add_rack_filter
+    @web_app.context.findFilterDefs().size().should == 0
+  end
+
+  it "should have rack listener already configured" do
+    @web_app.load_default_web_xml
+    @web_app.rack_listener_configured?().should == true
+
+    @web_app.add_rack_context_listener
+    @web_app.context.findApplicationListeners().size().should == 0
+  end
+
+  def start_context_with_web_xml
+    @web_app.load_default_web_xml
+    start_context
+  end
+
+  def start_context
+    load_tomcat_libs
+    lambda { @web_app.context.start }.should_not raise_error
+  end
+
+  def load_tomcat_libs
+    @web_app.config[:libs_dir] = File.join(File.dirname(__FILE__), '..', '..', 'tomcat-libs')
+    @web_app.add_context_loader
+  end
+  
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: trinidad
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-07 00:00:00 +02:00
+default_executable: trinidad
+dependencies: []
+
+description: 
+email: david.calavera@gmail.com
+executables: 
+- trinidad
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- History.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/trinidad
+- lib/trinidad.rb
+- lib/trinidad/command_line_parser.rb
+- lib/trinidad/jars.rb
+- lib/trinidad/server.rb
+- lib/trinidad/web_app.rb
+- trinidad-libs/core-3.1.1.jar
+- trinidad-libs/jasper-el.jar
+- trinidad-libs/jasper-jdt.jar
+- trinidad-libs/jasper.jar
+- trinidad-libs/jetty-util-6.1.14.jar
+- trinidad-libs/jruby-rack-0.9.4.jar
+- trinidad-libs/jsp-2.1.jar
+- trinidad-libs/jsp-api-2.1.jar
+- trinidad-libs/servlet-api-2.5-6.1.14.jar
+- trinidad-libs/tomcat-core.jar
+- trinidad-libs/tomcat-dbcp.jar
+- trinidad-libs/tomcat-jasper.jar
+has_rdoc: true
+homepage: http://calavera.github.com/trinidad
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: trinidad
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Simple library to run rails applications into an embedded Tomcat
+test_files: 
+- spec/spec_helper.rb
+- spec/trinidad/command_line_parser_spec.rb
+- spec/trinidad/web_app_spec.rb