foodcritic 0.8.1 → 0.9.0

data/bin/foodcritic

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
 require_relative '../lib/foodcritic'
-result, status = FoodCritic::Linter.check(ARGV)
-puts result; exit status.to_i
+module FoodCritic
+  cmd_line = CommandLine.new(ARGV)
+  review, status = Linter.check(cmd_line)
+  printer = cmd_line.show_context? ? ContextOutput.new : SummaryOutput.new
+  printer.output(review)
+  exit status.to_i
+end

data/lib/foodcritic.rb

@@ -1,8 +1,11 @@
 require 'chef'
 require 'pry'
+require 'rak'
+require_relative 'foodcritic/command_line'
 require_relative 'foodcritic/domain'
 require_relative 'foodcritic/error_checker'
 require_relative 'foodcritic/helpers'
 require_relative 'foodcritic/dsl'
 require_relative 'foodcritic/linter'
+require_relative 'foodcritic/output'
 require_relative 'foodcritic/version'

data/lib/foodcritic/command_line.rb

@@ -0,0 +1,67 @@
+module FoodCritic
+
+  # Command line parsing.
+  class CommandLine
+
+    # Create a new instance of CommandLine
+    #
+    # @param [Array] args The command line arguments
+    def initialize(args)
+      @args = args
+      @options = {}
+      @options[:fail_tags] = []; @options[:tags] = []
+      @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}
+      end
+      @parser.parse!(args) unless show_help?
+    end
+
+    # Show the command help to the end user?
+    #
+    # @return [Boolean] True if help should be shown.
+    def show_help?
+      @args.length == 1 and @args.first == '--help'
+    end
+
+    # The help text.
+    #
+    # @return [String] Help text describing the command-line options available.
+    def help
+      @parser.help
+    end
+
+    # If the cookbook path provided is valid
+    #
+    # @return [Boolean] True if the path is a directory that exists.
+    def valid_path?
+      @args.length == 1 and Dir.exists?(@args[0])
+    end
+
+    # The cookbook path
+    #
+    # @return [String] Path to the cookbook(s) being checked.
+    def cookbook_path
+      @args[0]
+    end
+
+    # 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?
+      @options[:context]
+    end
+
+    # Parsed command-line options
+    #
+    # @return [Hash] The parsed command-line options.
+    def options
+      @options
+    end
+
+  end
+
+end

data/lib/foodcritic/domain.rb

@@ -19,13 +19,15 @@ module FoodCritic
   # The collected warnings (if any) raised against a cookbook tree.
   class Review
 
-    attr_reader :warnings
+    attr_reader :cookbook_path, :warnings
 
     # Create a new review
     #
+    # @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?
-    def initialize(warnings, is_failed)
+    def initialize(cookbook_path, warnings, is_failed)
+      @cookbook_path = cookbook_path
       @warnings = warnings
       @is_failed = is_failed
     end
@@ -49,7 +51,7 @@ module FoodCritic
 
   # A rule to be matched against.
   class Rule
-    attr_accessor :code, :name, :cookbook, :recipe, :provider, :tags
+    attr_accessor :code, :name, :cookbook, :recipe, :provider, :resource, :tags
 
     # Create a new rule
     #

data/lib/foodcritic/dsl.rb

@@ -34,6 +34,13 @@ module FoodCritic
       rules.last.recipe = 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.
+    def resource(&block)
+      rules.last.resource = 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/helpers.rb

@@ -85,11 +85,13 @@ module FoodCritic
     def attribute_access(ast, accessed_via, exclude_with_dots)
       %w{node default override set normal}.map do |att_type|
         if accessed_via == :vivified
-          call = ast.xpath(%Q{//*[self::call or self::field][vcall/ident/@value='#{att_type}' or
+          calls = ast.xpath(%Q{//*[self::call or self::field][vcall/ident/@value='#{att_type}' or
             var_ref/ident/@value='#{att_type}'][@value='.']})
-          call.xpath("aref/args_add_block").size == 0 and (call.xpath("descendant::ident").size > 1 and
-              call.xpath("descendant::ident").first['value'] == 'node' and
-                ! Chef::Node.public_instance_methods.include?(call.xpath("ident/@value").to_s.to_sym)) ? call : []
+          calls.select do |call|
+            call.xpath("aref/args_add_block").size == 0 and (call.xpath("descendant::ident").size > 1 and
+                call.xpath("descendant::ident").first['value'] == att_type.to_s and
+                  ! dsl_methods.include?(call.xpath("ident/@value").to_s.to_sym))
+          end
         else
           accessed_via = 'tstring_content' if accessed_via == :string
           expr = '//*[self::aref_field or self::aref][descendant::ident'
@@ -100,6 +102,14 @@ module FoodCritic
       end.flatten.sort
     end
 
+    # The set of methods in the Chef DSL
+    #
+    # @return [Array] Array of method symbols
+    def dsl_methods
+      (Chef::Node.public_instance_methods +
+       Chef::Mixin::RecipeDefinitionDSLCore.included_modules.map{|mixin| mixin.public_instance_methods}).flatten.sort.uniq
+    end
+
     # Find Chef resources of the specified type.
     # TODO: Include blockless resources
     #

data/lib/foodcritic/linter.rb

@@ -13,25 +13,13 @@ module FoodCritic
     #
     # @param [Array] args The command-line arguments to parse
     # @return [Array] Pair - the first item is string output, the second is the exit code.
-    def self.check(args)
-      options = {}
-      options[:fail_tags] = []; options[:tags] = []
-      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}
-      end
-
-      return [parser.help, 0] if args.length == 1 and args.first == '--help'
-
-      parser.parse!(args)
-
-      if args.length == 1 and Dir.exists?(args[0])
-        review = FoodCritic::Linter.new.check(args[0], options)
+    def self.check(cmd_line)
+      return [cmd_line.help, 0] if cmd_line.show_help?
+      if cmd_line.valid_path?
+        review = FoodCritic::Linter.new.check(cmd_line.cookbook_path, cmd_line.options)
         [review, review.failed? ? 3 : 0]
       else
-        [parser.help, 2]
+        [cmd_line.help, 2]
       end
     end
 
@@ -59,6 +47,7 @@ module FoodCritic
         @rules.select{|rule| tag_expr.eval(rule.tags)}.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
           rule_matches.each do |match|
             warnings << Warning.new(rule, {:filename => file}.merge(match))
@@ -68,7 +57,7 @@ module FoodCritic
         last_dir = cookbook_dir
       end
 
-      @review = Review.new(warnings, should_fail_build?(options[:fail_tags], matched_rule_tags))
+      @review = Review.new(cookbook_path, warnings, should_fail_build?(options[:fail_tags], matched_rule_tags))
 
       binding.pry if options[:repl]
       @review
@@ -112,8 +101,8 @@ module FoodCritic
     # @return [Array] The files underneath the provided directory to be processed.
     def files_to_process(dir)
       return [dir] unless File.directory? dir
-      Dir.glob(File.join(dir, '{attributes,providers,recipes}/*.rb')) +
-          Dir.glob(File.join(dir, '*/{attributes,providers,recipes}/*.rb'))
+      Dir.glob(File.join(dir, '{attributes,providers,recipes,resources}/*.rb')) +
+          Dir.glob(File.join(dir, '*/{attributes,providers,recipes,resources}/*.rb'))
     end
 
     # Whether to fail the build.

data/lib/foodcritic/output.rb

@@ -0,0 +1,70 @@
+module FoodCritic
+
+  # Default output showing a summary view.
+  class SummaryOutput
+    # Output a summary view only listing the matching rules, file and line number.
+    #
+    # @param [Review] review The review to output.
+    def output(review)
+      puts review.to_s
+    end
+  end
+
+  # Display rule matches with surrounding context.
+  class ContextOutput
+
+    # Output the review showing matching lines with context.
+    #
+    # @param [Review] review The review to output.
+    def output(review)
+      unless review.respond_to?(:warnings)
+        puts review; return
+      end
+
+      # 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.
+      line_lookup = key_by_file_and_line(review)
+      Rak.class_eval do
+        const_set(:RULE_COLOUR, "\033[1;36m")
+        @warnings = line_lookup
+      end
+      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 ! displayed_filename
+            fn = "#{fn}\n#{rule_name}"
+          else
+            puts rule_name
+          end
+        else
+          next
+        end
+      }, review.cookbook_path])
+      Rak.send(:remove_const, :VERSION) # Prevent duplicate VERSION warning
+      load Gem.bin_path('rak', 'rak') # Assumes Rubygems
+    end
+
+    private
+
+    # 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
+        warn_hash[filename] = {} unless warn_hash.key?(filename)
+        warn_hash[filename][line_num] = Set.new unless warn_hash[filename].key?(line_num)
+        warn_hash[filename][line_num] << warning.rule
+      end
+      warn_hash
+    end
+
+  end
+
+end

data/lib/foodcritic/rules.rb

@@ -34,15 +34,14 @@ end
 rule "FC005", "Avoid repetition of resource declarations" do
   tags %w{style}
   recipe do |ast|
-    matches = []
-    # do all of the attributes for all resources of a given type match apart aside from one?
-    resource_attributes_by_type(ast).each do |type, resource_atts|
-        sorted_atts = resource_atts.map{|atts| atts.to_a.sort{|x,y| x.first.to_s <=> y.first.to_s }}
-        if sorted_atts.length > 2 and sorted_atts.all?{|att| (att - sorted_atts.inject{|atts,a| atts & a}).length == 1}
-          matches << match(find_resources(ast, type).first)
-        end
-    end
-    matches
+    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.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}
+    end.compact
   end
 end
 
@@ -148,6 +147,13 @@ rule "FC015", "Consider converting definition to a LWRP" do
   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)]
+  end
+end
+
 rule "FC017", "LWRP does not notify when updated" do
   tags %w{correctness lwrp}
   provider do |ast, filename|
@@ -171,14 +177,14 @@ 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_file(file)}}
-    types = [:string, :symbol, :vivified].map{|type| {:access_type => type, :count => files.count do |file|
-      ! attribute_access(file[:ast], type, true).tap{|ast|
-        asts[type] = {:ast => ast.first, :path => file[:path]} if (! ast.empty?) and (! asts.has_key?(type))
-      }.empty?
-    end}}.reject{|type| type[:count] == 0}
+    types = [:string, :symbol, :vivified].map{|type| {:access_type => type, :count => files.map do |file|
+      attribute_access(file[:ast], type, 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}
     if asts.size > 1
       least_used = asts[types.min{|a,b| a[:count] <=> b[:count]}[:access_type]]
-      [match(least_used[:ast]).merge(:filename => least_used[:path])]
+      least_used[:ast].map{|ast| match(ast).merge(:filename => least_used[:path])}
     end
   end
 end
@@ -191,8 +197,36 @@ rule "FC020", "Conditional execution string attribute looks like Ruby" do
     unless conditions.empty?
       lines = File.readlines(filename) # go back and get 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}
+        {: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]}
     end
   end
+end
+
+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?
+    end.compact
+  end
+end
+
+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/, '')}
+      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?
+        end
+      end
+    end.flatten.compact
+  end
 end

data/lib/foodcritic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &2152165640 !ruby/object:Gem::Requirement
+  requirement: &2156685440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.10.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152165640
+  version_requirements: *2156685440
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2152164620 !ruby/object:Gem::Requirement
+  requirement: &2156705560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152164620
+  version_requirements: *2156705560
 - !ruby/object:Gem::Dependency
   name: gherkin
-  requirement: &2152022200 !ruby/object:Gem::Requirement
+  requirement: &2156702700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 2.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152022200
+  version_requirements: *2156702700
 - !ruby/object:Gem::Dependency
   name: gist
-  requirement: &2152020740 !ruby/object:Gem::Requirement
+  requirement: &2156700200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +57,10 @@ dependencies:
         version: 2.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152020740
+  version_requirements: *2156700200
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152019320 !ruby/object:Gem::Requirement
+  requirement: &2156712640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152019320
+  version_requirements: *2156712640
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2152016360 !ruby/object:Gem::Requirement
+  requirement: &2156708060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -79,10 +79,10 @@ dependencies:
         version: 0.9.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152016360
+  version_requirements: *2156708060
 - !ruby/object:Gem::Dependency
   name: pry-doc
-  requirement: &2152015400 !ruby/object:Gem::Requirement
+  requirement: &2156721400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,7 +90,18 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152015400
+  version_requirements: *2156721400
+- !ruby/object:Gem::Dependency
+  name: rak
+  requirement: &2156718720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156718720
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -98,11 +109,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/foodcritic/command_line.rb
 - lib/foodcritic/domain.rb
 - lib/foodcritic/dsl.rb
 - lib/foodcritic/error_checker.rb
 - lib/foodcritic/helpers.rb
 - lib/foodcritic/linter.rb
+- lib/foodcritic/output.rb
 - lib/foodcritic/rules.rb
 - lib/foodcritic/version.rb
 - lib/foodcritic.rb
@@ -128,12 +141,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -295625784771858454
+      hash: -4091807695676040687
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: foodcritic-0.8.1
+summary: foodcritic-0.9.0
 test_files: []
 has_rdoc: