puppet-cleaner 0.1.0

data/COPYRIGHT

@@ -0,0 +1,26 @@
+Copyright (c) 2013, Gerardo Santana Gomez Garrido <gerardo.santana@gmail.com>
+ All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 
+ 1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+ 3. The name of the author may not be used to endorse or promote products
+    derived from this software without specific prior written permission.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.

data/Changelog

@@ -0,0 +1,8 @@
+0.1.0 2013-04-16
+-----------------
+Features:
+  * run puppet-clean -h to see the list of available formatters
+
+Caveats:
+  * comments are assumed to occur alone in a line
+  * monkey patches puppet 2.7.11; it hasn't been tested on any other version

data/README.md

@@ -0,0 +1,40 @@
+Puppet Cleaner
+==============
+
+Puppet DSL source code cleaner and helper utilities
+
+Motivation
+----------
+http://santanatechnotes.blogspot.mx/2013/04/puppet-cleaner-010-released.html
+
+Requirements
+------------
+
+  * puppet
+
+it has been tested with puppet 2.7.11 only
+
+Utilities
+------------
+
+### puppet-clean
+
+Receives a puppet manifest file as input and outputs the result of
+applying a set of transformation rules that makes it comply with
+a subset of the current puppet style guide.
+
+### puppet-diff
+
+Receives two puppet manifest files and outputs its difference, after
+converting them to YAML. Useful for verifying what (if anything) has
+changed after applying puppet-clean.
+
+### puppet-inspect
+
+Receives a puppet manifest file and converts its objects (defined types,
+classes and nodes) to YAML.
+
+Help & Feedback
+------------
+
+Mail me directly if you need help or have any feedback about it.

data/bin/puppet-clean

@@ -0,0 +1,101 @@
+#!/usr/bin/ruby
+
+require 'getoptlong'
+require 'puppet-cleaner'
+
+def usage
+  warn <<-EOS
+Usage:
+
+    #{File.basename($0)} [-h] [-t n] [-abedlmovw ] file.pp [file2.pp...]
+
+Options:
+    -h, --help              this help message
+    -d, --debug             prints tokens before and after the transformation
+
+    -a, --alignfarrow       aligns fat arrow (=>)
+    -b, --quotedbooleans    removes unneeded quotes around boolean literals
+    -e, --ensurefirst       moves 'ensure' parameter to the top
+    -l, --link              uses ensure => link and target for symbolic links
+    -m, --mlcomments        converts /* */ style comments into #
+    -o, --octalmode         uses a 4 digit string for file modes
+    -t n, --softtabs n      indents by n spaces
+    -v, --quotedvariables   removes unneeded quotes around variables
+    -w, --trailingws        removes trailing white space
+  EOS
+  exit 1
+end
+
+opts = GetoptLong.new(
+  [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+  [ '--debug', '-d', GetoptLong::NO_ARGUMENT ],
+
+  [ '--alignfarrow', '-a', GetoptLong::NO_ARGUMENT ],
+  [ '--quotedbooleans', '-b', GetoptLong::NO_ARGUMENT ],
+  [ '--ensurefirst', '-e', GetoptLong::NO_ARGUMENT ],
+  [ '--link', '-l', GetoptLong::NO_ARGUMENT ],
+  [ '--mlcomments', '-m', GetoptLong::NO_ARGUMENT ],
+  [ '--octalmode', '-o', GetoptLong::NO_ARGUMENT ],
+  [ '--softtabs', '-t', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--quotedvariables', '-v', GetoptLong::NO_ARGUMENT ],
+  [ '--trailingws', '-w', GetoptLong::NO_ARGUMENT ]
+)
+
+debug = false
+workers = []
+
+opts.each do |opt, arg|
+  case opt
+  when '--help'
+    usage
+  when '--debug'
+    debug = true
+  when '--alignfarrow'
+    workers << Puppet::Cleaner::AlignFarrow.new
+  when '--quotedbooleans'
+    workers << Puppet::Cleaner::QuotedBooleans.new
+  when '--ensurefirst'
+    workers << Puppet::Cleaner::EnsureFirst.new
+  when '--link'
+    workers << Puppet::Cleaner::Symlink.new
+  when '--mlcomments'
+    workers << Puppet::Cleaner::MultilineComments.new
+  when '--octalmode'
+    workers << Puppet::Cleaner::OctalMode.new
+  when '--softtabs'
+    tabstop = arg.to_i <= 2 ? 2 : arg.to_i
+    workers << Puppet::Cleaner::SoftTabs.new(tabstop)
+  when '--quotedvariables'
+    workers << Puppet::Cleaner::UnneededQuotes.new
+  when '--trailingws'
+    workers << Puppet::Cleaner::TrailingWhitespace.new
+    workers << Puppet::Cleaner::TrailingWhitespaceInComments.new
+  end
+end
+
+usage if ARGV.size < 1
+
+ALL = [
+  Puppet::Cleaner::MultilineComments.new,
+  Puppet::Cleaner::SoftTabs.new,
+  Puppet::Cleaner::UnneededQuotes.new,
+  Puppet::Cleaner::TrailingWhitespace.new,
+  Puppet::Cleaner::TrailingWhitespaceInComments.new,
+  Puppet::Cleaner::AlignFarrow.new,
+  Puppet::Cleaner::OctalMode.new,
+  Puppet::Cleaner::EnsureFirst.new,
+  Puppet::Cleaner::QuotedBooleans.new,
+  Puppet::Cleaner::Symlink.new
+]
+
+
+workers = ALL if workers.empty?
+
+ARGV.each do |filename|
+  line = Puppet::Cleaner.open(filename)
+  line.hire(workers)
+  puts line.inspect if debug
+  line.transform!
+  line.show
+  puts line.inspect if debug
+end

data/bin/puppet-diff

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby
+
+require 'puppet-cleaner/inspect'
+
+def usage
+  warn <<-EOS
+Usage:
+    #{File.basename $0} [-h] [-w] old.pp new.pp
+
+Options:
+    -h, --help        this help message
+    -w, --write       write a YAML file for each pp file if they are different
+  EOS
+  exit 1
+end
+
+opts = GetoptLong.new(
+  [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+  [ '--write', '-w', GetoptLong::NO_ARGUMENT ]
+)
+
+writedown = false
+
+opts.each do |opt, arg|
+  case opt
+  when '--help'
+    usage
+  when '--write'
+    writedown = true
+  end
+end
+
+usage if ARGV.size != 2
+
+filenames = ARGV
+
+old, new = filenames.collect do |filename|
+  catalog = Puppet::Cleaner.inspect(filename)
+  catalog.to_yaml.gsub(/^.*(?:file(?:_index)?|line):.*$/, "")
+end
+
+if old != new
+  puts "#{filenames[0]} and #{filenames[1]} differ"
+
+  if writedown
+    File.open("#{filenames[0]}.yaml", "w") {|f| f.write old }
+    File.open("#{filenames[1]}.yaml", "w") {|f| f.write new }
+  end
+end

data/bin/puppet-inspect

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby
+
+require 'puppet-cleaner/inspect'
+
+def usage
+  warn <<-EOS
+Usage:
+    #{File.basename $0} file.pp
+  EOS
+  exit 1
+end
+
+usage if ARGV.size != 1
+
+filename = ARGV[0]
+catalog = Puppet::Cleaner.inspect(filename)
+catalog.each {|e| puts e.to_yaml }

data/lib/puppet-cleaner/inspect.rb

@@ -0,0 +1,11 @@
+require 'puppet/parser'
+
+module Puppet::Cleaner
+  def self.inspect(filename)
+    Puppet[:manifest] = filename
+    tc = Puppet::Node::Environment.new(Puppet[:environment]).known_resource_types
+    catalog = [:nodes, :hostclasses, :definitions].collect {|meth| tc.send(meth) }
+    tc.clear
+    catalog
+  end
+end

data/lib/puppet-cleaner/line.rb

@@ -0,0 +1,108 @@
+require 'puppet-cleaner/parts'
+
+module Puppet::Cleaner
+  class Line
+    attr :position
+
+    def initialize(parts)
+      @parts = parts.map {|part| Part.create(part) }
+      @workers = Hash.new {|h, k| h[k] = []}
+      @position = 0
+    end
+
+    def hire(workers)
+      @workers.clear
+      workers.each do |worker|
+        worker.part_names.each {|part_name| @workers[part_name] << worker }
+      end
+    end
+
+    def transform!
+      start do |part|
+        @workers[part.name].each do |worker|
+          worker.operate(self)
+          if part.object_id != current.object_id
+            back!
+            break
+          end
+        end
+      end
+    end
+
+    def inspect
+      @parts.inject("") {|m, part| m += "#{part.name.inspect}\t#{part.value.inspect}\n"}
+    end
+
+    def show
+      start {|part| context = {:before => prev, :after => self.next}; part.show(context) }
+    end
+
+    def start
+      reset!
+      while !empty?
+        yield current
+        advance!
+      end
+    end
+
+    def size
+      @parts.size
+    end
+
+    def reset!
+      @position = 0
+    end
+
+    def advance!(n = 1)
+      @position += n
+    end
+
+    def back!(n = 1)
+      @position -= n
+    end
+
+    def empty?
+      @position >= 0 && @position >= size
+    end
+
+    def parts
+      @parts
+    end
+
+    def current
+      @parts[@position]
+    end
+
+    def next(n = 1)
+      (@position + n) >= size ? NoPart : @parts[@position + n]
+    end
+
+    def prev(n = 1)
+      (@position - n) < 0 ? NoPart : @parts[@position - n]
+    end
+
+    def last?
+      @position == (size  - 1)
+    end
+
+    def lookup(name, ignore = [])
+      position = @position
+      while position < size && !(ignore + [name]).include?(@parts[position].name)
+        position += 1
+      end
+      position == size || @parts[position].name != name ? nil : position
+    end
+
+    def remove(pos)
+      @parts.delete_at(pos)
+    end
+
+    def insert(pos, parts)
+      @parts.insert(pos, *parts)
+    end
+
+    def append(pos, parts)
+      @parts.insert(pos + 1, *parts)
+    end
+  end
+end

data/lib/puppet-cleaner/parts.rb

@@ -0,0 +1,137 @@
+module Puppet::Cleaner
+  class Part
+    # what makes a double quote string special
+    DQSPECIAL = {
+      "\n" => "\\n",
+      "\r" => "\\r",
+      "\t" => "\\t"
+    }
+
+    DQESCAPE = DQSPECIAL.dup
+    DQESCAPE["\""] = "\\\""
+    DQESCAPE["\\"] = "\\\\"
+    DQESCAPE["$"] = "\\$"
+
+    SQESCAPE = {
+      "'" => "\\'"
+    }
+
+    DQPATTERN = /[#{DQESCAPE.keys.map{|key| key.inspect[1..-2]}.join}]/
+    SQPATTERN = /[#{SQESCAPE.keys.map{|key| key.inspect[1..-2]}.join}]/
+
+    SPECIAL_ESCAPE_SEQUENCES = /[#{DQSPECIAL.keys.map{|key| key.inspect[1..-2]}.join}]/
+
+    def self.create(raw)
+      begin
+        klass = Puppet::Cleaner.const_get(raw[0].to_s.capitalize.to_sym)
+        klass.new(raw)
+      rescue NameError => e
+        Part.new(raw)
+      end
+    end
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def has_special_escape_sequences?
+      value =~ SPECIAL_ESCAPE_SEQUENCES
+    end
+
+    def show(context)
+      print to_s
+    end
+
+    def name
+      @raw[0]
+    end
+
+    def name=(name)
+      @raw[0] = name
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    def value
+      @raw[1][:value]
+    end
+
+    def value=(value)
+      @raw[1][:value] = value
+    end
+
+    def dqescape
+      value.gsub(Part::DQPATTERN) {|match| Part::DQESCAPE[match]}
+    end
+
+    def sqescape
+      ret = value.gsub(Part::SQPATTERN) {|match| Part::SQESCAPE[match]}
+      ret =~ /\\+$/
+      ret += "\\" if $& && $&.size % 2 == 1
+      ret
+    end
+
+  end
+
+  class Variable < Part
+    def to_s
+      "$#{value}"
+    end
+
+    def show(context)
+      if [:DQPRE, :DQMID].include?(context[:before].name)
+        print value
+      else
+        super
+      end
+    end
+  end
+
+  class Comment < Part
+    def to_s
+      value.empty? ? "#" : "# #{value}"
+    end
+  end
+
+  class Mlcomment < Part
+    def to_s
+      "/*#{value}*/"
+    end
+  end
+
+  class Dqpre < Part
+    def to_s
+      "\"#{dqescape}${"
+    end
+  end
+
+  class Dqmid < Part
+    def to_s
+      "}#{dqescape}${"
+    end
+  end
+
+  class Dqpost < Part
+    def to_s
+      "}#{dqescape}\""
+    end
+  end
+
+  class String < Part
+    def to_s
+      has_special_escape_sequences? ? "\"#{dqescape}\"" : "'#{sqescape}'"
+    end
+  end
+
+  class Class < Part; end
+
+  class Regex < Part
+    def to_s
+      value.inspect
+    end
+  end
+
+  NoPart = Part.new([:NOPART, {:value => ""}])
+end

data/lib/puppet-cleaner/workers/alignfarrow.rb

@@ -0,0 +1,55 @@
+module Puppet::Cleaner
+  class AlignFarrow < Worker
+    def part_names
+      [:LBRACE]
+    end
+  
+    def operate(line)
+      max, params = get_params(line)
+      params.each do |param|
+        nblanks = max - param[:name].to_s.size + 1
+        param[:before].value = ' '*nblanks if param[:before].value.size != nblanks
+      end
+    end
+  
+    def get_params(line)
+      depth = 1
+      max = 0
+      pos = line.position
+      params = []
+  
+      loop do
+        pos += 1
+        break if depth == 0 || pos >= line.parts.size
+        case line.parts[pos].name
+        when :LBRACE
+          depth += 1
+        when :RBRACE
+          depth -= 1
+        when :FARROW
+          next if depth != 1
+  
+          if line.parts[pos - 1].name == :BLANK
+            name = line.parts[pos - 2]
+            before = line.parts[pos - 1]
+          else
+            name = line.parts[pos - 1]
+            before = Part.create([:BLANK, {:value => ''}])
+            line.insert(pos, [before])
+            pos += 1
+          end
+  
+          if line.parts[pos + 1].name == :BLANK
+            line.parts[pos + 1].value = ' ' if line.parts[pos + 1].value != ' '
+          else
+            line.append(pos, Part.create([:BLANK, {:value => ' '}]))
+          end
+  
+          max = name.to_s.size if name.to_s.size > max
+          params << {:name => name, :before => before}
+        end
+      end
+      [max, params]
+    end
+  end
+end # module

data/lib/puppet-cleaner/workers/ensurefirst.rb

@@ -0,0 +1,27 @@
+module Puppet::Cleaner
+  class EnsureFirst < Worker
+    def part_names
+      [:COLON]
+    end
+  
+    def operate(line)
+      pos = line.position + 1
+      pos += 1 while [:BLANK, :RETURN, :COMMENT, :MLCOMMENT].include?(line.parts[pos].name)
+      return if line.parts[pos].name == :NAME && line.parts[pos].value == 'ensure'
+      start, pos  = get_param(line, 'ensure', line.position)
+      return if start.nil?
+  
+      ensure_param = line.parts.slice!(start..pos)
+      ensure_param += [Part.create([:COMMA, {:value => ","}])] unless ensure_param[-1].name == :COMMA
+  
+      pos = start
+      if line.parts[pos].name == :SEMIC
+        commapos = start - 1
+        commapos -= 1 while [:RETURN, :BLANK].include?(line.parts[commapos])
+        line.parts.delete_at(commapos)
+      end
+  
+      line.append(line.position, ensure_param)
+    end
+  end
+end

data/lib/puppet-cleaner/workers/multilinecomments.rb

@@ -0,0 +1,18 @@
+module Puppet::Cleaner
+  class MultilineComments < Worker
+    def part_names
+      [:MLCOMMENT]
+    end
+  
+    def operate(line)
+      pos = line.position
+      comments = line.current.value.split("\n")
+      line.remove(pos)
+      comments.map! do |comment|
+        [Part.create([:COMMENT, {:value => comment}]),
+         Part.create([:RETURN, {:value => "\n"}])]
+      end
+      line.insert(pos, comments.flatten)
+    end
+  end
+end

data/lib/puppet-cleaner/workers/octalmode.rb

@@ -0,0 +1,18 @@
+module Puppet::Cleaner
+  class OctalMode < Worker
+    def part_names
+      [:FARROW]
+    end
+  
+    def operate(line)
+      prev = line.prev.name == :BLANK ? line.prev(2) : line.prev
+      return if prev.value != "mode"
+      pos = line.next.name == :BLANK ? line.position + 2 : line.position + 1
+      mode = line.parts[pos]
+  
+      if mode.value =~ /^0?[0-7]{1,4}$/
+        line.parts[pos] = Part.create([:STRING, {:value => mode.value.rjust(4, "0")}])
+      end
+    end
+  end
+end

data/lib/puppet-cleaner/workers/quotedbooleans.rb

@@ -0,0 +1,14 @@
+module Puppet::Cleaner
+  class QuotedBooleans
+    def part_names
+      [:STRING]
+    end
+  
+    def operate(line)
+      value = line.current.value
+      return if !['true', 'false'].include?(value)
+      line.parts.delete_at(line.position)
+      line.insert(line.position, [Part.create([:NAME, {:value => value}])])
+    end
+  end
+end

data/lib/puppet-cleaner/workers/softtabs.rb

@@ -0,0 +1,43 @@
+module Puppet::Cleaner
+  class SoftTabs < Worker
+    def initialize(tabstop = 2)
+      @depth = 0
+      @tabstop = tabstop
+      @resource_tab = {:size => 0, :depth => nil}
+    end
+  
+    def part_names
+      [:LBRACE, :RBRACE, :LBRACK, :RBRACK, :LPAREN, :RPAREN, :COLON, :SEMIC, :RETURN]
+    end
+  
+    def operate(line)
+      case line.current.name
+      when :LBRACE, :LBRACK, :LPAREN
+        @depth += 1
+      when :RBRACE, :RBRACK, :RPAREN
+        @resource_tab[:size] = 0 if line.current.name == :RBRACE && @resource_tab[:depth] == @depth
+        @depth -= 1
+      when :SEMIC
+        @resource_tab[:size] = 0
+        @resource_tab[:depth] = nil
+      when :COLON
+        pos = line.position - 1
+        pos -= 1 while pos >= 0 && ![:LBRACE, :RETURN].include?(line.parts[pos].name)
+        return if pos < 0 || line.parts[pos].name != :RETURN
+        pos = line.position + 1
+        pos += 1 while pos < line.parts.size && [:BLANK, :RETURN].include?(line.parts[pos].name)
+        return if pos == line.parts.size || line.parts[pos].name == :LBRACE
+  
+        @resource_tab[:size] = 1
+        @resource_tab[:depth] = @depth
+      when :RETURN
+        return if line.last? || line.next.name == :RETURN
+        line.append(line.position, Part.create([:BLANK, {:value => ''}])) if line.next.name != :BLANK
+        n = [:RBRACE, :RBRACK, :RPAREN].include?(line.next(2).name) ? 1 : 0
+        @resource_tab[:size] = 0 if line.next(2).name == :RBRACE && @resource_tab[:depth] == @depth
+        blanks = ' '*@tabstop*(@depth - n + @resource_tab[:size])
+        line.next.value = blanks if line.next.value != blanks
+      end
+    end
+  end
+end

data/lib/puppet-cleaner/workers/symlink.rb

@@ -0,0 +1,47 @@
+module Puppet::Cleaner
+  class Symlink < Worker
+    def part_names
+      [:NAME]
+    end
+  
+    def operate(line)
+      return if line.current.value != 'file'
+      pos = line.position + 1
+      pos += 1 while pos < line.parts.size && [:BLANK, :RETURN, :COMMENT, :MLCOMMENT].include?(line.parts[pos].name)
+      return if pos >= line.parts.size || line.parts[pos].name != :LBRACE
+  
+      foreach_colon(line) {|colonpos|
+        start, pos = get_param(line, 'ensure', colonpos)
+        next if start.nil?
+        pos -= 1 if line.parts[pos].name == :COMMA
+        value = line.parts[pos].value
+        next if [:NAME, :STRING].include?(line.parts[pos].name) && %w(present absent file directory link symlink).include?(value)
+        next if line.parts[pos].name == :VARIABLE
+        ensure_param = [ [:RETURN, {:value => "\n"}], [:NAME, {:value => "ensure"}], [:FARROW, {:value => '=>'}], [:NAME, {:value => 'link'}], [:COMMA, {:value => ","}] ].map {|e| Part.create(e) }
+        start += 1 while line.parts[start].name != :NAME
+        line.parts[start].value = 'target'
+        line.append(colonpos, ensure_param)
+      }
+    end
+  
+    def foreach_colon(line)
+      pos = line.position
+      pos += 1 while pos < line.parts.size && line.parts[pos].name != :LBRACE
+      depth = 1
+  
+      loop do
+        pos += 1
+        break if depth == 0 || pos >= line.parts.size
+        case line.parts[pos].name
+        when :LBRACE
+          depth += 1
+        when :RBRACE
+          depth -= 1
+        when :COLON
+          next if depth != 1
+          yield pos
+        end
+      end
+    end
+  end
+end

data/lib/puppet-cleaner/workers/trailingwhitespace.rb

@@ -0,0 +1,11 @@
+module Puppet::Cleaner
+  class TrailingWhitespace < Worker
+    def part_names
+      [:BLANK]
+    end
+  
+    def operate(line)
+      line.remove(line.position) if line.next.name == :RETURN
+    end
+  end
+end

data/lib/puppet-cleaner/workers/trailingwhitespaceincomments.rb

@@ -0,0 +1,11 @@
+module Puppet::Cleaner
+  class TrailingWhitespaceInComments < Worker
+    def part_names
+      [:COMMENT]
+    end
+  
+    def operate(line)
+      line.current.value.rstrip!
+    end
+  end
+end

data/lib/puppet-cleaner/workers/unneededquotes.rb

@@ -0,0 +1,16 @@
+module Puppet::Cleaner
+  class UnneededQuotes < Worker
+    def part_names
+      [:VARIABLE]
+    end
+  
+    def operate(line)
+      return unless line.prev.name == :DQPRE && line.next.name == :DQPOST
+      return unless line.prev.value.empty? && line.next.value.empty?
+      pos = line.position
+      line.remove(pos + 1)
+      line.remove(pos - 1)
+      line.back!
+    end
+  end
+end

data/lib/puppet-cleaner/workers/worker.rb

@@ -0,0 +1,59 @@
+module Puppet::Cleaner
+  class Worker
+    def part_names
+      raise "Must be implemented in subclass"
+    end
+  
+    def operate
+      raise "Must be implemented in subclass"
+    end
+  
+    def get_param(line, param_name, pos)
+      depth = 1
+  
+      loop do
+        pos += 1
+        break if depth == 0 || pos >= line.parts.size
+        case line.parts[pos].name
+        when :LBRACE, :COLON
+          depth += 1
+        when :RBRACE
+          depth -= 1
+        when :SEMIC
+          depth -= 1
+        when :FARROW
+          next if depth != 1
+  
+          parampos = pos - 1
+          parampos -= 1 while [:BLANK, :RETURN].include?(line.parts[parampos].name)
+          next unless line.parts[parampos].name == :NAME && line.parts[parampos].value == param_name
+          start = parampos - 1
+          start -= 1 while [:BLANK, :RETURN].include?(line.parts[start].name)
+          start += 1
+  
+          loop do
+            pos += 1
+            break if depth < 0 || pos >= line.parts.size
+            case line.parts[pos].name
+            when :LBRACE
+              depth += 1
+            when :COMMA, :SEMIC, :RBRACE
+              depth -= 1 if line.parts[pos].name == :RBRACE
+              next if depth > 1
+              pos += 1 if line.parts[pos].name == :RBRACE && depth == 1
+              pos += 1 while pos < line.parts.size && ![:COMMA, :SEMIC, :RBRACE].include?(line.parts[pos].name)
+              break
+            end
+          end
+
+          return nil if pos >= line.parts.size
+          pos -= 1 unless line.parts[pos].name == :COMMA
+          pos -= 1 while [:BLANK, :RETURN].include?(line.parts[pos].name)
+  
+          return [start, pos]
+        end
+      end
+      nil
+    end
+  end
+end # module

data/lib/puppet-cleaner/workers.rb

@@ -0,0 +1,2 @@
+workersglob = File.join(File.dirname(__FILE__), "workers", "*.rb")
+Dir[workersglob].each {|worker| require worker }

data/lib/puppet-cleaner.rb

@@ -0,0 +1,36 @@
+require 'puppet/parser'
+require 'puppet-cleaner/line'
+require 'puppet-cleaner/workers'
+
+class Puppet::Parser::Lexer
+  class LexingContext < Hash
+    def []=(key, value)
+      return if key == :after && value == :BLANK
+      super
+    end
+  end
+
+  TOKENS[:COMMENT].skip = false
+  TOKENS[:MLCOMMENT].skip = false
+  TOKENS[:RETURN].skip = false
+  TOKENS.add_token :BLANK, %r{[ \t\r]+} do |lexer,value|
+    value.gsub!(/[\t\r]/,' ')
+    [self, value]
+  end
+
+  def lexing_context
+    @face_lexing_context ||= LexingContext.new.merge(@lexing_context)
+  end
+
+  def skip; end
+end
+
+module Puppet::Cleaner
+  def self.open(filename)
+    lexer = Puppet::Parser::Lexer.new
+    lexer.file = filename
+    tokens = lexer.fullscan
+    lexer.clear
+    Line.new(tokens[0..-2])
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: puppet-cleaner
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gerardo Santana Gomez Garrido
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-18 00:00:00 Z
+dependencies: []
+
+description: Cleans puppet source code
+email: gerardo.santana@gmail.com
+executables: 
+- puppet-diff
+- puppet-inspect
+- puppet-clean
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/puppet-cleaner.rb
+- lib/puppet-cleaner/parts.rb
+- lib/puppet-cleaner/line.rb
+- lib/puppet-cleaner/inspect.rb
+- lib/puppet-cleaner/workers.rb
+- lib/puppet-cleaner/workers/quotedbooleans.rb
+- lib/puppet-cleaner/workers/worker.rb
+- lib/puppet-cleaner/workers/unneededquotes.rb
+- lib/puppet-cleaner/workers/multilinecomments.rb
+- lib/puppet-cleaner/workers/trailingwhitespaceincomments.rb
+- lib/puppet-cleaner/workers/trailingwhitespace.rb
+- lib/puppet-cleaner/workers/symlink.rb
+- lib/puppet-cleaner/workers/alignfarrow.rb
+- lib/puppet-cleaner/workers/ensurefirst.rb
+- lib/puppet-cleaner/workers/octalmode.rb
+- lib/puppet-cleaner/workers/softtabs.rb
+- COPYRIGHT
+- Changelog
+- README.md
+- bin/puppet-diff
+- bin/puppet-inspect
+- bin/puppet-clean
+homepage: http://puppet-cleaner.rubyforge.org/
+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: puppet-cleaner
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Puppet Source Code Cleaner
+test_files: []
+