foodcritic 0.3.0 → 0.4.0

data/lib/foodcritic.rb

@@ -1,3 +1,4 @@
+require 'chef'
 require 'foodcritic/domain'
 require 'foodcritic/helpers'
 require 'foodcritic/dsl'

data/lib/foodcritic/dsl.rb

@@ -1,9 +1,12 @@
+require 'pathname'
+
 module FoodCritic
 
   # The DSL methods exposed for defining rules.
   class RuleDsl
     attr_reader :rules
     include Helpers
+    include Chef::Mixin::ConvertToClassName
 
     # Define a new rule
     #

data/lib/foodcritic/helpers.rb

@@ -1,5 +1,4 @@
 require 'nokogiri'
-require 'xmlsimple'
 
 module FoodCritic
 
@@ -12,7 +11,7 @@ module FoodCritic
     # @return [Hash] Hash with the matched node name and position with the recipe
     def match(node)
       pos = node.xpath('descendant::pos').first
-      {:matched => node.name, :line => pos['line'], :column => pos['column']}
+      {:matched => node.respond_to?(:name) ? node.name : '', :line => pos['line'], :column => pos['column']}
     end
 
     # Does the specified recipe check for Chef Solo?
@@ -71,7 +70,7 @@ module FoodCritic
     # @return [Hash] The resource attributes
     def resource_attributes(resource)
       atts = {:name => resource_name(resource)}
-      resource.xpath('do_block/descendant::command').each do |att|
+      resource.xpath('do_block/descendant::command[count(ancestor::do_block) = 1]').each do |att|
         if att.xpath('descendant::symbol').empty?
           att_value = att.xpath('string(descendant::tstring_content/@value)')
         else
@@ -144,26 +143,35 @@ module FoodCritic
       node.respond_to?(:length) and node.length == 2 and node.respond_to?(:all?) and node.all?{|child| child.respond_to?(:to_i)}
     end
 
-    # Recurse the nested arrays provided by Ripper to create an intermediate Hash for ease of searching.
+    # Recurse the nested arrays provided by Ripper to create a tree we can more easily apply expressions to.
     #
-    # @param [Nokogiri::XML::Node] node The AST
-    # @return [Hash] The friendlier Hash.
-    def ast_to_hash(node)
-      result = {}
+    # @param [Hash] node The AST
+    # @param [Nokogiri::XML::Document] doc The document being constructed
+    # @param [Nokogiri::XML::Node] xml_node The current node
+    # @return [Nokogiri::XML::Node] The XML representation
+    def build_xml(node, doc = nil, xml_node=nil)
+      if doc.nil?
+        doc = Nokogiri::XML('<opt></opt>')
+        xml_node = doc.root
+      end
       if node.respond_to?(:each)
         node.drop(1).each do |child|
           if position_node?(child)
-            result[:pos] = {:line => child.first, :column => child[1]}
+            pos = Nokogiri::XML::Node.new("pos", doc)
+            pos['line'] = child.first.to_s
+            pos['column'] = child[1].to_s
+            xml_node.add_child(pos)
           else
             if child.respond_to?(:first)
-              result[child.first.to_s.gsub(/[^a-z_]/, '')] = ast_to_hash(child)
+              n = Nokogiri::XML::Node.new(child.first.to_s.gsub(/[^a-z_]/, ''), doc)
+              xml_node.add_child(build_xml(child, doc, n))
             else
-              result[:value] = child  unless child.nil?
+              xml_node['value'] = child.to_s unless child.nil?
             end
           end
         end
       end
-      result
+      xml_node
     end
 
     # Read the AST for the given Ruby file
@@ -171,7 +179,7 @@ module FoodCritic
     # @param [String] file The file to read
     # @return [Nokogiri::XML::Node] The recipe AST
     def read_file(file)
-      Nokogiri::XML(XmlSimple.xml_out(ast_to_hash(Ripper::SexpBuilder.new(IO.read(file)).parse)))
+      build_xml(Ripper::SexpBuilder.new(IO.read(file)).parse)
     end
 
   end

data/lib/foodcritic/linter.rb

@@ -21,8 +21,8 @@ module FoodCritic
       files_to_process(cookbook_path).each do |file|
         ast = read_file(file)
         @rules.each do |rule|
-          matches = rule.recipe.yield(ast, File.expand_path(file))
-          matches.each{|match| warnings << Warning.new(rule, match.merge({:filename => file}))} unless matches.nil?
+          matches = rule.recipe.yield(ast, file)
+          matches.each{|match| warnings << Warning.new(rule, {:filename => file}.merge(match))} unless matches.nil?
         end
       end
       Review.new(warnings)

data/lib/foodcritic/rules.rb

@@ -49,12 +49,45 @@ end
 rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
   description "You are including a recipe that is not in the current cookbook and not defined as a dependency in your cookbook metadata."
   recipe do |ast,filename|
-    metadata_path = File.join(File.dirname(filename), '..', 'metadata.rb')
+    metadata_path = Pathname.new(File.join(File.dirname(filename), '..', 'metadata.rb')).cleanpath
     next unless File.exists? metadata_path
     undeclared = included_recipes(ast).keys.map{|recipe|recipe.split('::').first} - [cookbook_name(filename)] -
         declared_dependencies(read_file(metadata_path))
     included_recipes(ast).map do |recipe, resource|
-      match(resource) if undeclared.include?(recipe) || undeclared.any?{|u| recipe.start_with?("#{u}::")}
+      match(resource).merge(:filename => metadata_path) if undeclared.include?(recipe) || undeclared.any?{|u| recipe.start_with?("#{u}::")}
     end.compact
   end
 end
+
+rule "FC008", "Generated cookbook metadata needs updating" do
+  description "The cookbook metadata for this cookbook is boilerplate output from knife generate cookbook and needs updating with the real details of your cookbook."
+  recipe do |ast,filename|
+    metadata_path = Pathname.new(File.join(File.dirname(filename), '..', 'metadata.rb')).cleanpath
+    next unless File.exists? metadata_path
+    md = read_file(metadata_path)
+    {'maintainer' => 'YOUR_COMPANY_NAME', 'maintainer_email' => 'YOUR_EMAIL'}.map do |field,value|
+      md.xpath(%Q{//command[ident/@value='#{field}']/descendant::tstring_content[@value='#{value}']}).map do |m|
+        match(m).merge(:filename => metadata_path)
+      end
+    end.flatten
+  end
+end
+
+rule "FC009", "Resource attribute not recognised" do
+  description "You appear to be using an unrecognised attribute on a standard Chef resource. Please check for typos."
+  recipe do |ast|
+    matches = []
+    resource_attributes_by_type(ast).each do |type,resources|
+      if Chef::Resource.const_defined?(convert_to_class_name(type))
+        allowed_atts = Chef::Resource.const_get(convert_to_class_name(type)).public_instance_methods(true)
+        resources.each do |resource|
+          invalid_atts = resource.keys.map{|att|att.to_sym} - allowed_atts
+          unless invalid_atts.empty?
+            matches << match(find_resources(ast, type).find{|res|resource_attributes(res).include?(invalid_atts.first.to_s)})
+          end
+        end
+      end
+    end
+    matches
+  end
+end

data/lib/foodcritic/version.rb

@@ -1,3 +1,3 @@
 module FoodCritic
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-04 00:00:00.000000000 Z
+date: 2011-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &2157802560 !ruby/object:Gem::Requirement
+  name: chef
+  requirement: &2153103960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 0.10.4
   type: :runtime
   prerelease: false
-  version_requirements: *2157802560
+  version_requirements: *2153103960
 - !ruby/object:Gem::Dependency
-  name: xml-simple
-  requirement: &2157800260 !ruby/object:Gem::Requirement
+  name: nokogiri
+  requirement: &2153103180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2157800260
+  version_requirements: *2153103180
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -69,12 +69,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 927165501432344600
+      hash: 1643437083715464422
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: foodcritic-0.3.0
+summary: foodcritic-0.4.0
 test_files: []
 has_rdoc: