activeadmin 0.4.4 → 0.5.0.pre

data/lib/active_admin/application.rb

@@ -57,6 +57,18 @@ module ActiveAdmin
     # The method to use when generating the link for user logout
     inheritable_setting :logout_link_method, :get
 
+    # Whether the batch actions are enabled or not
+    inheritable_setting :batch_actions, false
+
+    # Whether filters are enabled
+    inheritable_setting :filters, true
+
+    # The namespace root.
+    inheritable_setting :root_to, 'dashboard#index'
+
+    # Default CSV separator
+    inheritable_setting :csv_column_separator, ','
+
     # 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,
@@ -80,7 +92,8 @@ module ActiveAdmin
     include AssetRegistration
 
     # Event that gets triggered on load of Active Admin
-    LoadEvent = 'active_admin.application.load'.freeze
+    BeforeLoadEvent = 'active_admin.application.before_load'.freeze
+    AfterLoadEvent = 'active_admin.application.after_load'.freeze
 
     def setup!
       register_default_assets
@@ -106,11 +119,17 @@ module ActiveAdmin
     # @returns [Namespace] the new or existing namespace
     def find_or_create_namespace(name)
       name ||= :root
-      return namespaces[name] if namespaces[name]
-      namespace = Namespace.new(self, name)
-      namespaces[name] = namespace
-      ActiveAdmin::Event.dispatch ActiveAdmin::Namespace::RegisterEvent, namespace
+
+      if namespaces[name]
+        namespace = namespaces[name]
+      else
+        namespace = Namespace.new(self, name)
+        namespaces[name] = namespace
+        ActiveAdmin::Event.dispatch ActiveAdmin::Namespace::RegisterEvent, namespace
+      end
+
       yield(namespace) if block_given?
+
       namespace
     end
 
@@ -157,17 +176,16 @@ module ActiveAdmin
       # No work to do if we've already loaded
       return false if loaded?
 
+      ActiveAdmin::Event.dispatch BeforeLoadEvent, self
+
       # Load files
       files_in_load_path.each{|file| load file }
 
       # If no configurations, let's make sure you can still login
       load_default_namespace if namespaces.values.empty?
 
-      # Load Menus
-      namespaces.values.each{|namespace| namespace.load_menu! }
-
       # Dispatch an ActiveAdmin::Application::LoadEvent with the Application
-      ActiveAdmin::Event.dispatch LoadEvent, self
+      ActiveAdmin::Event.dispatch AfterLoadEvent, self
 
       @@loaded = true
     end
@@ -224,9 +242,10 @@ module ActiveAdmin
     private
 
     def register_default_assets
-      register_stylesheet 'active_admin.css', :media => 'all'
+      register_stylesheet 'active_admin.css', :media => 'screen'
+      register_stylesheet 'active_admin/print.css', :media => 'print'
 
-      if !ActiveAdmin.use_asset_pipeline?
+      unless ActiveAdmin.use_asset_pipeline?
         register_javascript 'jquery.min.js'
         register_javascript 'jquery-ui.min.js'
         register_javascript 'jquery_ujs.js'
@@ -255,10 +274,6 @@ module ActiveAdmin
     end
 
     def generate_stylesheets
-      # This must be required after initialization
-      require 'sass/plugin'
-      require 'active_admin/sass/helpers'
-
       # Create our own asset pipeline in Rails 3.0
       if ActiveAdmin.use_asset_pipeline?
         # Add our mixins to the load path for SASS

data/lib/active_admin/base_controller/menu.rb

@@ -18,11 +18,11 @@ module ActiveAdmin
       # Get's called through a before filter
       def set_current_tab
         @current_tab = if active_admin_config.belongs_to? && parent?
-          active_admin_config.belongs_to_config.target.menu_item_name
+          active_admin_config.belongs_to_config.target.menu_item
         else
-          [active_admin_config.parent_menu_item_name, active_admin_config.menu_item_name].compact.join("/")
+          active_admin_config.menu_item
         end
-      end        
+      end
 
     end
   end

data/lib/active_admin/batch_actions.rb

@@ -0,0 +1,17 @@
+ActiveAdmin.before_load do |app|
+  require "active_admin/batch_actions/resource_extension"
+  require "active_admin/batch_actions/controller"
+
+  # Add our Extensions
+  ActiveAdmin::Resource.send :include, ActiveAdmin::BatchActions::ResourceExtension
+  ActiveAdmin::ResourceController.send :include, ActiveAdmin::BatchActions::Controller
+
+  # Require all the views
+  require "active_admin/batch_actions/views/batch_action_form"
+  require "active_admin/batch_actions/views/batch_action_popover"
+  require "active_admin/batch_actions/views/selection_cells"
+  require "active_admin/batch_actions/views/batch_action_selector"
+
+  # Register the views with the view factory
+  app.view_factory.register :batch_action_selector => ActiveAdmin::BatchActions::BatchActionSelector
+end

data/lib/active_admin/batch_actions/controller.rb

