activeadmin-rails 1.7.0

data/lib/active_admin/resource/routes.rb

@@ -0,0 +1,134 @@
+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.edit_instance_path(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 edit page of this resource
+        # @param instance [ActiveRecord::Base] the instance we want the path of
+        # @example "/admin/posts/1/edit"
+        def edit_instance_path(instance, additional_params = {})
+          path = resource.resources_configuration[:self][:route_instance_name]
+          route_name = route_name(path, action: :edit)
+
+          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

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,52 @@
+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)
+        default_options = {show_count: namespace.scopes_show_count}
+        options = default_options.merge(args.extract_options!)
+        title = args[0] rescue nil
+        method = args[1] rescue nil
+
+        options[:localizer] ||= ActiveAdmin::Localizers.resource(self)
+        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,32 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module Sidebars
+
+      def add_sidebar_section(name, options)
+        sidebar_sections << SidebarSection.new(name, options)
+      end
+
+      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) }
+          .sort_by(&:priority)
+      end
+
+      def sidebar_sections?
+        !!@sidebar_sections && @sidebar_sections.any?
+      end
+
+    end
+  end
+
+end

data/lib/active_admin/resource.rb

@@ -0,0 +1,215 @@
+require 'active_admin/resource/action_items'
+require 'active_admin/resource/attributes'
+require 'active_admin/resource/controllers'
+require 'active_admin/resource/menu'
+require 'active_admin/resource/page_presenters'
+require 'active_admin/resource/pagination'
+require 'active_admin/resource/routes'
+require 'active_admin/resource/naming'
+require 'active_admin/resource/scopes'
+require 'active_admin/resource/includes'
+require 'active_admin/resource/scope_to'
+require 'active_admin/resource/sidebars'
+require 'active_admin/resource/belongs_to'
+require 'active_admin/resource/ordering'
+
+module ActiveAdmin
+
+  # Resource is the primary data storage for resource configuration in Active Admin
+  #
+  # When you register a resource (ActiveAdmin.register Post) you are actually creating
+  # a new Resource instance within the given Namespace.
+  #
+  # The instance of the current resource is available in ResourceController and views
+  # by calling the #active_admin_config method.
+  #
+  class Resource
+
+    # Event dispatched when a new resource is registered
+    RegisterEvent = 'active_admin.resource.register'.freeze
+
+    # The namespace this config belongs to
+    attr_reader :namespace
+
+    # The name of the resource class
+    attr_reader :resource_class_name
+
+    # An array of member actions defined for this resource
+    attr_reader :member_actions
+    def add_member_route(name, options)
+      member_actions << ControllerAction.new(name, options)
+    end
+
+    # An array of collection actions defined for this resource
+    attr_reader :collection_actions
+    def add_collection_route(name, options)
+      collection_actions << ControllerAction.new(name, options)
+    end
+
+    # The default sort order to use in the controller
+    attr_writer :sort_order
+    def sort_order
+      @sort_order ||= (resource_class.respond_to?(:primary_key) ? resource_class.primary_key.to_s : 'id') + '_desc'
+    end
+
+    # Set the configuration for the CSV
+    attr_writer :csv_builder
+
+    # Set breadcrumb builder
+    attr_writer :breadcrumb
+
+    #Set order clause
+    attr_writer :order_clause
+    # Display create another checkbox on a new page
+    # @return [Boolean]
+    attr_writer :create_another
+
+    # Store a reference to the DSL so that we can dereference it during garbage collection.
+    attr_accessor :dsl
+
+    # The string identifying a class to decorate our resource with for the view.
+    # nil to not decorate.
+    attr_accessor :decorator_class_name
+
+    # An array or proc returning whitelisted resource attribute names.
+    attr_accessor :permitted_attr_names
+
+    module Base
+      def initialize(namespace, resource_class, options = {})
+        @namespace = namespace
+        @resource_class_name = "::#{resource_class.name}"
+        @options    = options
+        @sort_order = options[:sort_order]
+        @member_actions, @collection_actions = [], []
+      end
+    end
+
+    include MethodOrProcHelper
+
+    include Base
+    include ActionItems
+    include Authorization
+    include Controllers
+    include Menu
+    include Naming
+    include PagePresenters
+    include Pagination
+    include Scopes
+    include Includes
+    include ScopeTo
+    include Sidebars
+    include Routes
+    include Ordering
+    include Attributes
+
+    # The class this resource wraps. If you register the Post model, Resource#resource_class
+    # will point to the Post class
+    def resource_class
+      resource_class_name.constantize
+    end
+
+    def decorator_class
+      decorator_class_name&.constantize
+    end
+
+    def resource_table_name
+      resource_class.quoted_table_name
+    end
+
+    def resource_column_names
+      resource_class.column_names
+    end
+
+    def resource_quoted_column_name(column)
+      resource_class.connection.quote_column_name(column)
+    end
+
+    # Clears all the member actions this resource knows about
+    def clear_member_actions!
+      @member_actions = []
+    end
+
+    def clear_collection_actions!
+      @collection_actions = []
+    end
+
+    # Return only defined resource actions
+    def defined_actions
+      controller.instance_methods.map(&:to_sym) & ResourceController::ACTIVE_ADMIN_ACTIONS
+    end
+
+    def belongs_to(target, options = {})
+      @belongs_to = Resource::BelongsTo.new(self, target, options)
+      self.menu_item_options = false if @belongs_to.required?
+      controller.send :belongs_to, target, options.dup
+    end
+
+    def belongs_to_config
+      @belongs_to
+    end
+
+    def belongs_to_param
+      if belongs_to? && belongs_to_config.required?
+        belongs_to_config.to_param
+      end
+    end
+
+    # Do we belong to another resource?
+    def belongs_to?
+      !!belongs_to_config
+    end
+
+    # The csv builder for this resource
+    def csv_builder
+      @csv_builder || default_csv_builder
+    end
+
+    def breadcrumb
+      instance_variable_defined?(:@breadcrumb) ? @breadcrumb : namespace.breadcrumb
+    end
+
+    def order_clause
+      @order_clause || namespace.order_clause
+    end
+
+    def create_another
+      instance_variable_defined?(:@create_another) ? @create_another : namespace.create_another
+    end
+
+    def find_resource(id)
+      resource = resource_class.public_send *method_for_find(id)
+      (decorator_class && resource) ? decorator_class.new(resource) : resource
+    end
+
+    def resource_columns
+      resource_attributes.values
+    end
+
+    def resource_attributes
+      @resource_attributes ||= default_attributes
+    end
+
+    def association_columns
+      @association_columns ||= resource_attributes.select{ |key, value| key != value }.values
+    end
+
+    def content_columns
+      @content_columns ||= resource_attributes.select{ |key, value| key == value }.values
+    end
+
+    private
+
+    def method_for_find(id)
+      if finder = resources_configuration[:self][:finder]
+        [finder, id]
+      else
+        [:find_by, { resource_class.primary_key => id }]
+      end
+    end
+
+    def default_csv_builder
+      @default_csv_builder ||= CSVBuilder.default_for_resource(self)
+    end
+
+  end # class Resource
+end # module ActiveAdmin

data/lib/active_admin/resource_collection.rb

@@ -0,0 +1,72 @@
+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 :@collection, :empty?, :has_key?, :keys, :values, :size
+
+    def initialize
+      @collection = {}
+    end
+
+    def add(resource)
+      if match = @collection[resource.resource_name]
+        raise_if_mismatched! match, resource
+        match
+      else
+        @collection[resource.resource_name] = resource
+      end
+    end
+
+    # Changes `each` to pass in the value, instead of both the key and value.
+    def each(&block)
+      values.each &block
+    end
+
+    def [](obj)
+      @collection[obj] || find_resource(obj)
+    end
+
+    private
+
+    # Finds a resource based on the resource name, resource class, or base class.
+    def find_resource(obj)
+      resources.detect do |r|
+        r.resource_name.to_s == obj.to_s
+      end || resources.detect do |r|
+        r.resource_class.to_s == obj.to_s
+      end ||
+      if obj.respond_to? :base_class
+        resources.detect{ |r| r.resource_class.to_s == obj.base_class.to_s }
+      end
+    end
+
+    def resources
+      select{ |r| r.class <= Resource } # can otherwise be a Page
+    end
+
+    def raise_if_mismatched!(existing, given)
+      if existing.class != given.class
+        raise IncorrectClass.new existing, given
+      elsif given.class <= Resource && existing.resource_class != given.resource_class
+        raise ConfigMismatch.new existing, given
+      end
+    end
+
+    class IncorrectClass < StandardError
+      def initialize(existing, given)
+        super "You're trying to register #{given.resource_name} which is a #{given.class}, " +
+              "but #{existing.resource_name}, a #{existing.class} has already claimed that name."
+      end
+    end
+
+    class ConfigMismatch < StandardError
+      def initialize(existing, given)
+        super "You're trying to register #{given.resource_class} as #{given.resource_name}, " +
+              "but the existing #{existing.class} config was built for #{existing.resource_class}!"
+      end
+    end
+
+  end
+end

data/lib/active_admin/resource_controller/action_builder.rb

@@ -0,0 +1,21 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+
+    module ActionBuilder
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def clear_member_actions!
+          active_admin_config.clear_member_actions!
+        end
+
+        def clear_collection_actions!
+          active_admin_config.clear_collection_actions!
+        end
+      end
+
+    end
+
+  end
+end