activeadmin-rails 1.7.0

data/docs/9-batch-actions.md

@@ -0,0 +1,248 @@
+---
+layout: default
+nav_order: 9
+title: Batch Actions
+redirect_from: /docs/9-batch-actions.html
+---
+
+# Batch Actions
+
+By default, the index page provides you a "Batch Action" to quickly delete records,
+as well as an API for you to easily create your own. Note that if you override the
+default index, you must add `selectable_column` back for batch actions to be usable:
+
+```ruby
+index do
+  selectable_column
+  # ...
+end
+```
+
+## Creating your own
+
+Use the `batch_action` DSL method to declare your own, eg:
+
+```ruby
+ActiveAdmin.register Post do
+  batch_action :flag
+```
+and
+```ruby
+class Admin::PostsController < ActiveAdmin::ResourceController
+  protected
+  def batch_action_flag(ids, inputs)
+    batch_action_collection.find(ids).each do |post|
+      post.flag! :hot
+    end
+    redirect_to collection_path, alert: "The posts have been flagged."
+  end
+end
+```
+
+The controller method
+is passed an array of the record IDs that the user selected, so you can perform
+your desired batch action on all of them.
+
+### Disabling Batch Actions
+
+You can disable batch actions at the application, namespace, or resource level:
+
+```ruby
+# config/initializers/active_admin.rb
+ActiveAdmin.setup do |config|
+
+  # Application level:
+  config.batch_actions = false
+
+  # Namespace level:
+  config.namespace :admin do |admin|
+    admin.batch_actions = false
+  end
+end
+
+# app/admin/post.rb
+ActiveAdmin.register Post do
+
+  # Resource level:
+  config.batch_actions = false
+end
+```
+
+### Modification
+
+If you want, you can override the default batch action to do whatever you want:
+
+```ruby
+class Admin::PostsController < ActiveAdmin::ResourceController
+  protected
+  def batch_action_destroy(ids, inputs)
+    redirect_to collection_path, alert: "Didn't really delete these!"
+  end
+end
+```
+
+### Removal
+
+You can remove batch actions by simply passing false as the second parameter:
+
+```ruby
+ActiveAdmin.register Post do
+  batch_action :destroy, false
+end
+```
+
+### Conditional display
+
+You can control whether or not the batch action is available via the `:if`
+option, which is executed in the view context.
+
+```ruby
+ActiveAdmin.register Post do
+  batch_action :flag, if: proc{ can? :flag, Post } do |ids|
+    # ...
+  end
+end
+```
+
+### Priority in the drop-down menu
+
+You can change the order of batch actions through the `:priority` option:
+
+```ruby
+ActiveAdmin.register Post do
+  batch_action :destroy, priority: 1 do |ids|
+    # ...
+  end
+end
+```
+
+### Confirmation prompt
+
+You can pass a custom string to prompt the user with:
+
+```ruby
+ActiveAdmin.register Post do
+  batch_action :destroy, confirm: "Are you sure??" do |ids|
+    # ...
+  end
+end
+```
+
+### Batch Action forms
+
+If you want to capture input from the user as they perform a batch action,
+Active Admin has just the thing for you:
+
+```ruby
+batch_action :flag, form: {
+  type: %w[Offensive Spam Other],
+  reason: :text,
+  notes:  :textarea,
+  hide:   :checkbox,
+  date:   :datepicker
+} do |ids, inputs|
+  # inputs is a hash of all the form fields you requested
+  redirect_to collection_path, notice: [ids, inputs].to_s
+end
+```
+
+If you pass a nested array, it will behave just like Formtastic would, with the first
+element being the text displayed and the second element being the value.
+
+```ruby
+batch_action :doit, form: {user: [['Jake',2], ['Mary',3]]} do |ids, inputs|
+  User.find(inputs[:user])
+  # ...
+end
+```
+
+When you have dynamic form inputs you can pass a proc instead:
+
+```ruby
+batch_action :doit, form: -> { {user: User.pluck(:name, :id)} } do |ids, inputs|
+  User.find(inputs[:user])
+  # ...
+end
+```
+
+Under the covers this is powered by the JS `ActiveAdmin.modal_dialog` which you
+can use yourself:
+
+```coffee
+if $('body.admin_users').length
+  $('a[data-prompt]').click ->
+    ActiveAdmin.modal_dialog $(@).data('prompt'), comment: 'textarea',
+      (inputs)=>
+        $.post "/admin/users/#{$(@).data 'id'}/change_state",
+          comment: inputs.comment, state: $(@).data('state'),
+          success: ->
+            window.location.reload()
+```
+
+### Translation
+
+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}`.
+
+So this:
+
+```ruby
+ActiveAdmin.register Post do
+  batch_action :publish do |ids|
+    # ...
+  end
+end
+```
+
+Can be translated with:
+
+```yaml
+# config/locales/en.yml
+en:
+  active_admin:
+    batch_actions:
+      labels:
+        publish: "Publish"
+```
+
+### Support for other index types
+
+You can easily use `batch_action` in the other index views, *Grid*, *Block*,
+and *Blog*; however, these will require custom styling to fit your needs.
+
+```ruby
+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
+```
+
+### BTW
+
+In order to perform the batch action, the entire *Table*, *Grid*, etc. is
+wrapped in a form that submits the IDs of the selected rows to your batch_action.
+
+Since nested `<form>` tags in HTML often results in unexpected behavior, you
+may need to modify the custom behavior you've built using to prevent conflicts.
+
+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 will create a routing error. You can get around this
+by either moving the nested form to another page or using a POST so it doesn't
+override the batch action. As well, behavior may vary by browser.

data/docs/CNAME

@@ -0,0 +1 @@
+www.activeadmin.org

data/docs/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem 'github-pages'
+gem 'jekyll-default-layout'
+gem 'jekyll-redirect-from'
+gem 'just-the-docs'
+gem 'webrick'

data/docs/README.md

@@ -0,0 +1,24 @@
+# ActiveAdmin Documentation
+
+## Content
+
+- [Installation](0-installation.md)
+- [General Configuration](1-general-configuration.md)
+- [Resource Customization](2-resource-customization.md)
+- [Index Pages](3-index-pages.md)
+  - [Custom Index](3-index-pages/custom-index.md)
+  - [Index as Table](3-index-pages/index-as-table.md)
+  - [Index as Grid](3-index-pages/index-as-grid.md)
+  - [Index as Blocks](3-index-pages/index-as-block.md)
+  - [Index as Blog](3-index-pages/index-as-blog.md)
+- [Csv Format](4-csv-format.md)
+- [Forms](5-forms.md)
+- [Show Pages](6-show-pages.md)
+- [Sidebars](7-sidebars.md)
+- [Custom Actions](8-custom-actions.md)
+- [Batch Actions](9-batch-actions.md)
+- [Custom Pages](10-custom-pages.md)
+- [Decorators](11-decorators.md)
+- [Arbo Components](12-arbo-components.md)
+- [Authorization Adapter](13-authorization-adapter.md)
+- [Gotchas](14-gotchas.md)

data/docs/_config.yml

@@ -0,0 +1,15 @@
+plugins:
+  - jekyll-default-layout
+  - jekyll-redirect-from
+
+theme: just-the-docs
+# title: Active Admin | The administration framework for Ruby on Rails
+title: Active Admin v1.7
+# Aux links for the upper right navigation
+aux_links:
+  "Documentation":
+    - "/documentation"
+  "Try It Now!":
+    - "//demo.activeadmin.org/admin"
+  "Get the Code":
+    - "//github.com/varyonic/activeadmin"

data/docs/_includes/nav_footer_custom.html

@@ -0,0 +1,3 @@
+<div class='site-footer'>
+  Copyright &copy; 2011 <a href="http://gregbell.ca/">Greg Bell</a> and <a href="http://www.versapay.com/">VersaPay</a>
+</div>

data/docs/documentation.md

@@ -0,0 +1,61 @@
+---
+layout: default
+redirect_from: /docs/documentation.html
+---
+
+Active Admin is a framework for creating administration style interfaces. It
+abstracts common business application patterns to make it simple for developers
+to implement beautiful and elegant interfaces with very little effort.
+
+# Getting Started
+
+Active Admin is released as a Ruby Gem. The gem is to be installed within a Ruby
+on Rails application. To install, simply add the following to your Gemfile:
+
+```ruby
+# Gemfile
+gem 'activeadmin-rails'
+```
+
+After updating your bundle, run the installer
+
+```bash
+rails generate active_admin:install
+```
+
+The installer creates an initializer used for configuring defaults used by
+Active Admin as well as a new folder at `app/admin` to put all your admin
+configurations.
+
+Migrate your db and start the server:
+
+```bash
+$> rake db:migrate
+$> rails server
+```
+
+Visit `http://localhost:3000/admin` and log in using:
+
+* __User__: admin@example.com
+* __Password__: password
+
+Voila! You’re on your brand new Active Admin dashboard.
+
+To register your first model, run:
+
+```bash
+$> rails generate active_admin:resource
+        [MyModelName]
+```
+
+This creates a file at `app/admin/my_model_names.rb` for configuring the
+resource. Refresh your web browser to see the interface.
+
+# Next Steps
+
+Now that you have a working Active Admin installation, learn how to customize it:
+
+* [Customize the Index Page](3-index-pages.md)
+* [Customize the New and Edit Form](5-forms.md)
+* [Customize the Show Page](6-show-pages.md)
+* [Customize the Resource in General](2-resource-customization.md)