Module: Merb::AssetsMixin
- Includes:
- Merb::Assets::AssetHelpers
- Defined in:
- lib/merb-assets/assets_mixin.rb
Overview
The AssetsMixin module provides a number of helper methods to views for linking to assets and other pages, dealing with JavaScript and CSS.
Constant Summary
Constants included from Merb::Assets::AssetHelpers
Merb::Assets::AssetHelpers::ASSET_FILE_EXTENSIONS
Instance Method Summary collapse
-
#auto_link ⇒ Object
Parameters none.
-
#css_include_tag(*stylesheets) ⇒ Object
Parameters *stylesheets:: The stylesheets to include.
-
#escape_js(javascript) ⇒ Object
Parameters javascript
:: Text to escape for use in JavaScript. -
#image_tag(img, opts = {}) ⇒ Object
Parameters img<~to_s>:: The image path.
-
#include_required_css(options = {}) ⇒ Object
A method used in the layout of an application to create
<link>tags for CSS stylesheets required in in templates and subtemplates using require_css. -
#include_required_js(options = {}) ⇒ Object
A method used in the layout of an application to create
<script>tags to include JavaScripts required in in templates and subtemplates using require_js. -
#js(data) ⇒ Object
Parameters data
-
#js_include_tag(*scripts) ⇒ Object
Parameters *scripts:: The scripts to include.
-
#link_to(name, url = '', opts = {}) ⇒ Object
Parameters name<~to_s>:: The text of the link.
-
#require_css(*css) ⇒ Object
The require_css method can be used to require any CSS file anywhere in your templates.
-
#require_js(*js) ⇒ Object
The require_js method can be used to require any JavaScript file anywhere in your templates.
-
#required_css(options = {}) ⇒ Object
All css files to include, without duplicates.
-
#required_js(options = {}) ⇒ Object
All javascript files to include, without duplicates.
-
#uniq_css_path(*assets) ⇒ Object
Parameters *assets:: Creates unique paths for stylesheet files (prepends "/stylesheets" and appends ".css").
-
#uniq_css_tag(*assets) ⇒ Object
Parameters *assets:: As uniq_css_tag but has unique path.
-
#uniq_js_path(*assets) ⇒ Object
Parameters *assets:: Creates unique paths for javascript files (prepends "/javascripts" and appends ".js").
-
#uniq_js_tag(*assets) ⇒ Object
Parameters *assets:: As js_include_tag but has unique path.
-
#uniq_path(*assets) ⇒ Object
Parameters *assets:: The assets to include.
Methods included from Merb::Assets::AssetHelpers
Instance Method Details
#auto_link ⇒ Object
Parameters
none
Returns
html
Examples
We want all possible matches in the FileSys up to the action name Given: controller_name = "namespace/controller" action_name = "action" If all files are present should generate link/script tags for: namespace.(css|js) namespace/controller.(css|js) namespace/controller/action.(css|js)
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/merb-assets/assets_mixin.rb', line 26 def auto_link html = "" prefix = "" (controller_name / action_name).split("/").each do |path| path = prefix + path css_path = path + ".css" if File.exists? Merb.root / "public" / "stylesheets" / css_path html << %{<link rel="stylesheet" type="text/css" href="/stylesheets/#{css_path}" /> } end js_path = path + ".js" if File.exists? Merb.root / "public" / "javascripts" / js_path html << %{<script type="text/javascript" language="javascript" src="/javascripts/#{js_path}"></script>} end #Update the prefix for the next iteration prefix += path / "" end #Return the generated HTML html end |
#css_include_tag(*stylesheets) ⇒ Object
Parameters
- *stylesheets
The stylesheets to include. If the last element is a Hash, it will be used as options (see below). If ".css" is left out from the stylesheet names, it will be added to them.
Options
:bundle<~to_s>::
The name of the bundle the stylesheets should be combined into.
:media<~to_s>::
The media attribute for the generated link element. Defaults to :all.
Returns
- String
The CSS include tag(s).
Examples
css_include_tag 'style'
=>
css_include_tag 'style.css', 'layout'
# => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
# <link href="/stylesheets/layout.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
css_include_tag :menu
# => <link href="/stylesheets/menu.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
css_include_tag :style, :screen
# => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
# <link href="/stylesheets/screen.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
css_include_tag :style, :media => :print
=>
css_include_tag :style, :charset => 'iso-8859-1'
=>
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/merb-assets/assets_mixin.rb', line 485 def css_include_tag(*stylesheets) = stylesheets.last.is_a?(Hash) ? stylesheets.pop : {} return nil if stylesheets.empty? if (bundle_name = [:bundle]) && Merb::Assets.bundle? && stylesheets.size > 1 bundler = Merb::Assets::StylesheetAssetBundler.new(bundle_name, *stylesheets) bundled_asset = bundler.bundle! return css_include_tag(bundled_asset) end = "" for stylesheet in stylesheets attrs = { :href => asset_path(:stylesheet, stylesheet), :type => "text/css", :rel => "Stylesheet", :charset => [:charset] || 'utf-8', :media => [:media] || :all } << %Q{<link #{attrs.to_xml_attributes} />} end return end |
#escape_js(javascript) ⇒ Object
Parameters
- javascript
Text to escape for use in JavaScript.
Examples
escape_js("'Lorem ipsum!' -- Some guy") # => "\'Lorem ipsum!\' -- Some guy"
escape_js("Please keep text\nlines as skinny\nas possible.")
# => "Please keep text\\nlines as skinny\\nas possible."
131 132 133 |
# File 'lib/merb-assets/assets_mixin.rb', line 131 def escape_js(javascript) (javascript || '').gsub('\\','\0\0').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" } end |
#image_tag(img, opts = {}) ⇒ Object
Parameters
- img<~to_s>
The image path.
- opts
Additional options for the image tag (see below).
Options (opts)
:path
Sets the path prefix for the image. Defaults to "/images/" or whatever
is specified in Merb::Config. This is ignored if img is an absolute
path or full URL.
All other options set HTML attributes on the tag.
Examples
image_tag('foo.gif')
=> 
image_tag('foo.gif', :class => 'bar')
# => <img src='/images/foo.gif' class='bar' />
image_tag('foo.gif', :path => '/files/')
# => <img src='/files/foo.gif' />
image_tag('http://test.com/foo.gif')
# => <img src="http://test.com/foo.gif">
image_tag('charts', :path => '/dynamic/')
or
image_tag('/dynamic/charts')
# => <img src="/dynamic/charts">
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/merb-assets/assets_mixin.rb', line 100 def image_tag(img, opts={}) if img[0].chr == '/' opts[:src] = img else opts[:path] ||= if img =~ %r{^https?://} '' else if Merb::Config[:path_prefix] Merb::Config[:path_prefix] + '/images/' else '/images/' end end opts[:src] ||= opts.delete(:path) + img end %{<img #{ opts.to_xml_attributes } />} end |
#include_required_css(options = {}) ⇒ Object
A method used in the layout of an application to create <link> tags for
CSS stylesheets required in in templates and subtemplates using
require_css.
Parameters
- options
Options to pass to css_include_tag.
Returns
- String
The CSS tag.
Options
:bundle<~to_s>::
The name of the bundle the stylesheets should be combined into.
:media<~to_s>::
The media attribute for the generated link element. Defaults to :all.
Examples
my_action.herb has a call to require_css 'style'
File: layout/application.html.erb
include_required_css
=>
# my_action.herb has a call to require_css 'style', 'ie-specific'
# File: layout/application.html.erb
include_required_css
# => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css"/>
# <link href="/stylesheets/ie-specific.css" media="all" rel="Stylesheet" type="text/css"/>
395 396 397 |
# File 'lib/merb-assets/assets_mixin.rb', line 395 def include_required_css( = {}) required_css().map { |req_js| css_include_tag(*req_js) }.join end |
#include_required_js(options = {}) ⇒ Object
A method used in the layout of an application to create <script> tags
to include JavaScripts required in in templates and subtemplates using
require_js.
Parameters
- options
Options to pass to js_include_tag.
Options
:bundle<~to_s>::
The name of the bundle the scripts should be combined into.
Returns
- String
The JavaScript tag.
Examples
my_action.herb has a call to require_js 'jquery'
File: layout/application.html.erb
include_required_js
=>
# my_action.herb has a call to require_js 'jquery', 'effects', 'validation'
# File: layout/application.html.erb
include_required_js
# => <script src="/javascripts/jquery.js" type="text/javascript"></script>
# <script src="/javascripts/effects.js" type="text/javascript"></script>
# <script src="/javascripts/validation.js" type="text/javascript"></script>
363 364 365 |
# File 'lib/merb-assets/assets_mixin.rb', line 363 def include_required_js( = {}) required_js().map { |req_js| js_include_tag(*req_js) }.join end |
#js(data) ⇒ Object
Parameters
- data
Object to translate into JSON. If the object does not respond to :to_json, then data.inspect.to_json is returned instead.
Examples
js(=> 'Lewis', 'page' => 'home')
=> "\"user\":\"Lewis\",\"page\":\"home\""
js([ 1, 2, {"a"=>3.141}, false, true, nil, 4..10 ])
# => "[1,2,{\"a\":3.141},false,true,null,\"4..10\"]"
146 147 148 149 150 151 152 |
# File 'lib/merb-assets/assets_mixin.rb', line 146 def js(data) if data.respond_to? :to_json data.to_json else data.inspect.to_json end end |
#js_include_tag(*scripts) ⇒ Object
Parameters
- *scripts
The scripts to include. If the last element is a Hash, it will be used as options (see below). If ".js" is left out from the script names, it will be added to them.
Options
:bundle<~to_s>::
The name of the bundle the scripts should be combined into.
Returns
- String
The JavaScript include tag(s).
Examples
js_include_tag 'jquery'
=>
js_include_tag 'moofx.js', 'upload'
# => <script src="/javascripts/moofx.js" type="text/javascript"></script>
# <script src="/javascripts/upload.js" type="text/javascript"></script>
js_include_tag :effects
# => <script src="/javascripts/effects.js" type="text/javascript"></script>
js_include_tag :jquery, :validation
# => <script src="/javascripts/jquery.js" type="text/javascript"></script>
# <script src="/javascripts/validation.js" type="text/javascript"></script>
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/merb-assets/assets_mixin.rb', line 427 def js_include_tag(*scripts) = scripts.last.is_a?(Hash) ? scripts.pop : {} return nil if scripts.empty? if (bundle_name = [:bundle]) && Merb::Assets.bundle? && scripts.size > 1 bundler = Merb::Assets::JavascriptAssetBundler.new(bundle_name, *scripts) bundled_asset = bundler.bundle! return js_include_tag(bundled_asset) end = "" for script in scripts attrs = { :src => asset_path(:javascript, script), :type => "text/javascript" } << %Q{<script #{attrs.to_xml_attributes}></script>} end return end |
#link_to(name, url = '', opts = {}) ⇒ Object
Parameters
- name<~to_s>
The text of the link.
- url<~to_s>
The URL to link to. Defaults to an empty string.
- opts
Additional HTML options for the link.
Examples
link_to("The Merb home page", "http://www.merbivore.com/") # => The Merb home page
link_to("The Ruby home page", "http://www.ruby-lang.org", {'class' => 'special', 'target' => 'blank'})
# => <a href="http://www.ruby-lang.org" class="special" target="blank">The Ruby home page</a>
link_to p.title, "/blog/show/#{p.id}"
# => <a href="/blog/show/13">The Entry Title</a>
66 67 68 69 |
# File 'lib/merb-assets/assets_mixin.rb', line 66 def link_to(name, url='', opts={}) opts[:href] ||= url %{<a #{ opts.to_xml_attributes }>#{name}</a>} end |
#require_css(*css) ⇒ Object
The require_css method can be used to require any CSS file anywhere in your templates. Regardless of how many times a single stylesheet is included with require_css, Merb will only include it once in the header.
Parameters
- *css<~to_s>
CSS files to include.
Examples
<% require_css('style') %>
A subsequent call to include_required_css will render...
=>
<% require_css('style', 'ie-specific') %>
# A subsequent call to include_required_css will render...
# => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css"/>
# <link href="/stylesheets/ie-specific.css" media="all" rel="Stylesheet" type="text/css"/>
323 324 325 326 |
# File 'lib/merb-assets/assets_mixin.rb', line 323 def require_css(*css) @required_css ||= [] @required_css << css end |
#require_js(*js) ⇒ Object
The require_js method can be used to require any JavaScript file anywhere in your templates. Regardless of how many times a single script is included with require_js, Merb will only include it once in the header.
Parameters
- *js<~to_s>
JavaScript files to include.
Examples
<% require_js 'jquery' %>
A subsequent call to include_required_js will render...
=>
<% require_js 'jquery', 'effects' %>
# A subsequent call to include_required_js will render...
# => <script src="/javascripts/jquery.js" type="text/javascript"></script>
# <script src="/javascripts/effects.js" type="text/javascript"></script>
293 294 295 296 |
# File 'lib/merb-assets/assets_mixin.rb', line 293 def require_js(*js) @required_js ||= [] @required_js << js end |
#required_css(options = {}) ⇒ Object
All css files to include, without duplicates.
Parameters
- options
Default options to pass to css_include_tag.
332 333 334 |
# File 'lib/merb-assets/assets_mixin.rb', line 332 def required_css( = {}) extract_required_files(@required_css, ) end |
#required_js(options = {}) ⇒ Object
All javascript files to include, without duplicates.
Parameters
- options
Default options to pass to js_include_tag.
302 303 304 |
# File 'lib/merb-assets/assets_mixin.rb', line 302 def required_js( = {}) extract_required_files(@required_js, ) end |
#uniq_css_path(*assets) ⇒ Object
Parameters
- *assets
Creates unique paths for stylesheet files (prepends "/stylesheets" and appends ".css")
Returns
- Array
Full unique paths to assets OR
- String
if only a single path is requested
Examples
uniq_css_path("my") #=> "http://assets2.my-awesome-domain.com/stylesheets/my.css"
uniq_css_path(["admin/secrets","home/signup"]) #=> ["http://assets2.my-awesome-domain.com/stylesheets/admin/secrets.css", "http://assets1.my-awesome-domain.com/stylesheets/home/signup.css"]
577 578 579 580 581 582 583 |
# File 'lib/merb-assets/assets_mixin.rb', line 577 def uniq_css_path(*assets) paths = [] assets.collect.flatten.each do |filename| paths.push(Merb::Assets::UniqueAssetPath.build(asset_path(:stylesheet,filename))) end paths.length > 1 ? paths : paths.first end |
#uniq_css_tag(*assets) ⇒ Object
Parameters
- *assets
As uniq_css_tag but has unique path
Returns
- Array
Full unique paths to assets OR
- String
if only a single path is requested
Examples
uniq_css_tag("my") #=>
609 610 611 |
# File 'lib/merb-assets/assets_mixin.rb', line 609 def uniq_css_tag(*assets) css_include_tag(*uniq_css_path(assets)) end |
#uniq_js_path(*assets) ⇒ Object
Parameters
- *assets
Creates unique paths for javascript files (prepends "/javascripts" and appends ".js")
Returns
- Array
Full unique paths to assets OR
- String
if only a single path is requested
Examples
uniq_js_path("my") #=> "http://assets2.my-awesome-domain.com/javascripts/my.js"
uniq_js_path(["admin/secrets","home/signup"]) #=> ["http://assets2.my-awesome-domain.com/javascripts/admin/secrets.js", "http://assets1.my-awesome-domain.com/javascripts/home/signup.js"]
555 556 557 558 559 560 561 |
# File 'lib/merb-assets/assets_mixin.rb', line 555 def uniq_js_path(*assets) paths = [] assets.collect.flatten.each do |filename| paths.push(Merb::Assets::UniqueAssetPath.build(asset_path(:javascript,filename))) end paths.length > 1 ? paths : paths.first end |
#uniq_js_tag(*assets) ⇒ Object
Parameters
- *assets
As js_include_tag but has unique path
Returns
- Array
Full unique paths to assets OR
- String
if only a single path is requested
Examples
uniq_js_tag("my") #=>
595 596 597 |
# File 'lib/merb-assets/assets_mixin.rb', line 595 def uniq_js_tag(*assets) js_include_tag(*uniq_js_path(assets)) end |
#uniq_path(*assets) ⇒ Object
Parameters
- *assets
The assets to include. These should be the full paths to any static served file
Returns
- Array
Full unique paths to assets OR
- String
if only a single path is requested
Examples
uniq_path("/javascripts/my.js","/javascripts/my.css") #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/javascripts/my.css"]
uniq_path(["/javascripts/my.js","/stylesheets/my.css"]) #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/stylesheets/my.css"]
uniq_path(%w(/javascripts/my.js /stylesheets/my.css)) #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/stylesheets/my.css"]
uniq_path('/stylesheets/somearbitrary.css') #=> "http://assets3.my-awesome-domain.com/stylesheets/somearbitrary.css"
uniq_path('/images/hostsexypicture.jpg') #=>"http://assets1.my-awesome-domain.com/images/hostsexypicture.jpg"
![http://assets1.my-awesome-domain.com/images/hostsexypicture.jpg"](http://assets1.my-awesome-domain.com/images/hostsexypicture.jpg"){kind=link}
533 534 535 536 537 538 539 |
# File 'lib/merb-assets/assets_mixin.rb', line 533 def uniq_path(*assets) paths = [] assets.collect.flatten.each do |filename| paths.push(Merb::Assets::UniqueAssetPath.build(filename)) end paths.length > 1 ? paths : paths.first end |