yousty-activeadmin 1.0.0.pre

data/docs/0-installation.md

@@ -0,0 +1,84 @@
+# Installation
+
+Active Admin is a Ruby Gem.
+
+```ruby
+gem 'activeadmin'
+```
+
+More accurately, it's a [Rails Engine](http://guides.rubyonrails.org/engines.html)
+that can be injected into your existing Ruby on Rails application.
+
+## Setting up Active Admin
+
+After installing the gem, you need to run the generator:
+
+```sh
+rails g active_admin:install              # creates the AdminUser class
+rails g active_admin:install User         # uses an existing class
+rails g active_admin:install --skip-users # skips user authentication entirely
+```
+
+The generator adds these core files, among others:
+
+```
+app/admin/dashboard.rb
+app/assets/javascripts/active_admin.js.coffee
+app/assets/stylesheets/active_admin.css.scss
+config/initializers/active_admin.rb
+```
+
+Now, migrate your database and start the server:
+
+```sh
+rake db:migrate
+rails server
+```
+
+Visit `http://localhost:3000/admin` and log in as the default user:
+
+* __User__: admin@example.com
+* __Password__: password
+
+Voila! You're on your brand new Active Admin dashboard.
+
+To register an existing model with Active Admin:
+
+```sh
+rails generate active_admin:resource MyModel
+```
+
+This creates a file at `app/admin/my_model.rb` to set up the UI; refresh your browser to see it.
+
+# Upgrading
+
+When upgrading to a new version, it's a good idea to check the [CHANGELOG].
+
+To update the JS & CSS assets:
+
+```sh
+rails generate active_admin:assets
+```
+
+You should also sync these files with their counterparts in the AA source code:
+
+* app/admin/dashboard.rb [~>][dashboard.rb]
+* config/initializers/active_admin.rb [~>][active_admin.rb]
+
+# Gem compatibility
+
+## will_paginate
+
+If you use `will_paginate` in your app, you need to configure an initializer for
+Kaminari to avoid conflicts.
+
+```ruby
+# config/initializers/kaminari.rb
+Kaminari.configure do |config|
+  config.page_method_name = :per_page_kaminari
+end
+```
+
+[CHANGELOG]: https://github.com/gregbell/active_admin/blob/master/CHANGELOG.md
+[dashboard.rb]: https://github.com/gregbell/active_admin/blob/master/lib/generators/active_admin/install/templates/dashboard.rb
+[active_admin.rb]: https://github.com/gregbell/active_admin/blob/master/lib/generators/active_admin/install/templates/active_admin.rb.erb

data/docs/1-general-configuration.md

@@ -0,0 +1,137 @@
+# 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 use 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"
+```
+
+## Internationalization (I18n)
+
+To translate Active Admin to a new language or customize an existing translation, you can copy
+[config/locales/en.yml](https://github.com/gregbell/active_admin/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/gregbell/active_admin/blob/master/CONTRIBUTING.md)
+
+## 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
+```
+
+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.allow_comments = false
+end
+
+# For a namespace:
+ActiveAdmin.setup do |config|
+  config.namespace :admin do |admin|
+    admin.allow_comments = false
+  end
+end
+
+# For a given resource:
+ActiveAdmin.register Post do
+  config.comments = false
+end
+```
+
+## 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
+```

data/docs/10-custom-pages.md

@@ -0,0 +1,98 @@
+# Custom Pages
+
+When you need a standalone page on your site, Custom Pages will be there with a familiar syntax to resource registration.
+
+## Available Features
+* main page content
+* menu item
+* sidebars
+* action_items
+* page_actions
+
+## Create a new Page
+
+Creating a page is as simple as calling the `register_page` method and saving it 
+under `/admin/my_page.rb`:
+
+    ActiveAdmin.register_page "My Page" do
+      content do
+        para "Hello World"
+      end
+    end
+
+In the above example, a new page with the title "My Page" and the content of 
+"Hello World" will be displayed. Anything rendered within `content` will be the 
+main content on the page. To use partials, create the folder under `app/views/admin/my_page` 
+and save your partials there. Then use `render "partial"` within `content`.
+
+## Page Title & I18n
+
+Coming soon...
+
+## Customize the Menu
+
+The menu item is available to customize just like
+[any other resource](2-resource-customization.md#customize-the-menu) in Active Admin.
+
+## Add a Sidebar Section
+
+You can add sidebar sections to your pages using the same DSL as other resources
+in Active Admin:
+
+    ActiveAdmin.register_page "My Page" do
+
+      sidebar :help do
+        ul do
+          li "First Line of Help"
+        end
+      end
+
+      content do
+        para "Hello World"
+      end
+    end
+
+This creates a sidebar section named "Help" containing an unordered list.
+To view the full customization options, visit [Sidebars](7-sidebars.md).
+
+## Add an Action Item
+
+Just like other resources, you can add Action Item's to pages:
+
+    ActiveAdmin.register_page "My Page" do
+
+      action_item do
+        link_to "View Site", "/"
+      end
+
+      content do
+        para "Hello World"
+      end
+    end
+
+This adds an action item that links to the root URL of the application.
+
+## Add a Page Action
+
+`page_action` allows you to define controller actions specific to this page,
+and is the functional equivalent of `collection_action`.
+
+    ActiveAdmin.register_page "My Page" do
+
+      page_action :ex, :method => :post do
+        # do stuff here
+        redirect_to admin_my_page_path, :notice => "You did stuff!"
+      end
+
+      action_item do
+        link_to "Do Stuff", admin_my_page_ex_path, :method => :post
+      end
+
+      content do
+        para "Hello World"
+      end
+    end
+
+This defines the route `/admin/my_page/ex` which can handle HTTP POST requests.
+
+Clicking on the `action_item` will reload page with the message "You did stuff!"

data/docs/11-decorators.md

@@ -0,0 +1,66 @@
+# Decorators
+
+Active Admin supports the use of decorators for resources. Resources will be
+decorated for the index and show blocks. The
+[draper](https://github.com/drapergem/draper) gem is recommended but not required
+(more on requirements below). Note, that Active Admin works out of the box with
+Draper `>= 1.0.0`.
+
+## Configuration
+
+    ActiveAdmin.register Post do
+      decorate_with PostDecorator
+    end
+
+## Example Usage
+
+This example uses [draper](https://github.com/drapergem/draper).
+
+    # Gemfile
+    gem 'draper', '>= 1.0.0'
+
+Assuming a post and a post decorator
+
+    class Post < ActiveRecord::Base; end
+
+    class PostDecorator < ApplicationDecorator
+      decorates :post
+
+      def image
+        h.image_tag model.image_url
+      end
+    end
+
+Then the following is possible
+
+    ActiveAdmin.register Post do
+      decorate_with PostDecorator
+
+      index do
+        column(:title)
+        column(:image)
+      end
+
+      show do
+        attributes_table do
+          row(:title)
+          row(:image)
+        end
+      end
+    end
+
+## Forms
+
+Note that the resource proveded to form_for also gets decorated.
+
+In most cases this will work as expected. However, it is possible to disable
+automatic decoration in the form with the `decorate` option:
+
+    ActiveAdmin.register Post do
+      decorate_with PostDecorator
+
+      form decorate: false do
+        # ...
+      end
+    end
+

data/docs/12-arbre-components.md

@@ -0,0 +1,144 @@
+# 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.
+
+    ActiveAdmin.register Post do
+      show do
+        panel "Post Details" do
+          row("") { post.id }
+          row("Tags") do
+            text_node link_to "#{tag}",
+              admin_post_path( q: { tagged_with_contains: tag } )
+            text_node "&nbsp".html_safe
+          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.
+
+The following code will create two stacked panels:
+
+    show do
+
+      panel "Post Details" do
+        render partial: "show_details", locals: {post: post}
+      end
+
+      panel "Post Tags" do
+        render partial: "show_enhancements", 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.
+
+    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.
+
+    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.
+
+    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. table_for takes a collection and a hash of options and then
+uses #column to build the fields to show with the table.
+
+    table_for order.payments do
+      column "Payment Type" { |payment| payment.payment_type.titleize }
+      column "Received On", :created_at
+      column "Payment Details & Notes", :payment_details
+      column "Amount" { |payment| payment.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.
+
+    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>