puppet-doc-lint 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70a3379e492215be1a969178afa712b05c11e543
-  data.tar.gz: 03e079e6f1062f0134c62a5c405f7d5122551dba
+  metadata.gz: 4b785db59bb3c0b5397307901564a9814841e9a2
+  data.tar.gz: 38b68375f3fad99363eca90ecc277c6d43762687
 SHA512:
-  metadata.gz: 5afa27a3e693af0a682607a823ca02591ce05a9e5408d18c443dc932f1c748df31baa7200aca597d022909ec8fd894c886501e036617c41e62387932bb4a424e
-  data.tar.gz: ef1b370a69ed9abe5c4549c1b4937326830512e4ed7fa6fdfc4877df99631de70f7075933a73cfb681aebd8accc5b5e87fc441148dc4fc6656d6494d0c8b0726
+  metadata.gz: d59d5332839324fdd0c3e31f467f6af4224eff248e761bd49c4ec31c52911de9c32035788930d6c4fb344dd5d7452e06010103b3f5ccc08b5dd3102a3d1c27f7
+  data.tar.gz: 36c7c59d91507a5f3c6144564d7d7beb90d509f6154a2b0fdf5a836f73fd1c9c107ea9e6f5f32272d228ad6d1b8f21eb3ce018ccbd1b43aab2085f056c241129

data/README.md

@@ -3,13 +3,48 @@
 
 Lint your Puppet files for RDoc coverage
 
-This project is heavily based on the puppet-parse code base, go check it out! :smile:
+This project is heavily based on the [puppet-parse](https://github.com/johanek/puppet-parse) code base, go check it out! :smile:
+
+## Assumptions
+
+This assumes that you're formatting your documentation in Puppet with [RDoc formatting](http://rdoc.sourceforge.net/doc/).
+
+For example _this_ will work:
+
+```Rdoc
+# == Class: foo
+#
+# This module manages foo
+#
+# === Parameters
+#
+# [*ensure*]
+#   Controls presence of package and stuff
+#
+# === Authors
+#
+# * Jane Doe <mailto:jane.doe@fakecorp.com>
+#
+```
+
+_This_ will not:
+
+```
+# Class: foo
+#
+# This module manages foo
+#
+# Parameters:
+# 	- $ensure
+#
+# Authors: Jane Doe <mailto:jane.doe@fakecorp.com>
+#
+```
 
 ## Installation
 
     gem install puppet-doc-lint
 
-
 ## Usage
 
 ### By hand
@@ -28,6 +63,8 @@ class firewall::linux::debian Docs found are ["ensure", "enable"]
 
 ### Rake task
 
+** Currrently broken maybe? **
+
 If you want to parse your entire modules directory, you can add
 `require 'puppet-doc-lint/rake-task' to your Rakefile and then run
 

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

@@ -45,7 +45,7 @@ class PuppetDocLint
         rdoc.parts.each do |part|
           if part.respond_to?(:items)
             part.items.each do |item|
-              next if item.label.nil?
+              next if item.label.nil? || item.parts.first.class == RDoc::Markup::BlankLine
               key       = item.label.to_s.tr('^A-Za-z0-9_-', '')
               docs[key] = item.parts.first.parts
             end # do item
@@ -63,7 +63,7 @@ class PuppetDocLint
         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
+          unless doc_chunk[1].class == RDoc::Markup::BlankLine || doc_chunk[1].class == RDoc::Markup::Heading || !doc_chunk[1].respond_to?(:items)
             doc_chunk[1].items.each do |chunk|
               authors << chunk.parts.first.parts
             end

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

@@ -23,9 +23,11 @@ class PuppetDocLint
       puts "Class #{class_name} ( #{file_name} )".bg_blue
       puts "Parameters found #{parameters}"
       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"
+        puts "No documentation found.".red
+        puts "Possible reasons:"
+        puts "* The documentation is not formatted in the RDoc format"
+        puts "* There's a bug in the puppet documentation parser"
+        puts "* There is no documentation at all"
       else
         puts "Documented parameters found: #{documented_parameters}".green
         puts "Undocumented parameters found: #{undocumented_parameters}".red

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

@@ -1,3 +1,3 @@
 class PuppetDocLint
-  PUPPETDOCLINT_VERSION = "0.2.0"
+  PUPPETDOCLINT_VERSION = "0.3.0"
 end

data/spec/manifests/bad_author_block.pp

@@ -0,0 +1,77 @@
+# This adds the necessary components to get backports for ubuntu and debian
+#
+# == Parameters
+#
+# [*release*]
+#   The ubuntu/debian release name. Defaults to $lsbdistcodename. Setting this
+#   manually can cause undefined behavior. (Read: universe exploding)
+#
+# [*pin_priority*]
+#   _default_: 200
+#
+#   The priority that should be awarded by default to all packages coming from
+#   the Debian Backports project.
+#
+# == Examples
+#
+#   include apt::backports
+#
+#   class { 'apt::backports':
+#     release => 'natty',
+#   }
+#
+# == Authors
+#
+# Ben Hughes, I think. At least blame him if this goes wrong.
+# I just added puppet doc.
+#
+# == Copyright
+#
+# Copyright 2011 Puppet Labs Inc, unless otherwise noted.
+class apt::backports(
+  $release      = $::lsbdistcodename,
+  $location     = $::apt::params::backports_location,
+  $pin_priority = 200,
+) inherits apt::params {
+
+  if ! is_integer($pin_priority) {
+    fail('$pin_priority must be an integer')
+  }
+
+  if $::lsbdistid == 'LinuxMint' {
+    if $::lsbdistcodename == 'debian' {
+      $distid = 'debian'
+      $release_real = 'wheezy'
+    } else {
+      $distid = 'ubuntu'
+      $release_real = $::lsbdistcodename ? {
+        'qiana'  => 'trusty',
+        'petra'  => 'saucy',
+        'olivia' => 'raring',
+        'nadia'  => 'quantal',
+        'maya'   => 'precise',
+      }
+    }
+  } else {
+    $distid = $::lsbdistid
+    $release_real = downcase($release)
+  }
+
+  $key = $distid ? {
+    'debian' => '46925553',
+    'ubuntu' => '437D05B5',
+  }
+  $repos = $distid ? {
+    'debian' => 'main contrib non-free',
+    'ubuntu' => 'main universe multiverse restricted',
+  }
+
+  apt::source { 'backports':
+    location   => $location,
+    release    => "${release_real}-backports",
+    repos      => $repos,
+    key        => $key,
+    key_server => 'pgp.mit.edu',
+    pin        => $pin_priority,
+  }
+}

data/spec/runner_acceptance_spec.rb

@@ -70,7 +70,8 @@ describe PuppetDocLint::DocRunner do
 
     it "should return a multi-element array" do
       subject.class.should be(Array)
-      subject.size.should eql(7)
+      # Count of how many test manifests we have
+      subject.size.should eql(8)
     end
 
   end
@@ -127,5 +128,11 @@ describe PuppetDocLint::DocRunner do
     it_should_behave_like "something undocumented", file, klass    
   end
 
+  describe "badly formatted author block" do
+    file = 'spec/manifests/bad_author_block.pp'
+    klass = 'apt::backports'
+    it_should_behave_like "standard tests", file, klass
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-doc-lint
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Souter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -128,6 +128,7 @@ files:
 - lib/puppet-doc-lint/string.rb
 - lib/puppet-doc-lint/version.rb
 - puppet-doc-lint.gemspec
+- spec/manifests/bad_author_block.pp
 - spec/manifests/define_nordoc.pp
 - spec/manifests/define_rdoc.pp
 - spec/manifests/nested_bullets.pp
@@ -163,6 +164,7 @@ signing_key:
 specification_version: 4
 summary: Doc Parser for Puppet Modules. Returns Information about documentation.
 test_files:
+- spec/manifests/bad_author_block.pp
 - spec/manifests/define_nordoc.pp
 - spec/manifests/define_rdoc.pp
 - spec/manifests/nested_bullets.pp