Module: Jammit
- Defined in:
- lib/jammit.rb,
lib/jammit/routes.rb,
lib/jammit/helper.rb,
lib/jammit/packager.rb,
lib/jammit/controller.rb,
lib/jammit/compressor.rb,
lib/jammit/command_line.rb
Overview
Jammit
is the central namespace for all Jammit classes, and provides access
to all of the configuration options.
Defined Under Namespace
Modules: Helper, Routes Classes: CommandLine, Compressor, Controller, PackageNotFound, Packager
Constant Summary
- VERSION =
"0.2.1"
- ROOT =
File.(File.dirname(__FILE__) + '/..')
- DEFAULT_CONFIG_PATH =
"config/assets.yml"
- DEFAULT_PACKAGE_PATH =
"assets"
- DEFAULT_JST_SCRIPT =
"#{ROOT}/lib/jammit/jst.js"
- DEFAULT_JST_COMPILER =
"template"
- DEFAULT_COMPRESSOR =
:yui
Attribute Summary
- + (Object) compressor_options readonly Returns the value of attribute compressor_options.
- + (Object) configuration readonly Returns the value of attribute configuration.
- + (Object) embed_images readonly Returns the value of attribute embed_images.
- + (Object) include_jst_script readonly Returns the value of attribute include_jst_script.
- + (Object) javascript_compressor readonly Returns the value of attribute javascript_compressor.
- + (Object) mhtml_enabled readonly Returns the value of attribute mhtml_enabled.
- + (Object) package_assets readonly Returns the value of attribute package_assets.
- + (Object) package_path readonly Returns the value of attribute package_path.
- + (Object) template_function readonly Returns the value of attribute template_function.
Method Summary
- + (Object) asset_url(package, extension, suffix = nil, mtime = nil) Generates the server-absolute URL to an asset package.
- + (Object) filename(package, extension, suffix = nil) Generate the base filename for a version of a given package.
-
+ (Object) load_configuration(config_path)
Load the complete asset configuration from the specified
config_path
. -
+ (Object) packager
Keep a global (thread-local) reference to a
Jammit::Packager
, to avoid recomputing asset lists unnecessarily. - + (Object) reload! Force a reload by resetting the Packager and reloading the configuration.
- + (Object) set_package_assets(value) private
- + (Object) set_template_function(value) private
Attribute Details
+ (Object) compressor_options (readonly)
Returns the value of attribute compressor_options
26 27 28 |
# File 'lib/jammit.rb', line 26 def end |
+ (Object) configuration (readonly)
Returns the value of attribute configuration
26 27 28 |
# File 'lib/jammit.rb', line 26 def configuration @configuration end |
+ (Object) embed_images (readonly)
Returns the value of attribute embed_images
26 27 28 |
# File 'lib/jammit.rb', line 26 def end |
+ (Object) include_jst_script (readonly)
Returns the value of attribute include_jst_script
26 27 28 |
# File 'lib/jammit.rb', line 26 def include_jst_script @include_jst_script end |
+ (Object) javascript_compressor (readonly)
Returns the value of attribute javascript_compressor
26 27 28 |
# File 'lib/jammit.rb', line 26 def javascript_compressor @javascript_compressor end |
+ (Object) mhtml_enabled (readonly)
Returns the value of attribute mhtml_enabled
26 27 28 |
# File 'lib/jammit.rb', line 26 def mhtml_enabled @mhtml_enabled end |
+ (Object) package_assets (readonly)
Returns the value of attribute package_assets
26 27 28 |
# File 'lib/jammit.rb', line 26 def package_assets @package_assets end |
+ (Object) package_path (readonly)
Returns the value of attribute package_path
26 27 28 |
# File 'lib/jammit.rb', line 26 def package_path @package_path end |
+ (Object) template_function (readonly)
Returns the value of attribute template_function
26 27 28 |
# File 'lib/jammit.rb', line 26 def template_function @template_function end |
Method Details
+ (Object) asset_url(package, extension, suffix = nil, mtime = nil)
Generates the server-absolute URL to an asset package.
70 71 72 73 |
# File 'lib/jammit.rb', line 70 def self.asset_url(package, extension, suffix=nil, mtime=nil) = mtime ? "?#{mtime.to_i}" : '' "/#{package_path}/#{filename(package, extension, suffix)}#{timestamp}" end |
+ (Object) filename(package, extension, suffix = nil)
Generate the base filename for a version of a given package.
64 65 66 67 |
# File 'lib/jammit.rb', line 64 def self.filename(package, extension, suffix=nil) suffix_part = suffix ? "-#{suffix}" : '' "#{package}#{suffix_part}.#{extension}" end |
+ (Object) load_configuration(config_path)
Load the complete asset configuration from the specified config_path
.
36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/jammit.rb', line 36 def self.load_configuration(config_path) return unless config_path && File.exists?(config_path) @config_path = config_path @configuration = conf = YAML.load_file(@config_path).symbolize_keys @package_path = conf[:package_path] || DEFAULT_PACKAGE_PATH = conf[:embed_images] @mhtml_enabled = && != "datauri" @javascript_compressor = (conf[:javascript_compressor] || DEFAULT_COMPRESSOR).to_sym = conf[:compressor_options] || {} set_package_assets(conf[:package_assets]) set_template_function(conf[:template_function]) self end |
+ (Object) packager
Keep a global (thread-local) reference to a Jammit::Packager
, to avoid
recomputing asset lists unnecessarily.
59 60 61 |
# File 'lib/jammit.rb', line 59 def self.packager Thread.current[:jammit_packager] ||= Packager.new end |
+ (Object) reload!
Force a reload by resetting the Packager and reloading the configuration. In development, this will be called as a before_filter before every request.
52 53 54 55 |
# File 'lib/jammit.rb', line 52 def self.reload! Thread.current[:jammit_packager] = nil load_configuration(@config_path) end |
+ (Object) set_package_assets(value) (private)
78 79 80 81 82 83 84 85 86 |
# File 'lib/jammit.rb', line 78 def self.set_package_assets(value) package_env = !defined?(RAILS_ENV) || RAILS_ENV != 'development' @package_assets = case value when 'always' then true when false then false when true then package_env when nil then package_env end end |
+ (Object) set_template_function(value) (private)
88 89 90 91 92 93 94 95 96 |
# File 'lib/jammit.rb', line 88 def self.set_template_function(value) @template_function = case value when false then '' when true then DEFAULT_JST_COMPILER when nil then DEFAULT_JST_COMPILER else value end @include_jst_script = @template_function == DEFAULT_JST_COMPILER end |