Class: Warbler::Config
- Inherits:
-
Object
- Object
- Warbler::Config
- Includes:
- RakeHelper, Traits
- Defined in:
- lib/warbler/config.rb
Overview
Warbler archive assembly configuration class.
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
-
#autodeploy_dir ⇒ Object
Directory where the war file will be written.
-
#bundle_without ⇒ Object
An array of Bundler groups to avoid including in the war file.
-
#bundler ⇒ Object
Use Bundler to locate gems if Gemfile is found.
-
#compiled_ruby_files ⇒ Object
List of ruby files to compile to class files.
-
#dirs ⇒ Object
Top-level directories to be copied into WEB-INF.
-
#exclude_logs ⇒ Object
Whether to exclude */.log files (default is true).
-
#excludes ⇒ Object
Files to exclude from the WEB-INF directory.
-
#features ⇒ Object
Features: additional options controlling how the jar is built.
-
#gem_dependencies ⇒ Object
Whether to include dependent gems (default true).
-
#gem_excludes ⇒ Object
Array of regular expressions matching relative paths in gems to be excluded from the war.
-
#gem_path ⇒ Object
Path to the pre-bundled gem directory inside the war file.
-
#gems ⇒ Object
Rubygems to install into the webapp.
-
#includes ⇒ Object
Additional files beyond the top-level directories to include in the WEB-INF directory.
-
#init_contents ⇒ Object
Array containing filenames or StringIO’s to be concatenated together to form the init file.
-
#init_filename ⇒ Object
Warbler writes an “init” file into the war at this location.
-
#jar_extension ⇒ Object
Extension of jar file.
-
#jar_name ⇒ Object
Name of jar or war file (without the extension), defaults to the directory name containing the application.
-
#java_classes ⇒ Object
Java classes and other files to copy to WEB-INF/classes.
-
#java_libs ⇒ Object
Java libraries to copy to WEB-INF/lib.
-
#manifest_file ⇒ Object
Name of a MANIFEST.MF template to use.
-
#pathmaps ⇒ Object
Container of pathmaps used for specifying source-to-destination transformations under various situations (
public_html
andjava_classes
are two entries in this structure). -
#public_html ⇒ Object
Public HTML directory file list, to be copied into the root of the war.
-
#staging_dir ⇒ Object
Deprecated: No longer has any effect.
-
#traits ⇒ Object
Traits: an array of trait classes corresponding to characteristics of the project that are either auto-detected or configured.
-
#warbler_templates ⇒ Object
readonly
Returns the value of attribute warbler_templates.
-
#webinf_files ⇒ Object
Files for WEB-INF directory (next to web.xml).
-
#webxml ⇒ Object
Extra configuration for web.xml.
Instance Method Summary collapse
- #define_tasks ⇒ Object
- #dump ⇒ Object
-
#initialize(warbler_home = WARBLER_HOME) {|_self| ... } ⇒ Config
constructor
A new instance of Config.
- #relative_gem_path ⇒ Object
-
#war_name ⇒ Object
Deprecated.
-
#war_name=(w) ⇒ Object
Deprecated.
Methods included from Traits
#after_configure, #auto_detect_traits, #before_configure, #dump_traits, #trait_objects, #update_archive
Methods included from RakeHelper
Constructor Details
#initialize(warbler_home = WARBLER_HOME) {|_self| ... } ⇒ Config
Returns a new instance of Config.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/warbler/config.rb', line 148 def initialize(warbler_home = WARBLER_HOME) super() @warbler_home = warbler_home @warbler_templates = "#{WARBLER_HOME}/lib/warbler/templates" @features = Set.new @dirs = TOP_DIRS.select {|d| File.directory?(d)} @includes = FileList[] @excludes = FileList[] @java_libs = FileList[] @java_classes = FileList[] @gems = Warbler::Gems.new @gem_dependencies = true @gem_excludes = [] @exclude_logs = true @public_html = FileList[] @jar_name = File.basename(Dir.getwd) @jar_extension = 'jar' @webinf_files = FileList[] @init_filename = 'META-INF/init.rb' @init_contents = ["#{@warbler_templates}/config.erb"] before_configure yield self if block_given? after_configure @compiled_ruby_files ||= FileList[*@dirs.map {|d| "#{d}/**/*.rb"}] @excludes += ["tmp/war", "tmp/war/**/*"] if File.directory?("tmp/war") @excludes += warbler_vendor_excludes(warbler_home) @excludes += FileList["**/*.log"] if @exclude_logs 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 application directory.
41 42 43 |
# File 'lib/warbler/config.rb', line 41 def autodeploy_dir @autodeploy_dir end |
#bundle_without ⇒ Object
An array of Bundler groups to avoid including in the war file. Defaults to [“development”, “test”].
100 101 102 |
# File 'lib/warbler/config.rb', line 100 def bundle_without @bundle_without end |
#bundler ⇒ Object
Use Bundler to locate gems if Gemfile is found. Default is true.
96 97 98 |
# File 'lib/warbler/config.rb', line 96 def bundler @bundler end |
#compiled_ruby_files ⇒ Object
List of ruby files to compile to class files. Default is to compile all .rb files in the application.
108 109 110 |
# File 'lib/warbler/config.rb', line 108 def compiled_ruby_files @compiled_ruby_files end |
#dirs ⇒ Object
Top-level directories to be copied into WEB-INF. Defaults to names in TOP_DIRS
45 46 47 |
# File 'lib/warbler/config.rb', line 45 def dirs @dirs end |
#exclude_logs ⇒ Object
Whether to exclude */.log files (default is true)
71 72 73 |
# File 'lib/warbler/config.rb', line 71 def exclude_logs @exclude_logs end |
#excludes ⇒ Object
Files to exclude from the WEB-INF directory
52 53 54 |
# File 'lib/warbler/config.rb', line 52 def excludes @excludes end |
#features ⇒ Object
Features: additional options controlling how the jar is built. Currently the following features are supported:
-
gemjar: package the gem repository in a jar file in WEB-INF/lib
-
executable: embed a web server and make the war executable
-
compiled: compile .rb files to .class files
28 29 30 |
# File 'lib/warbler/config.rb', line 28 def features @features end |
#gem_dependencies ⇒ Object
Whether to include dependent gems (default true)
64 65 66 |
# File 'lib/warbler/config.rb', line 64 def gem_dependencies @gem_dependencies end |
#gem_excludes ⇒ Object
Array of regular expressions matching relative paths in gems to be excluded from the war. Default contains no exclusions.
68 69 70 |
# File 'lib/warbler/config.rb', line 68 def gem_excludes @gem_excludes end |
#gem_path ⇒ Object
Path to the pre-bundled gem directory inside the war file. Default is ‘/WEB-INF/gems’. This also sets ‘gem.path’ inside web.xml.
104 105 106 |
# File 'lib/warbler/config.rb', line 104 def gem_path @gem_path end |
#gems ⇒ Object
Rubygems to install into the webapp.
61 62 63 |
# File 'lib/warbler/config.rb', line 61 def gems @gems end |
#includes ⇒ Object
Additional files beyond the top-level directories to include in the WEB-INF directory
49 50 51 |
# File 'lib/warbler/config.rb', line 49 def includes @includes end |
#init_contents ⇒ Object
Array containing filenames or StringIO’s to be concatenated together to form the init file. If the filename ends in .erb the file will be expanded the same way web.xml.erb is; see below.
116 117 118 |
# File 'lib/warbler/config.rb', line 116 def init_contents @init_contents end |
#init_filename ⇒ Object
Warbler writes an “init” file into the war at this location. JRuby-Rack and possibly other launchers may use this to initialize the Ruby environment.
112 113 114 |
# File 'lib/warbler/config.rb', line 112 def init_filename @init_filename end |
#jar_extension ⇒ Object
Extension of jar file. Defaults to jar
or war
depending on the project.
86 87 88 |
# File 'lib/warbler/config.rb', line 86 def jar_extension @jar_extension end |
#jar_name ⇒ Object
Name of jar or war file (without the extension), defaults to the directory name containing the application.
83 84 85 |
# File 'lib/warbler/config.rb', line 83 def jar_name @jar_name end |
#java_classes ⇒ Object
Java classes and other files to copy to WEB-INF/classes
55 56 57 |
# File 'lib/warbler/config.rb', line 55 def java_classes @java_classes end |
#java_libs ⇒ Object
Java libraries to copy to WEB-INF/lib
58 59 60 |
# File 'lib/warbler/config.rb', line 58 def java_libs @java_libs end |
#manifest_file ⇒ Object
Name of a MANIFEST.MF template to use.
89 90 91 |
# File 'lib/warbler/config.rb', line 89 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).
79 80 81 |
# File 'lib/warbler/config.rb', line 79 def pathmaps @pathmaps end |
#public_html ⇒ Object
Public HTML directory file list, to be copied into the root of the war
74 75 76 |
# File 'lib/warbler/config.rb', line 74 def public_html @public_html end |
#staging_dir ⇒ Object
Deprecated: No longer has any effect.
36 37 38 |
# File 'lib/warbler/config.rb', line 36 def staging_dir @staging_dir end |
#traits ⇒ Object
Traits: an array of trait classes corresponding to characteristics of the project that are either auto-detected or configured.
33 34 35 |
# File 'lib/warbler/config.rb', line 33 def traits @traits end |
#warbler_templates ⇒ Object (readonly)
Returns the value of attribute warbler_templates.
146 147 148 |
# File 'lib/warbler/config.rb', line 146 def warbler_templates @warbler_templates end |
#webinf_files ⇒ Object
Files for WEB-INF directory (next to web.xml). Contains web.xml by default. If there are .erb files they will be processed with webxml config.
93 94 95 |
# File 'lib/warbler/config.rb', line 93 def webinf_files @webinf_files 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 <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.gem.path
– the path to your bundled gem directory -
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' %>
144 145 146 |
# File 'lib/warbler/config.rb', line 144 def webxml @webxml end |
Instance Method Details
#define_tasks ⇒ Object
189 190 191 192 193 194 195 196 |
# File 'lib/warbler/config.rb', line 189 def define_tasks task "gemjar" do self.features << "gemjar" end task "executable" do self.features << "executable" end end |
#dump ⇒ Object
220 221 222 |
# File 'lib/warbler/config.rb', line 220 def dump YAML::dump(self.dup.tap{|c| c.dump_traits }) end |
#relative_gem_path ⇒ Object
185 186 187 |
# File 'lib/warbler/config.rb', line 185 def relative_gem_path @gem_path[1..-1] end |
#war_name ⇒ Object
Deprecated
199 200 201 202 |
# File 'lib/warbler/config.rb', line 199 def war_name $stderr.puts "config.war_name deprecated; replace with config.jar_name" #:nocov: jar_name #:nocov: end |
#war_name=(w) ⇒ Object
Deprecated
205 206 207 208 |
# File 'lib/warbler/config.rb', line 205 def war_name=(w) $stderr.puts "config.war_name deprecated; replace with config.jar_name" #:nocov: self.jar_name = w #:nocov: end |