puppet-doc-lint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3869048bc78f3c9a1f104bcaf28111130e6d0511
+  data.tar.gz: aef6d72342b140b4b1444e08a80fc123eaeb7cb6
+SHA512:
+  metadata.gz: 622affc112e5377071b2a8ec6a2455ecbfa8626e8e98846e1ca2f8fef425156da38a51571d1cecb6d913e4fc23c2614d2302da13c36060ad11f92fe39b20d25f
+  data.tar.gz: 866228c5ebe8d5bb982cba81e2487b142b473657331f976e46d22ecfc431a0476c3b94037a34fa755180e78c21562e3ce8f219803e2cfd131e8153e6efcb5f08

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+script: bundle exec rake
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.0.1
+
+Initial release
+- Very messy implementation for now
+- Outputs full list of parameters and highlights parameters that are undocumented.
+- Initial code for a results class for cleaner output and allows users more nuanced data, but not working properly yet!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puppet-doc-lint.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Peter Souter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# puppet-doc-lint
+
+Lint your Puppet files for RDoc coverage
+
+This project is heavily based on the puppet-parse code base, go check it out! :smile:
+
+## Installation
+
+    gem install puppet-doc-lint
+
+
+## Usage
+
+### By hand
+
+You can report on one or more manifests by running
+
+    puppet-doc-lint <path(s) to file(s)>
+
+For example:
+  
+```
+puppet-doc-lint ~/Projects/puppetlabs-firewall/manifests/linux/debian.pp
+class firewall::linux::debian Parameters are ["ensure", "enable"]
+class firewall::linux::debian Docs found are ["ensure", "enable"]
+```
+
+### Rake task
+
+If you want to parse your entire modules directory, you can add
+`require 'puppet-doc-lint/rake-task' to your Rakefile and then run
+
+    rake parse
+
+If you need to ignore certain paths from being parsed:
+
+``` ruby
+PuppetDocLint.configuration.ignore_paths = ["vendor/**/*.pp"]
+```
+
+## Contributing
+
+You can do any of these:
+
+1. Create new Pull Request
+2. Create an issue
+3. Write me an email
+4. Complain about how useless my code is on twitter
+

data/Rakefile

@@ -0,0 +1,13 @@
+#encoding: utf-8
+require 'rubygems'
+require 'bundler'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'puppet-doc-lint/rake_task'
+
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/puppet-doc-lint

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'puppet-doc-lint'
+
+abort 'puppet-doc-lint: no arguments given ' if ARGV[0].nil?
+
+runner = PuppetDocLint::Runner.new
+
+path = ARGV[0]
+if File.directory?(path)
+  puppet_files = Dir.glob("#{path}/**/*.pp")
+  puts "Puppet docs to be checked: #{puppet_files}"
+  results = runner.run(puppet_files)
+else
+  results = runner.run(ARGV)
+end
+
+results.each do |result| 
+  result.result_report
+end

data/lib/puppet-doc-lint.rb

@@ -0,0 +1,25 @@
+require 'puppet'
+require 'puppet-doc-lint/version'
+require 'puppet-doc-lint/parser'
+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/configuration'
+require 'rdoc'
+
+class PuppetDocLint
+  # Public: Access PuppetDocLint's configuration from outside the class.
+  #
+  # Returns a PuppetDocLint::Configuration object.
+  def self.configuration
+    @configuration ||= PuppetDocLint::Configuration.new
+  end
+
+  # Public: Access PuppetDocLint's configuration from inside the class.
+  #
+  # Returns a PuppetDocLint::Configuration object.
+  def configuration
+    self.class.configuration
+  end
+end

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

@@ -0,0 +1,170 @@
+class PuppetDocLint
+  class Configuration
+
+    # Code blatently stolen from https://github.com/rodjek/puppet-lint
+
+    # Internal: Add helper methods for a new check to the
+    # PuppetDocLint::Configuration object.
+    #
+    # check - The String name of the check.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <check>_enabled?
+    #   disable_<check>
+    #   enable_<check>
+    def self.add_check(check)
+      # Public: Determine if the named check is enabled.
+      #
+      # Returns true if the check is enabled, otherwise return false.
+      define_method("#{check}_enabled?") do
+        settings["#{check}_disabled"] == true ? false : true
+      end
+
+      # Public: Disable the named check.
+      #
+      # Returns nothing.
+      define_method("disable_#{check}") do
+        settings["#{check}_disabled"] = true
+      end
+
+      # Public: Enable the named check.
+      #
+      # Returns nothing.
+      define_method("enable_#{check}") do
+        settings["#{check}_disabled"] = false
+      end
+    end
+
+    # Public: Catch situations where options are being set for the first time
+    # and create the necessary methods to get & set the option in the future.
+    #
+    # args[0] - The value to set the option to.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>=(value)
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /^(\w+)=$/
+        option = $1
+        add_option(option.to_s) if settings[option].nil?
+        settings[option] = args[0]
+      else
+        nil
+      end
+    end
+
+    # Internal: Add options to the PuppetDocLint::Configuration object from inside
+    # the class.
+    #
+    # option - The String name of the option.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>
+    #   <option>=(value)
+    def add_option(option)
+      self.class.add_option(option)
+    end
+
+    # Public: Add an option to the PuppetDocLint::Configuration object from
+    # outside the class.
+    #
+    # option - The String name of the option.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>
+    #   <option>=(value)
+    def self.add_option(option)
+      # Public: Set the value of the named option.
+      #
+      # value - The value to set the option to.
+      #
+      # Returns nothing.
+      define_method("#{option}=") do |value|
+        settings[option] = value
+      end
+
+      # Public: Get the value of the named option.
+      #
+      # Returns the value of the option.
+      define_method(option) do
+        settings[option]
+      end
+    end
+
+    # Internal: Register a new check.
+    #
+    # check - The String name of the check
+    # b     - The Block containing the logic of the check
+    #
+    # Returns nothing.
+    def add_check(check, &b)
+      self.class.add_check(check)
+      check_method[check] = b
+    end
+
+    # Internal: Register a new check helper method.
+    #
+    # name - The String name of the method.
+    # b    - The Block containing the logic of the helper.
+    #
+    # Returns nothing.
+    def add_helper(name, &b)
+      helper_method[name] = b
+    end
+
+    # Internal: Access the internal storage for settings.
+    #
+    # Returns a Hash containing all the settings.
+    def settings
+      @settings ||= {}
+    end
+
+    # Internal: Access the internal storage for check method blocks.
+    #
+    # Returns a Hash containing all the check blocks.
+    def check_method
+      @check_method ||= {}
+    end
+
+    # Public: Get a list of all the defined checks.
+    #
+    # Returns an Array of String check names.
+    def checks
+      check_method.keys
+    end
+
+    # Internal: Access the internal storage for helper method blocks.
+    #
+    # Returns a Hash containing all the helper blocks.
+    def helper_method
+      @helper_method ||= {}
+    end
+
+    # Public: Get a list of all the helper methods.
+    #
+    # Returns an Array of String method names.
+    def helpers
+      helper_method.keys
+    end
+
+    # Public: Clear the PuppetDocLint::Configuration storage and set some sane
+    # default values.
+    #
+    # Returns nothing.
+    def defaults
+      settings.clear
+    end
+
+  end # class Configuration
+end # module PuppetDocLint

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

@@ -0,0 +1,34 @@
+class PuppetDocLint
+  class DocRunner
+    def initialize  
+    end
+  
+    def run(files)
+      runner_results = []
+      files.each do |file|
+        puppet_file_result = Result.new 
+        Puppet.initialize_settings unless Puppet.settings.app_defaults_initialized?
+        content          = PuppetDocLint::Parser.new(file)
+        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 == {}
+        result           = {
+          content.klass  => {
+            'parameters' => parameters,
+            'docs'       => content.docs
+          }
+        }
+        puppet_file_result.parameters = parameters.keys
+        undocumented = parameters.keys - content.docs.keys
+        puppet_file_result.undocumented_parameters = undocumented unless undocumented.empty?
+        documented = parameters.keys - undocumented
+        puppet_file_result.documented_parameters = documented unless undocumented.empty?
+        runner_results << puppet_file_result        
+      end
+      runner_results
+    end
+    
+    
+  end #class Runner
+end #module PuppetDocLint

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

@@ -0,0 +1,13 @@
+class Hash
+  
+  def paramflat
+    result = {}
+
+    self.each do |key, val|
+      result[key] = (defined? val.value) ? val.value : nil
+    end
+
+    result
+  end
+  
+end

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

@@ -0,0 +1,61 @@
+class PuppetDocLint
+  class Parser
+
+    def initialize(file)
+      # Read file and return parsed object
+      pparser         = Puppet::Parser::Parser.new('production')
+      if File.exists?(file)
+        @file = File.expand_path(file)
+        pparser.import(@file)
+
+        # Find object in list of hostclasses
+        pparser.environment.known_resource_types.hostclasses.each do |x|
+          @object = x.last if x.last.file == @file
+        end
+        # Find object in list of definitions
+        pparser.environment.known_resource_types.definitions.each do |x|
+          @object = x.last if x.last.file == @file
+        end
+
+      else
+        'File does not exist'
+      end
+    end
+
+    # Read parameters from parsed object, returns hash of parameters and default
+    # values
+    def parameters
+      result = (defined? @object.arguments) ? @object.arguments : {}
+      result
+    end
+
+    # Read class from parsed object, returns string containing class
+    def klass
+      @object.name if (defined? @object.class.name)
+    end
+
+    # Read RDOC contents from parsed object, returns hash of paragraph headings
+    # and the following paragraph contents
+    #(i.e. parameter and parameter documentation)
+    def docs
+      if !@object.doc.nil?
+        rdoc            = RDoc::Markup.parse(@object.doc)
+        docs            = {}
+
+        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_-', '')
+              docs[key] = item.parts.first.parts
+            end # do item
+          end # endif
+        end # do parm
+        docs
+      end # if nil?
+    end # def docs
+  end # class Parser
+end # module PuppetDocLint

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

@@ -0,0 +1,17 @@
+require 'puppet-doc-lint'
+require 'rake'
+require 'rake/tasklib'
+
+desc 'Run puppet-doc-lint'
+task :parse_doc do
+  matched_files = FileList['**/*.pp']
+
+  if ignore_paths = PuppetDocLint.configuration.ignore_paths
+    matched_files = matched_files.exclude(*ignore_paths)
+  end
+
+  runner = PuppetDocLint::Runner.new
+  results = runner.run(matched_files)
+
+  results.each {|result| result.result_report}
+end

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

@@ -0,0 +1,23 @@
+require 'virtus'
+
+class PuppetDocLint
+  class Result
+    include Virtus.model
+    attribute :class_name, String
+    attribute :file_name, String
+    attribute :parameters, String
+    attribute :no_documentation, Boolean, :default => false
+    attribute :documented_parameters,   String, :default => []
+    attribute :undocumented_parameters, String, :default => []
+
+    def result_report
+      puts "Class name was: #{class_name}"
+      puts "File name #{file_name}"
+      puts "Parameters found #{parameters}"
+      puts "No documentation error: #{no_documentation}"
+      puts "Documented parameters found: #{documented_parameters}"
+      puts "Undocumented parameters found: #{undocumented_parameters}\n\n"
+    end
+
+  end #class Result
+end #module PuppetDocLint

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

@@ -0,0 +1,34 @@
+class PuppetDocLint
+  class Runner  
+    def run(files)
+      runner_results = []
+      files.each do |file|
+        puppet_file_result = Result.new 
+        Puppet.initialize_settings unless Puppet.settings.app_defaults_initialized?
+        content          = PuppetDocLint::Parser.new(file)
+        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 == {}
+        result           = {
+          content.klass  => {
+            'parameters' => parameters,
+            'docs'       => content.docs
+          }
+        }
+        puppet_file_result.file_name = file
+        puppet_file_result.parameters = parameters.keys
+        
+        undocumented = parameters.keys - content.docs.keys
+        documented = parameters.keys - undocumented
+
+        puppet_file_result.documented_parameters = documented unless documented.empty?
+        puppet_file_result.undocumented_parameters = undocumented unless undocumented.empty?
+        
+        runner_results << puppet_file_result        
+      end
+      runner_results
+    end
+    
+  end #class DocRunner
+end #module PuppetDocLint

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

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

data/puppet-doc-lint.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/puppet-doc-lint/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Souter"]
+  gem.email         = ["p.morsou@gmail.com"]
+  gem.description   = %q{Doc Parser for Puppet Modules. Returns Information about documentation.}
+  gem.summary       = %q{Doc Parser for Puppet Modules. Returns Information about documentation.}
+  gem.homepage      = "https://github.com/petems/puppet-doc-lint"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "puppet-doc-lint"
+  gem.require_paths = ["lib"]
+  gem.version       = PuppetDocLint::PUPPETDOCLINT_VERSION
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  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 'virtus', '~> 1.0.1'
+
+
+end

data/spec/manifests/define_nordoc.pp

@@ -0,0 +1,8 @@
+define define_nordoc (
+  $param_one = true,
+  $param_two = '',
+  $param_three = $::fqdn,
+  $param_four
+) {
+  # no content
+}

data/spec/manifests/define_rdoc.pp

@@ -0,0 +1,20 @@
+# = Define: define_rdoc
+#
+# A define for testing puppet-doc-lint
+#
+# == Requirements
+#
+# None
+#
+# == Parameters
+#
+# [*param_one*]
+#    Param1 documentation text
+define define_rdoc (
+  $param_one = true,
+  $param_two = '',
+  $param_three = $::fqdn,
+  $param_four
+) {
+  # no content
+}

data/spec/manifests/noclass.pp

@@ -0,0 +1,4 @@
+        nrpe_command{'check_mysqldump':
+          command    => 'check_file_age',
+          parameters => '-f /srv/backup/mysql/mysql.dump -w 86400 -c 90000 -W 8000 -C 8000'
+        }

data/spec/manifests/noparameters_nordoc.pp

@@ -0,0 +1,3 @@
+class noparameters_nordoc {
+  # no content
+}

data/spec/manifests/noparameters_rdoc.pp

@@ -0,0 +1,15 @@
+# = Class: noparameters_rdoc
+#
+# A class for testing puppet-doc-lint
+#
+# == Requirements
+#
+# None
+#
+# == Parameters
+#
+# [*param_one*]
+#    Param1 documentation text
+class noparameters_rdoc {
+  # no content
+}

data/spec/manifests/parameters_nordoc.pp

@@ -0,0 +1,8 @@
+class parameters_nordoc (
+  $param_one = true,
+  $param_two = '',
+  $param_three = $::fqdn,
+  $param_four
+) {
+  # no content
+}

data/spec/manifests/parameters_rdoc.pp

@@ -0,0 +1,20 @@
+# = Class: parameters_rdoc
+#
+# A class for testing puppet-doc-lint
+#
+# == Requirements
+#
+# None
+#
+# == Parameters
+#
+# [*param_one*]
+#    Param1 documentation text
+class parameters_rdoc (
+  $param_one = true,
+  $param_two = '',
+  $param_three = $::fqdn,
+  $param_four
+) {
+  # no content
+}

data/spec/runner_acceptance_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe PuppetDocLint::DocRunner do  
+  shared_examples "standard tests" do | file, klass |
+    subject { setup(file) }
+
+    it "result should be an array of PuppetDocLint::Result for #{file}" do
+      subject.class.should be(Array)
+      subject.first.class.should be(PuppetDocLint::Result)
+    end
+
+    it "file name should be defined for #{file}" do
+      subject.first.file_name.should eql file
+    end
+
+    it "class should be define_rdoc for #{file}" do
+      subject.first.class_name.should eql klass
+    end
+
+  end
+
+  shared_examples "parameters" do |file, klass|
+    subject { setup(file) }
+    it "parameters should have 4 elements #{file}" do
+      subject.first.parameters.count.should eql 4
+    end
+  end
+
+  shared_examples "no parameters" do |file, klass|
+    subject { setup(file) }
+    it "parameters should have 0 elements #{file}" do
+      subject.first.parameters.count.should eql 0
+    end
+  end
+
+  shared_examples "rdoc" do |file, klass|
+    subject { setup(file) }
+    it "no_documentation should be false #{file}" do
+      subject.first.no_documentation.should be_false
+    end
+  end
+
+  shared_examples "no rdoc" do |file, klass|
+    subject { setup(file) }
+    it "no_documentation should be true #{file}" do
+      subject.first.class_name.should eql klass
+      subject.first.no_documentation.should be_true
+    end
+  end
+
+  shared_examples "nothing undocumented" do |file, klass|
+    subject { setup(file) }
+    it "no_documentation should be true #{file}" do
+      subject.first.class_name.should eql klass
+      subject.first.documented_parameters.should_not eql []
+    end
+  end
+
+  shared_examples "something undocumented" do |file, klass|
+    subject { setup(file) }
+    it "no_documentation should be true for #{file}" do
+      subject.first.class_name.should eql klass
+      subject.first.documented_parameters.should eql []
+    end
+  end
+
+  describe "run on an directory" do 
+    puppet_files = Dir.glob('spec/manifests/**/*.pp')
+    subject { setup_folder(puppet_files) }
+
+    it "should return a multi-element array" do
+      subject.class.should be(Array)
+      subject.size.should eql(6)
+    end
+
+  end
+
+  describe "manifest with parameters and rdoc" do
+    file = 'spec/manifests/parameters_rdoc.pp'
+    klass = 'parameters_rdoc'
+    it_should_behave_like "standard tests", file, klass
+    it_should_behave_like "parameters", file, klass
+    it_should_behave_like "rdoc", file, klass    
+    it_should_behave_like "nothing undocumented", file, klass 
+  end 
+
+  describe "manifest with parameters and no rdoc" do
+    file = 'spec/manifests/parameters_nordoc.pp'
+    klass = 'parameters_nordoc'
+    it_should_behave_like "standard tests", file, klass
+    it_should_behave_like "parameters", file, klass
+    it_should_behave_like "no rdoc", file, klass
+    it_should_behave_like "something undocumented", file, klass         
+  end 
+
+  describe "manifest with no parameters and rdoc" do
+    file = 'spec/manifests/noparameters_rdoc.pp'
+    klass = 'noparameters_rdoc'
+    it_should_behave_like "standard tests", file, klass
+    it_should_behave_like "no parameters", file, klass
+    it_should_behave_like "rdoc", file, klass    
+    it_should_behave_like "something undocumented", file, klass 
+  end 
+
+  describe "manifest with no parameters and no rdoc" do
+    file = 'spec/manifests/noparameters_nordoc.pp'
+    klass = 'noparameters_nordoc'
+    it_should_behave_like "standard tests", file, klass
+    it_should_behave_like "no parameters", file, klass
+    it_should_behave_like "no rdoc", file, klass      
+    it_should_behave_like "something undocumented", file, klass   
+  end 
+
+  describe "define with rdoc" do
+    file = 'spec/manifests/define_rdoc.pp'
+    klass = 'define_rdoc'
+    it_should_behave_like "standard tests", file, klass
+    it_should_behave_like "rdoc", file, klass    
+    it_should_behave_like "nothing undocumented", file, klass 
+  end
+
+  describe "define with no rdoc" do
+    file = 'spec/manifests/define_nordoc.pp'
+    klass = 'define_nordoc'
+    it_should_behave_like "standard tests", file, klass
+    it_should_behave_like "no rdoc", file, klass 
+    it_should_behave_like "something undocumented", file, klass    
+  end
+
+end
+

data/spec/runner_results_spec.rb

@@ -0,0 +1,37 @@
+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
+
+  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
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'puppet-doc-lint'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end
+
+def setup(file)
+  runner = PuppetDocLint::Runner.new
+  manifests = [ file ]
+  runner.run(manifests)
+end
+
+def setup_folder(files)
+  runner = PuppetDocLint::Runner.new
+  runner.run(files)
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: puppet-doc-lint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Souter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: facter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: Doc Parser for Puppet Modules. Returns Information about documentation.
+email:
+- p.morsou@gmail.com
+executables:
+- puppet-doc-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/puppet-doc-lint
+- lib/puppet-doc-lint.rb
+- lib/puppet-doc-lint/configuration.rb
+- lib/puppet-doc-lint/doc_runner.rb
+- lib/puppet-doc-lint/hash.rb
+- lib/puppet-doc-lint/parser.rb
+- lib/puppet-doc-lint/rake_task.rb
+- lib/puppet-doc-lint/result.rb
+- lib/puppet-doc-lint/runner.rb
+- lib/puppet-doc-lint/version.rb
+- puppet-doc-lint.gemspec
+- spec/manifests/define_nordoc.pp
+- spec/manifests/define_rdoc.pp
+- spec/manifests/noclass.pp
+- spec/manifests/noparameters_nordoc.pp
+- spec/manifests/noparameters_rdoc.pp
+- spec/manifests/parameters_nordoc.pp
+- spec/manifests/parameters_rdoc.pp
+- spec/runner_acceptance_spec.rb
+- spec/runner_results_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/petems/puppet-doc-lint
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+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/noclass.pp
+- spec/manifests/noparameters_nordoc.pp
+- spec/manifests/noparameters_rdoc.pp
+- spec/manifests/parameters_nordoc.pp
+- spec/manifests/parameters_rdoc.pp
+- spec/runner_acceptance_spec.rb
+- spec/runner_results_spec.rb
+- spec/spec_helper.rb