yousty-activeadmin 1.0.0.pre

data/docs/8-custom-actions.md

@@ -0,0 +1,139 @@
+# Custom Controller Actions
+
+Active Admin allows you to override and modify the underlying controller which
+is generated for you. There are helpers to add collection and member actions, or
+you can drop right in to the controller and modify its behavior.
+
+## Collection Actions
+
+A collection action is a controller action which operates on the collection of
+resources. This method adds both the action to the controller as well as
+generating a route for you.
+
+To add a collection action, use the collection_action method:
+
+
+    ActiveAdmin.register Post do
+
+      collection_action :import_csv, :method => :post do
+        # Do some CSV importing work here...
+        redirect_to {:action => :index}, {:notice => "CSV imported successfully!"}
+      end
+
+    end
+
+This collection action will generate a route at "/admin/posts/import_csv"
+pointing to the Admin::PostsController#import_csv controller action.
+
+## Member Actions
+
+A member action is a controller action which operates on a single resource.
+
+For example, to add a lock action to a user resource, you would do the
+following:
+
+    ActiveAdmin.register User do
+
+      member_action :lock, :method => :put do
+        user = User.find(params[:id])
+        user.lock!
+        redirect_to {:action => :show}, {:notice => "Locked!"}
+      end
+
+    end
+
+This will generate a route at "/admin/users/:id/lock" pointing to the
+Admin::UserController#lock controller action.
+
+## Controller Action HTTP Verb
+
+The collection_action and member_actions methods both accept the "method"
+argument to set the HTTP verb for the controller action and route.
+
+The generated routes will be scoped to the given method you pass in. By default
+your action will use the :get verb.
+
+## Rendering in Custom Actions
+
+Custom controller actions support rendering within the standard Active Admin
+layout.
+
+    ActiveAdmin.register Post do
+
+      # /admin/posts/:id/comments
+      member_action :comments do
+        @post = Post.find(params[:id])
+
+        # This will render app/views/admin/posts/comments.html.erb
+      end
+
+    end
+
+If you would like to use the same view syntax as the rest of Active Admin, you
+can use the Arbre file extension: .arb.
+
+For example, create app/views/admin/posts/comments.html.arb with:
+
+    table_for assigns[:post].comments do
+      column :id
+      column :author
+      column :body do |comment|
+        simple_format comment.body
+      end
+    end
+
+### Custom Action Items
+
+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:
+
+    action_item :only => :show do
+      link_to('View on site', post_path(post)) if post.published?
+    end
+
+Actions items also accept the :if option to conditionally display them:
+
+    action_item :only => :show, :if => proc{ current_admin_user.super_admin? } do
+      "Only display this to super admins on the show screen"
+    end
+
+### Page Titles
+
+The page title for the custom action will be the internationalized version of
+the controller action name. For example, a member_action named "upload_csv" will
+look up a translation key of "active_admin.upload_csv". If none are found, it
+just title cases the controller action's name.
+
+If this method doesn't work for your requirements, you can always set the
+@page_title instance variable in your controller action to customize the page
+title.
+
+    ActiveAdmin.register Post do
+
+      # /admin/posts/:id/comments
+      member_action :comments do
+        @post = Post.find(params[:id])
+        @page_title = "#{@post.title}: Comments" # Set the page title
+
+        # This will render app/views/admin/posts/comments.html.erb
+      end
+
+    end
+
+## Modify the Controller
+
+The generated controller is available to you within the registration block by
+using the #controller method.
+
+    ActiveAdmin.register Post do
+
+      controller do
+        # This code is evaluated within the controller class
+
+        def define_a_method
+          # Instance method
+        end
+      end
+
+    end

data/docs/9-batch-actions.md

@@ -0,0 +1,155 @@
+# Index Batch Actions
+
+By default, the index view includes a way to quickly delete records from the listing,
+as well as an API for you to easily create your own "Batch Action" for handling a request to operate
+on multiple records at once.  If you override the default index, `selectable_column` must be used as the first column to enable batch actions:
+
+    index do
+      selectable_column
+      # add other columns here...
+    end
+
+## Provided Batch Action
+
+The `batch_action` API provides one default batch action for use in your application immediately, for deleting
+multiple records at once.  You are able to disable this action if you desire (see below).
+
+## Creating Your Own Batch Actions
+
+To create your own batch action, use the `batch_action` method.  You are provided an array of record IDs
+to operate on.  The array should contain at least one ID.
+
+    ActiveAdmin.register Post do
+      batch_action :flag do |selection|
+        Post.find(selection).each do |post|
+          post.flag! :hot
+        end
+        redirect_to collection_path, :alert => "The posts have been flagged."
+      end
+    end
+
+### Disabling Batch Actions
+
+You can disable batch actions at the application or namespace level in
+`config/initializers/active_admin.rb`:
+
+    ActiveAdmin.setup do |config|
+
+      # Disable all batch actions
+      config.batch_actions = false
+
+
+      # Or disable for a given namespace
+      config.namespace :admin do |admin|
+        admin.batch_actions = false
+      end
+    end
+
+You can disable batch actions on any given resource using:
+
+    ActiveAdmin.register Post do
+      config.batch_actions = false
+    end
+
+
+### Modifying a Previously Registered Batch Action
+
+If you wanted to modify the behavior of the provided "Delete" batch action, you can override by:
+
+    ActiveAdmin.register Post do
+      batch_action :destroy, :if => proc { can?( :destroy, Post ) } do |selection|
+        redirect_to collection_path, :alert => "Didn't really delete these!"
+      end
+    end
+
+### Removing a Batch Action
+
+You can also remove batch actions by simply passing false as the second parameter:
+
+    ActiveAdmin.register Post do
+      batch_action :destroy, false
+    end
+
+### Conditional Display of Batch Action
+
+You can control whether or not the batch action is available via the `:if` option. Provide a boolean or a proc, which is executed in context of the view.
+
+    ActiveAdmin.register Post do
+      batch_action :flag, :if => proc { false } do |selection|
+        # This action won't ever be displayed
+      end
+    end
+
+### Batch Action Priority in Menu
+
+You can also change the order of batch actions, by providing a value for the :priority param:
+
+    ActiveAdmin.register Post do
+      batch_action :destroy, :priority => 1 do |selection|
+        # Do some deleting in here...
+      end
+    end
+
+### Batch Action I18n of Labels
+
+By default, the name of the batch action will be used to lookup a label for the
+menu. It will lookup in `active_admin.batch_actions.labels.#{your_batch_action_name}`. For
+example:
+
+    ActiveAdmin.register Post do
+      batch_action :publish do |selection|
+        # do some publishing...
+      end
+    end
+
+Can be translated with:
+
+    # config/locales/en.yml
+    en:
+      active_admin:
+        batch_actions:
+          labels:
+            publish: "Publish"
+
+### Batch Action Confirmation
+
+You can also request that the user confirm the action, before the action is performed:
+
+    ActiveAdmin.register Post do
+      batch_action :destroy, :confirm => "Are you sure you want to delete all of these?" do |selection|
+        # Do some deleting...
+      end
+    end
+
+### Support for Other Index Types
+
+You can easily use `batch_action` in the other index views, *Grid*, *Block*, and *Blog*; however, these views will require more custom styling to fit your application needs.
+
+    ActiveAdmin.register Post do
+
+      # By default, the "Delete" batch action is provided
+
+      # Index as Grid
+      index as: :grid do |post|
+        resource_selection_cell post
+        h2 auto_link( post )
+      end
+
+      # Index as Blog requires nothing special
+
+      # Index as Block
+      index as: :block do |post|
+        div for: post do
+          resource_selection_cell post
+        end
+      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

@@ -0,0 +1,73 @@
+Feature: Action Item
+
+  Creating and Configuring action items
+
+  Background:
+    Given I am logged in
+    And a post with the title "Hello World" exists
+
+  Scenario: Create an member action
+    Given a configuration of:
+    """
+    ActiveAdmin.register Post do
+      action_item do
+        link_to "Embiggen", '/'
+      end
+    end
+    """
+    When I am on the index page for posts
+    Then I should not see a member link to "Embiggen"
+
+    When I follow "View"
+    Then I should see an action item link to "Embiggen"
+
+    When I follow "Edit Post"
+    Then I should see an action item link to "Embiggen"
+
+    When I am on the index page for posts
+    When I follow "New Post"
+    Then I should see an action item link to "Embiggen"
+
+  Scenario: Create an member action with if clause that returns true
+    Given a configuration of:
+    """
+    ActiveAdmin.register Post do
+      action_item :if => proc{ !current_active_admin_user.nil? } do
+        link_to "Embiggen", '/'
+      end
+    end
+    """
+    When I am on the index page for posts
+    Then I should not see a member link to "Embiggen"
+
+    When I follow "View"
+    Then I should see an action item link to "Embiggen"
+
+    When I follow "Edit Post"
+    Then I should see an action item link to "Embiggen"
+
+    When I am on the index page for posts
+    When I follow "New Post"
+    Then I should see an action item link to "Embiggen"
+
+  Scenario: Create an member action with if clause that returns false
+    Given a configuration of:
+    """
+    ActiveAdmin.register Post do
+      action_item :if => proc{ current_active_admin_user.nil? } do
+        link_to "Embiggen", '/'
+      end
+    end
+    """
+    When I am on the index page for posts
+    Then I should not see a member link to "Embiggen"
+
+    When I follow "View"
+    Then I should not see an action item link to "Embiggen"
+
+    When I follow "Edit Post"
+    Then I should not see an action item link to "Embiggen"
+
+    When I am on the index page for posts
+    When I follow "New Post"
+    Then I should not see an action item link to "Embiggen"

data/features/authorization.feature

@@ -0,0 +1,64 @@
+Feature: Authorizing Access
+
+  Ensure that access denied exceptions are managed
+
+  Background:
+    Given I am logged in
+    And 1 post exists
+    And a configuration of:
+    """
+    class OnlyAuthorsAuthorization < ActiveAdmin::AuthorizationAdapter
+
+      def authorized?(action, subject = nil)
+        case subject
+
+        when normalized(Post)
+          case action
+          when ActiveAdmin::Auth::UPDATE, ActiveAdmin::Auth::DESTROY
+            false
+          else
+            true
+          end
+
+        when ActiveAdmin::Page
+          if subject.name == "No Access"
+            false
+          else
+            true
+          end
+
+        else
+          false
+        end
+      end
+
+    end
+
+    ActiveAdmin.application.namespace(:admin).authorization_adapter = OnlyAuthorsAuthorization
+
+    ActiveAdmin.register Post do
+    end
+
+    ActiveAdmin.register_page "No Access" do
+    end
+    """
+    And I am on the index page for posts
+
+  @allow-rescue
+  Scenario: Attempt to access a resource I am not authorized to see
+    When I go to the last post's edit page
+    Then I should see "You are not authorized to perform this action"
+
+  Scenario: Viewing the default action items
+    When I follow "View"
+    Then I should not see an action item link to "Edit"
+
+  @allow-rescue
+  Scenario: Attempting to visit a Page without authorization
+    When I go to the admin no access page
+    Then I should see "You are not authorized to perform this action"
+
+  @allow-rescue
+  Scenario: Viewing a page with authorization
+    When I go to the admin dashboard page
+    Then I should see "Dashboard"

data/features/authorization_cancan.feature

@@ -0,0 +1,52 @@
+Feature: Authorizing Access using CanCan
+
+  Background:
+    Given I am logged in
+    And 1 post exists
+    And a configuration of:
+    """
+    require 'cancan'
+
+    class ::Ability
+      include ::CanCan::Ability
+
+      def initialize(user)
+        # Manage Posts
+        can [:edit, :destroy], Post, :author_id => user.id
+        can :read, Post
+
+        # View Pages
+        can :read, ActiveAdmin::Page, :name => "Dashboard"
+        cannot :read, ActiveAdmin::Page, :name => "No Access"
+      end
+
+    end
+
+    ActiveAdmin.application.namespace(:admin).authorization_adapter = ActiveAdmin::CanCanAdapter
+
+    ActiveAdmin.register Post do
+    end
+
+    ActiveAdmin.register_page "No Access" do
+    end
+    """
+    And I am on the index page for posts
+
+  @allow-rescue
+  Scenario: Attempt to access a resource I am not authorized to see
+    When I go to the last post's edit page
+    Then I should see "You are not authorized to perform this action"
+
+  Scenario: Viewing the default action items
+    When I follow "View"
+    Then I should not see an action item link to "Edit"
+
+  @allow-rescue
+  Scenario: Attempting to visit a Page without authorization
+    When I go to the admin no access page
+    Then I should see "You are not authorized to perform this action"
+
+  @allow-rescue
+  Scenario: Viewing a page with authorization
+    When I go to the admin dashboard page
+    Then I should see "Dashboard"

data/features/belongs_to.feature

@@ -0,0 +1,63 @@
+Feature: Belongs To
+
+  A resource belongs to another resource
+
+  Background:
+    Given I am logged in
+    And a post with the title "Hello World" written by "John Doe" exists
+    And a post with the title "Hello World" written by "Jane Doe" exists
+
+  Scenario: Viewing the child resource index page
+    Given a configuration of:
+    """
+      ActiveAdmin.register User
+      ActiveAdmin.register Post do
+        belongs_to :user
+      end
+    """
+    When I go to the last author's 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
+
+  Scenario: Viewing a child resource page
+    Given a configuration of:
+    """
+      ActiveAdmin.register User
+      ActiveAdmin.register Post do
+        belongs_to :user
+      end
+    """
+    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 "Posts" tab should be selected
+
+  Scenario: When the belongs to is optional
+    Given a configuration of:
+    """
+      ActiveAdmin.register User
+      ActiveAdmin.register Post do
+        belongs_to :user, :optional => true
+      end
+    """
+    When I go to the last author's posts
+    Then the "Users" tab should be selected
+    And I should see a menu item for "Posts"
+
+    When I follow "Posts"
+    Then the "Posts" tab should be selected
+
+  Scenario: Displaying belongs to resources in main menu
+    Given a configuration of:
+    """
+      ActiveAdmin.register User
+      ActiveAdmin.register Post do
+        belongs_to :user
+        navigation_menu :user
+      end
+    """
+    When I go to the last author's posts
+    And I follow "View"
+    Then the "Posts" tab should be selected

data/features/breadcrumb.feature

@@ -0,0 +1,27 @@
+Feature: Breadcrumb
+
+  Background:
+    Given I am logged in
+
+  Scenario: Default breadcrumb links
+    Given a configuration of:
+    """
+      ActiveAdmin.register Post do
+      end
+    """
+    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:
+    """
+      ActiveAdmin.register Post do
+        breadcrumb do
+          [
+            link_to('test', '/admin/test/url')
+          ]
+        end
+      end
+    """
+    When I am on the new post page
+    Then I should see a link to "test" in the breadcrumb