madman 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d2cbbb3df05900e21afcc52747a66d7e29966f89e16f479cf5fdf55dfcbf3d0
-  data.tar.gz: 48a7d30f17a8b31909d11ea296c424cbb5611d931d4b1ab101166bb192e43f57
+  metadata.gz: 23e170953e138b20f746310e8152cd7b43a7e1da60023d52745d94c55a1a9e4f
+  data.tar.gz: 1a9315ef63047804e548e040e1aeb9fff47dd87d06bfa6f3050b87bdc4f1c6cb
 SHA512:
-  metadata.gz: 6e2fe3266fe89d3ba1c9cfa776e533d52919dbc0af47609ea5057f07bb6b8d420bd6cbcceb9914a9e53c94975a85ea245df4d91e0025ff0a50427e88051f9fa3
-  data.tar.gz: 59ae594fc5021740a4b980e914b8309a404f1399bfd99a322286307d99a84715f0452eb7131d5f0343715d6c5f221d3614768d10024a45f6bc6034b9e1280aa7
+  metadata.gz: 75bc524b8513c711066ae65c649d752d49475e3e6e1f6b705ec751a5ec27034b1c7683dbf4fc3bc876a4bf17fd30821a078241a44d5d3b8d4c6286567e03cfc0
+  data.tar.gz: c519c432a7288f9ca983aa1ec06aba4437b81f699db16741d49c70200558fbf8868bfbdd86a8e23f98d919a5069c5ff80900006170f2a110d2775f33cfabcb4c

data/README.md

@@ -9,7 +9,7 @@ Madman
 
 ---
 
-The Markdown Swiss Armi Knife
+The Markdown Swiss Army Knife
 
 ---
 
@@ -28,17 +28,21 @@ gem 'madman', require: false
 
 
 
-Key Features
+Features
 --------------------------------------------------
 
-- GitHub-style markdown generation.
-- Convert markdown to a single HTML file (including CSS).
-- Ad-hoc server to serve a markdown file locally for preview.
-- Markdown generation with GitHub API (optional).
-- Table of Contents generation for a folder of markdown files.
-- Web server for an entire folder (like [Madness](https://github.com/DannyBen/madness))
-- [Planned] Table of Contents generation for a single file.
-- [Planned] Combine multiple markdown files to one.
+- [x] GitHub-style markdown generation (markup and stylesheet).
+- [x] Convert markdown to HTML file.
+- [x] Ad-hoc server to serve a markdown file locally for preview.
+- [x] Markdown generation with GitHub API (optional).
+- [x] Table of Contents generation for a folder of markdown files.
+- [x] Web server for an entire folder (like [Madness][1]) with GitHub Pages 
+      compatibility.
+- [x] Automatic detection of Right-to-Left markdown files for HTML rendering.
+- [x] Generate navigation README in folders without one.
+- [ ] [Planned] Generate breadcrumbs.
+- [ ] [Planned] Combine multiple markdown files to one.
+- [ ] [Considered] Table of Contents generation for a single file.
 
 
 
@@ -52,8 +56,9 @@ $ madman
 Commands:
   nav      Add site-wide navigation links to README files
   preview  Serve a markdown file using a local server
+  readme   Create README in all qualified sub directories
   render   Render markdown to HTML
-  serve    Serve a markdown folder using a local server
+  serve    Serve a markdown directory using a local server
 ```
 
 <!-- usage -->
@@ -66,7 +71,7 @@ Commands:
 $ madman render
 Usage:
   madman render FILE [--github --save OUTFILE]
-  madman render (-h|--help|--version)
+  madman render (-h|--help)
 ```
 
 <!-- render -->
@@ -80,7 +85,7 @@ Render markdown to HTML
 
 Usage:
   madman render FILE [--github --save OUTFILE]
-  madman render (-h|--help|--version)
+  madman render (-h|--help)
 
 Options:
   --github
@@ -119,7 +124,7 @@ Examples:
 $ madman preview
 Usage:
   madman preview FILE [--port N --bind ADDRESS]
-  madman preview (-h|--help|--version)
+  madman preview (-h|--help)
 ```
 
 <!-- preview -->
@@ -136,7 +141,7 @@ This command will start a local server with two endpoints:
 
 Usage:
   madman preview FILE [--port N --bind ADDRESS]
-  madman preview (-h|--help|--version)
+  madman preview (-h|--help)
 
 Options:
   -p --port N
@@ -173,8 +178,8 @@ Examples:
 ```
 $ madman serve
 Usage:
-  madman serve FOLDER [--port N --bind ADDRESS --github]
-  madman serve (-h|--help|--version)
+  madman serve DIR [--port N --bind ADDRESS --github]
+  madman serve (-h|--help)
 ```
 
 <!-- serve -->
@@ -183,11 +188,11 @@ Usage:
 
 ```
 $ madman serve --help
-Serve a markdown folder using a local server
+Serve a markdown directory using a local server
 
 Usage:
-  madman serve FOLDER [--port N --bind ADDRESS --github]
-  madman serve (-h|--help|--version)
+  madman serve DIR [--port N --bind ADDRESS --github]
+  madman serve (-h|--help)
 
 Options:
   --github
@@ -203,8 +208,8 @@ Options:
     Show this help
 
 Parameters:
-  FOLDER
-    The folder containing markdown files
+  DIR
+    The directory containing markdown files
 
 Environment Variables:
   GITHUB_ACCESS_TOKEN
@@ -227,8 +232,8 @@ Examples:
 ```
 $ madman nav
 Usage:
-  madman nav FOLDER [--marker TEXT --force --dry --verbose --depth N]
-  madman nav (-h|--help|--version)
+  madman nav DIR [options]
+  madman nav (-h|--help)
 ```
 
 <!-- nav -->
@@ -239,17 +244,18 @@ Usage:
 $ madman nav --help
 Add site-wide navigation links to README files
 
-This command will add a table of contents to all README files in the folder. The
-table of contents will link to all the pages and folders that are in the same
-folder as each README file.
+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 FOLDER [--marker TEXT --force --dry --verbose --depth N]
-  madman nav (-h|--help|--version)
+  madman nav DIR [options]
+  madman nav (-h|--help)
 
 Options:
   -f --force
-    Add to all README files, even if they do not have a marker
+    Inject TOC to all README files, even if they do not have a marker
 
   -m --marker TEXT
     Look for an HTML comment with <!-- TEXT --> [default: nav]
@@ -257,18 +263,24 @@ Options:
   -d --depth N
     The depth of the table of contents [default: 1]
 
-  --dry
-    Do not save the updated files, just show what will happen
-
   -v --verbose
     Show the updated README content
 
+  -t --target NAME
+    Set the target filename to look for. [default: README.md]
+
+  -r --recursive
+    Inject to all target files
+
+  -y --dry
+    Do not save the updated files, just show what will happen
+
   -h --help
     Show this help
 
 Parameters:
-  FOLDER
-    The folder containing markdown files
+  DIR
+    The directory containing markdown files
 
 Examples:
   madman nav
@@ -277,3 +289,52 @@ Examples:
 ```
 
 <!-- nav-help --></details>
+
+
+### Generate README files with H1
+
+<!-- readme -->
+
+```
+$ madman readme
+Usage:
+  madman readme DIR [--dry]
+  madman readme (-h|--help)
+```
+
+<!-- readme -->
+
+<details><summary>Show full usage</summary><!-- readme-help -->
+
+```
+$ madman readme --help
+Create README in all qualified sub directories
+
+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]
+  madman readme (-h|--help)
+
+Options:
+  -y --dry
+    Only show what will be created, don't make any changes
+
+  -h --help
+    Show this help
+
+Parameters:
+  DIR
+    The directory containing markdown files
+
+Examples:
+  madman readme .
+  madman readme path/to/docs --dry
+```
+
+<!-- readme-help --></details>
+
+
+[1]: https://github.com/DannyBen/madness

data/bin/madman-nav.rb

@@ -1,48 +1,62 @@
 require 'madman'
+require 'io/console'
 
 summary "Add site-wide navigation links to README files"
 
-help "This command will add a table of contents to all README files in the folder. The table of contents will link to all the pages and folders that are in the same folder as each README file."
+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 FOLDER [--marker TEXT --force --dry --verbose --depth N]"
-usage "madman nav (-h|--help|--version)"
+usage "madman nav DIR [options]"
+usage "madman nav (-h|--help)"
 
-option "-f --force", "Add to all README files, even if they do not have a marker"
+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 "--dry", "Do not save the updated files, just show what will happen"
 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 "FOLDER", "The folder containing markdown files"
+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|
-  dir     = args['FOLDER'] || '.'
-  force   = args['--force']
-  marker  = args['--marker']
-  dry     = args['--dry']
-  verbose = args['--verbose']
-  depth   = args['--depth'].to_i
-
-  candidates = Dir["#{dir}/**/README.md"]
-  candidates.each do |candidate|
-    say "Updating !txtgrn!#{candidate}"
-    candidate_dir = File.dirname candidate
-    toc = Madman::Navigation.new candidate_dir, depth: depth
-    doc = Madman::Document.from_file candidate
-    doc.inject toc.markdown, marker: marker, force: force
-
-    if verbose
-      say word_wrap "  !txtblu!#{doc.text}"
-      say ""
-    end
-
-    doc.save unless dry
+  @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
 
-  say dry ? "Done (dry mode, nothing changed)" : "Done"
+  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

@@ -5,7 +5,7 @@ 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|--version)"
+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]"

data/bin/madman-readme.rb

@@ -0,0 +1,37 @@
+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

@@ -3,7 +3,7 @@ require 'madman'
 help "Render markdown to HTML"
 
 usage "madman render FILE [--github --save OUTFILE]"
-usage "madman render (-h|--help|--version)"
+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"

data/bin/madman-serve.rb

@@ -1,15 +1,15 @@
 require 'madman'
 
-summary "Serve a markdown folder using a local server"
+summary "Serve a markdown directory using a local server"
 
-usage "madman serve FOLDER [--port N --bind ADDRESS --github]"
-usage "madman serve (-h|--help|--version)"
+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 "FOLDER", "The folder containing markdown files"
+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"
 
@@ -17,7 +17,7 @@ example "madman serve"
 example "madman serve path/to/docs -p4000 --github"
 
 action do |args|
-  dir = args['FOLDER'] || '.'
+  dir = args['DIR']
   port = args['--port']
   bind = args['--bind']
   renderer = args['--github'] ? :github : :default

data/lib/madman/directory.rb

@@ -12,6 +12,14 @@ module Madman
       @list ||= (dirs + files)
     end
 
+    def deep_list
+      result = list
+      dirs.each do |dir|
+        result += Directory.new(dir.path, basedir).deep_list
+      end
+      result
+    end
+
     private
 
     def files

data/lib/madman/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madman
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2018-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -296,6 +296,7 @@ executables:
 - madman
 - madman-nav.rb
 - madman-preview.rb
+- madman-readme.rb
 - madman-render.rb
 - madman-serve.rb
 extensions: []
@@ -305,6 +306,7 @@ files:
 - 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
@@ -344,5 +346,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: The Markdown Swiss Armi Knife
+summary: The Markdown Swiss Army Knife
 test_files: []