foodcritic 1.7.0 → 2.0.0

data/lib/foodcritic.rb

@@ -1,7 +1,6 @@
 require 'pathname'
 require 'gherkin'
 require 'treetop'
-require 'pry'
 require 'rak'
 require 'ripper'
 require 'yajl'
@@ -15,7 +14,6 @@ require_relative 'foodcritic/notifications'
 require_relative 'foodcritic/ast'
 require_relative 'foodcritic/xml'
 require_relative 'foodcritic/api'
-require_relative 'foodcritic/repl'
 require_relative 'foodcritic/dsl'
 require_relative 'foodcritic/linter'
 require_relative 'foodcritic/output'

data/lib/foodcritic/api.rb

@@ -34,16 +34,18 @@ module FoodCritic
     # Does the specified recipe check for Chef Solo?
     def checks_for_chef_solo?(ast)
       raise_unless_xpath!(ast)
-
       # TODO: This expression is too loose, but also will fail to match other
       # types of conditionals.
-      ! ast.xpath(%q{//*[self::if or self::unless]/*[self::aref or self::call]
+      (! ast.xpath(%q{//*[self::if or self::unless]/*[self::aref or
+        child::aref or self::call]
         [count(descendant::const[@value = 'Chef' or @value = 'Config']) = 2
           and
             (   count(descendant::ident[@value='solo']) > 0
             or  count(descendant::tstring_content[@value='solo']) > 0
             )
-          ]}).empty?
+          ]}).empty?) ||
+      ast.xpath('//if_mod[return][aref/descendant::ident/@value="solo"]/aref/
+        const_path_ref/descendant::const').map{|c|c['value']} == %w{Chef Config}
     end
 
     # Is the [chef-solo-search library](https://github.com/edelight/chef-solo-search)
@@ -105,12 +107,7 @@ module FoodCritic
       #     %w{foo bar baz}.each do |cbk|
       #       depends cbk
       #     end
-      var_ref = ast.xpath(%q{//command[ident/@value='depends']/
-        descendant::var_ref/ident})
-      unless var_ref.empty?
-        deps += ast.xpath(%Q{//block_var/params/ident#{var_ref.first['value']}/
-          ancestor::method_add_block/call/descendant::tstring_content})
-      end
+      deps = deps.to_a + word_list_values(ast, "//command[ident/@value='depends']")
       deps.map{|dep| dep['value']}
     end
 
@@ -191,16 +188,6 @@ module FoodCritic
        :line => pos['line'].to_i, :column => pos['column'].to_i}
     end
 
-    # Does the provided string look like an Operating System command? This is a
-    # rough heuristic to be taken with a pinch of salt.
-    def os_command?(str)
-      str.start_with?('grep ', 'net ', 'which ') or # common commands
-      str.include?('|') or     # a pipe, could be alternation
-      str.include?('/') or     # file path delimiter
-      str.match(/^[\w]+$/) or  # command name only
-      str.match(/ --?[a-z]/i)  # command-line flag
-    end
-
     # Read the AST for the given Ruby source file
     def read_ast(file)
       source = if file.to_s.end_with? '.erb'
@@ -298,6 +285,20 @@ module FoodCritic
          templates}
     end
 
