terradoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: becee654fffe5ec2bb4e0b798cf831f259b0cdbf117835b58c88964d213a5a13
+  data.tar.gz: caa198ed9694b6af9b11a312cd64e9b840495d67f02912c87c0d9f8d1a529e94
+SHA512:
+  metadata.gz: 0e6dd4bd07e79b6524c92f003a409b0d14d18b4001495780a514cc3e1e9b95046f488bb1657215db2ed6a4a613a35a421f5868d98c59c74e39929ef4076543d2
+  data.tar.gz: 6fe4358a94c96b115c918c52989fcfb235c497841d635c93140888d8447982316c01d51869830f7a57ceeefbe36f6b88596fc2fba0e950a5847a98e74d286e8c

data/.gitattributes

@@ -0,0 +1,2 @@
+# Just override github
+* linguist-language=Ruby

data/.gitignore

@@ -0,0 +1,22 @@
+.idea
+ab-results*
+.lock
+.caretaker.yml
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/Gemfile.lock
+
+*.gem
+
+# rspec failure tracking
+.rspec_status
+
+

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,71 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+#
+# New
+#
+Style/HashEachMethods:
+    Enabled: false
+
+Style/HashTransformKeys:
+    Enabled: false
+
+Style/HashTransformValues:
+    Enabled: false
+
+Layout/FirstHashElementIndentation:
+    Enabled: false
+
+Layout/HashAlignment:
+    Enabled: false
+
+Layout/IndentationWidth:
+    Width: 4
+
+Layout/LineLength:
+    Enabled: false
+
+Layout/SpaceAroundOperators:
+    Enabled: false
+
+Metrics/BlockNesting:
+    Enabled: false
+
+Metrics/AbcSize:
+    Enabled: false
+
+Metrics/BlockLength:
+    Enabled: false
+
+Metrics/ClassLength:
+    Enabled: false
+
+Metrics/CyclomaticComplexity:
+    Enabled: false
+
+Metrics/MethodLength: 
+    Enabled: false
+
+Metrics/PerceivedComplexity:
+    Enabled: false
+
+Style/FrozenStringLiteralComment:
+    Enabled: false
+
+Style/HashSyntax:
+    Enabled: false
+
+Style/RaiseArgs:
+    EnforcedStyle: compact
+
+Style/RedundantParentheses:
+    Enabled: false
+
+Style/RedundantBegin:
+    Enabled: false
+
+Style/RedundantReturn:
+    Enabled: false
+
+Style/SpecialGlobalVars:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,64 @@
+matrix:
+  include:
+  - language: ruby
+    name: Bundler (rvm 2.5 & bundler)
+    rvm: 2.5
+    before_install:
+    - gem install bundler
+  - language: ruby
+    name: Bundler (rvm 2.6 & bundler)
+    rvm: 2.6
+    before_install:
+    - gem install bundler
+  - language: ruby
+    name: Bundler (rvm 2.7 & bundler)
+    rvm: 2.7
+    before_install:
+    - gem install bundler
+  - language: ruby
+    name: Rubocop (rvm 2.5)
+    env: SKIP_INTERPRETER=true
+    rvm: 2.5
+    before_install:
+    - git clone https://github.com/TravisToolbox/rubocop-travis.git
+    install:
+    - "./rubocop-travis/install.sh"
+    script:
+    - "./rubocop-travis/scan.sh"
+  - language: ruby
+    name: Rubocop (rvm 2.6)
+    env: SKIP_INTERPRETER=true
+    rvm: 2.6
+    before_install:
+    - git clone https://github.com/TravisToolbox/rubocop-travis.git
+    install:
+    - "./rubocop-travis/install.sh"
+    script:
+    - "./rubocop-travis/scan.sh"
+  - language: ruby
+    name: Rubocop (rvm 2.7)
+    env: SKIP_INTERPRETER=true
+    rvm: 2.7
+    before_install:
+    - git clone https://github.com/TravisToolbox/rubocop-travis.git
+    install:
+    - "./rubocop-travis/install.sh"
+    script:
+    - "./rubocop-travis/scan.sh"
+  - language: ruby
+    name: Link Checking (rvm 2.7)
+    rvm: 2.7
+    env:
+    - WHITELIST="https://img.shields.io"
+    - EXCLUDE_FILES="CHANGELOG.md"
+    before_install:
+    - mkdir travis
+    - git clone https://github.com/TravisToolbox/awesomebot-travis.git travis/awesomebot
+    install:
+    - "./travis/awesomebot/install.sh"
+    script:
+    - "./travis/awesomebot/scan.sh"
+notifications:
+  email: false
+  slack:
+    secure: X44KdQElVK2NVkGtb9qda7XQzZPepO+odLBeNxqPCEAQ/0GpgTFi+nJ6iFMQ01usrCfz78EgerwKF51RAhjrdNAr6ySIxmErsLzbmtKKbpF46meLZ5qdWAisuVCMpc+t+ypFnQ/sEjboC5HbhBZH4waFnH/sWU6GorSVotkNaz/dEoHUD8No2iJTbbohPBO8ftX6NtCV7L9kd2pB2P9WWqUxMlT3DJJY4VruDKBC/zJnLa6+R9Af2BxZ9JIfSHoRGKIDcSto53FD8R+h7jOQGMRHTkwbNgA5E9B5u+5zmRVKXfUSAY84Z71sE3Srt+B3nGDh3e0iez2L9JvmWfJBvrNBbfnOTmHHSCtMpfzq4a37RNHUS/8M3KwZFcg3zYKubifg1qG3C3JHscikwNnSiSoImJUvS04V6Wzr3lyfOkUunF6HiffEFJ7wOVIo00dqqdADw0u2POVae0FGf34MOLCBA/mLpU51cJA9G+RxomPPhP7byNCPM3aBNqQD+YlyChT9Co+e6+G2YXwTxMEGrBP8628yDk+aM/MRuGFVv55N5gMXspZgTzwP3OcDT4CtxDHhKAZl/Wf9EJcqhzrEUWfss5vHLqDRYwbJCqPGJ5iyxHNHAzc3F0HLWjEhO8DVknn/wyEzEQWolzgxURICmPb8Ej1VSg+jlfzY+0e/ams=

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+
+This changelog was automatically generated using [Caretaker](https://github.com/TerraformToolbox/terradoc) by [Wolf Software](https://github.com/WolfSoftware)
+
+### [v0.1.0](https://github.com/TerraformToolbox/terradoc/releases/v0.1.0)
+
+> Released on March, 17th 2020
+
+- Add version file for caretaker to manage tags/releases [`[c7d9d84]`](https://github.com/TerraformToolbox/terradoc/commit/c7d9d8427db0896113dc685f54f0d23f42e01745) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Update README [`[7bc378b]`](https://github.com/TerraformToolbox/terradoc/commit/7bc378b152cc64eb826d60cab610146c17134433) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Initial Push [`[cf4ca4a]`](https://github.com/TerraformToolbox/terradoc/commit/cf4ca4ad9093fe84c4f8133a78f31191ce52b2e0) [`[TGWolf]`](https://github.com/TGWolf)
+

data/CODEOWNERS

@@ -0,0 +1,7 @@
+# The codeowners file:
+#
+# For more information please read: https://help.github.com/articles/about-codeowners/
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+*       @TerraformToolbox/reviewers

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+Please refer to the [contributing](https://github.com/TerraformToolbox/contributing) documentation.

data/EXAMPLE.md

@@ -0,0 +1,24 @@
+# Some example README
+
+## Terraform Data Sources
+<!--Terradoc-data-sources-start-->
+<!--Terradoc-data-sources-end-->
+
+## Terraform Modules
+<!--Terradoc-modules-start-->
+<!--Terradoc-modules-end-->
+
+## The Outputs
+<!--Terradoc-outputs-start-->
+<!--Terradoc-outputs-end-->
+
+## The resources we create
+<!--Terradoc-resources-start-->
+<!--Terradoc-resources-end-->
+
+## The inputs / variables
+<!--Terradoc-variables-start-->
+<!--Terradoc-variables-end-->
+
+
+# END

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,24 @@
+# The MIT License (MIT)
+
+Copyright © `2016 - 2020` `AntiPhoton Limited`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+[![Build Status](https://img.shields.io/travis/TerraformToolbox/terradoc/master?style=for-the-badge&logo=travis)](https://travis-ci.org/TerraformToolbox/terradoc)
+[![Software License](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](LICENSE.md)
+[![Release](https://img.shields.io/github/release/TerraformToolbox/terradoc?color=blue&style=for-the-badge&logo=github&label=Latest%20Release)](https://github.com/TerraformToolbox/terradoc/releases/latest)
+[![Last Release](https://img.shields.io/github/release-date/TerraformToolbox/terradoc?color=blue&style=for-the-badge&logo=github)](https://github.com/TerraformToolbox/terradoc/releases/latest)
+[![Github commits (since latest release)](https://img.shields.io/github/commits-since/TerraformToolbox/terradoc/latest?color=blue&style=for-the-badge&logo=github)](https://github.com/TerraformToolbox/terradoc/commits)
+[![Last Commit](https://img.shields.io/github/last-commit/TerraformToolbox/terradoc?color=blue&style=for-the-badge&logo=github)](https://github.com/TerraformToolbox/terradoc/commits/master)
+[![TerraformToolbox](https://img.shields.io/badge/Released%20By-Wolf%20Software%20Ltd.-blue?style=for-the-badge)](https://github.com/TerraformToolbox)
+
+# Terradoc
+
+Terradoc is a tool creating documentation from terraform code. It will parse all of the terraform code in a given directory and generate 5 data tables.
+
+1. Data Sources
+2. Modules
+3. Outputs
+4. Resources
+5. Variables
+
+You can then use the custom tags to insert these data tables into your README or other markdown files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'terradoc'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install terradoc
+```
+
+## Usage
+
+```
+Usage: terradoc
+    -h, --help               Display this screen
+    -v, --verbose            Turn on verbose mode
+    -o, --output string      Name of the output file. [default: README.md]
+    -p, --path string        Path to the terraform code. [default: current directory]
+
+```
+
+Once you have installed Terradoc you can simply run ```terradoc``` and it will generate the output. 
+
+## Contributing to Terradoc
+
+### Setup
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+
+### Testing
+
+For local testing make sure that you run `bundle exec rspec spec` and then `rake install` to install the gem locally.
+
+For further information please refer to the [contributing](https://github.com/TerraformToolbox/contributing) documentation.
+
+## To-Do List
+
+- [ ] Allow for setting of root url for linking to terraform registry
+- [ ] Allow different format outputs
+- [ ] Allow got global config files
+- [ ] Pre/Post git commit hook
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION.txt

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'terradoc'
+
+# 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/exe/terradoc

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift('./lib')
+
+require 'optparse'
+require 'terradoc'
+
+# -------------------------------------------------------------------------------- #
+# Run Terradoc                                                                     #
+# -------------------------------------------------------------------------------- #
+# Pass the command line options to the class and run terradoc                      #
+# -------------------------------------------------------------------------------- #
+
+def run_terradoc(options)
+    begin
+        Terradoc.new(options)
+    rescue StandardError => e
+        puts "Error: #{e}"
+        puts e.backtrace if options[:verbose]
+        exit(1)
+    end
+end
+
+# -------------------------------------------------------------------------------- #
+# Process Arguments                                                                #
+# -------------------------------------------------------------------------------- #
+# This function will process the input from the command line and work out what it  #
+# is that the user wants to see.                                                   #
+#                                                                                  #
+# This is the main processing function where all the processing logic is handled.  #
+# -------------------------------------------------------------------------------- #
+
+def process_arguments
+    options = { :verbose => false }
+    # Enforce the presence of
+    mandatory = %I[]
+
+    optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$PROGRAM_NAME}"
+
+        opts.on('-h', '--help', 'Display this screen') do
+            puts opts
+            exit(1)
+        end
+        opts.on('-v', '--verbose', 'Turn on verbose mode') do
+            options[:verbose] = true
+        end
+
+        opts.on('-o', '--output string', 'Set the name of the output file. [default: README.md]') do |output|
+            options[:output] = output
+        end
+        opts.on('-p', '--path string', 'Set the path for where the terraform code is. [default: current directory]') do |path|
+            options[:path] = path
+        end
+    end
+
+    begin
+        optparse.parse!
+        missing = mandatory.select { |param| options[param].nil? }
+        raise OptionParser::MissingArgument.new(missing.join(', ')) unless missing.empty?
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        puts e.to_s
+        puts optparse
+        exit
+    end
+
+    exit 0 if run_terradoc(options)
+
+    exit 1
+end
+
+# -------------------------------------------------------------------------------- #
+# Main()                                                                           #
+# -------------------------------------------------------------------------------- #
+# The main function where all of the heavy lifting and script config is done.      #
+# -------------------------------------------------------------------------------- #
+
+def main
+    process_arguments
+end
+
+main
+
+# -------------------------------------------------------------------------------- #
+# End of Script                                                                    #
+# -------------------------------------------------------------------------------- #
+# This is the end - nothing more to see here.                                      #
+# -------------------------------------------------------------------------------- #

data/lib/terradoc/version.rb

@@ -0,0 +1,3 @@
+class Terradoc
+    VERSION = '0.1.0'.freeze
+end

data/lib/terradoc.rb

@@ -0,0 +1,333 @@
+require 'terradoc/version'
+
+require 'tty-spinner'
+
+# -------------------------------------------------------------------------------- #
+# -------------------------------------------------------------------------------- #
+# -------------------------------------------------------------------------------- #
+class Terradoc
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def initialize(options = {})
+        @base_path = '.'
+        @base_path = options[:path] unless options[:path].nil?
+        @base_path.chomp!('/')
+        raise StandardError.new("Path #{@base_path} does not exist - Aborting") unless Dir.exist? @base_path
+
+        @output_file = 'CHANGELOG.md'
+        @output_file = options[:output] unless options[:output].nil?
+
+        @files   = []
+        @pattern = "#{@base_path}/*.tf"
+
+        @config = {
+                    'data-sources' => {
+                                        'include'        => 'data',
+                                        'match'          => /^(?!data).*/,
+                                        'regex'          => /^data\s*"(?<name>.*)"\s*".*/,
+                                        'split'          => /(?=data\s*")/,
+                                        'start'          => '<!--Terradoc-data-sources-start-->',
+                                        'end'            => '<!--Terradoc-data-sources-end-->',
+                                        'raw_results'    => [],
+                                        'sorted_results' => [],
+                                        'data_table'     => []
+                                      },
+                    'modules'      => {
+                                        'include'        => 'module',
+                                        'match'          => /^(?!module).*/,
+                                        'regex'          => /^module\s*".*"\s*{\s*source\s*=\s*"(?<name>.*?)"/,
+                                        'split'          => /(?=module\s*")/,
+                                        'start'          => '<!--Terradoc-modules-start-->',
+                                        'end'            => '<!--Terradoc-modules-end-->',
+                                        'raw_results'    => [],
+                                        'sorted_results' => [],
+                                        'data_table'     => []
+                                      },
+                    'outputs'      => {
+                                        'include'        => 'output',
+                                        'match'          => /^(?!output).*/,
+                                        'regex'          => /^output\s*"(?<name>.*)"\s*{\s*(?<details>.*)\s*}/,
+                                        'regex_stage_2'  => /description\s*=\s*"(?<description>.*?)".*/,
+                                        'split'          => /(?=output\s*")/,
+                                        'start'          => '<!--Terradoc-outputs-start-->',
+                                        'end'            => '<!--Terradoc-outputs-end-->',
+                                        'raw_results'    => [],
+                                        'sorted_results' => [],
+                                        'data_table'     => []
+                                      },
+                    'resources'    => {
+                                        'include'        => 'resource',
+                                        'match'          =>  /^(?!resource).*/,
+                                        'regex'          => /^resource\s*"(?<name>.*)"\s*".*/,
+                                        'split'          => /(?=resource\s*")/,
+                                        'start'          => '<!--Terradoc-resources-start-->',
+                                        'end'            => '<!--Terradoc-resources-end-->',
+                                        'raw_results'    => [],
+                                        'sorted_results' => [],
+                                        'data_table'     => []
+                                      },
+                    'variables'    => {
+                                        'include'        => 'variable',
+                                        'match'          => /^(?!variable).*/,
+                                        'regex'          => /^variable\s*"(?<name>.*)"\s*{\s*(?<details>.*)\s*}/,
+                                        'regex_stage_2'  => /(description|type|default)\s*=\s*(.*?(?=description|type|default\s*=\s*|$))/,
+                                        'split'          => /(?=variable\s*")/,
+                                        'start'          => '<!--Terradoc-variables-start-->',
+                                        'end'            => '<!--Terradoc-variables-end-->',
+                                        'raw_results'    => [],
+                                        'sorted_results' => [],
+                                        'data_table'     => []
+                                      }
+                  }
+
+        terradoc_main
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def terradoc_main
+        spinners = TTY::Spinner::Multi.new("[:spinner] Terradoc is processing your files (Path: #{@base_path}, Output File: #{@output_file})")
+
+        sp1 = spinners.register '[:spinner] Locating files'
+        sp2 = spinners.register '[:spinner] Processing files'
+        sp3 = spinners.register '[:spinner] Sorting the results'
+        sp4 = spinners.register '[:spinner] Generating data tables'
+        sp5 = spinners.register '[:spinner] Writing output'
+
+        sp1.auto_spin
+        sp2.auto_spin
+        sp3.auto_spin
+        sp4.auto_spin
+        sp5.auto_spin
+
+        generate_file_list
+        sp1.success
+
+        process_files
+        sp2.success
+
+        sort_details
+        sp3.success
+
+        generate_data_tables
+        sp4.success
+
+        write_output
+        sp5.success
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def generate_file_list
+        Dir.glob(@pattern).each do |file|
+            @files << file
+        end
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def process_files
+        @files.each do |file|
+            lines = File.readlines(file)
+            lines = lines.reject { |x| x.start_with? '#' }
+            data = lines.join(' ').gsub("\r\n", ' ').gsub("\n", ' ').gsub("\r", ' ').squeeze(' ').strip
+
+            process_file(data)
+        end
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def cleanup_array(array)
+        array = array.uniq { |k| k[:name] } if array.count.positive?
+        array = array.sort_by { |k| k[:name] } if array.count.positive?
+
+        return array
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def sort_details
+        @config['data-sources']['sorted_results'] = cleanup_array(@config['data-sources']['raw_results'])
+        @config['modules']['sorted_results'] = cleanup_array(@config['modules']['raw_results'])
+        @config['outputs']['sorted_results'] = cleanup_array(@config['outputs']['raw_results'])
+        @config['resources']['sorted_results'] = cleanup_array(@config['resources']['raw_results'])
+        @config['variables']['sorted_results'] = cleanup_array(@config['variables']['raw_results'])
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def generate_data_tables
+        if @config['data-sources']['sorted_results'].size.positive?
+            @config['data-sources']['data_table'] << '| Name |'
+            @config['data-sources']['data_table'] << '| ---- |'
+            @config['data-sources']['sorted_results'].each do |item|
+                @config['data-sources']['data_table'] << "| #{item[:name]} |"
+            end
+        else
+            @config['data-sources']['data_table'] << '> No data found'
+        end
+
+        if @config['modules']['sorted_results'].size.positive?
+            @config['modules']['data_table'] << '| Name |'
+            @config['modules']['data_table'] << '| ---- |'
+            @config['modules']['sorted_results'] .each do |item|
+                @config['modules']['data_table']  << "| #{item[:name]} |"
+            end
+        else
+            @config['modules']['data_table'] << '> No data found'
+        end
+
+        if @config['outputs']['sorted_results'].size.positive?
+            @config['outputs']['data_table'] << '| Name | Description |'
+            @config['outputs']['data_table'] << '| ---- | ----------- |'
+            @config['outputs']['sorted_results'].each do |item|
+                @config['outputs']['data_table'] << "| #{item[:name]} | #{item[:description]} |"
+            end
+        else
+            @config['outputs']['data_table'] << '> No data found'
+        end
+
+        if @config['resources']['sorted_results'].size.positive?
+            @config['resources']['data_table'] << '| Name |'
+            @config['resources']['data_table'] << '| ---- |'
+            @config['resources']['sorted_results'].each do |item|
+                @config['resources']['data_table'] << "| #{item[:name]} |"
+            end
+        else
+            @config['resources']['data_table'] << '> No data found'
+        end
+
+        if @config['variables']['sorted_results'].size.positive?
+            @config['variables']['data_table'] << '| Name | Description | Type | Default | Required? |'
+            @config['variables']['data_table'] << '| ---- | ----------- | ---- |:-------:|:---------:|'
+            @config['variables']['sorted_results'].each do |item|
+                @config['variables']['data_table'] << "| #{item[:name]} | #{item[:description]} | #{item[:type]} | #{item[:default]} | #{item[:required]} |"
+            end
+        else
+            @config['variables']['data_table'] << '> No data found'
+        end
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def clean_string(str)
+        return str if str.empty?
+
+        return str.strip.gsub(/\"/, '').chomp('.').strip
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def process_file(data)
+        @config.each do |key, value|
+            next unless data.include?(value['include'])
+
+            items = data.split(value['split'])
+            items.each do |item|
+                result = {}
+
+                item.strip!
+                next if item.match(value['match'])
+
+                matches = item.match(value['regex'])
+                next unless matches.size.positive?
+                next unless matches.names.include?('name')
+
+                result[:name] = matches[:name].gsub('_', '\_')
+
+                if matches.names.include?('details')
+                    if key == 'outputs'
+                        description = '-'
+
+                        parts = item.match(value['regex_stage_2'])
+                        description = clean_string(parts[:description]) if parts.size.positive?
+
+                        result[:description] = description
+                    else
+                        matches[:details].scan(value['regex_stage_2']).each do |key2, value2|
+                            result[key2.to_sym] = if key2 == 'default'
+                                                      value2
+                                                  else
+                                                      clean_string(value2)
+                                                  end
+                        end
+
+                        result[:required] = if result.key?(:default)
+                                                'No'
+                                            else
+                                                'Yes'
+                                            end
+                    end
+                end
+                value['raw_results'] << result
+            end
+        end
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def load_file(filename)
+        lines = []
+
+        begin
+            lines = File.readlines(filename).each(&:chomp!)
+        rescue SystemCallError
+            raise StandardError.new("Failed to open file #{filename} for reading")
+        end
+        return lines
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def generate_output(lines, start_tag, end_tag, data_table)
+        processed = []
+
+        skip_lines = false
+        lines.each do |line|
+            if line.casecmp?(end_tag) && skip_lines
+                processed << line
+                skip_lines = false
+                next
+            end
+
+            next if skip_lines
+
+            processed << line
+
+            next unless line.casecmp?(start_tag)
+
+            skip_lines = true
+            data_table.each do |row|
+                processed << row
+            end
+        end
+
+        return processed
+    end
+
+    # -------------------------------------------------------------------------------- #
+    # -------------------------------------------------------------------------------- #
+    def write_output
+        permissions = 0o0644
+
+        lines = load_file(@output_file)
+
+        lines = generate_output(lines, @config['data-sources']['start'], @config['data-sources']['end'], @config['data-sources']['data_table'])
+        lines = generate_output(lines, @config['modules']['start'], @config['modules']['end'], @config['modules']['data_table'])
+        lines = generate_output(lines, @config['outputs']['start'], @config['outputs']['end'], @config['outputs']['data_table'])
+        lines = generate_output(lines, @config['resources']['start'], @config['resources']['end'], @config['resources']['data_table'])
+        lines = generate_output(lines, @config['variables']['start'], @config['variables']['end'], @config['variables']['data_table'])
+
+        begin
+            File.open(@output_file, 'w') do |f|
+                lines.each do |line|
+                    f.puts line
+                end
+                f.chmod(permissions)
+            end
+        rescue SystemCallError
+            raise StandardError.new("Failed to open file #{filename} for writing")
+        end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'terradoc'
+
+RSpec.configure do |config|
+    # Enable flags like --only-failures and --next-failure
+    config.example_status_persistence_file_path = '.rspec_status'
+
+    # Disable RSpec exposing methods globally on `Module` and `main`
+    config.disable_monkey_patching!
+
+    config.expect_with :rspec do |c|
+        c.syntax = :expect
+    end
+end

data/spec/terradoc_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Terradoc do
+    it 'has a version number' do
+        expect(Terradoc::VERSION).not_to be nil
+    end
+end

data/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: true

data/terradoc.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'terradoc/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = 'terradoc'
+    spec.version       = Terradoc::VERSION
+    spec.authors       = ['Tim Gurney aka Wolf']
+    spec.email         = ['wolf@tgwolf.com']
+
+    spec.summary       = 'A simple tool for creating automatic documentaion from terraform source code.'
+    spec.description   = 'A simple tool for creating automatic documentaion from terraform source code.'
+    spec.homepage      = 'https://github.com/TerraformToolbox/terradoc'
+    spec.license       = 'MIT'
+
+    spec.files         = `git ls-files`.split($/)
+
+    spec.bindir        = 'exe'
+    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ['lib']
+
+    spec.required_ruby_version = '>= 2.5'
+
+    spec.add_development_dependency 'bundler', '~> 2'
+    spec.add_development_dependency 'rake', '~> 13.0'
+    spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'tty-spinner', '~> 0.9.0'
+
+    spec.add_runtime_dependency 'tty-spinner', '~> 0.9.0'
+end

data/testing/terradoc

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift('./lib')
+
+require 'bundler/setup'
+require 'optparse'
+require 'terradoc'
+
+# -------------------------------------------------------------------------------- #
+# Run Terradoc                                                                     #
+# -------------------------------------------------------------------------------- #
+# Pass the command line options to the class and run terradoc                      #
+# -------------------------------------------------------------------------------- #
+
+def run_terradoc(options)
+    begin
+        Terradoc.new(options)
+    rescue StandardError => e
+        puts "Error: #{e}"
+        puts e.backtrace if options[:verbose]
+        exit(1)
+    end
+end
+
+# -------------------------------------------------------------------------------- #
+# Process Arguments                                                                #
+# -------------------------------------------------------------------------------- #
+# This function will process the input from the command line and work out what it  #
+# is that the user wants to see.                                                   #
+#                                                                                  #
+# This is the main processing function where all the processing logic is handled.  #
+# -------------------------------------------------------------------------------- #
+
+def process_arguments
+    options = { :verbose => false }
+    # Enforce the presence of
+    mandatory = %I[]
+
+    optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$PROGRAM_NAME}"
+
+        opts.on('-h', '--help', 'Display this screen') do
+            puts opts
+            exit(1)
+        end
+        opts.on('-v', '--verbose', 'Turn on verbose mode') do
+            options[:verbose] = true
+        end
+
+        opts.on('-o', '--output string', 'Set the name of the output file. [default: README.md]') do |output|
+            options[:output] = output
+        end
+        opts.on('-p', '--path string', 'Set the path for where the terraform code is. [default: current directory]') do |path|
+            options[:path] = path
+        end
+    end
+
+    begin
+        optparse.parse!
+        missing = mandatory.select { |param| options[param].nil? }
+        raise OptionParser::MissingArgument.new(missing.join(', ')) unless missing.empty?
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        puts e.to_s
+        puts optparse
+        exit
+    end
+
+    exit 0 if run_terradoc(options)
+
+    exit 1
+end
+
+# -------------------------------------------------------------------------------- #
+# Main()                                                                           #
+# -------------------------------------------------------------------------------- #
+# The main function where all of the heavy lifting and script config is done.      #
+# -------------------------------------------------------------------------------- #
+
+def main
+    process_arguments
+end
+
+main
+
+# -------------------------------------------------------------------------------- #
+# End of Script                                                                    #
+# -------------------------------------------------------------------------------- #
+# This is the end - nothing more to see here.                                      #
+# -------------------------------------------------------------------------------- #

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: terradoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Gurney aka Wolf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A simple tool for creating automatic documentaion from terraform source
+  code.
+email:
+- wolf@tgwolf.com
+executables:
+- terradoc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CONTRIBUTING.md
+- EXAMPLE.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION.txt
+- bin/console
+- bin/setup
+- exe/terradoc
+- lib/terradoc.rb
+- lib/terradoc/version.rb
+- spec/spec_helper.rb
+- spec/terradoc_spec.rb
+- stale.yml
+- terradoc.gemspec
+- testing/terradoc
+homepage: https://github.com/TerraformToolbox/terradoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple tool for creating automatic documentaion from terraform source code.
+test_files: []