aa-rails4 0.6.0

data/lib/active_admin/resource/page_presenters.rb

@@ -0,0 +1,82 @@
+module ActiveAdmin
+  class Resource
+    module PagePresenters
+
+      # for setting default css class in admin ui
+      def default_index_class
+        @default_index
+      end
+
+      # A hash of page configurations for the controller indexed by action name
+      def page_presenters
+        @page_presenters ||= {}
+      end
+
+      # Sets a page config for a given action
+      #
+      # @param [String, Symbol] action The action to store this configuration for
+      # @param [PagePresenter] page_presenter The instance of PagePresenter to store
+      def set_page_presenter(action, page_presenter)
+
+        if action.to_s == "index" && page_presenter[:as]
+          index_class = find_index_class(page_presenter[:as])
+          page_presenter_key = index_class.index_name.to_sym
+          set_index_presenter page_presenter_key, page_presenter
+        else
+          page_presenters[action.to_sym] = page_presenter
+        end
+
+      end
+
+      # Returns a stored page config
+      #
+      # @param [Symbol, String] action The action to get the config for
+      # @param [String] type The string specified in the presenters index_name method
+      # @returns [PagePresenter, nil]
+      def get_page_presenter(action, type=nil)
+
+        if action.to_s == "index" && type && page_presenters[:index].kind_of?(Hash)
+          page_presenters[:index][type.to_sym]
+        elsif action.to_s == "index" && page_presenters[:index].kind_of?(Hash)
+          page_presenters[:index].default
+        else
+          page_presenters[action.to_sym]
+        end
+
+      end
+
+      protected
+
+      # Stores a config for all index actions supplied
+      #
+      # @param [Symbol] index_as The index type to store in the configuration
+      # @param [PagePresenter] page_presenter The intance of PagePresenter to store
+      def set_index_presenter(index_as, page_presenter)
+        page_presenters[:index] ||= {}
+
+        #set first index as default value or the index with default param set to to true
+        if page_presenters[:index].empty? || page_presenter[:default] == true
+          page_presenters[:index].default = page_presenter
+          @default_index = find_index_class(page_presenter[:as])
+        end
+
+        page_presenters[:index][index_as] = page_presenter
+      end
+
+      # Returns the actual class for renderering the main content on the index
+      # page. To set this, use the :as option in the page_presenter block.
+      #
+      # @param [Symbol, Class] symbol_or_class The component symbol or class
+      # @return [Class]
+      def find_index_class(symbol_or_class)
+        case symbol_or_class
+        when Symbol
+          ::ActiveAdmin::Views.const_get("IndexAs" + symbol_or_class.to_s.camelcase)
+        when Class
+          symbol_or_class
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/pagination.rb

@@ -0,0 +1,19 @@
+module ActiveAdmin
+
+  class Resource
+    module Pagination
+
+      # The default number of records to display per page
+      attr_accessor :per_page
+
+      # Enable / disable pagination (defaults to true)
+      attr_accessor :paginate
+
+      def initialize(*args)
+        super
+        @paginate = true
+        @per_page = namespace.default_per_page
+      end
+    end
+  end
+end

data/lib/active_admin/resource/routes.rb

@@ -0,0 +1,99 @@
+module ActiveAdmin
+  class Resource
+    module Routes
+      # @params params [Hash] of params: {study_id: 3}
+      # @return [String] the path to this resource collection page
+      # @example "/admin/posts"
+      def route_collection_path(params = {})
+        RouteBuilder.new(self).collection_path(params)
+      end
+      
+      # @param resource [ActiveRecord::Base] the instance we want the path of
+      # @return [String] the path to this resource collection page
+      # @example "/admin/posts/1"
+      def route_instance_path(resource)
+        RouteBuilder.new(self).instance_path(resource)
+      end
+
+      # Returns the routes prefix for this config
+      def route_prefix
+        namespace.module_name.try(:underscore)
+      end
+
+      def route_uncountable?
+        config = controller.resources_configuration[:self]
+
+        config[:route_collection_name] == config[:route_instance_name]
+      end
+
+      private
+
+      class RouteBuilder
+        def initialize(resource)
+          @resource = resource
+        end
+
+        def collection_path(params)
+          route_name = route_name(
+            resource.controller.resources_configuration[:self][:route_collection_name],
+            (resource.route_uncountable? ? 'index_path' : 'path')
+          )
+
+          routes.send(route_name, *route_collection_params(params))
+        end
+
+        # @return [String] the path to this resource collection page
+        # @param instance [ActiveRecord::Base] the instance we want the path of
+        # @example "/admin/posts/1"
+        def instance_path(instance)
+          route_name = route_name(resource.controller.resources_configuration[:self][:route_instance_name])
+
+          routes.send(route_name, *route_instance_params(instance))
+        end
+
+        private
+
+        attr_reader :resource
+
+        def route_name(resource_path_name, suffix = 'path')
+          route = []
+
+          route << resource.route_prefix      # "admin"
+          route << belongs_to_name if nested? # "category"
+          route << resource_path_name         # "posts" or "post"
+          route << suffix                     # "path" or "index path"
+
+          route.compact.join('_').to_sym      # :admin_category_posts_path
+        end
+
+
+        # @return params to pass to instance path
+        def route_instance_params(instance)
+          if nested?
+            [instance.send(belongs_to_name).to_param, instance.to_param]
+          else
+            instance.to_param
+          end
+        end
+
+        def route_collection_params(params)
+          if nested?
+            params[:"#{belongs_to_name}_id"]
+          end
+        end
+
+        def nested?
+          resource.belongs_to? && resource.belongs_to_config.required?
+        end
+
+        def belongs_to_name
+          resource.belongs_to_config.target.resource_name.singular if nested?
+        end
+
+        def routes
+          Rails.application.routes.url_helpers
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/resource/scope_to.rb

@@ -0,0 +1,74 @@
+module ActiveAdmin
+  class Resource
+    module ScopeTo
+
+      # Scope this controller to some object which has a relation
+      # to the resource. Can either accept a block or a symbol
+      # of a method to call.
+      #
+      # Eg:
+      #
+      #   ActiveAdmin.register Post do
+      #     scope_to :current_user
+      #   end
+      #
+      # Then every time we instantiate and object, it would call
+      #
+      #   current_user.posts.build
+      #
+      # By default Active Admin will use the resource name to build a
+      # method to call as the association. If its different, you can
+      # pass in the association_method as an option.
+      #
+      #   scope_to :current_user, :association_method => :blog_posts
+      #
+      # will result in the following
+      #
+      #   current_user.blog_posts.build
+      #
+      # To conditionally use this scope, you can use conditional procs
+      #
+      #   scope_to :current_user, :if => proc{ admin_user_signed_in? }
+      #
+      # or
+      #
+      #   scope_to :current_user, :unless => proc{ current_user.admin? }
+      #
+      def scope_to(*args, &block)
+        options = args.extract_options!
+        method = args.first
+
+        scope_to_config[:method]              = block || method
+        scope_to_config[:association_method]  = options[:association_method]
+        scope_to_config[:if]                  = options[:if]
+        scope_to_config[:unless]              = options[:unless]
+
+      end
+
+      def scope_to_association_method
+        scope_to_config[:association_method]
+      end
+
+      def scope_to_method
+        scope_to_config[:method]
+      end
+
+      def scope_to_config
+        @scope_to_config ||= {
+          :method               => nil,
+          :association_method   => nil,
+          :if                   => nil,
+          :unless               => nil
+        }
+      end
+
+      def scope_to?(context = nil)
+        return false if scope_to_method.nil?
+        return render_in_context(context, scope_to_config[:if]) unless scope_to_config[:if].nil?
+        return !render_in_context(context, scope_to_config[:unless]) unless scope_to_config[:unless].nil?
+        true
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/scopes.rb

@@ -0,0 +1,50 @@
+module ActiveAdmin
+  class Resource
+    module Scopes
+
+      # Return an array of scopes for this resource
+      def scopes
+        @scopes ||= []
+      end
+
+      # Returns a scope for this object by its identifier
+      def get_scope_by_id(id)
+        id = id.to_s
+        scopes.find{|s| s.id == id }
+      end
+
+      def default_scope(context = nil)
+        scopes.detect do |scope|
+          if scope.default_block.is_a?(Proc)
+            render_in_context(context, scope.default_block)
+          else
+            scope.default_block
+          end
+        end
+      end
+
+      # Create a new scope object for this resource.
+      # If you want to internationalize the scope name, you can add
+      # to your i18n files a key like "active_admin.scopes.scope_method".
+      def scope(*args, &block)
+        options = args.extract_options!
+        title = args[0] rescue nil
+        method = args[1] rescue nil
+
+        scope = ActiveAdmin::Scope.new(title, method, options, &block)
+
+        # Finds and replaces a scope by the same name if it already exists
+        existing_scope_index = scopes.index{|existing_scope| existing_scope.id == scope.id }
+        if existing_scope_index
+          scopes.delete_at(existing_scope_index)
+          scopes.insert(existing_scope_index, scope)
+        else
+          self.scopes << scope
+        end
+
+        scope
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/sidebars.rb

@@ -0,0 +1,27 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module Sidebars
+
+      def sidebar_sections
+        @sidebar_sections ||= []
+      end
+
+      def clear_sidebar_sections!
+        @sidebar_sections = []
+      end
+
+      def sidebar_sections_for(action, render_context = nil)
+        sidebar_sections.select{|section| section.display_on?(action, render_context) }
+      end
+
+      def sidebar_sections?
+        !!@sidebar_sections && @sidebar_sections.any?
+      end
+
+    end
+  end
+
+end

data/lib/active_admin/resource_collection.rb

@@ -0,0 +1,42 @@
+module ActiveAdmin
+  # This is a container for resources, which acts much like a Hash.
+  # It's assumed that an added resource responds to `resource_name`.
+  class ResourceCollection
+    include Enumerable
+    extend Forwardable
+    def_delegators :@resources, :empty?, :has_key?, :keys, :values, :[]=
+
+    def initialize
+      @resources = {}
+    end
+
+    def add(resource)
+      self[resource.resource_name] ||= resource
+    end
+
+    # Changes `each` to pass in the value, instead of both the key and value.
+    def each(&block)
+      values.each &block
+    end
+
+    # Finds a resource based on the resource name, the resource class, or the base class.
+    def [](klass)
+      if match = @resources[klass]
+        match
+      elsif match = real_resources.detect{ |r| r.resource_class.to_s == klass.to_s }
+        match
+      elsif klass.respond_to? :base_class
+        real_resources.detect{ |r| r.resource_class.to_s == klass.base_class.to_s }
+      end
+    end
+
+    private
+
+    # REFACTOR: ResourceCollection currently stores Resource and Page objects. That doesn't
+    # make sense, because by definition a ResourceCollection is a collection of resources.
+    def real_resources
+      select{ |r| r.respond_to? :resource_class }
+    end
+
+  end
+end

data/lib/active_admin/resource_controller.rb

@@ -0,0 +1,51 @@
+require 'inherited_resources'
+require 'active_admin/resource_controller/actions'
+require 'active_admin/resource_controller/action_builder'
+require 'active_admin/resource_controller/data_access'
+require 'active_admin/resource_controller/decorators'
+require 'active_admin/resource_controller/scoping'
+require 'active_admin/resource_controller/sidebars'
+require 'active_admin/resource_controller/resource_class_methods'
+
+module ActiveAdmin
+  # All Resources Controller inherits from this controller.
+  # It implements actions and helpers for resources.
+  class ResourceController < BaseController
+    layout :determine_active_admin_layout
+
+    respond_to :html, :xml, :json
+    respond_to :csv, :only => :index
+
+    include ActionBuilder
+    include Decorators
+    include DataAccess
+    include Scoping
+    include Sidebars
+    extend  ResourceClassMethods
+
+    def self.active_admin_config=(config)
+      if @active_admin_config = config
+        defaults :resource_class => config.resource_class,
+                 :route_prefix   => config.route_prefix,
+                 :instance_name  => config.resource_name.singular
+      end
+    end
+
+    # Inherited Resources uses the `self.inherited(base)` hook to add
+    # in `self.resource_class`. To override it, we need to install
+    # our resource_class method each time we're inherited from.
+    def self.inherited(base)
+      super(base)
+      base.override_resource_class_methods!
+    end
+
+    private
+
+    # Returns the renderer class to use for the given action.
+    def renderer_for(action)
+      active_admin_namespace.view_factory["#{action}_page"]
+    end
+    helper_method :renderer_for
+
+  end
+end