activeadmin 2.12.0 → 3.3.0

data/docs/1-general-configuration.md

@@ -1,224 +0,0 @@
----
-redirect_from: /docs/1-general-configuration.html
----
-
-# General Configuration
-
-You can configure Active Admin settings in `config/initializers/active_admin.rb`.
-Here are a few common configurations:
-
-## Authentication
-
-Active Admin requires two settings to authenticate and use the current user
-within your application.
-
-+ the method controllers used to force authentication
-
-```ruby
-config.authentication_method = :authenticate_admin_user!
-```
-
-+ the method used to access the current user
-
-```ruby
-config.current_user_method = :current_admin_user
-```
-
-Both of these settings can be set to false to turn off authentication.
-
-```ruby
-config.authentication_method = false
-config.current_user_method   = false
-```
-
-## Site Title Options
-
-Every page has what's called the site title on the left side of the menu bar.
-If you want, you can customize it.
-
-```ruby
-config.site_title       = "My Admin Site"
-config.site_title_link  = "/"
-config.site_title_image = "site_image.png"
-config.site_title_image = "http://www.google.com/images/logos/google_logo_41.png"
-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)!
-
-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
-
-Active Admin sets `:long` as default localize format for dates and times.
-If you want, you can customize it.
-
-```ruby
-config.localize_format = :short
-```
-
-## Namespaces
-
-When registering resources in Active Admin, they are loaded into a namespace.
-The default namespace is "admin".
-
-```ruby
-# app/admin/posts.rb
-ActiveAdmin.register Post do
-  # ...
-end
-```
-
-The Post resource will be loaded into the "admin" namespace and will be
-available at `/admin/posts`. Each namespace holds on to its own settings that
-inherit from the application's configuration.
-
-For example, if you have two namespaces (`:admin` and `:super_admin`) and want to
-have different site title's for each, you can use the `config.namespace(name)`
-block within the initializer file to configure them individually.
-
-```ruby
-ActiveAdmin.setup do |config|
-  config.site_title = "My Default Site Title"
-
-  config.namespace :admin do |admin|
-    admin.site_title = "Admin Site"
-  end
-
-  config.namespace :super_admin do |super_admin|
-    super_admin.site_title = "Super Admin Site"
-  end
-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.
-
-## Load paths
-
-By default Active Admin files go inside `app/admin/`. You can change this
-directory in the initializer file:
-
-```ruby
-ActiveAdmin.setup do |config|
-  config.load_paths = [File.join(Rails.root, "app", "ui")]
-end
-```
-
-## Comments
-
-By default Active Admin includes comments on resources. Sometimes, this is
-undesired. To disable comments:
-
-```ruby
-# For the entire application:
-ActiveAdmin.setup do |config|
-  config.comments = false
-end
-
-# For a namespace:
-ActiveAdmin.setup do |config|
-  config.namespace :admin do |admin|
-    admin.comments = false
-  end
-end
-
-# For a given resource:
-ActiveAdmin.register Post do
-  config.comments = false
-end
-```
-
-You can change the name under which comments are registered:
-
-```ruby
-config.comments_registration_name = 'AdminComment'
-```
-
-You can change the order for the comments and you can change the column to be
-used for ordering:
-
-```ruby
-config.comments_order = 'created_at ASC'
-```
-
-You can disable the menu item for the comments index page:
-
-```ruby
-config.comments_menu = false
-```
-
-You can customize the comment menu:
-
-```ruby
-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
-and a link to log out. However, the utility navigation is just like any other
-menu in the system; you can provide your own menu to be rendered in its place.
-
-```ruby
-ActiveAdmin.setup do |config|
-  config.namespace :admin do |admin|
-    admin.build_menu :utility_navigation do |menu|
-      menu.add label: "ActiveAdmin.info", url: "http://www.activeadmin.info",
-                                          html_options: { target: :blank }
-      admin.add_current_user_to_menu  menu
-      admin.add_logout_button_to_menu menu
-    end
-  end
-end
-```
-
-## Footer Customization
-
-By default, Active Admin displays a "Powered by ActiveAdmin" message on every
-page. You can override this message and show domain-specific messaging:
-
-```ruby
-config.footer = "MyApp Revision v1.3"
-```

data/docs/10-custom-pages.md

@@ -1,150 +0,0 @@
----
-redirect_from: /docs/10-custom-pages.html
----
-
-# Custom Pages
-
-If you have data you want on a standalone page that isn't tied to a resource,
-custom pages provide you with a familiar syntax and feature set:
-
-* a menu item
-* sidebars
-* action items
-* page actions
-
-## Create a new Page
-
-Creating a page is as simple as calling `register_page`:
-
-```ruby
-# app/admin/calendar.rb
-ActiveAdmin.register_page "Calendar" do
-  content do
-    para "Hello World"
-  end
-end
-```
-
-Anything rendered within `content` will be the main content on the page.
-Partials behave exactly the same way as they do for resources:
-
-```ruby
-# app/admin/calendar.rb
-ActiveAdmin.register_page "Calendar" do
-  content do
-    render partial: 'calendar'
-  end
-end
-
-# app/views/admin/calendar/_calendar.html.arb
-table do
-  thead do
-    tr do
-      %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday].each &method(:th)
-    end
-  end
-  tbody do
-    # ...
-  end
-end
-```
-
-## Customize the Menu
-
-See the [Menu](2-resource-customization.md#customize-the-menu) documentation.
-
-## Customize the breadcrumbs
-
-```ruby
-ActiveAdmin.register_page "Calendar" do
-  breadcrumb do
-    ['admin', 'calendar']
-  end
-end
-```
-
-## Customize the Namespace
-
-We use the `admin` namespace by default, but you can use anything:
-
-```ruby
-# Available at /today/calendar
-ActiveAdmin.register_page "Calendar", namespace: :today
-
-# Available at /calendar
-ActiveAdmin.register_page "Calendar", namespace: false
-```
-
-## Belongs To
-
-To nest the page within another resource, you can use the `belongs_to` method:
-
-```ruby
-ActiveAdmin.register Project
-ActiveAdmin.register_page "Status" do
-  belongs_to :project
-end
-```
-
-See also the [Belongs To](2-resource-customization.md#belongs-to) documentation
-and examples.
-
-## Add a Sidebar
-
-See the [Sidebars](7-sidebars.md) documentation.
-
-## Add an Action Item
-
-Just like other resources, you can add action items. The difference here being that
-`:only` and `:except` don't apply because there's only one page it could apply to.
-
-```ruby
-action_item :view_site do
-  link_to "View Site", "/"
-end
-```
-
-## Add a Page Action
-
-Page actions are custom controller actions (which mirror the resource DSL for
-the same feature).
-
-```ruby
-page_action :add_event, method: :post do
-  # ...
-  redirect_to admin_calendar_path, notice: "Your event was added"
-end
-
-action_item :add do
-  link_to "Add Event", admin_calendar_add_event_path, method: :post
-end
-```
-
-This defines the route `/admin/calendar/add_event` which can handle HTTP POST requests.
-
-Clicking on the action item will reload page and display the message "Your event
-was added"
-
-Page actions can handle multiple HTTP verbs.
-
-```ruby
-page_action :add_event, method: [:get, :post] do
-  # ...
-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

@@ -1,70 +0,0 @@
----
-redirect_from: /docs/11-decorators.html
----
-
-# Decorators
-
-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.
-
-## Example usage
-
-```ruby
-# app/models/post.rb
-class Post < ActiveRecord::Base
-  # has title, content, and image_url
-end
-
-# app/decorators/post_decorator.rb
-class PostDecorator < Draper::Decorator
-  delegate_all
-
-  def image
-    h.image_tag model.image_url
-  end
-end
-
-# app/admin/post.rb
-ActiveAdmin.register Post do
-  decorate_with PostDecorator
-
-  index do
-    column :title
-    column :image
-    actions
-  end
-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.
-If you need ActiveAdmin to decorate the forms, you can pass `decorate: true` to the
-form block.
-
-```ruby
-ActiveAdmin.register Post do
-  decorate_with PostDecorator
-
-  form decorate: true do |f|
-    # ...
-  end
-end
-```

data/docs/12-arbre-components.md

@@ -1,214 +0,0 @@
----
-redirect_from: /docs/12-arbre-components.html
----
-
-# Arbre Components
-
-Arbre allows the creation of shareable and extendable HTML components and is
-used throughout Active Admin to create view components.
-
-## Text Node
-
-Sometimes it makes sense to insert something into a registered resource like a
-non-breaking space or some text. The text_node method can be used to insert
-these elements into the page inside of other Arbre components or resource
-controller functions.
-
-```ruby
-ActiveAdmin.register Post do
-  show do
-    panel "Post Details" do
-      attributes_table_for post do
-        row :id
-        row 'Tags' do
-          post.tags.each do |tag|
-            a tag, href: admin_post_path(q: {tagged_with_contains: tag})
-            text_node " ".html_safe
-          end
-        end
-      end
-    end
-  end
-end
-```
-
-## Panels
-
-A panel is a component that takes up all available horizontal space and takes a
-title and a hash of attributes as arguments. If a sidebar is present, a panel
-will take up the remaining space.
-
-This will create two stacked panels:
-
-```ruby
-show do
-  panel "Post Details" do
-    render partial: "details", locals: {post: post}
-  end
-
-  panel "Post Tags" do
-    render partial: "tags",    locals: {post: post}
-  end
-end
-```
-
-## Columns
-
-The Columns component allows you draw content into scalable columns. All you
-need to do is define the number of columns and the component will take care of
-the rest.
-
-### Simple Columns
-
-To create simple columns, use the `columns` method. Within the block, call
-the #column method to create a new column.
-
-```ruby
-columns do
-  column do
-    span "Column #1"
-  end
-
-  column do
-    span "Column #2"
-  end
-end
-```
-
-### Spanning Multiple Columns
-
-To create columns that have multiple spans, pass the :span option to the column
-method.
-
-```ruby
-columns do
-  column span: 2 do
-    span "Column # 1"
-  end
-  column do
-    span "Column # 2"
-  end
-end
-```
-
-By default, each column spans 1 column. The above layout would have 2 columns,
-the first being twice as large as the second.
-
-### Custom Column Widths
-
-Active Admin uses a fluid width layout, causing column width to be defined
-using percentages. Due to using this style of layout, columns can shrink or
-expand past points that may not be desirable. To overcome this issue,
-columns provide `:max_width` and `:min_width` options.
-
-```ruby
-columns do
-  column max_width: "200px", min_width: "100px" do
-    span "Column # 1"
-  end
-  column do
-    span "Column # 2"
-  end
-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
-in `index_as_table`. It takes a collection and a hash of options and then
-uses `column` to build the fields to show with the table.
-
-```ruby
-table_for order.payments do
-  column(:payment_type) { |payment| payment.payment_type.titleize }
-  column "Received On",     :created_at
-  column "Details & Notes", :payment_details
-  column "Amount",          :amount_in_dollars
-end
-```
-
-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
-status. A common example of where the status tag could be useful is for orders
-that are complete or in progress. `status_tag` takes a status, like
-"In Progress", and a hash of options. The status_tag will generate HTML markup
-that Active Admin CSS uses in styling.
-
-```ruby
-status_tag 'In Progress'
-# => <span class='status_tag in_progress'>In Progress</span>
-
-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
-the one open when the page initially loads and the rest hidden. You can click
-each tab to toggle back and forth between them. Arbre supports unlimited number
-of tabs.
-
-```ruby
-tabs do
-  tab :active do
-    table_for orders.active do
-      ...
-    end
-  end
-
-  tab :inactive do
-    table_for orders.inactive do
-      ...
-    end
-  end
-end
-```