Class: Warbler::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/warbler/config.rb

Overview

Warbler assembly configuration.

Constant Summary collapse

TOP_DIRS = 
%w(app config lib log vendor)
FILE = 
"config/warble.rb"
BUILD_GEMS = 
%w(warbler rake rcov)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(warbler_home = WARBLER_HOME) {|_self| ... } ⇒ Config

Returns a new instance of Config.

Yields:

  • (_self)

Yield Parameters:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/warbler/config.rb', line 93

def initialize(warbler_home = WARBLER_HOME)
  @staging_dir = File.join("tmp", "war")
  @dirs        = TOP_DIRS.select {|d| File.directory?(d)}
  @includes    = FileList[]
  @excludes    = FileList[]
  @java_libs   = FileList["#{warbler_home}/lib/*.jar"]
  @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

Instance Attribute Details

#autodeploy_dir ⇒ Object

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.



22
23
24
 
# File 'lib/warbler/config.rb', line 22

def autodeploy_dir
  @autodeploy_dir
end

#dirs ⇒ Object

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



26
27
28
 
# File 'lib/warbler/config.rb', line 26

def dirs
  @dirs
end

#exclude_logs ⇒ Object

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



48
49
50
 
# File 'lib/warbler/config.rb', line 48

def exclude_logs
  @exclude_logs
end

#excludes ⇒ Object

Files to exclude from the WEB-INF directory



33
34
35
 
# File 'lib/warbler/config.rb', line 33

def excludes
  @excludes
end

#gem_dependencies ⇒ Object

Whether to include dependent gems (default true)



45
46
47
 
# File 'lib/warbler/config.rb', line 45

def gem_dependencies
  @gem_dependencies
end

#gems ⇒ Object

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



42
43
44
 
# File 'lib/warbler/config.rb', line 42

def gems
  @gems
end

#includes ⇒ Object

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



30
31
32
 
# File 'lib/warbler/config.rb', line 30

def includes
  @includes
end

#java_classes ⇒ Object

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



36
37
38
 
# File 'lib/warbler/config.rb', line 36

def java_classes
  @java_classes
end

#java_libs ⇒ Object

Java libraries to copy to WEB-INF/lib



39
40
41
 
# File 'lib/warbler/config.rb', line 39

def java_libs
  @java_libs
end

#manifest_file ⇒ Object

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



64
65
66
 
# File 'lib/warbler/config.rb', line 64

def manifest_file
  @manifest_file
end

#pathmaps ⇒ Object

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



56
57
58
 
# File 'lib/warbler/config.rb', line 56

def pathmaps
  @pathmaps
end

#public_html ⇒ Object

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



51
52
53
 
# File 'lib/warbler/config.rb', line 51

def public_html
  @public_html
end

#staging_dir ⇒ Object

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



17
18
19
 
# File 'lib/warbler/config.rb', line 17

def staging_dir
  @staging_dir
end

#war_name ⇒ Object

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



60
61
62
 
# File 'lib/warbler/config.rb', line 60

def war_name
  @war_name
end

#webxml ⇒ Object

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 &lt;resource-ref&gt; 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' %>



91
92
93
 
# File 'lib/warbler/config.rb', line 91

def webxml
  @webxml
end