activeadmin 0.6.6 → 1.0.0.pre1

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

@@ -1,4 +1,8 @@
-<!-- Please don't edit this file. It will be clobbered. -->
+<!--
+  WARNING: Please DO NOT edit this file! Update
+  source documentation in lib/active_admin/views
+  and execute rake yard to regenerate it.
+-->
 
 # Index as a Grid
 
@@ -6,16 +10,20 @@ Sometimes you want to display the index screen for a set of resources as a grid
 (possibly a grid of thumbnail images). To do so, use the :grid option for the
 index block.
 
-    index :as => :grid do |product|
-      link_to(image_tag(product.image_path), admin_product_path(product))
-    end
+```ruby
+index as: :grid do |product|
+  link_to image_tag(product.image_path), admin_product_path(product)
+end
+```
 
 The block is rendered within a cell in the grid once for each resource in the
 collection. The resource is passed into the block for you to use in the view.
 
-You can customize the number of colums that are rendered using the columns
+You can customize the number of columns that are rendered using the columns
 option:
 
-    index :as => :grid, :columns => 5 do |product|
-      link_to(image_tag(product.image_path), admin_product_path(product))
-    end
+```ruby
+index as: :grid, columns: 5 do |product|
+  link_to image_tag(product.image_path), admin_product_path(product)
+end
+```

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

@@ -1,4 +1,8 @@
-<!-- Please don't edit this file. It will be clobbered. -->
+<!--
+  WARNING: Please DO NOT edit this file! Update
+  source documentation in lib/active_admin/views
+  and execute rake yard to regenerate it.
+-->
 
 # Index as a Table
 
@@ -11,22 +15,30 @@ displayed.
 To display an attribute or a method on a resource, simply pass a symbol into the
 column method:
 
-    index do
-      column :title
-    end
+```ruby
+index do
+  selectable_column
+  column :title
+end
+```
 
 For association columns we make an educated guess on what to display by
 calling the following methods in the following order:
 
-    :display_name, :full_name, :name, :username, :login, :title, :email, :to_s
+```ruby
+:display_name, :full_name, :name, :username, :login, :title, :email, :to_s
+```
 
-This can be customized in config/initializers/active_admin.rb.
+This can be customized in `config/initializers/active_admin.rb`.
 
 If the default title does not work for you, pass it as the first argument:
 
-    index do
-      column "My Custom Title", :title
-    end
+```ruby
+index do
+  selectable_column
+  column "My Custom Title", :title
+end
+```
 
 Sometimes that just isn't enough and you need to write some view-specific code.
 For example, say we wanted a "Title" column that links to the posts admin screen.
@@ -34,36 +46,70 @@ For example, say we wanted a "Title" column that links to the posts admin screen
 `column` accepts a block that will be rendered for each of the objects in the collection.
 The block is called once for each resource, which is passed as an argument to the block.
 
-    index do
-      column "Title" do |post|
-        link_to post.title, admin_post_path(post)
-      end
-    end
+```ruby
+index do
+  selectable_column
+  column "Title" do |post|
+    link_to post.title, admin_post_path(post)
+  end
+end
+```
 
 To setup links to View, Edit and Delete a resource, use the `actions` method:
 
-    index do
-      column :title
-      actions
-    end
+```ruby
+index do
+  selectable_column
+  column :title
+  actions
+end
+```
 
 You can also append custom links to the default links:
 
-    index do
-      column :title
-      actions do |post|
-        link_to "Preview", admin_preview_post_path(post), :class => "member_link"
-      end
-    end
+```ruby
+index do
+  selectable_column
+  column :title
+  actions do |post|
+    item "Preview", admin_preview_post_path(post), class: "member_link"
+  end
+end
+```
 
 Or forego the default links entirely:
 
-    index do
-      column :title
-      actions :defaults => false do |post|
-        link_to "View", admin_post_path(post)
-      end
-    end
+```ruby
+index do
+  column :title
+  actions defaults: false do |post|
+    item "View", admin_post_path(post)
+  end
+end
+```
+
+Or append custom action with custom html via arbre:
+
+```ruby
+index do
+  column :title
+  actions do |post|
+    a link_to "View", admin_post_path(post)
+  end
+end
+```
+
+In case you prefer to list actions links in a dropdown menu:
+
+```ruby
+index do
+  selectable_column
+  column :title
+  actions dropdown: true do |post|
+    item "Preview", admin_preview_post_path(post)
+  end
+end
+```
 
 ## Sorting
 
@@ -74,17 +120,33 @@ Active Admin a hint for how to sort the table.
 If a column is defined using a block, you must pass the key to turn on sorting. The key
 is the attribute which gets used to sort objects using Active Record.
 
-    index do
-      column "Title", :sortable => :title do |post|
-        link_to post.title, admin_post_path(post)
-      end
-    end
+By default, this is the column on the resource's table that the attribute corresponds to.
+Otherwise, any attribute that the resource collection responds to can be used.
+
+```ruby
+index do
+  column :title, sortable: :title do |post|
+    link_to post.title, admin_post_path(post)
+  end
+end
+```
 
 You can turn off sorting on any column by passing false:
 
-    index do
-      column :title, :sortable => false
-    end
+```ruby
+index do
+  column :title, sortable: false
+end
+```
+
+It's also possible to sort by PostgreSQL's hstore column key. You should set `sortable`
+option to a `column->'key'` value:
+
+```ruby
+index do
+  column :keywords, sortable: "meta->'keywords'"
+end
+```
 
 ## Associated Sorting
 
@@ -93,17 +155,21 @@ can't sort by associated objects. Though with a few simple changes, you can.
 
 Assuming you're on the Books index page, and Book has_one Publisher:
 
-    controller do
-      def scoped_collection
-        resource_class.includes(:publisher) # prevents N+1 queries to your database
-      end
-    end
+```ruby
+controller do
+  def scoped_collection
+    super.includes :publisher # prevents N+1 queries to your database
+  end
+end
+```
 
 Then it's simple to sort by any Publisher attribute from within the index table:
 
-    index do
-      column :publisher, sortable: 'publishers.name'
-    end
+```ruby
+index do
+  column :publisher, sortable: 'publishers.name'
+end
+```
 
 ## Showing and Hiding Columns
 
@@ -112,9 +178,20 @@ easily do things that show or hide columns based on the current context.
 
 For example, if you were using CanCan:
 
-    index do
-      column :title, :sortable => false
-      if can? :manage, Post
-        column :some_secret_data
-      end
-    end
+```ruby
+index do
+  column :title, sortable: false
+  column :secret_data if can? :manage, Post
+end
+```
+
+## Custom row class
+
+In order to add special class to table rows pass the proc object as a `:row_class` option
+of the `index` method.
+
+```ruby
+index row_class: ->elem { 'active' if elem.active? } do
+  # columns
+end
+```

data/docs/4-csv-format.md

@@ -6,27 +6,34 @@ registered model.
 
 Customizing the CSV format is as simple as customizing the index page.
 
-    ActiveAdmin.register Post do
-      csv do
-        column :title
-        column("Author") { |post| post.author.full_name }
-      end
-    end
-
-You can set custom csv options:
-
-    ActiveAdmin.register Post do
-      csv :force_quotes => true do
-        column :title
-        column("Author") { |post| post.author.full_name }
-      end
-    end
-
-You can set options for the CSV format system-wide:
-
-    # config/initializers/active_admin.rb
-    # Set the CSV builder separator
-    config.csv_options = { :col_sep => ';' }
-
-    # Force the use of quotes
-    config.csv_options = { :force_quotes => true }
+```ruby
+ActiveAdmin.register Post do
+  csv do
+    column :title
+    column(:author) { |post| post.author.full_name }
+  end
+end
+```
+
+You can also set custom CSV settings for an individual resource:
+
+```ruby
+ActiveAdmin.register Post do
+  csv force_quotes: true, col_sep: ';', column_names: false do
+    column :title
+    column(:author) { |post| post.author.full_name }
+  end
+end
+```
+
+Or system-wide:
+
+```ruby
+# config/initializers/active_admin.rb
+
+# Set the CSV builder separator
+config.csv_options = { col_sep: ';' }
+
+# Force the use of quotes
+config.csv_options = { force_quotes: true }
+```

data/docs/5-forms.md

@@ -1,82 +1,159 @@
-# Customizing the Form
+# Forms
 
-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).
+Active Admin gives you complete control over the output of the form by creating
+a thin DSL on top of [Formtastic](https://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
+```ruby
+ActiveAdmin.register Post do
 
+  form do |f|
+    inputs 'Details' do
+      input :title
+      input :published_at, label: "Publish Post At"
+      li "Created at #{f.object.created_at}" unless f.object.new_record?
+      input :category
+    end
+    panel 'Markup' do
+      "The following can be used in the content below..."
     end
+    inputs 'Content', :body
+    para "Press cancel to return to the list without saving."
+    actions
+  end
 
-Please view [the documentation](http://github.com/justinfrench/formtastic)
-for Formtastic to see all the wonderful things you can do.
+end
+```
 
-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 more details, please see Formtastic's documentation.
 
-For example:
+## Default
 
-    ActiveAdmin.register Post do
-      form :partial => "form"
-    end
+Resources come with a default form defined as such:
+
+```ruby
+form do |f|
+  f.semantic_errors # shows errors on :base
+  f.inputs          # builds an input field for every attribute
+  f.actions         # adds the 'Submit' and 'Cancel' buttons
+end
+```
+
+## Partials
+
+If you want to split a custom form into a separate partial use:
 
-Then implement app/views/admin/posts/_form.html.erb:
+```ruby
+ActiveAdmin.register Post do
+  form partial: 'form'
+end
+```
 
-    <%= semantic_form_for [:admin, @post] do |f| %>
-      <%= f.inputs :title, :body %>
-      <%= f.actions :commit %>
-    <% end %>
+Which looks for something like this:
+
+```ruby
+# app/views/admin/posts/_form.html.arb
+insert_tag active_admin_form_for resource do |f|
+  inputs :title, :body
+  actions
+end
+```
+
+This is a regular Rails partial so any template engine may be used.
 
 ## Nested Resources
 
-You can create forms with nested models using the `has_many` method:
+You can create forms with nested models using the `has_many` method, even if your model uses `has_one`:
 
-    ActiveAdmin.register Post do
+```ruby
+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
+  form do |f|
+    f.inputs 'Details' do
+      f.input :title
+      f.input :published_at, label: 'Publish Post At'
+    end
+    f.inputs 'Content', :body
+    f.inputs do
+      f.has_many :categories, heading: 'Themes', allow_destroy: true, new_record: false do |a|
+        a.input :title
+      end
+    end
+    f.inputs do
+      f.has_many :taggings, sortable: :position, sortable_start: 1 do |t|
+        t.input :tag
       end
-
     end
+    f.inputs do
+      f.has_many :comment, new_record: 'Leave Comment' do |b|
+        b.input :body
+      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`
+The `:allow_destroy` option adds 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 `:heading` option adds a custom heading. You can hide it entirely by passing `false`.
+
+The `:new_record` option controls the visibility of the new record button (shown by default).
+If you pass a string, it will be used as the text for the new record button.
+
+The `:sortable` option adds a hidden field and will enable drag & drop sorting of the children. It 
+expects the name of the column that will store the index of each child.
 
-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.
+The `:sortable_start` option sets the value (0 by default) of the first position in the list.
+
+## Datepicker
+
+ActiveAdmin offers the `datepicker` input, which uses the [jQuery UI datepicker](http://jqueryui.com/datepicker/).
+The datepicker input accepts any of the options available to the standard jQueryUI Datepicker. For example:
+
+```ruby
+form do |f|
+  f.input :starts_at, as: :datepicker, datepicker_options: { min_date: "2013-10-8",        max_date: "+3D" }
+  f.input :ends_at,   as: :datepicker, datepicker_options: { min_date: 3.days.ago.to_date, max_date: "+1W +5D" }
+end
+```
 
 ## 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.
+To display a list of all validation errors:
 
-    form do |f|
-      f.semantic_errors *f.object.errors.keys
-      f.inputs
-      f.buttons
-    end
+```ruby
+form do |f|
+  f.semantic_errors *f.object.errors.keys
+  # ...
+end
+```
 
+This is particularly useful to display errors on virtual or hidden attributes.
+
+# Tabs
+
+You can arrage content in tabs as shown below:
+
+```ruby
+  form do |f|
+    tabs do
+      tab 'Basic' do
+        f.inputs 'Basic Details' do
+          f.input :email
+          f.input :password
+          f.input :password_confirmation
+        end
+      end
+
+      tab 'Advanced' do
+        f.inputs 'Advanced Details' do
+          f.input :role
+        end
+      end
+    end
+    f.actions
+  end
+```