puppet-cleaner 0.2.1 → 0.3.0

data/Changelog

@@ -1,3 +1,8 @@
+0.3.0 2013-05-05
+-----------------
+Features:
+	* New worker for quoting resource titles (-r option)
+
 0.2.1 2013-05-03
 -----------------
 Bug fix:

data/README.md

@@ -12,6 +12,11 @@ Requirements
 
   * puppet
 
+Installation
+------------
+
+    sudo gem install puppet-cleaner
+
 Utilities
 ------------
 
@@ -22,6 +27,10 @@ applying the set of transformation rules that you select. If no options
 are selected all of them are applied, which currently is a subset of the
 puppet style guide.
 
+**Note:** the use of `${}` for variable interpolation in strings and the
+replacement of double with single quotes when possible are done by default
+and are not optional.
+
     Usage:
     
         puppet-clean [-h] [-t n] [-abedlmovw ] file.pp [file2.pp...]
@@ -30,14 +39,15 @@ puppet style guide.
         -h, --help              this help message
         -d, --debug             prints tokens before and after the transformation
     
-        -a, --alignfarrow       aligns fat arrow (=>)
+        -a, --alignfarrow       aligns fat arrows (`=>`)
         -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
+        -e, --ensurefirst       moves `ensure` attribute to the top
+        -l, --link              declares symbolic links by using `ensure => link` and `target` attributes
+        -m, --mlcomments        converts /* */ style comments to #
+        -o, --octalmode         represents file modes as a 4 digits string
+        -r, --resourcetitles    quotes resource titles
         -t n, --softtabs n      indents by n spaces
-        -v, --quotedvariables   removes unneeded quotes around variables
+        -v, --quotedvariables   emoves unneeded quotes around variables
         -w, --trailingws        removes trailing white space
 
 ### puppet-diff
@@ -46,12 +56,22 @@ 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.
 
+    Usage:
+        puppet-diff [-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
+
 ### puppet-inspect
 
 Receives a puppet manifest file and converts its objects (defined types,
 classes and nodes) to YAML.
 
+    Usage:
+        puppet-inspect file.pp
+
 Help & Feedback
-------------
+---------------
 
-Mail me directly if you need help or have any feedback about it.
+You can mail me directly if you need help or have any feedback to share.

data/bin/puppet-clean

@@ -19,6 +19,7 @@ Options:
     -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
+    -r, --resourcetitles    quotes resource titles
     -t n, --softtabs n      indents by n spaces
     -v, --quotedvariables   removes unneeded quotes around variables
     -w, --trailingws        removes trailing white space
@@ -36,6 +37,7 @@ opts = GetoptLong.new(
   [ '--link', '-l', GetoptLong::NO_ARGUMENT ],
   [ '--mlcomments', '-m', GetoptLong::NO_ARGUMENT ],
   [ '--octalmode', '-o', GetoptLong::NO_ARGUMENT ],
+  [ '--resourcetitles', '-r', GetoptLong::NO_ARGUMENT ],
   [ '--softtabs', '-t', GetoptLong::REQUIRED_ARGUMENT ],
   [ '--quotedvariables', '-v', GetoptLong::NO_ARGUMENT ],
   [ '--trailingws', '-w', GetoptLong::NO_ARGUMENT ]
@@ -62,6 +64,8 @@ opts.each do |opt, arg|
     workers << Puppet::Cleaner::MultilineComments.new
   when '--octalmode'
     workers << Puppet::Cleaner::OctalMode.new
+  when '--resourcetitles'
+    workers << Puppet::Cleaner::ResourceTitles.new
   when '--softtabs'
     tabstop = arg.to_i <= 2 ? 2 : arg.to_i
     workers << Puppet::Cleaner::SoftTabs.new(tabstop)
@@ -83,6 +87,7 @@ ALL = [
   Puppet::Cleaner::TrailingWhitespaceInComments.new,
   Puppet::Cleaner::AlignFarrow.new,
   Puppet::Cleaner::OctalMode.new,
+  Puppet::Cleaner::ResourceTitles.new,
   Puppet::Cleaner::EnsureFirst.new,
   Puppet::Cleaner::QuotedBooleans.new,
   Puppet::Cleaner::Symlink.new

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

@@ -0,0 +1,42 @@
+module Puppet::Cleaner
+  class ResourceTitles < Worker
+    def part_names
+      [:LBRACE]
+    end
+  
+    def operate(line)
+      pos = line.position - 1
+      pos -= 1 while [:BLANK, :RETURN, :COMMENT, :MLCOMMENT].include?(line.parts[pos].name) && pos >= 0
+      return if pos < 0 || ![:NAME, :CLASS].include?(line.parts[pos].name)
+
+      pos -= 1
+      pos -= 1 while [:BLANK, :RETURN, :COMMENT, :MLCOMMENT].include?(line.parts[pos].name) && pos >= 0
+      return if [:CASE, :IF].include?(line.parts[pos].name)
+
+      foreach_title(line) do |pos|
+        if [:NAME, :CLASSREF].include?(line.parts[pos].name)
+          line.parts[pos] = Part.create([:STRING, {:value => line.parts[pos].value}])
+        end
+      end
+    end
+  
+    def foreach_title(line)
+      depth = 1
+      pos = line.position
+  
+      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 - 1
+        end
+      end
+    end
+  end
+end # module

metadata

@@ -1,54 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: puppet-cleaner
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Gerardo Santana Gomez Garrido
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-05-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: puppet
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Cleans puppet source code
 email: gerardo.santana@gmail.com
-executables: 
+executables:
 - puppet-diff
 - puppet-inspect
 - puppet-clean
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/puppet-cleaner.rb
-- lib/puppet-cleaner/inspect.rb
-- lib/puppet-cleaner/line.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/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/multilinecomments.rb
 - lib/puppet-cleaner/workers/octalmode.rb
-- lib/puppet-cleaner/workers/quotedbooleans.rb
+- lib/puppet-cleaner/workers/resourcetitles.rb
 - lib/puppet-cleaner/workers/softtabs.rb
-- lib/puppet-cleaner/workers/symlink.rb
-- lib/puppet-cleaner/workers/trailingwhitespace.rb
-- lib/puppet-cleaner/workers/trailingwhitespaceincomments.rb
-- lib/puppet-cleaner/workers/unneededquotes.rb
 - COPYRIGHT
 - Changelog
 - README.md
@@ -57,30 +60,26 @@ files:
 - bin/puppet-clean
 homepage: http://puppet-cleaner.rubyforge.org/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: puppet-cleaner
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Puppet Source Code Cleaner
 test_files: []
-