madness 0.2.0 → 0.2.1

data/app/views/document.slim

@@ -1,11 +1,11 @@
-== slim :_nav, locals: { nav: nav }
-
-.main
-  == slim :_breadcrumbs, locals: { breadcrumbs: breadcrumbs }
-  == slim :_content, locals: { nav: nav, content: content}
-
-  - unless type == :file
-    - unless type == :empty
-      hr 
-    == slim :_index_nav, locals: { nav: nav }
-
+== slim :_nav, locals: { nav: nav }
+
+.main
+  == slim :_breadcrumbs, locals: { breadcrumbs: breadcrumbs }
+  == slim :_content, locals: { nav: nav, content: content}
+
+  - unless type == :file
+    - unless type == :empty
+      hr 
+    == slim :_index_nav, locals: { nav: nav }
+

data/app/views/layout.slim

@@ -1,8 +1,8 @@
-doctype html
-
-head
-  title = locals[:title]
-  link href='/css/main.css' rel='stylesheet' type='text/css'
-
-body
+doctype html
+
+head
+  title = locals[:title]
+  link href='/css/main.css' rel='stylesheet' type='text/css'
+
+body
   == yield

data/app/views/search.slim

@@ -1,25 +1,25 @@
-== slim :_nav, locals: { nav: nav }
-
-.main
-  h1 Search
-
-  form.search-form action="/_search" method="get"
-    input.search-field type="text" name="q" value="#{params[:q]}" placeholder="Enter search query" autofocus=true
-    input type="submit" value="Search" style='display:none'
-
-  hr
-
-  - if results
-    - results.each_with_index do |result, index|
-      h4
-        = index+1
-        = ". "
-        a href="#{result[:file]}" = result[:label]
-        
-      - if result[:highlights]
-        - result[:highlights].each do |highlight|
-          pre.search-excerpt == highlight
-      - else
-        p.quiet No excerpt
-
-
+== slim :_nav, locals: { nav: nav }
+
+.main
+  h1 Search
+
+  form.search-form action="/_search" method="get"
+    input.search-field type="text" name="q" value="#{params[:q]}" placeholder="Enter search query" autofocus=true
+    input type="submit" value="Search" style='display:none'
+
+  hr
+
+  - if results
+    - results.each_with_index do |result, index|
+      h4
+        = index+1
+        = ". "
+        a href="#{result[:file]}" = result[:label]
+
+      - if result[:highlights]
+        - result[:highlights].each do |highlight|
+          pre.search-excerpt == highlight
+      - else
+        p.quiet No excerpt
+
+

data/lib/madness.rb

@@ -7,7 +7,7 @@ require 'rdiscount'
 require 'coderay'
 require 'sass'
 require 'sinatra/base'
-require "sinatra/reloader"
+require 'sinatra/reloader'
 require 'sass/plugin/rack'
 require 'docopt'
 require 'colsole'

data/lib/madness/breadcrumbs.rb

@@ -1,36 +1,36 @@
-module Madness
-  
-  # Handle breadcumbs generation by converting a path to an array
-  # of links
-  class Breadcrumbs
-    attr_reader :path
-
-    def initialize(path)
-      @path = path
-    end
-
-    def links
-      path == "" ? [] : get_breadcrumbs
-    end
-
-    private
-
-    def get_breadcrumbs
-      home = OpenStruct.new({ label: "Home", href: '/' })
-      result = breadcrumbs_maker(path).reverse.unshift home
-      result.last.last = true
-      result
-    end
-
-    def breadcrumbs_maker(partial_path)
-      parent, basename = File.split partial_path
-      item = OpenStruct.new({ 
-        label: basename.tr('-', ' '), 
-        href: "/#{partial_path}" }
-      )
-      result = [item]
-      result += breadcrumbs_maker parent unless parent == '.'
-      result
-    end
-  end
-end
+module Madness
+
+  # Handle breadcumbs generation by converting a path to an array
+  # of links
+  class Breadcrumbs
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def links
+      path == "" ? [] : get_breadcrumbs
+    end
+
+    private
+
+    def get_breadcrumbs
+      home = OpenStruct.new({ label: "Home", href: '/' })
+      result = breadcrumbs_maker(path).reverse.unshift home
+      result.last.last = true
+      result
+    end
+
+    def breadcrumbs_maker(partial_path)
+      parent, basename = File.split partial_path
+      item = OpenStruct.new({
+        label: basename.tr('-', ' '),
+        href: "/#{partial_path}" }
+      )
+      result = [item]
+      result += breadcrumbs_maker parent unless parent == '.'
+      result
+    end
+  end
+end

data/lib/madness/command_line.rb

@@ -1,77 +1,77 @@
-module Madness
-
-  # Handle command line execution. Used by bin/madness.
-  class CommandLine
-    include Singleton
-    include Colsole
-
-    # Launch the server
-    def execute(argv=[])
-      launch_server_with_options argv
-    end
-
-    private
-
-    # Execute the docopt engine to parse the options and then launch the
-    # server.
-    def launch_server_with_options(argv)
-      doc = File.read File.expand_path('docopt.txt', __dir__)
-      begin
-        args = Docopt::docopt(doc, argv: argv, version: VERSION)
-        set_config args
-
-        build_index if config.index
-        launch_server unless args['--and-quit']
-
-      rescue Docopt::Exit => e
-        puts e.message
-      end
-    end
-
-    # Launch the server, but not before doing some checks and making sure
-    # we ask it to "prepare". This will set the server options such as port
-    # and static files folder.
-    def launch_server
-      unless File.directory? config.path
-        STDERR.puts "Invalid path (#{config.path})" 
-        return
-      end
-
-      show_status
-      Server.prepare
-      Server.run!
-    end
-
-    # Get the arguments as provided by docopt, and set them to our own
-    # config object.
-    def set_config(args)
-      config.path = args['PATH']   if args['PATH']
-      config.port = args['--port'] if args['--port']
-      config.bind = args['--bind'] if args['--bind']
-      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
-
-    # Say hello to everybody when the server starts, showing the known 
-    # config.
-    def show_status
-      say_status :start, 'the madness'
-      say_status :listen, "#{config.bind}:#{config.port}", :txtblu
-      say_status :path, File.realpath(config.path), :txtblu
-      say_status :use, config.filename if config.file_exist?
-      say "-" * 40
-    end
-
-    def build_index
-      say_status :start, 'indexing'
-      Search.new.build_index
-      say_status :done, 'indexing'
-    end
-
-    def config
-      @config ||= Settings.instance
-    end
-  end
-end
+module Madness
+
+  # Handle command line execution. Used by bin/madness.
+  class CommandLine
+    include Singleton
+    include Colsole
+
+    # Launch the server
+    def execute(argv=[])
+      launch_server_with_options argv
+    end
+
+    private
+
+    # Execute the docopt engine to parse the options and then launch the
+    # server.
+    def launch_server_with_options(argv)
+      doc = File.read File.expand_path('docopt.txt', __dir__)
+      begin
+        args = Docopt::docopt(doc, argv: argv, version: VERSION)
+        set_config args
+
+        build_index if config.index
+        launch_server unless args['--and-quit']
+
+      rescue Docopt::Exit => e
+        puts e.message
+      end
+    end
+
+    # Launch the server, but not before doing some checks and making sure
+    # we ask it to "prepare". This will set the server options such as port
+    # and static files folder.
+    def launch_server
+      unless File.directory? config.path
+        STDERR.puts "Invalid path (#{config.path})" 
+        return
+      end
+
+      show_status
+      Server.prepare
+      Server.run!
+    end
+
+    # Get the arguments as provided by docopt, and set them to our own
+    # config object.
+    def set_config(args)
+      config.path = args['PATH']   if args['PATH']
+      config.port = args['--port'] if args['--port']
+      config.bind = args['--bind'] if args['--bind']
+      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
+
+    # Say hello to everybody when the server starts, showing the known 
+    # config.
+    def show_status
+      say_status :start, 'the madness'
+      say_status :listen, "#{config.bind}:#{config.port}", :txtblu
+      say_status :path, File.realpath(config.path), :txtblu
+      say_status :use, config.filename if config.file_exist?
+      say "-" * 40
+    end
+
+    def build_index
+      say_status :start, 'indexing'
+      Search.new.build_index
+      say_status :done, 'indexing'
+    end
+
+    def config
+      @config ||= Settings.instance
+    end
+  end
+end

data/lib/madness/docopt.txt

@@ -1,40 +1,40 @@
-Madness
-
-Usage:
-  madness [PATH] [options]
-  madness (-h|--help|--version)
-
-Parameters:
-  PATH:
-    Optional path to the markdown directory.
-
-Options:
-  -p, --port <number>
-    Set server port number.
-
-  -b, --bind <address>
-    Set server listen address.
-
-  --no-auto-h1
-    By default, if a markdown document does not start with an H1 caption,
-    it will be added automatically based on the file name. To disable this
-    behavior, use --no-auto-h1.
-
-  --no-syntax
-    Disable code syntax highlighting.
-
-  --no-line-numbers
-    Disable line numbering for syntax highlighter.
-
-  --index
-    Build or rebuild the index for the search page.
-
-  --and-quit
-    Quit after building the index (applicable only with --index).
-
-Examples:
-  madness
-  madness docs
-  madness docs --no-auto-h1 -p 4567
-  madness --index --and-quit
-
+Madness
+
+Usage:
+  madness [PATH] [options]
+  madness (-h|--help|--version)
+
+Parameters:
+  PATH:
+    Optional path to the markdown directory.
+
+Options:
+  -p, --port <number>
+    Set server port number.
+
+  -b, --bind <address>
+    Set server listen address.
+
+  --no-auto-h1
+    By default, if a markdown document does not start with an H1 caption,
+    it will be added automatically based on the file name. To disable this
+    behavior, use --no-auto-h1.
+
+  --no-syntax
+    Disable code syntax highlighting.
+
+  --no-line-numbers
+    Disable line numbering for syntax highlighter.
+
+  --index
+    Build or rebuild the index for the search page.
+
+  --and-quit
+    Quit after building the index (applicable only with --index).
+
+Examples:
+  madness
+  madness docs
+  madness docs --no-auto-h1 -p 4567
+  madness --index --and-quit
+

data/lib/madness/document.rb

@@ -1,98 +1,98 @@
-module Madness
-
-  # Handle a single markdown document.
-  class Document
-    include ServerHelper
-
-    attr_reader :file, :dir, :path, :type
-
-    # 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}"
-
-      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
-    end
-
-    # Return the HTML for that document
-    def content
-      @content ||= content!
-    end
-
-    # Return the HTML for that document, force re-read.
-    def content!
-      if File.exist?(file)
-        markdown_to_html
-      else
-        @type = :empty
-        ""
-      end
-    end
-
-    # Return a reasonable HTML title for the file or directory
-    def title
-      if file =~ /README.md/
-        result = File.basename File.dirname(file)
-      else
-        result = File.basename(file,'.md')
-      end
-      result.tr '-', ' '
-    end
-
-    private
-
-    # Convert markdown to HTML, wit hsome additional processing:
-    # 1. Syntax highilghting
-    # 2. Prepend H1 if needed
-    def markdown_to_html
-      html = RDiscount.new(File.read file).to_html
-      html = syntax_highlight(html) if config.highlighter
-      html = prepend_h1(html) if config.autoh1
-      html
-    end
-
-    # If the document does not start with an H1 tag, add it.
-    def prepend_h1(html)
-      unless html[0..3] == "<h1>"
-        html = "<h1>#{title}</h1>\n#{html}" 
-      end
-      html
-    end
-
-    # Apply syntax highlighting with CodeRay. This will parse for any 
-    # <code class='LANG'> sections in the HTML, pass it to CodeRay for
-    # highlighting.
-    # Since CodeRay adds another HTML escaping, on top of what RDiscount
-    # does, we unescape it before passing it to CodeRay.
-    #
-    # Open StackOverflow question:
-    # http://stackoverflow.com/questions/37771279/prevent-double-escaping-with-coderay-and-rdiscount
-    def syntax_highlight(html)
-      line_numbers = config.line_numbers ? :table : nil
-      opts = { css: :style, wrap: nil, line_numbers: line_numbers }
-      html.gsub(/\<code class="(.+?)"\>(.+?)\<\/code\>/m) do
-        lang, code = $1, $2
-        code = CGI.unescapeHTML code
-        CodeRay.scan(code, lang).html opts
-      end
-    end
-  end
-end
-
+module Madness
+
+  # Handle a single markdown document.
+  class Document
+    include ServerHelper
+
+    attr_reader :file, :dir, :path, :type
+
+    # 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}"
+
+      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
+    end
+
+    # Return the HTML for that document
+    def content
+      @content ||= content!
+    end
+
+    # Return the HTML for that document, force re-read.
+    def content!
+      if File.exist?(file)
+        markdown_to_html
+      else
+        @type = :empty
+        ""
+      end
+    end
+
+    # Return a reasonable HTML title for the file or directory
+    def title
+      if file =~ /README.md/
+        result = File.basename File.dirname(file)
+      else
+        result = File.basename(file,'.md')
+      end
+      result.tr '-', ' '
+    end
+
+    private
+
+    # Convert markdown to HTML, wit hsome additional processing:
+    # 1. Syntax highilghting
+    # 2. Prepend H1 if needed
+    def markdown_to_html
+      html = RDiscount.new(File.read file).to_html
+      html = syntax_highlight(html) if config.highlighter
+      html = prepend_h1(html) if config.autoh1
+      html
+    end
+
+    # If the document does not start with an H1 tag, add it.
+    def prepend_h1(html)
+      unless html[0..3] == "<h1>"
+        html = "<h1>#{title}</h1>\n#{html}"
+      end
+      html
+    end
+
+    # Apply syntax highlighting with CodeRay. This will parse for any
+    # <code class='LANG'> sections in the HTML, pass it to CodeRay for
+    # highlighting.
+    # Since CodeRay adds another HTML escaping, on top of what RDiscount
+    # does, we unescape it before passing it to CodeRay.
+    #
+    # Open StackOverflow question:
+    # http://stackoverflow.com/questions/37771279/prevent-double-escaping-with-coderay-and-rdiscount
+    def syntax_highlight(html)
+      line_numbers = config.line_numbers ? :table : nil
+      opts = { css: :style, wrap: nil, line_numbers: line_numbers }
+      html.gsub(/\<code class="(.+?)"\>(.+?)\<\/code\>/m) do
+        lang, code = $1, $2
+        code = CGI.unescapeHTML code
+        CodeRay.scan(code, lang).html opts
+      end
+    end
+  end
+end
+