nsm-activeadmin 0.2.2

data/lib/active_admin/resource.rb

@@ -0,0 +1,151 @@
+require 'active_admin/resource/action_items'
+require 'active_admin/resource/menu'
+require 'active_admin/resource/naming'
+require 'active_admin/resource/scopes'
+require 'active_admin/resource/sidebars'
+
+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
+
+    autoload :BelongsTo, 'active_admin/resource/belongs_to'
+
+    # The namespace this resource belongs to
+    attr_reader :namespace
+
+    # The class this resource wraps. If you register the Post model, Resource#resource
+    # will point to the Post class
+    attr_reader :resource
+
+    # A hash of page configurations for the controller indexed by action name
+    attr_reader :page_configs
+
+    # An array of member actions defined for this resource
+    attr_reader :member_actions
+
+    # An array of collection actions defined for this resource
+    attr_reader :collection_actions
+
+    # The default sort order to use in the controller
+    attr_accessor :sort_order
+
+    # Scope this resource to an association in the controller
+    attr_accessor :scope_to
+
+    # If we're scoping resources, use this method on the parent to return the collection
+    attr_accessor :scope_to_association_method
+
+    # Set to false to turn off admin notes
+    attr_accessor :admin_notes
+
+    # Set the configuration for the CSV
+    attr_writer :csv_builder
+
+    module Base
+      def initialize(namespace, resource, options = {})
+        @namespace = namespace
+        @resource = resource
+        @options = default_options.merge(options)
+        @sort_order = @options[:sort_order]
+        @page_configs = {}
+        @member_actions, @collection_actions = [], []
+      end
+    end
+
+    include Base
+    include ActionItems
+    include Menu
+    include Naming
+    include Scopes
+    include Sidebars
+
+
+    def resource_table_name
+      resource.quoted_table_name
+    end
+
+    # Returns a properly formatted controller name for this
+    # resource within its namespace
+    def controller_name
+      [namespace.module_name, camelized_resource_name.pluralize + "Controller"].compact.join('::')
+    end
+
+    # Returns the controller for this resource
+    def controller
+      @controller ||= controller_name.constantize
+    end
+
+    # Returns the routes prefix for this resource
+    def route_prefix
+      namespace.module_name.try(:underscore)
+    end
+
+    # Returns a symbol for the route to use to get to the
+    # collection of this resource
+    def route_collection_path
+      [route_prefix, controller.resources_configuration[:self][:route_collection_name], 'path'].compact.join('_').to_sym
+    end
+
+    # Returns the named route for an instance of this resource
+    def route_instance_path
+      [route_prefix, controller.resources_configuration[:self][:route_instance_name], 'path'].compact.join('_').to_sym
+    end
+
+    # Clears all the member actions this resource knows about
+    def clear_member_actions!
+      @member_actions = []
+    end
+
+    def clear_collection_actions!
+      @collection_actions = []
+    end
+
+    # Are admin notes turned on for this resource
+    def admin_notes?
+      admin_notes.nil? ? ActiveAdmin.admin_notes : admin_notes
+    end
+
+    def belongs_to(target, options = {})
+      @belongs_to = Resource::BelongsTo.new(self, target, options)
+      controller.belongs_to(target, options.dup)
+    end
+
+    def belongs_to_config
+      @belongs_to
+    end
+
+    # Do we belong to another resource
+    def belongs_to?
+      !belongs_to_config.nil?
+    end
+
+    # The csv builder for this resource
+    def csv_builder
+      @csv_builder || default_csv_builder
+    end
+
+    private
+
+    def default_options
+      {
+        :namespace  => ActiveAdmin.application.default_namespace,
+        :sort_order => "#{resource.respond_to?(:primary_key) ? resource.primary_key : 'id'}_desc"
+      }
+    end
+
+    def default_csv_builder
+      @default_csv_builder ||= CSVBuilder.default_for_resource(resource)
+    end
+  end # class Resource
+end # module ActiveAdmin

data/lib/active_admin/resource/action_items.rb

@@ -0,0 +1,88 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module ActionItems
+
+      # Add 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 [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.
+      def add_action_item(options = {}, &block)
+        self.action_items << ActiveAdmin::ActionItem.new(options, &block)
+      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)
+        action_items.select{|item| item.display_on?(action) }
+      end
+
+      # Clears all the existing action items for this resource
+      def clear_action_items!
+        @action_items = []
+      end
+
+      private
+
+      # Adds the default action items to each resource
+      def add_default_action_items
+        # New Link on all actions except :new and :show
+        add_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
+
+        # Edit link on show
+        add_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
+
+        # Destroy link on show
+        add_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
+      end
+
+    end
+  end
+
+  # Model class to store the data for ActionItems
+  class ActionItem
+    include ActiveAdmin::OptionalDisplay
+
+    attr_accessor :block
+
+    def initialize(options = {}, &block)
+      @options, @block = options, block
+      normalize_display_options!
+    end
+  end
+
+end

data/lib/active_admin/resource/belongs_to.rb

@@ -0,0 +1,31 @@
+module ActiveAdmin
+  class Resource
+    class BelongsTo
+
+      class TargetNotFound < StandardError; end
+
+      # The resource which initiated this relationship
+      attr_reader :owner
+
+      def initialize(owner_resource, target_name, options = {})
+        @owner, @target_name = owner_resource, target_name
+        @options = options
+      end
+
+      # Returns the target resource class or raises an exception if it doesn't exist
+      def target
+        namespace.resources[@target_name.to_s.camelize] or 
+          raise TargetNotFound, "Could not find registered resource #{@target_name} in #{namespace.name} with #{namespace.resources.keys.inspect}"
+      end
+
+      def namespace
+        @owner.namespace
+      end
+
+      def optional?
+        @options[:optional]
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/menu.rb

@@ -0,0 +1,45 @@
+module ActiveAdmin
+  class Resource
+    module Menu
+
+      # Set the menu options. To not add this resource to the menu, just
+      # call #menu(false)
+      def menu(options = {})
+        options = options == false ? { :display => false } : options
+        @menu_options = options
+      end
+
+      # The options to use for the menu
+      def menu_options
+        @menu_options ||= {}
+      end
+
+      # Returns the name to put this resource under in the menu
+      def parent_menu_item_name
+        menu_options[:parent]
+      end
+
+      # Returns the name to be displayed in the menu for this resource
+      def menu_item_name
+        menu_options[:label] || plural_resource_name
+      end
+
+      # Returns the items priority for altering the default sort order
+      def menu_item_priority
+        menu_options[:priority] || 10
+      end
+
+      # Returns a proc for deciding whether to display the menu item or not in the view
+      def menu_item_display_if
+        menu_options[:if] || proc { true }
+      end
+
+      # Should this resource be added to the menu system?
+      def include_in_menu?
+        return false if menu_options[:display] == false
+        !(belongs_to? && !belongs_to_config.optional?)
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/naming.rb

@@ -0,0 +1,36 @@
+module ActiveAdmin
+  class Resource
+    module Naming
+
+      # An underscored safe representation internally for this resource
+      def underscored_resource_name
+        @underscored_resource_name ||= if @options[:as]
+          @options[:as].gsub(' ', '').underscore.singularize
+        else
+          resource.name.gsub('::','').underscore
+        end
+      end
+
+      # A camelized safe representation for this resource
+      def camelized_resource_name
+        underscored_resource_name.camelize
+      end
+
+      # Returns the name to call this resource.
+      # By default will use resource.model_name.human
+      def resource_name
+        @resource_name ||= if @options[:as] || !resource.respond_to?(:model_name)
+          underscored_resource_name.titleize
+        else
+          resource.model_name.human.titleize
+        end
+      end
+
+      # Returns the plural version of this resource
+      def plural_resource_name
+        @plural_resource_name ||= resource_name.pluralize
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/scopes.rb

@@ -0,0 +1,33 @@
+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
+        @default_scope
+      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!
+        self.scopes << ActiveAdmin::Scope.new(*args, &block)
+        if options[:default]
+          @default_scope = scopes.last
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource/sidebars.rb

@@ -0,0 +1,36 @@
+require 'active_admin/helpers/optional_display'
+
+module ActiveAdmin
+
+  class Resource
+    module Sidebars
+
+      def initialize(*args)
+        super
+        add_default_sidebar_sections
+      end
+
+      def sidebar_sections
+        @sidebar_sections ||= []
+      end
+
+      def clear_sidebar_sections!
+        @sidebar_sections = []
+      end
+
+      def sidebar_sections_for(action)
+        sidebar_sections.select{|section| section.display_on?(action) }
+      end
+
+      private
+
+      def add_default_sidebar_sections
+        self.sidebar_sections << ActiveAdmin::SidebarSection.new(:filters, :only => :index) do
+          active_admin_filters_form_for assigns["search"], filters_config
+        end
+      end
+
+    end
+  end
+
+end

data/lib/active_admin/resource_controller.rb

@@ -0,0 +1,103 @@
+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'
+
+module ActiveAdmin
+  class ResourceController < ::InheritedResources::Base
+
+    helper ::ActiveAdmin::ViewHelpers
+
+    layout :determine_active_admin_layout
+
+    respond_to :html, :xml, :json
+    respond_to :csv, :only => :index
+
+    before_filter :only_render_implemented_actions
+    before_filter :authenticate_active_admin_user
+
+    ACTIVE_ADMIN_ACTIONS = [:index, :show, :new, :create, :edit, :update, :destroy]
+
+    include Actions
+    include ActionBuilder
+    include Callbacks
+    include Collection
+    include Filters
+    include Form
+    include Menu
+    include PageConfigurations
+    include Scoping
+
+    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
+
+    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
+
+    # Determine which layout to use.
+    #
+    #   1.  If we're rendering a standard Active Admin action, we want layout(false)
+    #       because these actions are subclasses of the Base page (which implementes
+    #       all the required layout code)
+    #   2.  If we're rendering a custom action, we'll use the active_admin layout so
+    #       that users can render any template inside Active Admin.
+    def determine_active_admin_layout
+      ACTIVE_ADMIN_ACTIONS.include?(params[:action].to_sym) ? false : 'active_admin'
+    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