activeadmin 2.2.0

data/lib/active_admin/resource/attributes.rb

@@ -0,0 +1,47 @@
+module ActiveAdmin
+
+  class Resource
+    module Attributes
+
+      def default_attributes
+        resource_class.columns.each_with_object({}) do |c, attrs|
+          unless reject_col?(c)
+            name = c.name.to_sym
+            attrs[name] = (method_for_column(name) || name)
+          end
+        end
+      end
+
+      def method_for_column(c)
+        resource_class.respond_to?(:reflect_on_all_associations) && foreign_methods.has_key?(c) && foreign_methods[c].name.to_sym
+      end
+
+      def foreign_methods
+        @foreign_methods ||= resource_class.reflect_on_all_associations.
+          select { |r| r.macro == :belongs_to }.
+          reject { |r| r.chain.length > 2 && !r.options[:polymorphic] }.
+          index_by { |r| r.foreign_key.to_sym }
+      end
+
+      def reject_col?(c)
+        primary_col?(c) || sti_col?(c) || counter_cache_col?(c) || filtered_col?(c)
+      end
+
+      def primary_col?(c)
+        c.name == resource_class.primary_key
+      end
+
+      def sti_col?(c)
+        c.name == resource_class.inheritance_column
+      end
+
+      def counter_cache_col?(c)
+        c.name.end_with?('_count')
+      end
+
+      def filtered_col?(c)
+        ActiveAdmin.application.filter_attributes.include?(c.name.to_sym)
+      end
+    end
+  end
+end

data/lib/active_admin/resource/belongs_to.rb

@@ -0,0 +1,50 @@
+require 'active_admin/resource'
+
+module ActiveAdmin
+  class Resource
+    class BelongsTo
+
+      class TargetNotFound < StandardError
+        def initialize(key, namespace)
+          super "Could not find #{key} in #{namespace.name} " +
+                "with #{namespace.resources.map(&:resource_name)}"
+        end
+      end
+
+      # The resource which initiated this relationship
+      attr_reader :owner
+
+      def initialize(owner, target_name, options = {})
+        @owner = owner
+        @target_name = target_name
+        @options = options
+      end
+
+      # Returns the target resource class or raises an exception if it doesn't exist
+      def target
+        resource or raise TargetNotFound.new (@options[:class_name] || @target_name.to_s.camelize), namespace
+      end
+
+      def resource
+        namespace.resources[@options[:class_name]] ||
+          namespace.resources[@target_name.to_s.camelize]
+      end
+
+      def namespace
+        @owner.namespace
+      end
+
+      def optional?
+        @options[:optional]
+      end
+
+      def required?
+        !optional?
+      end
+
+      def to_param
+        :"#{@target_name}_id"
+      end
+    end
+  end
+end

data/lib/active_admin/resource/controllers.rb

@@ -0,0 +1,19 @@
+module ActiveAdmin
+  class Resource
+    module Controllers
+      delegate :resources_configuration, to: :controller
+
+      # Returns a properly formatted controller name for this
+      # config within its namespace
+      def controller_name
+        [namespace.module_name, resource_name.plural.camelize + "Controller"].compact.join('::')
+      end
+
+      # Returns the controller for this config
+      def controller
+        @controller ||= controller_name.constantize
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/includes.rb

@@ -0,0 +1,12 @@
+module ActiveAdmin
+  class Resource
+    module Includes
+
+      # Return an array of includes for this resource
+      def includes
+        @includes ||= []
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/menu.rb

@@ -0,0 +1,67 @@
+module ActiveAdmin
+  class Resource
+
+    module Menu
+
+      # Set the menu options.
+      # To disable this menu item, call `menu(false)` from the DSL
+      def menu_item_options=(options)
+        if options == false
+          @include_in_menu   = false
+          @menu_item_options = {}
+        else
+          @include_in_menu = true
+          @navigation_menu_name = options[:menu_name]
+          @menu_item_options    = default_menu_options.merge options
+        end
+      end
+
+      def menu_item_options
+        @menu_item_options ||= default_menu_options
+      end
+
+      def default_menu_options
+        # These local variables are accessible to the procs.
+        menu_resource_class = respond_to?(:resource_class) ? resource_class : self
+        resource = self
+        {
+          id: resource_name.plural,
+          label: proc { resource.plural_resource_label },
+          url:   proc { resource.route_collection_path(params, url_options) },
+          if:    proc { authorized?(Auth::READ, menu_resource_class) }
+        }
+      end
+
+      def navigation_menu_name=(menu_name)
+        self.menu_item_options = { menu_name: menu_name }
+      end
+
+      def navigation_menu_name
+        case @navigation_menu_name ||= DEFAULT_MENU
+        when Proc
+          controller.instance_exec(&@navigation_menu_name).to_sym
+        else
+          @navigation_menu_name
+        end
+      end
+
+      def navigation_menu
+        namespace.fetch_menu(navigation_menu_name)
+      end
+
+      def add_to_menu(menu_collection)
+        if include_in_menu?
+          @menu_item = menu_collection.add navigation_menu_name, menu_item_options
+        end
+      end
+
+      attr_reader :menu_item
+
+      # Should this resource be added to the menu system?
+      def include_in_menu?
+        @include_in_menu != false
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/naming.rb

@@ -0,0 +1,62 @@
+module ActiveAdmin
+  class Resource
+
+    module Naming
+      def resource_name
+        @resource_name ||= begin
+          as = @options[:as].gsub /\s/, '' if @options[:as]
+
+          if as || !resource_class.respond_to?(:model_name)
+            Name.new resource_class, as
+          else
+            Name.new resource_class
+          end
+        end
+      end
+
+      # Returns the name to call this resource such as "Bank Account"
+      def resource_label
+        resource_name.translate count: 1,
+          default: resource_name.to_s.gsub('::', ' ').titleize
+      end
+
+      # Returns the plural version of this resource such as "Bank Accounts"
+      def plural_resource_label(options = {})
+        defaults = { count:   Helpers::I18n::PLURAL_MANY_COUNT,
+                    default: resource_label.pluralize.titleize }
+        resource_name.translate defaults.merge options
+      end
+
+      # Forms use the model's original `param_key`, so we can't use our
+      # custom `resource_name` when the model's been renamed in ActiveAdmin.
+      def param_key
+        if resource_class.respond_to? :model_name
+          resource_class.model_name.param_key
+        else
+          resource_name.param_key
+        end
+      end
+    end
+
+    class Name < ActiveModel::Name
+      delegate :hash, to: :to_str
+
+      def initialize(klass, name = nil)
+        super(klass, nil, name)
+      end
+
+      def translate(options = {})
+        I18n.t i18n_key, { scope: [:activerecord, :models] }.merge(options)
+      end
+
+      def route_key
+        plural
+      end
+
+      def eql?(other)
+        to_str.eql?(other.to_str)
+      end
+    end
+
+  end
+end

data/lib/active_admin/resource/ordering.rb

@@ -0,0 +1,11 @@
+module ActiveAdmin
+  class Resource
+    module Ordering
+
+      def ordering
+        @ordering ||= {}.with_indifferent_access
+      end
+
+    end
+  end
+end

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
+      # @return [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,23 @@
+module ActiveAdmin
+
+  class Resource
+    module Pagination
+
+      # The default number of records to display per page
+      attr_accessor :per_page
+
+      # The default number of records to display per page
+      attr_accessor :max_per_page
+
+      # Enable / disable pagination (defaults to true)
+      attr_accessor :paginate
+
+      def initialize(*args)
+        super
+        @paginate = true
+        @per_page = namespace.default_per_page
+        @max_per_page = namespace.max_per_page
+      end
+    end
+  end
+end

data/lib/active_admin/resource/routes.rb

@@ -0,0 +1,139 @@
+module ActiveAdmin
+  class Resource
+    module Routes
+      # @param params [Hash] of params: { study_id: 3 }
+      # @return [String] the path to this resource collection page
+      # @example "/admin/posts"
+      def route_collection_path(params = {}, additional_params = {})
+        route_builder.collection_path(params, additional_params)
+      end
+
+      def route_batch_action_path(params = {}, additional_params = {})
+        route_builder.batch_action_path(params, additional_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, additional_params = {})
+        route_builder.instance_path(resource, additional_params)
+      end
+
+      def route_edit_instance_path(resource, additional_params = {})
+        route_builder.member_action_path(:edit, resource, additional_params)
+      end
+
+      def route_member_action_path(action, resource, additional_params = {})
+        route_builder.member_action_path(action, resource, additional_params)
+      end
+
+      # Returns the routes prefix for this config
+      def route_prefix
+        namespace.route_prefix
+      end
+
+      def route_builder
+        @route_builder ||= RouteBuilder.new(self)
+      end
+
+      def route_uncountable?
+        config = 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, additional_params = {})
+          route_name = route_name(
+            resource.resources_configuration[:self][:route_collection_name],
+            suffix: (resource.route_uncountable? ? "index_path" : "path")
+          )
+
+          routes.public_send route_name, *route_collection_params(params), additional_params
+        end
+
+        def batch_action_path(params, additional_params = {})
+          route_name = route_name(
+            resource.resources_configuration[:self][:route_collection_name],
+            action: :batch_action,
+            suffix: (resource.route_uncountable? ? "index_path" : "path")
+          )
+
+          query = params.slice(:q, :scope)
+          query = query.permit!.to_h
+          routes.public_send route_name, *route_collection_params(params), additional_params.merge(query)
+        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, additional_params = {})
+          route_name = route_name(resource.resources_configuration[:self][:route_instance_name])
+
+          routes.public_send route_name, *route_instance_params(instance), additional_params
+        end
+
+        # @return [String] the path to the member action of this resource
+        # @param action [Symbol]
+        # @param instance [ActiveRecord::Base] the instance we want the path of
+        # @example "/admin/posts/1/edit"
+        def member_action_path(action, instance, additional_params = {})
+          path = resource.resources_configuration[:self][:route_instance_name]
+          route_name = route_name(path, action: action)
+
+          routes.public_send route_name, *route_instance_params(instance), additional_params
+        end
+
+        private
+
+        attr_reader :resource
+
+        def route_name(resource_path_name, options = {})
+          suffix = options[:suffix] || "path"
+          route = []
+
+          route << options[:action]           # "batch_action", "edit" or "new"
+          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.public_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
+          Helpers::Routes
+        end
+      end
+    end
+  end
+end