foodcritic 1.2.0 → 1.3.0

data/lib/foodcritic/api.rb

@@ -23,7 +23,7 @@ module FoodCritic
       end
 
       if options[:type] == :vivified
-        vivified_attribute_access(ast)
+        vivified_attribute_access(ast, options[:cookbook_dir])
       else
         standard_attribute_access(ast, options)
       end
@@ -32,13 +32,17 @@ module FoodCritic
     # Does the specified recipe check for Chef Solo?
     #
     # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check.
-    # @return [Boolean] True if there is a test for Chef::Config[:solo] in the
-    #   recipe
+    # @return [Boolean] True if there is a test for Chef::Config[:solo],
+    #   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
           @value = 'Config']) = 2
-          and count(descendant::ident[@value='solo']) > 0]}).empty?
+          and
+            (   count(descendant::ident[@value='solo']) > 0
+            or  count(descendant::tstring_content[@value='solo']) > 0
+            )
+          ]}).empty?
     end
 
     # Is the chef-solo-search library available?
@@ -181,10 +185,11 @@ module FoodCritic
     # @param [String] str The string to check
     # @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                  # a pipe, could be alternation
-      str.match(/^[\w]+$/) or               # command name only
-      str.match(/ --?[a-z]/i)               # command-line flag
+      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
@@ -216,12 +221,14 @@ module FoodCritic
       atts[:name] = name unless name.empty?
       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
-          att_value =
+        att_value =
+          if ! att.xpath('args_add_block[count(descendant::args_add)>1]').empty?
+            att.xpath('args_add_block').first
+          elsif att.xpath('descendant::symbol').empty?
+            att.xpath('string(descendant::tstring_content/@value)')
+          else
             att.xpath('string(descendant::symbol/ident/@value)').to_sym
-        end
+          end
         atts[att.xpath('string(ident/@value)')] = att_value
       end
       resource.xpath("do_block/descendant::method_add_block[
@@ -357,6 +364,21 @@ module FoodCritic
       xml_node
     end
 
+    def node_method?(meth, cookbook_dir)
+      chef_dsl_methods.include?(meth) || patched_node_method?(meth, cookbook_dir)
+    end
+
+    def patched_node_method?(meth, cookbook_dir)
+      return false if cookbook_dir.nil? || ! Dir.exists?(cookbook_dir)
+      cbk_tree_path = Pathname.new(File.join(cookbook_dir, '..'))
+      libs = Dir[File.join(cbk_tree_path.realpath, '*/libraries/*.rb')]
+      libs.any? do |lib|
+        ! read_ast(lib).xpath(%Q{//class[count(descendant::const[@value='Chef'])
+          > 0][count(descendant::const[@value='Node']) > 0]/descendant::def/
+          ident[@value='#{meth.to_s}']}).empty?
+      end
+    end
+
     # If the provided node is the line / column information.
     #
     # @param [Nokogiri::XML::Node] node A node within the AST
@@ -382,14 +404,14 @@ module FoodCritic
       ast.xpath(expr, AttFilter.new).sort
     end
 
-    def vivified_attribute_access(ast)
+    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)
       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))
+            ! node_method?(call.xpath("ident/@value").to_s.to_sym, cookbook_dir))
       end.sort
     end
 

data/lib/foodcritic/command_line.rb

@@ -11,7 +11,7 @@ module FoodCritic
       @original_args = args.dup
       @options = {:fail_tags => [], :tags => [], :include_rules => []}
       @parser = OptionParser.new do |opts|
-        opts.banner = 'foodcritic [cookbook_path]'
+        opts.banner = 'foodcritic [cookbook_paths]'
         opts.on("-r", "--[no-]repl",
           "Drop into a REPL for interactive rule editing.") do |r|
           options[:repl] = r
@@ -76,18 +76,18 @@ module FoodCritic
       "foodcritic #{FoodCritic::VERSION}"
     end
 
-    # If the cookbook path provided is valid
+    # If the cookbook paths provided are valid
     #
-    # @return [Boolean] True if the path is a directory that exists.
-    def valid_path?
-      @args.length == 1 and Dir.exists?(@args[0])
+    # @return [Boolean] True if the paths exist.
+    def valid_paths?
+      @args.any? && @args.all? {|path| File.exists?(path) }
     end
 
-    # The cookbook path
+    # The cookbook paths
     #
-    # @return [String] Path to the cookbook(s) being checked.
-    def cookbook_path
-      @args[0]
+    # @return [Array<String>] Path(s) to the cookbook(s) being checked.
+    def cookbook_paths
+      @args
     end
 
     # Is the search grammar specified valid?

data/lib/foodcritic/domain.rb

@@ -20,16 +20,16 @@ module FoodCritic
   # The collected warnings (if any) raised against a cookbook tree.
   class Review
 
-    attr_reader :cookbook_path, :warnings
+    attr_reader :cookbook_paths, :warnings
 
     # Create a new review
     #
-    # @param [String] cookbook_path The path this review was performed against
+    # @param [String] cookbook_paths 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?
-    def initialize(cookbook_path, warnings, is_failed)
-      @cookbook_path = cookbook_path
+    def initialize(cookbook_paths, warnings, is_failed)
+      @cookbook_paths = cookbook_paths
       @warnings = warnings
       @is_failed = is_failed
     end

data/lib/foodcritic/linter.rb

@@ -12,7 +12,7 @@ module FoodCritic
     include FoodCritic::Api
 
     # The default version that will be used to determine relevant rules
-    DEFAULT_CHEF_VERSION = "0.10.8"
+    DEFAULT_CHEF_VERSION = "0.10.10"
 
     # Perform option parsing from the provided arguments and do a lint check
     # based on those arguments.
