puppet_readme_generator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e785cee37db01e0ea247e8fee2f9c3bd28918864
-  data.tar.gz: 925b80d0a901a692e194ba5c839c442269e250cf
+  metadata.gz: 11ba11909aa54848a0b43a9909400c631663993d
+  data.tar.gz: 92ed07c0a6134e264f188bae8d70d7dddc4ae517
 SHA512:
-  metadata.gz: 7e11e592e70ca62e79e7b7603eb7ed350ca734c2cd9e12a1c1fe7d834a2b97c4ea0fe32f61e7b66b9f2594fe90cf0eaf1d5b29ab6deb8b759a8a9e1c2d506de1
-  data.tar.gz: 67d437f96e5fbdc0cb7090c1642c7b65853eb0b9af0aad95558971a620a2129792c6e214f3c851be4739a7ac76668547ae599bf65fc3f95f53048d31223fd575
+  metadata.gz: 9a16d21bff53fa4a2e5af2840b817e254f1d0660d8e8b803278eb62bac34a5fa5a841e6870b5607b296de8d10782305e4b2d7aaca90c34a4720c9871a72e9efb
+  data.tar.gz: 53a750b20dfaf63ce7f3d47bacfbecb887252944f9e49a6c77fb90fee2d6721d3dde128c93d561ec5da4aeeb80bf6ddd61522e0a573d0a74620a47f719148c66

data/lib/puppet_readme_generator/version.rb

@@ -1,3 +1,3 @@
 module PuppetReadmeGenerator
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/puppet_readme_generator.rb

@@ -15,24 +15,44 @@ module PuppetReadmeGenerator
       output = []
       output << "# #{puppet_module}\n"
       output << "#### Table of Contents\n"
-      output << '1. [Description](#description)'
-      output << '2. [Classes](#classes)'
-      output << '3. [Defined Types](#defined-types)'
 
-      output << '## Description'
-      output << main_class.text
-      output << ''
+      count = 1
 
-      output << '## Classes'
-      classes.each do |c|
-        output << ''
-        output << c.markdown
+      unless main_class.nil?
+        output << "#{count}. [Description](#description)"
+        count += 1
+      end
+
+      if classes.length > 0
+        output << "#{count}. [Classes](#classes)"
+        count += 1
       end
 
-      output << '## DefinedTypes'
-      defined_types.each do |dt|
+      if defined_types.length > 0
+        output << "#{count}. [Defined Types](#defined-types)"
+        count += 1
+      end
+
+      unless main_class.nil?
+        output << '## Description'
+        output << main_class.text
         output << ''
-        output << dt.markdown
+      end
+
+      if classes.length > 0
+        output << '## Classes'
+        classes.each do |c|
+          output << ''
+          output << c.markdown
+        end
+      end
+
+      if defined_types.length > 0
+        output << '## DefinedTypes'
+        defined_types.each do |dt|
+          output << ''
+          output << dt.markdown
+        end
       end
 
       output.join("\n")
@@ -100,9 +120,12 @@ module PuppetReadmeGenerator
     def examples
       if @examples.nil?
         @examples = []
-        @c['docstring']['tags'].each do |t|
-          next unless t['tag_name'] == 'example'
-          @examples << Example.new(t, self)
+        begin
+          @c['docstring']['tags'].each do |t|
+            next unless t['tag_name'] == 'example'
+            @examples << Example.new(t, self)
+          end
+        rescue NoMethodError
         end
       end
       @examples
@@ -111,9 +134,12 @@ module PuppetReadmeGenerator
     def params
       if @params.nil?
         @params = []
-        @c['docstring']['tags'].each do |t|
-          next unless t['tag_name'] == 'param'
-          @params << Param.new(t, self)
+        begin
+          @c['docstring']['tags'].each do |t|
+            next unless t['tag_name'] == 'param'
+            @params << Param.new(t, self)
+          end
+        rescue NoMethodError
         end
       end
       @params
@@ -125,14 +151,18 @@ module PuppetReadmeGenerator
       output << text
       output << ''
 
-      output << "#### Parameters\n"
-      params.each do |p|
-        output << p.markdown
+      if params.length > 0
+        output << "#### Parameters\n"
+        params.each do |p|
+          output << p.markdown
+        end
       end
 
-      output << "#### Examples\n"
-      examples.each do |e|
-        output << e.markdown
+      if examples.length > 0
+        output << "#### Examples\n"
+        examples.each do |e|
+          output << e.markdown
+        end
       end
 
       output.join("\n")
@@ -158,8 +188,17 @@ module PuppetReadmeGenerator
     def markdown
       output = []
       output << "##### `#{@t['name']}`\n"
-      output << "* #{@t['text']}"
-      output << "* Type: `#{@t['types']}`"
+
+      if not @t['text'].nil? and @t['text'].length > 0
+        output << "* #{@t['text']}"
+      end
+
+      ptype = @t['types']
+      if not ptype.nil? and ptype.length > 1
+        output << "* Type: `#{ptype}`"
+      elsif not ptype.nil? and ptype.length == 1
+        output << "* Type: `#{ptype.first}`"
+      end
       default = @p.defaults[@t['name']]
       output << "* Default: `#{default}`" unless default.nil?
       output << ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_readme_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christian Simon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler