foodcritic 1.3.1 → 1.4.0

data/lib/foodcritic/api.rb

@@ -36,7 +36,7 @@ module FoodCritic
     #   Chef::Config['solo'] in the recipe
     def checks_for_chef_solo?(ast)
       raise_unless_xpath!(ast)
-      ! ast.xpath(%q{//if/aref[count(descendant::const[@value = 'Chef' or
+      ! ast.xpath(%q{//if/*[self::aref or self::call][count(descendant::const[@value = 'Chef' or
           @value = 'Config']) = 2
           and
             (   count(descendant::ident[@value='solo']) > 0
@@ -137,13 +137,22 @@ module FoodCritic
     # Retrieve the recipes that are included within the given recipe AST.
     #
     # @param [Nokogiri::XML::Node] ast The recipe AST
+    # @param [Hash] options Options to filter recipes to include
+    # @option [Symbol] :with_partial_names Include string literals for recipes
+    #   that have an embedded sub-expression.
     # @return [Hash] include_recipe nodes keyed by included recipe name
-    def included_recipes(ast)
+    def included_recipes(ast, options = {:with_partial_names => true})
       raise_unless_xpath!(ast)
+
+      filter = ['[count(descendant::args_add) = 1]']
+      unless options[:with_partial_names]
+        filter << '[count(descendant::string_embexpr) = 0]'
+      end
+
       # we only support literal strings, ignoring sub-expressions
-      included = ast.xpath(%q{//command[ident/@value = 'include_recipe'][count(
-        descendant::args_add) = 1][descendant::args_add/string_literal]/
-        descendant::tstring_content})
+      included = ast.xpath(%Q{//command[ident/@value = 'include_recipe']
+        #{filter.join}
+        [descendant::args_add/string_literal]/descendant::tstring_content})
       included.inject(Hash.new([])){|h, i| h[i['value']] += [i]; h}
     end
 
@@ -179,6 +188,61 @@ module FoodCritic
        :line => pos['line'].to_i, :column => pos['column'].to_i}
     end
 
