Merge branch 'fj-move-sidebar-code-to-lib' into 'master'

Move project sidebar refactor to 'lib' folder

See merge request gitlab-org/gitlab!59809

app/models/concerns/sidebars/container_with_html_options.rb

-# frozen_string_literal: true
-
-module Sidebars
-  module ContainerWithHtmlOptions
-    # The attributes returned from this method
-    # will be applied to helper methods like
-    # `link_to` or the div containing the container.
-    def container_html_options
-      {
-        aria: { label: title }
-      }.merge(extra_container_html_options)
-    end
-
-    # Classes will override mostly this method
-    # and not `container_html_options`.
-    def extra_container_html_options
-      {}
-    end
-
-    # Attributes to pass to the html_options attribute
-    # in the helper method that sets the active class
-    # on each element.
-    def nav_link_html_options
-      {}
-    end
-
-    def title
-      raise NotImplementedError
-    end
-
-    # The attributes returned from this method
-    # will be applied right next to the title,
-    # for example in the span that renders the title.
-    def title_html_options
-      {}
-    end
-
-    def link
-      raise NotImplementedError
-    end
-  end
-end

app/models/concerns/sidebars/has_active_routes.rb

-# frozen_string_literal: true
-
-module Sidebars
-  module HasActiveRoutes
-    # This method will indicate for which paths or
-    # controllers, the menu or menu item should
-    # be set as active.
-    #
-    # The returned values are passed to the `nav_link` helper method,
-    # so the params can be either `path`, `page`, `controller`.
-    # Param 'action' is not supported.
-    def active_routes
-      {}
-    end
-  end
-end

app/models/concerns/sidebars/positionable_list.rb

-# frozen_string_literal: true
-
-# This module handles elements in a list. All elements
-# must have a different class
-module Sidebars
-  module PositionableList
-    def add_element(list, element)
-      list << element
-    end
-
-    def insert_element_before(list, before_element, new_element)
-      index = index_of(list, before_element)
-
-      if index
-        list.insert(index, new_element)
-      else
-        list.unshift(new_element)
-      end
-    end
-
-    def insert_element_after(list, after_element, new_element)
-      index = index_of(list, after_element)
-
-      if index
-        list.insert(index + 1, new_element)
-      else
-        add_element(list, new_element)
-      end
-    end
-
-    private
-
-    def index_of(list, element)
-      list.index { |e| e.is_a?(element) }
-    end
-  end
-end

app/models/concerns/sidebars/renderable.rb

-# frozen_string_literal: true
-
-module Sidebars
-  module Renderable
-    # This method will control whether the menu or menu_item
-    # should be rendered. It will be overriden by specific
-    # classes.
-    def render?
-      true
-    end
-  end
-end

lib/sidebars/concerns/container_with_html_options.rb

+# frozen_string_literal: true
+
+module Sidebars
+  module Concerns
+    module ContainerWithHtmlOptions
+      # The attributes returned from this method
+      # will be applied to helper methods like
+      # `link_to` or the div containing the container.
+      def container_html_options
+        {
+          aria: { label: title }
+        }.merge(extra_container_html_options)
+      end
+
+      # Classes will override mostly this method
+      # and not `container_html_options`.
+      def extra_container_html_options
+        {}
+      end
+
+      # Attributes to pass to the html_options attribute
+      # in the helper method that sets the active class
+      # on each element.
+      def nav_link_html_options
+        {}
+      end
+
+      def title
+        raise NotImplementedError
+      end
+
+      # The attributes returned from this method
+      # will be applied right next to the title,
+      # for example in the span that renders the title.
+      def title_html_options
+        {}
+      end
+
+      def link
+        raise NotImplementedError
+      end
+    end
+  end
+end

lib/sidebars/concerns/has_active_routes.rb

+# frozen_string_literal: true
+
+module Sidebars
+  module Concerns
+    module HasActiveRoutes
+      # This method will indicate for which paths or
+      # controllers, the menu or menu item should
+      # be set as active.
+      #
+      # The returned values are passed to the `nav_link` helper method,
+      # so the params can be either `path`, `page`, `controller`.
+      # Param 'action' is not supported.
+      def active_routes
+        {}
+      end
+    end
+  end
+end

app/models/concerns/sidebars/has_hint.rb → lib/sidebars/concerns/has_hint.rb

@@ -4,13 +4,15 @@
 # hints for menus. Hints are elements displayed
 # when the user hover the menu item.
 module Sidebars
-  module HasHint
-    def show_hint?
-      false
-    end
+  module Concerns
+    module HasHint
+      def show_hint?
+        false
+      end
 
-    def hint_html_options
-      {}
+      def hint_html_options
+        {}
+      end
     end
   end
 end

app/models/concerns/sidebars/has_icon.rb → lib/sidebars/concerns/has_icon.rb

@@ -3,25 +3,27 @@
 # This module has the necessary methods to show
 # sprites or images next to the menu item.
 module Sidebars
-  module HasIcon
-    def sprite_icon
-      nil
-    end
+  module Concerns
+    module HasIcon
+      def sprite_icon
+        nil
+      end
 
-    def sprite_icon_html_options
-      {}
-    end
+      def sprite_icon_html_options
+        {}
+      end
 
-    def image_path
-      nil
-    end
+      def image_path
+        nil
+      end
 
