bootstrap-view-helpers 0.0.9 → 0.0.10

data/README.md

@@ -28,6 +28,7 @@ Includes support for:
   * form helpers
     * submit_tag_button
     * cancel_tag_button
+  * alerts
   
 ## Note
 
@@ -255,3 +256,28 @@ cancel_button_tag(:info, url: '/')
 cancel_button_tag(:large, url: '/')
 cancel_button_tag('Return', :small, :warning, url: '/', id: 'my-id')
 ```
+
+### Alerts
+
+[Bootstrap Documentation](http://twitter.github.io/bootstrap/components.html#alerts)
+[API Documentation](http://rubydoc.info/gems/bootstrap-view-helpers/Bootstrap/AlertHelper)
+
+```erb
+<%= alert('Default Alert') %>
+<%= alert('Type :info', :info) %>
+<%= alert('Type :success', :success) %>
+<%= alert('Type :error', :error) %>
+
+<%= alert('Default alert with heading', heading: 'Warning!') %>
+<%= alert('No close button', close: false) %>
+<%= alert("Type :block gives some more padding", :block ) %>
+<%= alert("Unknown options are html attributes", id: 'my-id', class: 'my-class') %>
+
+<%= alert :success do %>
+  <%= alert_heading('A List') %>
+  <ul>
+    <li>One</li>
+    <li>Two</li>
+  </ul>
+<% end %>
+```

data/app/helpers/bootstrap/alert_helper.rb

@@ -0,0 +1,82 @@
+# Rails helpers for producing Bootstrap alert boxes.
+#
+# See: http://twitter.github.io/bootstrap/components.html#alerts
+# 
+# @example
+#   <%= alert('Default alert') %>
+# 
+#   <%= alert('Watch out!', :error) %>
+#
+#   <%= alert('This is the body', heading: 'Title') %>
+#
+#   <%= alert :success do %>
+#     <%= alert_heading('A List') %>
+#     <ul>
+#       <li>One</li>
+#       <li>Two</li>
+#     </ul>
+#   <% end %>
+module Bootstrap::AlertHelper
+  
+  ALERT_ATTRIBUTES = %w(error success info block)
+  
+  # @overload alert(text, alert_type, options={})
+  #   @param text [String] text of the label
+  #   @param alert_type [Symbol, String] if present must be one of {Bootstrap::AlertHelper::ALERT_ATTRIBUTES}
+  #   @param options [Hash] html attributes for returned alert <div>
+  #   @option options [String] :heading if present, include a heading in the alert
+  #   @option options [Boolean] :close if +false+, don't include a close link ('x')
+  # @return [String] Returns html for alert
+  def alert(*args, &block)
+    text = args.shift unless block_given?
+    options = canonicalize_options(args.extract_options!)
+    options = ensure_class(options, 'alert')
+    options = add_alert_classes(options, args)
+    heading = options.delete(:heading)
+    show_close = options.delete(:close) != false 
+    
+    if block_given?
+      content_tag(:div, options) do
+        alert_close(show_close) + 
+        alert_heading(heading) + 
+        capture(&block)
+      end
+    else
+      content_tag(:div, options) do
+        alert_close(show_close) + 
+        alert_heading(heading) + 
+        text
+      end
+    end
+  end
+  
+  # Return an alert box close button
+  #
+  # @return [String] html for alert close button
+  def alert_close(show=true)
+    return '' unless show
+    content_tag(:button, '&times;'.html_safe, class: 'close', data: {dismiss: 'alert'})
+  end
+
+  # Return an alert heading
+  #
+  # @return [String] html for alert heading
+  def alert_heading(heading)
+    return '' unless heading.present?
+    content_tag(:h4, heading)
+  end
+  
+  private
+  
+  def add_alert_classes(options, alert_attributes)
+    validate_alert_attributes(alert_attributes)
+    classes = ['alert'] + alert_attributes.map { |e| "alert-#{e}" }
+    ensure_class(options, classes)
+  end
+  
+  def validate_alert_attributes(alert_attributes)
+    alert_attributes.each { |e| raise(InvalidAlertAttributeError, e.inspect) unless ALERT_ATTRIBUTES.include?(e.to_s) }
+  end
+  
+  
+end

data/app/views/application/_bootstrap_view_helper_side_bar.html.erb

@@ -7,5 +7,6 @@
   <%= dropdown_item('Labels and badges', bvh_path('labels_and_badges')) %>
   <%= dropdown_item('Accordions', bvh_path('accordions')) %>
   <%= dropdown_item('Form helpers', bvh_path('form_helpers')) %>
+  <%= dropdown_item('Alerts', bvh_path('alerts')) %>
   
 <% end %>

data/app/views/bootstrap_view_helpers/_alert_block.html.erb

@@ -0,0 +1,7 @@
+<%= alert :success do %>
+  <%= alert_heading('A List') %>
+  <ul>
+    <li>One</li>
+    <li>Two</li>
+  </ul>
+<% end %>

data/app/views/bootstrap_view_helpers/_alert_options.html.erb

@@ -0,0 +1,8 @@
+<%= alert('Default alert with heading', heading: 'Warning!') %>
+
+<%= alert('No close button', close: false) %>
+
+<%= alert("Type :block gives some more padding", :block ) %>
+
+<%= alert("Unknown options are html attributes", id: 'my-id', class: 'my-class') %>
+

data/app/views/bootstrap_view_helpers/_alert_types.html.erb

@@ -0,0 +1,8 @@
+<%= alert('Default Alert') %>
+
+<%= alert('Type :info', :info) %>
+
+<%= alert('Type :success', :success) %>
+
+<%= alert('Type :error', :error) %>
+

data/app/views/bootstrap_view_helpers/accordions.html.erb

@@ -9,5 +9,5 @@
 <h2>Example</h2>
 <%= render partial: 'accordions' %>
 
-<h2>Source</2>
+<h2>Source</h2>
 <%= bvh_show_source('bootstrap_view_helpers/_accordions') %>

data/app/views/bootstrap_view_helpers/alerts.html.erb

@@ -0,0 +1,31 @@
+<h1>Alerts</h1>
+
+<p>
+  <%=link_to 'Bootstrap Documentation', 'http://twitter.github.io/bootstrap/components.html#alerts' %>
+  <br>
+  <%= link_to('API Documentation', 'http://rubydoc.info/gems/bootstrap-view-helpers/Bootstrap/AlertHelper') %>
+</p>
+
+<h2>Standard Bootstrap Alert Types</h2>
+
+<h3>Examples</h3>
+<%= render partial: 'alert_types' %>
+
+<h3>Source</h3>
+<%= bvh_show_source('bootstrap_view_helpers/_alert_types') %>
+
+<h2>Alert Options</h2>
+
+<h3>Examples</h3>
+<%= render partial: 'alert_options' %>
+
+<h3>Source</h3>
+<%= bvh_show_source('bootstrap_view_helpers/_alert_options') %>
+
+<h2>Block Form</h2>
+
+<h3>Examples</h3>
+<%= render partial: 'alert_block' %>
+
+<h3>Source</h3>
+<%= bvh_show_source('bootstrap_view_helpers/_alert_block') %>

data/lib/bootstrap-view-helpers/version.rb

@@ -1,3 +1,3 @@
 module BootstrapViewHelpers
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap-view-helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -187,6 +187,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +277,7 @@ files:
 - app/assets/stylesheets/bootstrap-view-helpers/bs_docs_example.css
 - app/controllers/bootstrap_view_helpers_controller.rb
 - app/helpers/bootstrap/accordion_helper.rb
+- app/helpers/bootstrap/alert_helper.rb
 - app/helpers/bootstrap/badge_helper.rb
 - app/helpers/bootstrap/button_helper.rb
 - app/helpers/bootstrap/common_helper.rb
@@ -274,9 +291,13 @@ files:
 - app/views/application/_bootstrap_view_helper_nav_bar.html.erb
 - app/views/application/_bootstrap_view_helper_side_bar.html.erb
 - app/views/bootstrap_view_helpers/_accordions.html.erb
+- app/views/bootstrap_view_helpers/_alert_block.html.erb
+- app/views/bootstrap_view_helpers/_alert_options.html.erb
+- app/views/bootstrap_view_helpers/_alert_types.html.erb
 - app/views/bootstrap_view_helpers/_form_helper_1.html.erb
 - app/views/bootstrap_view_helpers/_icons.html.erb
 - app/views/bootstrap_view_helpers/accordions.html.erb
+- app/views/bootstrap_view_helpers/alerts.html.erb
 - app/views/bootstrap_view_helpers/buttons.html.erb
 - app/views/bootstrap_view_helpers/form_helpers.html.erb
 - app/views/bootstrap_view_helpers/icons.html.erb