yousty-activeadmin 1.0.4.pre → 1.0.5.pre

data/docs/3-index-pages.md

@@ -26,7 +26,7 @@ your resource.
 index do
   id_column
   column :image_title
-  default_actions
+  actions
 end
 
 index as: :grid do |product|
@@ -35,12 +35,12 @@ end
 ```
 
 The first index component will be the default index page unless you indicate
-otherwise by setting :default to true.
+otherwise by setting `:default` to true.
 
 ```ruby
 index do
   column :image_title
-  default_actions
+  actions
 end
 
 index as: :grid, default: true do |product|
@@ -48,14 +48,16 @@ index as: :grid, default: true do |product|
 end
 ```
 
+## Custom Index
+
 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.
+If you've created your own [custom index](3-index-pages/custom-index.md) page it
+can be included by setting `:as` to the class of the index component you created.
 
 ```ruby
-index as: ActiveAdmin::Views::IndexAsTable do
+index as: ActiveAdmin::Views::IndexAsMyIdea do
   column :image_title
-  default_actions
+  actions
 end
 ```
 
@@ -65,7 +67,7 @@ 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
+To display a filter for an attribute, use the `filter` method
 
 ```ruby
 ActiveAdmin.register Post do
@@ -84,13 +86,13 @@ Out of the box, Active Admin supports the following filter types:
 * *: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.
+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
+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.
 
@@ -106,6 +108,14 @@ 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.
+
+```ruby
+filter :first_name_or_last_name_cont, as: :string, label: "Name"
+```
+
 Filters can also be disabled for a resource, a namespace or the entire
 application.
 
@@ -142,18 +152,53 @@ preserve_default_filters!
 filter :author
 ```
 
+## 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:
+
+```ruby
+scope :all, default: true
+
+# assumes the model has a scope called ':active'
+scope :active
+
+# renames model scope ':leaves' to ':subcategories'
+scope "Subcategories", :leaves
+
+# Dynamic scope name
+scope ->{ Date.today.strftime '%A' }, :published_today
+
+# custom scope not defined on the model
+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|
+  posts.published
+end
+```
+
 ## Index default sort order
 
 You can define the default sort order for index pages:
 
 ```ruby
 ActiveAdmin.register Post do
-  config.sort_order = 'name asc'
+  config.sort_order = 'name_asc'
 end
 ```
 
 ## Index pagination
 
+You can set the number of records per page as default:
+
+```ruby
+ActiveAdmin.setup do |config|
+  config.default_per_page = 30
+end
+```
+
 You can set the number of records per page per resources:
 
 ```ruby
@@ -162,6 +207,16 @@ ActiveAdmin.register Post do
 end
 ```
 
+You can change it per request / action too:
+
+```ruby
+controller do
+  before_filter :only => :index do
+    @per_page = 100
+  end
+end
+```
+
 You can also disable pagination:
 
 ```ruby
@@ -170,7 +225,7 @@ ActiveAdmin.register Post do
 end
 ```
 
-If you have a very large database, you might want to disable SELECT COUNT(*)
+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
@@ -204,3 +259,7 @@ 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.
+
+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

@@ -0,0 +1,31 @@
+# Custom Index
+
+If the supplied Active Admin index components are insufficient for your project
+feel free to define your own. Index classes inherit from `ActiveAdmin::Component`
+and require a `build` method and an `index_name` class method.
+
+```ruby
+module ActiveAdmin
+  module Views
+    class IndexAsMyIdea < ActiveAdmin::Component
+
+      def build(page_presenter, collection)
+        # ...
+      end
+
+      def self.index_name
+        "my_idea"
+      end
+
+    end
+  end
+end
+```
+
+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
+index component will not be able take advantage of Active Admin's
+*multiple index pages* feature.

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

@@ -72,7 +72,7 @@ index do
   selectable_column
   column :title
   actions do |post|
-    link_to "Preview", admin_preview_post_path(post), class: "member_link"
+    item "Preview", admin_preview_post_path(post), class: "member_link"
   end
 end
 ```
@@ -83,7 +83,30 @@ Or forego the default links entirely:
 index do
   column :title
   actions defaults: false do |post|
-    link_to "View", admin_post_path(post)
+    item "View", admin_post_path(post)
+  end
+end
+```
+
+Or append custom action with custom html via arbre:
+
+```ruby
+index do
+  column :title
+  actions do |post|
+    a link_to "View", admin_post_path(post)
+  end
+end
+```
+
+In case you prefer to list actions links in a dropdown menu:
+
+```ruby
+index do
+  selectable_column
+  column :title
+  actions dropdown: true do |post|
+    item "Preview", admin_preview_post_path(post)
   end
 end
 ```
@@ -116,6 +139,15 @@ index do
 end
 ```
 
+It's also possible to sort by PostgreSQL's hstore column key. You should set `sortable`
+option to a `column->'key'` value:
+
+```ruby
+index do
+  column :keywords, sortable: "meta->'keywords'"
+end
+```
+
 ## Associated Sorting
 
 You're normally able to sort columns alphabetically, but by default you
@@ -152,3 +184,14 @@ index do
   column :secret_data if can? :manage, Post
 end
 ```
+
+## Custom row class
+
+In order to add special class to table rows pass the proc object as a `:row_class` option
+of the `index` method.
+
+```ruby
+index row_class: ->elem { 'active' if elem.active? } do
+  # columns
+end
+```

data/docs/4-csv-format.md

@@ -19,7 +19,7 @@ You can also set custom CSV settings for an individual resource:
 
 ```ruby
 ActiveAdmin.register Post do
-  csv force_quotes: true, col_sep: ';' do
+  csv force_quotes: true, col_sep: ';', column_names: false do
     column :title
     column(:author) { |post| post.author.full_name }
   end

data/docs/5-forms.md

@@ -1,4 +1,4 @@
-# Customizing the Form
+# Forms
 
 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):
@@ -7,23 +7,40 @@ a thin DSL on top of [Formtastic](https://github.com/justinfrench/formtastic):
 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
+    inputs 'Details' do
+      input :title
+      input :published_at, label: "Publish Post At"
+      li "Created at #{f.object.created_at}" unless f.object.new_record?
+      input :category
     end
-    f.inputs 'Content', :body
-    f.actions
+    panel 'Markup' do
+      "The following can be used in the content below..."
+    end
+    inputs 'Content', :body
+    para "Press cancel to return to the list without saving."
+    actions
   end
 
 end
 ```
 
-Please view [the documentation](http://github.com/justinfrench/formtastic)
-for Formtastic to see all the wonderful things you can do.
+For more details, please see Formtastic's documentation.
 
-If you require a more custom form than can be provided through the DSL, you can
-user a partial instead:
+## Default
+
+Resources come with a default form defined as such:
+
+```ruby
+form do |f|
+  f.semantic_errors # shows errors on :base
+  f.inputs          # builds an input field for every attribute
+  f.actions         # adds the 'Submit' and 'Cancel' buttons
+end
+```
+
+## Partials
+
+If you want to split a custom form into a separate partial use:
 
 ```ruby
 ActiveAdmin.register Post do
@@ -33,20 +50,19 @@ 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 %>
+```ruby
+# app/views/admin/posts/_form.html.arb
+active_admin_form_for resource do |f|
+  inputs :title, :body
+  actions
+end
 ```
 
+This is a regular Rails partial so any template engine may be used.
+
 ## Nested Resources
 
-You can create forms with nested models using the `has_many` method:
+You can create forms with nested models using the `has_many` method, even if your model uses `has_one`:
 
 ```ruby
 ActiveAdmin.register Post do
@@ -62,6 +78,11 @@ ActiveAdmin.register Post do
         a.input :title
       end
     end
+    f.inputs do
+      f.has_many :taggings, sortable: :position, sortable_start: 1 do |t|
+        t.input :tag
+      end
+    end
     f.inputs do
       f.has_many :comment, new_record: 'Leave Comment' do |b|
         b.input :body
@@ -82,16 +103,20 @@ The `:heading` option adds a custom heading. You can hide it entirely by passing
 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
+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 [jQueryUI Datepicker](http://jqueryui.com/datepicker/).
-The datepicker input accepts any of the options available to the standard
-jQueryUI Datepicker, e.g.
+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: 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" }
+  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
 ```
 
@@ -102,9 +127,33 @@ 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.
+
+# Tabs
+
+You can arrage content in tabs as shown below:
+
+```ruby
+  form do |f|
+    tabs do
+      tab 'Basic' do
+        f.inputs 'Basic Details' do
+          f.input :email
+          f.input :password
+          f.input :password_confirmation
+        end
+      end
+
+      tab 'Advanced' do
+        f.inputs 'Advanced Details' do
+          f.input :role
+        end
+      end
+    end
+    f.actions
+  end
+```

data/docs/6-show-pages.md

@@ -1,6 +1,6 @@
 # Customize the Show Page
 
-The show block is rendered within the context of the view and uses [Arbre](https://github.com/gregbell/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.
 
@@ -33,7 +33,7 @@ ActiveAdmin.register Ad do
   show do
     attributes_table do
       row :title
-      row :image do
+      row :image do |ad|
         image_tag ad.image.url
       end
     end
@@ -70,8 +70,36 @@ ActiveAdmin.register Book do
       row :title
       row :author
       row :publisher
-      row('Published?') { |b| status_tag b.published? ? 'Yes' : 'No' }
+      row('Published?') { |b| status_tag b.published? }
     end
   end
 end
 ```
+
+# Tabs
+
+You can arrage content in tabs as shown below:
+
+```ruby
+  ActiveAdmin.register Order do 
+    show do
+      tabs do
+        tab 'Overview' do
+          attributes_table do
+            row(:status) { status_tag(order.status) }
+            row(:paid) { number_to_currency(order.amount_paid_in_dollars) }
+          end
+        end
+        
+        tab 'Payments' do
+          table_for order.payments do
+            column('Payment Type') { |p| p.payment_type.titleize }
+            column('Received On', :created_at)
+            column('Payment Details & Notes', :notes)
+            column('Amount') { |p| number_to_currency(p.amount_in_dollars) }
+          end
+        end
+      end
+    end
+  end
+```