cli_markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec2eb95b5cd0c7a7295f1b31195979c9d9fad652676517a0e59166875b76e330
+  data.tar.gz: 0cf8d886a34c22b26ffa8f8fe49f12ab68a30e36286ddfcb149646394939dac9
+SHA512:
+  metadata.gz: 65805b1221655539b07cfb7144f4ed86e52446f7ee8c5e1d04972b5e5615e13f3dabcecfb0face82f17f1db4433795d4edf859749304e5cf010ae40a55b9c75b
+  data.tar.gz: a6b7bf93e2763b2e3557a0d0f8c6e57cba0081be9476267059b0c4b66a26d89da0fb84355165edfe679d74601e9ad3beb3682a3eb94403fbddbcbd06c34db6d3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/docs

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## [0.1.0]
+- Initial release
+- Extract cli doc generation out of lono

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cli_markdown.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    cli_markdown (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    aws-partitions (1.67.0)
+    aws-sdk-cloudformation (1.3.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-core (3.16.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.5.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-s3 (1.8.2)
+      aws-sdk-core (~> 3)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    coderay (1.1.2)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    ffi (1.9.23)
+    filesize (0.1.1)
+    formatador (0.2.5)
+    graph (2.8.2)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-cloudformation (0.0.3)
+      colorize
+      guard
+    guard-compat (1.2.1)
+    guard-lono (1.0.1)
+      colorize
+      guard
+      guard-compat
+    hashie (3.5.7)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.3.1)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lono (4.0.6)
+      activesupport
+      aws-sdk-cloudformation
+      aws-sdk-s3
+      colorize
+      filesize
+      graph
+      guard
+      guard-cloudformation
+      guard-lono
+      hashie
+      json
+      rb-fsevent
+      render_me_pretty
+      thor
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    render_me_pretty (0.7.1)
+      activesupport
+      colorize
+      tilt
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  cli_markdown!
+  lono
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,43 @@
+# CliMarkdown
+
+Library generates markdown from a Thor CLI class.  The markdown is meant to be served as part of a Jekyll static website.
+
+## Usage
+
+To use, add the following to your `Rakefile`:
+
+```ruby
+require_relative "lib/your_tool"
+require "cli_markdown"
+desc "Generates cli reference docs as markdown"
+task :docs do
+  CliMarkdown::Creator.create_all(cli_class: YourTool::CLI, cli_name: "your_tool")
+end
+```
+
+* The `YourTool::CLI` class must be a Thor class.
+* The cli_name is the name of the cli command used for your tool.
+
+To generate docs, you can call:
+
+    rake docs
+
+This will generate docs in the `docs/_reference` folder.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cli_markdown'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cli_markdown.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+# In a real project the require will be the project itself.
+# This ask is only here to pass specs.
+require "lono"
+require "./lib/cli_markdown"
+desc "Generates cli reference docs as markdown"
+task :docs do
+  CliMarkdown::Creator.create_all(cli_class: Lono::CLI, cli_name: "lono")
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cli_markdown"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cli_markdown.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cli_markdown/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli_markdown"
+  spec.version       = CliMarkdown::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = "Generate markdown docs from cli docs"
+  spec.homepage      = "https://github.com/tongueroo/cli_markdown"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "lono"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/cli_markdown.rb

@@ -0,0 +1,8 @@
+require "cli_markdown/version"
+
+module CliMarkdown
+  autoload :Creator, 'cli_markdown/creator'
+  autoload :Index, 'cli_markdown/index'
+  autoload :Page, 'cli_markdown/page'
+  autoload :Shell, 'cli_markdown/shell'
+end

data/lib/cli_markdown/creator.rb

@@ -0,0 +1,81 @@
+require "active_support/core_ext/object"
+
+module CliMarkdown
+  class Creator
+    cattr_accessor :mute
+
+    def self.create_all(options={})
+      clean unless options[:parent_command_name]
+      new(options).create_all
+    end
+
+    def self.clean
+      FileUtils.rm_rf("docs/_reference")
+      FileUtils.rm_f("docs/reference.md")
+    end
+
+    # cli_class is top-level CLI class.
+    def initialize(cli_class:, cli_name:, parent_command_name: nil)
+      @cli_class = cli_class
+      @cli_name = cli_name
+      @parent_command_name = parent_command_name
+    end
+
+    def create_all
+      create_index unless @parent_command_name
+
+      @cli_class.commands.keys.each do |command_name|
+        page = Page.new(
+            cli_class: @cli_class,
+            cli_name: @cli_name,
+            command_name: command_name,
+            parent_command_name: @parent_command_name,
+          )
+        create_page(page)
+
+        if subcommand?(command_name)
+          subcommand_class = subcommand_class(command_name)
+          parent_command_name = command_name
+
+          say "Creating subcommands pages for #{parent_command_name}..."
+          Creator.create_all(
+            cli_class: subcommand_class,
+            cli_name: @cli_name,
+            parent_command_name: parent_command_name
+          )
+        end
+      end
+    end
+
+    def create_page(page)
+      say "Creating #{page.path}..."
+      FileUtils.mkdir_p(File.dirname(page.path))
+      IO.write(page.path, page.doc)
+    end
+
+    def create_index
+      create_include_reference
+      page = Index.new(@cli_class, @cli_name)
+      FileUtils.mkdir_p(File.dirname(page.path))
+      say "Creating #{page.path}"
+      IO.write(page.path, page.doc)
+    end
+
+    def create_include_reference
+      path = "docs/_includes/reference.md"
+      IO.write(path, "Generic tool description. Please edit #{path} with a description.") unless File.exist?(path)
+    end
+
+    def subcommand?(command_name)
+      @cli_class.subcommands.include?(command_name)
+    end
+
+    def subcommand_class(command_name)
+      @cli_class.subcommand_classes[command_name]
+    end
+
+    def say(text)
+      puts text unless self.class.mute
+    end
+  end
+end

data/lib/cli_markdown/index.rb

@@ -0,0 +1,36 @@
+module CliMarkdown
+  class Index
+    def initialize(cli_class, cli_name)
+      @cli_class = cli_class
+      @cli_name = cli_name
+    end
+
+    def path
+      "docs/reference.md"
+    end
+
+    def command_list
+      @cli_class.commands.keys.sort.map.each do |command_name|
+        page = Page.new(
+            cli_class: @cli_class,
+            cli_name: @cli_name,
+            command_name: command_name,
+          )
+        link = page.path.sub("docs/", "")
+        # Example: [lono cfn]({% link _reference/lono-cfn.md %})
+        "* [#{@cli_name} #{command_name}]({% link #{link} %})"
+      end.join("\n")
+    end
+
+    def doc
+      <<-EOL
+---
+title: CLI Reference
+---
+{% include reference.md %}
+
+#{command_list}
+EOL
+    end
+  end
+end

data/lib/cli_markdown/page.rb

@@ -0,0 +1,167 @@
+module CliMarkdown
+  class Page
+    attr_reader :cli_name
+    def initialize(cli_class:, cli_name:, command_name:, parent_command_name: nil)
+      @cli_class = cli_class # IE: Lono::CLI
+      @cli_name = cli_name # IE: lono
+      @command_name = command_name # IE: generate
+      @parent_command_name = parent_command_name # IE: cfn
+      @command = @cli_class.commands[@command_name]
+    end
+
+    def usage
+      banner = @cli_class.send(:banner, @command) # banner is protected method
+      invoking_command = File.basename($0) # could be rspec, etc
+      banner.sub(invoking_command, cli_name)
+    end
+
+    def description
+      @command.description
+    end
+
+    def options
+      shell = Shell.new
+      @cli_class.send(:class_options_help, shell, nil => @command.options.values)
+      text = shell.stdout.string
+      return "" if text.empty? # there are no options
+
+      lines = text.split("\n")[1..-1] # remove first line wihth "Options: "
+      lines.map! do |line|
+        # remove 2 leading spaces
+        line.sub(/^  /, '')
+      end
+      lines.join("\n")
+    end
+
+    # Use command's long description as many description
+    def long_description
+      text = @command.long_description
+      return "" if text.nil? # empty description
+
+      lines = text.split("\n")
+      lines.map do |line|
+        # In the CLI help, we use 2 spaces to designate commands
+        # In Markdown we need 4 spaces.
+        line.sub(/^  \b/, '    ')
+      end.join("\n")
+    end
+
+    def path
+      full_name = if @parent_command_name
+        "#{cli_name}-#{@parent_command_name}-#{@command_name}"
+      else
+        "#{cli_name}-#{@command_name}"
+      end
+      "docs/_reference/#{full_name}.md"
+    end
+
+    def subcommand?
+      @cli_class.subcommands.include?(@command_name)
+    end
+
+    def subcommand_class
+      @cli_class.subcommand_classes[@command_name]
+    end
+
+    # Note:
+    # printable_commands are in the form:
+    #  [
+    #    [command_form,command_comment],
+    #    [command_form,command_comment],
+    #  ]
+    #
+    # It is useful to grab the command form printable_commands as it shows
+    # the proper form.
+    def subcommand_list
+      return '' unless subcommand?
+
+      invoking_command = File.basename($0) # could be rspec, etc
+      command_list = subcommand_class.printable_commands
+        .sort_by { |a| a[0] }
+        .map { |a| a[0].sub!(invoking_command, cli_name); a } # replace with proper comand
+        .reject { |a| a[0].include?("help [COMMAND]") } # filter out help
+
+      # dress up with markdown
+      text = command_list.map do |a|
+        command, comment = a[0], a[1].sub(/^# /,'')
+        subcommand_name = command.split(' ')[2]
+        full_command_path = "#{cli_name}-#{@command_name}-#{subcommand_name}"
+        full_command_name = "#{cli_name} #{@command_name} #{subcommand_name}"
+        link = "_reference/#{full_command_path}.md"
+
+        # "* [#{command}]({% link #{link} %})"
+        # Example: [lono cfn delete STACK]({% link _reference/lono-cfn-delete.md %})
+        "* [#{full_command_name}]({% link #{link} %}) - #{comment}"
+      end.join("\n")
+
+      <<-EOL
+## Subcommands
+
+#{text}
+EOL
+    end
+
+    def doc
+      <<-EOL
+#{front_matter}
+#{usage_markdown}
+#{long_desc_markdown}
+#{subcommand_list}
+#{options_markdown}
+EOL
+    end
+
+    def front_matter
+      command = [cli_name, @parent_command_name, @command_name].compact.join(' ')
+      <<-EOL
+---
+title: #{command}
+reference: true
+---
+EOL
+    end
+
+    def usage_markdown
+      <<-EOL
+## Usage
+
+    #{usage}
+EOL
+    end
+
+    def desc_markdown
+      <<-EOL
+## Description
+
+#{description}
+EOL
+    end
+
+    # If the Thor long_description is empty then use the description.
+    def long_desc_markdown
+      return desc_markdown if long_description.empty?
+
+      <<-EOL
+## Description
+
+#{description}
+
+#{long_description}
+EOL
+    end
+
+    # handles blank options
+    def options_markdown
+      return '' if options.empty?
+
+      <<-EOL
+## Options
+
+```
+#{options}
+```
+EOL
+    end
+
+  end
+end

data/lib/cli_markdown/shell.rb

@@ -0,0 +1,11 @@
+require 'thor'
+
+module CliMarkdown
+  # Override stdout as an @io object so we can grab the text written normally
+  # outputted to the shell.
+  class Shell < Thor::Shell::Basic
+    def stdout
+      @io ||= StringIO.new
+    end
+  end
+end

data/lib/cli_markdown/version.rb

@@ -0,0 +1,3 @@
+module CliMarkdown
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: cli_markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lono
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cli_markdown.gemspec
+- lib/cli_markdown.rb
+- lib/cli_markdown/creator.rb
+- lib/cli_markdown/index.rb
+- lib/cli_markdown/page.rb
+- lib/cli_markdown/shell.rb
+- lib/cli_markdown/version.rb
+homepage: https://github.com/tongueroo/cli_markdown
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Generate markdown docs from cli docs
+test_files: []