madman 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e170953e138b20f746310e8152cd7b43a7e1da60023d52745d94c55a1a9e4f
-  data.tar.gz: 1a9315ef63047804e548e040e1aeb9fff47dd87d06bfa6f3050b87bdc4f1c6cb
+  metadata.gz: '0397dcc8aa59270b402f884eef91bb3b9359c678317f5dc11b7b04e55fc714a0'
+  data.tar.gz: b03912ea38913bc419d0bab33bd533bfce1b4688d7972e28963205c92f7ea2ba
 SHA512:
-  metadata.gz: 75bc524b8513c711066ae65c649d752d49475e3e6e1f6b705ec751a5ec27034b1c7683dbf4fc3bc876a4bf17fd30821a078241a44d5d3b8d4c6286567e03cfc0
-  data.tar.gz: c519c432a7288f9ca983aa1ec06aba4437b81f699db16741d49c70200558fbf8868bfbdd86a8e23f98d919a5069c5ff80900006170f2a110d2775f33cfabcb4c
+  metadata.gz: 8e8a338fac43b8979a5ad68b158512bf85c102808c7ee284f3d5157fb537258d308a4acaa59a6238bcc5b7e2bfbb526670b574d3a3d5917f1400aea4b6ac61b2
+  data.tar.gz: c2d9c12999e35514c866653b655cb231e3e1a53af6b0932917779820c49e9542d7fb19e1b3cbbcc282f003dd011792fc0d74372f254879f341a0d99b4ad64291

data/bin/madman

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
-require 'mister_bin'
-require 'madman/version'
+require 'madman'
+require 'madman/cli'
 
-runner = MisterBin::Runner.new 'madman', basedir: __dir__,
-  version: Madman::VERSION
+runner = Madman::CLI.runner
 
 begin
   exit runner.run ARGV

data/lib/madman.rb

@@ -5,6 +5,7 @@ require 'sinatra/reloader'
 require 'slim'
 require 'string-direction'
 
+require 'madman/cli'
 require 'madman/injector'
 
 require 'madman/directory'
@@ -17,4 +18,5 @@ require 'madman/server_base'
 require 'madman/preview_server'
 require 'madman/server'
 
+
 require 'byebug' if ENV['BYEBUG']

data/lib/madman/cli.rb

@@ -0,0 +1,19 @@
+require 'mister_bin'
+require 'madman/commands'
+
+module Madman
+  class CLI
+    def self.runner
+      runner = MisterBin::Runner.new version: Madman::VERSION
+
+      runner.route 'nav',     to: Madman::Commands::Nav
+      runner.route 'preview', to: Madman::Commands::Preview
+      runner.route 'readme',  to: Madman::Commands::Readme
+      runner.route 'render',  to: Madman::Commands::Render
+      runner.route 'serve',   to: Madman::Commands::Serve
+
+      runner
+    end
+  end
+
+end

data/lib/madman/commands.rb

@@ -0,0 +1,5 @@
+require 'madman/commands/nav'
+require 'madman/commands/preview'
+require 'madman/commands/readme'
+require 'madman/commands/render'
+require 'madman/commands/serve'

data/lib/madman/commands/nav.rb

@@ -0,0 +1,70 @@
+require 'io/console'
+
+module Madman
+  module Commands
+    class Nav < MisterBin::Command
+      include Colsole
+
+      summary "Add site-wide navigation links to README files"
+
+      help "This command generates a Table of Contents for a directory, and injects it to a file. In addition, it supports recursive execution, which will add a Table of Contents to all README files (or a filename of your choice) in all the subfolders, creating nagigation pages for an entire Markdown site."
+
+      usage "madman nav DIR [options]"
+      usage "madman nav (-h|--help)"
+
+      option "-f --force", "Inject TOC to all README files, even if they do not have a marker"
+      option "-m --marker TEXT", "Look for an HTML comment with <!-- TEXT --> [default: nav]"
+      option "-d --depth N", "The depth of the table of contents [default: 1]"
+      option "-v --verbose", "Show the updated README content"
+      option "-t --target NAME", "Set the target filename to look for. [default: README.md]"
+      option "-r --recursive", "Inject to all target files"
+      option "-y --dry", "Do not save the updated files, just show what will happen"
+
+      param "DIR", "The directory containing markdown files"
+
+      example "madman nav"
+      example "madman nav path/to/docs --force --marker toc"
+      example "madman nav path/to/docs --dry -v -d2"
+
+      def run(args)
+        @args = args
+
+        if recursive?
+          Dir["#{dir}/**/#{target}"].each { |file| update_file file }
+        else
+          update_file "#{dir}/#{target}"
+        end
+
+        say dry? ? "Done (dry mode, no changes were made)" : "Done"
+      end
+
+      def update_file(file)
+        say "Updating !txtgrn!#{file}"
+        file_dir = File.dirname file
+        toc = Madman::Navigation.new file_dir, depth: depth
+        doc = Madman::Document.from_file file
+        doc.inject toc.markdown, marker: marker, force: force?
+
+        if verbose?
+          say word_wrap "  !txtblu!#{doc.text}"
+          say ""
+        end
+
+        doc.save unless dry?
+      end
+
+      # 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
+      
+    end
+  end
+end

data/lib/madman/commands/preview.rb

@@ -0,0 +1,41 @@
+module Madman
+  module Commands
+    class Preview < MisterBin::Command
+      include Colsole
+
+      summary "Serve a markdown 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"
+
+      usage "madman preview FILE [--port N --bind ADDRESS]"
+      usage "madman preview (-h|--help)"
+
+      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"
+
+      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"
+
+      def run(args)
+        file = args['FILE']
+        port = args['--port']
+        bind = args['--bind']
+
+        say "Starting server at !undblu!localhost:#{port}!txtrst!"
+        if ENV['GITHUB_ACCESS_TOKEN']
+          say "To view the GitHub API version go to !undblu!localhost:#{port}/github!txtrst!"
+        end
+        say ''
+
+        Madman::PreviewServer.set bind: bind, port: port, file: file
+        Madman::PreviewServer.run!
+      end
+
+    end
+  end
+end
+

data/lib/madman/commands/readme.rb

@@ -0,0 +1,45 @@
+require 'lp'
+
+module Madman
+  module Commands
+    class Readme < MisterBin::Command
+      include Colsole
+
+      summary "Create README in all qualified sub directories"
+
+      help "This command generates README.md files in all subdirectories. Each file will receive an H1 caption with the name of the folder it resides in. This command is designed to assist in preparing a folder for table of contents injection."
+
+      usage "madman readme DIR [--dry]"
+      usage "madman readme (-h|--help)"
+
+      option "-y --dry", "Only show what will be created, don't make any changes"
+
+      param "DIR", "The directory containing markdown files"
+
+      example "madman readme ."
+      example "madman readme path/to/docs --dry"
+
+      def run(args)
+        dir = args['DIR']
+        basedir = Madman::Directory.new dir, dir
+
+        dirs = basedir.deep_list.select { |i| i.dir? }.map { |i| i.path }
+        dirs.each do |dir|
+          file = "#{dir}/README.md"
+          
+          if File.exist? file
+            say "Skipping #{file}"
+          else
+            say "Creating !txtgrn!#{file}"
+            h1 = "# #{File.basename dir}\n\n"
+            File.write file, h1 unless args['--dry']
+          end
+        end
+
+        say args['--dry'] ? "Done (dry mode, no changes were made)" : "Done"
+      end
+
+    end
+  end
+end
+

data/lib/madman/commands/render.rb

@@ -0,0 +1,42 @@
+module Madman
+  module Commands
+    class Render < MisterBin::Command
+      include Colsole
+
+      help "Render markdown to HTML"
+
+      usage "madman render FILE [--github --save OUTFILE]"
+      usage "madman render (-h|--help)"
+
+      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"
+
+      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"
+
+      def run(args)
+        infile = args['FILE']
+        outfile = args['--save']
+        renderer = args['--github'] ? :github : :default
+
+        doc = Madman::Document.from_file infile
+        
+        output = doc.render renderer
+
+        if outfile
+          File.write outfile, output    
+          say "Saved !txtgrn!#{outfile}"
+        else
+          puts output
+        end
+      end
+
+    end
+  end
+end
+

data/lib/madman/commands/serve.rb

@@ -0,0 +1,39 @@
+module Madman
+  module Commands
+    class Serve < MisterBin::Command
+      include Colsole
+
+      summary "Serve a markdown directory using a local server"
+
+      usage "madman serve DIR [--port N --bind ADDRESS --github]"
+      usage "madman serve (-h|--help)"
+
+      option "--github", "Use the GitHub API renderer instead of the default one"
+      option "-p --port N", "Set server port [default: 3000]"
+      option "-b --bind ADDRESS", "Set server listen address [default: 0.0.0.0]"
+
+      param "DIR", "The directory containing markdown files"
+
+      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 serve"
+      example "madman serve path/to/docs -p4000 --github"
+
+      def run(args)
+        dir = args['DIR']
+        port = args['--port']
+        bind = args['--bind']
+        renderer = args['--github'] ? :github : :default
+
+        say "Starting server at !undblu!localhost:#{port}!txtrst! using the !txtgrn!#{renderer}!txtrst! renderer\n"
+
+        Madman::Server.set bind: bind, port: port, 
+          dir: dir, renderer: renderer
+          
+        Madman::Server.run!
+      end
+
+    end
+  end
+end
+

data/lib/madman/version.rb

@@ -1,3 +1,3 @@
 module Madman
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madman
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-26 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: lp
   requirement: !ruby/object:Gem::Requirement
@@ -294,22 +280,19 @@ description: A command line utility for markdown fun
 email: db@dannyben.com
 executables:
 - madman
-- madman-nav.rb
-- madman-preview.rb
-- madman-readme.rb
-- madman-render.rb
-- madman-serve.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/madman
-- bin/madman-nav.rb
-- bin/madman-preview.rb
-- bin/madman-readme.rb
-- bin/madman-render.rb
-- bin/madman-serve.rb
 - lib/madman.rb
+- lib/madman/cli.rb
+- lib/madman/commands.rb
+- lib/madman/commands/nav.rb
+- lib/madman/commands/preview.rb
+- lib/madman/commands/readme.rb
+- lib/madman/commands/render.rb
+- lib/madman/commands/serve.rb
 - lib/madman/directory.rb
 - lib/madman/document.rb
 - lib/madman/injector.rb

data/bin/madman-nav.rb

@@ -1,62 +0,0 @@
-require 'madman'
-require 'io/console'
-
-summary "Add site-wide navigation links to README files"
-
-help "This command generates a Table of Contents for a directory, and injects it to a file. In addition, it supports recursive execution, which will add a Table of Contents to all README files (or a filename of your choice) in all the subfolders, creating nagigation pages for an entire Markdown site."
-
-usage "madman nav DIR [options]"
-usage "madman nav (-h|--help)"
-
-option "-f --force", "Inject TOC to all README files, even if they do not have a marker"
-option "-m --marker TEXT", "Look for an HTML comment with <!-- TEXT --> [default: nav]"
-option "-d --depth N", "The depth of the table of contents [default: 1]"
-option "-v --verbose", "Show the updated README content"
-option "-t --target NAME", "Set the target filename to look for. [default: README.md]"
-option "-r --recursive", "Inject to all target files"
-option "-y --dry", "Do not save the updated files, just show what will happen"
-
-param "DIR", "The directory containing markdown files"
-
-example "madman nav"
-example "madman nav path/to/docs --force --marker toc"
-example "madman nav path/to/docs --dry -v -d2"
-
-action do |args|
-  @args = args
-
-  if recursive?
-    Dir["#{dir}/**/#{target}"].each { |file| update_file file }
-  else
-    update_file "#{dir}/#{target}"
-  end
-
-  say dry? ? "Done (dry mode, no changes were made)" : "Done"
-end
-
-def update_file(file)
-  say "Updating !txtgrn!#{file}"
-  file_dir = File.dirname file
-  toc = Madman::Navigation.new file_dir, depth: depth
-  doc = Madman::Document.from_file file
-  doc.inject toc.markdown, marker: marker, force: force?
-
-  if verbose?
-    say word_wrap "  !txtblu!#{doc.text}"
-    say ""
-  end
-
-  doc.save unless dry?
-end
-
-# 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

data/bin/madman-preview.rb

@@ -1,34 +0,0 @@
-require 'madman'
-
-summary "Serve a markdown 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"
-
-usage "madman preview FILE [--port N --bind ADDRESS]"
-usage "madman preview (-h|--help)"
-
-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"
-
-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"
-
-action do |args|
-  file = args['FILE']
-  port = args['--port']
-  bind = args['--bind']
-
-  say "Starting server at !undblu!localhost:#{port}!txtrst!"
-  if ENV['GITHUB_ACCESS_TOKEN']
-    say "To view the GitHub API version go to !undblu!localhost:#{port}/github!txtrst!"
-  end
-  say ''
-
-  Madman::PreviewServer.set bind: bind, port: port, file: file
-  Madman::PreviewServer.run!
-end
-

data/bin/madman-readme.rb

@@ -1,37 +0,0 @@
-require 'madman'
-require 'lp'
-
-summary "Create README in all qualified sub directories"
-
-help "This command generates README.md files in all subdirectories. Each file will receive an H1 caption with the name of the folder it resides in. This command is designed to assist in preparing a folder for table of contents injection."
-
-usage "madman readme DIR [--dry]"
-usage "madman readme (-h|--help)"
-
-option "-y --dry", "Only show what will be created, don't make any changes"
-
-param "DIR", "The directory containing markdown files"
-
-example "madman readme ."
-example "madman readme path/to/docs --dry"
-
-action do |args|
-  dir = args['DIR']
-  basedir = Madman::Directory.new dir, dir
-
-  dirs = basedir.deep_list.select { |i| i.dir? }.map { |i| i.path }
-  dirs.each do |dir|
-    file = "#{dir}/README.md"
-    
-    if File.exist? file
-      say "Skipping #{file}"
-    else
-      say "Creating !txtgrn!#{file}"
-      h1 = "# #{File.basename dir}\n\n"
-      File.write file, h1 unless args['--dry']
-    end
-  end
-
-  say args['--dry'] ? "Done (dry mode, no changes were made)" : "Done"
-end
-

data/bin/madman-render.rb

@@ -1,35 +0,0 @@
-require 'madman'
-
-help "Render markdown to HTML"
-
-usage "madman render FILE [--github --save OUTFILE]"
-usage "madman render (-h|--help)"
-
-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"
-
-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"
-
-action do |args|
-  infile = args['FILE']
-  outfile = args['--save']
-  renderer = args['--github'] ? :github : :default
-
-  doc = Madman::Document.from_file infile
-  
-  output = doc.render renderer
-
-  if outfile
-    File.write outfile, output    
-    say "Saved !txtgrn!#{outfile}"
-  else
-    puts output
-  end
-end
-

data/bin/madman-serve.rb

@@ -1,32 +0,0 @@
-require 'madman'
-
-summary "Serve a markdown directory using a local server"
-
-usage "madman serve DIR [--port N --bind ADDRESS --github]"
-usage "madman serve (-h|--help)"
-
-option "--github", "Use the GitHub API renderer instead of the default one"
-option "-p --port N", "Set server port [default: 3000]"
-option "-b --bind ADDRESS", "Set server listen address [default: 0.0.0.0]"
-
-param "DIR", "The directory containing markdown files"
-
-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 serve"
-example "madman serve path/to/docs -p4000 --github"
-
-action do |args|
-  dir = args['DIR']
-  port = args['--port']
-  bind = args['--bind']
-  renderer = args['--github'] ? :github : :default
-
-  say "Starting server at !undblu!localhost:#{port}!txtrst! using the !txtgrn!#{renderer}!txtrst! renderer\n"
-
-  Madman::Server.set bind: bind, port: port, 
-    dir: dir, renderer: renderer
-    
-  Madman::Server.run!
-end
-