DannyBen/bashly

View on GitHub
lib/bashly/commands/doc.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Bashly
  module Commands
    class Doc < Base
      summary 'Show bashly reference documentation'

      usage 'bashly doc [SEARCH] [--index]'
      usage 'bashly doc (-h|--help)'

      option '-i --index', 'Show option keys only'
      param 'SEARCH', 'Search for options that match this text'

      example 'bashly doc command'
      example 'bashly doc command.flags'
      example 'bashly doc flag. -i'
      example 'bashly doc catch_all'

      def run
        if args['--index']
          puts data.keys
        else
          show
        end
      end

    private

      def show
        data.each do |key, info|
          show_key key
          show_help info['help']
          show_example info['example'] if info['example']
          show_url info['url'] if info['url']
        end
      end

      def show_key(key)
        say "g`#{key}`"
        say ''
      end

      def show_url(url)
        say "  See bu`#{url}`"
        say ''
      end

      def show_example(example)
        example = word_wrap "    #{example}"
        example.gsub!(/^(\s*- )?(\s*\w+):/, '\1b`\2`:')
        example.gsub!(/^(\s*- )/, 'y`\1`')
        example.gsub!(/^(\s*#.+)/, 'm`\1`')
        say example
        say ''
      end

      def show_help(help)
        help = word_wrap "  #{help}"
        help.gsub!(/`([^`]+)`/, 'g`\1`')
        say help
        say ''
      end

      def data
        return raw_data unless args['SEARCH']

        result = raw_data.select { |k, _v| k == args['SEARCH'] }
        return result if result.any?

        result = raw_data.select { |k, _v| k.include? args['SEARCH'] }
        return result if result.any?

        raise Error, 'No match'
      end

      def raw_data
        @raw_data ||= begin
          result = {}
          Dir["#{docs_dir}/*.yml"].each do |path|
            result.merge! YAML.load_file(path)
          end
          result
        end
      end

      def docs_dir
        @docs_dir ||= File.expand_path '../docs', __dir__
      end
    end
  end
end