Merge branch 'deprecate-dashboards'

Conflicts:
	features/support/env.rb

Author: gregbell

cucumber.yml

@@ -1,3 +1,3 @@
-default: --format 'progress' --require features/support/env.rb --require features/step_definitions features --tags ~@requires-reloading
+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

features/dashboard.feature

@@ -1,17 +1,35 @@
 Feature: Dashboard
 
-  Background:
+  @dashboard
+  Scenario: With default configuration
+    Given a configuration of:
+      """
+      ActiveAdmin.register_page "Dashboard" do
+        content do
+          para "Hello world from the dashboard page"
+        end
+      end
+      """
     Given I am logged in
+    When I go to the dashboard
+    Then I should see the Active Admin layout
+    And I should not see the default welcome message
+    And I should see "Hello world from the dashboard page"
 
-
-  Scenario: With no configuration
+  @dashboard
+  Scenario: DEPRECATED - With default configuration
     Given a configuration of:
       """
+        ActiveAdmin::Dashboards.build do
+        end
       """
+    Given I am logged in
     When I go to the dashboard
-    Then I should see the default welcome message
+    Then I should see the Active Admin layout
+    And I should see the default welcome message
 
-  Scenario: Displaying a dashboard widget
+  @dashboard
+  Scenario: DEPRECATED - Displaying a dashboard widget
     Given a configuration of:
       """
       ActiveAdmin::Dashboards.build do
@@ -20,12 +38,15 @@ Feature: Dashboard
         end
       end
       """
+    Given I am logged in
     When I go to the dashboard
-    Then I should not see the default welcome message
+    Then I should see the Active Admin layout
+    And I should not see the default welcome message
     And I should see a dashboard widget "Hello World"
     And I should see "Hello world from the content"
 
-  Scenario: Displaying a dashboard widget using the ':if' option
+  @dashboard
+  Scenario: DEPRECATED - Displaying a dashboard widget using the ':if' option
     Given a configuration of:
       """
       ActiveAdmin::Dashboards.build do
@@ -38,7 +59,9 @@ Feature: Dashboard
         end
       end
       """
+    Given I am logged in
     When I go to the dashboard
-    Then I should not see the default welcome message
+    Then I should see the Active Admin layout
+    And I should not see the default welcome message
     And I should see a dashboard widget "Hello World"
     And I should not see a dashboard widget "Hidden by If"

features/i18n.feature

@@ -27,9 +27,9 @@ Feature: Internationalization
     When I set my locale to "fr"
     And I go to the dashboard
     Then I should see "Store"
-    And I should see "Tableau de Bord"
+    Then I should see "Déconnexion"
 
     When I set my locale to "en"
     And I go to the dashboard
     Then I should see "Bookstore"
-    And I should see "Dashboard"
+    Then I should see "Logout"

features/root_to.feature

@@ -0,0 +1,17 @@
+Feature: Namespace root
+
+  As a developer
+  In order to customize the welcome page
+  I want to set it in the configuration
+
+  Scenario: Default root is the Dashboard
+    Given I am logged in
+    Then I should be on the dashboard
+
+  Scenario: Set root to "stores#index"
+    Given a configuration of:
+    """
+      ActiveAdmin.application.root_to = 'stores#index'
+    """
+    Given I am logged in
+    Then I should see the page title "Bookstores"

features/support/env.rb

@@ -4,19 +4,18 @@
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
 
+ENV["RAILS_ENV"] ||= "cucumber"
 ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../Gemfile', __FILE__)
+require "rubygems"
+require "bundler"
+Bundler.setup
 
 require File.expand_path('../../../spec/support/detect_rails_version', __FILE__)
 ENV["RAILS"] = detect_rails_version
 
-ENV["RAILS_ENV"] ||= "cucumber"
 ENV['RAILS_ROOT'] = File.expand_path("../../../spec/rails/rails-#{ENV["RAILS"]}", __FILE__)
 
 
-require 'rubygems'
-require "bundler"
-Bundler.setup
-
 # Create the test app if it doesn't exists
 unless File.exists?(ENV['RAILS_ROOT'])
   system 'rake setup'
@@ -79,30 +78,58 @@
   end
 end
 
-# Create the test app if it doesn't exists
-unless File.exists?(ENV['RAILS_ROOT'])
-  system 'rake setup'  
+def add_default_dashboard
+  begin
+    dashboard_file = ENV['RAILS_ROOT'] + "/app/admin/dashboard.rb"
+    dashboard_template = File.expand_path('../../../lib/generators/active_admin/install/templates/dashboard.rb', __FILE__)
+    cmd = "cp #{dashboard_template} #{dashboard_file}"
+    system cmd
+  rescue
+    p $!
+    raise $!
+  end
 end
 
-# Remove all our constants
-Before do
-  # We are cachine classes, but need to manually clear references to
-  # the controllers. If they aren't clear, the router stores references
-  ActiveSupport::Dependencies.clear
-
-  # Reload Active Admin
-  ActiveAdmin.unload!
-  ActiveAdmin.load!
+def delete_default_dashboard
+  begin
+    dashboard_file = ENV['RAILS_ROOT'] + "/app/admin/dashboard.rb"
+    File.delete(dashboard_file) if File.exists?(dashboard_file)
+  rescue
+    p $!
+    raise $!
+  end
 end
 
 # Warden helpers to speed up login
 # See https://github.com/plataformatec/devise/wiki/How-To:-Test-with-Capybara
 include Warden::Test::Helpers
 
 After do
+  add_default_dashboard
   Warden.test_reset!
 end
 
+Before '@dashboard' do
+  delete_default_dashboard
+end
+
+Before do
+  add_default_dashboard
+
+  begin
+    # We are caching classes, but need to manually clear references to
+    # the controllers. If they aren't clear, the router stores references
+    ActiveSupport::Dependencies.clear
+
+    # Reload Active Admin
+    ActiveAdmin.unload!
+    ActiveAdmin.load!
+  rescue
+    p $!
+    raise $!
+  end
+end
+
 # improve the performance of the specs suite by not logging anything
 # see http://blog.plataformatec.com.br/2011/12/three-tips-to-improve-the-performance-of-your-test-suite/
 Rails.logger.level = 4

features/users/logging_out.feature

@@ -21,4 +21,5 @@ Feature: User Logging out
       """
     And I am logged in
     When I go to the dashboard
-    Then I should see the default welcome message
+    And I follow "Logout"
+    Then I should see "Login"

lib/active_admin/application.rb

@@ -60,6 +60,9 @@ def self.inheritable_setting(name, default)
     # Whether the batch actions are enabled or not
     inheritable_setting :batch_actions, true
 
+    # The namespace root.
+    inheritable_setting :root_to, 'dashboard#index'
+
     # Active Admin makes educated guesses when displaying objects, this is
     # the list of methods it tries calling in order
     setting :display_name_methods, [ :display_name,

lib/active_admin/dashboards.rb

@@ -1,9 +1,9 @@
+require 'active_admin/dashboards/dashboard_controller'
+require 'active_admin/dashboards/section'
+
 module ActiveAdmin
   module Dashboards
 
-    autoload :DashboardController,  'active_admin/dashboards/dashboard_controller'
-    autoload :Section,              'active_admin/dashboards/section'
-
     @@sections = {}
     mattr_accessor :sections
 
@@ -21,9 +21,15 @@ class << self
       #   end
       #
       def build(&block)
+        warn "DEPRECATION WARNING: ActiveAdmin::Dashboard is deprecated and will be removed in the next version"
+        @built = true
         module_eval(&block)
       end
 
+      def built?
+        !!@built
+      end
+
       # Add a new dashboard section to a namespace. If no namespace is given
       # it will be added to the default namespace.
       #
@@ -46,7 +52,18 @@ def clear_all_sections!
         @@sections = {}
       end
 
-    end
+      # Called from MenuBuilder to register dashboard to menu.
+      def add_to_menu(namespace, menu)
+        return unless ActiveAdmin::Dashboards.built?
+
+        dashboard_path = namespace.root? ? :dashboard_path : "#{namespace.name}_dashboard_path".to_sym
 
+        item = MenuItem.new  :id => "dashboard", 
+                             :label => proc{ I18n.t("active_admin.dashboard") },
+                             :url => dashboard_path,
+                             :priority => 1
+        menu.add item
+      end
+    end
   end
 end

lib/active_admin/dashboards/dashboard_controller.rb

@@ -1,9 +1,6 @@
 module ActiveAdmin
   module Dashboards
-    class DashboardController < ResourceController
-
-      actions :index
-
+    module DashboardController
       def index
         @dashboard_sections = find_sections
         render 'active_admin/dashboard/index'
@@ -48,7 +45,6 @@ def current_menu
       def active_admin_namespace
         ActiveAdmin.application.namespace(namespace)
       end
-
     end
   end
 end

lib/active_admin/menu_builder.rb

@@ -25,7 +25,7 @@ def namespace
     def build_menu
       menu = Menu.new
 
-      add_dashboard_to_menu(menu)
+      Dashboards.add_to_menu(namespace, menu)
 
       namespace.resources.each do |resource|
         register_with_menu(menu, resource) if resource.include_in_menu?
@@ -34,16 +34,6 @@ def build_menu
       menu
     end
 
-    def add_dashboard_to_menu(menu)
-      dashboard_path = namespace.root? ? :dashboard_path : "#{@namespace.name}_dashboard_path".to_sym
-
-      item = MenuItem.new  :id => "dashboard", 
-                           :label => proc{ I18n.t("active_admin.dashboard") },
-                           :url => dashboard_path,
-                           :priority => 1
-      menu.add item
-    end
-
     # Does all the work of registernig a config with the menu system
     def register_with_menu(menu, resource)
       # The menu we're going to add this resource to