madness 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 735d6b8d05c5c4ca640fc394f94b6d13dcc728e8
-  data.tar.gz: ee91a02a64aafb375ff2e410624c281c92096b5b
+  metadata.gz: bcdab65af0b9a96400c1d0f7b5dfacb89b51af1a
+  data.tar.gz: 988746a41c7cd24248f1c108104fa1f258854285
 SHA512:
-  metadata.gz: bc0dc6ca64a6da54e50fb5c60790f4cc71122d8607df9cf8e44cc651a6c4b8042d914cbd00ff038163718d796b5ae9ac4ece3b40e4ff2f836982e803fa556ded
-  data.tar.gz: 7f054e3b4c1832e91b5bdc5804f90e09745ee08db0e877321973c64002ba05152e8df5f080d40b44e6af77f1f5317072913a5dd88e9d44142af9d49bbcb38d97
+  metadata.gz: aeb491dbeb42c2755f985eebc83433bf7e9ad9f40daadff2a77b9a98e53a668c1df1b2895c534fbb895b835ea9f34305abf50c352f8ab2eaf16bf1567b566fa3
+  data.tar.gz: ce1cef2c6ca28043ea1cef131849aea3f7fb42acaa88810ec34550aaa987cfd0faee1a234aa3aaf14ddb96c70b3968ae59f3c0d48420cae97ee6ebd015d78c32

data/README.md

@@ -8,10 +8,12 @@ Madness - Instant Markdown Server
 
 ---
 
+
 Screenshot
 --------------------------------------------------
 
-![Screenshot]
+![screenshot]
+
 
 
 Install
@@ -20,6 +22,7 @@ Install
     $ gem install madness
 
 
+
 Design Intentions
 --------------------------------------------------
 
@@ -27,6 +30,17 @@ Madness was designed in order to provide easy browsing, viewing and
 searching for local, markdown based documentation directories.
 
 
+
+Feature Highlights
+--------------------------------------------------
+
+- Easy to use
+- Built in full text search
+- Built in GraphViz diagram generator
+- Configure with a configuration file or command arguments
+
+
+
 Usage
 --------------------------------------------------
 
@@ -39,6 +53,7 @@ For more options, run:
     $ madness --help
 
 
+
 Directory Conventions
 --------------------------------------------------
 
@@ -70,6 +85,8 @@ Example structure:
     └── Lists.md
 ```
 
+
+
 Configuration File
 --------------------------------------------------
 
@@ -87,9 +104,11 @@ autoh1: true
 highlighter: true
 line_numbers: true
 index: false
+development: false
 ```
 
 
+
 Search
 --------------------------------------------------
 
@@ -104,28 +123,93 @@ You will need to run this command from time to time, as your
 documents change or new documents are added.
 
 
-Tips
+
+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:
+
+```markdown
+![alt text](/images/ok.png)
+```
+
+
+Automatic H1
 --------------------------------------------------
 
-**Automatic H1**  
 If your markdown document does not start with a level 1 heading, it
 will be automatically added based on the file name.
 
-**Hidden Directories**  
+
+Hidden Directories
+--------------------------------------------------
+
 Directories that begin with an underscore will not be displayed in the
 navigation.
 
-**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:
+
+
+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](/images/ok.png)
+!['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
+--------------------------------------------------
+
+This gem is also available as a docker image.
+
+This command will start the server on localhost:3000, with the current 
+directory as the markdown documentation folder
 
-[Screenshot]: https://raw.githubusercontent.com/DannyBen/madness/master/screenshot.png
+```shell
+$ docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness
+```
+
+For more information see:
+
+- [Madness image on Docker Hub][dockerhub]
+- [Madness Dockerfile][dockerfile]
+
+
+
+---
 
+[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/command_line.rb

@@ -52,12 +52,14 @@ 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 :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,6 +15,11 @@ 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
@@ -36,5 +41,6 @@ Examples:
   madness
   madness docs
   madness docs --no-auto-h1 -p 4567
+  madness docs --production
   madness --index --and-quit
 

data/lib/madness/server.rb

@@ -14,6 +14,23 @@ 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/settings.rb

@@ -10,7 +10,7 @@ module Madness
     include Singleton
 
     attr_accessor :port, :bind, :path, :autoh1, 
-      :highlighter, :line_numbers, :index
+      :highlighter, :line_numbers, :index, :development
 
     def initialize
       reset
@@ -42,6 +42,7 @@ 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.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: runfile-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -198,70 +198,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
 description: Start a markdown server in any directory
 email: db@dannyben.com
 executables:
@@ -328,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Instant Markdown Server