- Add support for mixed sort order

Author: DannyBen

lib/madness/navigation.rb

@@ -2,6 +2,7 @@ module Madness
   # Handle the navigation links for a given directory
   class Navigation
     include ServerHelper
+    using ArrayRefinements
     using StringRefinements
 
     attr_reader :dir
@@ -11,7 +12,11 @@ def initialize(dir)
     end
 
     def links
-      @links ||= directory.list
+      @links ||= if config.sort_order == 'mixed'
+        directory.list.nat_sort(by: :href)
+      else
+        directory.list
+      end
     end
 
     def caption
@@ -27,5 +32,9 @@ def with_search?
     def directory
       @directory ||= Directory.new(dir)
     end
+
+    def config
+      Settings.instance
+    end
   end
 end

lib/madness/refinements/array_refinements.rb

@@ -3,8 +3,8 @@
 module Madness
   module ArrayRefinements
     refine Array do
-      def nat_sort
-        Naturally.sort self
+      def nat_sort(by: nil)
+        Naturally.sort self, by: by
       end
     end
   end

lib/madness/settings.rb

@@ -57,6 +57,7 @@ def defaults
         port:              3000,
         bind:              '0.0.0.0',
         base_uri:          nil,
+        sort_order:        'dirs_first',
         sidebar:           true,
         auto_h1:           true,
         auto_nav:          true,

lib/madness/templates/madness.yml

@@ -15,6 +15,11 @@ bind: 0.0.0.0
 # base_uri: /docs
 base_uri: ~
 
+# choose navigation sort order:
+# sort_order: dirs_first     # alphabetic directories then alphabetic files
+# sort_order: mixed          # alphabetic regardless of type
+sort_order: dirs_first
+
 # enable sidebar
 sidebar: true
 

spec/approvals/cli/config/show

@@ -2,6 +2,7 @@
                 port:  3000
                 bind:  0.0.0.0
             base_uri:  ~
+          sort_order:  dirs_first
              sidebar:  true
              auto_h1:  true
             auto_nav:  true

spec/approvals/cli/config/show-non-default

@@ -2,6 +2,7 @@
                 port:  1337
                 bind:  4.3.2.1
             base_uri:  ~
+          sort_order:  dirs_first
              sidebar:  true
              auto_h1:  true
             auto_nav:  true