puppet-doc-lint 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3869048bc78f3c9a1f104bcaf28111130e6d0511
-  data.tar.gz: aef6d72342b140b4b1444e08a80fc123eaeb7cb6
+  metadata.gz: cfba85bcbbcadad148909ef3260b5b76d5b4854f
+  data.tar.gz: 32824c2b9f5e90e179a801abaaa66ef08db7889c
 SHA512:
-  metadata.gz: 622affc112e5377071b2a8ec6a2455ecbfa8626e8e98846e1ca2f8fef425156da38a51571d1cecb6d913e4fc23c2614d2302da13c36060ad11f92fe39b20d25f
-  data.tar.gz: 866228c5ebe8d5bb982cba81e2487b142b473657331f976e46d22ecfc431a0476c3b94037a34fa755180e78c21562e3ce8f219803e2cfd131e8153e6efcb5f08
+  metadata.gz: a9b268671e92354301d0cf53608980e51a9d50046107d41e5a4aa05121ffeadf254faf82ac5b825e685c88d390d5d0ec6f9e1ffc9cd587034a1c4f263a5c03dc
+  data.tar.gz: 2c289d5f34666d5aa7ee7a8b8206ef3ff906d99c7817d21a67c156962c22a14e835c6a4d836af1409ee6c758252aafbb09075ee78fe51186db8a8fcf2f09505b

data/README.md

@@ -1,4 +1,5 @@
 # puppet-doc-lint
+[![Build Status](https://travis-ci.org/petems/puppet-doc-lint.png?branch=master)](https://travis-ci.org/petems/puppet-doc-lint)
 
 Lint your Puppet files for RDoc coverage
 

data/bin/puppet-doc-lint

@@ -15,6 +15,33 @@ else
   results = runner.run(ARGV)
 end
 
+parameters_total = 0
+parameters_documented_total = 0
+parameters_undocumented_total = 0
+parameters_missing_total = 0
+tally = 0
+
 results.each do |result| 
+  tally = tally + 1
   result.result_report
+  parameters_undocumented_total = parameters_undocumented_total + result.undocumented_parameters.size
+  parameters_total = parameters_total + result.parameters.size
+  parameters_documented_total = parameters_documented_total + result.documented_parameters.size 
+  parameters_missing_total = parameters_missing_total + result.documented_parameter_no_assignment.size 
+end 
+
+coverage = 100
+
+coverage = parameters_documented_total.percent_of(parameters_total) unless parameters_total == 0
+
+puts "\n\n"
+puts "Number of files: #{tally}"
+puts "Total variables: #{parameters_total}"
+puts "Total missing variables: #{parameters_total}"
+puts "Documented variables: #{parameters_documented_total}"
+puts "Documentation coverage: #{coverage.round(2)}%"
+
+if (parameters_missing_total + parameters_undocumented_total) > 0
+  puts "Issues found!".bold.green.bg_red
+  exit 1
 end

data/lib/puppet-doc-lint.rb

@@ -5,6 +5,7 @@ require 'puppet-doc-lint/runner'
 require 'puppet-doc-lint/doc_runner'
 require 'puppet-doc-lint/result'
 require 'puppet-doc-lint/hash'
+require 'puppet-doc-lint/string'
 require 'puppet-doc-lint/configuration'
 require 'rdoc'
 

data/lib/puppet-doc-lint/parser.rb

@@ -57,5 +57,24 @@ class PuppetDocLint
         docs
       end # if nil?
     end # def docs
+
+    def authors
+      if !@object.doc.nil?
+        rdoc            = RDoc::Markup.parse(@object.doc)
+        authors         = []
+
+        author_docs = rdoc.parts.chunk{|i|i.class == RDoc::Markup::Heading && i.text == 'Authors'}.reject{|sep,ans| sep}.map{|sep,ans| ans}
+
+        author_docs.each do | doc_chunk |
+          unless doc_chunk[1].class == RDoc::Markup::BlankLine || doc_chunk[1].class == RDoc::Markup::Heading
+            doc_chunk[1].items.each do |chunk|
+              authors << chunk.parts.first.parts
+            end
+          end
+        end
+
+        authors
+      end # if nil?
+    end # def authors
   end # class Parser
 end # module PuppetDocLint

data/lib/puppet-doc-lint/result.rb

@@ -1,5 +1,11 @@
 require 'virtus'
 
+class Numeric
+  def percent_of(n)
+    self.to_f / n.to_f * 100.0
+  end
+end
+
 class PuppetDocLint
   class Result
     include Virtus.model
@@ -9,14 +15,32 @@ class PuppetDocLint
     attribute :no_documentation, Boolean, :default => false
     attribute :documented_parameters,   String, :default => []
     attribute :undocumented_parameters, String, :default => []
+    attribute :documented_parameter_no_assignment, String, :default => []
+    attribute :authors, String, :default => []
 
     def result_report
-      puts "Class name was: #{class_name}"
-      puts "File name #{file_name}"
+      puts "===================================="
+      puts "Class #{class_name} ( #{file_name} )".bg_blue
       puts "Parameters found #{parameters}"
-      puts "No documentation error: #{no_documentation}"
-      puts "Documented parameters found: #{documented_parameters}"
-      puts "Undocumented parameters found: #{undocumented_parameters}\n\n"
+      if no_documentation
+        puts "No documentation found."
+        puts "If there is documentation, this may be a bug with the Puppet parser"
+        puts "Puppet files with newer features such as the use of hashes can cause this\n\n"
+      else
+        puts "Documented parameters found: #{documented_parameters}".green
+        puts "Undocumented parameters found: #{undocumented_parameters}".red
+        puts "Parameters with Documentation but no defintion: #{documented_parameter_no_assignment}".red unless documented_parameter_no_assignment.empty?
+        puts "Documentation Coverage: #{percent_documented}%"
+        puts "Authors: #{authors}" unless authors.empty?
+      end
+    end
+
+    def percent_documented
+      if documented_parameters.size == 0
+        100
+      else
+        documented_parameters.size.percent_of(parameters.size).round(2)
+      end
     end
 
   end #class Result

data/lib/puppet-doc-lint/runner.rb

@@ -9,7 +9,7 @@ class PuppetDocLint
         next if content.instance_variable_get('@object').nil?
         parameters = (defined? content.parameters) ? content.parameters.paramflat : nil
         puppet_file_result.class_name = content.klass
-        puppet_file_result.no_documentation = true if content.docs == {}
+        puppet_file_result.no_documentation = true if content.docs == {} && content.authors == []
         result           = {
           content.klass  => {
             'parameters' => parameters,
@@ -21,9 +21,12 @@ class PuppetDocLint
         
         undocumented = parameters.keys - content.docs.keys
         documented = parameters.keys - undocumented
+        documented_parameter_no_assignment = content.docs.keys - parameters.keys
 
         puppet_file_result.documented_parameters = documented unless documented.empty?
         puppet_file_result.undocumented_parameters = undocumented unless undocumented.empty?
+        puppet_file_result.documented_parameter_no_assignment = documented_parameter_no_assignment unless documented_parameter_no_assignment.empty?
+        puppet_file_result.authors = content.authors
         
         runner_results << puppet_file_result        
       end

data/lib/puppet-doc-lint/string.rb

@@ -0,0 +1,20 @@
+class String
+  def black;          "\033[30m#{self}\033[0m" end
+  def red;            "\033[31m#{self}\033[0m" end
+  def green;          "\033[32m#{self}\033[0m" end
+  def brown;          "\033[33m#{self}\033[0m" end
+  def blue;           "\033[34m#{self}\033[0m" end
+  def magenta;        "\033[35m#{self}\033[0m" end
+  def cyan;           "\033[36m#{self}\033[0m" end
+  def gray;           "\033[37m#{self}\033[0m" end
+  def bg_black;       "\033[40m#{self}\0330m"  end
+  def bg_red;         "\033[41m#{self}\033[0m" end
+  def bg_green;       "\033[42m#{self}\033[0m" end
+  def bg_brown;       "\033[43m#{self}\033[0m" end
+  def bg_blue;        "\033[44m#{self}\033[0m" end
+  def bg_magenta;     "\033[45m#{self}\033[0m" end
+  def bg_cyan;        "\033[46m#{self}\033[0m" end
+  def bg_gray;        "\033[47m#{self}\033[0m" end
+  def bold;           "\033[1m#{self}\033[22m" end
+  def reverse_color;  "\033[7m#{self}\033[27m" end
+end

data/lib/puppet-doc-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetDocLint
-  PUPPETDOCLINT_VERSION = "0.0.1"
+  PUPPETDOCLINT_VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-doc-lint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Souter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -125,6 +125,7 @@ files:
 - lib/puppet-doc-lint/rake_task.rb
 - lib/puppet-doc-lint/result.rb
 - lib/puppet-doc-lint/runner.rb
+- lib/puppet-doc-lint/string.rb
 - lib/puppet-doc-lint/version.rb
 - puppet-doc-lint.gemspec
 - spec/manifests/define_nordoc.pp
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Doc Parser for Puppet Modules. Returns Information about documentation.