saulolso-activeadmin 0.2.2

data/lib/active_admin/resource_controller/actions.rb

@@ -0,0 +1,79 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    # Override the InheritedResources actions to use the
+    # Active Admin templates.
+    #
+    # We ensure that the functionality provided by Inherited
+    # Resources is still available within any ResourceController
+
+    def index(options={}, &block)
+      super(options) do |format|
+        block.call(format) if block
+        format.html { render active_admin_template('index.html.arb') }
+        format.csv do
+          headers['Content-Type'] = 'text/csv; charset=utf-8'
+          headers['Content-Disposition'] = %{attachment; filename="#{csv_filename}"}
+          render active_admin_template('index.csv.erb')
+        end
+      end
+    end
+    alias :index! :index
+
+    def show(options={}, &block)
+      super do |format|
+        block.call(format) if block
+        format.html { render active_admin_template('show.html.arb') }
+      end
+    end
+    alias :show! :show
+
+    def new(options={}, &block)
+      super do |format|
+        block.call(format) if block
+        format.html { render active_admin_template('new.html.arb') }
+      end
+    end
+    alias :new! :new
+
+    def edit(options={}, &block)
+      super do |format|
+        block.call(format) if block
+        format.html { render active_admin_template('edit.html.arb') }
+      end
+    end
+    alias :edit! :edit
+
+    def create(options={}, &block)
+      super(options) do |success, failure|
+        block.call(success, failure) if block
+        failure.html { render active_admin_template('new.html.arb') }
+      end
+    end
+    alias :create! :create
+
+    def update(options={}, &block)
+      super do |success, failure|
+        block.call(success, failure) if block
+        failure.html { render active_admin_template('edit.html.arb') }
+      end
+    end
+    alias :update! :update
+
+    # Make aliases protected
+    protected :index!, :show!, :new!, :create!, :edit!, :update!
+
+    protected
+
+    # Returns the full location to the Active Admin template path
+    def active_admin_template(template)
+      "active_admin/resource/#{template}"
+    end
+
+    # Returns a filename for the csv file using the collection_name
+    # and current date such as 'my-articles-2011-06-24.csv'.
+    def csv_filename
+      "#{resource_collection_name.to_s.gsub('_', '-')}-#{Time.now.strftime("%Y-%m-%d")}.csv"
+    end
+  end
+end

data/lib/active_admin/resource_controller/callbacks.rb

@@ -0,0 +1,47 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    module Callbacks
+      extend ActiveSupport::Concern
+      include ::ActiveAdmin::Callbacks
+
+      included do
+        define_active_admin_callbacks :build, :create, :update, :save, :destroy
+      end
+
+      protected
+
+      def build_resource
+        object = super
+        run_build_callbacks object
+        object
+      end
+
+      def create_resource(object)
+        run_create_callbacks object do
+          save_resource(object)
+        end
+      end
+
+      def save_resource(object)
+        run_save_callbacks object do
+          object.save
+        end
+      end
+
+      def update_resource(object, attributes)
+        object.attributes = attributes
+        run_update_callbacks object do
+          save_resource(object)
+        end
+      end
+
+      def destroy_resource(object)
+        run_destroy_callbacks object do
+          object.destroy
+        end
+      end
+    end
+
+  end
+end

data/lib/active_admin/resource_controller/collection.rb

@@ -0,0 +1,144 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    # This module deals with the retrieval of collections for resources
+    # within the resource controller.
+    module Collection
+      extend ActiveSupport::Concern
+
+      included do
+        before_filter :setup_pagination_for_csv
+      end
+
+      module BaseCollection
+        protected
+
+        def collection
+          get_collection_ivar || set_collection_ivar(active_admin_collection)
+        end
+
+        def active_admin_collection
+          scoped_collection
+        end
+
+
+        # Override this method in your controllers to modify the start point
+        # of our searches and index.
+        #
+        # This method should return an ActiveRecord::Relation object so that
+        # the searching and filtering can be applied on top
+        #
+        # Note, unless you are doing something special, you should use the
+        # scope_to method from the Scoping module instead of overriding this
+        # method.
+        def scoped_collection
+          end_of_association_chain
+        end
+      end
+
+
+      module Sorting
+        protected
+
+        def active_admin_collection
+          sort_order(super)
+        end
+
+        def sort_order(chain)
+          params[:order] ||= active_admin_config.sort_order
+          table_name = active_admin_config.resource_table_name
+          if params[:order] && params[:order] =~ /^([\w\_\.]+)_(desc|asc)$/
+            chain.order("#{table_name}.#{$1} #{$2}")
+          else
+            chain # just return the chain
+          end
+        end
+      end
+
+
+      module Search
+        protected
+
+        def active_admin_collection
+          search(super)
+        end
+
+        def search(chain)
+          @search = chain.metasearch(clean_search_params(params[:q]))
+          @search.relation
+        end
+
+        def clean_search_params(search_params)
+          return {} unless search_params.is_a?(Hash)
+          search_params = search_params.dup
+          search_params.delete_if do |key, value|
+            value == ""
+          end
+          search_params
+        end
+      end
+
+
+      module Scoping
+        protected
+
+        def active_admin_collection
+          scope_collection(super)
+        end
+
+        def scope_collection(chain)
+          if current_scope
+            @before_scope_collection = chain
+
+            # ActiveRecord::Base isn't a relation, so let's help you out
+            return chain if current_scope.scope_method == :all
+
+            if current_scope.scope_method
+              chain.send(current_scope.scope_method)
+            else
+              instance_exec chain, &current_scope.scope_block
+            end
+          else
+            chain
+          end
+        end
+
+        def current_scope
+          @current_scope ||= if params[:scope]
+            active_admin_config.get_scope_by_id(params[:scope]) if params[:scope]
+          else
+            active_admin_config.default_scope
+          end
+        end
+      end
+
+
+      module Pagination
+        protected
+
+        def active_admin_collection
+          paginate(super)
+        end
+
+        # Allow more records for csv files
+        def setup_pagination_for_csv
+          @per_page = 10_000 if request.format == 'text/csv'
+        end
+
+        def paginate(chain)
+          chain.page(params[:page]).per(@per_page || active_admin_application.default_per_page)
+        end
+      end
+
+      # Include all the Modules. BaseCollection must be first
+      # and pagination should be last
+      include BaseCollection
+      include Sorting
+      include Search
+      include Scoping
+      include Pagination
+
+    end
+  end
+end
+

data/lib/active_admin/resource_controller/filters.rb

@@ -0,0 +1,58 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    module Filters
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :filters_config
+      end
+
+      module ClassMethods
+        def filter(attribute, options = {})
+          return false if attribute.nil?
+          @filters ||= []
+          @filters << options.merge(:attribute => attribute)
+        end
+
+        def filters_config
+          @filters && @filters.any? ? @filters : default_filters_config
+        end
+
+        def reset_filters!
+          @filters = []
+        end
+
+        # Returns a sane set of filters by default for the object
+        def default_filters_config
+          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
+      end
+
+      protected
+
+      def filters_config
+        self.class.filters_config
+      end
+    end
+
+  end
+end

data/lib/active_admin/resource_controller/form.rb

@@ -0,0 +1,42 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+    module Form
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :form_config
+      end
+
+      module ClassMethods
+
+        def form_config=(config)
+          @form_config = config
+        end
+
+        def form_config
+          @form_config ||= default_form_config
+        end
+
+        def reset_form_config!
+          @form_config = nil
+        end
+
+        def default_form_config
+          config = {}
+          config[:block] = lambda do |f|
+            f.inputs
+            f.buttons
+          end
+          config
+        end
+      end
+
+      protected
+
+      def form_config
+        @form_config ||= self.class.form_config
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource_controller/menu.rb

@@ -0,0 +1,29 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+    module Menu
+      extend ActiveSupport::Concern
+
+      included do
+        before_filter :set_current_tab
+        helper_method :current_menu
+      end
+
+      protected
+
+      def current_menu
+        active_admin_config.namespace.menu
+      end
+
+      # Set's @current_tab to be name of the tab to mark as current
+      # 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
+        else
+          [active_admin_config.parent_menu_item_name, active_admin_config.menu_item_name].compact.join("/")
+        end
+      end        
+
+    end
+  end
+end

data/lib/active_admin/resource_controller/page_configurations.rb

@@ -0,0 +1,53 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    module PageConfigurations
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :index_config
+        helper_method :show_config
+      end
+
+      module ClassMethods
+
+        def set_page_config(page, options, &block)
+          active_admin_config.page_configs[page] = ActiveAdmin::PageConfig.new(options, &block)
+        end
+
+        def get_page_config(page)
+          active_admin_config.page_configs[page]
+        end
+
+        def reset_page_config!(page)
+          active_admin_config.page_configs[page] = nil
+        end
+
+        # Define the getting and re-setter for each configurable page
+        [:index, :show].each do |page|
+          # eg: index_config
+          define_method :"#{page}_config" do
+            get_page_config(page)
+          end
+
+          # eg: reset_index_config!
+          define_method :"reset_#{page}_config!" do
+            reset_page_config! page
+          end
+        end
+
+      end
+
+      protected
+
+      def index_config
+        @index_config ||= self.class.index_config
+      end
+
+      def show_config
+        @show_config ||= self.class.show_config
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource_controller/scoping.rb

@@ -0,0 +1,36 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    # This module deals with scoping entire controllers to a relation
+    module Scoping
+      extend ActiveSupport::Concern
+
+      protected
+
+      # Override the default InheritedResource #begin_of_association_chain to allow
+      # the scope to be defined in the active admin configuration.
+      #
+      # If scope_to is a proc, we eval it, otherwise we call the method on the controller.
+      def begin_of_association_chain
+        return nil unless active_admin_config.scope_to
+        case active_admin_config.scope_to
+        when Proc
+          instance_eval &active_admin_config.scope_to
+        when Symbol
+          send active_admin_config.scope_to
+        else
+          raise ArgumentError, "#scope_to accepts a symbol or a block"
+        end
+      end
+
+      # Overriding from InheritedResources::BaseHelpers
+      #
+      # Returns the method for the association chain when using
+      # the scope_to option
+      def method_for_association_chain
+        active_admin_config.scope_to_association_method || super
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource_controller/sidebars.rb

@@ -0,0 +1,38 @@
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    module Sidebars
+      extend ActiveSupport::Concern
+
+      included do
+        self.class_inheritable_accessor :sidebar_sections
+        self.sidebar_sections = []
+      end
+
+      module ClassMethods
+        def sidebar(name, options = {}, &block)
+          self.sidebar_sections << ActiveAdmin::Sidebar::Section.new(name, options, &block)
+        end
+
+        def clear_sidebar_sections!
+          self.sidebar_sections = []
+        end
+
+        def sidebar_sections_for(action)
+          sidebar_sections.select{|section| section.display_on?(action) }
+        end
+      end
+
+      protected
+
+      def skip_sidebar!
+        @skip_sidebar = true
+      end
+
+      def skip_sidebar?
+        @skip_sidebar == true
+      end
+    end
+
+  end
+end

data/lib/active_admin/resource_controller.rb

@@ -0,0 +1,119 @@
+require 'inherited_resources'
+require 'active_admin/resource_controller/actions'
+require 'active_admin/resource_controller/action_builder'
+require 'active_admin/resource_controller/callbacks'
+require 'active_admin/resource_controller/collection'
+require 'active_admin/resource_controller/filters'
+require 'active_admin/resource_controller/form'
+require 'active_admin/resource_controller/menu'
+require 'active_admin/resource_controller/page_configurations'
+require 'active_admin/resource_controller/scoping'
+require 'active_admin/resource_controller/sidebars'
+
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    helper ::ActiveAdmin::ViewHelpers
+
+    layout false
+
+    respond_to :html, :xml, :json
+    respond_to :csv, :only => :index
+
+    before_filter :only_render_implemented_actions
+    before_filter :authenticate_active_admin_user
+
+    include Actions
+    include ActiveAdmin::ActionItems
+    include ActionBuilder
+    include Callbacks
+    include Collection
+    include Filters
+    include Form
+    include Menu
+    include PageConfigurations
+    include Scoping
+    include Sidebars
+
+    class << self
+
+      # Reference to the Resource object which initialized
+      # this controller
+      attr_accessor :active_admin_config
+
+      def active_admin_config=(config)
+        @active_admin_config = config
+        defaults  :resource_class => config.resource,
+                  :route_prefix => config.route_prefix,
+                  :instance_name => config.underscored_resource_name
+      end
+
+      public :belongs_to
+    end
+
+    # Default Sidebar Sections
+    sidebar :filters, :only => :index do
+      active_admin_filters_form_for assigns["search"], filters_config
+    end
+
+    # Default Action Item Links
+    action_item :only => :show do
+      if controller.action_methods.include?('edit')
+        link_to(I18n.t('active_admin.edit_model', :model => active_admin_config.resource_name), edit_resource_path(resource))
+      end
+    end
+
+    action_item :only => :show do
+      if controller.action_methods.include?("destroy")
+        link_to(I18n.t('active_admin.delete_model', :model => active_admin_config.resource_name),
+          resource_path(resource),
+          :method => :delete, :confirm => I18n.t('active_admin.delete_confirmation'))
+      end
+    end
+
+    action_item :except => [:new, :show] do
+      if controller.action_methods.include?('new')
+        link_to(I18n.t('active_admin.new_model', :model => active_admin_config.resource_name), new_resource_path)
+      end
+    end
+
+    protected
+
+    # By default Rails will render un-implemented actions when the view exists. Becuase Active
+    # Admin allows you to not render any of the actions by using the #actions method, we need
+    # to check if they are implemented.
+    def only_render_implemented_actions
+      raise AbstractController::ActionNotFound unless action_methods.include?(params[:action])
+    end
+
+    # Calls the authentication method as defined in ActiveAdmin.authentication_method
+    def authenticate_active_admin_user
+      send(active_admin_application.authentication_method) if active_admin_application.authentication_method
+    end
+
+    def current_active_admin_user
+      send(active_admin_application.current_user_method) if active_admin_application.current_user_method
+    end
+    helper_method :current_active_admin_user
+
+    def current_active_admin_user?
+      !current_active_admin_user.nil?
+    end
+    helper_method :current_active_admin_user?
+
+    def active_admin_config
+      self.class.active_admin_config
+    end
+    helper_method :active_admin_config
+
+    def active_admin_application
+      ActiveAdmin.application
+    end
+
+    # Returns the renderer class to use for the given action.
+    def renderer_for(action)
+      active_admin_application.view_factory["#{action}_page"]
+    end
+    helper_method :renderer_for
+  end
+end