padrino-helpers 0.11.3 → 0.11.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef68c8d06903529b8d8f51c05b1290487a392463
+  data.tar.gz: e7a25b76bffb3892afd7f4a4820e0507670c608a
+SHA512:
+  metadata.gz: 66cda324d865e815ec7bbdd1e93ac7dae958d5ec3db1e7b1f53a409f2aa825c76c58bcab9f632da80c2dce5f48d532a04aa77f9d7c632f72fea4d7955d5b1e19
+  data.tar.gz: c01aaa4bdb41938c530acb00cc1784490a06b462f1ff315c53514f3915a959bc76214c4a5142213e1ebe01abd5407fc498782663ea811368db9c2a9fc0b61671

data/README.rdoc

@@ -236,4 +236,4 @@ For more information on using the render and partial helpers, check out the guid
 
 == Copyright
 
-Copyright (c) 2011 Padrino. See LICENSE for details.
+Copyright (c) 2011-2013 Padrino. See LICENSE for details.

data/lib/padrino-helpers.rb

@@ -8,8 +8,6 @@ require 'active_support/core_ext/object/with_options' # with_options
 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
@@ -33,7 +31,7 @@ module Padrino
       #   Padrino::Helpers::Breadcrumbs
       #
       # @param [Sinatra::Application] app
-      #   The specified padrino application
+      #   The specified Padrino application.
       #
       # @example Register the helper module
       #   require 'padrino-helpers'
@@ -55,5 +53,5 @@ module Padrino
       end
       alias :included :registered
     end
-  end # Helpers
-end # Padrino
+  end
+end

data/lib/padrino-helpers/asset_tag_helpers.rb

@@ -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+.
       #
@@ -26,7 +26,6 @@ module Padrino
       #   # 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]
@@ -39,7 +38,7 @@ module Padrino
       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.
@@ -51,15 +50,15 @@ module Padrino
       #   @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 a ajax ujs handler.
+      #   If true, this link should be handled by an ajax ujs handler.
       # @option options [String] :confirm
       #   Instructs ujs handler to alert confirm message.
       # @option options [Symbol] :method
@@ -74,13 +73,12 @@ module Padrino
       #   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?
@@ -121,11 +119,11 @@ module Padrino
       # @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+.
       #
@@ -135,7 +133,6 @@ module Padrino
       #   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))
@@ -163,7 +160,6 @@ module Padrino
       #   # 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;')
@@ -188,14 +184,13 @@ module Padrino
       #   # 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.
@@ -210,7 +205,6 @@ module Padrino
       #   # 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}")
@@ -218,7 +212,7 @@ module Padrino
       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.
@@ -230,7 +224,6 @@ module Padrino
       # @example
       #   image_tag('icons/avatar.png')
       #
-      # @api public
       def image_tag(url, options={})
         options.reverse_merge!(:src => image_path(url))
         tag(:img, options)
@@ -250,7 +243,7 @@ module Padrino
       # @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')
@@ -273,7 +266,6 @@ module Padrino
       # @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')
@@ -287,7 +279,7 @@ module Padrino
       # 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+.
       #
@@ -301,10 +293,10 @@ module Padrino
       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).
       #
@@ -320,7 +312,6 @@ module Padrino
       #   # 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
@@ -332,7 +323,7 @@ module Padrino
 
       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"
@@ -344,7 +335,7 @@ module Padrino
       end
 
       ##
-      # Returns the timestamp mtime for an asset
+      # Returns the timestamp mtime for an asset.
       #
       # @example
       #   asset_timestamp("some/path/to/file.png") => "?154543678"
@@ -375,7 +366,8 @@ module Padrino
         end
       end
 
-      # Normalizes the extension for a given asset
+      ##
+      # Normalizes the extension for a given asset.
       #
       #  @example
       #
@@ -389,7 +381,7 @@ module Padrino
       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
@@ -404,6 +396,6 @@ module Padrino
           true
         end
       end
-    end # AssetTagHelpers
-  end # Helpers
-end # Padrino
+    end
+  end
+end

data/lib/padrino-helpers/breadcrumb_helpers.rb

@@ -1,30 +1,28 @@
 module Padrino
   module Helpers
     class Breadcrumb
-
       attr_accessor :home, :items
 
       DEFAULT_URL = "/"
       DEFAULT_CAPTION ="Home Page"
 
       ##
