rails-bootstrap-helpers 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTExOWU1ODk5MGFiM2Y1Mjk4NGZlNDVlNGYzOTMzYjkzZGEyMWJlNQ==
+  data.tar.gz: !binary |-
+    MGM1ZThmNjhkZGJkNTA4OGQzMDQ5MjAyNTAyYjgyMDMzN2RlYjM0ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzA0YTY2NTIwZjE1NjUwMTM2Y2M4MWE0ZjUyN2FjN2Q1NTdmYTQ4MzdmZDI3
+    MjA0MzQzNjc0MTM4ZGUxMGJmNTJhM2VkMjhjNTQxNzJkY2IxMTljZWU5Nzhj
+    NThlMmRlYTdjNDIzZTU2YTlmNDlmMmM2ZTcyYWRiZGFkYjM4ZTI=
+  data.tar.gz: !binary |-
+    YWM1ZGU1NjZkMGZlYzczNGE1NmE4N2JhYmFjNjY0ZDU4YjJjZDQxNjI2Mzc0
+    MDc2MDk4ZGI0YmNhMzU1NmVlNGJjYWM4NmZiNTA2YzgzM2IzYzFkMDE5MjIw
+    N2Q4NzY2ZDZiNjMzYjc0YzE2NDg5ZmRlYmJiNmNhNDhhODc1NDk=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# Rails Bootstrap Helpers
+
+Rails Bootstrap Helpers is a plugin for Ruby on Rails that adds view helpers for
+[Bootstrap](http://twitter.github.io/bootstrap/).
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem "rails-bootstrap-helpers"
+```
+
+Manually include the necessary stylesheets and JavaScript files from Bootstrap.
+
+Although it has no direct dependencies on other gems than Rails, it is necessary
+to include Bootstrap in some way or another to make this gem useful.
+[bootstrap-sass](https://github.com/thomas-mcdonald/bootstrap-sass) is
+recommended.
+
+### JavaScript
+
+Some of the helpers uses features of Bootstrap that requires JavaScript to be
+initialized. You need to manually do this initialization. The following helpers
+uses JavaScript that needs manually initialization:
+
+* Any helper with the `:tooltip` option
+* [bs\_popover\_button](#bs_popover_button)
+
+For which JavaScript file to include, follow the
+[Bootstrap documentation](http://twitter.github.io/bootstrap/javascript.html).
+
+## Usage
+
+### <a id="common"></a>Common
+
+#### <a id="icon"></a>icon
+
+```erb
+<%= icon :edit %> # renders an icon with the icon-edit icon
+<%= icon :edit, invert: true %> # inverts the color of the icon, making it white
+```
+
+[Bootstrap documentation](http://twitter.github.io/bootstrap/base-css.html#icons)
+
+### <a id="alerts"></a>Alerts
+
+#### <a id="bs_alert"></a>bs\_alert
+```erb
+<%= bs_alert "foo" %> # standard alert box
+<%= bs_alert "foo", block: true %> # alert box with block style
+<%= bs_alert "foo", dismiss_button: true %> # alert box with a dismiss button
+```
+
+[Bootstrap documentation](http://twitter.github.io/bootstrap/components.html#alerts)
+
+### <a id="buttons"></a>Buttons
+
+#### <a id="bs_button_to"></a>bs\_button\_to
+
+```erb
+<%= bs_button_to "google", "http://www.google.se" %>
+<%= bs_button_to "google", "http://www.google.se", style: "success" %>
+<%= bs_button_to "google", "http://www.google.se", disabled: true %>
+<%= bs_button_to "google", "http://www.google.se", icon: "edit" %>
+<%= bs_button_to "google", "http://www.google.se", icon_position: "left" %>
+<%= bs_button_to "google", "http://www.google.se", icon_invert: "left" %>
+```
+
+The `bs_button_to` helper renders an `a` tag, styled as a Bootstrap button. It's
+basically a wrapper around the `link_to` helper. In addition all the standard
+arguments and options that `link_to` accepts it also accepts the above options.
+
+#### <a id="bs_inline_button_to"></a>bs\_inline\_button\_to
+
+```erb
+<%= bs_inline_button_to "http://www.google.se", :edit %>
+```
+
+The `bs_inline_button_to` helper renders an `a` tag, styled as a inline
+Bootstrap button. That is, a button with the an icon (no text) and the size
+"mini". Except from that it accepts all options as the [bs\_button\_to](#bs_button_to) does.
+
+#### <a id="bs_popover_button"></a>bs\_popover\_button
+
+```erb
+<%= bs_popover_button "foo", "bar"
+<%= bs_popover_button "foo", "bar", placement: "right" %>
+<%= bs_popover_button "foo" do %>
+  <%= link_to "Google", "http://www.google.se" %>
+<% end %>
+```
+
+Renders a Bootstrap button that when clicked opens a popover. The content of the
+popover can either be supplied as the second argument or as a block.
+
+**Note:** this helper requires JavaScript to be manually initialized. Add the
+following code to your JavaScript file:
+
+````javascript
+$("[data-toggle=popover]").popover(html: true)
+// The "html" option tells the plugin to not escape HTML. Useful when rendering
+// the popover content using a block.
+```
+
+[Bootstrap documentation](http://twitter.github.io/bootstrap/base-css.html#buttons)
+
+### <a id="forms"></a>Forms
+
+#### <a id="bs_button_tag"></a> bs\_button\_tag
+
+```erb
+<%= bs_button_to "google", :submit %>
+```
+
+Renders an `button` tag styled as a Bootstrap button. First argument is the text
+to be rendered on the button, the other is what type of button (that is, the HTML
+attribute `type`). Accepts all the options as [bs\_button\_to](#bs_button_to) does.
+
+[Bootstrap documentation](http://twitter.github.io/bootstrap/base-css.html#buttons)
+
+### <a id="labels"></a>Labels
+
+#### <a id="bs_label"></a>bs\_label
+
+```erb
+<%= bs_label "foo" # standard label%>
+<%= bs_label "foo", style: "success" # styled label %>
+```
+
+### <a id="tooltips"></a>Tooltips
+
+```erb
+<%= bs_label "foo", tooltip: "bar" %>
+```
+
+Basically any helper accepts the `:tooltip` option. This will add a Bootstrap
+tooltip to the rendered component.
+
+**Note:** this option requires JavaScript to be manually initialized. Add the
+following code to your JavaScript file:
+
+````javascript
+$("[data-toggle=tooltip]").tooltip()
+```
+
+[Bootstrap documentation](http://twitter.github.io/bootstrap/components.html#labels-badges)
+
+## Tests
+
+Run the tests using RSpec
+
+	$ bundle install
+	$ bundle exec rspec
+
+## License
+
+Rails Bootstrap Helpers is licensed under [The MIT license](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsBootstrapHelpers'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/rails-bootstrap-helpers.rb

@@ -0,0 +1,20 @@
+require "rails-bootstrap-helpers/core_ext/abstract"
+
+module RailsBootstrapHelpers
+  module Renderers
+    autoload :AbstractButtonRenderer, "rails-bootstrap-helpers/renderers/abstract_button_renderer"
+    autoload :ButtonRenderer, "rails-bootstrap-helpers/renderers/button_renderer"
+    autoload :Renderer, "rails-bootstrap-helpers/renderers/renderer"
+  end
+
+  module Helpers
+    autoload :AlertHelper, "rails-bootstrap-helpers/helpers/alert_helper"
+    autoload :BaseHelper, "rails-bootstrap-helpers/helpers/base_helper"
+    autoload :ButtonHelper, "rails-bootstrap-helpers/helpers/button_helper"
+    autoload :FormTagHelper, "rails-bootstrap-helpers/helpers/form_tag_helper"
+    autoload :LabelHelper, "rails-bootstrap-helpers/helpers/label_helper"
+    autoload :OptionsHelper, "rails-bootstrap-helpers/helpers/options_helper"
+  end
+end
+
+require "rails-bootstrap-helpers/rails/engine"

data/lib/rails-bootstrap-helpers/core_ext/abstract.rb

@@ -0,0 +1,72 @@
+#
+class AbstractError < Exception; end
+
+# Class method that marks one or several methods as abstract, or a whole
+# class. If an abstract method is called an AbstractError will be thrown.
+#
+# Note: when making a whole class abstract the call to "abstract" must come
+# after any constructors.
+#
+# ==== Parameters
+# @param args [Array<String, Symbol>] A list of methods that should be abstract.
+#        If the list is empty the class that called the method will be made
+#        abstract instead.
+#
+# ==== Examples
+#
+#   class Foo
+#     abstract
+#   end
+#
+#   class Bar < Foo
+#   end
+#
+#   Foo.new
+#   # => AbstractError: Cannot instantiate abstract class Foo.
+#
+#   Bar.new
+#   # => #<Bar:0x100123a30>
+#
+#   class Base
+#     abstract :foo
+#   end
+#
+#   class Sub < Base
+#   end
+#
+#   class Foo < Base
+#     def foo
+#       3
+#     end
+#   end
+#
+#   Sub.new.foo
+#   # => AbstractError: Unimplemented abstract method foo.
+#
+#   Foo.new.foo
+#   # => 3
+def abstract(*args)
+  if args.length == 0
+    class_eval do
+      alias __abstract_initialize__ initialize
+
+      def initialize (*params, &block)
+        raise AbstractError.new("Cannot instantiate abstract class #{self.class.name}.")
+      end
+
+      def self.inherited (subclass)
+        subclass.send(:define_method, :initialize) do |*args|
+          __abstract_initialize__ *args
+        end
+      end
+    end
+  else
+    class_eval do
+      args.each do |name|
+        define_method name do |*params, &block|
+          raise AbstractError.new("Unimplemented abstract method #{name}.")
+        end
+      end
+    end
+  end
+end

data/lib/rails-bootstrap-helpers/helpers/alert_helper.rb

@@ -0,0 +1,45 @@
+# -*- encoding : utf-8 -*-
+
+module RailsBootstrapHelpers::Helpers::AlertHelper
+  # Renders a Bootstrap alert with the given text.
+  #
+  # @param text [String] the text to render in the alert
+  #
+  # ==== Options
+  # @param :type [String] the type of alert to render
+  # @param :block [Boolean] indicates if the alert should render with block style
+  # @param :dismiss_button [Boolean] indicates if an dismiss button should be
+  #        added to the alert
+  def bs_alert (text, options = {})
+    cls = "alert"
+
+    if type = options[:type]
+      type = type.to_s
+
+      if type == "notice"
+        type = "success"
+      end
+
+      unless type == "warning" || type == "default"
+        cls << " alert-#{type}"
+      end
+    end
+
+    if type = options[:block]
+      cls << " alert-block"
+    end
+
+    if dismiss_button = options[:dismiss_button]
+      content_tag :div, class: cls do
+        button = content_tag :button, "×",
+          type: "button",
+          class: "close",
+          :"data-dismiss" => "alert"
+
+        button + text
+      end
+    else
+      content_tag :div, text, class: cls
+    end
+  end
+end

data/lib/rails-bootstrap-helpers/helpers/base_helper.rb

@@ -0,0 +1,32 @@
+module RailsBootstrapHelpers::Helpers::BaseHelper
+  # Renders the given icon
+  #
+  # Renders an <tt>i</tt> tag with the class "icon-#{icon}"
+  #
+  # @param icon [String, Symbol] the kind of icon to render
+  #
+  # ==== Options
+  # @param :invert [Boolean] if the color of the icon should be inverted
+  def self.icon (icon, options = {})
+    icon = ERB::Util.html_escape(icon.to_s)
+    cls = "icon-" + icon
+
+    if invert = options.delete(:invert)
+      cls << " icon-white"
+    end
+
+    "<i class=\"#{cls}\"></i>".html_safe
+  end
+
+  # Renders the given icon
+  #
+  # Renders an <tt>i</tt> tag with the class "icon-#{icon}"
+  #
+  # @param icon [String, Symbol] the kind of icon to render
+  #
+  # ==== Options
+  # @param :invert [Boolean] if the color of the icon should be inverted
+  def icon (icon, options = {})
+    RailsBootstrapHelpers::Helpers::BaseHelper.icon(icon, options)
+  end
+end

data/lib/rails-bootstrap-helpers/helpers/button_helper.rb

@@ -0,0 +1,55 @@
+module RailsBootstrapHelpers::Helpers::ButtonHelper
+  # Renders a Bootstrap button. This method behaves just as "link_to" but will
+  # render a Bootstrap button instead of a regular link. Note that this is still
+  # an "a" tag and not an "input" tag. In addition to the options "link_to"
+  # handles this method also handles the following options:
+  #
+  # ==== Options
+  # @param :style [String, Symbol] the style of the button
+  # @param :size ["large", "small", "mini"] the size of the button
+  # @param :disabled [Boolean] if the button should be disabled or not
+  # @param :icon [String] the name of an icon to render on the button
+  # @param :icon_position ["left", "right"] the position of the icon, if present
+  # @present :icon_invert [Boolean] if the color of the icon should be inverted
+  #   or not
+  def bs_button_to (*args, &block)
+    RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :link, *args, &block).render
+  end
+
+  # Renders an inline Bootstrap button. That is, a small button having only an
+  # icon and no text.
+  #
+  # @param url [String] the URL the button should link to
+  # @param icon [String] the icon of the button
+  # @param options [Hash] a hash of options. See bs_button_to
+  #
+  # @see #bs_button_to
+  def bs_inline_button_to (url, icon, options = {})
+    options = options.reverse_merge icon: icon, size: "mini"
+    RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :link, nil, url, options).render
+  end
+
+  # Renders a Bootstrap button with a popover.
+  #
+  # @param name [String] the name/title of the button
+  # @param content_or_options [String, Hash] a hash of options if a block is
+  #        passed, otherwise the content of the popover
+  #
+  # @param block [block] a block rendering the content of the popover
+  #
+  # ==== Options
+  # @param :placement [String, "bottom", "top", "left", "right"]
+  def bs_popover_button (name, content_or_options = nil, options = {}, &block)
+    if block_given?
+      bs_popover_button(name, capture(&block).gsub("\n", ""), content_or_options || {})
+    else
+      placement = options.delete(:placement) || "bottom"
+
+      options = options.reverse_merge :"data-content" => content_or_options,
+        :"data-toggle" => "popover",
+        :"data-placement" => placement
+
+      bs_button_to(name, '#', options)
+    end
+  end
+end