madness 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b40224e178737a2b80bbdac62d8c1937f5abff7a5cbc0a228858280f299459
-  data.tar.gz: 7e9f72bebf1c17373540df77b5aa222bfd461d7cd324f9a25a213974641e1f4a
+  metadata.gz: 89018d212a6eb10fa20bcbf6874d00201639f636b3f015d1d091cef82fb0cc84
+  data.tar.gz: 2b0e17b9b9802d0ad2d0dd92dd3e35ddd28bfbf9b4a79f9347b733d7d8feb520
 SHA512:
-  metadata.gz: ad23d7559298ec2b05087aae493fcfbfb485b01d90c6849da53f74414c67804aca70e963b3b6241718170e0618f9125e9705e564b0da75f6789586f2e9f33d53
-  data.tar.gz: 0b4ea8fa485d52a2b1cc05d7d5989c10b2855da4708c94393543a50efcfa4e0c1d58c16a12798b7db1700098f4aa19160d43836ca70852c31e5317df2b3cba3e
+  metadata.gz: f6d63da556f0a76366ca5dbbff71c2e488d04bfec985a3d4c388ea51b7dbb51ddf3f643701d96e4cfbdea1965e2bb71681e3cec84b6b2644ed73262f1bc72669
+  data.tar.gz: 050aa5976b73a39cffcf0d1ef4d56887952253641853c5b1ec2d6960aad7cc5276939692a1f5adce042b42519a0a57c9b33390c8ea3dcefea69ef46af249ef4a

data/README.md

@@ -1,13 +1,10 @@
 Madness - Instant Markdown Server
 ==================================================
 
-[![Gem](https://img.shields.io/gem/v/madness.svg?style=flat-square)](https://rubygems.org/gems/madness)
-[![Downloads](https://img.shields.io/gem/dt/madness.svg?style=flat-square)](https://rubygems.org/gems/madness)
-[![Build](https://img.shields.io/travis/DannyBen/madness.svg?style=flat-square)](https://travis-ci.org/DannyBen/madness)
-[![Dependencies](https://img.shields.io/gemnasium/DannyBen/madness.svg?style=flat-square)](https://gemnasium.com/DannyBen/madness)
-[![Code Quality](https://img.shields.io/codacy/grade/794c32ee5f8743c3a835091efbc09068.svg?style=flat-square)](https://www.codacy.com/app/db/madness)
-[![Maintainability](https://img.shields.io/codeclimate/maintainability/DannyBen/madness.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/madness)
-[![Issues](https://img.shields.io/codeclimate/issues/github/DannyBen/madness.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/madness)
+[![Gem Version](https://badge.fury.io/rb/madness.svg)](https://badge.fury.io/rb/madness)
+[![Build Status](https://travis-ci.com/DannyBen/madness.svg?branch=master)](https://travis-ci.com/DannyBen/madness)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fa440dc4dbf895734d74/maintainability)](https://codeclimate.com/github/DannyBen/madness/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fa440dc4dbf895734d74/test_coverage)](https://codeclimate.com/github/DannyBen/madness/test_coverage)
 
 ---
 
@@ -76,16 +73,15 @@ Example structure:
 ```
 ./
 ├── README.md
-├── Code.md
-├── Double Escape.md
+├── File.md
+├── Another File.md
 ├── File-with-Dashes.md
 ├── Folder
-│   └── File.md
+│   ├── File.md
+│   └── image.png
 └── Another Folder
     ├── README.md
-    ├── Headings.md
-    ├── Images.md
-    └── Lists.md
+    └── File.md
 ```
 
 
@@ -107,7 +103,6 @@ autoh1: true
 highlighter: true
 line_numbers: true
 index: false
-development: false
 ```
 
 
@@ -130,15 +125,32 @@ documents change or new documents are added.
 Images and Static Files
 --------------------------------------------------
 
-Your markdown directory can have a `public` folder. Anything in it
-will be served as is. For example, if you have `public/images/ok.png` 
-you can access it from your markdown file by typing:
+You can put images and any other asset file anywhere in your documentation 
+folder.
+
+When linking to other pages or images in your documentation folder, simply
+use the URL relative to the markdown file. Madness will convert these to be
+relative to the docroot of the generated site.
+
+This behavior mimics how GitHub is rendering markdown files.
+
+For example, if you have a folder named `subfolder` that contains a 
+`README.md` and a `nice-picture.png`, showing it in your `README` is done by
+this markdown:
 
 ```markdown
-![alt text](/images/ok.png)
+![alt text](nice-picture.png)
+```
+
+If you wish to link to images or pages in a different folder, simply specify
+the path relative to the homepage:
+
+```
+![alt text](/images/nice-picture.png)
 ```
 
 
+
 Automatic H1
 --------------------------------------------------
 
@@ -154,44 +166,6 @@ navigation.
 
 
 
-Automatic GraphViz Dot Diagram Generation
---------------------------------------------------
-
-This feature requires that you have GraphViz installed 
-(`$ sudo apt install graphviz`).
-
-What you place `*.dot` files in the `_dot` folder (or subfolders), they
-can be accessed directly as an image in your Markdown files. 
-
-In development mode, when such files are accessed, Madness will run the
-graphviz `dot` command and generate a respective image in the `public` 
-folder.
-
-For example, if you have the following graphviz file:
-
-```
-# _dot/diagrams/my_diagram.dot
-digraph {
-  Hello -> World
-} 
-```
-
-You can access it from your markdown files like this:
-
-```markdown
-!['alt text'](/diagrams/my_diagram.dot)
-```
-
-This will work in one of two ways:
-
-1. If the server is in development mode (`--development`), then it will 
-   create a `png` image in the public folder, and redirect to it.
-2. If the server is in production mode, it will redirect to the 
-   (previously-generated-) `png` image in the public folder, meaning 
-   `public/diagrams/my_diagram.png`
-
-
-
 Docker Image
 --------------------------------------------------
 
@@ -216,3 +190,5 @@ For more information see:
 [screenshot]: https://raw.githubusercontent.com/DannyBen/madness/master/screenshot.png
 [dockerhub]: https://hub.docker.com/r/dannyben/madness/
 [dockerfile]: https://github.com/DannyBen/docker-madness
+
+

data/lib/madness.rb

@@ -3,7 +3,7 @@ require 'singleton'
 require 'yaml'
 
 require 'slim'
-require 'rdiscount'
+require 'commonmarker'
 require 'coderay'
 require 'sass'
 require 'sinatra/base'
@@ -13,6 +13,8 @@ require 'docopt'
 require 'colsole'
 require 'ferret'
 
+require'byebug' if ENV['BYEBUG']
+
 require 'madness/version'
 require 'madness/try_static'
 require 'madness/settings'

data/lib/madness/command_line.rb

@@ -52,14 +52,13 @@ module Madness
       config.highlighter  = false  if args['--no-syntax']
       config.line_numbers = false  if args['--no-line-numbers']
       config.index        = true   if args['--index']
-      config.development  = true   if args['--development']
     end
 
     # Say hello to everybody when the server starts, showing the known 
     # config.
     def show_status
       say_status :start, 'the madness'
-      say_status :env, config.development ? 'development' : 'production', :txtblu
+      say_status :env, Server.environment, :txtblu
       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?

data/lib/madness/docopt.txt

@@ -15,11 +15,6 @@ Options:
   -b, --bind <address>
     Set server listen address.
 
-  --development
-    Start the server in development mode. In this mode, dot diagrams are 
-    regenerated on each request, whereas in production mode (default), the
-    diagrams are expected to already be generated in the public folder.
-
   --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
@@ -41,6 +36,5 @@ Examples:
   madness
   madness docs
   madness docs --no-auto-h1 -p 4567
-  madness docs --development
   madness --index --and-quit
 

data/lib/madness/document.rb

@@ -56,13 +56,19 @@ module Madness
       result.tr '-', ' '
     end
 
+    def relative_dir
+      @relative_dir ||= dir[/#{docroot}\/(.*)/,1]
+    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
+      doc = CommonMarker.render_doc(File.read file)
+      fix_relative_links doc if relative_dir
+      html = doc.to_html
       html = syntax_highlight(html) if config.highlighter
       html = prepend_h1(html) if config.autoh1
       html
@@ -87,12 +93,24 @@ module Madness
     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
+      html.gsub(/\<code class="language-(.+?)"\>(.+?)\<\/code\>/m) do
         lang, code = $1, $2
         code = CGI.unescapeHTML code
         CodeRay.scan(code, lang).html opts
       end
     end
+
+    def fix_relative_links(doc)
+      doc.walk do |node|
+        if [:link, :image].include? node.type
+          node.url = "/#{relative_dir}/#{node.url}" if relative? node.url
+        end
+      end
+    end
+
+    def relative?(link)
+      !(link.include? ':' or link[0] == '/')
+    end
   end
 end
 

data/lib/madness/navigation.rb

@@ -45,7 +45,7 @@ module Madness
       dirs  = Dir["#{dir}/*"].select { |f| File.directory? f }
       dirs.reject! do |f| 
         basename = File.basename(f)
-        basename[0] == '_' || basename == 'public'
+        basename[0] == '_'
       end
       dirs
     end

data/lib/madness/server.rb

@@ -14,23 +14,6 @@ module Madness
       }
     end
 
-    get '/*.dot' do
-      splat = params[:splat].first
-      dot = "_dot/#{splat}.dot"
-      png = "public/#{splat}.png"
-      out_dir = File.dirname png
-
-      Dir.chdir docroot do
-        if config.development and File.exist? dot
-          FileUtils.mkdir_p out_dir unless Dir.exist? out_dir
-          system %Q[dot "#{dot}" -Tpng -o "#{png}"]
-          redirect to "#{splat}.png"
-        else
-          redirect to "#{splat}.png"
-        end
-      end
-    end
-
     get '/*' do
       path = params[:splat].first
 

data/lib/madness/server_base.rb

@@ -18,13 +18,18 @@ module Madness
     set :public_folder, File.expand_path('../../app/public', __dir__)
     set :server, :puma
 
+    configure :development do
+      register Sinatra::Reloader
+      also_reload "#{__dir__}/*.rb"
+    end    
+
     # Since we cannot use any config values in the main body of the class,
     # since they will be updated later, we need to set anything that relys
     # on the config values just before running the server.
     # The CommandLine class and the test suite should both call
     # `Server.prepare` before calling Server.run!
     def self.prepare
-      use TryStatic, root: "#{config.path}/public/", :urls => %w[/]
+      use TryStatic, root: "#{config.path}/", :urls => %w[/]
       set :bind, config.bind
       set :port, config.port
     end

data/lib/madness/settings.rb

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

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rdiscount
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: runfile-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement