activeadmin 1.0.0 → 2.13.1

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
 
@@ -33,7 +28,7 @@ end
 ```
 
 Second, you can pass a block to the tile option which will then be
-used as the contents fo the title. The resource being rendered
+used as the contents of the title. The resource being rendered
 is passed in to the block. For Example:
 
 ```ruby

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
 ```
@@ -118,7 +111,8 @@ index do
 end
 ```
 
-In addition, you can insert the position of the row in the greater collection by using the index_column special command:
+In addition, you can insert the position of the row in the greater
+collection by using the index_column special command:
 
 ```ruby
 index do
@@ -128,7 +122,8 @@ index do
 end
 ```
 
-index_column take an optional offset parameter to allow a developer to set the starting number for the index (default is 1).
+index_column take an optional offset parameter to allow a developer to set
+the starting number for the index (default is 1).
 
 ## Sorting
 
@@ -136,9 +131,7 @@ When a column is generated from an Active Record attribute, the table is
 sortable by default. If you are creating a custom column, you may need to give
 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.
-
+You can pass the key specifying the attribute which gets used to sort objects using Active Record.
 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.
 
@@ -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
 
@@ -200,6 +193,13 @@ controller do
 end
 ```
 
+You can also define associated objects to include outside of the
+`scoped_collection` method:
+
+```ruby
+includes :publisher
+```
+
 Then it's simple to sort by any Publisher attribute from within the index table:
 
 ```ruby
@@ -208,7 +208,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/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,30 @@ 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.
+`active_admin.scopes.scope_method`.
+
+### Scopes groups
+
+You can assign group names to scopes to keep related scopes together and separate them from the rest.
+
+```ruby
+# a scope in the default group
+scope :all
+
+# two scopes used to filter by status
+scope :active, group: :status
+scope :inactive, group: :status
+
+# two scopes used to filter by date
+scope :today, group: :date
+scope :tomorrow, group: :date
+```
 
 ## Index default sort order
 
@@ -235,6 +259,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 +320,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/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
 
@@ -55,7 +56,7 @@ Which looks for something like this:
 
 ```ruby
 # app/views/admin/posts/_form.html.arb
-insert_tag active_admin_form_for resource do |f|
+active_admin_form_for [:admin, resource] do |f|
   inputs :title, :body
   actions
 end
@@ -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,10 +79,17 @@ 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
+  permit_params :title,
+                :published_at,
+                :body,
+                categories_attributes: [:id, :title, :_destroy],
+                taggings_attributes: [:id, :tag],
+                comment_attributes: [:id, :body, :_destroy]
 
   form do |f|
     f.inputs 'Details' do
@@ -89,7 +98,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 +110,10 @@ 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 :comments,
+                 new_record: 'Leave Comment',
+                 remove_record: 'Remove Comment',
+                 allow_destroy: -> (c) { c.author?(current_admin_user) } do |b|
         b.input :body
       end
     end
@@ -110,39 +123,67 @@ ActiveAdmin.register Post do
 end
 ```
 
+*NOTE*: In addition to using `has_many` as illustrated above, you'll need to add
+`accepts_nested_attributes` to your parent model and [configure strong parameters](https://activeadmin.info/2-resource-customization.html)
+
 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 `:remove_record` option controls the text of the remove button (shown after
+the new record button is pressed). If you pass a string, it will be used as the
+text for the remove button.
 
-The `:sortable_start` option sets the value (0 by default) of the first position in the list.
+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.
 
 ## 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
 ```
 
+Datepicker also accepts the `:label` option as a string or proc to display.
+If it's a proc, it will be called each time the datepicker is rendered.
+
 ## Displaying Errors
 
 To display a list of all validation errors:
 
 ```ruby
 form do |f|
-  f.semantic_errors *f.object.errors.keys
+  f.semantic_errors *f.object.errors.attribute_names
+
   # ...
 end
 ```
@@ -164,7 +205,7 @@ You can arrange content in tabs as shown below:
         end
       end
 
-      tab 'Advanced' do
+      tab 'Advanced', html_options: { class: 'specific_css_class' } do
         f.inputs 'Advanced Details' do
           f.input :role
         end
@@ -174,11 +215,14 @@ You can arrange content in tabs as shown below:
   end
 ```
 
-## Customize the Create Another checkbox
+`html_options` allows you set additional html params for tab's menu item.
+
+# 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

data/docs/6-show-pages.md

@@ -3,7 +3,8 @@ redirect_from: /docs/6-show-pages.html
 ---
 # Customize the Show Page
 
-The show block is rendered within the context of the view and uses [Arbre](https://github.com/activeadmin/arbre) syntax.
+The show block is rendered within the context of the view and uses
+[Arbre](https://github.com/activeadmin/arbre) syntax.
 
 With the `show` block, you can render anything you want.
 
@@ -78,3 +79,15 @@ ActiveAdmin.register Book do
   end
 end
 ```
+
+If you want to keep the default show data, but add something extra to it:
+
+```ruby
+show do
+  div do
+    h3 'Some custom charts about this object'
+    render partial: 'charts'
+  end
+  default_main_content
+end
+```

data/docs/7-sidebars.md

@@ -68,7 +68,8 @@ By default sidebars are positioned in the same order as they defined, but it's a
 possible to specify their position manually:
 
 ```ruby
-sidebar :help, priority: 0 # will push Help section to the top (above default Filters section)
+# will push Help section to the top (above default Filters section)
+sidebar :help, priority: 0
 ```
 
 Default sidebar priority is `10`.

data/docs/8-custom-actions.md

@@ -1,6 +1,7 @@
 ---
 redirect_from: /docs/8-custom-actions.html
 ---
+
 # Custom Controller Actions
 
 Active Admin allows you to override and modify the underlying controller which
@@ -61,7 +62,7 @@ HTTP verbs. In that case, this is the suggested approach:
 ```ruby
 member_action :foo, method: [:get, :post] do
   if request.post?
-    resource.update_attributes! foo: params[:foo] || {}
+    resource.update! foo: params[:foo] || {}
     head :ok
   else
     render :foo
@@ -138,11 +139,24 @@ end
 Actions items also accept the `:if` option to conditionally display them:
 
 ```ruby
-action_item :super_action, only: :show, if: proc{ current_admin_user.super_admin? } do
+action_item :super_action,
+            only: :show,
+            if: proc{ current_admin_user.super_admin? } do
   "Only display this to super admins on the show screen"
 end
 ```
 
+By default action items are positioned in the same order as they defined (after default actions),
+but it’s also possible to specify their position manually:
+
+```ruby
+action_item :help, priority: 0 do
+  "Display this action to the first position"
+end
+```
+
+Default action item priority is 10.
+
 # Modifying the Controller
 
 The generated controller is available to you within the registration block by

data/docs/9-batch-actions.md

@@ -1,6 +1,7 @@
 ---
 redirect_from: /docs/9-batch-actions.html
 ---
+
 # Batch Actions
 
 By default, the index page provides you a "Batch Action" to quickly delete records,
@@ -51,7 +52,7 @@ end
 
 # app/admin/post.rb
 ActiveAdmin.register Post do
-  
+
   # Resource level:
   config.batch_actions = false
 end
@@ -153,12 +154,13 @@ batch_action :doit, form: -> { {user: User.pluck(:name, :id)} } do |ids, inputs|
 end
 ```
 
-Under the covers this is powered by the JS `ActiveAdmin.modal_dialog` which you can use yourself:
+Under the covers this is powered by the JS `ActiveAdmin.ModalDialog` which you
+can use yourself:
 
 ```coffee
 if $('body.admin_users').length
   $('a[data-prompt]').click ->
-    ActiveAdmin.modal_dialog $(@).data('prompt'), comment: 'textarea',
+    ActiveAdmin.ModalDialog $(@).data('prompt'), comment: 'textarea',
       (inputs)=>
         $.post "/admin/users/#{$(@).data 'id'}/change_state",
           comment: inputs.comment, state: $(@).data('state'),

data/docs/CNAME

@@ -1 +1 @@
-github-docs.activeadmin.info
+activeadmin.info

data/docs/Gemfile

@@ -1,2 +1,4 @@
-gem 'github-pages'
-gem 'jekyll-redirect-from'
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "github-pages"