trinidad 0.8.2 → 0.8.3

data/History.txt

@@ -1,3 +1,9 @@
+== 0.8.3 (2010-04-17)
+
+* Extensions improvements:
+    - Enable command line extensions.
+    - Allow to overload the server.
+
 == 0.8.2 (2010-04-09)
 
 * Fixes yaml parser error. Thank to @elskwid

data/README.rdoc

@@ -25,6 +25,8 @@ Trinidad allows you to configure some parameters when the server is started from
   * --classes CLASSES_DIR   =>    directory containing classes.
   * --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_NAME] => loads an extension to use its command line options.
 
 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).
 

data/VERSION

@@ -1 +1 @@
-0.8.2
+0.8.3

data/lib/trinidad.rb

@@ -16,4 +16,5 @@ require 'trinidad/rails_web_app'
 require 'trinidad/rackup_web_app'
 
 module Trinidad
+  VERSION = File.read(File.expand_path('../../VERSION', __FILE__))
 end

data/lib/trinidad/command_line_parser.rb

@@ -72,11 +72,20 @@ module Trinidad
           default_options[:public] = v
         end
 
+        opts.on('-t', '--threadsafe', 'Threadsafe mode') do
+          default_options[:jruby_min_runtimes] = 1
+          default_options[:jruby_max_runtimes] = 1
+        end
+
         opts.on('-v', '--version', 'display the current version') do
           puts File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
           exit
         end
 
+        opts.on('-l', '--load EXTENSION_NAME', 'load options for a given extension') do |name|
+          Trinidad::Extensions.configure_options_extensions({name => {}}, opts, default_options)
+        end
+
         opts.on('-h', '--help', 'display the help') do
           puts opts
           exit

data/lib/trinidad/extensions.rb

@@ -3,7 +3,7 @@ module Trinidad
     def self.configure_webapp_extensions(extensions, tomcat, app_context)
       if extensions
         extensions.each do |name, options|
-          extension(name, 'WebAppExtension').new(options).configure(tomcat, app_context)
+          extension(name, 'WebAppExtension', options).configure(tomcat, app_context)
         end
       end
     end
@@ -11,15 +11,26 @@ module Trinidad
     def self.configure_server_extensions(extensions, tomcat)
       if extensions
         extensions.each do |name, options|
-          extension(name, 'ServerExtension').new(options).configure(tomcat)
+          extension = extension(name, 'ServerExtension', options)
+          configured_tomcat = extension.configure(tomcat)
+          tomcat = configured_tomcat if extension.override_tomcat?
         end
       end
+      tomcat
     end
 
-    def self.extension(name, type)
+    def self.configure_options_extensions(extensions, parser, default_options)
+      if extensions
+        extensions.each do |name, options|
+          extension(name, 'OptionsExtension', options).configure(parser, default_options)
+        end
+      end
+    end
+
+    def self.extension(name, type, options)
       class_name = (name.to_s.camelize << type).to_sym
       load_extension(name) unless const_defined?(class_name)
-      const_get(class_name)
+      const_get(class_name).new(options)
     end
 
     def self.load_extension(name)
@@ -27,7 +38,7 @@ module Trinidad
     end
 
     class Extension
-      def initialize(options)
+      def initialize(options = {})
         @options = options.dup
       end
     end
@@ -42,6 +53,14 @@ module Trinidad
       def configure(tomcat)
         raise NotImplementedError, "#{self.class}#configure not implemented"
       end
+
+      def override_tomcat?; false; end # hack to allow override the tomcat's instance, it should be a better way
+    end
+
+    class OptionsExtension < Extension
+      def configure(parser, default_options)
+        raise NotImplementedError, "#{self.class}#configure not implemented"
+      end
     end
   end
 end

data/lib/trinidad/server.rb

@@ -38,7 +38,7 @@ module Trinidad
       add_ssl_connector if ssl_enabled?
       add_ajp_connector if ajp_enabled?
 
