bootstrap_admin 0.0.8

data/app/helpers/bootstrap_admin/paginator_helper.rb

@@ -0,0 +1,115 @@
+module BootstrapAdmin::PaginatorHelper
+
+  # =============================================================================
+  def render_paginator(paginator)
+    render "paginator", :paginator => paginator
+  end
+
+  # =============================================================================
+  def render_searchbox
+    render "search_box"
+  end
+
+  # =============================================================================
+  def paginator_previous(paginator)
+    if paginator[:current_page] == 1
+      url       = "#"
+      css_class = "prev disabled"
+    else
+      url       = url_for(params.merge(:page => paginator[:current_page]-1))
+      css_class = "prev"
+    end
+
+    content_tag(:li, :class=>css_class) do
+      if "#" == url
+        content_tag(:span, "← #{t(:previous)}".html_safe)
+      else
+        link_to "← #{t(:previous)}".html_safe, url
+      end
+    end.html_safe
+  end
+
+  # =============================================================================
+  def paginator_next(paginator)
+    if paginator[:current_page] == paginator[:pages]
+      url       = "#"
+      css_class = "next disabled"
+    else
+      url       = url_for(params.merge(:page => paginator[:current_page]+1))
+      css_class = "next"
+    end
+
+    content_tag(:li, :class=>css_class) do
+      if "#" == url
+        content_tag(:span, "#{t(:next)} →".html_safe)
+      else
+        link_to "#{t(:next)} →".html_safe, url
+      end
+    end.html_safe
+  end
+
+  # =============================================================================
+  def paginator_pages(paginator)
+    if paginator[:pages] <= 5
+      [
+        paginator_range(paginator[:current_page], 1..paginator[:pages])
+      ]
+
+    elsif paginator[:current_page] <= 3
+      [
+        paginator_range(paginator[:current_page], 1..4),
+        paginator_page("...", "disabled"),
+        paginator_page(paginator[:pages])
+      ]
+
+    elsif paginator[:current_page] >= paginator[:pages] - 2
+      [
+        paginator_page(1),
+        paginator_page("...", "disabled"),
+        paginator_range(paginator[:current_page], (paginator[:pages]-3)..paginator[:pages])
+      ]
+
+    else
+      [
+        paginator_page(1),
+        paginator_page("...", "disabled"),
+        paginator_range(paginator[:current_page], (paginator[:current_page]-1)..(paginator[:current_page]+1)),
+        paginator_page("...", "disabled"),
+        paginator_page(paginator[:pages])
+      ]
+    end.join.html_safe
+  end
+
+  # =============================================================================
+  def paginator_range(current_page, range)
+    contents = range.map do |page|
+      content_tag(:li, :class => (page==current_page ? "active" : "")) do
+        if page==current_page
+          content_tag(:span, page)
+        else
+          link_to page, url_for(params.merge(:page => page))
+        end
+      end
+    end
+
+    contents.join.html_safe
+  end
+
+  # =============================================================================
+  def paginator_page(num, css_class = nil)
+    if num.to_i > 0
+      url = url_for(params.merge :page => num)
+    else
+      url = "#"
+    end
+
+    content_tag(:li, :class=>css_class) do
+      if '#' == url
+        content_tag(:span, num)
+      else
+        link_to num, url
+      end
+    end.html_safe
+  end
+
+end # module BootstrapAdmin::PaginatorHelper

data/app/helpers/bootstrap_admin_helper.rb

@@ -0,0 +1,235 @@
+module BootstrapAdminHelper
+  # =============================================================================
+  # This re-implementation of link_to simply looks at the link label and if it
+  # falls under certain conditions, then it tries to create a label and/or url
+  # accordingly. Else works normally
+  #
+  # @param *args Same as the original link_to
+  # @param &block Same as the original link_to
+  #
+  # @return [String] link markup
+  #
+  # @example Assuming locale is set to PT
+  #  link_to :Show, @document
+  #    # <a href='/documents/1'>Ver</a>
+  #
+  #  link_to Document
+  #    # <a href='/documents'>Documentos</a>
+  #
+  #  link_to [:edit, @document]
+  #    # <a href='/document/1/edit'>Editar Documento</a>
+  #
+  def link_to(*args, &block)
+    super(*args, &block) if block_given?
+
+    # When args[0] is a symbol, then just translate the symbol...
+    if args[0].is_a? Symbol
+      super(t(args[0]), *args[1..-1])
+
+    # when arg[0] is a ActiveRecord class...
+    elsif args[0].is_a?(Class) and args[0] < ActiveRecord::Base
+      label = args[0].model_name.human.pluralize
+      if args.length == 1
+        controller_name = args[0].name.underscore.pluralize
+        super(label, url_for(controller: controller_name, action: "index"))
+      else
+        super(label, *args[1..-1])
+      end
+
+    elsif args[0].is_a?(Array) && args[0][0].is_a?(Symbol) && args[0][1] < ActiveRecord::Base
+      link_content = t("helpers.submit.#{args[0][0]}", :model => args[0][1].model_name.human)
+      super(link_content, *args[1..-1])
+    else
+      super(*args)
+    end
+  end
+
+  # =============================================================================
+  # Builds the markup to properly display a field, including label and field value.
+  #
+  # If a block is given, then it uses the block as the field "value"
+  # else it looks at what the field value is and if it is:
+  #   * a boolean, builds a fake checkbox
+  #   * an array, builds a ul list with each element of the array
+  #   * else, just uses the string value
+  #
+  # @param item [ActiveRecord::Base] The item record
+  # @param field [Symbol or String] The field to display
+  # @param &block [Block] An optional block that yields markup
+  #
+  # @return [Markup] the necessary markup to display the field
+  #
+  # @example
+  #   display_field @document, :title
+  #     # <p><b>Title: </b>So Long, and Thanks For All the Fish</p>
+  #
+  #   display_field @document, :awesome?
+  #     # <p><b>Awesome: </b><span class='checkbox true'><span class='icon'></span></span></p>
+  #
+  #   display_field @document, :authors
+  #     # <p><b>Authors: </b><ul><li>Douglas Adams</li></ul></p>
+  #
+  #   display_field @document, :details do
+  #     "#{@document.title} - #{@document.year}"
+  #   end
+  #     # <p><b>Title: </b>So Long, and Thanks For All the Fish - 1984</p>
+  #
+  def display_field item, field, &block
+    content_tag :p do
+      content_tag(:b) do
+        item.class.human_attribute_name(field) + ": "
+      end +
+      if block_given?
+        capture(&block)
+      else
+        val = render_field item, field
+        if val.class.name =~ /(TrueClass|FalseClass)/
+          content_tag(:span, :class => "checkbox #{val.to_s}") do
+            content_tag(:span, :class=>"icon"){""}
+          end
+        elsif val.is_a? Array
+          content_tag :ul do
+            val.map do |uniq_val|
+              content_tag(:li, uniq_val.to_s)
+            end.join.html_safe
+          end
+        else
+          val.to_s
+        end
+      end
+    end.html_safe
+  end
+
+  # =============================================================================
+  def render_field item, field
+    if self.respond_to?(helper = "#{params[:action]}_#{field}") ||
+       self.respond_to?(helper = "#{field}")
+      send helper, item
+    else
+      item.send field
+    end
+  end
+
+  # =============================================================================
+  def render_form_field form, field
+    if self.respond_to?(helper = "#{params[:action]}_form_#{field.name}") ||
+       self.respond_to?(helper = "form_#{field.name}")
+      send helper, form
+
+    elsif field.association?
+      form.association field.name
+
+    else
+      form.input field.name
+    end
+  end
+
+  # =============================================================================
+  def available_actions
+    bootstrap_admin_config.available_actions
+  end
+
+  # =============================================================================
+  def index_actions_for item
+    actions = []
+
+    if available_actions.include? :show
+      actions << link_to(:show, [BootstrapAdmin.admin_namespace, item], class: 'btn')
+    end
+
+    if available_actions.include? :edit
+      actions << link_to(:edit, [:edit, BootstrapAdmin.admin_namespace, item], class: 'btn')
+    end
+
+    if available_actions.include? :destroy
+      actions << link_to(:destroy, [BootstrapAdmin.admin_namespace, item], confirm: t(:confirm), method: :delete, class: 'btn btn-danger')
+    end
+
+    actions.join("\n").html_safe
+  end
+
+
+  # =============================================================================
+  # @param controller [ActionController::Base]
+  # @return [Class] the model class for the current controller
+  def model_for controller
+    collection_name_for(controller).classify.constantize
+  end
+
+  # =============================================================================
+  # @return [ActiveRecord::Base] the model instance based on the controller name
+  def model_instance_for controller
+    name = collection_name_for(controller).singularize
+    instance_variable_get "@#{name}"
+  end
+
+  # =============================================================================
+  # @return [ActiveRecord::Base Array] the model instance collection for the current controller
+  def collection_for controller
+    name = collection_name_for controller
+    instance_variable_get "@#{name}"
+  end
+
+  # =============================================================================
+  # @return [String] the model instance name for the current controller
+  def model_name_for controller
+    model_for(controller).model_name.underscore
+  end
+
+  # =============================================================================
+  # @return [String] the model instance collection name for the current controller
+  def collection_name_for controller
+    controller.class.name.sub("Controller", "").underscore.split('/').last
+  end
+
+  # =============================================================================
+  # Finds the model instance attributes to use for the current action.
+  #
+  # First it checks if the bootstrap_admin_config has fields configured for the
+  # current action. If so, it uses those, if not, it tries to guess which
+  # attributes to use through the model's "accessible_attributes"
+  #
+  # @return [BootstrapAdmin::Attribute Array] Attributes to be used on the current
+  #                                           action
+  #
+  def attributes
+    return @attributes if @attributes
+    model_klass = model_for controller
+
+    fields =  bootstrap_admin_config.send("#{params[:action]}_fields")  ||
+              bootstrap_admin_config.send("action_fields")              ||
+              model_klass.accessible_attributes.
+                reject(&:blank?).
+                map{|att| real_attribute_name att }
+
+    @attributes = fields.map do |att|
+      BootstrapAdmin::Attribute.new att,
+                                    model_klass.human_attribute_name(att),
+                                    model_klass.type_of(att)
+    end
+  end
+
+  # =============================================================================
+  # def render_attribute name, type = :index
+  #   # content_tag :td do
+  #   # if respond_to? "#{attribute.name}_index"
+  #   #   %td= send "#{attribute.name}_index", item
+  #   # else
+  #   #   %td= item.send attribute.name
+  #   # end
+  # end
+
+  private
+    # =============================================================================
+    # Translates "*_id" attribute names to association names when needed
+    # @param attribute [String] The attribute to "translate"
+    # @return [String] The attribute name translated
+    def real_attribute_name attribute
+      if attribute.match /(.+)_(?:id)(s)?$/
+        "#{$1}#{$2}".to_sym
+      else
+        attribute.to_sym
+      end
+    end
+
+end

data/app/views/admin/shared/_flash_area.html.haml

@@ -0,0 +1,6 @@
+#flash-area
+  - flash.each do |key, message|
+    .alert{:class => "alert-#{key}"}
+      = link_to (raw '×'), '#', :class => 'close'
+      = flash[key]
+.clear_both

data/app/views/admin/shared/_navigation.html.haml

@@ -0,0 +1,8 @@
+.navbar.navbar-fixed-top
+  .navbar-inner
+    .container
+      %a.brand(href="/admin")= t "app_name"
+      .container.nav-collapse
+        = bootstrap_admin_menu
+        = render 'admin/shared/login_area'
+.nav_fillup

data/app/views/defaults/_form.html.haml

@@ -0,0 +1,9 @@
+- model_instance = model_instance_for(controller)
+= simple_form_for [BootstrapAdmin.admin_namespace, model_instance] do |f|
+  = f.error_notification
+
+  = render "form_fields", :form => f
+
+  .actions
+    = yield :actions
+    = link_to :back, [BootstrapAdmin.admin_namespace, collection_name_for(controller)], :class => 'btn'

data/app/views/defaults/_form_fields.html.haml

@@ -0,0 +1,5 @@
+- attributes.each do |attribute|
+  = render_form_field form, attribute
+
+- content_for :actions do
+  = form.button :submit, :class => 'btn btn-primary'

data/app/views/defaults/_index.html.haml

@@ -0,0 +1,17 @@
+- collection = collection_for controller
+
+%table.table{:class => BootstrapAdmin.ui_styles[:index]}
+  %thead
+    %tr
+      - attributes.each do |attribute|
+        %th= attribute.human_name
+      %th= t(:actions)
+
+  %tbody
+    - collection.each do |item|
+      %tr
+        - attributes.each do |attribute|
+          %td= render_field item, attribute.to_s
+
+        %td.actions
+          = index_actions_for item

data/app/views/defaults/_paginator.html.haml

@@ -0,0 +1,6 @@
+.pagination{:style=>"float:right"}
+  %ul
+    = paginator_previous paginator
+    = paginator_pages    paginator
+    = paginator_next     paginator
+.clear

data/app/views/defaults/_search_box.html.haml

@@ -0,0 +1,7 @@
+= form_tag url_for(:controller => params[:controller]), :method => :get, :class=>"search bootstrap_admin" do
+  .input-append{:class => params[:q].blank? ? "" : "input-prepend"}
+    - unless params[:q].blank?
+      .add-on.prepend.btn.reset= image_tag "cross.gif"
+    = text_field_tag "q", params[:q], :placeholder => I18n.t("placeholder.search")
+    .add-on.append.btn.search= image_tag "search_btn.png"
+.clear

data/app/views/defaults/_show.html.haml

@@ -0,0 +1,4 @@
+- model_instance = model_instance_for controller
+
+- attributes.each do |attribute|
+  = display_field model_instance, attribute.name

data/app/views/defaults/edit.html.haml

@@ -0,0 +1,3 @@
+%h1.dotted= t('helpers.submit.edit', :model => model_for(controller).model_name.human) + " - #{model_instance_for(controller)}"
+
+= render 'form'

data/app/views/defaults/index.html.haml

@@ -0,0 +1,14 @@
+- model_klass = model_for(controller)
+- model_name  = model_name_for(controller)
+
+%h1= t :listing, :elem => model_klass.model_name.human.pluralize
+
+= render_searchbox
+= render "index"
+= render_paginator @paginator
+
+.clear_both
+
+.actions
+  - if available_actions.include? :new
+    = link_to [:new, model_klass], [:new, BootstrapAdmin.admin_namespace, model_name], :class => 'btn btn-primary'

data/app/views/defaults/new.html.haml

@@ -0,0 +1,3 @@
+%h1.dotted= t 'helpers.submit.new', :model => model_for(controller).model_name.human
+
+= render 'form'

data/app/views/defaults/show.html.haml

@@ -0,0 +1,11 @@
+- model_instance  = model_instance_for  controller
+- collection_name = collection_name_for controller
+
+%h1= t :showing, :elem => model_instance
+
+= render "show"
+
+.actions
+  - if available_actions.include? :edit
+    = link_to :edit, [:edit, BootstrapAdmin.admin_namespace, model_instance], :class => 'btn'
+  = link_to :back, [BootstrapAdmin.admin_namespace, collection_name], :class => 'btn'

data/app/views/layouts/bootstrap_admin.html.haml

@@ -0,0 +1,16 @@
+!!!
+%html
+  %head
+    %title= t :app_name
+    = stylesheet_link_tag BootstrapAdmin.admin_namespace, :media => "all"
+    = csrf_meta_tags
+    = yield :head
+  %body
+    = render "admin/shared/navigation"
+    = render "admin/shared/flash_area"
+
+    .container.content= yield
+
+    = javascript_include_tag BootstrapAdmin.admin_namespace
+    = yield :bottom
+

data/bootstrap_admin.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bootstrap_admin/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bootstrap_admin"
+  gem.version       = BootstrapAdmin::VERSION
+  gem.authors       = ["Ivo Jesus", "Bruno Coelho"]
+  gem.email         = ["ivo.jesus@gmail.com", "brunoflcoelho@gmail.com"]
+  gem.description   = %q{Create beatifull admin sections}
+  gem.summary       = %q{Small lib to create standard admin sections.}
+  gem.homepage      = "https://github.com/LynxEyes/bootstrap_admin"
+
+  gem.files         = `git ls-files`.split($/)
+  # gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency %q<rails>, [">= 3.1.0"]
+  gem.add_runtime_dependency %q<simple_form>, [">= 2.0.0"]
+  gem.add_runtime_dependency %q<haml>
+  gem.add_runtime_dependency %q<coffee-rails>
+  gem.add_runtime_dependency %q<jquery-rails>
+end

data/config/initializers/simple_form.rb

@@ -0,0 +1,34 @@
+SimpleForm.setup do |config|
+
+  config.wrappers :default,
+                  :tag         => 'div',
+                  :class       => [:clearfix ,:field_container],
+                  :hint_class  => :field_with_hint,
+                  :error_class => :error do |wrapper|
+
+    wrapper.use :label_input
+    wrapper.use :hint, :wrap_with => { :tag => :span, :class => :hint }
+    #b.use :error, :wrap_with => { :tag => :span, :class => :error }
+  end
+
+  config.wrappers :full_width,
+                  :tag         => 'div',
+                  :class       => [:clearfix ,:field_container, :full_width],
+                  :hint_class  => :field_with_hint,
+                  :error_class => :error do |wrapper|
+
+    wrapper.use :label_input
+    wrapper.use :hint, :wrap_with => { :tag => :span, :class => :hint }
+    #b.use :error, :wrap_with => { :tag => :span, :class => :error }
+  end
+
+  config.wrappers :non_persistence_fields,
+                  :tag         => :div,
+                  :class       => [:clearfix],
+                  :error_class => :error do |wrapper|
+    wrapper.use :label
+  end
+
+  SimpleForm.form_class = "form-stacked"
+  SimpleForm.browser_validations = false
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  scaffold:
+    Actions: Actions
+    Confirm: Are you sure?
+    

data/lib/bootstrap_admin/actions.rb

@@ -0,0 +1,121 @@
+module BootstrapAdmin
+
+  # This module defines default controller actions
+  # * index
+  # * show
+  # * create
+  # * update
+  # * destroy
+  # These actions are automagically injected on every controller
+  # that declares the usage of bootstrap_admin
+  module Actions
+
+    # The actual controller action methods!
+    module InstanceMethods
+
+      # =============================================================================
+      # Lists (all) items
+      def index; namespaced_response collection; end
+
+      # =============================================================================
+      # Shows a specific item
+      def show; namespaced_response instance; end
+
+      # =============================================================================
+      # Displays the form to create a new item
+      def new; namespaced_response instance; end
+
+      # =============================================================================
+      # Creates a new item
+      def create
+        instance model_class.create(params[model_name])
+        instance.save
+        namespaced_response instance
+      end
+
+      # =============================================================================
+      # Displays the form to edit an existing item
+      def edit; namespaced_response instance; end
+
+      # =============================================================================
+      # Updates the existing item
+      def update
+        instance.update_attributes params[model_name]
+        namespaced_response instance
+      end
+
+      # =============================================================================
+      # Destroys an existing item
+      def destroy
+        instance.destroy
+        namespaced_response instance
+      end
+
+      protected
+        # =============================================================================
+        # @return [String] model name based on the controller's name
+        def model_name
+          collection_name.singularize
+        end
+
+        # =============================================================================
+        # @return [ActiveRecord::Base] model class based on the controller's name
+        def model_class
+          model_name.classify.constantize
+        end
+
+        # =============================================================================
+        # @return [ActiveRecord::Base] instance
+        def instance instance_var = nil
+          if instance_var
+            instance_variable_set "@#{collection_name.singularize}", instance_var
+          else
+            unless ivar = instance_variable_get("@#{collection_name.singularize}")
+              ivar = model_class.find params[:id]
+              instance_variable_set "@#{collection_name.singularize}", ivar
+            end
+            ivar
+          end
+        end
+
+        # =============================================================================
+        # @return [ActiveRecord::Relation] collection of all items for the model
+        # named after the controller
+        def collection collection_var = nil
+          if collection_var
+            instance_variable_set "@#{collection_name}", collection_var
+          else
+            unless cvar = instance_variable_get("@#{collection_name}")
+              cvar = model_class.scoped
+              instance_variable_set "@#{collection_name}", cvar
+            end
+            cvar
+          end
+        end
+
+        # =============================================================================
+        # @return [String] collection name based on the controller name
+        def collection_name
+          self.class.name.sub("Controller", "").underscore.split('/').last
+        end
+
+      private
+        # =============================================================================
+        # Prepares a response using the controllers reponder.
+        def namespaced_response var
+          # namespace is a property of BootstrapAdmin::Config and gets called because
+          # the controller's method_missing redirects the call!
+          response_obj = [self.namespace].flatten.compact << var
+          respond_with *response_obj
+        end
+
+    end # module InstanceMethods
+
+    # =============================================================================
+    # includes InstanceMethods on the target class
+    def self.included base
+      base.send :include, InstanceMethods
+    end
+
+  end # module Actions
+end # module BootstrapAdmin