bootstrap_admin 0.0.15 → 0.0.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c48b519fd799851de6a334d3ddd7f642546d29a5
+  data.tar.gz: cb2011b030732ad0de90b95853a0060dd7bc29ad
+SHA512:
+  metadata.gz: c942b58bae975618c33212ed9b77f5df2cfde6c4249276be317159f3af18c5a9147eee4cf964b2c05465a4273cf5bb6de735276506d2ef319f06fe3e1e4e1874
+  data.tar.gz: fe1f3cad48919d74f0d865dc2262a457a1869a4632c3304d1920f4e252c31a17bc4e8a4222c9e53b2d11fd06ed13622b46bfe384c3fa4c1aaa1fdfbac329017b

data/README.md

@@ -94,7 +94,45 @@ And BAM, ready to roll!!
 
 ## Configuring Bootstrap Admin - Initializer
 
-TODO
+This is were you can configure the global options for bootstrap admin.
+
+For now there are only a few options:
+
+* `admin_namespace` - a String defining the name of the namespace to be used
+* `paginator_page_size`- an Integer defining the page size for all bootstrap_admin index actions
+* `ui_styles` - an Hash that defines CSS classes to be used on certain elements
+
+For now `ui_styles` should contain an hash with more or less the following structure:
+```ruby
+config.ui_styles = {
+  index: %w(table-bordered table-striped)
+}
+```
+The index ui_styles will be used on the index table.
+On future releases, this hash will be extended and taken into account for other situations.
+
+### Example of a Bootstrap Admin Initializer
+
+```ruby
+BootstrapAdmin.setup do |config|
+
+  # ==> Admin namespace configuration
+  # Configure namespace used for the scope of this admin
+  # Default value: :admin
+  config.admin_namespace = "backoffice"
+
+  # ==> Paginator configuration
+  # Configure the number of results shown per page by the paginator.
+  # Default value: 10
+  config.paginator_page_size = 6
+
+  # ==> 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
+```
 
 ## Admin Menu
 
@@ -103,51 +141,65 @@ If you want to customize the bootstrap_admin menu, you can edit the `config/boot
 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.
+* `: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
+  * By default (when not supplied), the label will be the `:item` human name.
+* `:namespace` - if your model (`:item`) is under a namespace, then you should declare it on this option
+* `:class` - the css class to apply to the item
+* `:url` - the url to be used on the item link.
+* `:controller` - the controller to be used on the item link.
 
 ### 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
+```yaml
+# Item based on a model
+- :item: Document
+
+# Item based on a model, with non-default controller
+- :item: NewsArticle
+  :controller: admin/news
+
+# Item based on a namespaced model (Blog::Entry)
+- :item: Entry
+  :namespace: Blog
+
+# 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.
+If you want to override this behavior, 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:
+To override the default behavior, 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..)
+* `action_fields` - the fields to be used on all actions. This will only be used when the specific action fields aren't defined.
 * `searchable_fields` - the fields to be used while searching
 
 To use these configurators, you pass a block to the bootstrap\_admin macro like so:
@@ -161,6 +213,28 @@ bootstrap_admin do |config|
 end
 ```
 
+### Configuring the action links available
+
+Imagine that for some reason you don't have the need to create new records on a given scaffold. Then, there really shouldn't be a button/link to the new record form...
+In order to configure which action links should be shown on a given scaffold, you can use the `available_actions` configurator:
+
+```ruby
+bootstrap_admin do |config|
+  config.available_actions = [:show, :new]
+end
+```
+
+With this setting, then your scaffold would only show the link to show on each record and the link to the new record form.
+
+By default the available_actions are:
+
+* `:new` - collection-wise link to the new record form
+* `:show` - member-wise link to show the record
+* `:edit` - member-wise link to the edit record form
+* `:destroy` - member-wise link to destroy the record
+
+No other actions will be taken into account.
+
 ### 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:
@@ -171,6 +245,18 @@ bootstrap_admin do |config|
 end
 ```
 
+### Configuring which model to use
+
+Sometimes you need a controller to handle a model that has a completely different name from the controller. On those cases, bootstrap\_admin allows you to configure the name of the model to use:
+
+```ruby
+class NewsController < AdminController
+  bootstrap_admin do |config|
+    config.model_name = "NewsArticle"
+  end
+end
+```
+
 ## Configuring the Routes
 
 TODO
@@ -203,7 +289,7 @@ def title record
 end
 ```
 
-If, on the other hand you need to use diferent code to display diferent actions, then your helper must:
+If, on the other hand you need to use different code to display different actions, then your helper must:
 
 * Be named `<action>_<field>`
 * Accept one argument - the model instance we are displaying
@@ -220,10 +306,12 @@ end
 
 #### Overriding field on `form` actions (`new`, `edit`, etc..)
 
-To override the field usage on a form action, your helper must:
+This is similar to the overriding done for the `show` and/or `index` actions.
+
+If all your form actions (`new`, `edit`, etc..) can use the same code, then your helper must:
 
 * Be named `form_<field>`
-* Accept one argument - the form for the model instance
+* Accept one argument - the form builder for the model
 
 ```ruby
 def form_title form
@@ -232,6 +320,16 @@ end
 ```
 You can use `form.object` to get the object to which the form is for.
 
+But if you need to use different code on each action, then you can build helpers that must:
+
+* Be named `<action>_form_<field>`
+* Accept one argument - the form builder for the model
+
+```ruby
+def new_form_title form
+  form.input(:title)
+end
+```
 
 ### Overriding the views
 

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

@@ -98,6 +98,7 @@ input[type="color"],
 
 .pagination {
   margin: 0;
+  float: right;
 }
 
 .pagination ul > li > a,

data/app/helpers/bootstrap_admin/menu_helper.rb

@@ -32,7 +32,7 @@ module BootstrapAdmin::MenuHelper
       "- :item: #{ename}"
     end.join("\n")
 
-    @bootstrap_admin_menu_items = YAML.load(yml_menu)
+    @bootstrap_admin_menu_items = YAML.load(yml_menu) || []
   end
 
   # =============================================================================

data/app/helpers/bootstrap_admin_helper.rb

@@ -134,8 +134,8 @@ module BootstrapAdminHelper
     defaults = {:controller => params[:controller]}.merge options
 
     ctrl_namespace = defaults[:controller].split("/").first
-    # Fix for engines with shared namespace for some reason main_app.url_for doesn't find the route without this "/" 
-    # It consider the route inside of engine instead of main app. 
+    # Fix for engines with shared namespace for some reason main_app.url_for doesn't find the route without this "/"
+    # It consider the route inside of engine instead of main app.
     defaults[:controller] = "/#{defaults[:controller]}"
 
     if instance_eval "defined? #{ctrl_namespace}"
@@ -171,7 +171,7 @@ module BootstrapAdminHelper
   end
 
   # =====
-  def index_default_actions 
+  def index_default_actions
     if available_actions.include? :new
       model_klass = model_for controller
       link_to([:new, model_klass], bootstrap_url_for(:action => :new), :class => 'btn btn-primary').html_safe
@@ -243,7 +243,11 @@ module BootstrapAdminHelper
               bootstrap_admin_config.send("action_fields")              ||
               model_klass.accessible_attributes.
                 reject(&:blank?).
-                map{|att| real_attribute_name att }
+                map{|att| real_attribute_name att }.
+                reject do |att| 
+                  att.to_s =~ /(.+)_attributes/ && 
+                  model_klass.reflect_on_all_associations.map(&:name).include?($1.to_sym)
+                end
 
     @attributes = fields.map do |att|
       BootstrapAdmin::Attribute.new att,
@@ -252,6 +256,20 @@ module BootstrapAdminHelper
     end
   end
 
+  # =============================================================================
+  # Tries to render the action/partial "namespaced" with the current action name
+  # if it fails, then simply calls render with whatever args that got passed in.
+  #
+  # Ex:
+  #  # on get to '/admin/some_resource/new'
+  #  render_with_fallback 'form' # this will to render 'new_form', if it fails,
+  #                              # then it will just call "render 'form'"
+  def render_with_fallback *args
+    render "#{params[:action]}_#{args.first}", *args[1..-1]
+  rescue ActionView::MissingTemplate
+    render *args
+  end
+
   # =============================================================================
   # def render_attribute name, type = :index
   #   # content_tag :td do

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

@@ -2,7 +2,7 @@
 = simple_form_for *bootstrap_form_url(model_instance) do |f|
   = f.error_notification
 
-  = render "form_fields", :form => f
+  = render_with_fallback "form_fields", :form => f
 
   .actions
     = yield :actions

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

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

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

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

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

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

data/bootstrap_admin.gemspec

@@ -17,9 +17,10 @@ Gem::Specification.new do |gem|
   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<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>
+  gem.add_runtime_dependency %q<responders>
 end

data/config/initializers/simple_form.rb

@@ -29,6 +29,6 @@ SimpleForm.setup do |config|
     wrapper.use :label
   end
 
-  SimpleForm.form_class = "form-stacked"
+  SimpleForm.default_form_class = "form-stacked"
   SimpleForm.browser_validations = false
 end

data/lib/bootstrap_admin/controller_helpers.rb

@@ -39,9 +39,12 @@ module BootstrapAdmin
       private
         # =============================================================================
         def add_bootstrap_admin_viewpath
+          view_matcher_format = ":action{.:locale,}{.:formats,}{.:handlers,}"
+          bootstrap_admin_app_viewpath = "#{Rails.root}/app/views/#{BootstrapAdmin.admin_namespace}/defaults"
           bootstrap_admin_viewpath = File.expand_path("../../../app/views/defaults", __FILE__)
-          self.view_paths << ActionView::FileSystemResolver.new(
-              bootstrap_admin_viewpath, ":action{.:locale,}{.:formats,}{.:handlers,}")
+
+          self.view_paths << ActionView::FileSystemResolver.new(bootstrap_admin_app_viewpath, view_matcher_format)
+          self.view_paths << ActionView::FileSystemResolver.new(bootstrap_admin_viewpath, view_matcher_format)
         end
 
     end # module ClassMethods

data/lib/bootstrap_admin/version.rb

@@ -1,3 +1,3 @@
 module BootstrapAdmin
-  VERSION = "0.0.15"
+  VERSION = "0.0.17"
 end

data/lib/bootstrap_admin.rb

@@ -22,6 +22,13 @@ module BootstrapAdmin
   class BootstrapAdminEngine < Rails::Engine
     config.autoload_paths << File.expand_path("../../app/helpers", __FILE__)
   end
+
+  # =============================================================================
+  # Returns the gem root dir
+  def self.root_dir
+    File.expand_path("../..", __FILE__)
+  end
+
   # =============================================================================
   # Defines the namespace where all the "bootstrap_admin" magic happens
   mattr_accessor :admin_namespace

data/lib/generators/bootstrap_admin/{install_generator.rb → install/install_generator.rb}

@@ -17,6 +17,11 @@ module BootstrapAdmin
         copy_file "en_bootstrap_admin.yml", "config/locales/en_bootstrap_admin.yml"
       end
 
+      def append_to_assets
+        append_file "config/initializers/assets.rb",
+                    "Rails.application.config.assets.precompile += %w( admin.css admin.js )"
+      end
+
       def asset_configuration
         empty_directory "app/assets/javascripts/#{namespace_parsed}"
         create_file "app/assets/javascripts/#{namespace_parsed}.js" do

data/lib/generators/bootstrap_admin/override_views/USAGE

@@ -0,0 +1,24 @@
+Description:
+  Allows you to override the default views for all bootstrap_admin actions, either globally or resource specific.
+  If you choose to override globally, then all views for all resources will be overridden.
+  If you choose to override for a specific resource, then your overrides will only affect that resources' views.
+
+Example:
+  $ rails g bootstrap_admin:override_views defaults
+    This will:
+      1) Create app/views/admin/defaults folder
+      2) Copy all of bootstrap_admin default views to that folder for you to tweak
+    From there on, all resources will use these views.
+
+  $ rails g bootstrap_admin:override_views defaults index new
+    This will:
+      1) Create app/views/admin/defaults folder
+      2) Copy all index and new related views to that folder for you to tweak
+    From there on, all resources will use these views to render index or new actions.
+
+  $ rails g bootstrap_admin:override_views books
+    This will:
+      1) Create app/views/admin/books folder (if it doesn't exist already)
+      2) Copy all of bootstrap_admin default views to that folder for you to tweak
+    From there on, only book resources will use these views.
+

data/lib/generators/bootstrap_admin/override_views/override_views_generator.rb

@@ -0,0 +1,61 @@
+module BootstrapAdmin
+  module Generators
+    class OverrideViewsGenerator < Rails::Generators::Base
+      # =============================================================================
+      argument :resource, :type     => :string,
+                          :default  => "defaults",
+                          :banner   => "defaults or <resource>"
+
+      # =============================================================================
+      argument :actions,  :type     => :array,
+                          :optional => true,
+                          :banner   => "index show edit ...",
+                          :default  => %w(index show new edit)
+
+      # =============================================================================
+      class_option :namespace,  :type    => :string,
+                                :default => "admin",
+                                :desc    => "Namespace used by the bootstrap_admin"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # =============================================================================
+      def copy_views
+        folder_base = "#{Rails.root}/app/views/#{BootstrapAdmin.admin_namespace}"
+        target_dir = if "defaults" == resource
+                       "#{folder_base}/defaults" # global view folder
+                     else
+                       "#{folder_base}/#{resource.tableize}" # resource view folder
+                     end
+
+        empty_directory target_dir
+        _copy_views_ target_dir, actions
+      end
+
+      # =============================================================================
+      protected
+        VIEW_DEPENDENCIES = {
+          "index"        => ['index', '_index', '_paginator', '_search_box'],
+          "show"         => ['show' , '_show'],
+          "new"          => ['new'  , ['_form', '_new_form'] , ['_form_fields', '_new_form_fields' ]],
+          "edit"         => ['edit' , ['_form', '_edit_form'], ['_form_fields', '_edit_form_fields']],
+          "new_and_edit" => ['new'  , 'edit', '_form', '_form_fields']
+        }
+
+        def _copy_views_ target_dir, actions
+          if actions & %w[new edit] == %w[new edit]
+            actions = actions - %w[new edit] + %w[new_and_edit]
+          end
+
+          actions.each do |action|
+            VIEW_DEPENDENCIES[action].each do |view_name, rename_to|
+              view   = "#{BootstrapAdmin.root_dir}/app/views/defaults/#{view_name}.html.haml"
+              target = "#{target_dir}/#{rename_to || view_name}.html.haml"
+              copy_file view, target
+            end
+          end
+        end
+
+    end # class OverrideViewsGenerator
+  end # module Generators
+end # module BootstrapAdmin