-      Trinidad::Extensions.configure_server_extensions(@config[:extensions], @tomcat)
+      @tomcat = Trinidad::Extensions.configure_server_extensions(@config[:extensions], @tomcat)
     end
 
     def create_web_apps

data/lib/trinidad/web_app.rb

@@ -40,12 +40,9 @@ module Trinidad
     end
 
     def add_init_params
-      [:jruby_min_runtimes, :jruby_max_runtimes].each do |param|
-        param_name = param.to_s.gsub(/_/, '.')
-        add_parameter_unless_exist(param_name, @config[param].to_s)
-      end
-
-      add_parameter_unless_exist('jruby.initial.runtimes', @config[:jruby_min_runtimes].to_s)
+      add_parameter_unless_exist('jruby.min.runtimes', jruby_min_runtimes.to_s)
+      add_parameter_unless_exist('jruby.max.runtimes', jruby_max_runtimes.to_s)
+      add_parameter_unless_exist('jruby.initial.runtimes', jruby_min_runtimes.to_s)
       add_parameter_unless_exist('public.root', File.join('/', public_root))
     end
 
@@ -74,14 +71,14 @@ module Trinidad
     end
 
     def load_default_web_xml
-      default_web_xml = File.expand_path(File.join(@app[:web_app_dir], default_web_xml_file))
+      file = File.expand_path(File.join(@app[:web_app_dir], default_web_xml))
 
-      if File.exist?(default_web_xml)
-        @context.setDefaultWebXml(default_web_xml)
-        @context.setDefaultContextXml(default_web_xml)
+      if File.exist?(file)
+        @context.setDefaultWebXml(file)
+        @context.setDefaultContextXml(file)
 
         context_config = Trinidad::Tomcat::ContextConfig.new
-        context_config.setDefaultWebXml(default_web_xml)
+        context_config.setDefaultWebXml(file)
 
         @context.addLifecycleListener(context_config)
       end
@@ -108,20 +105,11 @@ module Trinidad
       @context.findParameter('public.root') || @app[:public]  || @config[:public] || 'public'
     end
 
-    def libs_dir
-      @app[:libs_dir] || @config[:libs_dir]
-    end
-
-    def classes_dir
-      @app[:classes_dir] || @config[:classes_dir]
-    end
-
-    def default_web_xml_file
-      @app[:default_web_xml] || @config[:default_web_xml]
-    end
-
-    def environment
-      @app[:environment] || @config[:environment]
+    %w{libs_dir classes_dir default_web_xml environment jruby_min_runtimes jruby_max_runtimes}.each do |method_name|
+      define_method method_name do
+        sym = method_name.to_sym
+        @app[sym] || @config[sym]
+      end
     end
 
     def add_parameter_unless_exist(name, value)

data/spec/fixtures/trinidad_foo_extension.rb

@@ -1 +1,23 @@
-require File.dirname(__FILE__) + '/foo'
+module Trinidad
+  module Extensions
+    class FooWebAppExtension < WebAppExtension
+      def configure(tomcat, app_context)
+        @options
+      end
+    end
+
+    class FooServerExtension < ServerExtension
+      def configure(tomcat)
+        @options
+      end
+    end
+
+    class FooOptionsExtension < OptionsExtension
+      def configure(parser, default_options)
+        parser.on('--foo') do
+          default_options[:bar] = true
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/trinidad_override_tomcat_extension.rb

@@ -0,0 +1,11 @@
+module Trinidad
+  module Extensions
+    class OverrideTomcatServerExtension < ServerExtension
+      def configure(tomcat)
+        Trinidad::Tomcat::Tomcat.new
+      end
+
+      def override_tomcat?; true; end
+    end
+  end
+end

data/spec/trinidad/command_line_parser_spec.rb

@@ -3,68 +3,68 @@ 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(MOCK_WEB_APP_DIR, 'tomcat.yml')}".split
-    
+
     options = Trinidad::CommandLineParser.parse
     options[:environment].should == 'production'
   end
-  
+
   it "should add default ssl port to options" do
     ARGV = '--ssl'.split
-    
+
     options = Trinidad::CommandLineParser.parse
     options[:ssl].should == {:port => 8443}
   end
-  
+
   it "should add custom ssl port to options" do
     ARGV = '--ssl 8843'.split
-    
+
     options = Trinidad::CommandLineParser.parse
     options[:ssl].should == {:port => 8843}
   end
-  
+
   it "should add ajp connection with default port to options" do
     ARGV = '--ajp'.split
-    
+
     options = Trinidad::CommandLineParser.parse
     options[:ajp].should == {:port => 8009}
   end
-  
+
   it "should add ajp connection with coustom port to options" do
     ARGV = '--ajp 8099'.split
-    
+
     options = Trinidad::CommandLineParser.parse
     options[:ajp].should == {:port => 8099}
   end
-  
+
   it "should merge ajp options from the config file" do
     ARGV = "--ajp 8099 -f #{File.join(MOCK_WEB_APP_DIR, 'tomcat.yml')}".split
-    
+
     options = Trinidad::CommandLineParser.parse
     options[:ajp][:port].should == 8099
     options[:ajp][:secure].should == true
   end
-  
+
   it "uses default rackup file to configure the server" do
     ARGV = "--rackup".split
     options = Trinidad::CommandLineParser.parse
@@ -82,4 +82,18 @@ describe Trinidad::CommandLineParser do
     options = Trinidad::CommandLineParser.parse
     options[:public].should == 'web'
   end
+
+  it "works on threadsafe mode using the shortcut" do
+    ARGV = '--threadsafe'.split
+    options = Trinidad::CommandLineParser.parse
+    options[:jruby_min_runtimes].should == 1
+    options[:jruby_max_runtimes].should == 1
+  end
+
+  it "loads a given extension to add its options to the parser" do
+    ARGV = "--load foo --foo".split
+    options = Trinidad::CommandLineParser.parse
+    options.has_key?(:bar).should be_true
+
+  end
 end

data/spec/trinidad/extensions_spec.rb

@@ -16,4 +16,25 @@ describe Trinidad::Extensions do
     lambda {Trinidad::Extensions.configure_webapp_extensions(@extensions, nil, nil)}.should_not raise_error
     lambda {Trinidad::Extensions.const_get(:FooWebAppExtension)}.should_not raise_error
   end
+
+  it "adds options to the command line parser" do
+    options = {}
+    parser = OptionParser.new
+    lambda {
+      Trinidad::Extensions.configure_options_extensions({:foo => {}}, parser, options)
+    }.should_not raise_error
+
+    lambda {
+      parser.parse! ['--foo']
+      options.has_key?(:bar).should be_true
+    }.should_not raise_error
+  end
+
+  it "allows to override the tomcat's instance" do
+    extensions = {:override_tomcat => {}}
+    tomcat = Trinidad::Tomcat::Tomcat.new
+
+    extended = Trinidad::Extensions.configure_server_extensions(extensions, tomcat)
+    extended.should_not equal(tomcat)
+  end
 end

data/spec/trinidad/web_app_spec.rb

@@ -20,7 +20,7 @@ describe Trinidad::WebApp do
     }
     @web_app = Trinidad::RailsWebApp.new(@tomcat_web_app, @config, @app)
   end
-  
+
   it "creates a RailsWebApp if rackup option is not present" do
     Trinidad::WebApp.create(@tomcat_web_app, @config, @app).is_a?(Trinidad::RailsWebApp).should be_true
   end
@@ -42,7 +42,7 @@ describe Trinidad::WebApp do
   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
@@ -61,13 +61,25 @@ describe Trinidad::WebApp do
     lambda { @web_app.add_init_params }.should_not raise_error
   end
 
-  it "should load init params" do
+  it "loads init params from configuration root" 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 'loads init params from application node' do
+    @app[:jruby_min_runtimes] = 4
+    @app[:jruby_max_runtimes] = 8
+    @config[:web_apps][:default] = @app
+
+    web_app = Trinidad::WebApp.create(@tomcat_web_app, @config, @app)
+    web_app.add_init_params
+
+    web_app.context.findParameter('jruby.min.runtimes').should == '4'
+    web_app.context.findParameter('jruby.max.runtimes').should == '8'
+  end
+
   it "should configure rack filter" do
     @web_app.add_rack_filter
     @web_app.context.findFilterDefs().should have(1).filters

metadata

@@ -1,123 +1,143 @@
 --- !ruby/object:Gem::Specification 
 name: trinidad
 version: !ruby/object:Gem::Version 
-  version: 0.8.2
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 3
+  version: 0.8.3
 platform: ruby
 authors: 
-  - David Calavera
+- David Calavera
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 +02:00
+date: 2010-04-17 00:00:00 +02:00
 default_executable: trinidad
 dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: rack
-    type: :runtime
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "1.0"
-      version: 
-  - !ruby/object:Gem::Dependency 
-    name: jruby-rack
-    type: :runtime
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-      version: 
-  - !ruby/object:Gem::Dependency 
-    name: trinidad_jars
-    type: :runtime
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: 0.1.1
-      version: 
-  - !ruby/object:Gem::Dependency 
-    name: rspec
-    type: :development
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-      version: 
-  - !ruby/object:Gem::Dependency 
-    name: mocha
-    type: :development
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-      version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jruby-rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: trinidad_jars
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: 
 email: calavera@apache.org
 executables: 
-  - trinidad
+- trinidad
 extensions: []
 
 extra_rdoc_files: 
-  - LICENSE
-  - README.rdoc
+- LICENSE
+- README.rdoc
 files: 
-  - History.txt
-  - LICENSE
-  - README.rdoc
-  - VERSION
-  - bin/trinidad
-  - lib/trinidad.rb
-  - lib/trinidad/command_line_parser.rb
-  - lib/trinidad/core_ext.rb
-  - lib/trinidad/extensions.rb
-  - lib/trinidad/rackup_web_app.rb
-  - lib/trinidad/rails_web_app.rb
-  - lib/trinidad/server.rb
-  - lib/trinidad/web_app.rb
+- History.txt
+- LICENSE
+- README.rdoc
+- VERSION
+- bin/trinidad
+- lib/trinidad.rb
+- lib/trinidad/command_line_parser.rb
+- lib/trinidad/core_ext.rb
+- lib/trinidad/extensions.rb
+- lib/trinidad/rackup_web_app.rb
+- lib/trinidad/rails_web_app.rb
+- lib/trinidad/server.rb
+- lib/trinidad/web_app.rb
 has_rdoc: true
 homepage: http://calavera.github.com/trinidad
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-  - --charset=UTF-8
+- --charset=UTF-8
 require_paths: 
-  - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  version: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  version: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: trinidad
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Simple library to run rails applications into an embedded Tomcat
 test_files: 
-  - spec/spec_helper.rb
-  - spec/trinidad/extensions_spec.rb
-  - spec/trinidad/command_line_parser_spec.rb
-  - spec/trinidad/server_spec.rb
-  - spec/trinidad/web_app_spec.rb
-  - spec/fixtures/foo.rb
-  - spec/fixtures/trinidad_foo_extension.rb
+- spec/fixtures/trinidad_foo_extension.rb
+- spec/fixtures/trinidad_override_tomcat_extension.rb
+- spec/spec_helper.rb
+- spec/trinidad/command_line_parser_spec.rb
+- spec/trinidad/extensions_spec.rb
+- spec/trinidad/server_spec.rb
+- spec/trinidad/web_app_spec.rb

data/spec/fixtures/foo.rb

@@ -1,15 +0,0 @@
-module Trinidad
-  module Extensions
-  class FooWebAppExtension < WebAppExtension
-    def configure(tomcat, app_context)
-      @options
-    end
-  end
-
-  class FooServerExtension < ServerExtension
-    def configure(tomcat)
-      @options
-    end
-  end
-  end
-end