puppet-doc-lint 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2da6511d00ad5fd50a6c05b16f4cb40409849e7e
-  data.tar.gz: cd83dc46eeed2e6c4141aed1571f48a10d4fdb68
+  metadata.gz: 70a3379e492215be1a969178afa712b05c11e543
+  data.tar.gz: 03e079e6f1062f0134c62a5c405f7d5122551dba
 SHA512:
-  metadata.gz: 32948a5194dc971aead38a6e27b72427762e75a55ddba7e44a6ddf099da2e81f2869682aff115ccf94765cdb8f75074b4d83a3f39edfc303622f45e1efb2daa9
-  data.tar.gz: 7822554728c74750e2b270d97b3fd0d52235f0661b92d9b155d201f98cc5d1a44e2629edb5b43289b8705d2a83601284486fd3be73eee9b907a4bf9b11277bc1
+  metadata.gz: 5afa27a3e693af0a682607a823ca02591ce05a9e5408d18c443dc932f1c748df31baa7200aca597d022909ec8fd894c886501e036617c41e62387932bb4a424e
+  data.tar.gz: ef1b370a69ed9abe5c4549c1b4937326830512e4ed7fa6fdfc4877df99631de70f7075933a73cfb681aebd8accc5b5e87fc441148dc4fc6656d6494d0c8b0726

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - ruby-head

data/bin/puppet-doc-lint

@@ -37,7 +37,7 @@ coverage = parameters_documented_total.percent_of(parameters_total) unless param
 puts "\n\n"
 puts "Number of files: #{tally}"
 puts "Total variables: #{parameters_total}"
-puts "Total missing variables: #{parameters_total}"
+puts "Total missing variables: #{parameters_undocumented_total}"
 puts "Documented variables: #{parameters_documented_total}"
 puts "Documentation coverage: #{coverage.round(2)}%"
 

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

@@ -3,7 +3,7 @@ class PuppetDocLint
 
     def initialize(file)
       # Read file and return parsed object
-      pparser         = Puppet::Parser::Parser.new('production')
+      pparser = Puppet::Parser::Parser.new(Puppet::Node::Environment.new('production'))
       if File.exists?(file)
         @file = File.expand_path(file)
         pparser.import(@file)
@@ -45,11 +45,8 @@ class PuppetDocLint
         rdoc.parts.each do |part|
           if part.respond_to?(:items)
             part.items.each do |item|
-              # Skip rdoc items that aren't paragraphs
-              next unless (item.parts.to_s.scan("RDoc::Markup::Paragraph") == ["RDoc::Markup::Paragraph"])
-              # Documentation must be a list - if there's no label then skip
               next if item.label.nil?
-              key       = item.label.tr('^A-Za-z0-9_-', '')
+              key       = item.label.to_s.tr('^A-Za-z0-9_-', '')
               docs[key] = item.parts.first.parts
             end # do item
           end # endif

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

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

data/puppet-doc-lint.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec', '~> 2.14.1'
   gem.add_development_dependency 'rake', '~> 10.1.1'
   gem.add_runtime_dependency 'rdoc', '>=3.12', '<4.0'
-  gem.add_runtime_dependency 'facter', '~> 1.6'
-  gem.add_runtime_dependency 'puppet', '~> 3.4.2'
+  gem.add_runtime_dependency 'facter'
+  gem.add_runtime_dependency 'puppet'
   gem.add_runtime_dependency 'virtus', '~> 1.0.1'
 
 

data/spec/manifests/nested_bullets.pp

@@ -0,0 +1,13 @@
+# == Class: foo
+#
+# === Parameters
+#
+# [*ensure*]
+#   String. Foo
+#   * Bar
+#   * Baz
+#     * Qux
+#
+class foo ($ensure = false){
+
+}

data/spec/manifests/parameters_rdoc.pp

@@ -10,6 +10,7 @@
 #
 # [*param_one*]
 #    Param1 documentation text
+#
 class parameters_rdoc (
   $param_one = true,
   $param_two = '',

data/spec/runner_acceptance_spec.rb

@@ -70,7 +70,7 @@ describe PuppetDocLint::DocRunner do
 
     it "should return a multi-element array" do
       subject.class.should be(Array)
-      subject.size.should eql(6)
+      subject.size.should eql(7)
     end
 
   end

data/spec/runner_results_spec.rb

@@ -1,36 +1,75 @@
 require 'spec_helper'
 
 describe PuppetDocLint::DocRunner do
-  file = 'spec/manifests/define_rdoc.pp'  
-  subject { setup(file) }
 
-  it 'result should be an array of PuppetDocLint::Result' do
-    subject.class.should be(Array)
-    subject[0].class.should be(PuppetDocLint::Result)
-  end
+  context 'define_rdoc' do  
 
-  it 'file name should be defined' do
-    subject[0].file_name.should eql 'spec/manifests/define_rdoc.pp'
-  end
-  
-  it 'class should be define_rdoc ' do
-    subject[0].class_name.should eql 'define_rdoc'
-  end
+    file = 'spec/manifests/define_rdoc.pp'  
+    subject { setup(file) }
 
-  it 'all parameters should be defined' do
-    subject[0].parameters.should eql ["param_one", "param_two", "param_three", "param_four"]
-  end
+    it 'result should be an array of PuppetDocLint::Result' do
+      subject.class.should be(Array)
+      subject[0].class.should be(PuppetDocLint::Result)
+    end
 
-  it 'no documentation is nil' do
-    subject[0].no_documentation.should be_false
-  end
+    it 'file name should be defined' do
+      subject[0].file_name.should eql 'spec/manifests/define_rdoc.pp'
+    end
+
+    it 'class should be define_rdoc ' do
+      subject[0].class_name.should eql 'define_rdoc'
+    end
+
+    it 'all parameters should be defined' do
+      subject[0].parameters.should eql ["param_one", "param_two", "param_three", "param_four"]
+    end
+
+    it 'no documentation is nil' do
+      subject[0].no_documentation.should be_false
+    end
+
+    it 'documented parameters' do
+      subject[0].documented_parameters.should eql ["param_one"]
+    end
+
+    it 'undocumented_parameters parameters' do
+      subject[0].undocumented_parameters.should eql ["param_two", "param_three", "param_four"]
+    end
 
-  it 'documented parameters' do
-    subject[0].documented_parameters.should eql ["param_one"]
   end
 
-  it 'undocumented_parameters parameters' do
-    subject[0].undocumented_parameters.should eql ["param_two", "param_three", "param_four"]
+  context 'define_rdoc' do
+    file = 'spec/manifests/nested_bullets.pp'  
+    subject { setup(file) }
+
+    it 'result should be an array of PuppetDocLint::Result' do
+      subject.class.should be(Array)
+      subject[0].class.should be(PuppetDocLint::Result)
+    end
+
+    it 'file name should be defined' do
+      subject[0].file_name.should eql "spec/manifests/nested_bullets.pp"
+    end
+
+    it 'class should be foo' do
+      subject[0].class_name.should eql 'foo'
+    end
+
+    it 'all parameters should be defined' do
+      subject[0].parameters.should eql ["ensure"]
+    end
+
+    it 'no documentation is nil' do
+      subject[0].no_documentation.should be_false
+    end
+
+    it 'documented parameters' do
+      subject[0].documented_parameters.should eql ["ensure"]
+    end
+
+    it 'undocumented_parameters parameters' do
+      subject[0].undocumented_parameters.should eql []
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-doc-lint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Souter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -62,30 +62,30 @@ dependencies:
   name: facter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - puppet-doc-lint.gemspec
 - spec/manifests/define_nordoc.pp
 - spec/manifests/define_rdoc.pp
+- spec/manifests/nested_bullets.pp
 - spec/manifests/noclass.pp
 - spec/manifests/noparameters_nordoc.pp
 - spec/manifests/noparameters_rdoc.pp
@@ -157,13 +158,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Doc Parser for Puppet Modules. Returns Information about documentation.
 test_files:
 - spec/manifests/define_nordoc.pp
 - spec/manifests/define_rdoc.pp
+- spec/manifests/nested_bullets.pp
 - spec/manifests/noclass.pp
 - spec/manifests/noparameters_nordoc.pp
 - spec/manifests/noparameters_rdoc.pp