yousty-activeadmin 1.0.0.pre

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

@@ -0,0 +1,29 @@
+<!--
+  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
+
+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.
+
+```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 columns that are rendered using the columns
+option:
+
+```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

@@ -0,0 +1,154 @@
+<!--
+  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
+
+By default, the index page is a table with each of the models content columns and links to
+show, edit and delete the object. There are many ways to customize what gets
+displayed.
+
+## Defining Columns
+
+To display an attribute or a method on a resource, simply pass a symbol into the
+column method:
+
+```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:
+
+```ruby
+:display_name, :full_name, :name, :username, :login, :title, :email, :to_s
+```
+
+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:
+
+```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.
+
+`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.
+
+```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:
+
+```ruby
+index do
+  selectable_column
+  column :title
+  actions
+end
+```
+
+You can also append custom links to the default links:
+
+```ruby
+index do
+  selectable_column
+  column :title
+  actions do |post|
+    link_to "Preview", admin_preview_post_path(post), class: "member_link"
+  end
+end
+```
+
+Or forego the default links entirely:
+
+```ruby
+index do
+  column :title
+  actions defaults: false do |post|
+    link_to "View", admin_post_path(post)
+  end
+end
+```
+
+## Sorting
+
+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.
+
+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:
+
+```ruby
+index do
+  column :title, sortable: false
+end
+```
+
+## Associated Sorting
+
+You're normally able to sort columns alphabetically, but by default you
+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:
+
+```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:
+
+```ruby
+index do
+  column :publisher, sortable: 'publishers.name'
+end
+```
+
+## Showing and Hiding Columns
+
+The entire index block is rendered within the context of the view, so you can
+easily do things that show or hide columns based on the current context.
+
+For example, if you were using CanCan:
+
+```ruby
+index do
+  column :title, sortable: false
+  column :secret_data if can? :manage, Post
+end
+```

data/docs/3-index-pages.md

@@ -0,0 +1,206 @@
+# Customizing the Index Page
+
+Filtering and listing resources is one of the most important tasks for
+administering a web application. Active Admin provides many different tools for
+you to build a compelling interface into your data for the admin staff.
+
+Built in, Active Admin has the following index renderers:
+
+* *Table*: A table drawn with each row being a resource ([View Table Docs](3-index-pages/index-as-table.md))
+* *Grid*: A set of rows and columns each cell being a resource ([View Grid Docs](3-index-pages/index-as-grid.md))
+* *Blocks*: A set of rows (not tabular) each row being a resource ([View Blocks Docs](3-index-pages/index-as-block.md))
+* *Blog*: A title and body content, similar to a blog index ([View Blog Docs](3-index-pages/index-as-blog.md))
+
+All index pages also support scopes, filters, pagination, action items, and
+sidebar sections.
+
+## Multiple Index Pages
+
+Sometime you may want more than one index page for a resource to represent
+different views to the user. If multiple index pages exist, Active Admin will
+automatically build links at the top of the default index page. Including
+multiple views is simple and requires creating multiple index components in
+your resource.
+
+```ruby
+index do
+  id_column
+  column :image_title
+  default_actions
+end
+
+index as: :grid do |product|
+  link_to image_tag(product.image_path), admin_product_path(product)
+end
+```
+
+The first index component will be the default index page unless you indicate
+otherwise by setting :default to true.
+
+```ruby
+index do
+  column :image_title
+  default_actions
+end
+
+index as: :grid, default: true do |product|
+  link_to image_tag(product.image_path), admin_product_path(product)
+end
+```
+
+Active Admin does not limit the index page to be a table, block, blog or grid.
+If you've [created your own index page](3-index-pages/create-an-index.md) it
+can be included by setting :as to the class of the index component you created.
+
+```ruby
+index as: ActiveAdmin::Views::IndexAsTable do
+  column :image_title
+  default_actions
+end
+```
+
+## Index Filters
+
+By default the index screen includes a "Filters" sidebar on the right hand side
+with a filter for each attribute of the registered model. You can customize the
+filters that are displayed as well as the type of widgets they use.
+
+To display a filter for an attribute, use the filter method
+
+```ruby
+ActiveAdmin.register Post do
+  filter :title
+end
+```
+
+Out of the box, Active Admin supports the following filter types:
+
+* *:string* - A search field
+* *: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.
+* *:select* - A drop down which filters based on a selected item in a collection
+  or all.
+* *:check_boxes* - A list of check boxes users can turn on and off to filter
+
+By default, Active Admin will pick the most relevant filter based on the
+attribute type. You can force the type by passing the :as option.
+
+```ruby
+filter :author, as: :check_boxes
+```
+
+The :check_boxes and :select types accept options for the collection. By default
+it attempts to create a collection based on an association. But you can pass in
+the collection as a proc to be called at render time.
+
+```ruby
+filter :author, as: :check_boxes, collection: proc { Author.all }
+```
+
+You can change the filter label by passing a label option:
+
+```ruby
+filter :author, label: 'Something else'
+```
+
+By default, Active Admin will try to use ActiveModel I18n to determine the label.
+
+Filters can also be disabled for a resource, a namespace or the entire
+application.
+
+To disable for a specific resource:
+
+```ruby
+ActiveAdmin.register Post do
+  config.filters = false
+end
+```
+
+To disable for a namespace, in the initializer:
+
+```ruby
+ActiveAdmin.setup do |config|
+  config.namespace :my_namespace do |my_namespace|
+    my_namespace.filters = false
+  end
+end
+```
+
+Or to disable for the entire application:
+
+```ruby
+ActiveAdmin.setup do |config|
+  config.filters = false
+end
+```
+
+You can also add a filter and still preserve the default filters:
+
+```ruby
+preserve_default_filters!
+filter :author
+```
+
+## Index default sort order
+
+You can define the default sort order for index pages:
+
+```ruby
+ActiveAdmin.register Post do
+  config.sort_order = 'name asc'
+end
+```
+
+## Index pagination
+
+You can set the number of records per page per resources:
+
+```ruby
+ActiveAdmin.register Post do
+  config.per_page = 10
+end
+```
+
+You can also disable pagination:
+
+```ruby
+ActiveAdmin.register Post do
+  config.paginate = false
+end
+```
+
+If you have a very large database, you might want to disable SELECT COUNT(*)
+queries caused by the pagination info at the bottom of the page:
+
+```ruby
+ActiveAdmin.register Post do
+  index pagination_total: false do
+    # ...
+  end
+end
+```
+
+## Customizing Download Links
+
+You can easily remove or customize the download links you want displayed:
+
+```ruby
+# Per resource:
+ActiveAdmin.register Post do
+
+  index download_links: false
+  index download_links: [:pdf]
+  index download_links: proc{ current_user.can_view_download_links? }
+
+end
+
+# For the entire application:
+ActiveAdmin.setup do |config|
+
+  config.download_links = false
+  config.download_links = [:csv, :xml, :json, :pdf]
+  config.download_links = proc { current_user.can_view_download_links? }
+
+end
+```

data/docs/4-csv-format.md

@@ -0,0 +1,39 @@
+# Customizing the CSV format
+
+Active Admin provides CSV file downloads on the index screen for each Resource.
+By default it will render a CSV file with all the content columns of your
+registered model.
+
+Customizing the CSV format is as simple as customizing the index page.
+
+```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: ';' 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

@@ -0,0 +1,110 @@
+# Customizing the Form
+
+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):
+
+```ruby
+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', :body
+    f.actions
+  end
+
+end
+```
+
+Please view [the documentation](http://github.com/justinfrench/formtastic)
+for Formtastic to see all the wonderful things you can do.
+
+If you require a more custom form than can be provided through the DSL, you can
+user a partial instead:
+
+```ruby
+ActiveAdmin.register Post do
+  form partial: 'form'
+end
+```
+
+Which looks for something like this:
+
+```erb
+<%# app/views/admin/posts/_form.html.erb %>
+<%= semantic_form_for [:admin, @post] do |f| %>
+  <%= f.inputs :title, :body %>
+  <%= f.actions do %>
+    <%= f.action :submit %>
+    <li class="cancel"><%= link_to 'Cancel', collection_path %></li>
+  <% end %>
+<% end %>
+```
+
+## Nested Resources
+
+You can create forms with nested models using the `has_many` method:
+
+```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', :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 :comment, new_record: 'Leave Comment' do |b|
+        b.input :body
+      end
+    end
+    f.actions
+  end
+
+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.
+
+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.
+
+## DatePicker
+
+ActiveAdmin offers the `datepicker` input, which uses the [jQueryUI Datepicker](http://jqueryui.com/datepicker/).
+The datepicker input accepts any of the options available to the standard
+jQueryUI Datepicker, e.g.
+
+```ruby
+form do |f|
+  f.input :starts_at, as: :datepicker, datepicker_options: { min_date: "2013-10-8", max_date: 3.days.from_now.to_date }
+  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 validation errors:
+
+```ruby
+form do |f|
+  f.semantic_errors *f.object.errors.keys
+  f.inputs
+  f.actions
+end
+```
+
+This is particularly useful to display errors on virtual or hidden attributes.

data/docs/6-show-pages.md

@@ -0,0 +1,77 @@
+# Customize the Show Page
+
+The show block is rendered within the context of the view and uses [Arbre](https://github.com/gregbell/arbre) syntax.
+
+With the `show` block, you can render anything you want.
+
+```ruby
+ActiveAdmin.register Post do
+  show do
+    h3 post.title
+    div do
+      simple_format post.body
+    end
+  end
+end
+```
+
+You can render a partial at any point:
+
+```ruby
+ActiveAdmin.register Post do
+  show do
+    # renders app/views/admin/posts/_some_partial.html.erb
+    render 'some_partial'
+  end
+end
+```
+
+If you'd like to keep the default AA look, you can use `attributes_table`:
+
+```ruby
+ActiveAdmin.register Ad do
+  show do
+    attributes_table do
+      row :title
+      row :image do
+        image_tag ad.image.url
+      end
+    end
+    active_admin_comments
+  end
+end
+```
+
+You can also customize the title of the object in the show screen:
+
+```ruby
+show title: :name do
+  # ...
+end
+```
+
+If you want a more data-dense page, you can combine a sidebar:
+
+```ruby
+ActiveAdmin.register Book do
+  show do
+    panel "Table of Contents" do
+      table_for book.chapters do
+        column :number
+        column :title
+        column :page
+      end
+    end
+    active_admin_comments
+  end
+
+  sidebar "Details", only: :show do
+    attributes_table_for book do
+      row :title
+      row :author
+      row :publisher
+      row('Published?') { |b| status_tag b.published? ? 'Yes' : 'No' }
+    end
+  end
+end
+```

data/docs/7-sidebars.md

@@ -0,0 +1,42 @@
+# Sidebar Sections
+
+To add a sidebar section to all the screen within a section, use the sidebar method:
+
+    sidebar :help do
+      "Need help? Email us at help@example.com"
+    end
+
+This will generate a sidebar on every page for that resource. The first
+argument is used as the title, and can be a symbol, string, or lambda.
+
+You can also use [Arbre](https://github.com/gregbell/arbre) to define HTML content.
+
+    sidebar :help do
+      ul do
+        li "Second List First Item"
+        li "Second List Second Item"
+      end
+    end
+
+Sidebar sections can be rendered on a specific action by using the :only or :except
+options.
+
+    sidebar :help, only: :index do
+      "Need help? Email us at help@example.com"
+    end
+
+If you want to conditionally display a sidebar section, use the :if option and
+pass it a proc which will be rendered within the context of the view.
+
+    sidebar :help, if: proc{ current_admin_user.super_admin? } do
+      "Only for super admins!"
+    end
+
+If you only pass a symbol, Active Admin will attempt to locate a partial to render.
+
+    # Will render app/views/admin/posts/_help_sidebar.html.erb
+    sidebar :help
+
+Or you can pass your own custom partial to render.
+
+    sidebar :help, partial: "custom_help_partial"