bootstrap_admin 0.0.8

data/lib/bootstrap_admin/active_record_extensions.rb

@@ -0,0 +1,17 @@
+# -----------------------------------------------------------------------------
+# => TODO: This looks like a monkeypatch.. make this "the right way"..
+ActiveRecord::Base.class_eval do
+  def self.type_of name
+    name = name.to_sym
+    associations = self.reflect_on_all_associations.map(&:name)
+    if name.match(/(.*)_id(s)?$/) and associations.include? "#{$1}#{$2}"
+      :association
+    elsif associations.include? name
+      :association
+    elsif self.attribute_names.include? name.to_s
+      :attribute
+    else
+      :none
+    end
+  end
+end

data/lib/bootstrap_admin/attribute.rb

@@ -0,0 +1,34 @@
+module BootstrapAdmin
+
+  # BootstrapAdmin::Attribute represents a model attribute and stores
+  # its name, human_name and a computed "type" which can be one of:
+  #  :association
+  #  :attribute
+  #  :none
+  # (take a look at active_record_extensions).
+  #
+  # This is used to build UI elements, see:
+  #   app/views/defaults/show
+  #   app/views/defaults/form
+  #   app/views/defaults/index
+
+  class Attribute
+    attr_reader :name, :human_name, :type
+
+    def initialize name, human_name, type
+      @name, @human_name, @type = name, human_name, type
+    end
+
+    # @return [String] the attribute's name
+    def to_s; name.to_s; end
+
+    # @return [Symbol] the attribute's name, but as a Symbol
+    def to_sym; to_s.to_sym; end
+
+    # @return [true, false] true if type is :association, false otherwise
+    def association?; :association == type; end
+
+    # @return [true, false] true if type is :attribute, false otherwise
+    def attribute?; :attribute == type; end
+  end
+end

data/lib/bootstrap_admin/controller_config.rb

@@ -0,0 +1,57 @@
+module BootstrapAdmin
+  # Defines each controllers specific configuration
+  class ControllerConfig
+    DEFAULTS = {
+      :responder_formats => [:html, :json]
+    }
+
+    # controller's namespace
+    attr_accessor :namespace
+
+    # Responded formats
+    attr_accessor :responder_formats
+
+    # Fields to be used on the index action
+    attr_accessor :index_fields
+
+    # Fields to be used on the show action
+    attr_accessor :show_fields
+
+    # Fields to be used on form (edit/new/create/update) actions
+    attr_accessor :form_fields
+    alias_method :edit_fields,   :form_fields
+    alias_method :new_fields,    :form_fields
+    alias_method :create_fields, :form_fields
+    alias_method :update_fields, :form_fields
+
+    # Fields to be used on ALL actions
+    # These are used when none of the {action}_fields are defined
+    attr_accessor :action_fields
+
+    # Searchable fields
+    attr_accessor :searchable_fields
+
+    # Available Actions
+    attr_accessor :available_actions
+
+    # =============================================================================
+    def initialize options = {}
+      options      = DEFAULTS.merge options
+
+      # namespace
+      @namespace = options[:namespace] || BootstrapAdmin.admin_namespace
+
+      # responder responder_formats
+      @responder_formats = options[:responder_formats]
+
+      # fields to be shown @ index
+      # @index_fields = options[:index_fields]
+
+      # fields to be shown @ show
+      # @show_fields = options[:show_fields]
+
+      @available_actions = [:new, :show, :edit, :destroy]
+    end
+    # =============================================================================
+  end
+end

data/lib/bootstrap_admin/controller_helpers.rb

@@ -0,0 +1,78 @@
+module BootstrapAdmin
+  module ControllerHelpers
+    # =============================================================================
+    module ClassMethods
+      # Controller Macro to define and configure bootstrap_admin
+      #
+      # When you run this macro on a controller, it:
+      #   * sets BootstrapAdmin::Responder as the controller's responder
+      #   * includes BootstrapAdmin::Actions, defining the controller's default actions
+      #   * adds helpers (bootstrap_admin, bootstrap_admin/paginator and bootstrap_admin/menu)
+      #   * adds the bootstrap_admin default views to the viewpath
+      #
+      # == Parameters
+      # +block+:: an optional code block that will receive an instance of BootstrapAdmin::ControllerConfig
+      #           to configure controller specific stuff, such as index_fields, etc..
+      def bootstrap_admin &block
+        @bootstrap_admin_config = BootstrapAdmin::ControllerConfig.new # config
+        if block_given?
+          block.call @bootstrap_admin_config
+        end
+
+        self.respond_to *@bootstrap_admin_config.responder_formats
+        self.responder = BootstrapAdmin::Responder
+        # setup bootstrap_admin viewpath
+        add_bootstrap_admin_viewpath
+
+        # add bootstrap_admin helpers
+        helper "bootstrap_admin"
+        helper "bootstrap_admin/paginator"
+        helper "bootstrap_admin/menu"
+
+        layout "bootstrap_admin"
+
+        # add bootstrap_admin actions
+        self.send :include, BootstrapAdmin::Actions
+        helper_method :bootstrap_admin_config
+      end
+
+      private
+        # =============================================================================
+        def add_bootstrap_admin_viewpath
+          bootstrap_admin_viewpath = File.expand_path("../../../app/views/defaults", __FILE__)
+          self.view_paths << ActionView::FileSystemResolver.new(
+              bootstrap_admin_viewpath, ":action{.:locale,}{.:formats,}{.:handlers,}")
+        end
+
+    end # module ClassMethods
+
+    # =============================================================================
+    # Helper method - provides access to the controller config on the views
+    def bootstrap_admin_config
+      self.class.instance_variable_get "@bootstrap_admin_config"
+    end
+
+    # =============================================================================
+    # Eases the access to config properties via bootstrap_admin_config
+    def method_missing method, *args
+      if bootstrap_admin_config.respond_to? method
+        bootstrap_admin_config.send method, *args
+      else
+        super method, *args
+      end
+    end
+
+    # self responds_to bootstrap_admin_config methods via method_missing!
+    def respond_to? method, include_private = false
+      true if bootstrap_admin_config.respond_to? method
+      super method, include_private
+    end
+
+    # =============================================================================
+    def self.included base
+      base.extend ClassMethods
+    end
+  end
+end
+
+ActionController::Base.class_eval { include BootstrapAdmin::ControllerHelpers }

data/lib/bootstrap_admin/responder.rb

@@ -0,0 +1,157 @@
+module BootstrapAdmin
+  class Responder < ActionController::Responder
+    # =============================================================================
+    # Responds to any format...
+    def to_format
+      render @format        => format_resource(@resource, @format),
+             :status        => status_for_resource(@resource),
+             :content_type  => content_type_for(@format)
+    end
+
+    # =============================================================================
+    # Responds to HTML format
+    #
+    # It sets flash messages, handles search, sets pagination (@paginator)
+    def to_html
+      if get? && resource.is_a?(ActiveRecord::Relation)
+        items = process_search resource
+        items, paginator = paginate items
+
+        controller.instance_variable_set("@#{controller.controller_name}", items)
+        controller.instance_variable_set("@paginator", paginator)
+        if request.xhr?
+          render controller.params[:action], layout: false
+        end
+      elsif resource.is_a?(ActiveRecord::Base) && (post? || put?) && resource.valid?
+        message = if post?
+                    'helpers.messages.create.success'
+                  else #put?
+                    'helpers.messages.update.success'
+                  end
+        controller.flash[:success] = I18n.t(message, :model => resource.class.model_name.human)
+        redirect_to @resources
+
+      else
+        if delete?
+          controller.flash[:success] = I18n.t("helpers.messages.destroy.success", :model => resource.class.model_name.human)
+        end
+        super
+      end
+    end
+
+    private
+      # =============================================================================
+      def paginate resource
+        current_page = (controller.params[:page] || 1).to_i
+        per_page     = (controller.params[:pp]   || BootstrapAdmin.paginator_page_size).to_i
+        count        = resource_count(resource)
+        pages        = (count.to_f/per_page).ceil
+        paginator = {
+          :current_page => current_page,
+          :count        => count,
+          :pages        => pages > 0 ? pages : 1
+        }
+        items = resource.offset( (current_page-1)*per_page ).limit(per_page)
+
+        return items, paginator
+      end
+
+      # =============================================================================
+      def resource_count resource
+        values = resource.includes_values
+        to_remove = resource.reflect_on_all_associations.select{|a| a.options[:polymorphic]}.map &:name
+        resource.includes_values -= to_remove
+        count = resource.count
+        resource.includes_values = values
+
+        return count
+      end
+
+      # =============================================================================
+      def process_search resource
+        result = resource
+        fields = search_fields resource
+
+        if controller.params[:q] and !fields.blank?
+          conditions = fields.map do |field|
+            if field.is_a? Symbol or field.is_a? String
+              "#{resource.table_name}.#{field} like ?"
+
+            elsif field.is_a? Hash
+              resource, sconds = process_search_hash(resource, field)
+              sconds
+            end
+          end.flatten.compact
+
+          params = ["%#{controller.params[:q]}%"] * conditions.count
+          result = resource.where(conditions.join(" OR "), *params)
+        end
+
+        result
+      end
+
+      # =============================================================================
+      def search_fields resource
+        if controller.searchable_fields.blank?
+          accessible  = resource.accessible_attributes.reject &:blank?
+          text_fields = resource.columns.
+                                 select{|c| [:string, :text].include? c.type}.
+                                 map(&:name)
+          text_fields & accessible
+        else
+          controller.searchable_fields
+        end
+      end
+
+      # =============================================================================
+      def process_search_hash resource, hash
+        conditions = hash.keys.map do |key|
+          assoc = resource.reflect_on_association(key)
+          if assoc.options[:polymorphic]
+            next
+          else
+            resource = resource.joins <<-SQL
+              LEFT JOIN #{assoc.table_name}
+                on (#{resource.table_name}.#{assoc.foreign_key} = #{assoc.klass.table_name}.#{assoc.klass.primary_key})
+            SQL
+            if hash[key].is_a? Symbol or hash[key].is_a? String
+              "#{assoc.table_name}.#{hash[key]} like ?"
+
+            elsif hash[key].is_a? Array
+              hash[key].map{|col| "#{assoc.table_name}.#{col} like ?" }
+
+            elsif hash[key].is_a? Hash
+              process_search_hash(resource, hash[key])
+
+            end
+          end
+        end
+        return resource, conditions
+      end
+
+      # =============================================================================
+      def content_type_for format
+        "application/#{format}"
+      end
+
+      # =============================================================================
+      def format_resource resource, format
+        if resource.is_a?(ActiveRecord::Base) and not resource.valid?
+          resource.errors.send "to_#{format}"
+        else
+          resource.send "to_#{format}"
+        end
+      end
+
+      # =============================================================================
+      def status_for_resource(resource)
+        if resource.is_a?(ActiveRecord::Base) and not resource.valid?
+          403
+        else
+          200
+        end
+      end
+
+  end # class Responder
+end # module BootstrapAdmin
+

data/lib/bootstrap_admin/routes.rb

@@ -0,0 +1,28 @@
+module ActionDispatch::Routing
+  class Mapper
+    # =============================================================================
+    # Defines the routes to the bootstrap_admin controllers of your app and also
+    # defines a "admin root" route based on the bootstrap_admin namespace
+    #
+    # == Parameters
+    # +options+:: regular route options for the "admin root"
+    # +block+:: A block configuring namespaced routes, just like a regular
+    #           namespace route block
+    def bootstrap_admin options = {}, &block
+      admin_namespace = options.delete(:namespace) || BootstrapAdmin.admin_namespace
+      BootstrapAdmin.admin_namespace = admin_namespace
+
+      root_options = BootstrapAdmin.admin_root_options.
+                      merge({:to => admin_namespace.to_s}).
+                      merge(options)
+      resource admin_namespace, root_options
+
+      if block_given?
+        namespace admin_namespace do
+          block.call
+        end
+      end
+    end # bootstrap_admin
+
+  end # class Mapper
+end # module ActionDispatch::Routing

data/lib/bootstrap_admin/version.rb

@@ -0,0 +1,3 @@
+module BootstrapAdmin
+  VERSION = "0.0.8"
+end

data/lib/bootstrap_admin.rb

@@ -0,0 +1,58 @@
+# -----------------------------------------------------------------------------
+require 'rails'
+require 'haml'
+require 'simple_form'
+# -----------------------------------------------------------------------------
+require 'active_support/dependencies'
+# -----------------------------------------------------------------------------
+require 'bootstrap_admin/actions'
+require 'bootstrap_admin/active_record_extensions'
+require 'bootstrap_admin/attribute'
+require 'bootstrap_admin/version'
+require 'bootstrap_admin/responder'
+require 'bootstrap_admin/controller_config'
+require 'bootstrap_admin/controller_helpers'
+require 'bootstrap_admin/routes'
+# -----------------------------------------------------------------------------
+require File.expand_path("../../config/initializers/simple_form.rb", __FILE__)
+# -----------------------------------------------------------------------------
+
+# Bootstrap admin eases the tedious task of building admin interfaces
+module BootstrapAdmin
+  class BootstrapAdminEngine < Rails::Engine
+    config.autoload_paths << File.expand_path("../../app/helpers", __FILE__)
+  end
+  # =============================================================================
+  # Defines the namespace where all the "bootstrap_admin" magic happens
+  mattr_accessor :admin_namespace
+  @@admin_namespace = :admin
+
+  # =============================================================================
+  # mattr_accessor :admin_root_url
+  # @@admin_root_url = nil
+
+  # =============================================================================
+  # Defines the route options for the "admin root"
+  mattr_accessor :admin_root_options
+  @@admin_root_options = {:only => :show}
+
+  # =============================================================================
+  # Defines de number of items per page
+  mattr_accessor :paginator_page_size
+  @@paginator_page_size = 10
+
+  # =============================================================================
+  #
+  mattr_accessor :ui_styles
+  @@ui_styles = {
+    index: %w(table-bordered table-striped)
+  }
+  # =============================================================================
+  # Setup BootstrapAdmin
+  # Run rails generate bootstrap_admin:install
+  # to create a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+
+end

data/lib/generators/bootstrap_admin/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Copies bootstrap_admin's initializer, menu config file to your application.
+    Generates javascript and css structure needed to use and enhance bootstrap_admin's assets.
+
+Example:
+    1) rails g bootstrap_admin:install
+
+       This will:
+         1) Create config/initializers/bootstrap_admin.rb with bootstrap_admin's configurations
+         2) Create config/bootstrap_admin_menu.yml with bootstrap_admin's menu configurations
+         3) Creates manifest files with directives to use bootstrap_admin's assets
+            and complement them with host app's assets
+            - admin.js
+            - admin.css
+
+    2) rails g bootstrap_admin:install --namespace=MyAdmin
+
+       This will:
+         1) Create config/initializers/bootstrap_admin.rb with bootstrap_admin's configurations
+         2) Create config/bootstrap_admin_menu.yml with bootstrap_admin's menu configurations
+         3) Creates manifest files with directives to use bootstrap_admin's assets
+            and complement them with host app's assets
+            - my_admin.js
+            - my_admin.css

data/lib/generators/bootstrap_admin/install_generator.rb

@@ -0,0 +1,67 @@
+module BootstrapAdmin
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :namespace, :type => :string, :default => "admin", :desc => "Namespace used by the bootstrap_admin"
+
+      def copy_initializer
+        template "bootstrap_admin.rb", "config/initializers/bootstrap_admin.rb"
+      end
+
+      def copy_bootstrap_admin_menu
+        copy_file "bootstrap_admin_menu.yml", "config/bootstrap_admin_menu.yml"
+      end
+
+      def copy_locale_file
+        copy_file "en_bootstrap_admin.yml", "config/locales/en_bootstrap_admin.yml"
+      end
+
+      def asset_configuration
+        empty_directory "app/assets/javascripts/#{namespace_parsed}"
+        create_file "app/assets/javascripts/#{namespace_parsed}.js" do
+          <<-JS_INFO.strip_heredoc
+            // Loads all bootstrap_admin javascripts
+            //= require bootstrap_admin
+            //= require_tree ./#{namespace_parsed}
+          JS_INFO
+        end
+
+        empty_directory "app/assets/stylesheets/#{namespace_parsed}"
+        create_file "app/assets/stylesheets/#{namespace_parsed}.css" do
+          <<-CSS_INFO.strip_heredoc
+            /*
+             *= require bootstrap_admin.css
+             *= require_self
+             *= require_tree ./#{namespace_parsed}
+             */
+          CSS_INFO
+        end
+      end
+
+      def create_admin_controller
+        create_file "app/controllers/#{namespace_parsed}_controller.rb" do
+          <<-RUBY.strip_heredoc
+            class #{options.namespace.classify}Controller < ApplicationController
+              layout "bootstrap_admin"
+              helper "bootstrap_admin/menu"
+            end
+          RUBY
+        end
+
+        create_file "app/views/#{namespace_parsed}/show.html.haml" do
+          <<-HAML.strip_heredoc
+            %p Hello!
+            %p Find me @ app/views/#{namespace_parsed}/show.html.haml
+          HAML
+        end
+      end
+
+      private
+
+      def namespace_parsed
+        options.namespace.underscore
+      end
+    end
+  end
+end

data/lib/generators/bootstrap_admin/templates/bootstrap_admin.rb

@@ -0,0 +1,18 @@
+BootstrapAdmin.setup do |config|
+
+  # ==> Admin namespace configuration
+  # Configure namespace used for the scope of this admin
+  # Default value: :admin
+  config.admin_namespace = "<%= namespace_parsed %>"
+
+  # ==> Paginator configuration
+  # Configure the number of results shown per page by the paginator.
+  # Default value: 10
+  # config.paginator_page_size = 10
+
+  # ==> UI Styles
+  # Configure the css class names that each action wrapper will have
+  # Default value: {index: %w(table-bordered table-striped)}
+  # config.ui_styles[:index] << "my_awesome_style_class"
+
+end

data/lib/generators/bootstrap_admin/templates/bootstrap_admin_menu.yml

@@ -0,0 +1,37 @@
+# This is where you can define the bootstrap admin menu.
+# Menus can only have 2 levels (root level and secondary level [for dropdown menu entries]).
+# You must supply a list of menu entries.
+# To do that, you can use this set of options
+# :label - the label that will be presented in the menu
+# :class - the css class to apply to the item
+# :url   - the url to be used on the item link.
+# :item  - one of 3 things: a String, an Array or a Symbol
+#          * String: must be a name of a model. The supplied model will be used to build
+#                    the link url, as well as the label if not supplied
+#          * Array:  This will indicate 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. In this case, both :label and :url will be ignored
+#
+#
+# Examples:
+# * Simple menu item based on a known model
+# - :item: Document
+#
+# * Simple menu item based on a model with a custom label and a custom css class
+# - :item: Author
+#   :label: The guys who done things
+#   :class: really_bold
+#
+# * Simple menu 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 Administration"
+#   :url: "#"
+#   :item:
+#   - :item:  Role
+#   - :item:  :divider
+#   - :item:  User
+#     :label: Dudes

data/lib/generators/bootstrap_admin/templates/en_bootstrap_admin.yml

@@ -0,0 +1,37 @@
+en:
+  listing: "Listing %{elem}"
+  showing: "Showing %{elem}"
+  back: Back
+  new: New
+  update: Update
+  show: View
+  edit: Edit
+  destroy: Remove
+  previous: Previous
+  next: Next
+  actions: Actions
+  app_name: "!APP NAME!"
+  confirm: Are you sure?
+
+  placeholder:
+    search: Search...
+    date: Date...
+
+  helpers:
+    messages:
+      create:
+        success: "%{model} created successfully!"
+      update:
+        success: "%{model} updated successfully!"
+      destroy:
+        success: "%{model} removed successfully!"
+
+    select:
+      prompt: "Select an option"
+
+    submit:
+      new: 'New %{model}'
+      edit: 'Edit %{model}'
+      create: 'Create %{model}'
+      update: 'Update %{model}'
+      submit: 'Save %{model}'