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, ConfigurationNotFound, Controller, PackageNotFound, Packager

Constant Summary

VERSION =
"0.2.4"
ROOT =
File.expand_path(File.dirname(__FILE__) + '/..')
ASSET_ROOT =
defined?(RAILS_ROOT) ? RAILS_ROOT : "."
DEFAULT_CONFIG_PATH =
"#{ASSET_ROOT}/config/assets.yml"
DEFAULT_PACKAGE_PATH =
"assets"
DEFAULT_JST_SCRIPT =
"#{ROOT}/lib/jammit/jst.js"
DEFAULT_JST_COMPILER =
"template"
AVAILABLE_COMPRESSORS =
[:yui, :closure]
DEFAULT_COMPRESSOR =
:yui

Attribute Summary

Method Summary

Attribute Details

+ (Object) compressor_options (readonly)

Returns the value of attribute compressor_options



34
35
36
# File 'lib/jammit.rb', line 34

def compressor_options
  @compressor_options
end

+ (Object) configuration (readonly)

Returns the value of attribute configuration



34
35
36
# File 'lib/jammit.rb', line 34

def configuration
  @configuration
end

+ (Object) embed_images (readonly)

Returns the value of attribute embed_images



34
35
36
# File 'lib/jammit.rb', line 34

def embed_images
  @embed_images
end

+ (Object) include_jst_script (readonly)

Returns the value of attribute include_jst_script



34
35
36
# File 'lib/jammit.rb', line 34

def include_jst_script
  @include_jst_script
end

+ (Object) javascript_compressor (readonly)

Returns the value of attribute javascript_compressor



34
35
36
# File 'lib/jammit.rb', line 34

def javascript_compressor
  @javascript_compressor
end

+ (Object) mhtml_enabled (readonly)

Returns the value of attribute mhtml_enabled



34
35
36
# File 'lib/jammit.rb', line 34

def mhtml_enabled
  @mhtml_enabled
end

+ (Object) package_assets (readonly)

Returns the value of attribute package_assets



34
35
36
# File 'lib/jammit.rb', line 34

def package_assets
  @package_assets
end

+ (Object) package_path (readonly)

Returns the value of attribute package_path



34
35
36
# File 'lib/jammit.rb', line 34

def package_path
  @package_path
end

+ (Object) template_function (readonly)

Returns the value of attribute template_function



34
35
36
# File 'lib/jammit.rb', line 34

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.



79
80
81
82
# File 'lib/jammit.rb', line 79

def self.asset_url(package, extension, suffix=nil, mtime=nil)
  timestamp = 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.



73
74
75
76
# File 'lib/jammit.rb', line 73

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.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/jammit.rb', line 44

def self.load_configuration(config_path)
  conf = config_path && File.exists?(config_path) && YAML.load_file(config_path)
  raise ConfigurationNotFound, "could not find the \"#{config_path}\" configuration file" unless conf
  @config_path            = config_path
  @configuration          = conf = conf.symbolize_keys
  @package_path           = conf[:package_path] || DEFAULT_PACKAGE_PATH
  @embed_images           = conf[:embed_images]
  @mhtml_enabled          = @embed_images && @embed_images != "datauri"
  @compressor_options     = conf[:compressor_options] || {}
  set_javascript_compressor(conf[:javascript_compressor])
  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.



68
69
70
# File 'lib/jammit.rb', line 68

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.



61
62
63
64
# File 'lib/jammit.rb', line 61

def self.reload!
  Thread.current[:jammit_packager] = nil
  load_configuration(@config_path)
end

+ (Object) set_javascript_compressor(value) (private)



87
88
89
90
# File 'lib/jammit.rb', line 87

def self.set_javascript_compressor(value)
  value = value && value.to_sym
  @javascript_compressor = AVAILABLE_COMPRESSORS.include?(value) ? value : DEFAULT_COMPRESSOR
end

+ (Object) set_package_assets(value) (private)



92
93
94
95
96
97
98
99
100
# File 'lib/jammit.rb', line 92

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)



102
103
104
105
106
107
108
109
110
# File 'lib/jammit.rb', line 102

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