foodcritic 1.1.0 → 1.2.0

data/lib/foodcritic/api.rb

@@ -117,7 +117,17 @@ module FoodCritic
       return [] unless ast.respond_to?(:xpath)
       scope_type = ''
       scope_type = "[@value='#{options[:type]}']" unless options[:type] == :any
-      ast.xpath("//method_add_block[command/ident#{scope_type}]")
+      # XXX: include nested resources (provider actions)
+      no_actions = "[command/ident/@value != 'action']"
+      ast.xpath("//method_add_block[command/ident#{scope_type}]#{no_actions}")
+    end
+
+    # Helper to return a comparable version for a string.
+    #
+    # @param [String] version The version
+    # @return [Gem::Version] The comparable version
+    def gem_version(version)
+      Gem::Version.create(version)
     end
 
     # Retrieve the recipes that are included within the given recipe AST.
@@ -127,8 +137,9 @@ module FoodCritic
     def included_recipes(ast)
       raise_unless_xpath!(ast)
       # we only support literal strings, ignoring sub-expressions
-      included = ast.xpath(%q{//command[ident/@value = 'include_recipe' and
-        count(descendant::string_embexpr) = 0]/descendant::tstring_content})
+      included = ast.xpath(%q{//command[ident/@value = 'include_recipe'][count(
+        descendant::args_add) = 1][descendant::args_add/string_literal]/
+        descendant::tstring_content})
       included.inject(Hash.new([])){|h, i| h[i['value']] += [i]; h}
     end
 
@@ -213,6 +224,13 @@ module FoodCritic
         end
         atts[att.xpath('string(ident/@value)')] = att_value
       end
+      resource.xpath("do_block/descendant::method_add_block[
+        count(ancestor::do_block) = 1][brace_block | do_block]").each do |batt|
+          att_name = batt.xpath('string(method_add_arg/fcall/ident/@value)')
+          if att_name and ! att_name.empty? and batt.children.length > 1
+            atts[att_name] = batt.children[1]
+          end
+      end
       atts
     end
 
@@ -316,9 +334,20 @@ module FoodCritic
             xml_node.add_child(pos)
           else
             if child.respond_to?(:first)
-              n = Nokogiri::XML::Node.new(
-                child.first.to_s.gsub(/[^a-z_]/, ''), doc)
-              xml_node.add_child(build_xml(child, doc, n))
+              if child.first.respond_to?(:first) and
+                 child.first.first == :assoc_new
+                child.each do |c|
+                  n = Nokogiri::XML::Node.new(
+                    c.first.to_s.gsub(/[^a-z_]/, ''), doc)
+                  c.drop(1).each do |a|
+                    xml_node.add_child(build_xml(a, doc, n))
+                  end
+                end
+              else
+                n = Nokogiri::XML::Node.new(
+                  child.first.to_s.gsub(/[^a-z_]/, ''), doc)
+                xml_node.add_child(build_xml(child, doc, n))
+              end
             else
               xml_node['value'] = child.to_s unless child.nil?
             end
@@ -349,6 +378,7 @@ module FoodCritic
       expr += '[is_att_type(descendant::ident'
       expr += '[not(ancestor::aref/call)]' if options[:ignore_calls]
       expr += "/@value)]/descendant::#{type}"
+      expr += "[ident/@value != 'node']" if type == :symbol
       ast.xpath(expr, AttFilter.new).sort
     end
 

data/lib/foodcritic/command_line.rb

@@ -24,6 +24,10 @@ module FoodCritic
           "Fail the build if any of the specified tags are matched.") do |t|
           options[:fail_tags] << t
         end
+        opts.on("-c", "--chef-version VERSION",
+          "Only check against rules valid for this version of Chef.") do |c|
+          options[:chef_version] = c
+        end
         opts.on("-C", "--[no-]context",
           "Show lines matched against rather than the default summary.") do |c|
           options[:context] = c
