puppet-parse 0.0.5 → 0.0.6

data/README.md

@@ -10,24 +10,48 @@ Analyse puppet manifests and report what classes and defines are specified, and
 
 ## Requirements
 
-    rdoc
+    rdoc >=3.12, <4.0
     facter
 
 ## Usage
 
 ### By hand
 
-You can test one or more manifests by running
+You can report on one or more manifests by running
 
     puppet-parse <path(s) to file(s)>
 
-### Rake tast
+### Rake task
 
 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
 
+If you need to ignore certain paths from being parsed:
+
+``` ruby
+PuppetParse.configuration.ignore_paths = ["vendor/**/*.pp"]
+```
+
+## Sample Output
+
+    --- 
+      ntp: 
+        parameters: 
+          enabled: true
+          present: true
+          enableboot: true
+        docs: 
+          enabled: 
+            - "Set to 'false' to stop service"
+          present: 
+            - "Set to 'false' to remove package"
+          enableboot: 
+            - "Set to 'false' to prevent service starting at boot"
+
+
+
 ## Contributing
 
 You can do any of these:

data/lib/puppet-parse/configuration.rb

@@ -0,0 +1,170 @@
+class PuppetParse
+  class Configuration
+
+    # Code blatently stolen from https://github.com/rodjek/puppet-lint
+
+    # Internal: Add helper methods for a new check to the
+    # PuppetParse::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 PuppetParse::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 PuppetParse::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 PuppetParse::Configuration storage and set some sane
+    # default values.
+    #
+    # Returns nothing.
+    def defaults
+      settings.clear
+    end
+
+  end # class Configuration
+end # module PuppetParse

data/lib/puppet-parse/parser.rb

@@ -1,4 +1,4 @@
-module PuppetParse
+class PuppetParse
   class Parser
 
     def initialize(file)

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

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

data/lib/puppet-parse/runner.rb

@@ -1,4 +1,4 @@
-module PuppetParse
+class PuppetParse
   class Runner
   
     def initialize

data/lib/puppet-parse/version.rb

@@ -1,3 +1,3 @@
-module PuppetParse
-    VERSION = "0.0.5"
+class PuppetParse
+    VERSION = "0.0.6"
 end

data/lib/puppet-parse.rb

@@ -4,5 +4,21 @@ require 'puppet-parse/version'
 require 'puppet-parse/parser'
 require 'puppet-parse/runner'
 require 'puppet-parse/hash'
+require 'puppet-parse/configuration'
 require 'rdoc'
 
+class PuppetParse
+  # Public: Access PuppetParse's configuration from outside the class.
+  #
+  # Returns a PuppetParse::Configuration object.
+  def self.configuration
+    @configuration ||= PuppetParse::Configuration.new
+  end
+
+  # Public: Access PuppetParse's configuration from inside the class.
+  #
+  # Returns a PuppetParse::Configuration object.
+  def configuration
+    self.class.configuration
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-parse
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - bin/puppet-parse
 - lib/puppet-parse.rb
+- lib/puppet-parse/configuration.rb
 - lib/puppet-parse/hash.rb
 - lib/puppet-parse/parser.rb
 - lib/puppet-parse/puppet-parse.rb