activeadmin 0.6.0 → 0.6.1

data/docs/13-authorization-adapter.md

@@ -1,13 +1,13 @@
 # Authorization Adapter
 
-Active Admin offers the ability to define and use your own authorization 
-adapter. If implemented, the '#authorized?' will be called when an action is 
+Active Admin offers the ability to define and use your own authorization
+adapter. If implemented, the '#authorized?' will be called when an action is
 taken. By default, '#authorized?' returns true.
 
 
 ## Setting up your own AuthorizationAdapter
 
-Setting up your own `AuthorizationAdapter` is easy! The following example shows 
+Setting up your own `AuthorizationAdapter` is easy! The following example shows
 how to set up and tie your authorization adapter class to Active Admin:
 
     # app/models/only_authors_authorization.rb
@@ -15,7 +15,7 @@ how to set up and tie your authorization adapter class to Active Admin:
 
         def authorized?(action, subject = nil)
           case subject
-          when normalize(Post)
+          when normalized(Post)
 
             # Only let the author update and delete posts
             if action == :update || action == :destroy
@@ -33,7 +33,7 @@ how to set up and tie your authorization adapter class to Active Admin:
 
     end
 
-In order to hook up `OnlyAuthorsAuthorization` to Active Admin, go to your 
+In order to hook up `OnlyAuthorsAuthorization` to Active Admin, go to your
 application's `config/initializers/active_admin.rb` and add/modify the line:
 
     config.authorization_adapter = "OnlyAuthorsAuthorization"
@@ -55,7 +55,7 @@ Now, whenever a controller action is performed, the `OnlyAuthorsAuthorization`'s
 
 ## Getting Access to the Current User
 
-From within your authorization adapter, you can call the `#user` method to 
+From within your authorization adapter, you can call the `#user` method to
 retrieve the current user.
 
     class OnlyAdmins < ActiveAdmin::AuthorizationAdapter
@@ -69,8 +69,8 @@ retrieve the current user.
 
 ## Scoping Collections in Authorization Adapters
 
-`ActiveAdmin::AuthorizationAdapter` also provides a hook method (`#scope_collection`) 
-for the adapter to scope the resource's collection. For example, you may want to 
+`ActiveAdmin::AuthorizationAdapter` also provides a hook method (`#scope_collection`)
+for the adapter to scope the resource's collection. For example, you may want to
 centralize the scoping:
 
     class OnlyMyAccount < ActiveAdmin::AuthorizationAdapter
@@ -112,7 +112,7 @@ subject will be an instance of `ActiveAdmin::Page`.
 
 ## Action Types
 
-By default Active Admin simplifies the controller actions into 4 actions: 
+By default Active Admin simplifies the controller actions into 4 actions:
 
   * `:read` - This controls if the user can view the menu item as well as the
     index and show screens.
@@ -181,6 +181,27 @@ To use the CanCan adapter, simply update the configuration in the Active Admin
 initializer:
 
     config.authorization_adapter = ActiveAdmin::CanCanAdapter
+    
+You can also specify a method to be called on unauthorized access. This is necessary
+in order to prevent a redirect loop that can happen if a user tries to access a page
+they don't have permissions for (see [#2081](https://github.com/gregbell/active_admin/issues/2081)).
+```ruby
+config.on_unauthorized_access = :access_denied
+```    
+The method `access_denied` would be defined in `application_controller.rb`. Here is one
+example that redirects the user from the page they don't have permission to
+access to a resource they have permission to access (organizations in this case), and
+also displays the error message in the browser:
+
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  
+  def access_denied(exception)
+    redirect_to admin_organizations_path, :alert => exception.message
+  end
+end
+```
 
 By default this will use the ability class named "Ability". This can also be
 changed from the initializer:
@@ -194,7 +215,7 @@ will use it for authorization:
     class Ability
       include CanCan::Ability
 
-      def intialize(user)
+      def initialize(user)
         can :manage, Post
         can :read, User
         can :manage, User, :id => user.id

data/docs/2-resource-customization.md

@@ -158,6 +158,21 @@ has_many relationships, you can simply scope the listings and finders like so:
 
 That approach limits the posts an admin can access to ```current_user.posts```.
 
+If you want to conditionally apply the scope, then there are options for that as well:
+
+    ActiveAdmin.register Post do
+      # Only scope the query if there is a user to scope to, helper provided via Devise
+      scope_to :current_user, :if => proc{ admin_user_signed_in? }
+
+      # Don't scope the query if the user is an admin
+      scope_to :current_user, :unless => proc{ current_admin_user.admin? }
+
+      # Get fancy and can combine with block syntax
+      scope_to :if => proc{ admin_user_signed_in? } do
+        User.most_popular
+      end
+    end
+
 If you want to do something fancier, for example override a default scope, you can
 also use :association_method parameter with a normal method on your User model.
 The only requirement is that your method returns an instance of ActiveRecord::Relation.
@@ -229,7 +244,7 @@ possibilities for how you may with to handle your user interface):
 
     ActiveAdmin.register Project do
 
-      sidebar "Project Details" do
+      sidebar "Project Details", only: [:show, :edit] do
         ul do
           li link_to("Tickets", admin_project_tickets_path(project))
           li link_to("Milestones", admin_project_milestones_path(project))

data/docs/3-index-pages.md

@@ -50,7 +50,7 @@ class of the index component you created.
     index :as => ActiveAdmin::Views::IndexAsTable do
       column :image_title
       default_actions
-    end     
+    end
 
 ## Index Filters
 
@@ -143,6 +143,17 @@ You can also disable pagination:
       config.paginate = false
     end
 
+If you have a very large database, you might want to disable SELECT COUNT(*) queries caused by the pagination info at the bottom of the page:
+
+    ActiveAdmin.register Post do
+
+      # disable pagination total
+      index :pagination_total => false do
+        #...
+      end
+
+    end
+
 ## Disable CSV, XML and JSON export
 
 You can remove links to download CSV, XML and JSON exports:
@@ -177,3 +188,4 @@ If you want to customize download links for every resource throughout the applic
       config.download_links = [:csv, :xml, :json, :pdf]
 
     end
+

data/docs/3-index-pages/create-an-index.md

@@ -1,7 +1,7 @@
 # Create an Index
 
 If the supplied Active Admin index components are insufficient for your project
-feel free to define your own. Index classes extend ActiveAdmin::Component and 
+feel free to define your own. Index classes extend ActiveAdmin::Component and
 require a build method and an index_name class method.
 
     module ActiveAdmin
@@ -20,10 +20,10 @@ require a build method and an index_name class method.
       end
     end
 
-The build method takes a PagePresenter object and collection of whatever you 
+The build method takes a PagePresenter object and collection of whatever you
 choose.
 
 The index_name class method takes no arguments and returns a string that should
 be representative of the the class name. If this method is not defined, your
-index component will not be able take advantage of Active Admin's 
-*multiple index pages* feature.
+index component will not be able take advantage of Active Admin's
+*multiple index pages* feature.

data/docs/3-index-pages/index-as-block.md

@@ -13,4 +13,4 @@ resource.
           simple_format product.description
         end
       end
-    end
+    end

data/docs/3-index-pages/index-as-blog.md

@@ -58,4 +58,4 @@ Or, render a block as the body:
           span "Post in #{post.categories.join(', ')}"
         end
       end
-    end
+    end

data/docs/3-index-pages/index-as-grid.md

@@ -18,4 +18,4 @@ option:
 
     index :as => :grid, :columns => 5 do |product|
       link_to(image_tag(product.image_path), admin_product_path(product))
-    end
+    end

data/docs/4-csv-format.md

@@ -16,7 +16,7 @@ Customizing the CSV format is as simple as customizing the index page.
 You can set custom csv options:
 
     ActiveAdmin.register Post do
-      csv :options => { :force_quotes => true } do
+      csv :force_quotes => true do
         column :title
         column("Author") { |post| post.author.full_name }
       end
@@ -25,8 +25,8 @@ You can set custom csv options:
 You can set options for the CSV format system-wide:
 
     # config/initializers/active_admin.rb
-    # Set the CSV builder separator (default is ",")
-    config.csv_column_separator = ';'
+    # Set the CSV builder separator
+    config.csv_options = { :col_sep => ';' }
 
-    # Set the CSV builder options (default is {})
+    # Force the use of quotes
     config.csv_options = { :force_quotes => true }

data/docs/5-forms.md

@@ -1,7 +1,7 @@
 # Customizing the Form
 
 Active Admin gives complete control over the output of the form by creating a thin DSL on top of
-the fabulous DSL created by Formtastic (http://github.com/justinfrench/formtastic).
+the fabulous DSL created by [Formtastic](http://github.com/justinfrench/formtastic).
 
     ActiveAdmin.register Post do
 
@@ -19,8 +19,8 @@ the fabulous DSL created by Formtastic (http://github.com/justinfrench/formtasti
 
     end
 
-Please view the documentation for Formtastic to see all the wonderful things you can do:
-http://github.com/justinfrench/formtastic
+Please view [the documentation](http://github.com/justinfrench/formtastic)
+for Formtastic to see all the wonderful things you can do.
 
 If you require a more custom form than can be provided through the DSL, you can pass
 a partial in to render the form yourself.
@@ -37,3 +37,46 @@ Then implement app/views/admin/posts/_form.html.erb:
       <%= f.inputs :title, :body %>
       <%= f.actions :commit %>
     <% end %>
+
+## Nested Resources
+
+You can create forms with nested models using the `has_many` method:
+
+    ActiveAdmin.register Post do
+
+      form do |f|
+        f.inputs "Details" do
+          f.input :title
+          f.input :published_at, :label => "Publish Post At"
+        end
+        f.inputs "Content" do
+          f.input :body
+        end
+        f.inputs do
+          f.has_many :categories, :allow_destroy => true, :heading => 'Themes', :new_record => false do |cf|
+            cf.input :title
+          end
+        end
+        f.actions
+      end
+
+    end
+
+The `:allow_destroy` option will add a checkbox to the end of the nested form allowing
+removal of the child object upon submission. Be sure to set `:allow_destroy => true`
+on the association to use this option.
+
+The `:heading` option will add a custom heading to has_many form. You can hide a heading by setting `:heading => false`.
+
+The `:new_record` option will show or hide new record link at the bottom of has_many form. It is set as true by default.
+
+## Displaying Errors
+
+To display a list of all errors, include `semantic_errors` at top of form. Particularly useful to display errors on the base or virtual attributes.
+
+    form do |f|
+      f.semantic_errors *f.object.errors.keys
+      f.inputs
+      f.buttons
+    end
+

data/docs/{6-show-screens.md → 6-show-pages.md}

@@ -1,6 +1,6 @@
-# Customizing the Show Screen
+# Customize the Show Page
 
-Customizing the show screen is as simple as implementing the show block:
+Customize the show page is as simple as implementing the show block:
 
     ActiveAdmin.register Post do
       show do
@@ -36,7 +36,7 @@ If you'd like to keep the default active_admin look, you can also use "attribute
     end
 
 You can customize the title of the object in the show screen.  The default is the resource name and the ID.  You can customize as follows:
-    
+
     show :title => :name do
     end
 

data/docs/8-custom-actions.md

@@ -56,7 +56,7 @@ your action will use the :get verb.
 ## Rendering in Custom Actions
 
 Custom controller actions support rendering within the standard Active Admin
-layout. 
+layout.
 
     ActiveAdmin.register Post do
 
@@ -81,10 +81,10 @@ For example, create app/views/admin/posts/comments.html.arb with:
         simple_format comment.body
       end
     end
-    
+
 ### Custom Action Items
 
-To include your own action items (like the New, Edit and Delete buttons), add an 
+To include your own action items (like the New, Edit and Delete buttons), add an
 `action_item` block. For example, to add a "View on site" button to view a blog
 post:
 

data/docs/9-batch-actions.md

@@ -105,7 +105,7 @@ Can be translated with:
           labels:
             publish: "Publish"
 
-### Batch Action Confirmation   
+### Batch Action Confirmation
 
 You can also request that the user confirm the action, before the action is performed:
 
@@ -159,3 +159,11 @@ You can easily use `batch_action` in the other index views, *Grid*, *Block*, and
       end
 
     end
+
+### Batch Actions and Custom Actions 
+
+In order to perform the batch action, the entire *Table*, *Grid*, etc. is wrapped in a form that submits the id's of the selected rows to your batch_action.
+
+Since nested `<form>` tags in HTML often results in unexpected behavior, you may need to modify custom actions or forms you are using on your page with batch actions enabled. 
+
+Specifically, if you are using HTTP methods like `PUT` or `PATCH` with a custom form on your index page this may result in your batch action being `PUT`ed instead of `POST`ed which in turn will create a routing error. You can get around this by either moving the nested form to another page (ie. the Object's show page) or, if possible, changing the method of the custom action to `POST` so that it doesn't override the batch action. Remember, behavior may vary by browser.

data/features/action_item.feature

@@ -10,9 +10,9 @@ Feature: Action Item
     Given a configuration of:
     """
     ActiveAdmin.register Post do
-      action_item do 
+      action_item do
         link_to "Embiggen", '/'
-      end  
+      end
     end
     """
     When I am on the index page for posts
@@ -32,9 +32,9 @@ Feature: Action Item
     Given a configuration of:
     """
     ActiveAdmin.register Post do
-      action_item :if => proc{ !current_active_admin_user.nil? } do 
+      action_item :if => proc{ !current_active_admin_user.nil? } do
         link_to "Embiggen", '/'
-      end  
+      end
     end
     """
     When I am on the index page for posts
@@ -54,9 +54,9 @@ Feature: Action Item
     Given a configuration of:
     """
     ActiveAdmin.register Post do
-      action_item :if => proc{ current_active_admin_user.nil? } do 
+      action_item :if => proc{ current_active_admin_user.nil? } do
         link_to "Embiggen", '/'
-      end  
+      end
     end
     """
     When I am on the index page for posts

data/features/authorization_cancan.feature

@@ -7,7 +7,7 @@ Feature: Authorizing Access using CanCan
     """
     require 'cancan'
 
-    class ::Ability 
+    class ::Ability
       include ::CanCan::Ability
 
       def initialize(user)

data/features/belongs_to.feature

@@ -16,8 +16,8 @@ Feature: Belongs To
       end
     """
     When I go to the last author's posts
-    Then the "Users" tab should be selected
-    And I should not see a menu item for "Posts"
+    Then the "Posts" tab should be selected
+    And I should not see a menu item for "Users"
     And I should see "Displaying 1 Post"
     And I should see a link to "Users" in the breadcrumb
 
@@ -32,7 +32,7 @@ Feature: Belongs To
     When I go to the last author's posts
     And I follow "View"
     Then I should be on the last author's last post page
-    And the "Users" tab should be selected
+    And the "Posts" tab should be selected
 
   Scenario: When the belongs to is optional
     Given a configuration of:

data/features/breadcrumb.feature

@@ -11,7 +11,7 @@ Feature: Breadcrumb
     """
     When I am on the new post page
     Then I should see a link to "Post" in the breadcrumb
-    
+
   Scenario: Rewritten breadcrumb links
     Given a configuration of:
     """
@@ -24,4 +24,4 @@ Feature: Breadcrumb
       end
     """
     When I am on the new post page
-    Then I should see a link to "test" in the breadcrumb
+    Then I should see a link to "test" in the breadcrumb

data/features/comments/commenting.feature

@@ -34,13 +34,14 @@ Feature: Commenting
         config.comments = false
       end
     """
-    Then I should not see "Comments"
+    Then I should not see the element "div.comments.panel"
 
   Scenario: View a resource in a namespace that doesn't have comments
     Given a configuration of:
     """
-      post_config = ActiveAdmin.register Post, :namespace => :new_namespace
-      post_config.namespace.allow_comments = false
+      ActiveAdmin.application.namespace(:new_namespace).allow_comments = false
+      ActiveAdmin.register Post,      :namespace => :new_namespace
+      ActiveAdmin.register AdminUser, :namespace => :new_namespace
     """
     Given I am logged in
     When I am on the index page for posts in the new_namespace namespace
@@ -51,7 +52,8 @@ Feature: Commenting
     Given a show configuration of:
     """
       ActiveAdmin.register Post
-      ActiveAdmin.register Post, :namespace => :public
+      ActiveAdmin.register Post,      :namespace => :public
+      ActiveAdmin.register AdminUser, :namespace => :public
     """
     When I add a comment "Hello world in admin namespace"
     Then I should see "Hello world in admin namespace"
@@ -123,4 +125,4 @@ Feature: Commenting
 		And I follow "View"
 		When I add a comment "Tag Comment"
 		Then I should see a flash with "Comment was successfully created"
-		And I should be in the resource section for tags
+		And I should be in the resource section for tags