activeadmin 0.4.4 → 0.5.0.pre

data/lib/active_admin/comments.rb

@@ -16,13 +16,16 @@ ActiveAdmin::Resource.send :include, ActiveAdmin::Comments::ResourceHelper
 # Add the module to the show page
 ActiveAdmin.application.view_factory.show_page.send :include, ActiveAdmin::Comments::ShowPageHelper
 
-# Generate a Comment resource when namespaces are registered
-ActiveAdmin::Event.subscribe ActiveAdmin::Application::LoadEvent do |app|
+# Walk through all the loaded resources after they are loaded
+ActiveAdmin.after_load do |app|
   app.namespaces.values.each do |namespace|
     if namespace.comments?
       namespace.register ActiveAdmin::Comment, :as => "Comment" do
         actions :index, :show, :create
 
+        # Ensure filters are turned on
+        config.filters = true
+
         # Don't display in the menu
         menu false
 

data/lib/active_admin/comments/comment.rb

@@ -11,6 +11,8 @@ module ActiveAdmin
     belongs_to :resource, :polymorphic => true
     belongs_to :author, :polymorphic => true
 
+    attr_accessible :resource, :resource_id, :resource_type, :body, :namespace
+
     validates_presence_of :resource
     validates_presence_of :body
     validates_presence_of :namespace
@@ -19,7 +21,7 @@ module ActiveAdmin
     def self.resource_type(record)
       record.class.base_class.name.to_s
     end
-    
+
     def self.resource_id_cast(record)
       # Postgres adapters won't compare strings to numbers (issue 34)
       if resource_id_type == :string
@@ -31,11 +33,10 @@ module ActiveAdmin
 
     def self.find_for_resource_in_namespace(resource, namespace)
       where(:resource_type => resource_type(resource),
-            :resource_id => resource_id_cast(resource), 
+            :resource_id => resource_id_cast(resource),
             :namespace => namespace.to_s)
     end
 
-  
     def self.resource_id_type
       columns.select { |i| i.name == "resource_id" }.first.type
     end

data/lib/active_admin/comments/views/active_admin_comments.rb

@@ -66,12 +66,12 @@ module ActiveAdmin
         def build_comment_form
           self << active_admin_form_for(ActiveAdmin::Comment.new, :url => comment_form_url, :html => {:class => "inline_form"}) do |form|
             form.inputs do
-              form.input :resource_type, :value => ActiveAdmin::Comment.resource_type(@record), :as => :hidden
-              form.input :resource_id, :value => @record.id, :as => :hidden
-              form.input :body, :input_html => {:size => "80x8"}, :label => false
+              form.input :resource_type, :input_html => { :value => ActiveAdmin::Comment.resource_type(@record) }, :as => :hidden
+              form.input :resource_id, :input_html => { :value => @record.id }, :as => :hidden
+              form.input :body, :input_html => { :size => "80x8" }, :label => false
             end
-            form.buttons do
-              form.commit_button I18n.t('active_admin.comments.add')
+            form.actions do
+              form.action :submit, :label => I18n.t('active_admin.comments.add'), :button_html => { :value => I18n.t('active_admin.comments.add') }
             end
           end
         end

data/lib/active_admin/component.rb

@@ -1,22 +1,5 @@
 module ActiveAdmin
-  class Component < Arbre::HTML::Div
-
-    # By default components render a div
-    def tag_name
-      'div'
-    end
-
-    def initialize(*)
-      super
-      add_class default_class_name
-    end
-
-    protected
-
-    # By default, add a css class named after the ruby class
-    def default_class_name
-      self.class.name.demodulize.underscore
-    end
+  class Component < Arbre::Component
 
   end
 end

data/lib/active_admin/csv_builder.rb

@@ -7,6 +7,10 @@ module ActiveAdmin
   #   csv_builder.column :id
   #   csv_builder.column("Name") { |resource| resource.full_name }
   #
+  #   csv_builder = CSVBuilder.new :separator => ";"
+  #   csv_builder.column :id
+  #
+  #
   class CSVBuilder
 
     # Return a default CSVBuilder for a resource
@@ -21,10 +25,11 @@ module ActiveAdmin
       end
     end
 
-    attr_reader :columns
+    attr_reader :columns, :column_separator
 
-    def initialize(&block)
-      @columns = []
+    def initialize(options={}, &block)
+      @columns          = []
+      @column_separator = options.delete(:separator)
       instance_eval &block if block_given?
     end
 

data/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 @@ module ActiveAdmin
       #   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 @@ module ActiveAdmin
         @@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

data/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 @@ module ActiveAdmin
       def active_admin_namespace
         ActiveAdmin.application.namespace(namespace)
       end
-
     end
   end
 end

data/lib/active_admin/dependency_checker.rb

@@ -25,7 +25,7 @@ module ActiveAdmin
 
       def sass_rails_3_1?
         require 'sass/rails/version'
-        Sass::Rails::VERSION >= "3.1"
+        ::Sass::Rails::VERSION >= "3.1"
       rescue LoadError
         false
       end

data/lib/active_admin/dsl.rb

@@ -7,13 +7,14 @@ module ActiveAdmin
   #
   class DSL
 
-    # Runs the registration block inside this object
-    def run_registration_block(config, &block)
+    def initialize(config)
       @config = config
-      instance_eval &block
     end
 
-    private
+    # Runs the registration block inside this object
+    def run_registration_block(&block)
+      instance_eval &block if block_given?
+    end
 
     # The instance of ActiveAdmin::Config that's being registered
     # currently. You can use this within your registration blocks to
@@ -29,6 +30,32 @@ module ActiveAdmin
       @config
     end
 
+    # Include a module with this resource. The modules's `included` method
+    # is called with the instance of the `ActiveAdmin::DSL` passed into it.
+    #
+    # eg:
+    #
+    #   module HelpSidebar
+    #
+    #     def self.included(dsl)
+    #       dsl.sidebar "Help" do
+    #         "Call us for Help"
+    #       end
+    #     end
+    #
+    #   end
+    #
+    #   ActiveAdmin.register Post do
+    #     include HelpSidebar
+    #   end
+    #
+    # @param [Module] mod A module to include
+    #
+    # @returns [Nil]
+    def include(mod)
+      mod.included(self)
+    end
+
     # Returns the controller for this resource. If you pass a
     # block, it will be eval'd in the controller
     #
@@ -59,6 +86,36 @@ module ActiveAdmin
     def action_item(options = {}, &block)
       config.add_action_item(options, &block)
     end
+    
+    # Add a new batch action item to the resource
+    # Provide a symbol/string to register the action, options, & block to execute on request
+    # 
+    # To unregister an existing action, just provide the symbol & pass false as the second param
+    #
+    # @param [Symbol or String] title
+    # @param [Hash] options valid keys include:
+    # => :if is a proc that will be called to determine if the BatchAction should be displayed
+    # => :sort_order is used to sort the batch actions ascending
+    # => :confirm is a string which the user will have to accept in order to process the action
+    #
+    def batch_action(title, options = {}, &block)
+      
+      # Create symbol & title information
+      if title.is_a?( String )
+        sym = title.titleize.gsub(' ', '').underscore.to_sym
+      else
+        sym = title
+        title = sym.to_s.titleize
+      end
+      
+      # Either add/remove the batch action
+      unless options == false
+        config.add_batch_action( sym, title, options, &block )
+      else
+        config.remove_batch_action sym
+      end
+      
+    end
 
     def menu(options = {})
       config.menu(options)

data/lib/active_admin/engine.rb

@@ -2,7 +2,7 @@ module ActiveAdmin
   class Engine < Rails::Engine
     if Rails.version > "3.1"
       initializer "ActiveAdmin precompile hook" do |app|
-        app.config.assets.precompile += ['active_admin.js', 'active_admin.css']
+        app.config.assets.precompile += %w(active_admin.js active_admin.css active_admin/print.css)
       end
     end
   end

data/lib/active_admin/filters.rb

@@ -0,0 +1,8 @@
+require 'active_admin/filters/dsl'
+require "active_admin/filters/resource_extension"
+require 'active_admin/filters/forms'
+
+# Add our Extensions
+ActiveAdmin::ResourceDSL.send :include, ActiveAdmin::Filters::DSL
+ActiveAdmin::Resource.send    :include, ActiveAdmin::Filters::ResourceExtension
+ActiveAdmin::ViewHelpers.send :include, ActiveAdmin::Filters::ViewHelper

data/lib/active_admin/filters/dsl.rb

@@ -0,0 +1,12 @@
+module ActiveAdmin
+  module Filters
+    module DSL
+
+      # For docs, please see ActiveAdmin::Filters::ResourceExtension#add_filter
+      def filter(attribute, options = {})
+        config.add_filter(attribute, options)
+      end
+
+    end
+  end
+end

data/lib/active_admin/filters/forms.rb

@@ -0,0 +1,93 @@
+module ActiveAdmin
+  module Filters
+
+    # This form builder defines methods to build filter forms such
+    # as the one found in the sidebar of the index page of a standard resource.
+    class FormBuilder < ::ActiveAdmin::FormBuilder
+
+      def filter(method, options = {})
+        return "" if method.blank?
+        options[:as] ||= default_input_type(method)
+        return "" unless options[:as]
+        content = input(method, options)
+        form_buffers.last << content.html_safe if content
+      end
+
+      protected
+
+      # Returns the default filter type for a given attribute
+      def default_input_type(method, options = {})
+        if (column = column_for(method))
+          case column.type
+          when :date, :datetime
+            return :date_range
+          when :string, :text
+            return :string
+          when :integer
+            return :select if reflection_for(method.to_s.gsub('_id','').to_sym)
+            return :numeric
+          when :float, :decimal
+            return :numeric
+          end
+        end
+
+        if (reflection = reflection_for(method))
+          return :select if reflection.macro == :belongs_to && !reflection.options[:polymorphic]
+        end
+      end
+
+      def custom_input_class_name(as)
+        "Filter#{as.to_s.camelize}Input"
+      end
+
+      def active_admin_input_class_name(as)
+        "ActiveAdmin::Inputs::Filter#{as.to_s.camelize}Input"
+      end
+
+      # Returns the column for an attribute on the object being searched
+      # if it exists. Otherwise returns nil
+      def column_for(method)
+        @object.base.columns_hash[method.to_s] if @object.base.respond_to?(:columns_hash)
+      end
+
+      # Returns the association reflection for the method if it exists
+      def reflection_for(method)
+        @object.base.reflect_on_association(method) if @object.base.respond_to?(:reflect_on_association)
+      end
+
+    end
+
+
+    # This module is included into the view
+    module ViewHelper
+
+      # Helper method to render a filter form
+      def active_admin_filters_form_for(search, filters, options = {})
+        options[:builder] ||= ActiveAdmin::Filters::FormBuilder
+        options[:url] ||= collection_path
+        options[:html] ||= {}
+        options[:html][:method] = :get
+        options[:html][:class] ||= "filter_form"
+        options[:as] = :q
+        clear_link = link_to(I18n.t('active_admin.clear_filters'), "#", :class => "clear_filters_btn")
+        form_for search, options do |f|
+          filters.each do |filter_options|
+            filter_options = filter_options.dup
+            attribute = filter_options.delete(:attribute)
+            f.filter attribute, filter_options
+          end
+
+          buttons = content_tag :div, :class => "buttons" do
+            f.submit(I18n.t('active_admin.filter')) +
+              clear_link +
+              hidden_field_tags_for(params, :except => [:q, :page])
+          end
+
+          f.form_buffers.last + buttons
+        end
+      end
+
+    end
+
+  end
+end

data/lib/active_admin/filters/resource_extension.rb

@@ -0,0 +1,92 @@
+module ActiveAdmin
+  module Filters
+
+    module ResourceExtension
+
+      def initialize(*)
+        super
+        add_filters_sidebar_section
+      end
+
+      # Returns the filters for this resource. If filters are not enabled,
+      # it will always return an empty array.
+      #
+      # @return [Array] Filters that apply for this resource
+      def filters
+        return [] unless filters_enabled?
+
+        @filters || default_filters
+      end
+
+      # Setter to enable / disable filters on this resource.
+      #
+      # Set to `nil` to inherit the setting from the namespace
+      def filters=(bool)
+        @filters_enabled = bool
+      end
+
+      # @return [Boolean] If filters are enabled for this resource
+      def filters_enabled?
+        @filters_enabled.nil? ? namespace.filters : @filters_enabled
+      end
+
+      # Add a filter for this resource. If filters are not enabled, this method
+      # will raise a RuntimeError
+      #
+      # @param [Symbol] attribute The attribute to filter on
+      # @param [Hash] options The set of options that are passed through to 
+      #                       metasearch for the field definition.
+      def add_filter(attribute, options = {})
+        unless filters_enabled?
+          raise RuntimeError, "Can't add a filter when filters are disabled. Enable filters with 'config.filters = true'"
+        end
+
+        @filters ||= []
+
+        @filters << options.merge({ :attribute => attribute })
+      end
+
+      # Reset the filters to use defaults
+      def reset_filters!
+        @filters = nil
+      end
+
+      private
+
+      # @return [Array] The array of default for filters for this resource
+      def default_filters
+        default_association_filters + default_content_filters
+      end
+
+      # Returns a default set of filters for the associations
+      def default_association_filters
+        if resource_class.respond_to?(:reflections)
+          resource_class.reflections.collect{|name, r| { :attribute => name }}
+        else
+          []
+        end
+      end
+
+      # Returns a default set of filters for the content columns
+      def default_content_filters
+        if resource_class.respond_to?(:content_columns)
+          resource_class.content_columns.collect{|c| { :attribute => c.name.to_sym } }
+        else
+          []
+        end
+      end
+
+      def add_filters_sidebar_section
+        self.sidebar_sections << filters_sidebar_section
+      end
+
+      def filters_sidebar_section
+        ActiveAdmin::SidebarSection.new(:filters, :only => :index, :if => proc{ active_admin_config.filters.any? } ) do
+          active_admin_filters_form_for assigns[:search], active_admin_config.filters
+        end
+      end
+
+    end
+
+  end
+end