foodcritic 1.0.1 → 1.1.0

data/lib/foodcritic/api.rb

@@ -22,24 +22,11 @@ module FoodCritic
         raise ArgumentError, "Node type not recognised"
       end
 
-      (if options[:type] == :vivified
-        calls = ast.xpath(%q{//*[self::call or self::field]
-          [is_att_type(vcall/ident/@value) or
-           is_att_type(var_ref/ident/@value)][@value='.']}, AttFilter.new)
-        calls.select do |call|
-          call.xpath("aref/args_add_block").size == 0 and
-          (call.xpath("descendant::ident").size > 1 and
-           ! chef_dsl_methods.include?(call.xpath("ident/@value").to_s.to_sym))
-        end
+      if options[:type] == :vivified
+        vivified_attribute_access(ast)
       else
-        type = (options[:type] == :string) ? 'tstring_content' : options[:type]
-        expr = '//*[self::aref_field or self::aref]'
-        expr += '[is_att_type(descendant::ident'
-        expr += '[not(ancestor::aref/call)]' if options[:ignore_calls]
-        expr += "/@value)]/descendant::#{type}"
-        ast.xpath(expr, AttFilter.new)
+        standard_attribute_access(ast, options)
       end
-      ).sort
     end
 
     # Does the specified recipe check for Chef Solo?
@@ -61,7 +48,8 @@ module FoodCritic
     def chef_solo_search_supported?(recipe_path)
       return false if recipe_path.nil? || ! File.exists?(recipe_path)
       cbk_tree_path = Pathname.new(File.join(recipe_path, '../../..'))
-      search_libs = Dir[File.join(cbk_tree_path.realpath, "*/libraries/search.rb")]
+      search_libs = Dir[File.join(cbk_tree_path.realpath,
+        '*/libraries/search.rb')]
       search_libs.any? do |lib|
         ! read_ast(lib).xpath(%q{//class[count(descendant::const[@value='Chef']
           ) = 1]/descendant::def/ident[@value='search']}).empty?
@@ -78,6 +66,12 @@ module FoodCritic
         file = File.absolute_path(File.dirname(file.to_s))
       end
       file = File.dirname(file) unless File.extname(file).empty?
+      md_path = File.join(file, 'metadata.rb')
+      if File.exists?(md_path)
+        name = read_ast(md_path).xpath("//stmts_add/
+          command[ident/@value='name']/descendant::tstring_content/@value").to_s
+        return name unless name.empty?
+      end
       File.basename(file)
     end
 
@@ -88,7 +82,7 @@ module FoodCritic
     def declared_dependencies(ast)
       raise_unless_xpath!(ast)
       deps = ast.xpath(%q{//command[ident/@value='depends']/
-        descendant::args_add/descendant::tstring_content})
+        descendant::args_add/descendant::tstring_content[1]})
       # handle quoted word arrays
       var_ref = ast.xpath(%q{//command[ident/@value='depends']/
         descendant::var_ref/ident})
@@ -138,6 +132,7 @@ module FoodCritic
       included.inject(Hash.new([])){|h, i| h[i['value']] += [i]; h}
     end
 
+    # XPath custom function
     class AttFilter
       def is_att_type(value)
         return [] unless value.respond_to?(:select)
@@ -159,7 +154,8 @@ module FoodCritic
     # Create a match from the specified node.
     #
     # @param [Nokogiri::XML::Node] node The node to create a match for
-    # @return [Hash] Hash with the matched node name and position with the recipe
+    # @return [Hash] Hash with the matched node name and position with the
+    #   recipe
     def match(node)
       raise_unless_xpath!(node)
       pos = node.xpath('descendant::pos').first
@@ -175,7 +171,7 @@ module FoodCritic
     # @return [Boolean] True if this string might be an OS command
     def os_command?(str)
       str.start_with?('grep ', 'which ') or # common commands
-      str.include?('|') or                  # probably a pipe, could be alternation
+      str.include?('|') or                  # a pipe, could be alternation
       str.match(/^[\w]+$/) or               # command name only
       str.match(/ --?[a-z]/i)               # command-line flag
     end
@@ -212,7 +208,8 @@ module FoodCritic
         if att.xpath('descendant::symbol').empty?
           att_value = att.xpath('string(descendant::tstring_content/@value)')
         else
-          att_value = att.xpath('string(descendant::symbol/ident/@value)').to_sym
+          att_value =
+            att.xpath('string(descendant::symbol/ident/@value)').to_sym
         end
         atts[att.xpath('string(ident/@value)')] = att_value
       end
@@ -346,6 +343,26 @@ module FoodCritic
       end
     end
 
+    def standard_attribute_access(ast, options)
+      type = options[:type] == :string ? 'tstring_content' : options[:type]
+      expr = '//*[self::aref_field or self::aref]'
+      expr += '[is_att_type(descendant::ident'
+      expr += '[not(ancestor::aref/call)]' if options[:ignore_calls]
+      expr += "/@value)]/descendant::#{type}"
+      ast.xpath(expr, AttFilter.new).sort
+    end
+
+    def vivified_attribute_access(ast)
+      calls = ast.xpath(%q{//*[self::call or self::field]
+        [is_att_type(vcall/ident/@value) or
+        is_att_type(var_ref/ident/@value)][@value='.']}, AttFilter.new)
+      calls.select do |call|
+        call.xpath("aref/args_add_block").size == 0 and
+          (call.xpath("descendant::ident").size > 1 and
+            ! chef_dsl_methods.include?(call.xpath("ident/@value").to_s.to_sym))
+      end.sort
+    end
+
   end
 
 end

data/lib/foodcritic/chef.rb

@@ -8,7 +8,7 @@ module FoodCritic
     # @return [Array] Array of method symbols
     def chef_dsl_methods
       load_metadata
-      @dsl_metadata[:dsl_methods].map{|m| m.to_sym}
+      @dsl_metadata[:dsl_methods].map(&:to_sym)
     end
 
     # Is the specified attribute valid for the type of resource? Note that this
@@ -16,6 +16,7 @@ module FoodCritic
     #
     # @param [Symbol] resource_type The type of Chef resource
     # @param [Symbol] attribute_name The attribute name
+    # @return [Boolean] False if the attribute is known not to be valid
     def resource_attribute?(resource_type, attribute_name)
       if resource_type.to_s.empty? || attribute_name.to_s.empty?
         raise ArgumentError, "Arguments cannot be nil or empty."
@@ -46,6 +47,7 @@ module FoodCritic
         :symbolize_keys => true)
     end
 
+    # Chef Search
     class Search
 
       # The search grammars that ship with any Chef gems installed locally.
@@ -67,7 +69,8 @@ module FoodCritic
             begin
               break parser unless parser.nil?
               # don't instantiate custom nodes
-              Treetop.load_from_string(IO.read(lucene_grammar).gsub(/<[^>]+>/, ''))
+              Treetop.load_from_string(
+                IO.read(lucene_grammar).gsub(/<[^>]+>/, ''))
               LuceneParser.new
             rescue
               # silently swallow and try the next grammar
@@ -82,6 +85,9 @@ module FoodCritic
         ! @search_parser.nil?
       end
 
+      # The search parser
+      #
+      # @return [LuceneParser] The search parser
       def parser
         @search_parser
       end

data/lib/foodcritic/command_line.rb

@@ -9,17 +9,37 @@ module FoodCritic
     def initialize(args)
       @args = args
       @original_args = args.dup
-      @options = {}
-      @options[:fail_tags] = []; @options[:tags] = []; @options[:include_rules] = []
+      @options = {:fail_tags => [], :tags => [], :include_rules => []}
       @parser = OptionParser.new do |opts|
         opts.banner = 'foodcritic [cookbook_path]'
-        opts.on("-r", "--[no-]repl", "Drop into a REPL for interactive rule editing.") {|r|options[:repl] = r}
-        opts.on("-t", "--tags TAGS", "Only check against rules with the specified tags.") {|t|options[:tags] << t}
-        opts.on("-f", "--epic-fail TAGS", "Fail the build if any of the specified tags are matched.") {|t|options[:fail_tags] << t}
-        opts.on("-C", "--[no-]context", "Show lines matched against rather than the default summary.") {|c|options[:context] = c}
-        opts.on("-I", "--include PATH", "Additional rule file path(s) to load.") {|i|options[:include_rules] << i}
-        opts.on("-S", "--search-grammar PATH", "Specify grammar to use when validating search syntax.") {|s|options[:search_grammar] = s}
-        opts.on("-V", "--version", "Display version."){|v|options[:version] = true}
+        opts.on("-r", "--[no-]repl",
+          "Drop into a REPL for interactive rule editing.") do |r|
+          options[:repl] = r
+        end
+        opts.on("-t", "--tags TAGS",
+          "Only check against rules with the specified tags.") do |t|
+          options[:tags] << t
+        end
+        opts.on("-f", "--epic-fail TAGS",
+          "Fail the build if any of the specified tags are matched.") do |t|
+          options[:fail_tags] << t
+        end
+        opts.on("-C", "--[no-]context",
+          "Show lines matched against rather than the default summary.") do |c|
+          options[:context] = c
+        end
+        opts.on("-I", "--include PATH",
+          "Additional rule file path(s) to load.") do |i|
+          options[:include_rules] << i
+        end
+        opts.on("-S", "--search-grammar PATH",
+          "Specify grammar to use when validating search syntax.") do |s|
+          options[:search_grammar] = s
+        end
+        opts.on("-V", "--version",
+          "Display version.") do |v|
+          options[:version] = true
+        end
       end
       @parser.parse!(args) unless show_help?
     end
@@ -68,7 +88,8 @@ module FoodCritic
 
     # Is the search grammar specified valid?
     #
-    # @return [Boolean] True if the grammar has not been provided or can be loaded.
+    # @return [Boolean] True if the grammar has not been provided or can be
+    #   loaded.
     def valid_grammar?
       return true unless options.key?(:search_grammar)
       return false unless File.exists?(options[:search_grammar])
@@ -77,7 +98,8 @@ module FoodCritic
       search.parser?
     end
 
-    # If matches should be shown with context rather than the default summary display.
+    # If matches should be shown with context rather than the default summary
+    # display.
     #
     # @return [Boolean] True if matches should be shown with context.
     def show_context?

data/lib/foodcritic/domain.rb

@@ -8,7 +8,8 @@ module FoodCritic
     #
     # @param [FoodCritic::Rule] rule The rule which raised this warning
     # @param [Hash] match The match data
-    # @option match [String] :filename The filename the warning was raised against
+    # @option match [String] :filename The filename the warning was raised
+    #   against
     # @option match [Integer] :line The identified line
     # @option match [Integer] :column The identified column
     def initialize(rule, match={})
@@ -25,7 +26,8 @@ module FoodCritic
     #
     # @param [String] cookbook_path The path this review was performed against
     # @param [Array] warnings The warnings raised in this review
-    # @param [Boolean] is_failed Have warnings been raised that mean this should be considered failed?
+    # @param [Boolean] is_failed Have warnings been raised that mean this
+    #   should be considered failed?
     def initialize(cookbook_path, warnings, is_failed)
       @cookbook_path = cookbook_path
       @warnings = warnings
@@ -41,9 +43,13 @@ module FoodCritic
 
     # Returns a string representation of this review.
     #
-    # @return [String] Review as a string, this representation is liable to change.
+    # @return [String] Review as a string, this representation is liable to
+    #   change.
     def to_s
-      @warnings.map{|w|["#{w.rule.code}: #{w.rule.name}: #{w.match[:filename]}", w.match[:line].to_i]}.sort do |x,y|
+      @warnings.map do |w|
+        ["#{w.rule.code}: #{w.rule.name}: #{w.match[:filename]}",
+         w.match[:line].to_i]
+      end.sort do |x,y|
         x.first == y.first ? x[1] <=> y[1] : x.first <=> y.first
       end.map{|w|"#{w.first}:#{w[1]}"}.uniq.join("\n")
     end
@@ -56,13 +62,19 @@ module FoodCritic
 
     # Create a new rule
     #
-    # @param [String] code The short unique identifier for this rule, e.g. 'FC001'
-    # @param [String] name The short descriptive name of this rule presented to the end user.
+    # @param [String] code The short unique identifier for this rule,
+    #   e.g. 'FC001'
+    # @param [String] name The short descriptive name of this rule presented to
+    #   the end user.
     def initialize(code, name)
       @code, @name = code, name
       @tags = [code]
     end
 
+    # The tags associated with this rule.
+    # A rule is always tagged with the tags 'any' and the rule code.
+    #
+    # @return [Array] The tags associated.
     def tags
       ['any'] + @tags
     end

data/lib/foodcritic/dsl.rb

@@ -11,7 +11,8 @@ module FoodCritic
 
     # Define a new rule
     #
-    # @param [String] code The short unique identifier for this rule, e.g. 'FC001'
+    # @param [String] code The short unique identifier for this rule,
+    #   e.g. 'FC001'
     # @param [String] name The short descriptive name of this rule presented to
     #   the end user.
     # @param [Block] block The rule definition

data/lib/foodcritic/error_checker.rb

@@ -18,7 +18,8 @@ module FoodCritic
 
     # Register with all available error handlers.
     def self.register_error_handlers
-      SexpBuilder.public_instance_methods.grep(/^on_.*_error$/).sort.each do |err_meth|
+      error_methods = SexpBuilder.public_instance_methods.grep(/^on_.*_error$/)
+      error_methods.sort.each do |err_meth|
         define_method(err_meth) { |*| @found_error = true }
       end
     end

data/lib/foodcritic/linter.rb

@@ -54,13 +54,20 @@ module FoodCritic
       active_rules = @rules.select{|rule| matching_tags?(options[:tags],
         rule.tags)}
       files_to_process(cookbook_path).each do |file|
-        cookbook_dir = Pathname.new(File.join(File.dirname(file), '..')).cleanpath
+        cookbook_dir = Pathname.new(
+          File.join(File.dirname(file), '..')).cleanpath
         ast = read_ast(file)
         active_rules.each do |rule|
           rule_matches = matches(rule.recipe, ast, file)
-          rule_matches += matches(rule.provider, ast, file) if File.basename(File.dirname(file)) == 'providers'
-          rule_matches += matches(rule.resource, ast, file) if File.basename(File.dirname(file)) == 'resources'
-          rule_matches += matches(rule.cookbook, cookbook_dir) if last_dir != cookbook_dir
+          if File.basename(File.dirname(file)) == 'providers'
+            rule_matches += matches(rule.provider, ast, file)
+          end
+          if File.basename(File.dirname(file)) == 'resources'
+          rule_matches += matches(rule.resource, ast, file)
+          end
+          if last_dir != cookbook_dir
+            rule_matches += matches(rule.cookbook, cookbook_dir)
+          end
           rule_matches.each do |match|
             warnings << Warning.new(rule, {:filename => file}.merge(match))
             matched_rule_tags << rule.tags
@@ -76,7 +83,8 @@ module FoodCritic
       @review
     end
 
-    # Convenience method to repeat the last check. Intended to be used from the REPL.
+    # Convenience method to repeat the last check. Intended to be used from the
+    # REPL.
     def recheck
       check(@last_cookbook_path, @last_options)
     end
@@ -107,7 +115,16 @@ module FoodCritic
     def matches(match_method, *params)
       return [] unless match_method.respond_to?(:yield)
       matches = match_method.yield(*params)
-      matches.respond_to?(:each) ? matches : []
+      return [] unless matches.respond_to?(:each)
+      matches.map do |m|
+        if m.respond_to?(:node_name)
+          match(m)
+        elsif m.respond_to?(:xpath)
+          m.to_a.map{|m| match(m)}
+        else
+          m
+        end
+      end.flatten
     end
 
     # Return the files within a cookbook tree that we are interested in trying
@@ -118,8 +135,9 @@ module FoodCritic
     #   processed.
     def files_to_process(dir)
       return [dir] unless File.directory? dir
-      Dir.glob(File.join(dir, '{attributes,providers,recipes,resources}/*.rb')) +
-        Dir.glob(File.join(dir, '*/{attributes,providers,recipes,resources}/*.rb'))
+      cookbook_glob = '{attributes,providers,recipes,resources}/*.rb'
+      Dir.glob(File.join(dir, cookbook_glob)) +
+        Dir.glob(File.join(dir, "*/#{cookbook_glob}"))
     end
 
     # Whether to fail the build.

data/lib/foodcritic/output.rb

@@ -2,7 +2,8 @@ module FoodCritic
 
   # Default output showing a summary view.
   class SummaryOutput
-    # Output a summary view only listing the matching rules, file and line number.
+    # Output a summary view only listing the matching rules, file and line
+    # number.
     #
     # @param [Review] review The review to output.
     def output(review)
@@ -21,10 +22,12 @@ module FoodCritic
         puts review; return
       end
 
-      # Cheating here and mis-using Rak (Ruby port of Ack) to generate pretty colourised context.
+      # Cheating here and mis-using Rak (Ruby port of Ack) to generate pretty
+      # colourised context.
       #
-      # Rak supports evaluating a custom expression as an alternative to a regex. Our expression consults a hash of the
-      # matches found and then we let Rak take care of the presentation.
+      # Rak supports evaluating a custom expression as an alternative to a
+      # regex. Our expression consults a hash of the matches found and then we
+      # let Rak take care of the presentation.
       line_lookup = key_by_file_and_line(review)
       Rak.class_eval do
         const_set(:RULE_COLOUR, "\033[1;36m")
@@ -33,8 +36,9 @@ module FoodCritic
       ARGV.replace(['--context', '--eval', %q{
         # This code will be evaluated inline by Rak.
         fn = fn.split("\n").first
-        if @warnings.key?(fn) and @warnings[fn].key?($.) # filename and line number
-          rule_name = "#{RULE_COLOUR if opt[:colour]}#{@warnings[fn][$.].to_a.join("\n")}#{CLEAR_COLOURS}"
+        if @warnings.key?(fn) and @warnings[fn].key?($.) # filename and line no
+          rule_name = opt[:colour] ? RULE_COLOUR : ''
+          rule_name += "#{@warnings[fn][$.].to_a.join("\n")}#{CLEAR_COLOURS}"
           if ! displayed_filename
             fn = "#{fn}\n#{rule_name}"
           else
@@ -50,16 +54,20 @@ module FoodCritic
 
     private
 
-    # Build a hash lookup by filename and line number for warnings found in the specified review.
+    # Build a hash lookup by filename and line number for warnings found in the
+    # specified review.
     #
     # @param [Review] review The review to convert.
     # @return [Hash] Nested hashes keyed by filename and line number.
     def key_by_file_and_line(review)
       warn_hash = {}
       review.warnings.each do |warning|
-        filename = Pathname.new(warning.match[:filename]).cleanpath.to_s;  line_num = warning.match[:line].to_i
+        filename = Pathname.new(warning.match[:filename]).cleanpath.to_s
+        line_num = warning.match[:line].to_i
         warn_hash[filename] = {} unless warn_hash.key?(filename)
-        warn_hash[filename][line_num] = Set.new unless warn_hash[filename].key?(line_num)
+        unless warn_hash[filename].key?(line_num)
+          warn_hash[filename][line_num] = Set.new
+        end
         warn_hash[filename][line_num] << warning.rule
       end
       warn_hash
@@ -67,4 +75,4 @@ module FoodCritic
 
   end
 
-end
+end

data/lib/foodcritic/rules.rb

@@ -1,7 +1,8 @@
-rule "FC001", "Use strings in preference to symbols to access node attributes" do
+rule "FC001",
+     "Use strings in preference to symbols to access node attributes" do
   tags %w{style attributes}
   recipe do |ast|
-    attribute_access(ast, :type => :symbol).map{|ar| match(ar)}
+    attribute_access(ast, :type => :symbol)
   end
 end
 
@@ -9,14 +10,19 @@ rule "FC002", "Avoid string interpolation where not required" do
   tags %w{style strings}
   recipe do |ast|
     ast.xpath(%q{//string_literal[count(descendant::string_embexpr) = 1 and
-      count(string_add/tstring_content|string_add/string_add/tstring_content) = 0]}).map{|str| match(str)}
+      count(string_add/tstring_content|string_add/string_add/tstring_content)
+      = 0]})
   end
 end
 
-rule "FC003", "Check whether you are running with chef server before using server-specific features" do
+rule "FC003",
+     "Check whether you are running with chef server before using" +
+     " server-specific features" do
   tags %w{portability solo}
   recipe do |ast,filename|
-    searches(ast).map{|s| match(s)} unless checks_for_chef_solo?(ast) or chef_solo_search_supported?(filename)
+    unless checks_for_chef_solo?(ast) or chef_solo_search_supported?(filename)
+      searches(ast)
+    end
   end
 end
 
@@ -25,38 +31,52 @@ rule "FC004", "Use a service resource to start and stop services" do
   recipe do |ast|
     find_resources(ast, :type => 'execute').find_all do |cmd|
       cmd_str = (resource_attribute(cmd, 'command') || resource_name(cmd)).to_s
-      cmd_str.include?('/etc/init.d') || cmd_str.start_with?('service ') || cmd_str.start_with?('/sbin/service ') ||
-          cmd_str.start_with?('start ') || cmd_str.start_with?('stop ') || cmd_str.start_with?('invoke-rc.d ')
-    end.map{|cmd| match(cmd)}
+      cmd_str.include?('/etc/init.d') || cmd_str.start_with?('service ') ||
+        cmd_str.start_with?('/sbin/service ') ||
+        cmd_str.start_with?('start ') || cmd_str.start_with?('stop ') ||
+        cmd_str.start_with?('invoke-rc.d ')
+    end
   end
 end
 
 rule "FC005", "Avoid repetition of resource declarations" do
   tags %w{style}
   recipe do |ast|
-    resources = find_resources(ast).map{|res| resource_attributes(res).merge({:type => resource_type(res),
-      :ast => res})}.chunk{|res| res[:type]}.reject{|res| res[1].size < 3}
+    resources = find_resources(ast).map do |res|
+      resource_attributes(res).merge({:type => resource_type(res),
+                                      :ast => res})
+    end.chunk{|res| res[:type]}.reject{|res| res[1].size < 3}
     resources.map do |cont_res|
       first_resource = cont_res[1][0][:ast]
-      # we have contiguous resources of the same type, but do they share the same attributes?
-      sorted_atts = cont_res[1].map{|atts| atts.delete_if{|k| k == :ast}.to_a.sort{|x,y| x.first.to_s <=> y.first.to_s}}
-      match(first_resource) if sorted_atts.all?{|att| (att - sorted_atts.inject{|atts,a| atts & a}).length == 1}
+      # we have contiguous resources of the same type, but do they share the
+      # same attributes?
+      sorted_atts = cont_res[1].map do |atts|
+        atts.delete_if{|k| k == :ast}.to_a.sort do |x,y|
+          x.first.to_s <=> y.first.to_s
+        end
+      end
+      first_resource if sorted_atts.all? do |att|
+        (att - sorted_atts.inject{|atts,a| atts & a}).length == 1
+      end
     end.compact
   end
 end
 
-rule "FC006", "Mode should be quoted or fully specified when setting file permissions" do
+rule "FC006",
+     "Mode should be quoted or fully specified when setting file permissions" do
   tags %w{correctness files}
   recipe do |ast|
-    ast.xpath(%q{//ident[@value='mode']/parent::command/descendant::int[string-length(@value) < 5 and not(starts-with(@value, "0") and string-length(@value) = 4)]/
-      ancestor::method_add_block}).map{|resource| match(resource)}
+    ast.xpath(%q{//ident[@value='mode']/parent::command/
+      descendant::int[string-length(@value) < 5 and not(starts-with(@value, "0")
+      and string-length(@value) = 4)]/ancestor::method_add_block})
   end
 end
 
 rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
   tags %w{correctness metadata}
   recipe do |ast,filename|
-    metadata_path = Pathname.new(File.join(File.dirname(filename), '..', 'metadata.rb')).cleanpath
+    metadata_path =Pathname.new(
+      File.join(File.dirname(filename), '..', 'metadata.rb')).cleanpath
     next unless File.exists? metadata_path
     undeclared = included_recipes(ast).keys.map do |recipe|
       recipe.split('::').first
@@ -65,7 +85,7 @@ rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
     included_recipes(ast).map do |recipe, include_stmts|
       if undeclared.include?(recipe) ||
          undeclared.any?{|u| recipe.start_with?("#{u}::")}
-        include_stmts.map{|i| match(i)}
+        include_stmts
       end
     end.flatten.compact
   end
@@ -77,8 +97,10 @@ rule "FC008", "Generated cookbook metadata needs updating" do
     metadata_path = Pathname.new(File.join(filename, 'metadata.rb')).cleanpath
     next unless File.exists? metadata_path
     md = read_ast(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|
+    {'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
@@ -91,12 +113,12 @@ rule "FC009", "Resource attribute not recognised" do
     matches = []
     resource_attributes_by_type(ast).each do |type,resources|
       resources.each do |resource|
-        resource.keys.map{|att|att.to_sym}.reject do |att|
+        resource.keys.map(&:to_sym).reject do |att|
           resource_attribute?(type.to_sym, att)
         end.each do |invalid_att|
-          matches << match(find_resources(ast, :type => type).find do |res|
+          matches << find_resources(ast, :type => type).find do |res|
             resource_attributes(res).include?(invalid_att.to_s)
-          end)
+          end
         end
       end
     end
@@ -108,21 +130,25 @@ rule "FC010", "Invalid search syntax" do
   tags %w{correctness search}
   recipe do |ast|
     # This only works for literal search strings
-    literal_searches(ast).reject{|search| valid_query?(search['value'])}.map{|search| match(search)}
+    literal_searches(ast).reject{|search| valid_query?(search['value'])}
   end
 end
 
 rule "FC011", "Missing README in markdown format" do
   tags %w{style readme}
   cookbook do |filename|
-    [file_match(File.join(filename, 'README.md'))] unless File.exists?(File.join(filename, 'README.md'))
+    unless File.exists?(File.join(filename, 'README.md'))
+      [file_match(File.join(filename, 'README.md'))]
+    end
   end
 end
 
 rule "FC012", "Use Markdown for README rather than RDoc" do
   tags %w{style readme}
   cookbook do |filename|
-    [file_match(File.join(filename, 'README.rdoc'))] if File.exists?(File.join(filename, 'README.rdoc'))
+    if File.exists?(File.join(filename, 'README.rdoc'))
+      [file_match(File.join(filename, 'README.rdoc'))]
+    end
   end
 end
 
@@ -130,9 +156,10 @@ rule "FC013", "Use file_cache_path rather than hard-coding tmp paths" do
   tags %w{style files}
   recipe do |ast|
     find_resources(ast, :type => 'remote_file').find_all do |download|
-      path = (resource_attribute(download, 'path') || resource_name(download)).to_s
+      path = (resource_attribute(download, 'path') ||
+        resource_name(download)).to_s
       path.start_with?('/tmp/')
-    end.map{|download| match(download)}
+    end
   end
 end
 
@@ -140,30 +167,38 @@ rule "FC014", "Consider extracting long ruby_block to library" do
   tags %w{style libraries}
   recipe do |ast|
     find_resources(ast, :type => 'ruby_block').find_all do |rb|
-      ! rb.xpath("//fcall[ident/@value='block' and count(ancestor::*) = 8]/../../do_block[count(descendant::*) > 100]").empty?
-    end.map{|block| match(block)}
+      ! rb.xpath("//fcall[ident/@value='block' and count(ancestor::*) = 8]/../
+                  ../do_block[count(descendant::*) > 100]").empty?
+    end
   end
 end
 
 rule "FC015", "Consider converting definition to a LWRP" do
   tags %w{style definitions lwrp}
   cookbook do |dir|
-    Dir[File.join(dir, 'definitions', '*.rb')].reject{|entry| ['.', '..'].include? entry}.map{|entry| file_match(entry)}
+    Dir[File.join(dir, 'definitions', '*.rb')].reject do |entry|
+      ['.', '..'].include? entry
+    end.map{|entry| file_match(entry)}
   end
 end
 
 rule "FC016", "LWRP does not declare a default action" do
   tags %w{correctness lwrp}
   resource do |ast, filename|
-    ast.xpath("//def/bodystmt/descendant::assign/var_field/ivar/@value='@action'") ? [] : [file_match(filename)]
+    unless ["//ident/@value='default_action'",
+     "//def/bodystmt/descendant::assign/
+      var_field/ivar/@value='@action'"].any? {|expr| ast.xpath(expr)}
+      [file_match(filename)]
+    end
   end
 end
 
 rule "FC017", "LWRP does not notify when updated" do
   tags %w{correctness lwrp}
   provider do |ast, filename|
-    if ast.xpath(%q{//call/*[self::vcall or self::var_ref/ident/@value='new_resource']/../
-      ident[@value='updated_by_last_action']}).empty?
+    if ast.xpath(%q{//call/*[self::vcall or self::var_ref/ident/
+                 @value='new_resource']/../
+                 ident[@value='updated_by_last_action']}).empty?
       [file_match(filename)]
     end
   end
@@ -172,24 +207,34 @@ end
 rule "FC018", "LWRP uses deprecated notification syntax" do
   tags %w{style lwrp deprecated}
   provider do |ast|
-    ast.xpath("//assign/var_field/ivar[@value='@updated']").map{|class_var| match(class_var)} +
-    ast.xpath(%q{//assign/field/*[self::vcall or self::var_ref/ident/@value='new_resource']/../
-      ident[@value='updated']}).map{|assign| match(assign)}
+    ast.xpath("//assign/var_field/ivar[@value='@updated']").map do |class_var|
+      match(class_var)
+    end + ast.xpath(%q{//assign/field/*[self::vcall or self::var_ref/ident/
+                       @value='new_resource']/../ident[@value='updated']})
   end
 end
 
 rule "FC019", "Access node attributes in a consistent manner" do
   tags %w{style attributes}
   cookbook do |cookbook_dir|
-    asts = {}; files = Dir["#{cookbook_dir}/*/*.rb"].map{|file| {:path => file, :ast => read_ast(file)}}
-    types = [:string, :symbol, :vivified].map{|type| {:access_type => type, :count => files.map do |file|
-      attribute_access(file[:ast], :type => type, :ignore_calls => true).tap{|ast|
-        asts[type] = {:ast => ast, :path => file[:path]} if (! ast.empty?) and (! asts.has_key?(type))
-      }.size
-    end.inject(:+)}}.reject{|type| type[:count] == 0}
+    asts = {}; files = Dir["#{cookbook_dir}/*/*.rb"].map do |file|
+      {:path => file, :ast => read_ast(file)}
+    end
+    types = [:string, :symbol, :vivified].map do |type|
+      {:access_type => type, :count => files.map do |file|
+        attribute_access(file[:ast], :type => type,
+                         :ignore_calls => true).tap do |ast|
+          if (! ast.empty?) and (! asts.has_key?(type))
+            asts[type] = {:ast => ast, :path => file[:path]}
+          end
+        end.size
+      end.inject(:+)}
+    end.reject{|type| type[:count] == 0}
     if asts.size > 1
       least_used = asts[types.min{|a,b| a[:count] <=> b[:count]}[:access_type]]
-      least_used[:ast].map{|ast| match(ast).merge(:filename => least_used[:path])}
+      least_used[:ast].map do |ast|
+        match(ast).merge(:filename => least_used[:path])
+      end
     end
   end
 end
@@ -197,13 +242,18 @@ end
 rule "FC020", "Conditional execution string attribute looks like Ruby" do
   tags %w{correctness}
   recipe do |ast, filename|
-    conditions = ast.xpath(%q{//command[(ident/@value='only_if' or ident/@value='not_if') and
-      descendant::tstring_content]}).map{|m| match(m)}
+    conditions = ast.xpath(%q{//command[(ident/@value='only_if' or ident/
+      @value='not_if') and descendant::tstring_content]}).map{|m| match(m)}
     unless conditions.empty?
-      lines = File.readlines(filename) # go back and get the raw untokenized string
+      lines = File.readlines(filename) # go back for the raw untokenized string
       conditions.map do |condition|
-        {:match => condition, :raw_string => lines[(condition[:line].to_i) -1].strip.sub(/^(not|only)_if[\s+]["']/, '').chop}
-      end.find_all{|cond| ruby_code?(cond[:raw_string]) and ! os_command?(cond[:raw_string])}.map{|cond| cond[:match]}
+        line = lines[(condition[:line].to_i) -1]
+        {:match => condition,
+         :raw_string => line.strip.sub(/^(not|only)_if[\s+]["']/, '').chop}
+      end.find_all do |cond|
+        ruby_code?(cond[:raw_string]) and
+          ! os_command?(cond[:raw_string])
+      end.map{|cond| cond[:match]}
     end
   end
 end
@@ -212,10 +262,12 @@ rule "FC021", "Resource condition in provider may not behave as expected" do
   tags %w{correctness lwrp}
   provider do |ast|
     find_resources(ast).map do |resource|
-      condition = resource.xpath(%q{//method_add_block/descendant::ident[@value='not_if' or @value='only_if']/
-        ancestor::*[self::method_add_block or self::command][1][descendant::ident/@value='new_resource']/
-        ancestor::stmts_add[2]/method_add_block/command[count(descendant::string_embexpr) = 0]})
-      match(condition) unless condition.empty?
+      condition = resource.xpath(%q{//method_add_block/
+        descendant::ident[@value='not_if' or @value='only_if']/
+        ancestor::*[self::method_add_block or self::command][1][descendant::
+        ident/@value='new_resource']/ancestor::stmts_add[2]/method_add_block/
+        command[count(descendant::string_embexpr) = 0]})
+      condition
     end.compact
   end
 end
@@ -224,12 +276,18 @@ rule "FC022", "Resource condition within loop may not behave as expected" do
   tags %w{correctness}
   recipe do |ast|
     ast.xpath("//call[ident/@value='each']/../do_block").map do |loop|
-      block_vars = loop.xpath("block_var/params/child::*").map{|n| n.name.sub(/^ident/, '')}
+      block_vars = loop.xpath("block_var/params/child::*").map do |n|
+        n.name.sub(/^ident/, '')
+      end
       find_resources(loop).map do |resource|
-        # if any of the parameters to the block are used in a condition then we have a match
-        unless (block_vars & (resource.xpath(%q{descendant::ident[@value='not_if' or @value='only_if']/
-          ancestor::*[self::method_add_block or self::command][1]/descendant::ident/@value}).map{|a| a.value})).empty?
-          match(resource) unless resource.xpath('command[count(descendant::string_embexpr) = 0]').empty?
+        # if any of the parameters to the block are used in a condition then we
+        # have a match
+        unless (block_vars &
+          (resource.xpath(%q{descendant::ident[@value='not_if' or
+          @value='only_if']/ancestor::*[self::method_add_block or
+          self::command][1]/descendant::ident/@value}).map{|a| a.value})).empty?
+          c = resource.xpath('command[count(descendant::string_embexpr) = 0]')
+          resource unless c.empty?
         end
       end
     end.flatten.compact
@@ -243,6 +301,26 @@ rule "FC023", "Prefer conditional attributes" do
       [@value='only_if' or @value='not_if']) = 0]/ancestor::*[self::if or
       self::unless][count(descendant::method_add_block[command/ident]) = 1]
       [count(stmts_add/method_add_block/call) = 0]
-      [count(stmts_add/stmts_add) = 0]}).map{|condition| match(condition)}
+      [count(stmts_add/stmts_add) = 0]})
+  end
+end
+
+rule "FC024", "Consider adding platform equivalents" do
+  tags %w{portability}
+  RHEL = %w{amazon centos redhat scientific}
+  recipe do |ast|
+    ['//method_add_arg[fcall/ident/@value="platform?"]/arg_paren/args_add_block',
+     "//when"].map do |expr|
+      ast.xpath(expr).map do |whn|
+        platforms = whn.xpath("args_add/descendant::tstring_content").map do |p|
+          p['value']
+        end
+        unless platforms.size == 1 || (RHEL & platforms).empty?
+          unless (RHEL - platforms).empty?
+            whn
+          end
+        end
+      end.compact
+    end.flatten
   end
 end

