bootstrap_admin 0.0.8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bootstrap_admin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ivo Jesus
+
+MIT License
+
+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,246 @@
+# BootstrapAdmin
+
+Dead-simple admin interfaces!<br>
+BootstrapAdmin is a small engine designed to ease the construction of administrative interfaces.
+
+## Installation
+
+Add the gem to your Rails app Gemfile:
+`gem 'bootstrap_admin'`
+
+And run:
+`$ bundle install`
+
+Or just run:
+`$ gem install bootstrap_admin`
+
+Then, just run the install generator
+`$ rails g bootstrap_admin:install`
+
+By default, bootstrap\_admin will use "admin" as the namespace, but you can change this by adding the wanted namespace:
+
+`$ rails g bootstrap_admin:install --namespace=MyAdmin`
+
+Running the generator will create the following files (assuming the namespace is "admin"):
+
+    config/initializers/bootstrap_admin.rb
+    config/bootstrap_admin_menu.yml
+    app/assets/javascripts/admin
+    app/assets/javascripts/admin.js
+    app/assets/stylesheets/admin
+    app/assets/stylesheets/admin.css
+    app/controllers/admin_controller.rb
+
+## Usage
+
+Bootstrap Admin was designed to be an almost zero-configuration drop-in solution for administration UIs, so getting it up and running is actually pretty simple.
+
+### Defining Routes
+
+Bootstrap Admin comes with a route macro to define the administration section of your app.<br/>
+All you need to do is head up to your `config/routes.rb` and add something like:
+
+```ruby
+bootstrap_admin do
+  # define resources normally here...
+  # resources :books
+end
+```
+
+This will define:
+
+* A basic route to "admin#show"
+* A namespace "admin" that will contain all resources defined within the block
+
+### Creating a basic CRUD scaffold
+
+For a basic CRUD interface for an Entity, all you need to do is:
+
+* Generate a Model and set it up (relations, accessible attributes, etc..)
+* Generate a Controller that inherits from your AdminController and add the `bootstrap_admin` macro on that controller
+* Add the routes to the controller under the bootstrap_admin route<br/>
+  `resource :books`
+
+And you're ready to roll!
+
+#### Basic Example - Books
+
+So, assuming you have a Book model:
+
+`$ rails g model Book title:string author:string synopsis:text`
+```ruby
+class Book < ActiveRecord::Base
+  accessible_attributes :title, :author, :synopsis
+end
+```
+
+All you need on the controller side (assuming you are using "admin" as namespace) is:
+
+`$ rails g controller Admin::Books`
+```ruby
+class Admin::BooksController < AdminController
+  bootstrap_admin
+end
+```
+
+And a route like:
+```ruby
+bootstrap_admin do
+  resources :books
+end
+```
+
+And BAM, ready to roll!!
+
+## Configuring Bootstrap Admin - Initializer
+
+TODO
+
+## Admin Menu
+
+If you want to customize the bootstrap_admin menu, you can edit the `config/bootstrap_admin_menu.yml` file. There, you can specify the entries you want for the menu, customize the label, an even define dropdown sub-menus.
+
+So, to customize the menu, you must supply a list of menu entries.<br/>
+On each entry you can use this set of options:
+
+* `:label` - the label that will be presented in the menu. This can be either:
+  * **Symbol** - Will be passed to I18n for translation
+  * **String** - Will be used directly
+* `:class` - the css class to apply to the item
+* `:url`   - the url to be used on the item link.
+* `:item`  - one of 3 things:
+  * **String**: must be a name of a model (it will be used to build the link url and the label if not supplied)
+  * **List**: This will tell bootstrap_admin that the item is in fact a dropdown menu. **In this case `:label` must be supplied.**
+  * **Symbol**: currently only `:divider` is supported and produces a division between dropdown elements.
+
+### Example
+
+    # Item based on a model
+    - :item: Document
+
+    # Item based on a model with a custom label and css class
+    - :item: Author
+      :label: The guys who write things
+      :class: really_bold
+
+    # Item based on a model with a custom url
+    - :item: Search
+      :url: "https://google.com"
+
+    # Dropdown menu item with several options and a divider
+    - :label: :user_admin # this will be called as I18n.t(:user_admin)
+      :url: "#"
+      :item:
+      - :item:  Role
+      - :item:  :divider
+      - :item:  User
+        :label: Dudes
+
+## Configuring the Controller
+
+By default, bootstrap\_admin will use the fields defined as accessible on the model matching the name of the controller it is working on to build all markup. Also, by default, bootstrap\_admin will respond to `html` and `json` formats.
+If you want to override this behaviour, the controller macro allows you to pass a block that will be used to configure how bootstrap\_admin will behave.
+
+### Configuring which fields to use
+
+To override the default behaviour, you can use the following configurators:
+
+* `index_fields` - the fields to be used on the index action
+* `show_fields` - the fields to be used on the show action
+* `form_fields` - the fields to be used on all form actions (new, edit, etc..)
+* `searchable_fields` - the fields to be used while searching
+
+To use these configurators, you pass a block to the bootstrap\_admin macro like so:
+
+```ruby
+bootstrap_admin do |config|
+  config.index_fields = [:title, :author]
+  config.show_fields  = [:title, :author, :synopsis]
+  config.form_fields  = [:title, :author, :synopsis]
+  config.searchable_fields = [:title]
+end
+```
+
+### Configuring response formats
+
+bootstrap\_admin also allows you to define to which formats will your controller respond to using the `responder_formats` configurator like so:
+
+```ruby
+bootstrap_admin do |config|
+  config.responder_formats = [:html, :xml, :json]
+end
+```
+
+## Configuring the Routes
+
+TODO
+
+## Overriding
+
+### Overriding fields with Helper methods
+
+Lets say you have a NewsArticle model that stores news and in that article you have a field named `body` which contains the actual article in the form of markup (built with an WYSIWYG editor like CKEditor). It would be a bummer to display the whole body on the index table!!
+
+bootstrap\_admin allows you to override the field usage by defining a helper like so:
+```ruby
+def index_body record
+  strip_tags(record.body)[0..120] + "..."
+end
+```
+
+#### Overriding field on `show` or `index` actions
+
+You can override the field usage just for one of the actions or for both at once if applicable.
+
+So, if both actions can use the same display, then your helper must:
+
+* Be named `<field>` - the name of the field
+* Accept one argument - the model instance we are displaying
+
+```ruby
+def title record
+  content_tag(:i, record.title)
+end
+```
+
+If, on the other hand you need to use diferent code to display diferent actions, then your helper must:
+
+* Be named `<action>_<field>`
+* Accept one argument - the model instance we are displaying
+
+```ruby
+def show_title record
+  content_tag(:b, record.title)
+end
+
+def index_title record
+  content_tag(:i, record.title)
+end
+```
+
+#### Overriding field on `form` actions (`new`, `edit`, etc..)
+
+To override the field usage on a form action, your helper must:
+
+* Be named `form_<field>`
+* Accept one argument - the form for the model instance
+
+```ruby
+def form_title form
+  form.input(:title)
+end
+```
+You can use `form.object` to get the object to which the form is for.
+
+
+### Overriding the views
+
+TODO
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/app/assets/javascripts/bootstrap_admin/bootstrap_admin.js.coffee

