Class: Warbler::Config

Inherits:
Object
  • Object
show all
Includes:
RakeHelper, Traits
Defined in:
lib/warbler/config.rb

Overview

Warbler archive assembly configuration class.

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Traits

#after_configure, #auto_detect_traits, #before_configure, #dump_traits, #trait_objects, #update_archive

Methods included from RakeHelper

extended, included

Constructor Details

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

Returns a new instance of Config.

Yields:

  • (_self)

Yield Parameters:


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/warbler/config.rb', line 188

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['*file'] # [r/R]akefile gets included
  @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"]
  @override_gem_home = true
  @script_files      = []
  @warbler_scripts = "#{WARBLER_HOME}/lib/warbler/scripts"
  @move_jars_to_webinf_lib = false
  @compile_gems      = false

  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 += ["tmp/cache/**/*"] if File.directory?("tmp/cache")
  @excludes += warbler_vendor_excludes(warbler_home)
  @excludes += FileList["**/*.log"] if @exclude_logs
end

Instance Attribute Details

#autodeploy_dirObject

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_withoutObject

An array of Bundler groups to avoid including in the war file. Defaults to [“development”, “test”, “assets”].


106
107
108
# File 'lib/warbler/config.rb', line 106

def bundle_without
  @bundle_without
end

#bundlerObject

Use Bundler to locate gems if Gemfile is found. Default is true.


102
103
104
# File 'lib/warbler/config.rb', line 102

def bundler
  @bundler
end

#bytecode_versionObject

Explicit bytecode version for compiled ruby files. If given bytecode version is specified when ruby files are compiled using jrubyc


143
144
145
# File 'lib/warbler/config.rb', line 143

def bytecode_version
  @bytecode_version
end

#compile_gemsObject

Determines if ruby files in supporting gems will be compiled. Ignored unless compile feature is used.


121
122
123
# File 'lib/warbler/config.rb', line 121

def compile_gems
  @compile_gems
end

#compiled_ruby_filesObject

List of ruby files to compile to class files. Default is to compile all .rb files in the application.


117
118
119
# File 'lib/warbler/config.rb', line 117

def compiled_ruby_files
  @compiled_ruby_files
end

#dirsObject

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_logsObject

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


71
72
73
# File 'lib/warbler/config.rb', line 71

def exclude_logs
  @exclude_logs
end

#excludesObject

Files to exclude from the WEB-INF directory


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

def excludes
  @excludes
end

#executableObject

Executable of the jar


82
83
84
# File 'lib/warbler/config.rb', line 82

def executable
  @executable
end

#executable_paramsObject

parameters to pass to the executable


85
86
87
# File 'lib/warbler/config.rb', line 85

def executable_params
  @executable_params
end

#featuresObject

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_dependenciesObject

Whether to include dependent gems (default true)


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

def gem_dependencies
  @gem_dependencies
end

#gem_excludesObject

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_pathObject

Path to the pre-bundled gem directory inside the war file. Default is '/WEB-INF/gems'. This also sets 'gem.path' inside web.xml.


113
114
115
# File 'lib/warbler/config.rb', line 113

def gem_path
  @gem_path
end

#gemsObject

Rubygems to install into the webapp.


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

def gems
  @gems
end

#includesObject

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_contentsObject

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.


133
134
135
# File 'lib/warbler/config.rb', line 133

def init_contents
  @init_contents
end

#init_filenameObject

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.


129
130
131
# File 'lib/warbler/config.rb', line 129

def init_filename
  @init_filename
end

#jar_extensionObject

Extension of jar file. Defaults to jar or war depending on the project.


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

def jar_extension
  @jar_extension
end

#jar_nameObject Also known as: war_name

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


89
90
91
# File 'lib/warbler/config.rb', line 89

def jar_name
  @jar_name
end

#java_classesObject

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_libsObject

Java libraries to copy to WEB-INF/lib


58
59
60
# File 'lib/warbler/config.rb', line 58

def java_libs
  @java_libs
end

#jbundlerObject

Use JBundler to locate gems if Jarfile is found. Default is true.


109
110
111
# File 'lib/warbler/config.rb', line 109

def jbundler
  @jbundler
end

#jrubyc_optionsObject

Desired options passed to JRuby compiler if compiling to class files. Ignored unless compile feature is used.


125
126
127
# File 'lib/warbler/config.rb', line 125

def jrubyc_options
  @jrubyc_options
end

#manifest_fileObject

Name of a MANIFEST.MF template to use.


95
96
97
# File 'lib/warbler/config.rb', line 95

def manifest_file
  @manifest_file
end

#move_jars_to_webinf_libObject

If set to true, Warbler will move jar files into the WEB-INF/lib directory of the created war file. This may be needed for some web servers. Defaults to false.


179
180
181
# File 'lib/warbler/config.rb', line 179

def move_jars_to_webinf_lib
  @move_jars_to_webinf_lib
end

#override_gem_homeObject

Override GEM_HOME environment variable at runtime. When false, gems in GEM_HOME will be loaded in preference to those packaged within the jar file. When true, only gems packaged in the jar file will be loaded. Defaults to true


139
140
141
# File 'lib/warbler/config.rb', line 139

def override_gem_home
  @override_gem_home
end

#pathmapsObject

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_htmlObject

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

#script_filesObject

These file will be placed in the META-INF directory of the jar or war that warbler produces. They are primarily used as launchers by the runnable feature.


183
184
185
# File 'lib/warbler/config.rb', line 183

def script_files
  @script_files
end

#staging_dirObject

Deprecated: No longer has any effect.


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

def staging_dir
  @staging_dir
end

#traitsObject

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_scriptsObject (readonly)

Returns the value of attribute warbler_scripts


186
187
188
# File 'lib/warbler/config.rb', line 186

def warbler_scripts
  @warbler_scripts
end

#warbler_templatesObject (readonly)

Returns the value of attribute warbler_templates


185
186
187
# File 'lib/warbler/config.rb', line 185

def warbler_templates
  @warbler_templates
end

#webinf_filesObject

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.


99
100
101
# File 'lib/warbler/config.rb', line 99

def webinf_files
  @webinf_files
end

#webserverObject

Embedded webserver to use. Currently supported webservers are:

  • jetty - Embedded Jetty from Eclipse


175
176
177
# File 'lib/warbler/config.rb', line 175

def webserver
  @webserver
end

#webxmlObject

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' %>

171
172
173
# File 'lib/warbler/config.rb', line 171

def webxml
  @webxml
end

Instance Method Details

#define_tasksObject


235
236
237
238
239
240
241
242
243
244
245
# File 'lib/warbler/config.rb', line 235

def define_tasks
  task "gemjar" do
    self.features << "gemjar"
  end
  task "executable" do
    self.features << "executable"
  end
  task "runnable" do
    self.features << "runnable"
  end
end

#dumpObject


260
261
262
# File 'lib/warbler/config.rb', line 260

def dump
  YAML::dump(self.dup.tap{|c| c.dump_traits })
end

#relative_gem_pathObject


231
232
233
# File 'lib/warbler/config.rb', line 231

def relative_gem_path
  @gem_path[1..-1]
end