data/lib/foodcritic/version.rb

@@ -1,4 +1,4 @@
 module FoodCritic
   # The current version of foodcritic
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-15 00:00:00.000000000 Z
+date: 2012-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
-  requirement: &2158578500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 2.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *2158578500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: gist
-  requirement: &2158577320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,21 +37,43 @@ dependencies:
         version: 2.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2158577320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2158576420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.0
+    - - ! '!='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    - - ! '!='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *2158576420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - ! '!='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    - - ! '!='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2158592160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +81,15 @@ dependencies:
         version: 0.9.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *2158592160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7.4
 - !ruby/object:Gem::Dependency
   name: pry-doc
-  requirement: &2158591020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +97,15 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2158591020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rak
-  requirement: &2158589520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +113,15 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2158589520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: treetop
-  requirement: &2158587600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +129,15 @@ dependencies:
         version: 1.4.10
   type: :runtime
   prerelease: false
-  version_requirements: *2158587600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.10
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2158585060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +145,12 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2158585060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -118,7 +170,8 @@ files:
 - lib/foodcritic/version.rb
 - lib/foodcritic.rb
 - chef_dsl_metadata.json
-- bin/foodcritic
+- !binary |-
+  YmluL2Zvb2Rjcml0aWM=
 homepage: http://acrmp.github.com/foodcritic
 licenses:
 - MIT
@@ -140,12 +193,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1104674546192512952
+      hash: -4140544099475579299
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: foodcritic-1.0.1
+summary: foodcritic-1.1.0
 test_files: []
 has_rdoc: