activeadmin-rails 1.7.0

data/lib/active_admin/pundit_adapter.rb

@@ -0,0 +1,68 @@
+ActiveAdmin::Dependency.pundit!
+
+require 'pundit'
+
+# Add a setting to the application to configure the pundit default policy
+ActiveAdmin::Application.inheritable_setting :pundit_default_policy, nil
+
+module ActiveAdmin
+
+  class PunditAdapter < AuthorizationAdapter
+
+    def authorized?(action, subject = nil)
+      policy = retrieve_policy(subject)
+      action = format_action(action, subject)
+
+      policy.respond_to?(action) && policy.public_send(action)
+    end
+
+    def scope_collection(collection, action = Auth::READ)
+      # scoping is appliable only to read/index action
+      # which means there is no way how to scope other actions
+      Pundit.policy_scope!(user, collection)
+    rescue Pundit::NotDefinedError => e
+      if default_policy_class && default_policy_class.const_defined?(:Scope)
+        default_policy_class::Scope.new(user, collection).resolve
+      else
+        raise e
+      end
+    end
+
+    def retrieve_policy(subject)
+      case subject
+      when nil   then Pundit.policy!(user, resource)
+      when Class then Pundit.policy!(user, subject.new)
+      else Pundit.policy!(user, subject)
+      end
+    rescue Pundit::NotDefinedError => e
+      if default_policy_class
+        default_policy(user, subject)
+      else
+        raise e
+      end
+    end
+
+    def format_action(action, subject)
+      # https://github.com/elabs/pundit/blob/master/lib/generators/pundit/install/templates/application_policy.rb
+      case action
+      when Auth::CREATE  then :create?
+      when Auth::UPDATE  then :update?
+      when Auth::READ    then subject.is_a?(Class) ? :index? : :show?
+      when Auth::DESTROY then subject.is_a?(Class) ? :destroy_all? : :destroy?
+      else "#{action}?"
+      end
+    end
+
+    private
+
+    def default_policy_class
+      ActiveAdmin.application.pundit_default_policy && ActiveAdmin.application.pundit_default_policy.constantize
+    end
+
+    def default_policy(user, subject)
+      default_policy_class.new(user, subject)
+    end
+
+  end
+
+end

data/lib/active_admin/resource/action_items.rb

@@ -0,0 +1,120 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module ActionItems
+
+      # Adds the default action items to a resource when it's initialized
+      def initialize(*args)
+        super
+        add_default_action_items
+      end
+
+      # @return [Array] The set of action items for this resource
+      def action_items
+        @action_items ||= []
+      end
+
+      # Add a new action item to a resource
+      #
+      # @param [Symbol] name
+      # @param [Hash] options valid keys include:
+      #                 :only:  A single or array of controller actions to display
+      #                         this action item on.
+      #                 :except: A single or array of controller actions not to
+      #                          display this action item on.
+      #                 :priority: A single integer value. To control the display order. Default is 10.
+      def add_action_item(name, options = {}, &block)
+        self.action_items << ActiveAdmin::ActionItem.new(name, options, &block)
+      end
+
+      def remove_action_item(name)
+        self.action_items.delete_if { |item| item.name == name }
+      end
+
+      # Returns a set of action items to display for a specific controller action
+      #
+      # @param [String, Symbol] action the action to retrieve action items for
+      #
+      # @return [Array] Array of ActionItems for the controller actions
+      def action_items_for(action, render_context = nil)
+        action_items.select { |item| item.display_on? action, render_context }.sort_by(&:priority)
+      end
+
+      # Clears all the existing action items for this resource
+      def clear_action_items!
+        @action_items = []
+      end
+
+      # Used by active_admin Base view
+      def action_items?
+        !!@action_items && @action_items.any?
+      end
+
+      private
+
+      # Adds the default action items to each resource
+      def add_default_action_items
+        add_default_new_action_item
+        add_default_edit_action_item
+        add_default_show_action_item
+      end
+
+      # Adds the default New link on index
+      def add_default_new_action_item
+        add_action_item :new, only: :index do
+          if controller.action_methods.include?('new') && authorized?(ActiveAdmin::Auth::CREATE, active_admin_config.resource_class)
+            localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+            link_to localizer.t(:new_model), new_resource_path
+          end
+        end
+      end
+
+      # Adds the default Edit link on show
+      def add_default_edit_action_item
+        add_action_item :edit, only: :show do
+          if controller.action_methods.include?('edit') && authorized?(ActiveAdmin::Auth::UPDATE, resource)
+            localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+            link_to localizer.t(:edit_model), edit_resource_path(resource)
+          end
+        end
+      end
+
+      # Adds the default Destroy link on show
+      def add_default_show_action_item
+        add_action_item :destroy, only: :show do
+          if controller.action_methods.include?('destroy') && authorized?(ActiveAdmin::Auth::DESTROY, resource)
+            localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+            link_to localizer.t(:delete_model), resource_path(resource), method: :delete,
+              data: {confirm: localizer.t(:delete_confirmation)}
+          end
+        end
+      end
+
+    end
+  end
+
+  # Model class to store the data for ActionItems
+  class ActionItem
+    include ActiveAdmin::OptionalDisplay
+
+    attr_accessor :block, :name
+
+    def initialize(name, options = {}, &block)
+      @name = name
+      @options = options
+      @block = block
+      normalize_display_options!
+    end
+
+    def html_class
+      "action_item #{@options[:class]}".rstrip
+    end
+
+    def priority
+      @options[:priority] || 10
+    end
+  end
+
+end

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,48 @@
+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, @target_name, @options = owner, target_name, 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,65 @@
+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)
+        @menu_item_options = options
+      end
+
+      def menu_item_options
+        @menu_item_options ||= {}
+        @menu_item_options.reverse_merge(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
+        navigation_menu_name = @menu_item_options[:menu_name] if @menu_item_options
+        navigation_menu_name ||= DEFAULT_MENU
+
+        case navigation_menu_name
+        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
+
+      # Invoked by namespace when menu is about to be rendered.
+      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?
+        @menu_item_options != 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,90 @@
+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 page options for a given action
+      #
+      # @param [String, Symbol] action The action to store this configuration for
+      def set_page_options(action, options)
+        options[:as] ||= :table if action.to_sym == :index
+        set_page_presenter(action, PagePresenter.new(options))
+      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