Created a nicer syntax for defining many dashboard sections.

gregbell · gregbell · commit 7027cb15e752 · 2010-09-07T07:02:46.000-07:00
Example:

  ActiveAdmin::Dashboards.build do
    section "Recent Post" do
      # return a list of posts
    end

    section "New Users This Week" do
      # return a list of users this week
    end
  end
diff --git a/lib/active_admin.rb b/lib/active_admin.rb
@@ -222,10 +222,8 @@ def around_filter(*args, &block)
 
     # Helper method to add a dashboard section
     def dashboard_section(name, options = {}, &block)
-      namespace = options.delete(:namespace) || default_namespace
-      ActiveAdmin::Dashboards.add_section(namespace, name, options, &block)
+      ActiveAdmin::Dashboards.add_section(name, options, &block)
     end
 
-
   end
 end
diff --git a/lib/active_admin/dashboards.rb b/lib/active_admin/dashboards.rb
@@ -10,11 +10,31 @@ module Dashboards
     mattr_accessor :sections
 
     class << self
-      def add_section(namespace, name, options = {}, &block)
-       self.sections[namespace] ||= [] 
-       self.sections[namespace] << Section.new(namespace, name, options, &block)
-       self.sections[namespace].sort!
+
+      # Eval an entire block in the context of this module to build 
+      # dashboards quicker. 
+      #
+      # Example:
+      #
+      #   ActiveAdmin::Dashboards.build do
+      #     section "Recent Post" do
+      #       # return a list of posts
+      #     end
+      #   end
+      #
+      def build(&block)
+        module_eval(&block)
+      end
+
+      # Add a new dashboard section to a namespace. If no namespace is given
+      # it will be added to the default namespace.
+      def add_section(name, options = {}, &block)
+        namespace = options.delete(:namespace) || ActiveAdmin.default_namespace
+        self.sections[namespace] ||= [] 
+        self.sections[namespace] << Section.new(namespace, name, options, &block)
+        self.sections[namespace].sort!
       end
+      alias_method :section, :add_section
 
       def sections_for_namespace(namespace)
         @@sections[namespace] || []
@@ -23,6 +43,7 @@ def sections_for_namespace(namespace)
       def clear_all_sections!
         @@sections = {}
       end
+
     end
 
   end
diff --git a/spec/unit/active_admin_spec.rb b/spec/unit/active_admin_spec.rb
@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe ActiveAdmin do
 
diff --git a/spec/unit/dashboards_spec.rb b/spec/unit/dashboards_spec.rb
@@ -9,16 +9,30 @@
   describe "adding sections" do
     before do
       ActiveAdmin::Dashboards.clear_all_sections!
-      ActiveAdmin::Dashboards.add_section(:admin, 'Recent Posts')
+      ActiveAdmin::Dashboards.add_section('Recent Posts')
     end
     it "should add a new section namespaced" do
       ActiveAdmin::Dashboards.sections[:admin].first.should be_an_instance_of(ActiveAdmin::Dashboards::Section)
     end
   end
 
+  describe "adding sections using the build syntax" do
+    before do
+      ActiveAdmin::Dashboards.clear_all_sections!
+      ActiveAdmin::Dashboards.build do
+        section "Recent Posts" do
+        end
+      end
+    end
+
+    it "should add a new section" do
+      ActiveAdmin::Dashboards.sections[:admin].first.should be_an_instance_of(ActiveAdmin::Dashboards::Section)
+    end
+  end
+
   describe "clearing all sections" do
     before do
-      ActiveAdmin::Dashboards.add_section(:admin, 'Recent Posts')
+      ActiveAdmin::Dashboards.add_section('Recent Posts')
     end
     it "should clear all sections" do
       ActiveAdmin::Dashboards.clear_all_sections!
@@ -29,7 +43,7 @@
   describe "finding namespaced sections" do
     context "when the namespace exists" do
       before do
-        ActiveAdmin::Dashboards.add_section(:admin, 'Recent Posts')
+        ActiveAdmin::Dashboards.add_section('Recent Posts')
       end
       it "should return an array of sections" do
         ActiveAdmin::Dashboards.sections_for_namespace(:admin).should_not be_empty

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')`
	`1`	`+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')`
`2`	`2`
`3`	`3`	`describe ActiveAdmin do`
`4`	`4`