puppet-parse 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7
+env:
+  - PUPPET_VERSION=2.7.6
+  - PUPPET_VERSION=2.7.13
+  - PUPPET_VERSION=2.7.20
+  - PUPPET_VERSION=3.0.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Johan van den Dorpe
+
+MIT License
+
+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,42 @@
+# puppet-parse
+
+[![Build Status](https://travis-ci.org/johanek/puppet-parse.png)](http://travis-ci.org/johanek/puppet-parse)
+
+Analyse puppet manifests and report what classes and defines are specified, and their parameters and parameter documentation.
+
+## Installation
+
+    gem install puppet-parse
+
+## Requirements
+
+    puppet >2.7, <3.0
+    rdoc
+
+I think there's a bug in Puppet 3.0 which is breaking things. So don't use with Puppet 3.0 yet.
+
+## Usage
+
+### By hand
+
+You can test one or more manifests by running
+
+    puppet-parse <path(s) to file(s)>
+
+
+### Rake tast
+
+If you want to parse your entire modules directory, you can add
+`require 'puppet-parse/puppet-parse' to your Rakefile and then run
+
+    rake parse
+
+## 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,6 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default => :test
+
+RSpec::Core::RakeTask.new(:test)

data/bin/puppet-parse

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'puppet-parse'
+require 'yaml'
+
+run = PuppetParse::Runner.new
+puts run.run(ARGV).to_yaml
+

data/lib/puppet-parse/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-parse/parser.rb

@@ -0,0 +1,63 @@
+module PuppetParse
+  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 PuppetParse

data/lib/puppet-parse/puppet-parse.rb

@@ -0,0 +1,13 @@
+
+$LOAD_PATH.unshift File.expand_path('/vagrant/puppet-parser/lib')
+
+require 'puppet-parse'
+require 'rake'
+require 'rake/tasklib'
+
+desc 'Run puppet-parse'
+task :parse do
+  matched_files = FileList['**/*.pp']
+  run = PuppetParse::Runner.new
+  puts run.run(matched_files.to_a).to_yaml
+end

data/lib/puppet-parse/runner.rb

@@ -0,0 +1,26 @@
+module PuppetParse
+  class Runner
+  
+    def initialize
+    end
+  
+    def run(files)
+      output = {}
+      files.each do |file|
+        content          = PuppetParse::Parser.new(file)
+        next if content.instance_variable_get('@object').nil? 
+        parameters = (defined? content.parameters) ? content.parameters.paramflat : nil
+        result           = {
+          content.klass  => {
+            'parameters' => parameters,
+            'docs'       => content.docs
+          }
+        }
+        output = output.merge(result)
+      end
+      output
+    end
+    
+    
+  end #class Runner
+end #module PuppetParse

data/lib/puppet-parse/version.rb

@@ -0,0 +1,3 @@
+module PuppetParse
+    VERSION = "0.0.1"
+end

data/lib/puppet-parse.rb

@@ -0,0 +1,8 @@
+require 'puppet-parse/version'
+require 'puppet-parse/parser'
+require 'puppet-parse/runner'
+require 'puppet-parse/hash'
+require 'rubygems'
+require 'puppet'
+require 'rdoc'
+

data/puppet-parse.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/puppet-parse/version', __FILE__)
+
+if ENV.key?('PUPPET_VERSION')
+  puppetversion = "= #{ENV['PUPPET_VERSION']}"
+else
+  puppetversion = ['>= 2.7', '< 3.0']
+end
+
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Johan van den Dorpe"]
+  gem.email         = ["johan.vandendorpe@gmail.com"]
+  gem.description   = %q{Parse Puppet modules for classes, defines, parameters and documentation}
+  gem.summary       = %q{Parser for Puppet Modules. Returns Information about available classes and defines, their parameters, and documentation for those parameters.}
+  gem.homepage      = "https://github.com/johanek/puppet-parse"
+
+  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-parse"
+  gem.require_paths = ["lib"]
+  gem.version       = PuppetParse::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+  gem.add_runtime_dependency "rdoc"
+  gem.add_runtime_dependency "puppet", puppetversion
+
+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-parse
+#
+# == 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-parse
+#
+# == 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-parse
+#
+# == 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/puppet-parse_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+def setup(file)
+  run = PuppetParse::Runner.new
+  manifests = [ file ]
+  run.run(manifests)
+end
+
+shared_examples "standard tests" do |file, klass|
+
+  subject { setup(file) }
+
+  it 'should be a hash' do
+    subject.should be_a(Hash)
+  end
+
+  it 'class should have a name' do
+    subject.class.should_not be nil
+  end
+
+  it 'parameters and docs keys should be set' do
+    subject[klass].keys.should =~ ['parameters', 'docs']
+  end
+  
+  it 'parameters should be a hash' do
+    subject[klass]['parameters'].should be_a(Hash)
+  end
+
+  it 'docs should be a hash' do
+    subject[klass]['docs'].should be_a(Hash)
+  end
+
+  it 'values should not be nil' do
+    subject[klass].values.should_not include(nil)
+  end
+
+end
+
+shared_examples "parameters" do |file, klass|
+  subject { setup(file) }
+  it 'parameters should have four keys' do
+    subject[klass]['parameters'].should have(4).keys
+  end
+end
+
+shared_examples "no parameters" do |file, klass|
+  subject { setup(file) }
+  it 'parameters should have no keys' do
+    subject[klass]['parameters'].should have(0).keys
+  end
+end
+
+shared_examples "rdoc" do |file, klass|
+  subject { setup(file) }
+  it 'docs should have one key' do
+    subject[klass]['docs'].should have(1).keys
+  end
+end
+
+shared_examples "no rdoc" do |file, klass|
+  subject { setup(file) }
+  it 'docs should have no keys' do
+    subject[klass]['docs'].should have(0).keys
+  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    
+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        
+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    
+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        
+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    
+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    
+end
+
+describe "noclass" do
+  file = 'spec/manifests/noclass.pp'
+  subject { setup(file) }
+  
+  it 'should be a hash' do
+    subject.should be_a(Hash)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'rspec/autorun'
+require 'puppet-parse'

data/spec/tests

@@ -0,0 +1,13 @@
+classes should have a name
+parameters should be set
+every parameter should have a value
+docs should be set
+every doc key should have a value
+
+a sample file with parameters & rdoc should work
+a sample file with parameters & no rdoc should work
+a sample file with no parameters & rdoc should work
+a sample file with no parameters & no rdoc should work
+a sample file with no class should work
+a sample file with define and rdoc should work
+a sample file with define and no rdoc should work

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: puppet-parse
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Johan van den Dorpe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-22 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: puppet
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id004
+description: Parse Puppet modules for classes, defines, parameters and documentation
+email: 
+- johan.vandendorpe@gmail.com
+executables: 
+- puppet-parse
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/puppet-parse
+- lib/puppet-parse.rb
+- lib/puppet-parse/hash.rb
+- lib/puppet-parse/parser.rb
+- lib/puppet-parse/puppet-parse.rb
+- lib/puppet-parse/runner.rb
+- lib/puppet-parse/version.rb
+- puppet-parse.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/puppet-parse_spec.rb
+- spec/spec_helper.rb
+- spec/tests
+has_rdoc: true
+homepage: https://github.com/johanek/puppet-parse
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Parser for Puppet Modules. Returns Information about available classes and defines, their parameters, and documentation for those parameters.
+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/puppet-parse_spec.rb
+- spec/spec_helper.rb
+- spec/tests