+    # Platforms declared as supported in cookbook metadata
+    def supported_platforms(ast)
+      platforms = ast.xpath('//command[ident/@value="supports"]/
+        descendant::*[self::string_literal or self::symbol_literal][position() = 1]
+        [self::symbol_literal or count(descendant::string_add) = 1]/
+        descendant::*[self::tstring_content | self::ident]')
+      platforms = platforms.to_a + word_list_values(ast, "//command[ident/@value='supports']")
+      platforms.map do |platform|
+        versions = platform.xpath('ancestor::args_add[position() > 1]/
+	  string_literal/descendant::tstring_content/@value').map{|v| v.to_s}
+        {:platform => platform['value'], :versions => versions}
+      end.sort{|a,b| a[:platform] <=> b[:platform]}
+    end
+
     # Template filename
     def template_file(resource)
       if resource['source']
@@ -441,13 +442,20 @@ module FoodCritic
           standard_attribute_access(ast, options.merge(:type => type))
         end.inject(:+)
       else
-        type = options[:type] == :string ? 'tstring_content' : options[:type]
-        expr = '//*[self::aref_field or self::aref]'
-        expr += '[count(descendant::aref/var_ref) = 0]'
+        type = if options[:type] == :string
+	         'tstring_content'
+	       else
+                 '*[self::symbol or self::dyna_symbol]'
+	       end
+        expr = '//*[self::aref_field or self::aref][count(method_add_arg) = 0]'
+        expr += '[count(is_att_type(descendant::var_ref/ident/@value)) =
+          count(descendant::var_ref/ident/@value)]'
         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
+	if options[:type] == :string
+          expr += '[count(ancestor::dyna_symbol) = 0]'
+        end
         ast.xpath(expr, AttFilter.new).sort
       end
     end
@@ -463,6 +471,16 @@ module FoodCritic
       end.sort
     end
 
+    def word_list_values(ast, xpath)
+      var_ref = ast.xpath("#{xpath}/descendant::var_ref/ident")
+      if var_ref.empty?
+        []
+      else
+        ast.xpath(%Q{descendant::block_var/params/ident#{var_ref.first['value']}/
+          ancestor::method_add_block/call/descendant::tstring_content})
+      end
+    end
+
   end
 
 end

data/lib/foodcritic/command_line.rb

@@ -12,16 +12,12 @@ module FoodCritic
       @options = {:fail_tags => [], :tags => [], :include_rules => []}
       @parser = OptionParser.new do |opts|
         opts.banner = 'foodcritic [cookbook_paths]'
-        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|
+          "Fail the build if any of the specified tags are matched ('any' -> fail on any match).") do |t|
           options[:fail_tags] << t
         end
         opts.on("-c", "--chef-version VERSION",
@@ -86,14 +82,6 @@ module FoodCritic
       "foodcritic #{FoodCritic::VERSION}"
     end
 
-    # If the cookbook path provided is valid
-    #
-    # @deprecated Multiple cookbook paths may be provided.
-    # @return [Boolean] True if the path exists.
-    def valid_path?
-      @args.length == 1 and File.exists?(@args[0])
-    end
-
     # If the cookbook paths provided are valid
     #
     # @return [Boolean] True if the paths exist.
@@ -101,14 +89,6 @@ module FoodCritic
       @args.any? && @args.all? {|path| File.exists?(path) }
     end
 
-    # The cookbook path.
-    #
-    # @deprecated Multiple cookbook paths may be provided.
-    # @return [String] Path to the cookbook(s) being checked.
-    def cookbook_path
-      @args[0]
-    end
-
     # The cookbook paths
     #
     # @return [Array<String>] Path(s) to the cookbook(s) being checked.

data/lib/foodcritic/domain.rb

@@ -25,12 +25,6 @@ module FoodCritic
       @is_failed = is_failed
     end
 
-    # Provided for backwards compatibility. Deprecated and will be removed in a
-    # later version.
-    def cookbook_path
-      @cookbook_paths.first
-    end
-
     # If this review has failed or not.
     def failed?
       @is_failed

data/lib/foodcritic/dsl.rb

@@ -65,17 +65,13 @@ module FoodCritic
     rule_block :template
 
     # Load the ruleset(s).
-    def self.load(paths, with_repl)
+    def self.load(paths)
       dsl = RuleDsl.new
       paths.map do |path|
         File.directory?(path) ? Dir["#{path}/**/*.rb"].sort : path
       end.flatten.each do |path|
         dsl.instance_eval(File.read(path), path)
       end
-
-      # Drop into the REPL for exploratory rule development.
-      dsl.instance_eval { binding.pry } if with_repl
-
       dsl.rules
     end
 

data/lib/foodcritic/linter.rb

@@ -9,7 +9,6 @@ module FoodCritic
   class Linter
 
     include FoodCritic::Api
-    include FoodCritic::REPL
 
     # The default version that will be used to determine relevant rules. This
     # can be over-ridden at the command line with the `--chef-version` option.
@@ -47,57 +46,73 @@ module FoodCritic
 
       cookbook_paths = sanity_check_cookbook_paths(cookbook_paths)
       options = setup_defaults(options)
+      @options = options
 
-      # Enable checks to be easily repeated at the REPL
-      with_repl(cookbook_paths, options) do
-        warnings = []; last_dir = nil; matched_rule_tags = Set.new
+      warnings = []; last_dir = nil; matched_rule_tags = Set.new
 
-        load_rules
+      load_rules
 
-        # Loop through each file to be processed and apply the rules
-        files_to_process(cookbook_paths, options[:exclude_paths]).each do |file|
-          ast = read_ast(file)
-          active_rules(options).each do |rule|
-            rule_matches = matches(rule.recipe, ast, file)
+      # Loop through each file to be processed and apply the rules
+      files_to_process(cookbook_paths, options[:exclude_paths]).each do |file|
+        ast = read_ast(file)
+        active_rules(options).each do |rule|
+          rule_matches = matches(rule.recipe, ast, file)
 
-            if dsl_method_for_file(file)
-              rule_matches += matches(rule.send(dsl_method_for_file(file)),
-                ast, file)
-            end
+          if dsl_method_for_file(file)
+            rule_matches += matches(rule.send(dsl_method_for_file(file)),
+              ast, file)
+          end
 
-            per_cookbook_rules(last_dir, file) do
-              if File.basename(file) == 'metadata.rb'
-                rule_matches += matches(rule.metadata, ast, file)
-              end
-              rule_matches += matches(rule.cookbook, cookbook_dir(file))
+          per_cookbook_rules(last_dir, file) do
+            if File.basename(file) == 'metadata.rb'
+              rule_matches += matches(rule.metadata, ast, file)
             end
+            rule_matches += matches(rule.cookbook, cookbook_dir(file))
+          end
 
-            # Convert the matches into warnings
-            rule_matches.each do |match|
-              warnings << Warning.new(rule, {:filename => file}.merge(match))
-              matched_rule_tags << rule.tags
-            end
+          rule_matches = remove_ignored(rule_matches, rule, file)
+
+          # Convert the matches into warnings
+          rule_matches.each do |match|
+            warnings << Warning.new(rule, {:filename => file}.merge(match))
+            matched_rule_tags << rule.tags
           end
-          last_dir = cookbook_dir(file)
         end
-
-        Review.new(cookbook_paths, warnings,
-          should_fail_build?(options[:fail_tags], matched_rule_tags))
+        last_dir = cookbook_dir(file)
       end
+
+      Review.new(cookbook_paths, warnings,
+        should_fail_build?(options[:fail_tags], matched_rule_tags))
     end
 
     # Load the rules from the (fairly unnecessary) DSL.
     def load_rules
-      load_rules!(@last_options) unless defined? @rules
+      load_rules!(@options) unless defined? @rules
     end
 
     def load_rules!(options)
       @rules = RuleDsl.load([File.join(File.dirname(__FILE__), 'rules.rb')] +
-        options[:include_rules], options[:repl])
+        options[:include_rules])
     end
 
     private
 
+    def remove_ignored(matches, rule, file)
+      matches.reject do |m|
+        (line = m[:line]) && File.exist?(file) &&
+           ignore_line_match?(File.readlines(file)[line-1], rule)
+      end
+    end
+
+    def ignore_line_match?(line, rule)
+      ignores = line.to_s[/\s+#\s*(.*)/, 1]
+      if ignores and ignores.include?('~')
+        ! matching_tags?(ignores.split(/[ ,]/), rule.tags)
+      else
+        false
+      end
+    end
+
     # Some rules are version specific.
     def applies_to_version?(rule, version)
       return true unless version

data/lib/foodcritic/rules.rb

@@ -207,7 +207,8 @@ rule "FC017", "LWRP does not notify when updated" do
     version >= gem_version("0.7.12")
   end
   provider do |ast, filename|
-    if ast.xpath(%q{//call/*[self::vcall or self::var_ref/ident/
+    if ast.xpath(%q{//*[self::call or self::command_call]/
+                 *[self::vcall or self::var_ref/ident/
                  @value='new_resource']/../
                  ident[@value='updated_by_last_action']}).empty?
       [file_match(filename)]
@@ -229,23 +230,26 @@ 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 do |file|
+    asts = {}; files = Dir["#{cookbook_dir}/*/*.rb"].reject do |file|
+      relative_path = Pathname.new(file).relative_path_from(Pathname.new(cookbook_dir))
+      relative_path.to_s.split(File::SEPARATOR).include?('spec')
+    end.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,
                           :cookbook_dir => cookbook_dir).tap do |ast|
-          if (! ast.empty?) and (! asts.has_key?(type))
-            asts[type] = {:ast => ast, :path => file[:path]}
+          unless ast.empty?
+            (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 do |ast|
-        match(ast).merge(:filename => least_used[:path])
+      least_used.map do |file|
+        file[:ast].map{|ast| match(ast).merge(:filename => file[:path])}.flatten
       end
     end
   end
@@ -307,17 +311,26 @@ end
 rule "FC024", "Consider adding platform equivalents" do
   tags %w{portability}
   RHEL = %w{amazon centos redhat scientific}
-  recipe do |ast|
+  recipe do |ast, filename|
+    next if Pathname.new(filename).basename.to_s == 'metadata.rb'
+    metadata_path = Pathname.new(
+      File.join(File.dirname(filename), '..', 'metadata.rb')).cleanpath
+    md_platforms = if File.exists?(metadata_path)
+      supported_platforms(read_ast(metadata_path)).map{|p| p[:platform]}
+    else
+      []
+    end
+    md_platforms = RHEL if md_platforms.empty?
+
     ['//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.sort
+        unless platforms.size == 1 || (md_platforms & platforms).empty?
+          whn unless (platforms & RHEL).empty? ||
+            ((md_platforms & RHEL) - (platforms & RHEL)).empty?
         end
       end.compact
     end.flatten
@@ -476,7 +489,7 @@ rule "FC037", "Invalid notification action" do
           when :notifies then n[:resource_type]
           when :subscribes then resource_type(resource).to_sym
         end
-        ! resource_action?(type, n[:action])
+        n[:action].size > 0 and ! resource_action?(type, n[:action])
       end
     end
   end
@@ -522,9 +535,14 @@ end
 rule "FC040", "Execute resource used to run git commands" do
   tags %w{style recipe etsy}
   recipe do |ast|
+    possible_git_commands = %w{ clone fetch pull checkout reset }
     find_resources(ast, :type => 'execute').select do |cmd|
       cmd_str = (resource_attribute(cmd, 'command') || resource_name(cmd)).to_s
-      cmd_str.include?('git ')
+
+      git_cmd = cmd_str.match(/git ([a-z]+)/)
+      break false if git_cmd.nil?
+
+      !git_cmd.captures.nil? && possible_git_commands.include?(git_cmd.captures[0])
     end
   end
 end
@@ -548,6 +566,7 @@ end
 
 rule "FC043", "Prefer new notification syntax" do
   tags %w{style notifications deprecated}
+  applies_to {|version| version >= gem_version("0.9.10")}
   recipe do |ast|
     find_resources(ast).select do |resource|
       notifications(resource).any?{|notify| notify[:style] == :old}
@@ -561,7 +580,10 @@ rule "FC044", "Avoid bare attribute keys" do
     declared = ast.xpath('//descendant::var_field/ident/@value').map{|v| v.to_s}
     ast.xpath('//assign/*[self::vcall or self::var_ref]
       [count(child::kw) = 0]/ident').select do |v|
-        (v['value'] != 'secure_password') && ! declared.include?(v['value'])
+        (v['value'] != 'secure_password') &&
+          ! declared.include?(v['value']) &&
+	  ! v.xpath("ancestor::*[self::brace_block or self::do_block]/block_var/
+                     descendant::ident/@value='#{v['value']}'")
     end
   end
 end
@@ -579,3 +601,9 @@ rule "FC045", "Consider setting cookbook name in metadata" do
     end
   end
 end
+
+rule "FC046", "Attribute assignment uses assign unless nil" do
+  attributes do |ast|
+    attribute_access(ast).map{|a| a.xpath('ancestor::opassign/op[@value="||="]')}
+  end
+end

data/lib/foodcritic/version.rb

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