terradoc 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e125cf8c7b7500b455c6f52e2b1073f7f64a76cee715375831e965adc7d977c7
-  data.tar.gz: 914e0f417d6482bbe7528d59e8c5fe8ac1d0aab2ab5d11b2bf0b3d010ff2ef96
+  metadata.gz: c24356337689fb8ec399869c6770c8a0dbf782d84947b8de25fb05a870e1206c
+  data.tar.gz: 0affbe537539912932b1f61a69f2ad0d0a940b713c0728bead07322e27643e2c
 SHA512:
-  metadata.gz: 043b1390f79765f36d9fd3bd33b0d0d20918771055ba06065fc0db8e99eb8d2c28a3fb6d8fd63e81d21de5dbaeabfe87014d90e09b1f9f5a6be1fecf3002963d
-  data.tar.gz: 65ed88938ebc9622254da92d186b62cd8d6c93de633e0a04e65597d68589bd9bb76a0109e7f6d86efad31e1c8e3c0aaab9d6418c59749006e232a94e01df2bf1
+  metadata.gz: 707b4abfb5be29470ff58826e7558ed6eaa1cf518ee0d74bca295f6464051eecd9ace870d5025e1fea0793751fb92cbb6a93d10a64227a85dd94cd300b4a2f55
+  data.tar.gz: 3bcc43d029fc7d9428962805a036a37ea292baceee9c6d3f459a2b337951b57087fa3060750bdbd06d0ea53612ab0dd61e22317f39e4dfcb077b1ff84448078a

data/CHANGELOG.md