-      # initialize breadcrumbs with default value
+      # Initialize breadcrumbs with default value.
       #
       # @example
       #   before do
       #     @breadcrumbs = breadcrumbs.new
       #   end
       #
-      # @api public
       def initialize
         reset!
       end
 
       ##
-      # Set the custom home (Parent) link
+      # Set the custom home (Parent) link.
       #
       # @param [String] url
-      #  The url href
+      #  The url href.
       #
       # @param [String] caption
       #   The  text caption.
@@ -35,8 +33,6 @@ module Padrino
       # @example
       #   breadcrumbs.set_home "/HomeFoo", "Foo Home", :id => "home-breadcrumb"
       #
-      #
-      # @api public
       def set_home(url, caption, options = {})
         self.home = {
           :url     => url.to_s,
@@ -48,24 +44,22 @@ module Padrino
       end
 
       ##
-      # Reset breadcrumbs to default or personal  home
+      # Reset breadcrumbs to default or personal home.
       #
       # @example
       #   breadcrumbs.reset
       #
-      # @api public
       def reset
         self.items = []
         self.items << home
       end
 
       ##
-      # Reset breadcrumbs to default home
+      # Reset breadcrumbs to default home.
       #
       # @example
       #   breadcrumbs.reset!
       #
-      # @api public
       def reset!
         self.home = {
           :name    => :home,
@@ -77,7 +71,7 @@ module Padrino
       end
 
       ##
-      # Add a new  breadcrumbs
+      # Add a new breadcrumbs.
       #
       # @param [String] name
       #   The name of resource.
@@ -97,7 +91,6 @@ module Padrino
       #   breadcrumbs.add "foo", "/foo", "Foo Link", :id => "foo-id"
       #   breadcrumbs.add :foo, "/foo", "Foo Link", :class => "foo-class"
       #
-      # @api public
       def add(name, url, caption, options = {})
         items << {
           :name    => name.to_sym,
@@ -106,42 +99,35 @@ module Padrino
           :options => options
         }
       end
-
       alias :<< :add
 
       ##
-      # Remove a Breadcrumbs
+      # Remove a breadcrumb.
       #
       # @param [String] name
-      #  The name of resource to delete from breadcrumbs list
-      #
-      # @param [Symbol] name
-      #  The name of resource to delete from breadcrumbs list
+      #  The name of resource to delete from breadcrumbs list.
       #
       # @example
       #   breadcrumbs.del "foo"
       #   breadcrumbs.del :foo
       #
-      # @api public
       def del(name)
         items.delete_if { |item| item[:name] == name.to_sym }
       end
-
-    end # Breadcrumb
-
+    end
 
     module Breadcrumbs
-
-      # Render breadcrumbs to view
+      ##
+      # Render breadcrumbs to view.
       #
       # @param [Breadcrumbs] breadcrumbs
-      #   The breadcrumbs to render into view
+      #   The breadcrumbs to render into view.
       #
       # @param [Boolean] bootstrap
-      #  If true, render separation (usefull with Twitter Bootstrap)
+      #  If true, render separation (useful with Twitter Bootstrap).
       #
       # @param [String] active
-      #  Css class style set to active breadcrumb
+      #  CSS class style set to active breadcrumb.
       #
       # @param [Hash] options
       #   The HTML options to include in ul.
@@ -156,8 +142,6 @@ module Padrino
       #  #   <li class="active"><a href="/bar">Bar Link</a></li>
       #  # </ul>
       #
-      #
-      # @api public
       def breadcrumbs(breadcrumbs, bootstrap = false, active = "active", options = {})
         content = ""
         breadcrumbs.items[0..-2].each do |item|
@@ -178,24 +162,22 @@ module Padrino
 
       private
       ##
-      # Private method to return list item
+      # Private method to return list item.
       #
       # @param [Hash] item
-      #   The breadcrumb item
+      #   The breadcrumb item.
       #
       # @param [Boolean] bootstrap
-      #   If true, render separation (usefull with Twitter Bootstrap)
+      #   If true, render separation (useful with Twitter Bootstrap).
       #
-      # @return [String] List item with breacrumb
+      # @return [String] List item with breadcrumb
       #
-      # @api public
       def render_item(item, bootstrap)
         content = ""
         content << link_to(item[:caption], item[:url])
         content << safe_content_tag(:span, "/", :class => "divider") if bootstrap
         safe_content_tag(:li, content, item[:options])
       end
-
-    end # Breadcrumb
-  end # Helpers
-end # Padrino
+    end
+  end
+end