@@ -37,7 +41,7 @@ module FoodCritic
           options[:search_grammar] = s
         end
         opts.on("-V", "--version",
-          "Display version.") do |v|
+          "Display the foodcritic version.") do |v|
           options[:version] = true
         end
       end

data/lib/foodcritic/domain.rb

@@ -57,7 +57,7 @@ module FoodCritic
 
   # A rule to be matched against.
   class Rule
-    attr_accessor :code, :name, :cookbook, :recipe, :provider, :resource
+    attr_accessor :code, :name, :applies_to, :cookbook, :recipe, :provider, :resource
     attr_writer :tags
 
     # Create a new rule
@@ -69,6 +69,7 @@ module FoodCritic
     def initialize(code, name)
       @code, @name = code, name
       @tags = [code]
+      @applies_to = Proc.new {|version| true}
     end
 
     # The tags associated with this rule.

data/lib/foodcritic/dsl.rb

@@ -29,6 +29,13 @@ module FoodCritic
       rules.last.tags += tags
     end
 
+    # Limit the versions that this rule can be seen to apply to.
+    #
+    # @param [block] block Your version constraint logic.
+    def applies_to(&block)
+      rules.last.applies_to = block
+    end
+
     # Define a matcher that will be passed the AST with this method.
     #
     # @param [block] block Your implemented matcher that returns a match Hash.

data/lib/foodcritic/linter.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 require 'ripper'
+require 'rubygems'
 require 'gherkin/tag_expression'
 require 'set'
 
@@ -10,6 +11,9 @@ module FoodCritic
 
     include FoodCritic::Api
 
+    # The default version that will be used to determine relevant rules
+    DEFAULT_CHEF_VERSION = "0.10.8"
+
     # Perform option parsing from the provided arguments and do a lint check
     # based on those arguments.
     #
@@ -51,8 +55,10 @@ module FoodCritic
       load_rules unless defined? @rules
       warnings = []; last_dir = nil; matched_rule_tags = Set.new
 
-      active_rules = @rules.select{|rule| matching_tags?(options[:tags],
-        rule.tags)}
+      active_rules = @rules.select do |rule|
+        matching_tags?(options[:tags], rule.tags) and
+        applies_to_version?(rule, options[:chef_version] || DEFAULT_CHEF_VERSION)
+      end
       files_to_process(cookbook_path).each do |file|
         cookbook_dir = Pathname.new(
           File.join(File.dirname(file), '..')).cleanpath
@@ -107,6 +113,16 @@ module FoodCritic
 
     private
 
+    # Some rules are version specific.
+    #
+    # @param [FoodCritic::Rule] rule The rule determine applicability for
+    # @param [String] version The version of Chef
+    # @return [Boolean] True if the rule applies to this version of Chef
+    def applies_to_version?(rule, version)
+      return true unless version
+      rule.applies_to.yield(Gem::Version.create(version))
+    end
+
     # Invoke the DSL method with the provided parameters.
     #
     # @param [Proc] match_method Proc to invoke

data/lib/foodcritic/rules.rb

@@ -9,9 +9,9 @@ end
 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]})
+    ast.xpath(%q{//*[self::string_literal | self::assoc_new]/string_add[
+      count(descendant::string_embexpr) = 1 and
+      count(tstring_content|string_add/tstring_content) = 0]})
   end
 end
 
@@ -31,10 +31,10 @@ 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 ')
+      (cmd_str.include?('/etc/init.d') || ['service ', '/sbin/service ',
+       'start ', 'stop ', 'invoke-rc.d '].any? do |service_cmd|
+          cmd_str.start_with?(service_cmd)
+        end) && %w{start stop restart reload}.any?{|a| cmd_str.include?(a)}
     end
   end
 end
@@ -45,7 +45,14 @@ rule "FC005", "Avoid repetition of resource declarations" do
     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}