@@ -0,0 +1,13 @@
+# ------------------------------------------------------------------------------
+$ = jQuery
+# ------------------------------------------------------------------------------
+$("form.bootstrap_admin.search")
+  .on "click", ".reset", ->
+    window.location = $(this).closest("form").attr("action")
+  .on "click", ".search", ->
+    $(this).closest("form").submit()
+# ------------------------------------------------------------------------------
+$("#flash-area").on "click", ".close", ->
+  $(this).closest(".alert").slideUp ->
+    $(this).remove()
+# ------------------------------------------------------------------------------

data/app/assets/javascripts/bootstrap_admin.js

@@ -0,0 +1,5 @@
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap
+//= require jquery-ui-1.9.2.custom.min
+//= require_tree './bootstrap_admin'

data/app/assets/stylesheets/_backgrounds.scss

@@ -0,0 +1,12 @@
+@mixin background-gradient($from, $to){
+  background-color: $to;
+  background-repeat: repeat-x;
+  background-image: -khtml-gradient(linear, left top, left bottom, from($from), to($to));
+  background-image: -moz-linear-gradient(top, $from, $to);
+  background-image: -ms-linear-gradient(top, $from, $to);
+  background-image: -webkit-gradient(linear, left top, left bottom, color-stop(0%, $from), color-stop(100%, $to));
+  background-image: -webkit-linear-gradient(top, $from, $to);
+  background-image: -o-linear-gradient(top, $from, $to);
+  background-image: linear-gradient(top, $from, $to);
+  filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=#{$from}, endColorstr=#{$to}, GradientType=0);
+}

data/app/assets/stylesheets/bootstrap_admin.css

@@ -0,0 +1,12 @@
+/*
+ *= require bootstrap
+ *= require bootstrap_overrides
+ *= require jquery-ui-1.9.2.custom
+ *= require_self
+ *= require_tree .
+ */
+form.search{
+  float:right;
+  margin-top: -45px;
+}
+.clear_both{clear:both;}

data/app/assets/stylesheets/bootstrap_overrides.css.scss

@@ -0,0 +1,173 @@
+@import "backgrounds.scss";
+
+.nav_fillup{
+  clear:both;
+  margin-top:40px;
+}
+.container.content{
+}
+
+
+/*  Bootstrap overrides  */
+body { font-size: 13px; }
+
+h1 { font-size: 30px; }
+h2 { font-size: 24px; }
+h3 { font-size: 18px; line-height: 20px; }
+h4 { font-size: 14px; }
+h5 { font-size: 12px; }
+h6 { font-size: 10px; }
+h1.dotted, h2.dotted, h3.dotted, h4.dotted, h5.dotted, h6.dotted{
+  border-bottom:1px dotted silver;
+}
+
+label, input, button, select, textarea { font-size: 13px; }
+
+select,
+textarea,
+input[type="text"],
+input[type="password"],
+input[type="datetime"],
+input[type="datetime-local"],
+input[type="date"],
+input[type="month"],
+input[type="time"],
+input[type="week"],
+input[type="number"],
+input[type="email"],
+input[type="url"],
+input[type="search"],
+input[type="tel"],
+input[type="color"],
+.uneditable-input {
+  font-size: 13px;
+}
+
+.actions{
+  border-top: 1px dotted silver;
+  padding: 20px 0;
+  margin-top: 10px;
+}
+
+.input-append input,
+.input-prepend input,
+.input-append select,
+.input-prepend select,
+.input-append .uneditable-input,
+.input-prepend .uneditable-input {
+  font-size: 13px;
+}
+
+.input-append .add-on,
+.input-prepend .add-on {
+  font-size: 13px;
+}
+
+.table td.actions{
+  text-align: right;
+}
+.btn { font-size: 13px; }
+.btn-group > .btn,
+.btn-group > .dropdown-menu {
+  font-size: 13px;
+}
+
+/*.navbar-inner {
+  background-color: #fafafa;
+  background-image: -moz-linear-gradient(top, #333, #222);
+  background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#333), to(#222));
+  background-image: -webkit-linear-gradient(top, #333, #222);
+  background-image: -o-linear-gradient(top, #333, #222);
+  background-image: linear-gradient(to bottom, #333, #222);
+  filter: progid:dximagetransform.microsoft.gradient(startColorstr='#ff333333', endColorstr='#ff222222', GradientType=0);
+}*/
+
+.navbar .brand {
+  /*color: white;*/
+  /*text-shadow: none;*/
+}
+.navbar .nav > li > a,
+.navbar .nav > li > a:focus,
+.navbar .nav > li > a:hover {
+  /*color: white;*/
+  text-shadow: none;
+}
+.navbar .nav > li > a{
+  color: silver;
+}
+
+.pagination {
+  margin: 0;
+}
+
+.pagination ul > li > a,
+.pagination ul > li > span {
+  line-height: 28px;
+}
+
+.popover-title {
+  font-size: 13px;
+}
+
+.navbar-fixed-top, .navbar-fixed-bottom{
+  z-index: 1;
+}
+
+// ------------------------------------------------------------------------------------
+.navbar-inner{
+  // @include background-gradient(#242424, #050505);
+  @include background-gradient(#333, #222);
+}
+.navbar{
+  .brand {
+    color: white;
+    text-shadow: 0 1px 0 #222;
+    &:hover{
+      text-shadow: 0 0 1px silver;
+    }
+  }
+  .nav > li > a{
+    &:focus, &:hover{
+      color:white;
+      text-shadow: 0 0 1px silver;
+    }
+  }
+}
+// -----------------------------------------------------------------------------
+form div.error{
+  // background:#fae5e3;
+  padding:10px 0;
+  margin:-10px 0 10px;
+  -webkit-border-radius:4px;
+  -moz-border-radius:4px;
+  border-radius:4px;
+
+  >label, span.help-inline, span.help-block{
+    color: #9d261d;
+  }
+
+  .input-prepend span.add-on, .input-append span.add-on{
+    background:#f4c8c5;
+    border-color:#c87872;
+    color:#b9554d;
+  }
+  input, textarea, select{
+    border-color:#c87872;
+    -webkit-box-shadow:0 0 3px rgba(171, 41, 32, 0.25);
+    -moz-box-shadow:0 0 3px rgba(171, 41, 32, 0.25);
+    box-shadow:0 0 3px rgba(171, 41, 32, 0.25);
+  }
+  input[type=file]{
+    border: 1px solid #c87872;
+  }
+
+  input:focus, textarea:focus{
+    border-color:#b9554d;
+    -webkit-box-shadow:0 0 6px rgba(171, 41, 32, 0.5);
+    -moz-box-shadow:0 0 6px rgba(171, 41, 32, 0.5);
+    box-shadow:0 0 6px rgba(171, 41, 32, 0.5);
+  }
+}
+
+
+

data/app/helpers/bootstrap_admin/menu_helper.rb

@@ -0,0 +1,117 @@
+module BootstrapAdmin::MenuHelper
+
+  BOOTSTRAP_ADMIN_MENU_FILE = "config/bootstrap_admin_menu.yml"
+
+  # =============================================================================
+  # Builds the bootstrap_admin menu markup
+  # @return [Markup] bootstrap_admin menu
+  def bootstrap_admin_menu
+    content_tag :ul, :class=>"nav" do
+      bootstrap_admin_menu_items.map do |row|
+        if row[:item].is_a? Array
+          bootstrap_admin_menu_dropdown row
+        elsif row[:item].is_a? Symbol
+          bootstrap_admin_menu_separator row
+        else
+          bootstrap_admin_menu_item row
+        end
+      end.join.html_safe
+    end # content_tag
+  end
+
+  private
+    # =============================================================================
+    def build_bootstrap_admin_menu_from_controller_names
+      namespace = BootstrapAdmin.admin_namespace
+      Dir["./app/controllers/#{namespace}/**/*.rb"].each do |controller|
+        require controller
+      end
+
+      yml_menu = AdminController.descendants.map do |controller|
+        ename = controller.name.demodulize.gsub("Controller","").singularize
+        "- :item: #{ename}"
+      end.join("\n")
+
+      @bootstrap_admin_menu_items = YAML.load(yml_menu)
+    end
+
+    # =============================================================================
+    def load_bootstrap_admin_menu_items
+      @bootstrap_admin_menu_items = YAML.load_file(BOOTSTRAP_ADMIN_MENU_FILE)
+      unless @bootstrap_admin_menu_items
+        build_bootstrap_admin_menu_from_controller_names
+      end
+      @bootstrap_admin_menu_load_timestamp = Time.now
+    end
+
+    # =============================================================================
+    def bootstrap_admin_menu_items
+      if @bootstrap_admin_menu_load_timestamp.nil? or
+         File.mtime(BOOTSTRAP_ADMIN_MENU_FILE) > @bootstrap_admin_menu_load_timestamp
+        load_bootstrap_admin_menu_items
+      end
+      @bootstrap_admin_menu_items
+    end
+
+    # =============================================================================
+    def bootstrap_admin_menu_item row
+      if respond_to?(:cannot?) && cannot?(:read, row[:item].classify.constantize)
+        "".html_safe
+      else
+        content_tag(:li) do
+          bootstrap_admin_menu_link row
+        end
+      end
+    end
+
+    # =============================================================================
+    def bootstrap_admin_menu_dropdown row
+      content_tag(:li, :class=>"dropdown", :"data-dropdown"=>"dropdown") do
+        bootstrap_admin_menu_link(row) +
+        content_tag(:ul, :class=>"dropdown-menu") do
+          row[:item].map do |sub|
+            if sub[:item].is_a? Symbol
+              bootstrap_admin_menu_separator sub
+            else
+              bootstrap_admin_menu_item sub
+            end
+          end.join.html_safe
+        end
+      end
+    end
+
+    # =============================================================================
+    def bootstrap_admin_menu_separator row
+      content_tag(:li, :class => row[:item]){""}
+    end
+
+    # =============================================================================
+    def bootstrap_admin_menu_link row
+      if row[:item].is_a? Array #then its a dropdown menu
+        label = if row[:label].is_a? Symbol
+                  t row[:label]
+                else
+                  row[:label]
+                end
+        url       = row[:url  ] || "#"
+        css_class = row[:class] || "dropdown-toggle"
+        data_attr = { :toggle => "dropdown" }
+
+      else #then its a resource link.
+        model_class  = row[:item].classify.constantize
+        model_symbol = row[:item].demodulize.underscore.pluralize.to_sym
+
+        label = if row[:label].is_a? Symbol
+                  t row[:label]
+                else
+                  row[:label] || model_class.model_name.human.pluralize
+                end
+        url       = row[:url  ] || [BootstrapAdmin.admin_namespace, model_symbol]
+        css_class = row[:class]
+        data_attr = {}
+      end
+
+      link_to label, url, :class => css_class, :data => data_attr
+    end
+
+end