Skip to content

Commit

Permalink
Merge pull request #1412 from matthias-guenther/padrino-helpers-docum…
Browse files Browse the repository at this point in the history 
…entation-cleanup

Helpers documentation cleanup
  • Loading branch information
@namusyaka
namusyaka committed Sep 15, 2013
2 parents a768fde + 0b10b1d commit aa600a3
Show file tree
Hide file tree
Showing 37 changed files with 666 additions and 769 deletions.
8 changes: 3 additions & 5 deletions padrino-helpers/lib/padrino-helpers.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
require 'active_support/inflector' # humanize

FileSet.glob_require('padrino-helpers/**/*.rb', __FILE__)

# Load our locales
I18n.load_path += Dir["#{File.dirname(__FILE__)}/padrino-helpers/locale/*.yml"]

module Padrino
Expand All @@ -33,7 +31,7 @@ class << self
# Padrino::Helpers::Breadcrumbs
#
# @param [Sinatra::Application] app
# The specified padrino application
# The specified Padrino application.
#
# @example Register the helper module
# require 'padrino-helpers'
Expand All @@ -55,5 +53,5 @@ def registered(app)
end
alias :included :registered
end
end # Helpers
end # Padrino
end
end
70 changes: 31 additions & 39 deletions padrino-helpers/lib/padrino-helpers/asset_tag_helpers.rb
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
module Padrino
module Helpers
###
# Helpers related to producing assets (images,stylesheets,js,etc) within templates.
# Helpers related to producing assets (images, stylesheets, js, etc) within templates.
#
module AssetTagHelpers
FRAGMENT_HASH = "#".html_safe.freeze
APPEND_ASSET_EXTENSIONS = ["js", "css"] # assets that require an appended extension
ABSOLUTE_URL_PATTERN = %r{^(https?://)} # absolute url regex
APPEND_ASSET_EXTENSIONS = ["js", "css"]
ABSOLUTE_URL_PATTERN = %r{^(https?://)}

##
# Creates a div to display the flash of given type if it exists
# Creates a div to display the flash of given type if it exists.
#
# @param [Symbol] kind
# The type of flash to display in the tag.
# @param [Hash] options
# The html options for this section.
# use :bootstrap => true to support Twitter's bootstrap dismiss alert button
# use :bootstrap => true to support Twitter's bootstrap dismiss alert button.
#
# @return [String] Flash tag html with specified +options+.
#
Expand All @@ -26,7 +26,6 @@ module AssetTagHelpers
# # Generates: <div class="error">flash-error</div>
# # <div class="success">flash-success</div>
#
# @api public
def flash_tag(*args)
options = args.extract_options!
bootstrap = options.delete(:bootstrap) if options[:bootstrap]
Expand All @@ -39,7 +38,7 @@ def flash_tag(*args)
end

##
# Creates a link element with given name, url and options
# Creates a link element with given name, url and options.
#
# @overload link_to(caption, url, options={})
# @param [String] caption The text caption.
Expand All @@ -51,13 +50,13 @@ def flash_tag(*args)
# @param [Proc] block The link content.
#
# @option options [String] :anchor
# The anchor for the link (i.e #something)
# The anchor for the link (i.e #something).
# @option options [String] :fragment
# Synonym for anchor
# Synonym for anchor.
# @option options [Boolean] :if
# If true, the link will appear, otherwise not;
# If true, the link will appear, otherwise not.
# @option options [Boolean] :unless
# If false, the link will appear, otherwise not;
# If false, the link will appear, otherwise not.
# @option options [Boolean] :remote
# If true, this link should be handled by an ajax ujs handler.
# @option options [String] :confirm
Expand All @@ -74,13 +73,12 @@ def flash_tag(*args)
# link_to('click me', :class => 'blocky') do; end
#
# Note that you can pass :+if+ or :+unless+ conditions, but if you provide :current as
# condition padrino return true/false if the request.path_info match the given url
# condition padrino return true/false if the request.path_info match the given url.
#
# @api public
def link_to(*args, &block)
options = args.extract_options!
fragment = options.delete(:anchor).to_s if options[:anchor]
fragment = options.delete(:fragment).to_s if options[:fragment]
options = args.extract_options!
fragment = options.delete(:anchor).to_s if options[:anchor]
fragment = options.delete(:fragment).to_s if options[:fragment]

url = ActiveSupport::SafeBuffer.new
if block_given?
Expand Down Expand Up @@ -121,11 +119,11 @@ def link_to(*args, &block)
# @param[Hash] options
# The options for the feed tag.
# @option options [String] :rel ("alternate")
# Specify the relation of this link
# Specify the relation of this link.
# @option options [String] :type
# Override the auto-generated mime type
# Override the auto-generated mime type.
# @option options [String] :title
# Specify the title of the link, defaults to the type
# Specify the title of the link, defaults to the type.
#
# @return [String] Feed link html tag with specified +options+.
#
Expand All @@ -135,7 +133,6 @@ def link_to(*args, &block)
# feed_tag :rss, url(:blog, :posts, :format => :rss)
# # Generates: <link type="application/rss+xml" rel="alternate" href="/blog/posts.rss" title="rss" />
#
# @api public
def feed_tag(mime, url, options={})
full_mime = (mime == :atom) ? 'application/atom+xml' : 'application/rss+xml'
tag(:link, options.reverse_merge(:rel => 'alternate', :type => full_mime, :title => mime, :href => url))
Expand Down Expand Up @@ -163,7 +160,6 @@ def feed_tag(mime, url, options={})
# # Generates: <a href="mailto:me@demo.com">My Email</a>
# mail_to "me@demo.com", "My Email"
#
# @api public
def mail_to(email, caption=nil, mail_options={})
html_options = mail_options.slice!(:cc, :bcc, :subject, :body)
mail_query = Rack::Utils.build_query(mail_options).gsub(/\+/, '%20').gsub('%40', '@').gsub('&', '&amp;')
Expand All @@ -188,14 +184,13 @@ def mail_to(email, caption=nil, mail_options={})
# # Generates: <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
# meta_tag "text/html; charset=UTF-8", 'http-equiv' => "Content-Type"
#
# @api public
def meta_tag(content, options={})
options.reverse_merge!("content" => content)
tag(:meta, options)
end

##
# Generates a favicon link. looks inside images folder
# Generates a favicon link. Looks inside images folder
#
# @param [String] source
# The source image path for the favicon link tag.
Expand All @@ -210,15 +205,14 @@ def meta_tag(content, options={})
# # or override some options
# favicon_tag 'favicon.png', :type => 'image/ico'
#
# @api public
def favicon_tag(source, options={})
type = File.extname(source).gsub('.','')
options = options.dup.reverse_merge!(:href => image_path(source), :rel => 'icon', :type => "image/#{type}")
tag(:link, options)
end

##
# Creates an image element with given url and options
# Creates an image element with given url and options.
#
# @param [String] url
# The source path for the image tag.
Expand All @@ -230,7 +224,6 @@ def favicon_tag(source, options={})
# @example
# image_tag('icons/avatar.png')
#
# @api public
def image_tag(url, options={})
options.reverse_merge!(:src => image_path(url))
tag(:img, options)
Expand All @@ -250,7 +243,7 @@ def image_tag(url, options={})
# @example
# stylesheet_link_tag 'style', 'application', 'layout'
#
# @api public
# @api public.
def stylesheet_link_tag(*sources)
options = sources.extract_options!.symbolize_keys
options.reverse_merge!(:media => 'screen', :rel => 'stylesheet', :type => 'text/css')
Expand All @@ -273,7 +266,6 @@ def stylesheet_link_tag(*sources)
# @example
# javascript_include_tag 'application', :extjs
#
# @api public
def javascript_include_tag(*sources)
options = sources.extract_options!.symbolize_keys
options.reverse_merge!(:type => 'text/javascript')
Expand All @@ -287,7 +279,7 @@ def javascript_include_tag(*sources)
# like app/public/images for inclusion. You can provide also a full path.
#
# @param [String] src
# The path to the image file (relative or absolute)
# The path to the image file (relative or absolute).
#
# @return [String] Path to an image given the +kind+ and +source+.
#
Expand All @@ -301,10 +293,10 @@ def image_path(src)
end

##
# Returns the path to the specified asset (css or javascript)
# Returns the path to the specified asset (css or javascript).
#
# @param [String] kind
# The kind of asset (i.e :images, :js, :css)
# The kind of asset (i.e :images, :js, :css).
# @param [String] source
# The path to the asset (relative or absolute).
#
Expand All @@ -320,7 +312,6 @@ def image_path(src)
# # Generates: /images/example.jpg?1269008689
# asset_path :images, 'example.jpg'
#
# @api semipublic
def asset_path(kind, source)
source = asset_normalize_extension(kind, URI.escape(source.to_s))
return source if source =~ ABSOLUTE_URL_PATTERN || source =~ /^\// # absolute source
Expand All @@ -332,7 +323,7 @@ def asset_path(kind, source)

private
##
# Returns the uri root of the application with optional paths appended.
# Returns the URI root of the application with optional paths appended.
#
# @example
# uri_root_path("/some/path") => "/root/some/path"
Expand All @@ -344,7 +335,7 @@ def uri_root_path(*paths)
end

##
# Returns the timestamp mtime for an asset
# Returns the timestamp mtime for an asset.
#
# @example
# asset_timestamp("some/path/to/file.png") => "?154543678"
Expand Down Expand Up @@ -375,7 +366,8 @@ def asset_folder_name(kind)
end
end

# Normalizes the extension for a given asset
##
# Normalizes the extension for a given asset.
#
# @example
#
Expand All @@ -389,7 +381,7 @@ def asset_normalize_extension(kind, source)
end

##
# Parses link_to options for given correct conditions
# Parses link_to options for given correct conditions.
#
# @example
# parse_conditions("/some/url", :if => false) => true
Expand All @@ -404,6 +396,6 @@ def parse_conditions(url, options)
true
end
end
end # AssetTagHelpers
end # Helpers
end # Padrino
end
end
end
Loading

0 comments on commit aa600a3

Please sign in to comment.