activeadmin 1.0.0.pre4 → 1.0.0.pre5

data/docs/0-installation.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/0-installation.html
+---
 # Installation
 
 Active Admin is a Ruby Gem.

data/docs/1-general-configuration.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/1-general-configuration.html
+---
 # General Configuration
 
 You can configure Active Admin settings in `config/initializers/active_admin.rb`.
@@ -169,3 +172,11 @@ ActiveAdmin.setup do |config|
   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,3 +1,6 @@
+---
+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,
@@ -71,6 +74,19 @@ ActiveAdmin.register_page "Calendar", namespace: :today
 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.
@@ -104,3 +120,12 @@ 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.

data/docs/11-decorators.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/11-decorators.html
+---
 # Decorators
 
 Active Admin allows you to use the decorator pattern to provide view-specific

data/docs/12-arbre-components.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/12-arbre-components.html
+---
 # Arbre Components
 
 Arbre allows the creation of shareable and extendable HTML components and is

data/docs/13-authorization-adapter.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/13-authorization-adapter.html
+---
 # Authorization Adapter
 
 Active Admin offers the ability to define and use your own authorization

data/docs/14-gotchas.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/14-gotchas.html
+---
 #Gotchas
 
 ## Security
@@ -95,6 +98,22 @@ YourModel.__elasticsearch__.search
 ```ruby
 YourModel.solr_search
 ```
+
+### Rails 5 scaffold generators
+
+Active Admin requires the `inherited_resources` gem which may break scaffolding under Rails 5 as it replaces the default scaffold generator. The solution is to configure the default controller in `config/application.rb` as outlined in [josevalim/inherited_resources#195](https://github.com/josevalim/inherited_resources/issues/195)
+
+```
+module SampleApp
+  class Application < Rails::Application
+    ...
+    config.app_generators.scaffold_controller = :scaffold_controller
+    ...
+  end
+end
+```
+
+
 ## Authentication & Application Controller
 
 The `ActiveAdmin::BaseController` inherits from the `ApplicationController`. Any authentication method(s) specified in the `ApplicationController` callbacks will be called instead of the authentication method in the active admin config file. For example, if the ApplicationController has a callback `before_action :custom_authentication_method` and the config file's authentication method is `config.authentication_method = :authenticate_active_admin_user`, then `custom_authentication_method` will be called instead of `authenticate_active_admin_user`.

data/docs/2-resource-customization.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/2-resource-customization.html
+---
 # Working with Resources
 
 Every Active Admin resource corresponds to a Rails model. So before creating a
@@ -65,6 +68,15 @@ ActiveAdmin.register Post do
 end
 ```
 
+If your resource is nested, declare `permit_params` after `belongs_to`:
+
+```ruby
+ActiveAdmin.register Post do
+  belongs_to :user
+  permit_params :title, :content, :publisher_id
+end
+```
+
 The `permit_params` call creates a method called `permitted_params`. You should use this method when overriding `create` or `update` actions:
 
 ```ruby
@@ -94,6 +106,13 @@ ActiveAdmin.register Post do
 end
 ```
 
+## Renaming Action Items
+
+One can set custom button name and page title for new, edit, and destroy actions/pages
+at the resource level by providing a resource specific translation.
+For example to change 'New Offer' to 'Make an Offer'
+set `active_admin.resources.offer.new_model`.
+
 ## Rename the Resource
 
 By default, any references to the resource (menu, routes, buttons, etc) in the
@@ -364,8 +383,8 @@ ActiveAdmin.register Project do
 
   sidebar "Project Details", only: [:show, :edit] do
     ul do
-      li link_to "Tickets",    admin_project_tickets_path(project)
-      li link_to "Milestones", admin_project_milestones_path(project)
+      li link_to "Tickets",    admin_project_tickets_path(resource)
+      li link_to "Milestones", admin_project_milestones_path(resource)
     end
   end
 end

data/docs/3-index-pages.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/3-index-pages.html
+---
 # Customizing the Index Page
 
 Filtering and listing resources is one of the most important tasks for
@@ -100,6 +103,22 @@ the collection as a proc to be called at render time.
 filter :author, as: :check_boxes, collection: proc { Author.all }
 ```
 
+To override options for string or numeric filter pass `filters` option.
+
+```ruby
+  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.
+
+For example:
+```ruby
+filter :name_equals
+# or
+filter :name_contains
+```
+
 You can change the filter label by passing a label option:
 
 ```ruby
@@ -186,6 +205,8 @@ scope "Published", if: proc { current_admin_user.can? :manage, Posts } do |posts
 end
 ```
 
+Scopes can be labelled with a translation, e.g. `activerecord.scopes.invoice.expired`.
+
 ## Index default sort order
 
 You can define the default sort order for index pages:

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

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/3-index-pages/custom-index.html
+---
 # Custom Index
 
 If the supplied Active Admin index components are insufficient for your project

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

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/3-index-pages/index-as-block.html
+---
 <!--
   WARNING: Please DO NOT edit this file! Update
   source documentation in lib/active_admin/views

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

@@ -1,3 +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

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

@@ -1,3 +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

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

@@ -1,3 +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
@@ -164,6 +167,24 @@ index do
 end
 ```
 
+## Custom sorting 
+
+It is also possible to use database specific expressions and options for sorting by column
+
+```ruby
+order_by(:title) do |order_clause|
+   if order_clause.order == 'desc'
+     [order_clause.to_sql, 'NULLS LAST'].join(' ')
+   else
+     [order_clause.to_sql, 'NULLS FIRST'].join(' ')
+   end
+end
+
+index do
+  column :title
+end
+```
+
 ## Associated Sorting
 
 You're normally able to sort columns alphabetically, but by default you
@@ -187,6 +208,7 @@ index do
 end
 ```
 
+
 ## Showing and Hiding Columns
 
 The entire index block is rendered within the context of the view, so you can

data/docs/4-csv-format.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/4-csv-format.html
+---
 # Customizing the CSV format
 
 Active Admin provides CSV file downloads on the index screen for each Resource.
@@ -39,6 +42,18 @@ config.csv_options = { col_sep: ';' }
 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
+    def csv_filename
+      'User Details.csv'
+    end
+  end
+end
+```
+
+
 ## Streaming
 
 By default Active Admin streams the CSV response to your browser as it's generated.

data/docs/5-forms.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/5-forms.html
+---
 # Forms
 
 Active Admin gives you complete control over the output of the form by creating
@@ -96,7 +99,8 @@ ActiveAdmin.register Post do
       end
     end
     f.inputs do
-      f.has_many :comment, new_record: 'Leave Comment' do |b|
+      f.has_many :comment, new_record: 'Leave Comment',
+        allow_destroy: proc { |comment| comment.author?(current_admin_user) } do |b|
         b.input :body
       end
     end
@@ -108,14 +112,14 @@ 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.
+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 `: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 
+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.

data/docs/6-show-pages.md

@@ -1,3 +1,6 @@
+---
+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.

data/docs/7-sidebars.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/7-sidebars.html
+---
 # Sidebar Sections
 
 Sidebars allow you to put whatever content you want on the side the page.

data/docs/8-custom-actions.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/8-custom-actions.html
+---
 # Custom Controller Actions
 
 Active Admin allows you to override and modify the underlying controller which

data/docs/9-batch-actions.md

@@ -1,3 +1,6 @@
+---
+redirect_from: /docs/9-batch-actions.html
+---
 # Batch Actions
 
 By default, the index page provides you a "Batch Action" to quickly delete records,
@@ -145,7 +148,7 @@ When you have dynamic form inputs you can pass a proc instead:
 
 ```ruby
 # NOTE: multi-pluck is new to Rails 4
-batch_action :doit, form: ->{{user: User.pluck(:name, :id)}} do |ids, inputs|
+batch_action :doit, form: -> { {user: User.pluck(:name, :id)} } do |ids, inputs|
   User.find(inputs[:user])
   # ...
 end

data/docs/CNAME

@@ -0,0 +1 @@
+activeadmin.info

data/docs/Gemfile

@@ -0,0 +1,2 @@
+gem 'github-pages'
+gem 'jekyll-redirect-from'

data/docs/_config.yml

@@ -0,0 +1,2 @@
+gems:
+  - jekyll-redirect-from

data/docs/_includes/footer.html

@@ -0,0 +1,8 @@
+<p id="footer">
+<div class="left">
+    Copyright 2011 <a href="http://gregbell.ca/">Greg Bell</a> and <a href="http://www.versapay.com/">VersaPay</a>
+</div>
+<div class="right">
+    <a href="http://twitter.com/share" class="twitter-share-button">Tweet</a></p>
+</div>
+</p>

data/docs/_includes/google-analytics.html

@@ -0,0 +1,16 @@
+<script type="text/javascript">
+
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', 'UA-23306458-1']);
+    _gaq.push(['_trackPageview']);
+
+    (function () {
+        var ga = document.createElement('script');
+        ga.type = 'text/javascript';
+        ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0];
+        s.parentNode.insertBefore(ga, s);
+    })();
+
+</script>

data/docs/_includes/head.html

@@ -0,0 +1,7 @@
+<head>
+    <title>Active Admin | The administration framework for Ruby on Rails</title>
+    <link href='http://fonts.googleapis.com/css?family=Yanone+Kaffeesatz:extralight,light,regular,bold' rel='stylesheet' type='text/css'>
+    <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
+    <link href="{{ site.baseurl }}/stylesheets/main.css" media="screen" rel="stylesheet" type="text/css" />
+    <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>
+</head>

data/docs/_includes/toc.html

@@ -0,0 +1,97 @@
+<ol class='level-1'>
+    <li><a href='{{ site.baseurl }}/0-installation.html'>Installation</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/0-installation.html#setting-up-active-admin'>Setting up Active Admin</a></li>
+        <li><a href='{{ site.baseurl }}/0-installation.html#upgrading'>Upgrading</a></li>
+        <li><a href='{{ site.baseurl }}/0-installation.html#gem-compatibility'>Gem Compatibility</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/1-general-configuration.html'>General Configuration</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/1-general-configuration.html#authentication'>Authentication</a></li>
+        <li><a href='{{ site.baseurl }}/1-general-configuration.html#site-title-options'>Site Title Options</a></li>
+        <li><a href='{{ site.baseurl }}/1-general-configuration.html#internationalization-(i18n)'>Internationalization (I18n)</a></li>
+        <li><a href='{{ site.baseurl }}/1-general-configuration.html#namespaces'>Namespaces</a></li>
+        <li><a href='{{ site.baseurl }}/1-general-configuration.html#load-paths'>Load paths</a></li>
+        <li><a href='{{ site.baseurl }}/1-general-configuration.html#comments'>Comments</a></li>
+        <li><a href='{{ site.baseurl }}/1-general-configuration.html#utility-navigation'>Utility Navigation</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/2-resource-customization.html'>Working with Resources</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/2-resource-customization.html#rename-the-resource'>Rename the Resource</a></li>
+        <li><a href='{{ site.baseurl }}/2-resource-customization.html#customize-the-namespace'>Customize the Namespace</a></li>
+        <li><a href='{{ site.baseurl }}/2-resource-customization.html#customize-the-menu'>Customize the Menu</a></li>
+        <li><a href='{{ site.baseurl }}/2-resource-customization.html#scoping-the-queries'>Scoping the queries</a></li>
+        <li><a href='{{ site.baseurl }}/2-resource-customization.html#customizing-resource-retrieval'>Customizing resource
+            retrieval</a></li>
+        <li><a href='{{ site.baseurl }}/2-resource-customization.html#belongs-to'>Belongs To</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/3-index-pages.html'>Customizing the Index Page</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/3-index-pages/create-an-index.html'>Create an Index</a></li>
+        <li><a href='{{ site.baseurl }}/3-index-pages/index-as-block.html'>Index as a Block</a></li>
+        <li><a href='{{ site.baseurl }}/3-index-pages/index-as-blog.html'>Index as Blog</a></li>
+        <li><a href='{{ site.baseurl }}/3-index-pages/index-as-grid.html'>Index as a Grid</a></li>
+        <li><a href='{{ site.baseurl }}/3-index-pages/index-as-table.html'>Index as a Table</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/4-csv-format.html'>Customizing the CSV format</a></li>
+    <li><a href='{{ site.baseurl }}/5-forms.html'>Customizing the Form</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/5-forms.html#default'>Default</a></li>
+        <li><a href='{{ site.baseurl }}/5-forms.html#partials'>Partials</a></li>
+        <li><a href='{{ site.baseurl }}/5-forms.html#nested-resources'>Nested Resources</a></li>
+        <li><a href='{{ site.baseurl }}/5-forms.html#datepicker'>Datepicker</a></li>
+        <li><a href='{{ site.baseurl }}/5-forms.html#displaying-errors'>Displaying Errors</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/6-show-pages.html'>Customize the Show Page</a></li>
+    <li><a href='{{ site.baseurl }}/7-sidebars.html'>Sidebar Sections</a></li>
+    <li><a href='{{ site.baseurl }}/8-custom-actions.html'>Custom Controller Actions</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/8-custom-actions.html#collection-actions'>Collection Actions</a></li>
+        <li><a href='{{ site.baseurl }}/8-custom-actions.html#member-actions'>Member Actions</a></li>
+        <li><a href='{{ site.baseurl }}/8-custom-actions.html#http-verbs'>HTTP Verbs</a></li>
+        <li><a href='{{ site.baseurl }}/8-custom-actions.html#rendering'>Rendering</a></li>
+        <li><a href='{{ site.baseurl }}/8-custom-actions.html#action-items'>Action Items</a></li>
+        <li><a href='{{ site.baseurl }}/8-custom-actions.html#modifying-the-controller'>Modifying the Controller</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/9-batch-actions.html'>Index Batch Actions</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/9-batch-actions.html#provided-batch-action'>Provided Batch Action</a></li>
+        <li><a href='{{ site.baseurl }}/9-batch-actions.html#creating-your-own'>Creating Your Own</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/10-custom-pages.html'>Custom Pages</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/10-custom-pages.html#create-a-new-page'>Create a new Page</a></li>
+        <li><a href='{{ site.baseurl }}/10-custom-pages.html#customize-the-menu'>Customize the Menu</a></li>
+        <li><a href='{{ site.baseurl }}/10-custom-pages.html#add-a-sidebar'>Add a Sidebar</a></li>
+        <li><a href='{{ site.baseurl }}/10-custom-pages.html#add-an-action-item'>Add an Action Item</a></li>
+        <li><a href='{{ site.baseurl }}/10-custom-pages.html#add-a-page-action'>Add a Page Action</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/11-decorators.html'>Decorators</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/11-decorators.html#example-usage'>Example Usage</a></li>
+        <li><a href='{{ site.baseurl }}/11-decorators.html#forms'>Forms</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/12-arbre-components.html'>Arbre Components</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/12-arbre-components.html#text-node'>Text Node</a></li>
+        <li><a href='{{ site.baseurl }}/12-arbre-components.html#panels'>Panels</a></li>
+        <li><a href='{{ site.baseurl }}/12-arbre-components.html#columns'>Columns</a></li>
+        <li><a href='{{ site.baseurl }}/12-arbre-components.html#table-for'>Table For</a></li>
+        <li><a href='{{ site.baseurl }}/12-arbre-components.html#status-tag'>Status tag</a></li>
+    </ol>
+    <li><a href='{{ site.baseurl }}/13-authorization-adapter.html'>Authorization Adapter</a></li>
+    <ol class='level-2'>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#setting-up-your-own-authorizationadapter'>Setting up your own
+            AuthorizationAdapter</a></li>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#getting-access-to-the-current-user'>Getting Access to the
+            Current User</a></li>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#scoping-collections-in-authorization-adapters'>Scoping
+            Collections in Authorization Adapters</a></li>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#managing-access-to-pages'>Managing Access to Pages</a></li>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#action-types'>Action Types</a></li>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#checking-for-authorization-in-controllers-and-views'>Checking
+            for Authorization in Controllers and Views</a></li>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#using-the-cancan-adapter'>Using the CanCan Adapter</a></li>
+        <li><a href='{{ site.baseurl }}/13-authorization-adapter.html#using-the-pundit-adapter'>Using the Pundit Adapter</a></li>
+    </ol>
+</ol>