madman 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e1113b347b10a4315da7bf0c27322724f470d18788f4cd29e55ff08d20e386d
-  data.tar.gz: 612124a4e5f5fc1620e9a620cb5a626d7ebd8e3403ecd23098de0556b68c0452
+  metadata.gz: 8761538fd56beb2a8676fef5c492b833617a425932ede9b6c3e3faf151a7e0ba
+  data.tar.gz: 5a2bb08578bd917cf42b3175b7198fd0c2e70c71911a412c884311cddeac51f7
 SHA512:
-  metadata.gz: 6f70d18a985aefdd93bb1d1be78b3374725aa7f90267f2f3feac3e462f016e55e30ca6b9995cb2bc276db92daea97e76ffacbb6506d0ae16198fb273a8b33347
-  data.tar.gz: d9fafb6da92cb704d5431b59d3424d71e25a5a4965afed3e258fb65e948c39be490dd430ce9e7e209a6c0ad09c215e7a354d606d009465818cda683f354178b8
+  metadata.gz: 0a3d0275fc0d5306c4c31a7a35dc89cef6902e3ba42fdc7c464b5f6d3579918eab2b5724f21e8e13fe870f79fa81826aeb5bcc2c458ebb295189cba0c49e2fd3
+  data.tar.gz: a8fa0793810b599585856faf5580faefd09388e4a9f1f0a33718dd32dbe4650f51442886ee64926d9455637b3dd2563393aa39e3b5f51d8ccfe779b666382f51

data/README.md

@@ -41,6 +41,7 @@ Features
       compatibility.
 - [x] Automatic detection of Right-to-Left markdown files for HTML rendering.
 - [x] Generate navigation README in folders without one.
+- [x] Convert YAML file to an interactive HTML with collapsible sections.
 - [ ] Generate breadcrumbs.
 - [ ] Combine multiple markdown files to one.
 - [ ] Table of Contents generation for a single file.
@@ -56,15 +57,15 @@ Usage
 $ madman
 Commands:
   nav      Add site-wide navigation links to README files
-  preview  Serve a markdown file using a local server
+  preview  Serve a markdown or YAML file using a local server
   readme   Create README in all qualified sub directories
-  render   Render markdown to HTML
+  render   Render markdown or YAML to HTML
   serve    Serve a markdown directory using a local server
 ```
 
 <!-- usage -->
 
-### Render Markdown to File
+### Render Markdown or YAML to HTML
 
 <!-- render -->
 
@@ -82,7 +83,7 @@ Usage:
 
 ```
 $ madman render --help
-Render markdown to HTML
+Render markdown or YAML to HTML
 
 Usage:
   madman render FILE [--github --save OUTFILE]
@@ -101,7 +102,7 @@ Options:
 
 Parameters:
   FILE
-    The input markdown file
+    The input markdown or YAML file
 
 Environment Variables:
   GITHUB_ACCESS_TOKEN
@@ -112,12 +113,13 @@ Examples:
   madman render README.md
   madman render README.md --github
   madman render README.md --save out.html
+  madman render file.yml --save out.html
 ```
 
 <!-- render-help -->
 </details>
 
-### Preview Markdown in Browser
+### Preview Markdown or HTML in Browser
 
 <!-- preview -->
 
@@ -134,7 +136,7 @@ Usage:
 
 ```
 $ madman preview --help
-Serve a markdown file using a local server
+Serve a markdown or YAML file using a local server
 
 This command will start a local server with two endpoints:
   /         will render the markdown with the default renderer
@@ -156,7 +158,7 @@ Options:
 
 Parameters:
   FILE
-    The input markdown file
+    The input markdown or YAML file
 
 Environment Variables:
   GITHUB_ACCESS_TOKEN
@@ -167,6 +169,7 @@ Environment Variables:
 Examples:
   madman preview README.md
   madman preview README.md -p4000
+  madman preview file.yml
 ```
 
 <!-- preview-help --></details>

data/bin/madman

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 require 'madman'
 require 'madman/cli'
+require 'colsole'
+include Colsole
 
 runner = Madman::CLI.runner
 

data/lib/madman.rb

@@ -1,23 +1,12 @@
+require 'byebug' if ENV['BYEBUG']
 require 'commonmarker'
+require 'mister_bin'
 require 'octokit'
+require 'requires'
 require 'sinatra/base'
 require 'sinatra/reloader'
 require 'slim'
 require 'string-direction'
+require 'yaml'
 
-require 'madman/version'
-require 'madman/cli'
-require 'madman/injector'
-
-require 'madman/directory'
-require 'madman/document'
-require 'madman/item'
-require 'madman/renderers'
-require 'madman/navigation'
-
-require 'madman/server_base'
-require 'madman/preview_server'
-require 'madman/dir_server'
-
-
-require 'byebug' if ENV['BYEBUG']
+requires 'madman'

data/lib/madman/cli.rb

@@ -1,4 +1,3 @@
-require 'mister_bin'
 require 'madman/commands'
 
 module Madman

data/lib/madman/commands/nav.rb

@@ -26,9 +26,7 @@ module Madman
       example "madman nav path/to/docs --force --marker toc"
       example "madman nav path/to/docs --dry -v -d2"
 
-      def run(args)
-        @args = args
-
+      def run
         if recursive?
           Dir["#{dir}/**/#{target}"].each { |file| update_file file }
         else
@@ -55,15 +53,14 @@ module Madman
 
       # CLI Arguments
 
-      def args;         @args; end
-      def dir;          args['DIR'] || '.'; end
-      def depth;        args['--depth'].to_i; end
-      def marker;       args['--marker']; end
-      def target;       args['--target']; end
-      def force?;       args['--force']; end
-      def dry?;         args['--dry']; end
-      def verbose?;     args['--verbose']; end
-      def recursive?;   args['--recursive']; end
+      def dir;        args['DIR'] || '.'; end
+      def depth;      args['--depth'].to_i; end
+      def marker;     args['--marker']; end
+      def target;     args['--target']; end
+      def force?;     args['--force']; end
+      def dry?;       args['--dry']; end
+      def verbose?;   args['--verbose']; end
+      def recursive?; args['--recursive']; end
       
     end
   end

data/lib/madman/commands/preview.rb

@@ -3,7 +3,7 @@ module Madman
     class Preview < MisterBin::Command
       include Colsole
 
-      summary "Serve a markdown file using a local server"
+      summary "Serve a markdown or YAML file using a local server"
 
       help "This command will start a local server with two endpoints:\n  /         will render the markdown with the default renderer\n  /github   will render with the GitHub API"
 
@@ -13,14 +13,15 @@ module Madman
       option "-p --port N", "Set server port [default: 3000]"
       option "-b --bind ADDRESS", "Set server listen address [default: 0.0.0.0]"
 
-      param "FILE", "The input markdown file"
+      param "FILE", "The input markdown or YAML file"
 
       environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nRequired only if you wish to use the '/github' endpoint\nGenerate one here: https://github.com/settings/tokens"
 
       example "madman preview README.md"
       example "madman preview README.md -p4000"
+      example "madman preview file.yml"
 
-      def run(args)
+      def run
         file = args['FILE']
         port = args['--port']
         bind = args['--bind']

data/lib/madman/commands/readme.rb

@@ -17,7 +17,7 @@ module Madman
       example "madman readme ."
       example "madman readme path/to/docs --dry"
 
-      def run(args)
+      def run
         dir = args['DIR']
         basedir = Madman::Directory.new dir, dir
 

data/lib/madman/commands/render.rb

@@ -3,7 +3,7 @@ module Madman
     class Render < MisterBin::Command
       include Colsole
 
-      help "Render markdown to HTML"
+      help "Render markdown or YAML to HTML"
 
       usage "madman render FILE [--github --save OUTFILE]"
       usage "madman render (-h|--help)"
@@ -11,15 +11,16 @@ module Madman
       option "--github", "Render using the GitHub API\nRequires setting the GITHUB_ACCESS_TOKEN environment variable"
       option "--save OUTFILE", "Save the output to a file"
 
-      param "FILE", "The input markdown file"
+      param "FILE", "The input markdown or YAML file"
 
       environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nGenerate one here: https://github.com/settings/tokens"
 
       example "madman render README.md"
       example "madman render README.md --github"
       example "madman render README.md --save out.html"
+      example "madman render file.yml --save out.html"
 
-      def run(args)
+      def run
         infile = args['FILE']
         outfile = args['--save']
         renderer = args['--github'] ? :github : :default

data/lib/madman/commands/serve.rb

@@ -19,7 +19,7 @@ module Madman
       example "madman serve"
       example "madman serve path/to/docs -p4000 --github"
 
-      def run(args)
+      def run
         dir = args['DIR']
         port = args['--port']
         bind = args['--bind']

data/lib/madman/dir_server.rb

@@ -1,3 +1,5 @@
+require 'madman/server_base'
+
 module Madman
   class DirServer < ServerBase
     set :public_folder, -> { File.expand_path(settings.dir) }
@@ -16,7 +18,7 @@ module Madman
       slim :template
     end
 
-    private
+  private
 
     def find_file(path)
       type = :file

data/lib/madman/directory.rb

@@ -20,7 +20,7 @@ module Madman
       result
     end
 
-    private
+  private
 
     def files
       result = Dir["#{dir}/*.md"]

data/lib/madman/document.rb

@@ -1,12 +1,21 @@
+require 'madman/injector'
+require 'madman/renderers'
+
 module Madman
   class Document
     include Injector
 
     attr_reader :filename
-    attr_accessor :text
+    attr_accessor :text, :yaml_mode
 
     def self.from_file(file)
-      new File.read(file), file
+      if File.extname(file) == '.yml'
+        result = new YAML.load_file(file), file
+        result.yaml_mode = true
+        result
+      else
+        new File.read(file), file
+      end
     end
 
     def initialize(text, filename=nil)
@@ -15,7 +24,11 @@ module Madman
     end
 
     def render(renderer=:default)
-      renderers[renderer].render text
+      if yaml_mode
+        renderers[:yaml].render text, title: File.basename(filename, '.yml')
+      else
+        renderers[renderer].render text
+      end
     end
 
     def rtl?
@@ -28,7 +41,7 @@ module Madman
       File.write save_as, text
     end
 
-    private
+  private
 
     def detector
       @detector ||= StringDirection::Detector.new :dominant

data/lib/madman/item.rb

@@ -22,7 +22,7 @@ module Madman
       type == :file
     end
 
-    private
+  private
 
     def path_without_extension
       @path_without_extension ||= path.sub(/\.md$/, '')

data/lib/madman/navigation.rb

@@ -1,3 +1,5 @@
+require 'madman/directory'
+
 module Madman
   # Generate a markdown Table of Contents
   class Navigation
@@ -15,7 +17,7 @@ module Madman
       @markdown ||= markdown!
     end
 
-    private
+  private
 
     def markdown!
       result = []

data/lib/madman/preview_server.rb

@@ -1,3 +1,6 @@
+require 'madman/server_base'
+require 'madman/document'
+
 module Madman
   class PreviewServer < ServerBase
     set :public_folder, -> { File.expand_path(File.dirname(settings.file)) }

data/lib/madman/refinements/string.rb

@@ -0,0 +1,11 @@
+module StringRefinements
+  refine String do
+    def slug
+      downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+    end
+
+    def to_html
+      CommonMarker.render_html self, :DEFAULT, [:table]
+    end
+  end
+end

data/lib/madman/renderers.rb

@@ -1,11 +1,13 @@
 require 'madman/renderers/default'
 require 'madman/renderers/github'
+require 'madman/renderers/yaml'
 
 module Madman
   module Renderers
     def self.available_renderers
       {
         default: Renderers::Default,
+        yaml: Renderers::YAML,
         github: Renderers::GitHub,
       }
     end

data/lib/madman/renderers/github.rb

@@ -5,7 +5,7 @@ module Madman
         client.markdown text
       end
 
-      private
+    private
 
       def self.client
         Octokit::Client.new access_token: access_token

data/lib/madman/renderers/yaml.rb

@@ -0,0 +1,12 @@
+module Madman
+  module Renderers
+    class YAML
+      def self.render(yaml, opts={})
+        doc = YAMLDoc.new yaml, title: opts[:title]
+        doc.render
+      end
+    end
+  end
+end
+
+

data/lib/madman/version.rb

@@ -1,3 +1,3 @@
 module Madman
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/lib/madman/yamldoc.rb

@@ -0,0 +1,76 @@
+require 'madman/refinements/string'
+
+module Madman
+  class YAMLDoc
+    using StringRefinements
+
+    attr_reader :yaml, :title
+
+    def initialize(yaml, title: nil)
+      @yaml = yaml
+      @title = title
+    end
+
+    def render
+      slim.render self
+    end
+
+    def template
+      File.expand_path '../views/yamldoc.slim', __dir__
+    end
+
+    def slim
+      @slim ||= Slim::Template.new template, slim_options
+    end
+
+    def slim_options
+      { pretty: true, disable_escape: true }
+    end
+
+    def tree
+      @tree ||= tree!
+    end
+
+  private
+
+    def counter
+      @counter ||= 0
+      @counter += 1
+    end
+
+    def tree!(data=nil, indent=0, caption=2)
+      data ||= yaml
+      result = []
+      caption = 6 if caption > 6
+
+      data.each do |key, value|
+        result.push render_pair key, value, indent, caption
+      end
+
+      result.join "\n"
+    end
+
+    def render_pair(key, value, indent, caption)
+      slug = "#{key.slug}-#{counter}"
+      space = '  '
+      result = []
+
+      if key[0] == '_'
+        result.push "#{space * indent}<div>"
+      else
+        result.push "#{space * indent}<h#{caption}><a href='##{slug}' class='clickable'>#{key}</a></h#{caption}>"
+        result.push "#{space * indent}<div class='hidden' id='#{slug}'>"
+      end
+
+      if value.is_a? Hash
+        result.push tree!(value, indent+1, caption+1)
+      elsif value
+        result.push "#{space * (indent+1)}#{value.to_html}"
+      end
+
+      result.push "#{space * indent}</div>"
+      result
+    end
+
+  end
+end

data/lib/views/template.slim

@@ -2,10 +2,9 @@ doctype html
 html
   head
     meta name="viewport" content="width=device-width, initial-scale=1"
-
-  body
     link href='https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/2.10.0/github-markdown.min.css' rel='stylesheet' type='text/css'
 
+  body
     css:
       .markdown-body {
         box-sizing: border-box;

data/lib/views/yamldoc.slim

@@ -0,0 +1,52 @@
+doctype html
+html
+  head
+    meta name="viewport" content="width=device-width, initial-scale=1"
+    script src="https://code.jquery.com/jquery-3.3.1.min.js"integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="crossorigin="anonymous"
+    link href='https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/2.10.0/github-markdown.min.css' rel='stylesheet' type='text/css'
+
+  body
+
+    scss:
+      .markdown-body {
+        box-sizing: border-box;
+        min-width: 200px;
+        max-width: 980px;
+        margin: 0 auto;
+        padding: 45px;
+      }
+
+      @media (max-width: 767px) {
+        .markdown-body {
+          padding: 15px;
+        }
+      }
+
+      .s:hover {
+        cursor: pointer;
+      }
+
+      .hidden { 
+        display: none;
+        margin-left: 10px;
+      }
+
+
+    .markdown-body 
+      h1 
+        a#toggle-all href='#' = title
+
+      == tree
+
+
+    coffee:
+      $ ->
+        $('.clickable').on "click", (e) ->
+          e.preventDefault()
+          target = $(this).attr 'href'
+          $(target).toggle()
+
+        $('#toggle-all').on "click", (e) ->
+          e.preventDefault()
+          $('.hidden').toggle()
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madman
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
+date: 2018-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: requires
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -95,97 +109,55 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: string-direction
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: string-direction
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.9'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: lp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
+        version: '4.9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '4.9'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -193,89 +165,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: rspec-html-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: rspec_fixtures
+  name: coffee-script
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  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: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
+        version: '2.4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.4'
 description: A command line utility for markdown fun
 email: db@dannyben.com
 executables:
@@ -300,12 +202,16 @@ files:
 - lib/madman/item.rb
 - lib/madman/navigation.rb
 - lib/madman/preview_server.rb
+- lib/madman/refinements/string.rb
 - lib/madman/renderers.rb
 - lib/madman/renderers/default.rb
 - lib/madman/renderers/github.rb
+- lib/madman/renderers/yaml.rb
 - lib/madman/server_base.rb
 - lib/madman/version.rb
+- lib/madman/yamldoc.rb
 - lib/views/template.slim
+- lib/views/yamldoc.slim
 homepage: https://github.com/dannyben/madman
 licenses:
 - MIT