RubyGems - bootstrap2-rails - Versions diffs - 0.0.1 - Mend

bootstrap2-rails 0.0.1

Files changed (33) hide show

data/.gitignore +4 -0
data/Gemfile +4 -0
data/README.rdoc +54 -0
data/Rakefile +1 -0
data/app/views/layouts/application.html.erb +21 -0
data/app/views/shared/_search.html.erb +4 -0
data/app/views/shared/_search.html.erb~ +4 -0
data/bootstrap2-rails.gemspec +25 -0
data/lib/bootstrap2-rails.rb +19 -0
data/lib/bootstrap2-rails/bootstrap_helper.rb +24 -0
data/lib/bootstrap2-rails/menu_creator.rb +39 -0
data/lib/bootstrap2-rails/version.rb +3 -0
data/lib/generators/bootstrap/views_generator.rb +23 -0
data/lib/templates/erb/scaffold/_form.html.erb +43 -0
data/lib/templates/erb/scaffold/edit.html.erb +7 -0
data/lib/templates/erb/scaffold/index.html.erb +53 -0
data/lib/templates/erb/scaffold/new.html.erb +7 -0
data/lib/templates/erb/scaffold/show.html.erb +21 -0
data/lib/templates/rails/scaffold_controller/controller.rb +102 -0
data/vendor/assets/images/close.gif +0 -0
data/vendor/assets/images/error.png +0 -0
data/vendor/assets/images/glyphicons-halflings-white.png +0 -0
data/vendor/assets/images/glyphicons-halflings.png +0 -0
data/vendor/assets/images/left_arrow.png +0 -0
data/vendor/assets/images/notice.png +0 -0
data/vendor/assets/images/right_arrow.png +0 -0
data/vendor/assets/images/success.png +0 -0
data/vendor/assets/images/warning.png +0 -0
data/vendor/assets/javascripts/bootstrap.js +1722 -0
data/vendor/assets/javascripts/jquery.toastmessage.js +161 -0
data/vendor/assets/stylesheets/bootstrap.css +3363 -0
data/vendor/assets/stylesheets/jquery.toastmessage.css +142 -0
metadata +88 -0

data/.gitignore ADDED

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in bootstrap2-rails.gemspec
+gemspec

data/README.rdoc ADDED

@@ -0,0 +1,54 @@
+== bootstrap2-rails gem
+Warning: this gem is under development, bugs are present.
+This gem replaces Rails default scaffold to create views based on Bootstrap 2, from Twitter (http://twitter.github.com/bootstrap). There is also a toast message feature based on JQuery Toast Message plugin.
+When installed, this gem overrides Rails default scaffold templates, which means that any call to scaffold generator will use the gem templates. The views also are generated with some others features like search and sort.
+There is also a dropdown menu generator to avoid manual menu creation.
+=== Building gem
+After downloading project folder, run this command on root folder to make a gem file inside pkg folder:
+  rake build
+=== Installation
+You can use this gem with only Rails 3. Include this line inside your Gemfile:
+  gem 'bootstrap2-rails', :path => '/path/to/gemfolder'
+Run the bundle command to install required gems in your Rails application:
+  bundle
+=== Generating view files
+After installing gem, run the views generator to copy some needed files (caution: it will override application.html.erb)
+  rails generate bootstrap:views
+=== Loading bootstrap CSS file
+Include this line in your app/assets/stylesheets/application.css file to load a required CSS file
+   *= require bootstrap
+=== Toast messages
+Toast messages are notifications with an android-like visual. There are 4 types of toast messages: error, warning, notice and success. In order to use the toast-messages include this required line in your app/assets/javascripts/application.js file
+  *= require jquery.toastmessage
+And also this line for loading CSS in your app/assets/stylesheets/application.css file
+  *= require jquery.toastmessage
+To show a toast message use this helper method
+  display_toast_message(message, type)
+where message is the message text and type is one of the four types of messages (notice, error, success or warning)
+=== Menu generator
+The menu generator creates a dropdown menu for your actions inside your controllers. There are three steps needed for creating a menu:
+1) Load a required javascript file by adding this line to your app/assets/javascripts/application.js
+  //= require bootstrap-dropdown
+2) Define wich items and subitems will be available. In a dropdown menu there is a main item and several subitems. The main item is only a text explaining the content (e.g. File, Window, Tools). The subitems are controller actions (e.g. New, Save, Close). To define the main item and corresponding subitems, insert this line in your application_controller.rb:
+  menu_options [{:title => 'Index', :itens => [
+    {:text => 'Projects', :controller => 'projects', :action => 'index'}
+  ]}]
+The menu_options parameter is an array of hashes with 2 keys: title and itens. The title is the text of the main item and can be anything you want. The itens is an array of hashes, wich one with 3 keys: text (the subitem text), controller (the controller with the action) and action (the action itself).
+3) Include a menu_bar call in your html page:
+  <%= menu_bar %>

data/Rakefile ADDED

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

data/app/views/layouts/application.html.erb ADDED

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Framework</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= menu_bar %>
+<div class="container-fluid" style="padding-top: 45px">
+  <% flash.each do |name, msg| %>
+    <%= display_toast_message(msg, name) %>
+  <% end %>
+  <%= yield %>
+</div>
+</body>
+</html>

data/app/views/shared/_search.html.erb ADDED

@@ -0,0 +1,4 @@
+<%= form_tag({action: "index"}, {method: :get, class: 'form-search'}) do %>
+  <%= text_field_tag("search", params[:search], {size: 70, placeholder: placeholder, class: 'input-medium search-query'}) %>
+  <%= submit_tag("Search", class: 'btn') %>
+<% end %>

data/app/views/shared/_search.html.erb~ ADDED

@@ -0,0 +1,4 @@
+<%= form_tag({action: "index"}, {method: :get, class: 'form-search'}) do %>
+  <%= text_field_tag("search", params[:search], {size: 70, placeholder: placeholder}) %>
+  <%= submit_tag("Search", class: 'btn') %>
+<% end %>

data/bootstrap2-rails.gemspec ADDED

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bootstrap2-rails/version"
+Gem::Specification.new do |s|
+  s.name        = "bootstrap2-rails"
+  s.version     = BootstrapRails::VERSION
+  s.authors     = ["Fabio Stapait"]
+  s.email       = ["stapait@gmail.com"]
+  s.homepage    = "https://github.com/stapait/bootstrap2-rails"
+  s.summary     = %q{This is a scaffold replacement with a Twitter Bootstrap look}
+  s.description = %q{This is a scaffold replacement with a Twitter Bootstrap look}
+  s.rubyforge_project = "bootstrap2-rails"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_dependency "will_paginate"
+end

data/lib/bootstrap2-rails.rb ADDED

@@ -0,0 +1,19 @@
+require "bootstrap2-rails/version"
+require "will_paginate"
+require "bootstrap2-rails/bootstrap_helper"
+require "bootstrap2-rails/menu_creator"
+module BootstrapRails
+  module Rails
+    class Engine < ::Rails::Engine
+      # Include helper inside app
+      ActionView::Base.send :include, BootstrapHelper
+      ActionView::Base.send :include, MenuCreator
+      config.app_generators do |g|
+        # Make templates loadable from gem insted of copying to app
+        g.templates.unshift File::expand_path('../templates', __FILE__)
+      end
+    end
+  end
+end

data/lib/bootstrap2-rails/bootstrap_helper.rb ADDED

@@ -0,0 +1,24 @@
+module BootstrapHelper
+  # returns a link to sort table columns
+  def sortable(column, title = nil)
+    title ||= column.titleize
+    direction = params[:direction] == "asc" ? "desc" : "asc"
+    link_to title, sort: column, direction: direction
+  end
+  def sort_class(direction, column, table_column)
+    return nil if column != table_column
+    return 'yellow headerSortDown' if direction == 'asc'
+    return 'yellow headerSortUp' if direction == 'desc'
+  end
+  # display a message using the JQuery Toast Message plugin
+  # types available: notice, success, warning an error
+  def display_toast_message(message, type)
+    return nil unless ['notice', 'success', 'warning', 'error'].include? type.to_s.downcase
+    result = "<script>"
+    result << "$().toastmessage('show#{type.to_s.capitalize}Toast', '#{message}');"
+    result << "</script>"
+    result.html_safe
+  end
+end

data/lib/bootstrap2-rails/menu_creator.rb ADDED

@@ -0,0 +1,39 @@
+module MenuCreator
+  @@loaded = false
+  @@menu_params = []
+  def menu_options(params)
+    @@menu_params = params unless @@loaded
+  end
+  def menu_bar
+    return nil unless @@menu_params
+    html = '<div class="topbar-wrapper" style="z-index:5">'
+    html += '<div class="topbar" data-dropdown="dropdown">'
+    html += '<div class="topbar-inner">'
+    html += '<div class="container">'
+    html += '<ul class="nav">'
+    @@menu_params.each do |param|
+      html += '<li class="dropdown">'
+      html += link_to(param[:title], '#', class: 'dropdown-toggle')
+      html += '<ul class="dropdown-menu">'
+      param[:itens].each do |subitem|
+        html += content_tag(:li, link_to(subitem[:text], controller: subitem[:controller], action: subitem[:action]))
+      end
+      html += '</ul>'
+      html += '</li>'
+    end
+    html += '</ul>'
+    html += '</div>'
+    html += '</div>'
+    html += '</div>'
+    html += '</div>'
+    html.html_safe
+  end
+end

data/lib/bootstrap2-rails/version.rb ADDED

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

data/lib/generators/bootstrap/views_generator.rb ADDED

@@ -0,0 +1,23 @@
+module Bootstrap
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates views needed for working with bootstrap2-rails"
+      def generate_files
+        source_folder = File.join(File.dirname(File.absolute_path(__FILE__)), "..", "..", "..", "app", "views", "shared")
+        dest_folder = File.join("app", "views", "shared")
+        Dir.entries(source_folder).each do |file|
+          copy_file("#{source_folder}/#{file}", "#{dest_folder}/#{file}") unless File.directory? "#{source_folder}/#{file}"
+        end
+        source_folder = File.join(File.dirname(File.absolute_path(__FILE__)), "..", "..", "..", "app", "views", "layouts")
+        dest_folder = File.join("app", "views", "layouts")
+        Dir.entries(source_folder).each do |file|
+          copy_file("#{source_folder}/#{file}", "#{dest_folder}/#{file}") unless File.directory? "#{source_folder}/#{file}"
+        end
+      end
+    end
+  end
+end

data/lib/templates/erb/scaffold/_form.html.erb ADDED

@@ -0,0 +1,43 @@
+<%%= form_for(@<%= singular_table_name %>, html: {class: 'form-horizontal'}) do |f| %>
+  <%% if @<%= singular_table_name %>.errors.any? %>
+    <div class="alert alert-block">
+      <p>
+      	<strong><%%= pluralize(@<%= singular_table_name %>.errors.count, "error") %> prohibited this <%= singular_table_name %> from being saved:</strong>
+        <ul>
+          <%% @<%= singular_table_name %>.errors.full_messages.each do |msg| %>
+          <li><%%= msg %></li>
+          <%% end %>
+        </ul>
+      </p>
+    </div>
+    <script type="text/javascript">
+    $('document').ready(function() {
+      $(".field_with_errors label").css('color', 'red');
+      // Remove field_with_errors div
+      $(".field_with_errors").each(function(index, element) {
+        var content = element.innerHTML;
+        $(element).replaceWith(content);
+      });
+	  <%% @<%= singular_table_name %>.errors.each do |a| %>
+	    $('#<%= singular_table_name %>_<%%= a %>').css('border-color', 'red');
+	  <%% end %>
+    });
+    </script>
+  <%% end %>
+<% attributes.each do |attribute| -%>
+  <div class="control-group">
+    <%%= f.label :<%= attribute.name %>, class: 'control-label' %>
+    <div class="controls">
+      <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+    </div>
+  </div>
+<% end -%>
+  <div class="form-actions">
+    <%%= f.submit <%= key_value :class, "'btn btn-primary'" %> %>
+    <%%= link_to 'Back', <%= plural_table_name %>_path, <%= key_value :class, "'btn btn-default'" %> %>
+  </div>
+<%% end %>

data/lib/templates/erb/scaffold/edit.html.erb ADDED

@@ -0,0 +1,7 @@
+<div class="breadcrumb">
+  <div class="page-header">
+    <h2>Editing <%= singular_table_name %></h2>
+  </div>
+  <%%= render 'form' %>
+</div>

data/lib/templates/erb/scaffold/index.html.erb ADDED

@@ -0,0 +1,53 @@
+<script type="text/javascript">
+	$('.btn-danger').click(function(){
+		event.preventDefault();
+	});
+	$('document').ready(function(){
+    $('.btn-info').tooltip({title: "Show <%= singular_table_name %>"});
+    $('.btn-primary').tooltip({title: "Edit <%= singular_table_name %>"});
+    $('.btn-danger').tooltip({title: "Delete <%= singular_table_name %>"});
+    $('.btn-success').tooltip({title: "Create a new <%= singular_table_name %>"});
+  });
+</script>
+<div class="page-header">
+  <h2>Listing <%= plural_table_name %></h2>
+</div>
+<%%= render(partial: '/shared/search', locals: {placeholder: 'Text to search'}) %>
+<table class="table table-striped table-bordered table-condensed">
+  <thead>
+  	<tr>
+<% attributes.each do |attribute| -%>
+    <th class="<%%= sort_class(@sort_direction, @sort_column, '<%= attribute.name %>') %>"><%%= sortable('<%= attribute.name %>') %></th>
+<% end -%>
+    <th width="140px"><a href="#">Actions</a></th>
+    </tr>
+  </thead>
+  <tbody>
+<%% if @<%= plural_table_name %>.size > 0 %>
+  <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+    <tr>
+<% attributes.each do |attribute| -%>
+      <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+      <td>
+        <%%= link_to content_tag(:i, nil, class: 'icon-list-alt icon-white'), <%= singular_table_name %>, <%= key_value :class, "'btn btn-info btn-small'" %> %> &nbsp;
+        <%%= link_to content_tag(:i, nil, class: 'icon-tag icon-white'), edit_<%= singular_table_name %>_path(<%= singular_table_name %>), <%= key_value :class, "'btn btn-primary btn-small'" %> %> &nbsp;
+        <%%= link_to content_tag(:i, nil, class: 'icon-trash icon-white'), <%= singular_table_name %>, <%= key_value :confirm, "'Are you sure?'" %>, <%= key_value :method, ":delete" %>, <%= key_value :class, "'btn btn-danger btn-small'" %> %>
+      </td>
+    </tr>
+  <%% end %>
+<%% else %>
+    <tr><td colspan="10">Empty</td></tr>
+<%% end %>
+  </tbody>
+</table>
+<%%= will_paginate @<%= plural_table_name %> %>
+<%%= link_to 'New <%= human_name %>', new_<%= singular_table_name %>_path, <%= key_value :class, "'btn btn-large btn-success'" %>, <%= key_value :style, "'float: right'" %> %>

data/lib/templates/erb/scaffold/new.html.erb ADDED

@@ -0,0 +1,7 @@
+<div class="breadcrumb">
+  <div class="page-header">
+    <h2>New <%= singular_table_name %></h2>
+  </div>
+  <%%= render 'form' %>
+</div>

data/lib/templates/erb/scaffold/show.html.erb ADDED

@@ -0,0 +1,21 @@
+<div class="breadcrumb">
+  <div class="page-header">
+    <h2><%= class_name %> details</h2>
+  </div>
+  <% attributes.each do |attribute| -%>
+  <div class="row">
+    <div class="span1">
+      <strong><%= attribute.human_name %></strong>
+    </div>
+    <div class="span8">
+  	  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+    </div>
+  </div>
+  <% end -%>
+</div>
+<div class="breadcrumb">
+  <%%= link_to 'Edit', edit_<%= singular_table_name %>_path(@<%= singular_table_name %>), :class => 'btn btn-primary' %>
+  <%%= link_to 'Back', <%= index_helper %>_path, class: 'btn btn-default' %>
+</div>

data/lib/templates/rails/scaffold_controller/controller.rb ADDED

@@ -0,0 +1,102 @@
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  # Attribute used for search (change if needed)
+  SEARCH_ATTR = "name"
+  # GET <%= route_url %>
+  # GET <%= route_url %>.json
+  def index
+    condition = "#{SEARCH_ATTR} like ?"
+    @<%= plural_table_name %> = <%= class_name %>.where(condition, "%#{params[:search]}%")
+      .page(params[:page]).order(sort_column + " " + sort_direction).per_page(10)
+    @sort_direction = sort_direction
+    @sort_column = sort_column
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render <%= key_value :json, "@#{plural_table_name}" %> }
+    end
+  end
+  # GET <%= route_url %>/1
+  # GET <%= route_url %>/1.json
+  def show
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render <%= key_value :json, "@#{singular_table_name}" %> }
+    end
+  end
+  # GET <%= route_url %>/new
+  # GET <%= route_url %>/new.json
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render <%= key_value :json, "@#{singular_table_name}" %> }
+    end
+  end
+  # GET <%= route_url %>/1/edit
+  def edit
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+  end
+  # POST <%= route_url %>
+  # POST <%= route_url %>.json
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "params[:#{singular_table_name}]") %>
+    respond_to do |format|
+      if @<%= orm_instance.save %>
+        format.html { redirect_to @<%= singular_table_name %>, <%= key_value :notice, "'#{human_name} was successfully created.'" %> }
+        format.json { render <%= key_value :json, "@#{singular_table_name}" %>, <%= key_value :status, ':created' %>, <%= key_value :location, "@#{singular_table_name}" %> }
+      else
+        format.html { render <%= key_value :action, '"new"' %> }
+        format.json { render <%= key_value :json, "@#{orm_instance.errors}" %>, <%= key_value :status, ':unprocessable_entity' %> }
+      end
+    end
+  end
+  # PUT <%= route_url %>/1
+  # PUT <%= route_url %>/1.json
+  def update
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    respond_to do |format|
+      if @<%= orm_instance.update_attributes("params[:#{singular_table_name}]") %>
+        format.html { redirect_to @<%= singular_table_name %>, <%= key_value :notice, "'#{human_name} was successfully updated.'" %> }
+        format.json { head :ok }
+      else
+        format.html { render <%= key_value :action, '"edit"' %> }
+        format.json { render <%= key_value :json, "@#{orm_instance.errors}" %>, <%= key_value :status, ':unprocessable_entity' %> }
+      end
+    end
+  end
+  # DELETE <%= route_url %>/1
+  # DELETE <%= route_url %>/1.json
+  def destroy
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    @<%= orm_instance.destroy %>
+    respond_to do |format|
+      format.html { redirect_to <%= index_helper %>_url, <%= key_value :notice, "'#{human_name} deleted.'" %> }
+      format.json { head :ok }
+    end
+  end
+  private
+  def sort_column
+    <%= class_name %>.column_names.include?(params[:sort]) ? params[:sort] : SEARCH_ATTR
+  end
+  def sort_direction
+    %w[asc desc].include?(params[:direction]) ? params[:direction] : "asc"
+  end
+end
+<% end -%>