activeadmin 1.3.0 → 2.13.1

data/docs/1-general-configuration.md

@@ -46,13 +46,22 @@ config.site_title_image = ->(context) { context.current_user.company.logo_url }
 
 ## Internationalization (I18n)
 
+Active Admin comes with translations for a lot of
+[locales](https://github.com/activeadmin/activeadmin/blob/master/config/locales/).
+Active Admin does not provide the translations for the kaminari gem it uses for pagination,
+to get these you can use the
+[kaminari-i18n](https://github.com/tigrish/kaminari-i18n) gem.
+
 To translate Active Admin to a new language or customize an existing
 translation, you can copy
 [config/locales/en.yml](https://github.com/activeadmin/activeadmin/blob/master/config/locales/en.yml)
 to your application's `config/locales` folder and update it. We welcome
 new/updated translations, so feel free to
 [contribute](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md)!
-To translate third party gems like devise, use for example devise-i18n.
+
+When using [devise](https://github.com/plataformatec/devise) for authentication,
+you can use the [devise-i18n](https://github.com/tigrish/devise-i18n)
+gem to get the devise translations for other locales.
 
 ## Localize Format For Dates and Times
 
@@ -97,6 +106,26 @@ ActiveAdmin.setup do |config|
 end
 ```
 
+If you are creating a multi-tenant application you may want to have multiple namespaces mounted to the same path. We can do this using the `route_options` settings on the namespace
+
+```ruby
+config.namespace :site_1 do |admin|
+  admin.route_options = { path: :admin, constraints: ->(request){ request.domain == "site1.com" } }
+end
+
+config.namespace :site_2 do |admin|
+  admin.route_options = { path: :admin, constraints: ->(request){ request.domain == "site2.com" } }
+end
+```
+
+If you would like to mount the namespace to a subdomain instead of path we can use the `route_options` for this as well
+
+```ruby
+config.namespace :admin do |admin|
+  admin.route_options = { path: '', subdomain: 'admin' }
+end
+```
+
 Each setting available in the Active Admin setup block is configurable on a per
 namespace basis.
 
@@ -160,6 +189,12 @@ You can customize the comment menu:
 config.comments_menu = { parent: 'Admin', priority: 1 }
 ```
 
+Remember to indicate where to place the comments and form with:
+
+```ruby
+active_admin_comments
+```
+
 ## Utility Navigation
 
 The "utility navigation" shown at the top right normally shows the current user

data/docs/10-custom-pages.md

@@ -134,3 +134,17 @@ end
 ```
 
 See also the [Custom Actions](8-custom-actions.md#http-verbs) example.
+
+## Use custom column as id
+
+You can use custom parameter instead of id
+
+```ruby
+ActiveAdmin.register User do
+  controller do
+    defaults :finder => :find_by_name
+  end
+end
+```
+
+This defines the resource route as `/admin/users/john` if user name is john

data/docs/11-decorators.md

@@ -8,11 +8,6 @@ Active Admin allows you to use the decorator pattern to provide view-specific
 versions of a resource. [Draper](https://github.com/drapergem/draper) is
 recommended but not required.
 
-To use decorator support without Draper, your decorator must support a variety
-of collection methods to support pagination, filtering, etc. See
-[this github issue discussion](https://github.com/activeadmin/activeadmin/issues/3600)
-and [this gem](https://github.com/kiote/activeadmin-poro-decorator) for more details.
-
 ## Example usage
 
 ```ruby
@@ -42,6 +37,22 @@ ActiveAdmin.register Post do
 end
 ```
 
+You can pass any decorator class as an argument to `decorate_with`
+as long as it accepts the record to be decorated as a parameter in
+the initializer, and responds to all the necessary methods.
+
+```ruby
+# app/decorators/post_decorator.rb
+class PostDecorator
+  attr_reader :post
+  delegate_missing_to :post
+
+  def initialize(post)
+    @post = post
+  end
+end
+```
+
 ## Forms
 
 By default, ActiveAdmin does *not* decorate the resource used to render forms.

data/docs/12-arbre-components.md

@@ -115,6 +115,21 @@ end
 In the above example, the first column will not grow larger than 200px and will
 not shrink less than 100px.
 
+### Custom Column Class
+
+Pass the `:class` option to the column method to set a custom class.
+
+```ruby
+columns do
+  column class: "important" do
+    span "Column # 1"
+  end
+  column do
+    span "Column # 2"
+  end
+end
+```
+
 ## Table For
 
 Table For provides the ability to create tables like those present
@@ -130,10 +145,22 @@ table_for order.payments do
 end
 ```
 
-the `column` method can take a title as its first argument and data
+The `column` method can take a title as its first argument and data
 (`:your_method`) as its second (or first if no title provided). Column also
 takes a block.
 
+### Internationalization
+
+To customize the internationalization for the component, specify a resource to
+use for translations via the `i18n` named parameter. This is only necessary for
+non-`ActiveRecord::Relation` collections:
+
+```ruby
+table_for payments, i18n: Payment do
+  # ...
+end
+```
+
 ## Status tag
 
 Status tags provide convenient syntactic sugar for styling items that have
@@ -150,6 +177,19 @@ status_tag 'active', class: 'important', id: 'status_123', label: 'on'
 # => <span class='status_tag active important' id='status_123'>on</span>
 ```
 
+When providing a `true` or `false` value, the `status_tag` will display "Yes"
+or "No". This can be configured through the `"en.active_admin.status_tag"`
+locale.
+
+```ruby
+status_tag true
+# => <span class='status_tag yes'>Yes</span>
+```
+
+In the case that a boolean field is `nil`, it will display "No" as a default.
+But using the `"en.active_admin.status_tag.unset"` locale key, it can be
+configured to display something else.
+
 ## Tabs
 
 The Tabs component is helpful for saving page real estate. The first tab will be

data/docs/13-authorization-adapter.md

@@ -10,8 +10,8 @@ taken. By default, '#authorized?' returns true.
 
 ## Setting up your own AuthorizationAdapter
 
-Setting up your own `AuthorizationAdapter` is easy! The following example shows
-how to set up and tie your authorization adapter class to Active Admin:
+The following example shows how to set up and tie your authorization
+adapter class to Active Admin:
 
 ```ruby
 # app/models/only_authors_authorization.rb
@@ -41,6 +41,9 @@ application's `config/initializers/active_admin.rb` and add/modify the line:
 config.authorization_adapter = "OnlyAuthorsAuthorization"
 ```
 
+Now, whenever a controller action is performed, the `OnlyAuthorsAuthorization`'s
+`#authorized?` method will be called.
+
 Authorization adapters can be configured per ActiveAdmin namespace as well, for
 example:
 
@@ -55,9 +58,6 @@ ActiveAdmin.setup do |config|
 end
 ```
 
-Now, whenever a controller action is performed, the `OnlyAuthorsAuthorization`'s
-`#authorized?` method will be called.
-
 ## Getting Access to the Current User
 
 From within your authorization adapter, you can call the `#user` method to
@@ -136,7 +136,7 @@ Each of these actions is available as a constant. Eg: `:read` is available as
 Active Admin provides a helper method to check if the current user is
 authorized to perform an action on a subject.
 
-Simply use the `#authorized?(action, subject)` method to check.
+Use the `#authorized?(action, subject)` method to check.
 
 ```ruby
 ActiveAdmin.register Post do
@@ -180,10 +180,9 @@ end
 
 Sub-classing `ActiveAdmin::AuthorizationAdapter` is fairly low level. Many times
 it's nicer to have a simpler DSL for managing authorization. Active Admin
-provides an adapter out of the box for [CanCan](https://github.com/ryanb/cancan)
-and [CanCanCan](https://github.com/CanCanCommunity/cancancan).
+provides an adapter out of the box for [CanCanCan](https://github.com/CanCanCommunity/cancancan).
 
-To use the CanCan adapter, simply update the configuration in the Active Admin
+To use the CanCan adapter, update the configuration in the Active Admin
 initializer:
 
 ```ruby
@@ -221,7 +220,7 @@ changed from the initializer:
 config.cancan_ability_class = "MyCustomAbility"
 ```
 
-Now you can simply use CanCan or CanCanCan the way that you would expect and
+Now you can simply use CanCanCan the way that you would expect and
 Active Admin will use it for authorization:
 
 ```ruby
@@ -233,34 +232,54 @@ class Ability
     can :manage, Post
     can :read, User
     can :manage, User, id: user.id
-    can :read, ActiveAdmin::Page, name: "Dashboard", namespace_name: :admin
+    can :read, ActiveAdmin::Page, name: "Dashboard", namespace_name: "admin"
   end
 
 end
 ```
 
 To view more details about the API's, visit project pages of
-[CanCan](https://github.com/ryanb/cancan) and
 [CanCanCan](https://github.com/CanCanCommunity/cancancan).
 
 ## Using the Pundit Adapter
 
-Active Admin provides an adapter out of the box also for
-[Pundit](https://github.com/elabs/pundit).
+Active Admin also provides an adapter out of the box for
+[Pundit](https://github.com/varvet/pundit).
 
-To use the Pundit adapter, simply update the configuration in the Active Admin
+To use the Pundit adapter, update the configuration in the Active Admin
 initializer:
 
 ```ruby
 config.authorization_adapter = ActiveAdmin::PunditAdapter
 ```
 
-You can simply use Pundit the way that you would expect and Active Admin will
-use it for authorization. Check Pundit's documentation to [set up Pundit in your
-application](https://github.com/elabs/pundit#installation). If you want to use
-batch actions just ensure that `destroy_all?` method is defined in your policy
-class. You can use this [template
+Once that's done, Active Admin will pick up your Pundit policies, and use
+them for authorization. For more information about setting up Pundit, see
+[their documentation](https://github.com/varvet/pundit#installation).
+
+Pundit also has [verify_authorized and/or verify_policy_scoped
+methods](https://github.com/varvet/pundit#ensuring-policies-and-scopes-are-used)
+to enforce usage of `authorized` and `policy_scope`. This conflicts with Active
+Admin's authorization architecture, so if you're using those features, you'll
+want to disable them for Active Admin's controllers:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Pundit
+  after_action :verify_authorized, except: :index, unless: :active_admin_controller?
+  after_action :verify_policy_scoped, only: :index, unless: :active_admin_controller?
+
+  def active_admin_controller?
+    is_a?(ActiveAdmin::BaseController)
+  end
+end
+```
+
+If you want to use batch actions, ensure that `destroy_all?` method is defined
+in your policy class. You can use this [template
 policy](https://github.com/activeadmin/activeadmin/blob/master/spec/support/templates/policies/application_policy.rb)
-in your application instead of default one generated by Pundit's `rails g
-pundit:install` command.
+in your application instead of default one generated by Pundit's
+`rails g pundit:install` command.
 
+In addition, there are [example policies](https://github.com/activeadmin/activeadmin/tree/master/spec/support/templates/policies/active_admin)
+for restricting access to ActiveAdmin's pages and comments.

data/docs/2-resource-customization.md

@@ -116,10 +116,15 @@ config/locales/[en].yml:
 en:
   active_admin:
     resources:
-      offer:
-        new_model: 'Make an Offer'
+      offer: # Registered resource
+        new_model: 'Make an Offer' # new action item
+        edit_model: 'Change Offer' # edit action item
+        delete_model: 'Cancel Offer' # delete action item
 ```
 
+See the [default en.yml](/config/locales/en.yml) locale file for
+existing translations and examples.
+
 ## Rename the Resource
 
 By default, any references to the resource (menu, routes, buttons, etc) in the
@@ -159,7 +164,8 @@ The menu method accepts a hash with the following options:
 
 * `:label` - The string or proc label to display in the menu. If it's a proc, it
   will be called each time the menu is rendered.
-* `:parent` - The string id (or label) of the parent used for this menu
+* `:parent` - The string id (or label) of the parent used for this menu, or an array
+  of string ids (or labels) for a nested menu
 * `:if` - A block or a symbol of a method to call to decide if the menu item
   should be displayed
 * `:priority` - The integer value of the priority, which defaults to `10`
@@ -222,6 +228,14 @@ end
 Note that the "Blog" parent menu item doesn't even have to exist yet; it can be
 dynamically generated for you.
 
+To further nest an item under a submenu, provide an array of parents.
+
+```ruby
+ActiveAdmin.register Post do
+  menu parent: ["Admin", "Blog"]
+end
+```
+
 ### Customizing Parent Menu Items
 
 All of the options given to a standard menu item are also available to
@@ -320,7 +334,7 @@ end
 
 ## Eager loading
 
-A common way to increase page performance is to elimate N+1 queries by eager
+A common way to increase page performance is to eliminate N+1 queries by eager
 loading associations:
 
 ```ruby
@@ -350,7 +364,7 @@ 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
+custom `to_param` implementation in your models), override the `find_resource` method
 on the controller:
 
 ```ruby

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

@@ -30,6 +30,6 @@ The build method takes a PagePresenter object and collection of whatever you
 choose.
 
 The `index_name` class method takes no arguments and returns a string that should
-be representative of the the class name. If this method is not defined, your
+be representative of the class name. If this method is not defined, your
 index component will not be able take advantage of Active Admin's
 *multiple index pages* feature.

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

@@ -28,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-table.md

@@ -111,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
@@ -121,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
 
@@ -129,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.
 
@@ -193,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

data/docs/3-index-pages.md

@@ -212,7 +212,24 @@ end
 ```
 
 Scopes can be labelled with a translation, e.g.
-`activerecord.scopes.invoice.expired`.
+`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
 

data/docs/5-forms.md

@@ -56,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
@@ -84,6 +84,12 @@ 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
@@ -104,9 +110,10 @@ ActiveAdmin.register Post do
       end
     end
     f.inputs do
-      f.has_many :comment,
+      f.has_many :comments,
                  new_record: 'Leave Comment',
-                 allow_destroy: -> { |c| c.author?(current_admin_user) } do |b|
+                 remove_record: 'Remove Comment',
+                 allow_destroy: -> (c) { c.author?(current_admin_user) } do |b|
         b.input :body
       end
     end
@@ -116,6 +123,9 @@ 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
@@ -130,6 +140,10 @@ 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 `: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` 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.
@@ -159,13 +173,17 @@ form do |f|
 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
 ```
@@ -187,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
@@ -197,6 +215,8 @@ You can arrange content in tabs as shown below:
   end
 ```
 
+`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

data/docs/6-show-pages.md

@@ -79,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/8-custom-actions.md

@@ -62,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
@@ -146,6 +146,17 @@ action_item :super_action,
 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

@@ -154,13 +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
+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"