-    def image_html_options
-      {}
-    end
+      def image_html_options
+        {}
+      end
 
-    def icon_or_image?
-      sprite_icon || image_path
+      def icon_or_image?
+        sprite_icon || image_path
+      end
     end
   end
 end

app/models/concerns/sidebars/has_pill.rb → lib/sidebars/concerns/has_pill.rb

@@ -3,19 +3,21 @@
 # This module introduces the logic to show the "pill" element
 # next to the menu item, indicating the a count.
 module Sidebars
-  module HasPill
-    def has_pill?
-      false
-    end
+  module Concerns
+    module HasPill
+      def has_pill?
+        false
+      end
 
-    # In this method we will need to provide the query
-    # to retrieve the elements count
-    def pill_count
-      raise NotImplementedError
-    end
+      # In this method we will need to provide the query
+      # to retrieve the elements count
+      def pill_count
+        raise NotImplementedError
+      end
 
-    def pill_html_options
-      {}
+      def pill_html_options
+        {}
+      end
     end
   end
 end

lib/sidebars/concerns/positionable_list.rb

+# frozen_string_literal: true
+
+# This module handles elements in a list. All elements
+# must have a different class
+module Sidebars
+  module Concerns
+    module PositionableList
+      def add_element(list, element)
+        list << element
+      end
+
+      def insert_element_before(list, before_element, new_element)
+        index = index_of(list, before_element)
+
+        if index
+          list.insert(index, new_element)
+        else
+          list.unshift(new_element)
+        end
+      end
+
+      def insert_element_after(list, after_element, new_element)
+        index = index_of(list, after_element)
+
+        if index
+          list.insert(index + 1, new_element)
+        else
+          add_element(list, new_element)
+        end
+      end
+
+      private
+
+      def index_of(list, element)
+        list.index { |e| e.is_a?(element) }
+      end
+    end
+  end
+end

lib/sidebars/concerns/renderable.rb

+# frozen_string_literal: true
+
+module Sidebars
+  module Concerns
+    module Renderable
+      # This method will control whether the menu or menu_item
+      # should be rendered. It will be overriden by specific
+      # classes.
+      def render?
+        true
+      end
+    end
+  end
+end

app/models/sidebars/menu.rb → lib/sidebars/menu.rb

@@ -6,12 +6,12 @@ module Sidebars
     include ::Gitlab::Routing
     include GitlabRoutingHelper
     include Gitlab::Allowable
-    include ::Sidebars::HasPill
-    include ::Sidebars::HasIcon
-    include ::Sidebars::PositionableList
-    include ::Sidebars::Renderable
-    include ::Sidebars::ContainerWithHtmlOptions
-    include ::Sidebars::HasActiveRoutes
+    include ::Sidebars::Concerns::HasPill
+    include ::Sidebars::Concerns::HasIcon
+    include ::Sidebars::Concerns::PositionableList
+    include ::Sidebars::Concerns::Renderable
+    include ::Sidebars::Concerns::ContainerWithHtmlOptions
+    include ::Sidebars::Concerns::HasActiveRoutes
 
     attr_reader :context
     delegate :current_user, :container, to: :@context

app/models/sidebars/menu_item.rb → lib/sidebars/menu_item.rb

@@ -6,11 +6,11 @@ module Sidebars
     include ::Gitlab::Routing
     include GitlabRoutingHelper
     include Gitlab::Allowable
-    include ::Sidebars::HasIcon
-    include ::Sidebars::HasHint
-    include ::Sidebars::Renderable
-    include ::Sidebars::ContainerWithHtmlOptions
-    include ::Sidebars::HasActiveRoutes
+    include ::Sidebars::Concerns::HasIcon
+    include ::Sidebars::Concerns::HasHint
+    include ::Sidebars::Concerns::Renderable
+    include ::Sidebars::Concerns::ContainerWithHtmlOptions
+    include ::Sidebars::Concerns::HasActiveRoutes
 
     attr_reader :context
 

app/models/sidebars/panel.rb → lib/sidebars/panel.rb

@@ -3,7 +3,7 @@
 module Sidebars
   class Panel
     extend ::Gitlab::Utils::Override
-    include ::Sidebars::PositionableList
+    include ::Sidebars::Concerns::PositionableList
 
     attr_reader :context, :scope_menu, :hidden_menu
 

spec/models/concerns/sidebars/container_with_html_options_spec.rb → spec/lib/sidebars/concerns/container_with_html_options_spec.rb

@@ -2,10 +2,10 @@
 
 require 'spec_helper'
 
-RSpec.describe Sidebars::ContainerWithHtmlOptions do
+RSpec.describe Sidebars::Concerns::ContainerWithHtmlOptions do
   subject do
     Class.new do
-      include Sidebars::ContainerWithHtmlOptions
+      include Sidebars::Concerns::ContainerWithHtmlOptions
 
       def title
         'Foo'

spec/models/concerns/sidebars/positionable_list_spec.rb → spec/lib/sidebars/concerns/positionable_list_spec.rb

@@ -2,10 +2,10 @@
 
 require 'spec_helper'
 
-RSpec.describe Sidebars::PositionableList do
+RSpec.describe Sidebars::Concerns::PositionableList do
   subject do
     Class.new do
-      include Sidebars::PositionableList
+      include Sidebars::Concerns::PositionableList
     end.new
   end