rails-bootstrap-helpers 0.0.1

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

@@ -0,0 +1,22 @@
+module RailsBootstrapHelpers::Helpers::FormTagHelper
+  # Renders a Bootstrap button tag. This method behaves just as
+  # <tt>button_tag</tt> but will render a Bootstrap styled button tag instead.
+  #
+  # @params text [String] the text of the button
+  # @params type [String, Symbol] the type of the button. Adds a "type"
+  #         attribute to the tag
+  #
+  # @params options [Hash] a hash of 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 post of the icon, if present
+  # @param :icon_invert [Boolean] if the color of the icon should be inverted
+  def bs_button_tag (value, type, options = {})
+    options = options.merge type: type
+    RailsBootstrapHelpers::Renderers::ButtonRenderer.new(self, :button, value, options).render
+  end
+end

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

@@ -0,0 +1,35 @@
+module RailsBootstrapHelpers::Helpers::LabelHelper
+  include RailsBootstrapHelpers::Helpers::OptionsHelper
+
+  # Renders a Bootstrap label.
+  #
+  # @param text [String] the text rendered in the label
+  # @param style [Symbol, Symbol] the style used to render the label
+  # @param options [Hash] a hash of options. Passed straight through to the
+  #        underlying "span" tag.
+  # 
+  def bs_label (text, style = :default, options = {})
+    normalize_style = lambda do |style|
+      style = style.to_s
+
+      case style
+        when "inactive" then "default"
+        when "active" then "success"
+        when "error" then "important"
+      else
+        style
+      end
+    end
+
+    options = options.dup
+    style = normalize_style.call(style)
+
+    cls = options[:class]
+    cls ||= "label"
+    cls << " label-" + style unless style == "default"
+
+    options[:class] = cls
+
+    content_tag :span, text, bs_options(options)
+  end
+end

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

@@ -0,0 +1,32 @@
+module RailsBootstrapHelpers::Helpers::OptionsHelper
+  # Handles general Bootstrap options available for all Bootstrap helpers.
+  #
+  # Any option not specify below are kept intact.
+  #
+  # @param options [Hash] a hash of options
+  # @param html_options [Hash] a hash of HTML options/attributes
+  #
+  # ==== Options
+  # @param :tooltip [String] the text of the tooltip. IF present adds attributes
+  #        for a Bootstrap tooltip. This will add the <tt>data-toggle="tooltip"</tt>
+  #        and <tt>title="#{tooltip}" </tt> HTML attributes if not already present
+  #
+  # @param :tooltip_location ["left", "right", "top", "bottom"] the position of
+  #        the tooltip if <tt>:tooltip</tt> is present. Adds the
+  #        <tt>data-placement="#{tooltip_position}"</tt> HTML attribute if not
+  #        already present.
+  def bs_options (options, html_options = {})
+    options = options.reverse_merge(html_options)
+
+    if tooltip = options.delete(:tooltip)
+      options[:"data-toggle"] ||= "tooltip"
+      options[:title] ||= tooltip
+
+      if tooltip_position = options.delete(:tooltip_position)
+        options[:"data-placement"] ||= tooltip_position
+      end
+    end
+
+    options
+  end
+end

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

@@ -0,0 +1,15 @@
+#require "action"
+
+module RailsBootstrapHelpers
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer "rails-bootstrap-helpers.helpers" do
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::AlertHelper
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::BaseHelper
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::ButtonHelper
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::FormTagHelper
+        ActionView::Base.send :include, RailsBootstrapHelpers::Helpers::LabelHelper
+      end
+    end
+  end
+end

data/lib/rails-bootstrap-helpers/renderers/abstract_button_renderer.rb

@@ -0,0 +1,86 @@
+module RailsBootstrapHelpers::Renderers
+  class AbstractButtonRenderer < Renderer
+    def initialize (template, type, *args, &block)
+      super template
+      @args = args
+      @block = block
+      @text = self.args[0]
+      @type = type
+
+      extract_options!
+    end
+
+    def render
+      template.send method, *new_args, &block
+    end
+
+  protected
+
+    attr_reader :block
+    attr_reader :args
+
+    attr_accessor :options
+    attr_accessor :html_options
+    attr_accessor :text
+
+    def method
+      case @type
+        when :link then :link_to
+        when :button then :button_tag
+        else :link_to
+      end
+    end
+
+    def new_args
+      case @type
+        when :link
+          [text, options, html_options, *self.args[3 .. -1]]
+        when :button then
+          opts = options.reverse_merge(html_options)
+          [text, opts, *self.args[3 .. -1]]
+        else
+          [text, options, html_options, *self.args[3 .. -1]]
+      end    
+    end
+
+    # Returns true if the given key exists as an option.
+    #
+    # @param key [String, Symbol] the key to check for
+    # @return the value of the option
+    def has_option? (key)
+      _has_option?(key, options, html_options)
+    end
+
+    # Appends the given class to the "class" HTMl attribute.
+    #
+    # @param cls [String, Symbol] the class to append
+    def append_class (cls)
+      return unless cls
+
+      if c = html_options[:class]
+        html_options[:class] << " " + cls.to_s
+      else
+        html_options[:class] = cls.to_s
+      end
+    end
+
+  private
+
+    def extract_options!
+      self.options = args[1]
+      self.options = options.stringify_keys if options.is_a?(Hash)
+      self.html_options = args[2] || {}
+      self.html_options = html_options.stringify_keys
+    end
+
+    def _has_option? (key, options, html_options = nil)
+      result = options.is_a?(Hash) && options.key?(key) && options.delete(key)
+
+      if html_options
+        result || _has_option?(key, html_options)
+      else
+        result
+      end
+    end
+  end
+end

data/lib/rails-bootstrap-helpers/renderers/button_renderer.rb

@@ -0,0 +1,43 @@
+module RailsBootstrapHelpers::Renderers
+  class ButtonRenderer < AbstractButtonRenderer
+    def render
+      append_class "btn"
+
+      if style = has_option?("style")
+        append_class "btn-" + style.to_s
+      end
+
+      if size = has_option?("size")
+        append_class "btn-" + size.to_s
+      end
+
+      if disabled = has_option?("disabled")
+        append_class "disabled"
+      end
+
+      if icon = has_option?("icon")
+        pos = has_option?("icon_position")
+        icon_args = [icon, invert: has_option?("icon_invert")]
+
+        if pos.to_s == "right"
+          self.text = self.text.to_s + " " + RailsBootstrapHelpers::Helpers::BaseHelper.icon(*icon_args)
+        else
+          self.text = RailsBootstrapHelpers::Helpers::BaseHelper.icon(*icon_args) + " " + self.text.to_s
+        end
+
+        self.text = self.text.html_safe
+      else
+        strip_unused_options!
+      end
+
+      super
+    end
+
+  private
+
+    def strip_unused_options!
+      has_option?("icon_position")
+      has_option?("icon_invert")
+    end
+  end
+end

data/lib/rails-bootstrap-helpers/renderers/renderer.rb

@@ -0,0 +1,14 @@
+module RailsBootstrapHelpers::Renderers
+  class Renderer
+    abstract :render
+    attr_reader :template
+
+    def initialize (template)
+      @template = template
+    end
+
+    def method_missing (*args, &block)
+      @template.send(*args, &block)
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module RailsBootstrapHelpers
+  VERSION = "0.0.1"
+end

data/lib/tasks/bootstrap-rails-helpers_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails-bootstrap-helpers do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.