madness 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61800bba372a7802c94d6e1b03ae7ae976a272bd46e70bcd6ee4c6840c0f99b9
-  data.tar.gz: 80b9b50292629189fb9592eff557a63aa23cf856541a174782dffc253f0c1adf
+  metadata.gz: f7c16859452e4652252758d4ead7dbb37eace8c0997cc4723891a937c200408f
+  data.tar.gz: 203352bfdaf474d2c4fcf2cd7b220deffe326ecb0185e8e46a5f0912d888351a
 SHA512:
-  metadata.gz: 7e25d76930f8ebad4bb54edeb033b0cd8fc1cd90c8455ebfbc534cd09df211c4f49b4ce616930ba2ca30dc9f7f8685f1bf12a1d541e43779071390f8fa1b0e50
-  data.tar.gz: fa5f24750e105497e026c1afe6d5ac0a5815e0db7aaf3c5aec97afbc6ac07044f6249e329b169292828543dfabe128ecb13a1862a63f6bb1a0b1a66461ff45b3
+  metadata.gz: 3de2ec54e53a84022d9f8131b27c15b7a09985793e21ea30d861354814a0071721aa3a0f3101bb752df9889931f8ecc3b595c1c889a05bd828de3add6b9ca453
+  data.tar.gz: a3768d1826817338345e537f4e76c34cc3098d71a96ef86833d06c5a481a9a7ab53088cd438ae425332782053f801ebecacc639595db278b2cd2c0e2097bdad4

data/README.md

@@ -84,8 +84,8 @@ Madness expects to be executed in a documentation directory.
 A documentation directory contains only markdown files (`*.md`) and 
 sub directories that contain more markdown files.
 
-The server will consider the file `README.md` in any directory as the 
-main file describing this directory.
+The server will consider the file `index.md` or `README.md` in any directory 
+as the main file describing this directory, where `index.md` has priority.
 
 The navigation sidebar will show all the sub directories and files in 
 the same directory as the viewed file.

data/lib/madness/directory.rb

@@ -17,7 +17,10 @@ module Madness
 
     def files
       result = Dir["#{dir}/*.md"]
-      result.reject! { |f| File.basename(f) == 'README.md' }
+      result.reject! do |f| 
+        basename = File.basename(f)
+        basename == 'README.md' or basename == 'index.md'
+      end
       result.sort.map { |path| Item.new path, :file }
     end
 

data/lib/madness/document.rb

@@ -5,32 +5,30 @@ module Madness
     include ServerHelper
     using StringRefinements
 
-    attr_reader :file, :dir, :path, :type
+    attr_reader :base, :path
 
-    # At initialization, we handle three file "types":
-    # :readme - in case the path is a directory, then the only file we
-    #           MAY show, is the README.md in it
-    # :file   - in case the path is a *.md file
-    # :empty  - in any other case, we don't know.
     def initialize(path)
       @path = path
+      @base = path.empty? ? docroot : "#{docroot}/#{path}"
+      @base.chomp! '/'
+    end
 
-      base = path.empty? ? docroot : "#{docroot}/#{path}"
-      base.chomp! '/'
+    # Return :readme, :file or :empty
+    def type
+      set_base_attributes unless @type
+      @type
+    end
 
-      if File.directory? base
-        @file = "#{base}/README.md"
-        @dir  = base
-        @type = :readme
-      elsif File.exist? "#{base}.md"
-        @file = "#{base}.md"
-        @dir  = File.dirname file
-        @type = :file
-      else
-        @file = ''
-        @dir  = docroot
-        @type = :empty
-      end
+    # Return the path to the actual markdown file
+    def file
+      set_base_attributes unless @file
+      @file
+    end
+
+    # Return the path to the document directory
+    def dir
+      set_base_attributes unless @dir
+      @dir
     end
 
     # Return the HTML for that document
@@ -40,12 +38,7 @@ module Madness
 
     # Return the HTML for that document, force re-read.
     def content!
-      if File.exist?(file)
-        markdown_to_html
-      else
-        @type = :empty
-        ""
-      end
+      type == :empty ? '' : markdown_to_html
     end
 
     # Return a reasonable HTML title for the file or directory
@@ -60,6 +53,38 @@ module Madness
 
     private
 
+    # Identify file, dir and type.
+    # :readme - in case the path is a directory, and it contains index.md
+    #           or README.md
+    # :file   - in case the path is a *.md file
+    # :empty  - in any other case, we don't know.
+    def set_base_attributes
+      @dir  = docroot
+      @type = :empty
+      @file = ''
+
+      if File.directory? base
+        set_base_attributes_for_directory
+      elsif File.exist? "#{base}.md"
+        @file = "#{base}.md"
+        @dir  = File.dirname file
+        @type = :file
+      end
+    end
+
+    def set_base_attributes_for_directory
+      @dir  = base
+      @type = :readme
+
+      if File.exist? "#{base}/index.md"
+        @file = "#{base}/index.md"
+      elsif File.exist? "#{base}/README.md"
+        @file = "#{base}/README.md"
+      else
+        @type = :empty
+      end
+    end
+
     def markdown
       @markdown ||= File.read file
     end

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.5.6"
+  VERSION = "0.5.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Danny Ben Shitrit