@@ -25,8 +25,8 @@ module FoodCritic
       return [cmd_line.version, 0] if cmd_line.show_version?
       if ! cmd_line.valid_grammar?
         [cmd_line.help, 4]
-      elsif cmd_line.valid_path?
-        review = FoodCritic::Linter.new.check(cmd_line.cookbook_path,
+      elsif cmd_line.valid_paths?
+        review = FoodCritic::Linter.new.check(cmd_line.cookbook_paths,
           cmd_line.options)
         [review, review.failed? ? 3 : 0]
       else
@@ -42,16 +42,16 @@ module FoodCritic
     # Review the cookbooks at the provided path, identifying potential
     # improvements.
     #
-    # @param [String] cookbook_path The file path to an individual cookbook
-    #   directory
+    # @param [String] cookbook_paths The file path(s) to an individual
+    #   cookbook(s) being checked
     # @param [Hash] options Options to apply to the linting
     # @option options [Array] tags The tags to filter rules based on
     # @option options [Array] fail_tags The tags to fail the build on
     # @return [FoodCritic::Review] A review of your cookbooks, with any
     #   warnings issued.
-    def check(cookbook_path, options)
-      raise ArgumentError, "Cookbook path is required" if cookbook_path.nil?
-      @last_cookbook_path, @last_options = cookbook_path, options
+    def check(cookbook_paths, options)
+      raise ArgumentError, "Cookbook paths are required" if cookbook_paths.nil?
+      @last_cookbook_paths, @last_options = cookbook_paths, options
       load_rules unless defined? @rules
       warnings = []; last_dir = nil; matched_rule_tags = Set.new
 
@@ -59,7 +59,7 @@ module FoodCritic
         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|
+      files_to_process(cookbook_paths).each do |file|
         cookbook_dir = Pathname.new(
           File.join(File.dirname(file), '..')).cleanpath
         ast = read_ast(file)
@@ -82,7 +82,7 @@ module FoodCritic
         last_dir = cookbook_dir
       end
 
-      @review = Review.new(cookbook_path, warnings,
+      @review = Review.new(cookbook_paths, warnings,
                   should_fail_build?(options[:fail_tags], matched_rule_tags))
 
       binding.pry if options[:repl]
@@ -92,7 +92,7 @@ module FoodCritic
     # Convenience method to repeat the last check. Intended to be used from the
     # REPL.
     def recheck
-      check(@last_cookbook_path, @last_options)
+      check(@last_cookbook_paths, @last_options)
     end
 
     # Load the rules from the (fairly unnecessary) DSL.
@@ -146,14 +146,23 @@ module FoodCritic
     # Return the files within a cookbook tree that we are interested in trying
     # to match rules against.
     #
-    # @param [String] dir The cookbook directory
-    # @return [Array] The files underneath the provided directory to be
+    # @param [Array<String>] dirs The cookbook path(s)
+    # @return [Array] The files underneath the provided paths to be
     #   processed.
-    def files_to_process(dir)
-      return [dir] unless File.directory? dir
-      cookbook_glob = '{attributes,providers,recipes,resources}/*.rb'
-      Dir.glob(File.join(dir, cookbook_glob)) +
-        Dir.glob(File.join(dir, "*/#{cookbook_glob}"))
+    def files_to_process(dirs)
+      files = []
+
+      dirs.each do |dir|
+        if File.directory? dir
+          cookbook_glob = '{attributes,providers,recipes,resources}/*.rb'
+          files += Dir.glob(File.join(dir, cookbook_glob)) +
+            Dir.glob(File.join(dir, "*/#{cookbook_glob}"))
+        else
+          files << dir
+        end
+      end
+
+      files
     end
 
     # Whether to fail the build.

data/lib/foodcritic/output.rb

@@ -47,7 +47,7 @@ module FoodCritic
         else
           next
         end
-      }, review.cookbook_path])
+      }] + review.cookbook_paths)
       Rak.send(:remove_const, :VERSION) # Prevent duplicate VERSION warning
       load Gem.bin_path('rak', 'rak') # Assumes Rubygems
     end

data/lib/foodcritic/rules.rb

@@ -235,8 +235,8 @@ rule "FC019", "Access node attributes in a consistent manner" do
     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|
+        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]}
           end
@@ -303,7 +303,10 @@ rule "FC022", "Resource condition within loop may not behave as expected" do
           @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?
+          resource unless c.empty? || block_vars.any? do |var|
+            ! resource.xpath(%Q{command/args_add_block/args_add/
+              var_ref/ident[@value='#{var}']}).empty?
+          end
         end
       end
     end.flatten.compact
@@ -359,3 +362,19 @@ rule "FC025", "Prefer chef_gem to compile-time gem install" do
     end
   end
 end
+
+rule "FC026", "Conditional execution block attribute contains only string" do
+  tags %w{correctness}
+  applies_to {|version| version >= gem_version("0.7.4")}
+  recipe do |ast|
+    find_resources(ast).map{|r| resource_attributes(r)}.map do |resource|
+      [resource['not_if'], resource['only_if']]
+    end.flatten.compact.select do |condition|
+      condition.respond_to?(:xpath) and
+      ! condition.xpath('descendant::string_literal').empty? and
+        ! condition.xpath('stmts_add/string_literal').empty? and
+        condition.xpath('descendant::stmts_add[count(ancestor::
+          string_literal) = 0]').size == 1
+    end
+  end
+end

data/lib/foodcritic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-21 00:00:00.000000000 Z
+date: 2012-05-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: 700162912727168001
+      hash: -2700846089795891822
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: foodcritic-1.2.0
+summary: foodcritic-1.3.0
 test_files: []
 has_rdoc: