yousty-activeadmin 1.0.4.pre → 1.0.5.pre

data/docs/1-general-configuration.md

@@ -8,7 +8,7 @@ Here are a few common configurations:
 Active Admin requires two settings to authenticate and use the current user
 within your application.
 
-+ the method controllers use to force authentication
++ the method controllers used to force authentication
 
 ```ruby
 config.authentication_method = :authenticate_admin_user!
@@ -36,14 +36,17 @@ If you want, you can customize it.
 config.site_title       = "My Admin Site"
 config.site_title_link  = "/"
 config.site_title_image = "site_image.png"
+config.site_title_image = "http://www.google.com/images/logos/google_logo_41.png"
+config.site_title_image = ->(context) { context.current_user.company.logo_url }
 ```
 
 ## 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)
+[config/locales/en.yml](https://github.com/activeadmin/activeadmin/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)
+so feel free to [contribute](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md)!
+To translate third party gems like devise, use for example devise-i18n.
 
 ## Namespaces
 
@@ -101,13 +104,13 @@ undesired. To disable comments:
 ```ruby
 # For the entire application:
 ActiveAdmin.setup do |config|
-  config.allow_comments = false
+  config.comments = false
 end
 
 # For a namespace:
 ActiveAdmin.setup do |config|
   config.namespace :admin do |admin|
-    admin.allow_comments = false
+    admin.comments = false
   end
 end
 

data/docs/10-custom-pages.md

@@ -1,98 +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.
+If you have data you want on a standalone page that isn't tied to a resource,
+custom pages provide you with a familiar syntax and feature set:
 
-## Available Features
-* main page content
-* menu item
+* a menu item
 * sidebars
-* action_items
-* page_actions
+* 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
+Creating a page is as simple as calling `register_page`:
+
+```ruby
+# app/admin/calendar.rb
+ActiveAdmin.register_page "Calendar" do
+  content do
+    para "Hello World"
+  end
+end
+```
+
+Anything rendered within `content` will be the main content on the page.
+Partials behave exactly the same way as they do for resources:
+
+```ruby
+# app/admin/calendar.rb
+ActiveAdmin.register_page "Calendar" do
+  content do
+    render partial: 'calendar'
+  end
+end
+
+# app/views/admin/calendar/_calendar.html.arb
+table do
+  thead do
+    tr do
+      %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday].each &method(:th)
     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...
+  end
+  tbody do
+    # ...
+  end
+end
+```
 
 ## 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.
+See the [Menu](2-resource-customization.md#customize-the-menu) documentation.
 
-## Add a Sidebar Section
+## Customize the Namespace
 
-You can add sidebar sections to your pages using the same DSL as other resources
-in Active Admin:
+We use the `admin` namespace by default, but you can use anything:
 
-    ActiveAdmin.register_page "My Page" do
+```ruby
+# Available at /today/calendar
+ActiveAdmin.register_page "Calendar", namespace: :today
 
-      sidebar :help do
-        ul do
-          li "First Line of Help"
-        end
-      end
+# Available at /calendar
+ActiveAdmin.register_page "Calendar", namespace: false
+```
 
-      content do
-        para "Hello World"
-      end
-    end
+## Add a Sidebar
 
-This creates a sidebar section named "Help" containing an unordered list.
-To view the full customization options, visit [Sidebars](7-sidebars.md).
+See the [Sidebars](7-sidebars.md) documentation.
 
 ## Add an Action Item
 
-Just like other resources, you can add Action Item's to pages:
-
-    ActiveAdmin.register_page "My Page" do
+Just like other resources, you can add action items. The difference here being that
+`:only` and `:except` don't apply because there's only one page it could apply to.
 
-      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.
+```ruby
+action_item :view_site do
+  link_to "View Site", "/"
+end
+```
 
 ## Add a Page Action
 
-`page_action` allows you to define controller actions specific to this page,
-and is the functional equivalent of `collection_action`.
+Page actions are custom controller actions (which mirror the resource DSL for the same feature).
 
-    ActiveAdmin.register_page "My Page" do
+```ruby
+page_action :add_event, method: :post do
+  # ...
+  redirect_to admin_calendar_path, notice: "Your event was added"
+end
 
-      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
+action_item :add do
+  link_to "Add Event", admin_calendar_add_event_path, method: :post
+end
+```
 
-This defines the route `/admin/my_page/ex` which can handle HTTP POST requests.
+This defines the route `/admin/calendar/add_event` which can handle HTTP POST requests.
 
-Clicking on the `action_item` will reload page with the message "You did stuff!"
+Clicking on the action item will reload page and display the message "Your event was added"

data/docs/11-decorators.md

@@ -1,66 +1,55 @@
 # 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
+Active Admin allows you to use the decorator pattern to provide view-specific
+versions of a resource. [Draper](https://github.com/drapergem/draper) is
+recommended but not required.
+
+To use decorator support without Draper, your decorator must support a variety
+of collection methods to support pagination, filtering, etc. See
+[this github issue discussion](https://github.com/activeadmin/activeadmin/issues/3600)
+and [this gem](https://github.com/kiote/activeadmin-poro-decorator) for more details.
+
+## Example usage
+
+```ruby
+# app/models/post.rb
+class Post < ActiveRecord::Base
+  # has title, content, and image_url
+end
+
+# app/decorators/post_decorator.rb
+class PostDecorator < Draper::Decorator
+  delegate_all
+
+  def image
+    h.image_tag model.image_url
+  end
+end
+
+# app/admin/post.rb
+ActiveAdmin.register Post do
+  decorate_with PostDecorator
+
+  index do
+    column :title
+    column :image
+    actions
+  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
+By default, ActiveAdmin does *not* decorate the resource used to render forms.
+If you need ActiveAdmin to decorate the forms, you can pass `decorate: true` to the
+form block.
 
-      form decorate: false do
-        # ...
-      end
-    end
+```ruby
+ActiveAdmin.register Post do
+  decorate_with PostDecorator
 
+  form decorate: true do |f|
+    # ...
+  end
+end
+```

data/docs/12-arbre-components.md

@@ -10,19 +10,23 @@ 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 } )
+```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
 
@@ -30,19 +34,19 @@ 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
+This will create two stacked panels:
 
-      panel "Post Details" do
-        render partial: "show_details", locals: {post: post}
-      end
-
-      panel "Post Tags" do
-        render partial: "show_enhancements", locals: {post: post}
-      end
+```ruby
+show do
+  panel "Post Details" do
+    render partial: "details", locals: {post: post}
+  end
 
-    end
+  panel "Post Tags" do
+    render partial: "tags",    locals: {post: post}
+  end
+end
+```
 
 ## Columns
 
@@ -52,34 +56,36 @@ the rest.
 
 #### Simple Columns
 
-To create simple columnns, use the #columns method. Within the block, call
+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
+```ruby
+columns do
+  column do
+    span "Column #1"
+  end
 
-    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
+```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.
@@ -89,16 +95,18 @@ the first being twice as large as the second.
 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
+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.
@@ -106,39 +114,37 @@ 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
+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
+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>
+```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
+# => <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>
+status_tag 'active', :ok, class: 'important', id: 'status_123', label: 'on'
+# => <span class='status_tag active ok important' id='status_123'>on</span>
+```