aa-rails4 0.6.0

data/lib/active_admin/menu_item.rb

@@ -0,0 +1,97 @@
+require 'active_admin/view_helpers/method_or_proc_helper'
+
+module ActiveAdmin
+  class MenuItem
+    include Menu::MenuNode
+    include MethodOrProcHelper
+
+    attr_reader :html_options, :parent, :priority
+
+    # Builds a new menu item
+    #
+    # @param [Hash] options The options for the menu
+    #
+    # @option options [String, Symbol, Proc] :label
+    #         The label to display for this menu item.
+    #         Default: Titleized Resource Name
+    #
+    # @option options [String] :id
+    #         A custom id to reference this menu item with.
+    #         Default: underscored_resource_name
+    #
+    # @option options [String, Symbol, Proc] :url
+    #         The URL this item will link to.
+    #
+    # @option options [Integer] :priority
+    #         The lower the priority, the earlier in the menu the item will be displayed.
+    #         Default: 10
+    #
+    # @option options [Symbol, Proc] :if
+    #         This decides whether the menu item will be displayed. Evaluated on each request.
+    #
+    # @option options [Hash] :html_options
+    #         A hash of options to pass to `link_to` when rendering the item
+    #
+    # @option [ActiveAdmin::MenuItem] :parent
+    #         This menu item's parent. It will be displayed nested below its parent.
+    #
+    # NOTE: for :label, :url, and :if
+    # These options are evaluated in the view context at render time. Symbols are called
+    # as methods on `self`, and Procs are exec'd within `self`.
+    # Here are some examples of what you can do:
+    #
+    #   menu if:  :admin?
+    #   menu url: :new_book_path
+    #   menu url: :awesome_helper_you_defined
+    #   menu label: ->{ User.some_method }
+    #   menu label: ->{ I18n.t 'menus.user' }
+    #
+    def initialize(options = {})
+      super() # MenuNode
+      @label          = options[:label]
+      @dirty_id       = options[:id]           || options[:label]
+      @url            = options[:url]          || '#'
+      @priority       = options[:priority]     || 10
+      @html_options   = options[:html_options] || {}
+      @should_display = options[:if]           || proc{true}
+      @parent         = options[:parent]
+
+      yield(self) if block_given? # Builder style syntax
+    end
+
+    def id
+      @id ||= normalize_id @dirty_id
+    end
+
+    def label(context = nil)
+      render_in_context context, @label
+    end
+
+    def url(context = nil)
+      render_in_context context, @url
+    end
+
+    # Don't display if the :if option passed says so
+    # Don't display if the link isn't real, we have children, and none of the children are being displayed.
+    def display?(context = nil)
+      return false unless render_in_context(context, @should_display)
+      return false if     !real_url?(context) && @children.any? && !items(context).any?
+      true
+    end
+
+    # Returns an array of the ancestory of this menu item.
+    # The first item is the immediate parent of the item.
+    def ancestors
+      parent ? [parent, parent.ancestors].flatten : []
+    end
+
+    private
+
+    # URL is not nil, empty, or '#'
+    def real_url?(context = nil)
+      url = url context
+      url.present? && url != '#'
+    end
+
+  end
+end

data/lib/active_admin/namespace.rb

@@ -0,0 +1,221 @@
+require 'active_admin/resource_collection'
+
+module ActiveAdmin
+
+  # Namespaces are the basic organizing principle for resources within Active Admin
+  #
+  # Each resource is registered into a namespace which defines:
+  #   * the namespaceing for routing
+  #   * the module to namespace controllers
+  #   * the menu which gets displayed (other resources in the same namespace)
+  #
+  # For example:
+  #
+  #   ActiveAdmin.register Post, :namespace => :admin
+  #
+  # Will register the Post model into the "admin" namespace. This will namespace the
+  # urls for the resource to "/admin/posts" and will set the controller to
+  # Admin::PostsController
+  #
+  # You can also register to the "root" namespace, which is to say no namespace at all.
+  #
+  #   ActiveAdmin.register Post, :namespace => false
+  #
+  # This will register the resource to an instantiated namespace called :root. The
+  # resource will be accessible from "/posts" and the controller will be PostsController.
+  #
+  class Namespace
+    RegisterEvent = 'active_admin.namespace.register'.freeze
+
+    attr_reader :application, :resources, :name, :menus
+
+    def initialize(application, name)
+      @application = application
+      @name = name.to_s.underscore.to_sym
+      @resources = ResourceCollection.new
+      register_module unless root?
+      build_menu_collection
+    end
+
+    # Register a resource into this namespace. The preffered method to access this is to
+    # use the global registration ActiveAdmin.register which delegates to the proper
+    # namespace instance.
+    def register(resource_class, options = {}, &block)
+      config = find_or_build_resource(resource_class, options)
+
+      # Register the resource
+      register_resource_controller(config)
+      parse_registration_block(config, &block) if block_given?
+      reset_menu!
+
+      # Dispatch a registration event
+      ActiveAdmin::Event.dispatch ActiveAdmin::Resource::RegisterEvent, config
+
+      # Return the config
+      config
+    end
+
+    def register_page(name, options = {}, &block)
+      config = build_page(name, options)
+
+      # Register the resource
+      register_page_controller(config)
+      parse_page_registration_block(config, &block) if block_given?
+      reset_menu!
+
+      config
+    end
+
+    def root?
+      name == :root
+    end
+
+    # Returns the name of the module if required. Will be nil if none
+    # is required.
+    #
+    # eg:
+    #   Namespace.new(:admin).module_name # => 'Admin'
+    #   Namespace.new(:root).module_name # => nil
+    #
+    def module_name
+      return nil if root?
+      @module_name ||= name.to_s.camelize
+    end
+
+    # Unload all the registered resources for this namespace
+    def unload!
+      unload_resources!
+      reset_menu!
+    end
+
+    # Returns the first registered ActiveAdmin::Resource instance for a given class
+    def resource_for(klass)
+      resources[klass]
+    end
+
+    # Override from ActiveAdmin::Settings to inherit default attributes
+    # from the application
+    def read_default_setting(name)
+      application.send(name)
+    end
+
+    def fetch_menu(name)
+      @menus.fetch(name)
+    end
+
+    def reset_menu!
+      @menus.clear!
+    end
+
+    # Add a callback to be ran when we build the menu
+    #
+    # @param [Symbol] name The name of the menu. Default: :default
+    # @param [Proc] block The block to be ran when the menu is built
+    #
+    # @returns [void]
+    def build_menu(name = DEFAULT_MENU, &block)
+      @menus.before_build do |menus|
+        menus.menu name do |menu|
+          block.call(menu)
+        end
+      end
+    end
+
+    # Add the default logout button to the menu, using the ActiveAdmin configuration settings
+    #
+    # @param [ActiveAdmin::MenuItem] menu The menu to add the logout link to
+    # @param [Fixnum] priority Override the default priority of 100 to position the logout button where you want
+    # @param [Hash] html_options An options hash to pass along to link_to
+    #
+    # @returns [void]
+    def add_logout_button_to_menu(menu, priority=100, html_options={})
+      if logout_link_path
+        logout_method = logout_link_method || :get
+        menu.add :id           => 'logout',
+                 :priority     => priority,
+                 :label        => proc{ I18n.t('active_admin.logout') },
+                 :html_options => html_options.reverse_merge(:method => logout_method),
+                 :url          => proc{ render_or_call_method_or_proc_on self, active_admin_namespace.logout_link_path },
+                 :if           => proc{ current_active_admin_user? }
+      end
+    end
+
+    protected
+
+    def build_menu_collection
+      @menus = MenuCollection.new
+
+      @menus.on_build do |menus|
+        build_default_utility_nav
+
+        resources.each do |resource|
+          resource.add_to_menu(@menus)
+        end
+      end
+    end
+
+    # Builds the default utility navigation in top right header with current user & logout button
+    def build_default_utility_nav
+      return if @menus.exists? :utility_navigation
+      @menus.menu :utility_navigation do |menu|
+        menu.add  :label  => proc{ display_name current_active_admin_user },
+                  :url    => proc{ url_for [active_admin_namespace.name, current_active_admin_user] rescue '#' },
+                  :id     => 'current_user',
+                  :if     => proc{ current_active_admin_user? }
+
+        add_logout_button_to_menu menu
+      end
+    end
+
+    # Either returns an existing Resource instance or builds a new
+    # one for the resource and options
+    def find_or_build_resource(resource_class, options)
+      resources.add Resource.new(self, resource_class, options)
+    end
+
+    def build_page(name, options)
+      resources.add Page.new(self, name, options)
+    end
+
+    def register_page_controller(config)
+      eval "class ::#{config.controller_name} < ActiveAdmin::PageController; end"
+      config.controller.active_admin_config = config
+    end
+
+    def unload_resources!
+      resources.each do |resource|
+        parent = (module_name || 'Object').constantize
+        const_name = resource.controller_name.split('::').last
+        # Remove the const if its been defined
+        parent.send(:remove_const, const_name) if parent.const_defined?(const_name)
+
+        # Remove circular references
+        resource.controller.active_admin_config = nil
+        if resource.is_a?(Resource) && resource.dsl
+          resource.dsl.run_registration_block { @config = nil }
+        end
+      end
+      @resources = ResourceCollection.new
+    end
+
+    # Creates a ruby module to namespace all the classes in if required
+    def register_module
+      eval "module ::#{module_name}; end"
+    end
+
+    def register_resource_controller(config)
+      eval "class ::#{config.controller_name} < ActiveAdmin::ResourceController; end"
+      config.controller.active_admin_config = config
+    end
+
+    def parse_registration_block(config, &block)
+      config.dsl = ResourceDSL.new(config)
+      config.dsl.run_registration_block(&block)
+    end
+
+    def parse_page_registration_block(config, &block)
+      PageDSL.new(config).run_registration_block(&block)
+    end
+
+  end
+end

data/lib/active_admin/page.rb

@@ -0,0 +1,88 @@
+module ActiveAdmin
+  # Page is the primary data storage for page configuration in Active Admin
+  #
+  # When you register a page (ActiveAdmin.page "Status") you are actually creating
+  # a new Page instance within the given Namespace.
+  #
+  # The instance of the current page is available in PageController and views
+  # by calling the #active_admin_config method.
+  #
+  class Page
+
+    # The namespace this config belongs to
+    attr_reader :namespace
+
+    # The name of the page
+    attr_reader :name
+
+    # An array of custom actions defined for this page
+    attr_reader :page_actions
+
+    # Set breadcrumb builder
+    attr_accessor :breadcrumb
+
+    module Base
+      def initialize(namespace, name, options)
+        @namespace = namespace
+        @name = name
+        @options = options
+        @page_actions = []
+      end
+    end
+
+    include Base
+    include Resource::Controllers
+    include Resource::PagePresenters
+    include Resource::Sidebars
+    include Resource::ActionItems
+    include Resource::Menu
+    include Resource::Naming
+    include Resource::Routes
+
+    # label is singular
+    def plural_resource_label
+      name
+    end
+
+    def resource_name
+      @resource_name ||= Resource::Name.new(nil, name)
+    end
+
+    def underscored_resource_name
+      resource_name.to_s.parameterize.underscore
+    end
+
+    def camelized_resource_name
+      underscored_resource_name.camelize
+    end
+
+    def default_menu_options
+      super.merge(:id => resource_name)
+    end
+
+    def controller_name
+      [namespace.module_name, camelized_resource_name + "Controller"].compact.join('::')
+    end
+
+    # Override from `ActiveAdmin::Resource::Controllers`
+    def route_uncountable?
+      false
+    end
+
+    def belongs_to?
+      false
+    end
+
+    def add_default_action_items
+    end
+
+    def add_default_sidebar_sections
+    end
+
+    # Clears all the custom actions this page knows about
+    def clear_page_actions!
+      @page_actions = []
+    end
+
+  end
+end

data/lib/active_admin/page_controller.rb

@@ -0,0 +1,29 @@
+module ActiveAdmin
+
+  # All Pages controllers inherit from this controller.
+  class PageController < BaseController
+
+    # Active admin actions don't require layout.  All custom actions do.
+    ACTIVE_ADMIN_ACTIONS = [:index]
+
+    actions :index
+
+    before_filter :authorize_access!
+
+    def index(options={}, &block)
+      render "active_admin/page/index"
+    end
+
+    def clear_page_actions!
+      active_admin_config.clear_page_actions!
+    end
+
+    private
+
+    def authorize_access!
+      permission = action_to_permission(params[:action])
+      authorize! permission, active_admin_config
+    end
+
+  end
+end

data/lib/active_admin/page_dsl.rb

@@ -0,0 +1,28 @@
+module ActiveAdmin
+  # This is the class where all the register_page blocks are instance eval'd
+  class PageDSL < DSL
+
+    # Page content.
+    #
+    # The block should define the view using Arbre.
+    #
+    # Example:
+    #
+    #   ActiveAdmin.register "My Page" do
+    #     content do
+    #       para "Sweet!"
+    #     end
+    #   end
+    #
+    def content(options = {}, &block)
+      config.set_page_presenter :index, ActiveAdmin::PagePresenter.new(options, &block)
+    end
+
+    def page_action(name, options = {}, &block)
+      config.page_actions << ControllerAction.new(name, options)
+      controller do
+        define_method(name, &block || Proc.new{})
+      end
+    end
+  end
+end