activeadmin 2.2.0

data/lib/active_admin/menu_item.rb

@@ -0,0 +1,69 @@
+module ActiveAdmin
+  class MenuItem
+    include Menu::MenuNode
+
+    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
+
+    attr_reader :label
+    attr_reader :url
+
+    # Don't display if the :if option passed says so
+    attr_reader :should_display
+  end
+end

data/lib/active_admin/namespace.rb

@@ -0,0 +1,266 @@
+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
+    class << self
+      def setting(name, default)
+        Deprecation.warn "This method does not do anything and will be removed."
+      end
+    end
+
+    RegisterEvent = 'active_admin.namespace.register'.freeze
+
+    attr_reader :application, :resources, :menus
+
+    def initialize(application, name)
+      @application = application
+      @name = name.to_s.underscore
+      @resources = ResourceCollection.new
+      register_module unless root?
+      build_menu_collection
+    end
+
+    def name
+      @name.to_sym
+    end
+
+    def settings
+      @settings ||= SettingsNode.build(application.namespace_settings)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      settings.respond_to?(method) || super
+    end
+
+    def method_missing(method, *args)
+      settings.respond_to?(method) ? settings.send(method, *args) : super
+    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
+      ActiveSupport::Notifications.publish 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
+      root? ? nil : @name.camelize
+    end
+
+    def route_prefix
+      root? ? nil : @name
+    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
+
+    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
+    # @yield [ActiveAdmin::Menu] The block to be ran when the menu is built
+    #
+    # @return [void]
+    def build_menu(name = DEFAULT_MENU)
+      @menus.before_build do |menus|
+        menus.menu name do |menu|
+          yield menu
+        end
+      end
+    end
+
+    # The default logout menu item
+    #
+    # @param [ActiveAdmin::MenuItem] menu The menu to add the logout link to
+    # @param [Fixnum] priority The numeric priority for the order in which it appears
+    # @param [Hash] html_options An options hash to pass along to link_to
+    #
+    def add_logout_button_to_menu(menu, priority = 20, html_options = {})
+      if logout_link_path
+        html_options = html_options.reverse_merge(method: logout_link_method || :get)
+        menu.add id: 'logout', priority: priority, html_options: html_options,
+          label: -> { I18n.t 'active_admin.logout' },
+          url:   -> { render_or_call_method_or_proc_on self, active_admin_namespace.logout_link_path },
+          if:    :current_active_admin_user?
+      end
+    end
+
+    # The default user session menu item
+    #
+    # @param [ActiveAdmin::MenuItem] menu The menu to add the logout link to
+    # @param [Fixnum] priority The numeric priority for the order in which it appears
+    # @param [Hash] html_options An options hash to pass along to link_to
+    #
+    def add_current_user_to_menu(menu, priority = 10, html_options = {})
+      if current_user_method
+        menu.add id: 'current_user', priority: priority, html_options: html_options,
+          label: -> { display_name current_active_admin_user },
+          url:   -> { auto_url_for(current_active_admin_user) },
+          if:    :current_active_admin_user?
+      end
+    end
+
+    protected
+
+    def build_menu_collection
+      @menus = MenuCollection.new
+
+      @menus.on_build do
+        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|
+        add_current_user_to_menu menu
+        add_logout_button_to_menu menu
+      end
+    end
+
+    # Either returns an existing Resource instance or builds a new one.
+    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
+
+    # TODO: replace `eval` with `Class.new`
+    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
+        name   = resource.controller_name.split('::').last
+        parent.send(:remove_const, name) if parent.const_defined?(name, false)
+
+        # 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
+      unless Object.const_defined? module_name
+        Object.const_set module_name, Module.new
+      end
+    end
+
+    # TODO: replace `eval` with `Class.new`
+    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
+
+    class Store
+      include Enumerable
+      delegate :[], :[]=, :empty?, to: :@namespaces
+
+      def initialize
+        @namespaces = {}
+      end
+
+      def each(&block)
+        @namespaces.values.each(&block)
+      end
+
+      def names
+        @namespaces.keys
+      end
+    end
+  end
+end

data/lib/active_admin/namespace_settings.rb

@@ -0,0 +1,110 @@
+require 'active_admin/dynamic_settings_node'
+
+module ActiveAdmin
+  class NamespaceSettings < DynamicSettingsNode
+    # The default number of resources to display on index pages
+    register :default_per_page, 30
+
+    # The max number of resources to display on index pages and batch exports
+    register :max_per_page, 10_000
+
+    # The title which gets displayed in the main layout
+    register :site_title, "", :string_symbol_or_proc
+
+    # Set the site title link href (defaults to AA dashboard)
+    register :site_title_link, ""
+
+    # Set the site title image displayed in the main layout (has precendence over :site_title)
+    register :site_title_image, "", :string_symbol_or_proc
+
+    # Add to the site head
+    register :head, "", :string_symbol_or_proc
+
+    # Set the site footer text (defaults to Powered by ActiveAdmin text with version)
+    register :footer, "", :string_symbol_or_proc
+
+    # Set a favicon
+    register :favicon, false
+
+    # Additional meta tags to place in head of logged in pages
+    register :meta_tags, {}
+
+    # Additional meta tags to place in head of logged out pages
+    register :meta_tags_for_logged_out_pages, { robots: "noindex, nofollow" }
+
+    # The view factory to use to generate all the view classes. Take
+    # a look at ActiveAdmin::ViewFactory
+    register :view_factory, ActiveAdmin::ViewFactory.new
+
+    # The method to call in controllers to get the current user
+    register :current_user_method, false
+
+    # The method to call in the controllers to ensure that there
+    # is a currently authenticated admin user
+    register :authentication_method, false
+
+    # The path to log user's out with. If set to a symbol, we assume
+    # that it's a method to call which returns the path
+    register :logout_link_path, :destroy_admin_user_session_path
+
+    # The method to use when generating the link for user logout
+    register :logout_link_method, :get
+
+    # Whether the batch actions are enabled or not
+    register :batch_actions, false
+
+    # Whether filters are enabled
+    register :filters, true
+
+    # The namespace root
+    register :root_to, 'dashboard#index'
+
+    # Options that are passed to root_to
+    register :root_to_options, {}
+
+    # Options passed to the routes, i.e. { path: '/custom' }
+    register :route_options, {}
+
+    # Display breadcrumbs
+    register :breadcrumb, true
+
+    # Display create another checkbox on a new page
+    # @return [Boolean] (true)
+    register :create_another, false
+
+    # Default CSV options
+    register :csv_options, { col_sep: ',', byte_order_mark: "\xEF\xBB\xBF" }
+
+    # Default Download Links options
+    register :download_links, true
+
+    # The authorization adapter to use
+    register :authorization_adapter, ActiveAdmin::AuthorizationAdapter
+
+    # A proc to be used when a user is not authorized to view the current resource
+    register :on_unauthorized_access, :rescue_active_admin_access_denied
+
+    # A regex to detect unsupported browser, set to false to disable
+    register :unsupported_browser_matcher, /MSIE [1-8]\.0/
+
+    # Whether to display 'Current Filters' on search screen
+    register :current_filters, true
+
+    # class to handle ordering
+    register :order_clause, ActiveAdmin::OrderClause
+
+    # default show_count for scopes
+    register :scopes_show_count, true
+
+    # Request parameters that are permitted by default
+    register :permitted_params, [
+      :utf8, :_method, :authenticity_token, :commit, :id
+    ]
+
+    # Set flash message keys that shouldn't show in ActiveAdmin
+    register :flash_keys_to_except, ['timedout']
+
+    # Include association filters by default
+    register :include_default_association_filters, true
+  end
+end

data/lib/active_admin/order_clause.rb

@@ -0,0 +1,48 @@
+module ActiveAdmin
+  class OrderClause
+    attr_reader :field, :order, :active_admin_config
+
+    def initialize(active_admin_config, clause)
+      clause =~ /^([\w\_\.]+)(->'\w+')?_(desc|asc)$/
+      @column = $1
+      @op = $2
+      @order = $3
+      @active_admin_config = active_admin_config
+      @field = [@column, @op].compact.join
+    end
+
+    def valid?
+      @field.present? && @order.present?
+    end
+
+    def apply(chain)
+      chain.reorder(Arel.sql sql)
+    end
+
+    def to_sql
+      [table_column, @op, ' ', @order].compact.join
+    end
+
+    def table
+      active_admin_config.resource_column_names.include?(@column) ? active_admin_config.resource_table_name : nil
+    end
+
+    def table_column
+      (@column =~ /\./) ? @column :
+        [table, active_admin_config.resource_quoted_column_name(@column)].compact.join(".")
+    end
+
+    def sql
+      custom_sql || to_sql
+    end
+
+    protected
+
+    def custom_sql
+      if active_admin_config.ordering[@column].present?
+        active_admin_config.ordering[@column].call(self)
+      end
+    end
+
+  end
+end