@@ -0,0 +1,25 @@
+module ActiveAdmin
+  module BatchActions
+    module Controller
+
+      # Controller Action that get's called when submitting the batch action form
+      def batch_action
+        if selected_batch_action
+          selected_ids = params[:collection_selection]
+          selected_ids ||= []
+          instance_exec selected_ids, &selected_batch_action.block
+        else
+          raise "Couldn't find batch action \"#{params[:batch_action]}\""
+        end
+      end
+
+      protected
+
+      def selected_batch_action
+        return unless params[:batch_action].present?
+        active_admin_config.batch_actions.select { |action| action.sym == params[:batch_action].to_sym }.first
+      end
+
+    end
+  end
+end

data/lib/active_admin/batch_actions/resource_extension.rb

@@ -0,0 +1,126 @@
+module ActiveAdmin
+
+  module BatchActions
+    module ResourceExtension
+      def initialize(*)
+        super
+        @batch_actions = {}
+        add_default_batch_actions
+      end
+
+      # @return [Array] The set of batch actions for this resource
+      def batch_actions
+        batch_actions_enabled? ? @batch_actions.values.sort : []
+      end
+
+      # @return [Boolean] If batch actions are enabled for this resource
+      def batch_actions_enabled?
+        # If the resource config has been set, use it. Otherwise
+        # return the namespace setting
+        @batch_actions_enabled.nil? ? namespace.batch_actions : @batch_actions_enabled
+      end
+
+      # Disable or Enable batch actions for this resource
+      # Set to `nil` to inherit the setting from the namespace
+      def batch_actions=(bool)
+        @batch_actions_enabled = bool
+      end
+
+      # Add a new batch item to a resource
+      # @param [String] title
+      # @param [Hash] options
+      # => :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 add_batch_action(sym, title, options = {}, &block)
+        @batch_actions[sym] = ActiveAdmin::BatchAction.new(sym, title, options, &block)
+      end
+
+      # Remove a batch action
+      # @param [Symbol] sym
+      # @returns [ActiveAdmin::BatchAction] the batch action, if it was present
+      #
+      def remove_batch_action(sym)
+        @batch_actions.delete(sym.to_sym)
+      end
+
+      # Clears all the existing batch actions for this resource
+      def clear_batch_actions!
+        @batch_actions = {}
+      end
+
+      # Path to the batch action itself
+      def batch_action_path
+        "batch_action_#{route_collection_path}".to_sym
+      end
+
+      private
+
+      # @return [ActiveAdmin::BatchAction] The default "delete" action
+      def add_default_batch_actions
+        destroy_options = {
+          :priority => 100,
+          :confirm => I18n.t('active_admin.batch_actions.delete_confirmation', :plural_model => plural_resource_label.downcase),
+          :if => proc{ controller.action_methods.include?('destroy') }
+        }
+
+        add_batch_action :destroy, I18n.t('active_admin.delete'), destroy_options do |selected_ids|
+          active_admin_config.resource_class.find(selected_ids).each { |r| r.destroy }
+
+          redirect_to collection_path, :notice => I18n.t("active_admin.batch_actions.succesfully_destroyed",
+                                                         :count => selected_ids.count,
+                                                         :model => active_admin_config.resource_label.downcase,
+                                                         :plural_model => active_admin_config.plural_resource_label.downcase)
+        end
+      end
+
+    end
+  end
+
+  class BatchAction
+
+    include Comparable
+
+    attr_reader :block, :title, :sym, :confirm
+
+    # Create a Batch Action
+    #
+    # Examples:
+    #
+    #   BatchAction.new :flag 
+    # => Will create an action that appears in the action list popover
+    #
+    #   BatchAction.new( :flag ) { |selection| redirect_to collection_path, :notice => "#{selection.length} users flagged" }
+    # => Will create an action that uses a block to process the request (which receives one paramater of the selected objects) 
+    #
+    #   BatchAction.new( "Perform Long Operation on the" ) { |selection| }
+    # => You can create batch actions with a title instead of a Symbol
+    #
+    #   BatchAction.new( :flag, :if => proc { can? :flag, AdminUser  } ) { |selection| }
+    # => You can provide an optional :if proc to optionally display the batch action
+    #
+    def initialize(sym, title, options = {}, &block)
+      @sym, @title, @options, @block, @confirm = sym, title, options, block, options[:confirm]
+      @block ||= proc {}
+    end
+
+    # Returns the display if block. If the block was not explicitly defined
+    # a default block always returning true will be returned.
+    def display_if_block
+      @options[:if] || proc { true }
+    end
+
+    # Used for sorting
+    def priority
+      @options[:priority] || 10
+    end
+
+    # sort operator
+    def <=>(other)
+      self.priority <=> other.priority
+    end
+
+  end
+
+end

data/lib/active_admin/batch_actions/views/batch_action_form.rb

@@ -0,0 +1,35 @@
+require 'active_admin/component'
+
+module ActiveAdmin
+  module BatchActions
+
+    # Build an BatchActionForm
+    class BatchActionForm < ActiveAdmin::Component
+      builder_method :batch_action_form
+
+      attr_reader :prefix_html
+
+      def build(options = {}, &block)
+        options[:id] ||= "collection_selection"
+
+        # Open a form
+        text_node form_tag(send(active_admin_config.batch_action_path), :id => options[:id])
+        input(:name => :batch_action, :id => :batch_action, :type => :hidden)
+
+        super(options)
+      end
+
+      # Override the default to_s to include a closing form tag
+      def to_s
+        content + closing_form_tag
+      end
+
+      private
+
+      def closing_form_tag
+        '</form>'.html_safe
+      end
+
+    end
+  end
+end

data/lib/active_admin/batch_actions/views/batch_action_popover.rb

@@ -0,0 +1,28 @@
+require 'active_admin/views/components/action_list_popover'
+
+module ActiveAdmin
+  module BatchActions
+    # Build an BatchActionPopover
+    class BatchActionPopover < ActiveAdmin::Views::ActionListPopover
+      builder_method :batch_action_popover
+
+      def build(options = {}, &block)
+        options[:id] ||= "batch_actions_popover"
+        super(options)
+      end
+
+      def action(batch_action, options = {})
+        options[:class] ||= []
+        options[:class] += %w(batch_action)
+        options.merge! "data-action" => batch_action.sym,
+                       "data-confirm" => batch_action.confirm
+
+        title = I18n.t("active_admin.batch_actions.labels.#{batch_action.sym}", :default => batch_action.title)
+        label = I18n.t("active_admin.batch_actions.action_label", :title => title)
+
+        super(label, "#", options)
+      end
+
+    end
+  end
+end

data/lib/active_admin/batch_actions/views/batch_action_selector.rb

@@ -0,0 +1,63 @@
+require 'active_admin/component'
+
+module ActiveAdmin
+  module BatchActions
+
+    class BatchActionSelector < ActiveAdmin::Component
+      builder_method :batch_action_selector
+
+      # Build a new batch actions selector
+      #
+      # @param [Array] batch_actions An array of batch actions
+      def build(batch_actions)
+        @batch_actions = Array(batch_actions)
+        @drop_down = build_drop_down
+      end
+
+      # We don't want to wrap the action list (or any other children) in
+      # an unecessary div, so instead we just return the children
+      def to_s
+        children.to_s
+      end
+
+      private
+
+      def build_drop_down
+        dropdown_menu I18n.t("active_admin.batch_actions.button_label"), 
+                      :id => "batch_actions_selector",
+                      :button => { :class => "disabled" } do
+          batch_actions_to_display.each do |batch_action|
+            options = {
+              :class => "batch_action",
+              "data-action" => batch_action.sym,
+              "data-confirm" => batch_action.confirm
+            }
+
+            title = I18n.t("active_admin.batch_actions.labels.#{batch_action.sym}", :default => batch_action.title)
+            label = I18n.t("active_admin.batch_actions.action_label", :title => title)
+
+            item label, "#", options
+          end
+        end
+      end
+
+      # Return the set of batch actions that should be displayed
+      def batch_actions_to_display
+        @batch_actions.select do |batch_action|
+          call_method_or_proc_on(self, batch_action.display_if_block)
+        end
+      end
+
+      # def build_batch_action_button
+      #   a :class => 'table_tools_button dropdown_button disabled', :href => "#batch_actions_popover", :id => "batch_actions_button" do
+      #     text_node I18n.t("active_admin.batch_actions.button_label")
+      #   end
+      # end
+
+      # def build_batch_action_popover
+      # end
+
+    end
+
+  end
+end

data/lib/active_admin/batch_actions/views/selection_cells.rb

@@ -0,0 +1,37 @@
+require 'active_admin/component'
+
+module ActiveAdmin
+  module BatchActions
+
+    # Creates the toggle checkbox used to toggle the collection selection on/off
+    class ResourceSelectionToggleCell < ActiveAdmin::Component
+      builder_method :resource_selection_toggle_cell
+
+      def build
+        input( :type => "checkbox", :id => "collection_selection_toggle_all", :name => "collection_selection_toggle_all", :class => "toggle_all" )
+      end
+    end
+
+    # Creates the checkbox used to select a resource in the collection selection
+    class ResourceSelectionCell < ActiveAdmin::Component
+      builder_method :resource_selection_cell
+
+      def build(resource)
+        input :type => "checkbox", :id => "batch_action_item_#{resource.id}", :value => resource.id, :class => "collection_selection", :name => "collection_selection[]" 
+      end
+    end
+
+    # Creates a wrapper panel for all index pages, except for the table, as the table has the checkbox in the thead
+    class ResourceSelectionTogglePanel < ActiveAdmin::Component
+      builder_method :resource_selection_toggle_panel
+
+      def build
+        super(:id => "collection_selection_toggle_panel")
+        resource_selection_toggle_cell
+        div(:id => "collection_selection_toggle_explaination" ) { I18n.t('active_admin.batch_actions.selection_toggle_explanation', :default => "(Toggle Selection)") }
+      end
+
+    end
+
+  end
+end