+    end.chunk do |res|
+      res[:type] +
+      res[:ast].xpath("ancestor::*[self::if | self::unless | self::elsif |
+        self::else | self::when | self::method_add_block/call][position() = 1]/
+        descendant::pos[position() = 1]").to_s +
+      res[:ast].xpath("ancestor::method_add_block/command[
+        ident/@value='action']/args_add_block/descendant::ident/@value").to_s
+    end.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
@@ -175,6 +182,7 @@ end
 
 rule "FC015", "Consider converting definition to a LWRP" do
   tags %w{style definitions lwrp}
+  applies_to {|version| version >= gem_version("0.7.12")}
   cookbook do |dir|
     Dir[File.join(dir, 'definitions', '*.rb')].reject do |entry|
       ['.', '..'].include? entry
@@ -184,6 +192,7 @@ end
 
 rule "FC016", "LWRP does not declare a default action" do
   tags %w{correctness lwrp}
+  applies_to {|version| version >= gem_version("0.7.12")}
   resource do |ast, filename|
     unless ["//ident/@value='default_action'",
      "//def/bodystmt/descendant::assign/
@@ -195,6 +204,9 @@ end
 
 rule "FC017", "LWRP does not notify when updated" do
   tags %w{correctness lwrp}
+  applies_to do |version|
+    version >= gem_version("0.7.12")
+  end
   provider do |ast, filename|
     if ast.xpath(%q{//call/*[self::vcall or self::var_ref/ident/
                  @value='new_resource']/../
@@ -206,6 +218,7 @@ end
 
 rule "FC018", "LWRP uses deprecated notification syntax" do
   tags %w{style lwrp deprecated}
+  applies_to {|version| version >= gem_version("0.9.10")}
   provider do |ast|
     ast.xpath("//assign/var_field/ivar[@value='@updated']").map do |class_var|
       match(class_var)
@@ -241,6 +254,7 @@ end
 
 rule "FC020", "Conditional execution string attribute looks like Ruby" do
   tags %w{correctness}
+  applies_to {|version| version >= gem_version("0.7.4")}
   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)}
@@ -260,6 +274,7 @@ end
 
 rule "FC021", "Resource condition in provider may not behave as expected" do
   tags %w{correctness lwrp}
+  applies_to {|version| version >= gem_version("0.10.6")}
   provider do |ast|
     find_resources(ast).map do |resource|
       condition = resource.xpath(%q{//method_add_block/
@@ -274,6 +289,7 @@ end
 
 rule "FC022", "Resource condition within loop may not behave as expected" do
   tags %w{correctness}
+  applies_to {|version| version >= gem_version("0.10.6")}
   recipe do |ast|
     ast.xpath("//call[ident/@value='each']/../do_block").map do |loop|
       block_vars = loop.xpath("block_var/params/child::*").map do |n|
@@ -301,7 +317,8 @@ 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]})
+      [count(stmts_add/stmts_add) = 0]
+      [count(descendant::*[self::else or self::elsif]) = 0]})
   end
 end
 
@@ -324,3 +341,21 @@ rule "FC024", "Consider adding platform equivalents" do
     end.flatten
   end
 end
+
+rule "FC025", "Prefer chef_gem to compile-time gem install" do
+  tags %w{style deprecated}
+  applies_to {|version| version >= gem_version("0.10.10")}
+  recipe do |ast|
+    gem_install = ast.xpath("//stmts_add/assign[method_add_block[command/ident/
+      @value='gem_package'][do_block/stmts_add/command[ident/@value='action']
+      [descendant::ident/@value='nothing']]]")
+    gem_install.map do |install|
+      gem_var = install.xpath("var_field/ident/@value")
+      unless ast.xpath("//method_add_arg[call/var_ref/ident/@value='#{gem_var}']
+        [arg_paren/descendant::ident/@value='install' or
+         arg_paren/descendant::ident/@value='upgrade']").empty?
+        gem_install
+      end
+    end
+  end
+end

data/lib/foodcritic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000 Z
+date: 2012-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -193,12 +193,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4140544099475579299
+      hash: 700162912727168001
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: foodcritic-1.1.0
+summary: foodcritic-1.2.0
 test_files: []
 has_rdoc: