Parent

Methods

Class/Module Index [+]

Quicksearch

Warbler::Config

Warbler assembly configuration.

Attributes

autodeploy_dir[RW]

Directory where the war file will be written. Can be used to direct Warbler to place your war file directly in your application server's autodeploy directory. Defaults to the root of the Rails directory.

dirs[RW]

Top-level directories to be copied into WEB-INF. Defaults to names in TOP_DIRS

exclude_logs[RW]

Whether to exclude */.log files (default is true)

excludes[RW]

Files to exclude from the WEB-INF directory

gem_dependencies[RW]

Whether to include dependent gems (default true)

gems[RW]

Rubygems to install into the webapp at WEB-INF/gems

includes[RW]

Additional files beyond the top-level directories to include in the WEB-INF directory

java_classes[RW]

Java classes and other files to copy to WEB-INF/classes

java_libs[RW]

Java libraries to copy to WEB-INF/lib

manifest_file[RW]

Name of the MANIFEST.MF template. Defaults to the MANIFEST.MF normally generated by jar -cf....

pathmaps[RW]

Container of pathmaps used for specifying source-to-destination transformations under various situations (public_html and java_classes are two entries in this structure).

public_html[RW]

Public HTML directory file list, to be copied into the root of the war

staging_dir[RW]

Directory where files will be staged, defaults to tmp/war

war_name[RW]

Name of war file (without the .war), defaults to the directory name containing the Rails application

webxml[RW]

Extra configuration for web.xml. Controls how the dynamically-generated web.xml file is generated.

  • webxml.jndi -- the name of one or more JNDI data sources name to be available to the application. Places appropriate <resource-ref> entries in the file.

  • webxml.ignored -- array of key names that will be not used to generate a context param. Defaults to ['jndi', 'booter']

Any other key/value pair placed in the open structure will be dumped as a context parameter in the web.xml file. Some of the recognized values are:

  • webxml.rails.env -- the Rails environment to use for the running application, usually either development or production (the default).

  • webxml.jruby.min.runtimes -- minimum number of pooled runtimes to keep around during idle time

  • webxml.jruby.max.runtimes -- maximum number of pooled Rails application runtimes

Note that if you attempt to access webxml configuration keys in a conditional, you might not obtain the result you want. For example:

<%= webxml.maybe.present.key || 'default' %>

doesn't yield the right result. Instead, you need to generate the context parameters:

<%= webxml.context_params['maybe.present.key'] || 'default' %>

Public Class Methods

new(warbler_home = WARBLER_HOME) click to toggle source
# File lib/warbler/config.rb, line 93
def initialize(warbler_home = WARBLER_HOME)
  @warbler_home = warbler_home
  @staging_dir = File.join("tmp", "war")
  @dirs        = TOP_DIRS.select {|d| File.directory?(d)}
  @includes    = FileList[]
  @excludes    = FileList[]
  @java_libs   = default_jar_files
  @java_classes = FileList[]
  @gems        = Warbler::Gems.new
  @gem_dependencies = true
  @exclude_logs = true
  @public_html = FileList["public/**/*"]
  @pathmaps    = default_pathmaps
  @webxml      = default_webxml_config
  @rails_root  = File.expand_path(defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)
  @war_name    = File.basename(@rails_root)
  auto_detect_frameworks
  yield self if block_given?
  @excludes += warbler_vendor_excludes(warbler_home)
  @excludes += FileList["**/*.log"] if @exclude_logs
  @excludes << @staging_dir
end

Public Instance Methods

gems=(value) click to toggle source
# File lib/warbler/config.rb, line 116
def gems=(value)
  @gems = Warbler::Gems.new(value)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.