aa-rails4 0.6.0

data/docs/5-forms.md

@@ -0,0 +1,72 @@
+# 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).
+
+    ActiveAdmin.register Post do
+
+      form do |f|
+        f.inputs "Details" do
+          f.input :title
+          f.input :published_at, :label => "Publish Post At"
+          f.input :category
+        end
+        f.inputs "Content" do
+          f.input :body
+        end
+        f.actions
+      end
+
+    end
+
+Please view the documentation for Formtastic to see all the wonderful things you can do:
+http://github.com/justinfrench/formtastic
+
+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.
+
+For example:
+
+    ActiveAdmin.register Post do
+      form :partial => "form"
+    end
+
+Then implement app/views/admin/posts/_form.html.erb:
+
+    <%= semantic_form_for [:admin, @post] do |f| %>
+      <%= 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.
+

data/docs/6-show-pages.md

@@ -0,0 +1,43 @@
+# Customize the Show Page
+
+Customize the show page is as simple as implementing the show block:
+
+    ActiveAdmin.register Post do
+      show do
+        h3 post.title
+        div do
+          simple_format post.body
+        end
+      end
+    end
+
+The show block is rendered within the context of the view and uses the Arbre HTML DSL. You
+can also render a partial at any point.
+
+    ActiveAdmin.register Post do
+      show do
+        # renders app/views/admin/posts/_some_partial.html.erb
+        render "some_partial"
+      end
+    end
+
+If you'd like to keep the default active_admin look, you can also use "attributes_table":
+
+    ActiveAdmin.register Ad do
+      show do |ad|
+        attributes_table do
+          row :title
+          row :image do
+            image_tag(ad.image.url)
+          end
+        end
+        active_admin_comments
+      end
+    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/7-sidebars.md

@@ -0,0 +1,42 @@
+# Sidebar Sections
+
+To add a sidebar section to all the screen within a section, use the sidebar method:
+
+    sidebar :help do
+      "Need help? Email us at help@example.com"
+    end
+
+This will generate a sidebar section on each screen of the resource. With the block as
+the contents of the section. The first argument is the section title.
+
+You can also use Arbre syntax to define the content.
+
+    sidebar :help do
+      ul do
+        li "Second List First Item"
+        li "Second List Second Item"
+      end
+    end
+
+Sidebar sections can be rendered on a specific action by using the :only or :except
+options.
+
+    sidebar :help, :only => :index do
+      "Need help? Email us at help@example.com"
+    end
+
+If you want to conditionally display a sidebar section, use the :if option and
+pass it a proc which will be rendered within the context of the view.
+
+    sidebar :help, :if => proc{ current_admin_user.super_admin? }
+      "Only for super admins!"
+    end
+
+If you only pass a symbol, Active Admin will attempt to locate a partial to render.
+
+    # Will render app/views/admin/posts/_help_sidebar.html.erb
+    sidebar :help
+
+Or you can pass your own custom partial to render.
+
+    sidebar :help, :partial => "custom_help_partial"

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,161 @@
+# 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.
+
+## 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
+      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
+
+### Customizing Table Columns
+
+To include the column with checkboxes in after overriding the list of columns for the `index` block in the *Table* listing, use the following helper as seen below:
+
+    ActiveAdmin.register Post do
+
+      batch_action :flag do |selection|
+        Post.find(selection).each { |p| p.flag! }
+        redirect_to collection_path, :notice => "Posts flagged!"
+      end
+
+      index do
+        selectable_column
+        column :title
+        default_actions
+      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