activeadmin 1.0.0 → 1.1.0

data/docs/2-resource-customization.md

@@ -1,6 +1,7 @@
 ---
 redirect_from: /docs/2-resource-customization.html
 ---
+
 # Working with Resources
 
 Every Active Admin resource corresponds to a Rails model. So before creating a
@@ -27,8 +28,8 @@ ActiveAdmin.register Post do
 end
 ```
 
-Any form field that sends multiple values (such as a HABTM association, or an array attribute)
-needs to pass an empty array to `permit_params`:
+Any form field that sends multiple values (such as a HABTM association, or an
+array attribute) needs to pass an empty array to `permit_params`:
 
 If your HABTM is `roles`, you should permit `role_ids: []`
 
@@ -74,7 +75,8 @@ ActiveAdmin.register Post do
 end
 ```
 
-The `permit_params` call creates a method called `permitted_params`. You should use this method when overriding `create` or `update` actions:
+The `permit_params` call creates a method called `permitted_params`. You should
+use this method when overriding `create` or `update` actions:
 
 ```ruby
 ActiveAdmin.register Post do
@@ -105,10 +107,18 @@ end
 
 ## Renaming Action Items
 
-One can set custom button name and page title for new, edit, and destroy actions/pages
-at the resource level by providing a resource specific translation.
-For example to change 'New Offer' to 'Make an Offer'
-set `active_admin.resources.offer.new_model`.
+You can use translations to override labels and page titles for actions such as
+new, edit, and destroy by providing a resource specific translation.  For
+example, to change 'New Offer' to 'Make an Offer' add the following in
+config/locales/[en].yml:
+
+```yaml
+en:
+  active_admin:
+    resources:
+      offer:
+        new_model: 'Make an Offer'
+```
 
 ## Rename the Resource
 
@@ -188,6 +198,7 @@ end
 ### Conditionally Showing / Hiding Menu Items
 
 Menu items can be shown or hidden at runtime using the `:if` option.
+
 ```ruby
 ActiveAdmin.register Post do
   menu if: proc{ current_user.can_edit_posts? }
@@ -262,9 +273,15 @@ config.namespace :admin do |admin|
     menu.add label: "The Application", url: "/", priority: 0
 
     menu.add label: "Sites" do |sites|
-      sites.add label: "Google",   url: "http://google.com", html_options: { target: :blank }
-      sites.add label: "Facebook", url: "http://facebook.com"
-      sites.add label: "Github",   url: "http://github.com"
+      sites.add label: "Google",
+                url: "http://google.com",
+                html_options: { target: :blank }
+
+      sites.add label: "Facebook",
+                url: "http://facebook.com"
+
+      sites.add label: "Github",
+                url: "http://github.com"
     end
   end
 end
@@ -303,7 +320,8 @@ end
 
 ## Eager loading
 
-A common way to increase page performance is to elimate N+1 queries by eager loading associations:
+A common way to increase page performance is to elimate N+1 queries by eager
+loading associations:
 
 ```ruby
 ActiveAdmin.register Post do
@@ -313,10 +331,13 @@ end
 
 ## Customizing resource retrieval
 
-Our controllers are built on [Inherited Resources](https://github.com/activeadmin/inherited_resources),
-so you can use [all of its features](https://github.com/activeadmin/inherited_resources#overwriting-defaults).
+Our controllers are built on [Inherited
+Resources](https://github.com/activeadmin/inherited_resources), so you can use
+[all of its
+features](https://github.com/activeadmin/inherited_resources#overwriting-defaults).
 
-If you need to customize the collection properties, you can overwrite the `scoped_collection` method.
+If you need to customize the collection properties, you can overwrite the
+`scoped_collection` method.
 
 ```ruby
 ActiveAdmin.register Post do
@@ -328,8 +349,9 @@ ActiveAdmin.register Post do
 end
 ```
 
-If you need to completely replace the record retrieving code (e.g., you have a custom
-`to_param` implementation in your models), override the `resource` method on the controller:
+If you need to completely replace the record retrieving code (e.g., you have a
+custom `to_param` implementation in your models), override the `resource` method
+on the controller:
 
 ```ruby
 ActiveAdmin.register Post do
@@ -341,8 +363,9 @@ ActiveAdmin.register Post do
 end
 ```
 
-Note that if you use an authorization library like CanCan, you should be careful to not
-write code like this, otherwise **your authorization rules won't be applied**:
+Note that if you use an authorization library like CanCan, you should be careful
+to not write code like this, otherwise **your authorization rules won't be
+applied**:
 
 ```ruby
 ActiveAdmin.register Post do

data/docs/3-index-pages.md

@@ -1,6 +1,7 @@
 ---
 redirect_from: /docs/3-index-pages.html
 ---
+
 # Customizing the Index Page
 
 Filtering and listing resources is one of the most important tasks for
@@ -80,7 +81,8 @@ end
 
 Out of the box, Active Admin supports the following filter types:
 
-* *:string* - A search field
+* *:string* -  A drop down for selecting "Contains", "Equals", "Starts with",
+  "Ends with" and an input for a value.
 * *:date_range* - A start and end date field with calendar inputs
 * *:numeric* - A drop down for selecting "Equal To", "Greater Than" or "Less
   Than" and an input for a value.
@@ -109,10 +111,12 @@ To override options for string or numeric filter pass `filters` option.
   filter :title, filters: [:starts_with, :ends_with]
 ```
 
-Also, if you don't need the select with the options 'contains', 'equals', 'starts_with' or 'ends_with'
-just add the option to the filter name with an underscore.
+Also, if you don't need the select with the options 'contains', 'equals',
+'starts_with' or 'ends_with' just add the option to the filter name with an
+underscore.
 
 For example:
+
 ```ruby
 filter :name_equals
 # or
@@ -127,9 +131,11 @@ filter :author, label: 'Something else'
 
 By default, Active Admin will try to use ActiveModel I18n to determine the label.
 
-You can also filter on more than one attribute of a model using the
-[Ransack search predicate syntax](https://github.com/activerecord-hackery/ransack/wiki/Basic-Searching). If using a custom search method, you will
-also need to specify the field type using `:as` and the label.
+You can also filter on more than one attribute of a model using the [Ransack
+search predicate
+syntax](https://github.com/activerecord-hackery/ransack/wiki/Basic-Searching).
+If using a custom search method, you will also need to specify the field type
+using `:as` and the label.
 
 ```ruby
 filter :first_name_or_last_name_cont, as: :string, label: "Name"
@@ -181,8 +187,8 @@ remove_filter :id
 ## Index Scopes
 
 You can define custom scopes for your index page. This will add a tab bar above
-the index table to quickly filter your collection on pre-defined scopes. There are
-a number of ways to define your scopes:
+the index table to quickly filter your collection on pre-defined scopes. There
+are a number of ways to define your scopes:
 
 ```ruby
 scope :all, default: true
@@ -200,12 +206,13 @@ scope ->{ Date.today.strftime '%A' }, :published_today
 scope("Inactive") { |scope| scope.where(active: false) }
 
 # conditionally show a custom controller scope
-scope "Published", if: proc { current_admin_user.can? :manage, Posts } do |posts|
+scope "Published", if: -> { current_admin_user.can? :manage, Posts } do |posts|
   posts.published
 end
 ```
 
-Scopes can be labelled with a translation, e.g. `activerecord.scopes.invoice.expired`.
+Scopes can be labelled with a translation, e.g.
+`activerecord.scopes.invoice.expired`.
 
 ## Index default sort order
 
@@ -235,6 +242,14 @@ ActiveAdmin.register Post do
 end
 ```
 
+Or allow users to choose themselves using dropdown with values
+
+```ruby
+ActiveAdmin.register Post do
+  config.per_page = [10, 50, 100]
+end
+```
+
 You can change it per request / action too:
 
 ```ruby
@@ -288,6 +303,9 @@ ActiveAdmin.setup do |config|
 end
 ```
 
-Note: you have to actually implement PDF rendering for your action, ActiveAdmin does not provide this feature. This setting just allows you to specify formats that you want to show up under the index collection.
+Note: you have to actually implement PDF rendering for your action, ActiveAdmin
+does not provide this feature. This setting just allows you to specify formats
+that you want to show up under the index collection.
 
-You'll need to use a PDF rendering library like PDFKit or WickedPDF to get the PDF generation you want.
+You'll need to use a PDF rendering library like PDFKit or WickedPDF to get the
+PDF generation you want.

data/docs/3-index-pages/custom-index.md

@@ -1,6 +1,7 @@
 ---
 redirect_from: /docs/3-index-pages/custom-index.html
 ---
+
 # Custom Index
 
 If the supplied Active Admin index components are insufficient for your project

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

@@ -1,11 +1,6 @@
 ---
 redirect_from: /docs/3-index-pages/index-as-block.html
 ---
-<!--
-  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 Block
 

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

@@ -1,11 +1,6 @@
 ---
 redirect_from: /docs/3-index-pages/index-as-blog.html
 ---
-<!--
-  WARNING: Please DO NOT edit this file! Update
-  source documentation in lib/active_admin/views
-  and execute rake yard to regenerate it.
--->
 
 # Index as Blog
 

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

@@ -1,11 +1,6 @@
 ---
 redirect_from: /docs/3-index-pages/index-as-grid.html
 ---
-<!--
-  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
 

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

@@ -1,11 +1,6 @@
 ---
 redirect_from: /docs/3-index-pages/index-as-table.html
 ---
-<!--
-  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
 
@@ -89,8 +84,6 @@ index do
   column :title
   actions defaults: false do |post|
     item "View", admin_post_path(post)
-    item "Edit", edit_admin_post_path(post)
-    item "Delete", admin_post_path(post), method: :delete
   end
 end
 ```
@@ -167,7 +160,7 @@ index do
 end
 ```
 
-## Custom sorting 
+## Custom sorting
 
 It is also possible to use database specific expressions and options for sorting by column
 
@@ -208,7 +201,6 @@ index do
 end
 ```
 
-
 ## Showing and Hiding Columns
 
 The entire index block is rendered within the context of the view, so you can

data/docs/4-csv-format.md

@@ -1,6 +1,7 @@
 ---
 redirect_from: /docs/4-csv-format.html
 ---
+
 # Customizing the CSV format
 
 Active Admin provides CSV file downloads on the index screen for each Resource.
@@ -43,6 +44,7 @@ config.csv_options = { force_quotes: true }
 ```
 
 You can customize the filename by overriding `csv_filename` in the controller block.
+
 ```ruby
 ActiveAdmin.register User do
   controller do
@@ -53,7 +55,6 @@ ActiveAdmin.register User do
 end
 ```
 
-
 ## Streaming
 
 By default Active Admin streams the CSV response to your browser as it's generated.

data/docs/5-forms.md

@@ -1,6 +1,7 @@
 ---
 redirect_from: /docs/5-forms.html
 ---
+
 # Forms
 
 Active Admin gives you complete control over the output of the form by creating
@@ -27,7 +28,7 @@ ActiveAdmin.register Post do
 end
 ```
 
-For more details, please see Formtastic's documentation.
+For more details, please see [Formtastic's documentation](https://github.com/justinfrench/formtastic/wiki).
 
 ## Default
 
@@ -63,7 +64,8 @@ end
 
 This is a regular Rails partial so any template engine may be used.
 
-You can also use the `ActiveAdmin::FormBuilder` as builder in your Formtastic Form for use the same helpers are used in the admin file:
+You can also use the `ActiveAdmin::FormBuilder` as builder in your Formtastic
+Form for use the same helpers are used in the admin file:
 
 ```ruby
   = semantic_form_for [:admin, @post], builder: ActiveAdmin::FormBuilder do |f|
@@ -77,7 +79,8 @@ You can also use the `ActiveAdmin::FormBuilder` as builder in your Formtastic Fo
 
 ## Nested Resources
 
-You can create forms with nested models using the `has_many` method, even if your model uses `has_one`:
+You can create forms with nested models using the `has_many` method, even if
+your model uses `has_one`:
 
 ```ruby
 ActiveAdmin.register Post do
@@ -89,7 +92,9 @@ ActiveAdmin.register Post do
     end
     f.inputs 'Content', :body
     f.inputs do
-      f.has_many :categories, heading: 'Themes', allow_destroy: true, new_record: false do |a|
+      f.has_many :categories, heading: 'Themes',
+                              allow_destroy: true,
+                              new_record: false do |a|
         a.input :title
       end
     end
@@ -99,8 +104,9 @@ ActiveAdmin.register Post do
       end
     end
     f.inputs do
-      f.has_many :comment, new_record: 'Leave Comment',
-        allow_destroy: proc { |comment| comment.author?(current_admin_user) } do |b|
+      f.has_many :comment,
+                 new_record: 'Leave Comment',
+                 allow_destroy: -> { |c| c.author?(current_admin_user) } do |b|
         b.input :body
       end
     end
@@ -112,27 +118,44 @@ end
 
 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. It is possible to associate `:allow_destroy` with a string or a symbol, corresponding to the name of a child object's method that will get called, or with a Proc object. The Proc object receives the child object as a parameter and should return either true or false.
+on the association to use this option. It is possible to associate
+`:allow_destroy` with a string or a symbol, corresponding to the name of a child
+object's method that will get called, or with a Proc object. The Proc object
+receives the child object as a parameter and should return either true or false.
 
-The `:heading` option adds a custom heading. You can hide it entirely by passing `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 `: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 `: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 `:sortable_start` option sets the value (0 by default) of the first position in the list.
+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:
+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" }
+  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
 ```
 
@@ -174,11 +197,12 @@ You can arrange content in tabs as shown below:
   end
 ```
 
-## Customize the Create Another checkbox
+# Customize the Create Another checkbox
+
+In order to simplify creating multiple resources you may enable ActiveAdmin to
+show nice "Create Another" checkbox alongside of Create Model button. It may be
+enabled for the whole application:
 
-In order to simplify creating multiple resources you may enable ActiveAdmin to show nice "Create Another" checkbox alongside of Create Model
-button. It may be enabled for the whole application:
- 
 ```ruby
 ActiveAdmin.setup do |config|
   config.create_another = true