madness 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4548ff821bb0396f536bc5d7228a03bc44307c9eb60b1282c74aee8519f1dd86
-  data.tar.gz: d438320e3e8a819aa6e90dac8d9a77140444270fceccedf6f5a199c53d685d45
+  metadata.gz: 05747c9d79187c38d51b832818d55b3d5ac3f752a9fe607b122deb3696cbd602
+  data.tar.gz: 77a756be50f65a205d65d497415dfca806ff86388f11bfe51adcf31c5e5f0f7d
 SHA512:
-  metadata.gz: 05caa89aa6745f72cc6552ae8b4376db76bace2561196c220fa94958c327a1b9ade31686f0ad38a8c847a13a80a08ab173de2edfddbd689db4848e49060578f5
-  data.tar.gz: 4f8937f11e93d872d1d1a3c1cc5015e5bb326a84d6a34a086fa9fe077db7aa09dbfdba170dcac1f6e0120aef26acbaf71230e32199d05d074ceaa8d4e1db9990
+  metadata.gz: b680d72a2ddc93f673f5d87057303872a1f6d6317af03888e684e7b925818b304bdf6695d1862aad2cc10665845ae60d6e901739ac5203a0370fe3e76872849f
+  data.tar.gz: e5f2c52f519da17724114a6521ffdff3922688e470029fbab57c87f25b8541aa718e6410c86ce28780bf661b4fce3a3264de95ece283e223547cb5bcfb112b22

data/README.md

@@ -16,6 +16,25 @@ Screenshot
 
 
 
+Table of Contents
+--------------------------------------------------
+
+* [Install](#install)
+* [Design Intentions](#design-intentions)
+* [Feature Highlights](#feature-highlights)
+* [Usage](#usage)
+* [Directory Conventions](#directory-conventions)
+* [Configuration File](#configuration-file)
+* [Search](#search)
+* [Images and Static Files](#images-and-static-files)
+* [Automatic H1](#automatic-h1)
+* [Table of Contents Generation](#table-of-contents-generation)
+* [Hidden Directories](#hidden-directories)
+* [Changing Theme](#changing-theme)
+* [Docker Image](#docker-image)
+
+
+
 Install
 --------------------------------------------------
 
@@ -38,6 +57,7 @@ Feature Highlights
 - Built in full text search
 - Compatible with how markdown files are displayed on GitHub andGitHub pages.
 - Configure with a configuration file or command arguments
+- Automatic generation of Table of Contents
 
 
 
@@ -103,6 +123,7 @@ autoh1: true
 highlighter: true
 line_numbers: true
 index: false
+toc: Table of Contents
 ```
 
 
@@ -156,14 +177,19 @@ will be automatically added based on the file name.
 
 
 
-Hidden Directories
+Table of Contents Generation
 --------------------------------------------------
 
-These directories will not be displayed in the navigation:
+You can use the `madness --toc` command to generate a "Table of Contents" 
+markdown file.
+
+
+
+Hidden Directories
+--------------------------------------------------
 
-- Directories that begin with an underscore.
-- Directories that are made only of lowercase letters, underscoew, dash and/or 
-  numbers (`/^[a-z_\-0-9]+$/`).
+Diretories that are made only of lowercase letters, underscoes, dash and/or 
+numbers (`/^[a-z_\-0-9]+$/`) will not be displayed in the navigation.
 
 
 

data/lib/madness.rb

@@ -15,15 +15,19 @@ require 'ferret'
 
 require'byebug' if ENV['BYEBUG']
 
-require 'madness/version'
-require 'madness/try_static'
-require 'madness/settings'
 require 'madness/server_helper'
-require 'madness/server_base'
-require 'madness/server'
-require 'madness/document'
-require 'madness/navigation'
+
 require 'madness/breadcrumbs'
 require 'madness/command_line'
+require 'madness/directory'
+require 'madness/document'
+require 'madness/item'
+require 'madness/navigation'
 require 'madness/search'
+require 'madness/server'
+require 'madness/server_base'
+require 'madness/settings'
+require 'madness/table_of_contents'
+require 'madness/try_static'
+require 'madness/version'
 

data/lib/madness/command_line.rb

@@ -19,8 +19,7 @@ module Madness
       begin
         args = Docopt.docopt(doc, argv: argv, version: VERSION)
         set_config args
-
-        build_index if config.index
+        generate_stuff
         launch_server unless args['--and-quit']
 
       rescue Docopt::Exit => e
@@ -48,12 +47,19 @@ module Madness
       config.path = args['PATH']   if args['PATH']
       config.port = args['--port'] if args['--port']
       config.bind = args['--bind'] if args['--bind']
+      config.toc  = args['--toc']  if args['--toc']
       config.autoh1       = false  if args['--no-auto-h1']
       config.highlighter  = false  if args['--no-syntax']
       config.line_numbers = false  if args['--no-line-numbers']
       config.index        = true   if args['--index']
     end
 
+    # Generate index and toc, if requested by the user.
+    def generate_stuff
+      build_index if config.index
+      build_toc   if config.toc
+    end
+
     # Say hello to everybody when the server starts, showing the known 
     # config.
     def show_status
@@ -65,10 +71,15 @@ module Madness
       say "-" * 40
     end
 
+    # Build the search index
     def build_index
-      say_status :start, 'indexing'
+      say_status :index, "generating"
       Search.new.build_index
-      say_status :done, 'indexing'
+    end
+
+    def build_toc
+      say_status :toc, "generating #{config.toc}"
+      TableOfContents.new.build(config.toc)
     end
 
     def config

data/lib/madness/directory.rb

@@ -0,0 +1,33 @@
+module Madness
+  # Represents a directory with markdown file sand subflders.
+  class Directory
+    include ServerHelper
+
+    attr_reader :dir
+
+    def initialize(dir)
+      @dir = dir
+    end
+    
+    def list
+      @list ||= (dirs + files)
+    end
+
+    private
+
+    def files
+      result = Dir["#{dir}/*.md"]
+      result.reject! { |f| File.basename(f) == 'README.md' }
+      result.sort.map { |path| Item.new path, :file }
+    end
+
+    def dirs
+      result = Dir["#{dir}/*"].select { |f| File.directory? f }
+      result.reject! do |f| 
+        basename = File.basename(f)
+        basename =~ /^[a-z_\-0-9]+$/
+      end
+      result.sort.map { |path| Item.new path, :dir }
+    end
+  end
+end

data/lib/madness/docopt.txt

@@ -9,10 +9,10 @@ Parameters:
     Optional path to the markdown directory.
 
 Options:
-  -p, --port <number>
+  -p, --port NUMBER
     Set server port number.
 
-  -b, --bind <address>
+  -b, --bind ADDRESS
     Set server listen address.
 
   --no-auto-h1
@@ -29,12 +29,16 @@ Options:
   --index
     Build or rebuild the index for the search page.
 
+  --toc FILE
+    Generate a table of contents file. 
+
   --and-quit
-    Quit after building the index (applicable only with --index).
+    Quit instead of running the server. Useful with --index or --toc.
 
 Examples:
   madness
   madness docs
   madness docs --no-auto-h1 -p 4567
   madness --index --and-quit
+  madness --toc "Table of Contents.md" --index --and-quit
 

data/lib/madness/document.rb

@@ -63,8 +63,7 @@ module Madness
     # 1. Syntax highilghting
     # 2. Prepend H1 if needed
     def markdown_to_html
-      doc = CommonMarker.render_doc(File.read file)
-      html = doc.to_html
+      html = CommonMarker.render_html File.read(file), :DEFAULT, [:table]
       html = syntax_highlight(html) if config.highlighter
       html = prepend_h1(html) if config.autoh1
       html

data/lib/madness/item.rb

@@ -0,0 +1,34 @@
+module Madness
+  class Item
+    include ServerHelper
+
+    attr_reader :path, :type
+
+    def initialize(path, type)
+      @path, @type = path, type
+    end
+
+    def label
+      @label ||= File.basename(path_without_extension)
+    end
+
+    def href
+      URI.escape(path_without_extension.sub(/^#{docroot}/, ''))
+    end
+
+    def dir?
+      type == :dir
+    end
+
+    def file?
+      type == :file
+    end
+
+    private
+
+    def path_without_extension
+      @path_without_extension ||= path.sub(/\.md$/, '')
+    end
+  end
+end
+

data/lib/madness/navigation.rb

@@ -3,59 +3,28 @@ module Madness
   class Navigation
     include ServerHelper
 
-    attr_reader :links, :caption
+    attr_reader :dir
 
     def initialize(dir)
-      @links = make_links dir
-      # @caption = File.basename(dir) unless dir == docroot
-      @caption = dir == docroot ? "Index" : File.basename(dir)
+      @dir = dir
     end
 
-    def with_search?
-      @with_search ||= Search.new.has_index?
+    def links
+      @links ||= directory.list
     end
 
-    private
-
-    # Prepare a list of links from all the accepted items in the directory
-    def make_links(dir)
-      files = get_files dir
-      dirs  = get_dirs dir
-
-      links = []
-
-      dirs.sort.each do |item|
-        links.push link(item, :dir)
-      end
-
-      files.each do |item|
-        links.push link(item, :file)
-      end
-
-      links
+    def caption
+      @caption ||= (dir == docroot ? "Index" : File.basename(dir))
     end
 
-    def get_files(dir)
-      files = Dir["#{dir}/*.md"].map { |f| f.sub(/\.md$/, '') }
-      files.reject! { |f| File.basename(f) == 'README' }
-      files.sort
+    def with_search?
+      @with_search ||= Search.new.has_index?
     end
 
-    def get_dirs(dir)
-      dirs  = Dir["#{dir}/*"].select { |f| File.directory? f }
-      dirs.reject! do |f| 
-        basename = File.basename(f)
-        basename[0] == '_' or basename =~ /^[a-z_\-0-9]+$/
-      end
-      dirs
-    end
+    private
 
-    def link(item, type)
-      OpenStruct.new({ 
-        label: File.basename(item).tr('-', ' '), 
-        href: URI.escape(item.sub(/^#{docroot}/, '')), 
-        type: type 
-      })
+    def directory
+      @directory ||= Directory.new(dir)
     end
   end
 end

data/lib/madness/server.rb

@@ -25,7 +25,7 @@ module Madness
         redirect "#{path}/"
       end
 
-      nav = Navigation.new(dir)
+      nav = Navigation.new dir
       breadcrumbs = Breadcrumbs.new(path).links
 
       if nav.links.count == 1 and doc.type == :empty

data/lib/madness/settings.rb

@@ -10,7 +10,7 @@ module Madness
     include Singleton
 
     attr_accessor :port, :bind, :path, :autoh1, 
-      :highlighter, :line_numbers, :index
+      :highlighter, :line_numbers, :index, :toc
 
     def initialize
       reset
@@ -42,6 +42,7 @@ module Madness
       self.highlighter = true
       self.line_numbers = true
       self.index = false
+      self.index = false
     end
 
     def load_from_file

data/lib/madness/table_of_contents.rb

@@ -0,0 +1,42 @@
+module Madness
+  # Generate a markdown Table of Contents
+  class TableOfContents
+    include ServerHelper
+
+    attr_reader :dir
+
+    def initialize(dir=nil)
+      @dir = dir || docroot
+    end
+
+    def build(file)
+      file += ".md" unless file.end_with? '.md'
+      File.write "#{dir}/#{file}", toc
+    end
+
+    def toc
+      @toc ||= toc!.join("\n")
+    end
+
+    private
+
+    def toc!(path=dir, indent=0)
+      list = Directory.new(path).list
+
+      result = []
+      list.each do |item|
+        if item.type == :dir
+          result.push "#{' ' * indent}1. #{make_link item}"
+          result += toc! item.path, indent+4
+        elsif item.type == :file
+          result.push "#{' ' * indent}1. #{make_link item}"
+        end
+      end
+      result
+    end
+
+    def make_link(item)
+      "[#{item.label}](#{item.href})"
+    end
+  end
+end

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec_fixtures
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -327,14 +341,17 @@ files:
 - lib/madness.rb
 - lib/madness/breadcrumbs.rb
 - lib/madness/command_line.rb
+- lib/madness/directory.rb
 - lib/madness/docopt.txt
 - lib/madness/document.rb
+- lib/madness/item.rb
 - lib/madness/navigation.rb
 - lib/madness/search.rb
 - lib/madness/server.rb
 - lib/madness/server_base.rb
 - lib/madness/server_helper.rb
 - lib/madness/settings.rb
+- lib/madness/table_of_contents.rb
 - lib/madness/try_static.rb
 - lib/madness/version.rb
 homepage: https://github.com/DannyBen/madness