aa-rails4 0.6.0

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format 'progress' --require features/support/env.rb --require features/step_definitions features --tags ~@requires-reloading --tags ~@wip
+wip: --format 'progress' --require features/support/env.rb --require features/step_definitions features --tags @wip:3 --wip features
+class-reloading: RAILS_ENV=cucumber_with_reloading --format 'progress' --require features/support/env.rb --require features/step_definitions features --tags @requires-reloading

data/docs/0-installation.md

@@ -0,0 +1,56 @@
+# Install
+
+## Gemfile
+
+First add the gem to your Gemfile:
+
+    gem 'activeadmin'
+
+## Initialize Active Admin
+
+Use the command below to initialize Active Admin. It would also create a user model 
+ named AdminUser.
+
+    $> rails generate active_admin:install
+
+To create a user model with a different name, pass it as the last parameter:
+
+    $> rails generate active_admin:install User
+
+You could also skip the creation of this user model. But note that in this case, you
+ need to make additional changes in `config/intializers/active_admin.rb`.
+
+    $> rails generate active_admin:install --skip-users
+
+After the generator finishes, you need to migrate the database:
+
+    $> rake db:migrate
+
+## Register your models with Active Admin
+
+This creates a file in `app/admin/` to hold any resource-specific configuration.
+
+    $> rails generate active_admin:resource Post
+
+# Upgrade
+
+To upgrade Active Admin, simply update the version number in your Gemfile, then
+run the assets generator:
+
+    $> rails generate active_admin:assets
+
+This command makes sure you have all the latest assets and your installation is
+up to date. Each time you upgrade Active Admin, you should run this command.
+
+
+# Gem compatibility
+
+## will_paginate compatibility
+
+If you use `will_paginate` in your app, you need to configure an initializer for
+Kaminari to avoid conflicts. Put this in `config/initializers/kaminari.rb`
+
+
+    Kaminari.configure do |config|
+      config.page_method_name = :per_page_kaminari
+    end

data/docs/1-general-configuration.md

@@ -0,0 +1,129 @@
+# General Configuration
+
+Active Admin generates an initializer for you with sane defaults. The
+initializer can be found at `config/initializers/active_admin.rb`. For the most
+part, it is well documented. Here are a few common configurations.
+
+## Authentication
+
+Active Admin requires two settings to authenticate and use the current user
+within your application. Both are set in `config/initializers/active_admin.rb`.
+By default they are setup for use with Devise and a model named AdminUser. If
+you chose a different model name, you will need to update these settings.
+
+Set the method that controllers should call to authenticate the current user
+with:
+
+    # config/initializers/active_admin.rb
+    config.authentication_method = :authenticate_admin_user!
+
+Set the method to call within the view to access the current admin user
+
+    # config/initializers/active_admin.rb
+    config.current_user_method = :current_admin_user
+
+Both of these settings can be set to false to turn off authentication.
+
+    # Turn off authentication all together
+    config.authentication_method = false
+    config.current_user_method   = false
+
+## Site Title Options
+
+You can update the title or use an optional image in the initializer also. In addition you can set the link.  By default
+there is no link and the title is set to the name of your Rails.application class name.
+
+    # config/initializers/active_admin.rb
+    config.site_title = "My Admin Site"
+    config.site_title_link = "/"    ## Rails url helpers do not work here
+    config.site_title_image = "site_log_image.png"
+
+## Internationalization (I18n)
+
+To internationalize Active Admin or to change default strings, you can copy
+`lib/active_admin/locales/en.yml` to your application `config/locales` directory and
+change its content. You can contribute to the project with your translations too!
+
+## Namespaces
+
+When registering resources in Active Admin, they are loaded into a namespace.
+The default namespace is "admin".
+
+    # 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 configuration
+settings which inherit from the application's general configurations.
+
+For example, if you have two namespaces: `:admin` and `super_admin` and want to
+have different site title's for each namespace. You can use the
+`config.namespace(name)` block within the initializer file to configure them
+individually.
+
+    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 under '/app/admin'. You can change this
+directory in the initializer file:
+
+    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 for the entire application:
+
+    ActiveAdmin.setup do |config|
+
+      config.allow_comments = false
+
+    end
+
+If you would like to enable / disable comments for just a namespace, do the
+following:
+
+    ActiveAdmin.setup do |config|
+
+      config.namespace :admin do |admin|
+        admin.allow_comments = false
+      end
+
+    end
+
+You can also disable comments for a specific resource:
+
+    ActiveAdmin.register Post do
+      config.comments = false
+    end
+
+## Utility Navigation
+
+The "utility navigation" shown at the top right when logged in by default shows the current user email address and a link to "Log Out".  However, the utility navigation is just like any other menu in the system, so you can provide your own menu to be rendered in place if you like.
+
+    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_logout_button_to_menu menu # can also pass priority & html_options for link_to to use
+        end
+      end
+    end

data/docs/10-custom-pages.md

@@ -0,0 +1,96 @@
+# 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 a simple as calling the `register_page` method:
+
+    ActiveAdmin.register_page "My Page" do
+      content do
+        para "Hello World"
+      end
+    end
+
+In the above example, a new page will be created at `/admin/my_page` with the
+title "My Page" and the content of "Hello World". Anything rendered within
+`content` will be the main content on the page.
+
+## 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
+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
+
+### Spannig 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>