@@ -5,11 +5,17 @@ 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.9](https://github.com/TerraformToolbox/terradoc/compare/v0.1.8...v0.1.9)
+
+> Released on March, 18th 2020
+
+- Array merging was not working as expected, so switch to processing file by file, and added a --console only option [`[b4bea10]`](https://github.com/TerraformToolbox/terradoc/commit/b4bea1074efc494614f0b591b545d0d824f4125a) [`[TGWolf]`](https://github.com/TGWolf)
+
 ### [v0.1.8](https://github.com/TerraformToolbox/terradoc/compare/v0.1.7...v0.1.8)
 
 > Released on March, 18th 2020
 
-- Passing wrong data-table when generating output [`[1aeff45]`](https://github.com/TerraformToolbox/terradoc/commit/1aeff4504947e7fd26b0d20a6826dfdbe774600a) [`[TGWolf]`](https://github.com/TGWolf)
+- Passing wrong data-table when generating output [`[0d2dbeb]`](https://github.com/TerraformToolbox/terradoc/commit/0d2dbeb8eccd00ab3c211b01531551b1c880ca13) [`[TGWolf]`](https://github.com/TGWolf)
 
 ### [v0.1.7](https://github.com/TerraformToolbox/terradoc/compare/v0.1.6...v0.1.7)
 

data/VERSION.txt

@@ -1 +1 @@
-0.1.8
+0.1.9

data/exe/terradoc

@@ -45,6 +45,9 @@ def process_arguments
         opts.on('-v', '--verbose', 'Turn on verbose mode') do
             options[:verbose] = true
         end
+        opts.on('-c', '--console', 'Turn on console output only (doesnt update file)') do
+            options[:console] = true
+        end
 
         opts.on('-o', '--output string', 'Set the name of the output file. [default: README.md]') do |output|
             options[:output] = output

data/lib/terradoc.rb

@@ -15,6 +15,9 @@ class Terradoc
 
         raise StandardError.new("Failed to locate #{@command} please install (pip install #{@command})") unless which @command
 
+        @console_only = false
+        @console_only = options[:console] unless options[:console].nil?
+
         @base_path = '.'
         @base_path = options[:path] unless options[:path].nil?
         @base_path.chomp!('/')
@@ -23,7 +26,6 @@ class Terradoc
         @output_file = 'README.md'
         @output_file = options[:output] unless options[:output].nil?
 
-        @raw_results = {}
         @files   = []
         @pattern = "#{@base_path}/*.tf"
 
@@ -31,44 +33,44 @@ class Terradoc
                     'data-sources' => {
                                         'start'          => '<!--Terradoc-data-sources-start-->',
                                         'end'            => '<!--Terradoc-data-sources-end-->',
-                                        'raw_results'    => [],
-                                        'sorted_results' => [],
-                                        'data_table'     => []
+                                        'raw-results'    => [],
+                                        'sorted-results' => [],
+                                        'data-table'     => []
                                       },
                     'modules'      => {
                                         'start'          => '<!--Terradoc-modules-start-->',
                                         'end'            => '<!--Terradoc-modules-end-->',
-                                        'raw_results'    => [],
-                                        'sorted_results' => [],
-                                        'data_table'     => []
+                                        'raw-results'    => [],
+                                        'sorted-results' => [],
+                                        'data-table'     => []
                                       },
                     'outputs'      => {
                                         'start'          => '<!--Terradoc-outputs-start-->',
                                         'end'            => '<!--Terradoc-outputs-end-->',
-                                        'raw_results'    => [],
-                                        'sorted_results' => [],
-                                        'data_table'     => []
+                                        'raw-results'    => [],
+                                        'sorted-results' => [],
+                                        'data-table'     => []
                                       },
                     'providers'    => {
                                         'start'          => '<!--Terradoc-providers-start-->',
                                         'end'            => '<!--Terradoc-providers-end-->',
-                                        'raw_results'    => [],
-                                        'sorted_results' => [],
-                                        'data_table'     => []
+                                        'raw-results'    => [],
+                                        'sorted-results' => [],
+                                        'data-table'     => []
                                       },
                     'resources'    => {
                                         'start'          => '<!--Terradoc-resources-start-->',
                                         'end'            => '<!--Terradoc-resources-end-->',
-                                        'raw_results'    => [],
-                                        'sorted_results' => [],
-                                        'data_table'     => []
+                                        'raw-results'    => [],
+                                        'sorted-results' => [],
+                                        'data-table'     => []
                                       },
                     'variables'    => {
                                         'start'          => '<!--Terradoc-variables-start-->',
                                         'end'            => '<!--Terradoc-variables-end-->',
-                                        'raw_results'    => [],
-                                        'sorted_results' => [],
-                                        'data_table'     => []
+                                        'raw-results'    => [],
+                                        'sorted-results' => [],
+                                        'data-table'     => []
                                       }
                   }
 
@@ -91,39 +93,36 @@ class Terradoc
     # -------------------------------------------------------------------------------- #
     # -------------------------------------------------------------------------------- #
     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] Processing raw results'
-        sp4 = spinners.register '[:spinner] Sorting the results'
-        sp5 = spinners.register '[:spinner] Generating data tables'
-        sp6 = spinners.register '[:spinner] Writing output'
-
-        sp1.auto_spin
-        sp2.auto_spin
-        sp3.auto_spin
-        sp4.auto_spin
-        sp5.auto_spin
-        sp6.auto_spin
+        unless @console_only
+            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
+        end
 
         generate_file_list
-        sp1.success
+        sp1.success unless @console_only
 
         process_files
-        sp2.success
-
-        process_raw_results
-        sp3.success
+        sp2.success unless @console_only
 
         sort_details
-        sp4.success
+        sp3.success unless @console_only
 
         generate_data_tables
-        sp5.success
+        sp4.success unless @console_only
 
         write_output
-        sp6.success
+        sp5.success unless @console_only
     end
 
     # -------------------------------------------------------------------------------- #
@@ -142,51 +141,52 @@ class Terradoc
                 stdout_str = stdout.read
 
                 json = JSON.parse(stdout_str, max_nesting: 256)
-                @raw_results = @raw_results.merge(json)
+
+                process_raw_results(json)
             end
         end
     end
 
     # -------------------------------------------------------------------------------- #
     # -------------------------------------------------------------------------------- #
-    def process_raw_results
-        unless @raw_results['data'].nil?
-            @raw_results['data'].each do |key, _value|
+    def process_raw_results(json)
+        unless json['data'].nil?
+            json['data'].each do |key, _value|
                 name = key.gsub('_', '\_')
-                @config['data-sources']['raw_results'] << { :name => name }
+                @config['data-sources']['raw-results'] << { :name => name }
             end
         end
 
-        unless @raw_results['module'].nil?
-            @raw_results['module'].each do |key, value|
+        unless json['module'].nil?
+            json['module'].each do |key, value|
                 name = key.gsub('_', '\_')
-                @config['modules']['raw_results'] << { :name => name, :source => value['source'], :version => value['version'] }
+                @config['modules']['raw-results'] << { :name => name, :source => value['source'], :version => value['version'] }
             end
         end
 
-        unless @raw_results['output'].nil?
-            @raw_results['output'].each do |key, value|
+        unless json['output'].nil?
+            json['output'].each do |key, value|
                 name = key.gsub('_', '\_')
-                @config['outputs']['raw_results'] << { :name => name, :description => value['description'] }
+                @config['outputs']['raw-results'] << { :name => name, :description => value['description'] }
             end
         end
 
-        unless @raw_results['provider'].nil?
-            @raw_results['provider'].each do |key, _value|
+        unless json['provider'].nil?
+            json['provider'].each do |key, _value|
                 name = key.gsub('_', '\_')
-                @config['providers']['raw_results'] << { :name => name }
+                @config['providers']['raw-results'] << { :name => name }
             end
         end
 
-        unless @raw_results['resource'].nil?
-            @raw_results['resource'].each do |key, _value|
+        unless json['resource'].nil?
+            json['resource'].each do |key, _value|
                 name = key.gsub('_', '\_')
-                @config['resources']['raw_results'] << { :name => name }
+                @config['resources']['raw-results'] << { :name => name }
             end
         end
 
-        unless @raw_results['variable'].nil?
-            @raw_results['variable'].each do |key, value|
+        unless json['variable'].nil?
+            json['variable'].each do |key, value|
                 name = key.gsub('_', '\_')
                 default = value['default'].to_s.gsub('_', '\_')
                 required = if default.empty?
@@ -194,7 +194,7 @@ class Terradoc
                            else
                                'No'
                            end
-                @config['variables']['raw_results'] << { :name => name, :description => value['description'], :type => value['type'], :default => default, :required => required }
+                @config['variables']['raw-results'] << { :name => name, :description => value['description'], :type => value['type'], :default => default, :required => required }
             end
         end
     end
@@ -210,75 +210,75 @@ class Terradoc
     # -------------------------------------------------------------------------------- #
     # -------------------------------------------------------------------------------- #
     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['providers']['sorted_results'] = cleanup_array(@config['providers']['raw_results'])
-        @config['resources']['sorted_results'] = cleanup_array(@config['resources']['raw_results'])
-        @config['variables']['sorted_results'] = cleanup_array(@config['variables']['raw_results'])
+        @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['providers']['sorted-results'] = cleanup_array(@config['providers']['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]} |"
+        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 sources found'
+            @config['data-sources']['data-table'] << '> No data sources 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]} |"
+        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 modules found'
+            @config['modules']['data-table'] << '> No modules 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]} |"
+        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 outputs found'
+            @config['outputs']['data-table'] << '> No outputs found'
         end
 
-        if @config['providers']['sorted_results'].size.positive?
-            @config['providers']['data_table'] << '| Name |'
-            @config['providers']['data_table'] << '| ---- |'
-            @config['providers']['sorted_results'].each do |item|
-                @config['providers']['data_table'] << "| #{item[:name]} |"
+        if @config['providers']['sorted-results'].size.positive?
+            @config['providers']['data-table'] << '| Name |'
+            @config['providers']['data-table'] << '| ---- |'
+            @config['providers']['sorted-results'].each do |item|
+                @config['providers']['data-table'] << "| #{item[:name]} |"
             end
         else
-            @config['providers']['data_table'] << '> No providers found'
+            @config['providers']['data-table'] << '> No providers 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]} |"
+        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 resources found'
+            @config['resources']['data-table'] << '> No resources 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]} |"
+        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 variables found'
+            @config['variables']['data-table'] << '> No variables found'
         end
     end
 
@@ -330,22 +330,26 @@ class Terradoc
 
         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['providers']['start'], @config['providers']['end'], @config['providers']['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'])
+        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['providers']['start'], @config['providers']['end'], @config['providers']['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
+        if @console_only
+            puts lines
+        else
+            begin
+                File.open(@output_file, 'w') do |f|
+                    lines.each do |line|
+                        f.puts line
+                    end
+                    f.chmod(permissions)
                 end
-                f.chmod(permissions)
+            rescue SystemCallError
+                raise StandardError.new("Failed to open file #{filename} for writing")
             end
-        rescue SystemCallError
-            raise StandardError.new("Failed to open file #{filename} for writing")
         end
     end
 end

data/lib/terradoc/version.rb

@@ -1,3 +1,3 @@
 class Terradoc
-    VERSION = '0.1.8'.freeze
+    VERSION = '0.1.9'.freeze
 end

data/testing/terradoc

@@ -47,6 +47,10 @@ def process_arguments
             options[:verbose] = true
         end
 
+        opts.on('-c', '--console', 'Turn on console output only (doesnt update file)') do
+            options[:console] = true
+        end
+
         opts.on('-o', '--output string', 'Set the name of the output file. [default: README.md]') do |output|
             options[:output] = output
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terradoc
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
@@ -102,7 +102,6 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- TEST
 - VERSION.txt
 - bin/console
 - bin/setup

data/TEST

@@ -1,87 +0,0 @@
-# Some example README
-
-## Data Sources
-<!--Terradoc-data-sources-start-->
-> No data found
-<!--Terradoc-data-sources-end-->
-
-## Modules
-<!--Terradoc-modules-start-->
-> No data found
-<!--Terradoc-modules-end-->
-
-## Outputs
-<!--Terradoc-outputs-start-->
-| Name | Description |
-| ---- | ----------- |
-| automated\_testing\_account\_alias | The account alias for the automated testing account |
-| automated\_testing\_account\_email | The account email for the automated testing account |
-| automated\_testing\_account\_id | The account id for the automated testing account |
-| automated\_testing\_account\_name | The account name for the automated testing account |
-| development\_account\_alias | The account alias for the development account |
-| development\_account\_email | The account email for the development account |
-| development\_account\_id | The account id for the development account |
-| development\_account\_name | The account name for the development account |
-| development\_collector\_account\_alias | The account alias for the development collect account |
-| development\_collector\_account\_email | The account email for the development collect account |
-| development\_collector\_account\_id | The account id for the development collect account |
-| development\_collector\_account\_name | The account name for the development collect account |
-| infradev\_account\_alias | The account alias for the infradev account |
-| infradev\_account\_email | The account email for the infradev account |
-| infradev\_account\_id | The account id for the infradev account |
-| infradev\_account\_name | The account name for the infradev account |
-| logging\_account\_alias | The account alias for the logging account |
-| logging\_account\_email | The account email for the logging account |
-| logging\_account\_id | The account id for the logging account |
-| logging\_account\_name | The account id for the logging account |
-| messaging\_account\_alias | The account alias for the messaging account |
-| messaging\_account\_email | The account email for the messaging account |
-| messaging\_account\_id | The account id for the messaging account |
-| messaging\_account\_name | The account name for the messaging account |
-| organisation\_account\_alias | The account alias for the organisation account |
-| organisation\_account\_email | The account email for the organisation account |
-| organisation\_account\_id | The account id for the organisation account |
-| organisation\_account\_name | The account name for the organisation account |
-| production\_account\_alias | The account alias for the production account |
-| production\_account\_email | The account email for the production account |
-| production\_account\_id | The account id for the production account |
-| production\_account\_name | The account name for the production account |
-| production\_collector\_account\_alias | The account alias for the production collector account |
-| production\_collector\_account\_email | The account email for the production collector account |
-| production\_collector\_account\_id | The account id for the production collector account |
-| production\_collector\_account\_name | The account name for the production collector account |
-| reporting\_account\_alias | The account alias for the reporting account |
-| reporting\_account\_email | The account email for the reporting account |
-| reporting\_account\_id | The account id for the reporting account |
-| reporting\_account\_name | The account name for the reporting account |
-| testing\_account\_alias | The account alias for the testing account |
-| testing\_account\_email | The account email for the testing account |
-| testing\_account\_id | The account id for the testing account |
-| testing\_account\_name | The account name for the testing account |
-| testing\_collector\_account\_alias | The account alias for the testing collector account |
-| testing\_collector\_account\_email | The account email for the testing collector account |
-| testing\_collector\_account\_id | The account id for the testing collector account |
-| testing\_collector\_account\_name | The account name for the testing collector account |
-| tooling\_account\_alias | The account alias for the tooling account |
-| tooling\_account\_email | The account email for the tooling account |
-| tooling\_account\_id | The account id for the tooling account |
-| tooling\_account\_name | The account name for the tooling account |
-<!--Terradoc-outputs-end-->
-
-## Providers
-<!--Terradoc-providers-start-->
-<!--Terradoc-providers-end-->
-
-## Resources
-<!--Terradoc-resources-start-->
-> No data found
-<!--Terradoc-resources-end-->
-
-## Variables
-<!--Terradoc-variables-start-->
-| Name | Description | Type | Default | Required? |
-| ---- | ----------- |:----:|:-------:|:---------:|
-| account\_emails | A list of account email addresses | list(string) |  | Yes |
-| account\_ids | A list of account id | list(string) |  | Yes |
-| account\_names | A list of account names | list(string) |  | Yes |
-<!--Terradoc-variables-end-->