From 39618514f5ec5c38297050512c851201babb697a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Robin=20Bo=CC=88ning?= <rb@magiclabs.de>
Date: Fri, 6 Sep 2019 11:00:02 +0200
Subject: [PATCH] Add dashboard configuration to (not) be displayed in
 navigation

+ Introduces general configuration for Dashboards.
+ By default every Dashboard is configured to be displayed in the navigation.

How to remove a Dashboard from navigation:

```
class LineItemDashboard < Administrate::BaseDashboard
  configure do |config|
    config.navigation = false
  end
end
```
---
 .../application/_navigation.html.erb          |  2 +-
 docs/getting_started.md                       | 14 +++++++++--
 lib/administrate/base_dashboard.rb            | 25 +++++++++++++++++++
 lib/administrate/engine.rb                    |  1 +
 lib/administrate/namespace/resource.rb        |  9 +++++++
 lib/administrate/navigation.rb                | 10 ++++++++
 spec/features/navigation_spec.rb              | 23 +++++++++++++++++
 7 files changed, 81 insertions(+), 3 deletions(-)
 create mode 100644 lib/administrate/navigation.rb

diff --git a/app/views/administrate/application/_navigation.html.erb b/app/views/administrate/application/_navigation.html.erb
index 3c8c16d2a3..145db96e3d 100644
--- a/app/views/administrate/application/_navigation.html.erb
+++ b/app/views/administrate/application/_navigation.html.erb
@@ -8,7 +8,7 @@ as defined by the routes in the `admin/` namespace
 %>
 
 <nav class="navigation" role="navigation">
-  <% Administrate::Namespace.new(namespace).resources.each do |resource| %>
+  <% Administrate::Navigation.new(namespace).resources.each do |resource| %>
     <%= link_to(
       display_resource_name(resource),
       [namespace, resource_index_route_key(resource)],
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 8d9ba72f6b..641c1948c2 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -43,8 +43,18 @@ Rails.application.routes.draw do
  end
 ```
 
-The routes can be customized to show or hide
-different models on the dashboard.
+Removing resources from the routes will hide them on the dashboard.
+
+There might be situations where resources shall be hidden in the navigation
+but still be nested in another resource. In this case you keep the route but configure the dashboard to not be displayed in the navigation.
+
+```ruby
+class LineItemDashboard < Administrate::BaseDashboard
+  configure do |config|
+    config.navigation = false
+  end
+end
+```
 
 Each `FooDashboard` specifies which attributes should be displayed
 on the admin dashboard for the `Foo` resource.
diff --git a/lib/administrate/base_dashboard.rb b/lib/administrate/base_dashboard.rb
index 1b37a4fdb6..56fc82ae43 100644
--- a/lib/administrate/base_dashboard.rb
+++ b/lib/administrate/base_dashboard.rb
@@ -17,6 +17,22 @@ module Administrate
   class BaseDashboard
     include Administrate
 
+    class << self
+      attr_accessor :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield configuration
+      end
+
+      def display_in_navigation?
+        self.configuration.navigation == true
+      end
+    end
+
     def attribute_types
       self.class::ATTRIBUTE_TYPES
     end
@@ -87,5 +103,14 @@ def attribute_includes(attributes)
         key if association_classes.include?(field.try(:deferred_class))
       end.compact
     end
+
+    class Configuration
+      attr_accessor :navigation
+
+      def initialize
+        @navigation = true
+      end
+    end
+
   end
 end
diff --git a/lib/administrate/engine.rb b/lib/administrate/engine.rb
index 28383148dd..6db41650a7 100644
--- a/lib/administrate/engine.rb
+++ b/lib/administrate/engine.rb
@@ -14,6 +14,7 @@
 require "administrate/search"
 require "administrate/namespace"
 require "administrate/namespace/resource"
+require "administrate/navigation"
 
 module Administrate
   class Engine < ::Rails::Engine
diff --git a/lib/administrate/namespace/resource.rb b/lib/administrate/namespace/resource.rb
index 19ab0213c7..68aaeccb1e 100644
--- a/lib/administrate/namespace/resource.rb
+++ b/lib/administrate/namespace/resource.rb
@@ -3,6 +3,9 @@ class Namespace
     class Resource
       attr_reader :namespace, :resource
 
+      delegate :display_in_navigation?, to: :dashboard_class
+      delegate :dashboard_class, to: :resource_resolver
+
       def initialize(namespace, resource)
         @namespace = namespace
         @resource = resource
@@ -23,6 +26,12 @@ def name
       def path
         name.to_s.gsub("/", "_")
       end
+
+      private
+
+      def resource_resolver
+        @resource_resolver ||= ResourceResolver.new("#{namespace}/#{resource}")
+      end
     end
   end
 end
diff --git a/lib/administrate/navigation.rb b/lib/administrate/navigation.rb
new file mode 100644
index 0000000000..ce0b1d5279
--- /dev/null
+++ b/lib/administrate/navigation.rb
@@ -0,0 +1,10 @@
+module Administrate
+  class Navigation
+    attr_reader :resources
+
+    def initialize(namespace)
+      namespace = Administrate::Namespace.new(namespace)
+      @resources = namespace.resources.select(&:display_in_navigation?)
+    end
+  end
+end
diff --git a/spec/features/navigation_spec.rb b/spec/features/navigation_spec.rb
index acac84f6e6..69ae3298f2 100644
--- a/spec/features/navigation_spec.rb
+++ b/spec/features/navigation_spec.rb
@@ -9,6 +9,29 @@
     expect(active_link.text).to eq "Customers"
   end
 
+  it "displays links to resources from admin namespace" do
+    visit admin_root_path
+
+    navigation = find(".navigation")
+    expect(navigation).to have_link("Customers")
+    expect(navigation).to have_link("Line Items")
+    expect(navigation).to have_link("Log Entries")
+    expect(navigation).to have_link("Products")
+    expect(navigation).to have_link("Product Meta Tags")
+    expect(navigation).to have_link("Payments")
+    expect(navigation).to have_link("Series")
+    expect(navigation).to have_link("Blog/Posts")
+  end
+
+  it "does not display links to resources configured to not be rendered in navigation" do
+    LineItemDashboard.configuration.navigation = false
+
+    visit admin_root_path
+
+    navigation = find(".navigation")
+    expect(navigation).not_to have_link("Line Items")
+  end
+
   it "displays translated name of model" do
     translations = {
       activerecord: {