activeadministration 0.0.1

data/docs/12-arbre-components.md

@@ -0,0 +1,150 @@
+# 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 "&nbsp".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 columnns, 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.
+
+## 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.
+
+## 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", a type, which defaults to nil, 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', :ok
+# => <span class='status_tag active ok'>Active</span>
+
+status_tag 'active', :ok, class: 'important', id: 'status_123', label: 'on'
+# => <span class='status_tag active ok important' id='status_123'>on</span>
+```

data/docs/13-authorization-adapter.md

@@ -0,0 +1,239 @@
+# Authorization Adapter
+
+Active Admin offers the ability to define and use your own authorization
+adapter. If implemented, the '#authorized?' will be called when an action is
+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:
+
+    # app/models/only_authors_authorization.rb
+    class OnlyAuthorsAuthorization < ActiveAdmin::AuthorizationAdapter
+
+        def authorized?(action, subject = nil)
+          case subject
+          when normalized(Post)
+
+            # Only let the author update and delete posts
+            if action == :update || action == :destroy
+              subject.author == user
+
+            # If it's not an update or destroy, anyone can view it
+            else
+              true
+            end
+
+          else
+            true
+          end
+        end
+
+    end
+
+In order to hook up `OnlyAuthorsAuthorization` to Active Admin, go to your
+application's `config/initializers/active_admin.rb` and add/modify the line:
+
+    config.authorization_adapter = "OnlyAuthorsAuthorization"
+
+Authorization adapters can be configured per ActiveAdmin namespace as well, for example:
+
+    ActiveAdmin.setup do |config|
+      config.namespace :admin do |ns|
+        ns.authorization_adapter = "AdminAuthorization"
+      end
+      config.namespace :my do |ns|
+        ns.authorization_adapter = "DashboardAuthorization"
+      end
+    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
+retrieve the current user.
+
+    class OnlyAdmins < ActiveAdmin::AuthorizationAdapter
+
+      def authorized?(action, subject = nil)
+        user.admin?
+      end
+
+    end
+
+
+## Scoping Collections in Authorization Adapters
+
+`ActiveAdmin::AuthorizationAdapter` also provides a hook method (`#scope_collection`)
+for the adapter to scope the resource's collection. For example, you may want to
+centralize the scoping:
+
+    class OnlyMyAccount < ActiveAdmin::AuthorizationAdapter
+
+      def authorized?(action, subject = nil)
+        subject.account == user.account
+      end
+
+      def scope_collection(collection, action = Auth::READ)
+        collection.where(:account_id => user.account_id)
+      end
+
+    end
+
+All collections presented on Index Screens will be passed through this method
+and will be scoped accordingly.
+
+
+## Managing Access to Pages
+
+Pages, just like resources, get authorized also. When authorization a page, the
+subject will be an instance of `ActiveAdmin::Page`.
+
+    class OnlyDashboard < ActiveAdmin::AuthorizationAdapter
+      def authorized?(action, subject = nil)
+        case subject
+        when ActiveAdmin::Page
+          if action == :read && subject.name == "Dashboard"
+            true
+          else
+            false
+          end
+        else
+          false
+        end
+      end
+    end
+
+
+## Action Types
+
+By default Active Admin simplifies the controller actions into 4 actions:
+
+  * `:read` - This controls if the user can view the menu item as well as the
+    index and show screens.
+  * `:create` - This controls if the user can view the new screen and submit
+    the form to the create action.
+  * `:update` - This controls if the user can view the edit screen and submit
+    the form to the update action.
+  * `:destroy` - This controls if the user can delete a resource.
+
+Each of these actions is available as a constant. Eg: `:read` is available as
+`ActiveAdmin::Authorization::READ`.
+
+
+## Checking for Authorization in Controllers and Views
+
+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.
+
+    ActiveAdmin.register Post do
+
+      index do
+        column :title
+        column "" do |post|
+          if authorized?(:update, post)
+            link_to("Edit", admin_post_path(post))
+          end
+        end
+
+      end
+
+    end
+
+If you are implementing a custom controller action, you can use the
+`#authorize!` method to raise an `ActiveAdmin::AccessDenied` exception.
+
+    ActiveAdmin.register Post do
+
+      member_action :publish, :method => :post do
+        post = Post.find(params[:id])
+
+        authorize! :publish, post
+        post.publish!
+
+        flash[:notice] = "Post has been published"
+        redirect_to [:admin, post]
+      end
+
+      action_item :only => :show do
+        if !post.published? && authorized?(:publish, post)
+          link_to("Publish", publish_admin_post_path(post), :method => :post)
+        end
+      end
+
+    end
+
+
+## Using the CanCan Adapter
+
+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).
+
+To use the CanCan adapter, simply update the configuration in the Active Admin
+initializer:
+
+    config.authorization_adapter = ActiveAdmin::CanCanAdapter
+    
+You can also specify a method to be called on unauthorized access. This is necessary
+in order to prevent a redirect loop that can happen if a user tries to access a page
+they don't have permissions for (see [#2081](https://github.com/gregbell/active_admin/issues/2081)).
+```ruby
+config.on_unauthorized_access = :access_denied
+```    
+The method `access_denied` would be defined in `application_controller.rb`. Here is one
+example that redirects the user from the page they don't have permission to
+access to a resource they have permission to access (organizations in this case), and
+also displays the error message in the browser:
+
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  
+  def access_denied(exception)
+    redirect_to admin_organizations_path, :alert => exception.message
+  end
+end
+```
+
+By default this will use the ability class named "Ability". This can also be
+changed from the initializer:
+
+    config.cancan_ability_class = "MyCustomAbility"
+
+Now you can simply use CanCan the way that you would expect and Active Admin
+will use it for authorization:
+
+    # app/models/ability.rb
+    class Ability
+      include CanCan::Ability
+
+      def initialize(user)
+        can :manage, Post
+        can :read, User
+        can :manage, User, :id => user.id
+        can :read, ActiveAdmin::Page, :name => "Dashboard"
+      end
+
+    end
+
+To view more details about the CanCan API, visit [https://github.com/ryanb/cancan](https://github.com/ryanb/cancan).
+
+## Using the Pundit Adapter
+
+Active Admin provides an adapter out of the box also for [Pundit](https://github.com/elabs/pundit).
+
+To use the Pundit adapter, simply update the configuration in the Active Admin
+initializer:
+
+    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 policy](spec/support/templates/policies/application_policy.rb) in your application instead of default one generated by Pundit's `rails g pundit:install` command.
+

data/docs/2-resource-customization.md

@@ -0,0 +1,359 @@
+# Working with Resources
+
+Every Active Admin resource corresponds to a Rails model. So before creating a
+resource you must first create a Rails model for it.
+
+## Create a Resource
+
+The basic command for creating a resource is `rails g active_admin:resource Post`.
+The generator will produce an empty `app/admin/post.rb` file like so:
+
+```ruby
+ActiveAdmin.register Post do
+  # everything happens here :D
+end
+```
+
+## Setting up Strong Parameters
+
+Rails 4 replaces `attr_accessible` with [Strong Parameters](https://github.com/rails/strong_parameters),
+which moves attribute whitelisting from the model to the controller.
+
+Use the `permit_params` method to define which attributes may be changed:
+
+```ruby
+ActiveAdmin.register Post do
+  permit_params :title, :content, :publisher_id
+end
+```
+
+For nested associations in your form, this is how you define their attributes:
+
+```ruby
+ActiveAdmin.register Post do
+  permit_params :title, :content, :publisher_id,
+    tags_attributes: [:id, :name, :description, :_destroy]
+end
+
+# Note that `accepts_nested_attributes_for` is still required:
+class Post < ActiveRecord::Base
+  accepts_nested_attributes_for :tags, allow_destroy: true
+end
+```
+
+If you want to dynamically choose which attributes can be set, pass a block:
+
+```ruby
+ActiveAdmin.register Post do
+  permit_params do
+    params = [:title, :content, :publisher_id]
+    params.push :author_id if current_user.admin?
+    params
+  end
+end
+```
+
+## Disabling Actions on a Resource
+
+All CRUD actions are enabled by default. These can be disabled for a given resource:
+
+```ruby
+ActiveAdmin.register Post do
+  actions :all, except: [:update, :destroy]
+end
+```
+
+## Rename the Resource
+
+By default, any references to the resource (menu, routes, buttons, etc) in the
+interface will use the name of the class. You can rename the resource by using
+the `:as` option.
+
+```ruby
+ActiveAdmin.register Post, as: "Article"
+```
+
+The resource will then be available at `/admin/articles`.
+
+## Customize the Namespace
+
+We use the `admin` namespace by default, but you can use anything:
+
+```ruby
+# Available at /today/posts
+ActiveAdmin.register Post, namespace: :today
+
+# Available at /posts
+ActiveAdmin.register Post, namespace: false
+```
+
+## Customize the Menu
+
+The resource will be displayed in the global navigation by default. To disable
+the resource from being displayed in the global navigation:
+
+```ruby
+ActiveAdmin.register Post do
+  menu false
+end
+```
+
+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
+* `: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`
+
+### Labels
+
+To change the name of the label in the menu:
+
+```ruby
+ActiveAdmin.register Post do
+  menu label: "My Posts"
+end
+```
+
+If you want something more dynamic, pass a proc instead:
+
+```ruby
+ActiveAdmin.register Post do
+  menu label: proc{ I18n.t "mypost" }
+end
+```
+
+### Menu Priority
+
+Menu items are sorted first by their numeric priority, then alphabetically. Since
+every menu by default has a priority of `10`, the menu is normally alphabetical.
+
+You can easily customize this:
+
+```ruby
+ActiveAdmin.register Post do
+  menu priority: 1 # so it's on the very left
+end
+```
+
+### Conditionally Showing / Hiding Menu Items
+
+Menu items can be shown or hidden at runtime using the `:if` option.
+```ruby
+ActiveAdmin.register Post do
+  menu if: proc{ current_user.can_edit_posts? }
+end
+```
+
+The proc will be called in the context of the view, so you have access to all
+your helpers and current user session information.
+
+### Drop Down Menus
+
+In many cases, a single level navigation will not be enough to manage a large
+application. In that case, you can group your menu items under a parent menu item.
+
+```ruby
+ActiveAdmin.register Post do
+  menu parent: "Blog"
+end
+```
+
+Note that the "Blog" parent menu item doesn't even have to exist yet; it can be
+dynamically generated for you.
+
+### Customizing Parent Menu Items
+
+All of the options given to a standard menu item are also available to
+parent menu items. In the case of complex parent menu items, you should
+configure them in the Active Admin initializer.
+
+```ruby
+# config/initializers/active_admin.rb
+config.namespace :admin do |admin|
+  admin.build_menu do |menu|
+    menu.add label: 'Blog', priority: 0
+  end
+end
+
+# app/admin/post.rb
+ActiveAdmin.register Post do
+  menu parent: 'Blog'
+end
+```
+
+### Dynamic Parent Menu Items
+
+While the above works fine, what if you want a parent menu item with a dynamic
+name? Well, you have to refer to it by its `:id`.
+
+```ruby
+# config/initializers/active_admin.rb
+config.namespace :admin do |admin
+  admin.build_menu do |menu|
+    menu.add id: 'blog', label: proc{"Something dynamic"}, priority: 0
+  end
+end
+
+# app/admin/post.rb
+ActiveAdmin.register Post do
+  menu parent: 'blog'
+end
+```
+
+### Adding Custom Menu Items
+
+Sometimes it's not enough to just customize the menu label. In this case, you
+can customize the menu for the namespace within the Active Admin initializer.
+
+```ruby
+# config/initializers/active_admin.rb
+config.namespace :admin do |admin|
+  admin.build_menu do |menu|
+    menu.add label: "The Application", url: "/", priority: 0
+
+    menu.add label: "Sites" do |sites|
+      sites.add label: "Google",   url: "http://google.com", html_options: { target: :blank }
+      sites.add label: "Facebook", url: "http://facebook.com"
+      sites.add label: "Github",   url: "http://github.com"
+    end
+  end
+end
+```
+
+This will be registered on application start before your resources are loaded.
+
+## Scoping the queries
+
+If your administrators have different access levels, you may sometimes want to
+scope what they have access to. Assuming your User model has the proper
+has_many relationships, you can simply scope the listings and finders like so:
+
+```ruby
+ActiveAdmin.register Post do
+  scope_to :current_user # limits the accessible posts to `current_user.posts`
+
+  # Or if the association doesn't have the default name:
+  scope_to :current_user, association_method: :blog_posts
+
+  # Finally, you can pass a block to be called:
+  scope_to do
+    User.most_popular_posts
+  end
+end
+```
+
+You can also conditionally apply the scope:
+
+```ruby
+ActiveAdmin.register Post do
+  scope_to :current_user, if:     proc{ current_user.limited_access? }
+  scope_to :current_user, unless: proc{ current_user.admin? }
+end
+```
+
+## Customizing resource retrieval
+
+A common way to increase page performance is to elimate N+1 queries by eager loading associations:
+
+```ruby
+ActiveAdmin.register Post do
+  controller do
+    def scoped_collection
+      super.includes :author, :categories
+    end
+  end
+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 on the controller:
+
+```ruby
+ActiveAdmin.register Post do
+  controller do
+    def find_resource
+      Post.where(id: params[:id]).first!
+    end
+  end
+end
+```
+
+Our controllers are built on [Inherited Resources](https://github.com/josevalim/inherited_resources),
+so you can use [all of its features](https://github.com/josevalim/inherited_resources#overwriting-defaults).
+
+## Belongs To
+
+It's common to want to scope a series of resources to a relationship. For
+example a Project may have many Milestones and Tickets. To nest the resource
+within another, you can use the `belongs_to` method:
+
+```ruby
+ActiveAdmin.register Project
+ActiveAdmin.register Ticket do
+  belongs_to :project
+end
+```
+
+Projects will be available as usual and tickets will be availble by visiting
+`/admin/projects/1/tickets` assuming that a Project with the id of 1 exists.
+Active Admin does not add "Tickets" to the global navigation because the routes
+can only be generated when there is a project id.
+
+To create links to the resource, you can add them to a sidebar (one of the many
+possibilities for how you may with to handle your user interface):
+
+```ruby
+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)
+    end
+  end
+end
+
+ActiveAdmin.register Ticket do
+  belongs_to :project
+end
+
+ActiveAdmin.register Milestone do
+  belongs_to :project
+end
+```
+
+In some cases (like Projects), there are many sub resources and you would
+actually like the global navigation to switch when the user navigates "into" a
+project. To accomplish this, Active Admin stores the `belongs_to` resources in a
+seperate menu which you can use if you so wish. To use:
+
+```ruby
+ActiveAdmin.register Ticket do
+  belongs_to :project
+  navigation_menu :project
+end
+
+ActiveAdmin.register Milestone do
+  belongs_to :project
+  navigation_menu :project
+end
+```
+
+Now, when you navigate to the tickets section, the global navigation will
+only display "Tickets" and "Milestones". When you navigate back to a
+non-belongs_to resource, it will switch back to the default menu.
+
+You can also defer the menu lookup until runtime so that you can dynamically show
+different menus, say perhaps based on user permissions. For example:
+
+```ruby
+ActiveAdmin.register Ticket do
+  belongs_to: :project
+  navigation_menu do
+    authorized?(:manage, SomeResource) ? :project : :restricted_menu
+  end
+end
+```