+    # Decode resource notifications.
+    #
+    # @param [Nokogiri::XML::Node] ast The AST to check for notifications.
+    # @return [Array] A flat array of notifications. The resource_name may be
+    #   a string or a Node if the resource name is an expression.
+    def notifications(ast)
+      return [] unless ast.respond_to?(:xpath)
+      ast.xpath('descendant::command[ident/@value="notifies" or
+        ident/@value="subscribes"]').map do |notifies|
+
+        params = notifies.xpath('descendant::method_add_arg[fcall/ident/
+          @value="resources"]/descendant::assoc_new')
+        timing = notifies.xpath('args_add_block/args_add/symbol_literal[last()]/
+          symbol/ident[1]/@value')
+        if params.empty?
+          target = notifies.xpath('args_add_block/args_add/
+            descendant::tstring_content/@value').to_s
+          match = target.match(/^([^\[]+)\[(.*)\]$/)
+          next unless match
+          resource_type, resource_name =
+            match.captures.tap{|m| m[0] = m[0].to_sym}
+          if notifies.xpath('descendant::string_embexpr').empty?
+            next if resource_name.empty?
+          else
+            resource_name =
+              notifies.xpath('args_add_block/args_add/string_literal')
+          end
+        else
+          resource_type = params.xpath('symbol[1]/ident/@value').to_s.to_sym
+          resource_name = params.xpath('string_add[1][count(../
+            descendant::string_add) = 1]/tstring_content/@value').to_s
+          resource_name = params if resource_name.empty?
+        end
+        {
+          :type =>
+            notifies.xpath('ident/@value[1]').to_s.to_sym,
+          :resource_type => resource_type,
+          :resource_name => resource_name,
+          :style => params.empty? ? :new : :old,
+          :action =>
+            notifies.xpath('descendant::symbol[1]/ident/@value').to_s.to_sym,
+          :timing =>
+            if timing.empty?
+              :delayed
+            else
+              case timing.first.to_s.to_sym
+                when :immediately, :immediate then :immediate
+                else timing.first.to_s.to_sym
+              end
+            end
+        }
+
+      end.compact
+    end
+
     # Does the provided string look like an Operating System command? This is a
     # rough heuristic to be taken with a pinch of salt.
     #
@@ -224,6 +288,10 @@ module FoodCritic
         att_value =
           if ! att.xpath('args_add_block[count(descendant::args_add)>1]').empty?
             att.xpath('args_add_block').first
+          elsif ! att.xpath('args_add_block/args_add/
+            var_ref/kw[@value="true" or @value="false"]').empty?
+            att.xpath('string(args_add_block/args_add/
+              var_ref/kw/@value)') == 'true'
           elsif att.xpath('descendant::symbol').empty?
             att.xpath('string(descendant::tstring_content/@value)')
           else
@@ -406,8 +474,8 @@ module FoodCritic
 
     def vivified_attribute_access(ast, cookbook_dir)
       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)
+        [is_att_type(vcall/ident/@value) or is_att_type(var_ref/ident/@value)]
+        [@value='.'][count(following-sibling::arg_paren) = 0]}, AttFilter.new)
       calls.select do |call|
         call.xpath("aref/args_add_block").size == 0 and
           (call.xpath("descendant::ident").size > 1 and

data/lib/foodcritic/linter.rb

@@ -78,7 +78,7 @@ module FoodCritic
             rule_matches += matches(rule.provider, ast, file)
           end
           if File.basename(File.dirname(file)) == 'resources'
-          rule_matches += matches(rule.resource, ast, file)
+            rule_matches += matches(rule.resource, ast, file)
           end
           if last_dir != cookbook_dir
             rule_matches += matches(rule.cookbook, cookbook_dir)

data/lib/foodcritic/rules.rb

@@ -85,11 +85,12 @@ rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
     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|
+    actual_included = included_recipes(ast, :with_partial_names => false)
+    undeclared = actual_included.keys.map do |recipe|
       recipe.split('::').first
     end - [cookbook_name(filename)] -
         declared_dependencies(read_ast(metadata_path))
-    included_recipes(ast).map do |recipe, include_stmts|
+    actual_included.map do |recipe, include_stmts|
       if undeclared.include?(recipe) ||
          undeclared.any?{|u| recipe.start_with?("#{u}::")}
         include_stmts
@@ -378,3 +379,79 @@ rule "FC026", "Conditional execution block attribute contains only string" do
     end
   end
 end
+
+rule "FC027", "Resource sets internal attribute" do
+  tags %w{correctness}
+  recipe do |ast|
+    find_resources(ast, :type => :service).map do |service|
+      service unless (resource_attributes(service).keys &
+                        ['enabled', 'running']).empty?
+    end.compact
+  end
+end
+
+rule "FC028", "Incorrect #platform? usage" do
+  tags %w{correctness}
+  recipe do |ast|
+    ast.xpath(%q{//*[self::call | self::command_call]
+      [(var_ref|vcall)/ident/@value='node']
+      [ident/@value="platform?"]})
+  end
+end
+
+rule "FC029", "No leading cookbook name in recipe metadata" do
+  tags %w{correctness metadata}
+  cookbook do |filename|
+    metadata_path = Pathname.new(File.join(filename, 'metadata.rb')).cleanpath
+    next unless File.exists? metadata_path
+    read_ast(metadata_path).xpath('//command[ident/@value="recipe"]').map do |declared_recipe|
+      next unless declared_recipe.xpath('count(//vcall|//var_ref)').to_i == 0
+      recipe_name = declared_recipe.xpath('args_add_block/
+        descendant::tstring_content[1]/@value').to_s
+      unless recipe_name.empty? ||
+        recipe_name.split('::').first == cookbook_name(filename.to_s)
+          declared_recipe
+      end
+    end.compact.map {|m| match(m).merge(:filename => metadata_path.to_s) }
+  end
+end
+
+rule "FC030", "Cookbook contains debugger breakpoints" do
+  tags %w{annoyances}
+  cookbook do |cookbook_dir|
+    Dir[cookbook_dir + '**/*.rb'].map do |ruby_file|
+      read_ast(ruby_file).xpath('//call[(vcall|var_ref)/ident/@value="binding"]
+        [ident/@value="pry"]').map do |bp|
+        match(bp).merge({:filename => ruby_file})
+      end
+    end +
+    Dir[cookbook_dir + 'templates/**/*.erb'].map do |template_file|
+      IO.read(template_file).lines.with_index(1).map do |line, line_number|
+        # Not properly parsing the template
+        if line =~ /binding\.pry/
+          {:filename => template_file, :line => line_number}
+        end
+      end.compact
+    end
+  end
+end
+
+rule "FC031", "Cookbook without metadata file" do
+  tags %w{correctness metadata}
+  cookbook do |filename|
+    if ! File.exists?(File.join(filename, 'metadata.rb'))
+      [file_match(File.join(filename, 'metadata.rb'))]
+    end
+  end
+end
+
+rule "FC032", "Invalid notification timing" do
+  tags %w{correctness notifications}
+  recipe do |ast|
+    find_resources(ast).select do |resource|
+      notifications(resource).any? do |notification|
+        ! [:delayed, :immediate].include? notification[:timing]
+      end
+    end
+  end
+end

data/lib/foodcritic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-10 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -181,12 +181,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2247396416415780367
+      hash: -3352294596244898334
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: foodcritic-1.3.1
+summary: foodcritic-1.4.0
 test_files: []
 has_rdoc: