foodcritic 0.5.2 → 0.6.0

data/lib/foodcritic/domain.rb

@@ -32,13 +32,15 @@ module FoodCritic
     #
     # @return [String] Review as a string, this representation is liable to change.
     def to_s
-      @warnings.map { |w| "#{w.rule.code}: #{w.rule.name}: #{w.match[:filename]}:#{w.match[:line]}" }.sort.uniq.join("\n")
+      @warnings.map{|w|["#{w.rule.code}: #{w.rule.name}: #{w.match[:filename]}", w.match[:line].to_i]}.sort do |x,y|
+        x.first == y.first ? x[1] <=> y[1] : x.first <=> y.first
+      end.map{|w|"#{w.first}:#{w[1]}"}.uniq.join("\n")
     end
   end
 
   # A rule to be matched against.
   class Rule
-    attr_accessor :code, :name, :description, :recipe, :tags
+    attr_accessor :code, :name, :description, :cookbook, :recipe, :provider, :tags
 
     # Create a new rule
     #

data/lib/foodcritic/dsl.rb

@@ -40,6 +40,20 @@ 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 provider(&block)
+      rules.last.provider = block
+    end
+
+    # Define a matcher that will be passed the cookbook path with this method.
+    #
+    # @param [block] block Your implemented matcher that returns a match Hash.
+    def cookbook(&block)
+      rules.last.cookbook = block
+    end
+
     # Load the ruleset
     #
     # @param [String] filename The path to the ruleset to load

data/lib/foodcritic/helpers.rb

@@ -15,6 +15,10 @@ module FoodCritic
       {:matched => node.respond_to?(:name) ? node.name : '', :line => pos['line'], :column => pos['column']}
     end
 
+    def file_match(file)
+      {:filename => file, :matched => file, :line => 1, :column => 1}
+    end
+
     # Does the specified recipe check for Chef Solo?
     #
     # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check.

data/lib/foodcritic/linter.rb

@@ -20,20 +20,35 @@ module FoodCritic
     # @option options [Array] tags The tags to filter rules based on
     # @return [FoodCritic::Review] A review of your cookbooks, with any warnings issued.
     def check(cookbook_path, options)
-      warnings = []
+      warnings = []; last_dir = nil
       tag_expr = Gherkin::TagExpression.new(options[:tags])
       files_to_process(cookbook_path).each do |file|
+        cookbook_dir = Pathname.new(File.join(File.dirname(file), '..')).cleanpath
         ast = read_file(file)
         @rules.select{|rule| tag_expr.eval(rule.tags)}.each do |rule|
-          matches = rule.recipe.yield(ast, file)
-          matches.each{|match| warnings << Warning.new(rule, {:filename => file}.merge(match))} unless matches.nil?
+          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.cookbook, cookbook_dir) if last_dir != cookbook_dir
+          rule_matches.each{|match| warnings << Warning.new(rule, {:filename => file}.merge(match))}
         end
+        last_dir = cookbook_dir
       end
       Review.new(warnings)
     end
 
     private
 
+    # Invoke the DSL method with the provided parameters.
+    #
+    # @param [Proc] match_method Proc to invoke
+    # @param params Parameters for the proc
+    # @return [Array] The returned matches
+    def matches(match_method, *params)
+      return [] unless match_method.respond_to?(:yield)
+      matches = match_method.yield(*params)
+      matches.respond_to?(:each) ? matches : []
+    end
+
     # Load the rules from the (fairly unnecessary) DSL.
     def load_rules
       @rules = RuleDsl.load(File.join(File.dirname(__FILE__), 'rules.rb'))
@@ -45,7 +60,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,recipes}/*.rb')) + Dir.glob(File.join(dir, '*/{attributes,recipes}/*.rb'))
+      Dir.glob(File.join(dir, '{attributes,providers,recipes}/*.rb')) +
+          Dir.glob(File.join(dir, '*/{attributes,providers,recipes}/*.rb'))
     end
 
   end

data/lib/foodcritic/rules.rb

@@ -1,3 +1,13 @@
+rule "FC001", "Use strings in preference to symbols to access node attributes" do
+  tags %w{style attributes}
+  description "When accessing node attributes you should use a string for a key rather than a symbol."
+  recipe do |ast|
+    %w{node default override set normal}.map do |type|
+      ast.xpath("//*[self::aref_field or self::aref][descendant::ident/@value='#{type}']//symbol").map{|ar| match(ar)}
+    end.flatten
+  end
+end
+
 rule "FC002", "Avoid string interpolation where not required" do
   tags %w{style strings}
   description "When setting a resource value avoid string interpolation where not required."
@@ -21,7 +31,8 @@ rule "FC004", "Use a service resource to start and stop services" do
   recipe do |ast|
     find_resources(ast, 'execute').find_all do |cmd|
       cmd_str = (resource_attribute('command', cmd) || resource_name(cmd)).to_s
-      cmd_str.include?('/etc/init.d') || cmd_str.start_with?('service ') || cmd_str.start_with?('/sbin/service ')
+      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 ')
     end.map{|cmd| match(cmd)}
   end
 end
@@ -34,7 +45,7 @@ rule "FC005", "Avoid repetition of resource declarations" do
     # 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.all?{|att| (att - sorted_atts.inject{|atts,a| atts & a}).length == 1}
+        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
@@ -68,8 +79,8 @@ end
 rule "FC008", "Generated cookbook metadata needs updating" do
   tags %w{style metadata}
   description "The cookbook metadata for this cookbook is boilerplate output from knife generate cookbook and needs updating with the real details of your cookbook."
-  recipe do |ast,filename|
-    metadata_path = Pathname.new(File.join(File.dirname(filename), '..', 'metadata.rb')).cleanpath
+  cookbook do |filename|
+    metadata_path = Pathname.new(File.join(filename, 'metadata.rb')).cleanpath
     next unless File.exists? metadata_path
     md = read_file(metadata_path)
     {'maintainer' => 'YOUR_COMPANY_NAME', 'maintainer_email' => 'YOUR_EMAIL'}.map do |field,value|
@@ -107,4 +118,70 @@ rule "FC010", "Invalid search syntax" do
     # This only works for literal search strings
     literal_searches(ast).reject{|search| valid_query?(search['value'])}.map{|search| match(search)}
   end
+end
+
+rule "FC011", "Missing README in markdown format" do
+  tags %w{style readme}
+  cookbook do |filename|
+    [file_match(File.join(filename, 'README.md'))] unless File.exists?(File.join(filename, 'README.md'))
+  end
+end
+
+rule "FC012", "Use Markdown for README rather than RDoc" do
+  tags %w{style readme}
+  cookbook do |filename|
+    [file_match(File.join(filename, 'README.rdoc'))] if File.exists?(File.join(filename, 'README.rdoc'))
+  end
+end
+
+rule "FC013", "Use file_cache_path rather than hard-coding tmp paths" do
+  tags %w{style files}
+  recipe do |ast|
+    find_resources(ast, 'remote_file').find_all do |download|
+      path = (resource_attribute('path', download) || resource_name(download)).to_s
+      path.start_with?('/tmp/')
+    end.map{|download| match(download)}
+  end
+end
+
+rule "FC014", "Consider extracting long ruby_block to library" do
+  tags %w{style libraries}
+  recipe do |ast|
+    find_resources(ast, 'ruby_block').find_all do |rb|
+      ! rb.xpath("//fcall[ident/@value='block' and count(ancestor::*) = 8]/../../do_block[count(descendant::*) > 100]").empty?
+    end.map{|block| match(block)}
+  end
+end
+
+rule "FC015", "Consider converting definition to a LWRP" do
+  tags %w{style definitions lwrp}
+  cookbook do |dir|
+    Dir[File.join(dir, 'definitions', '*.rb')].reject{|entry| ['.', '..'].include? entry}.map{|entry| file_match(entry)}
+  end
+end
+
+rule "FC016", "LWRP does not declare a default action" do
+  tags %w{correctness lwrp}
+  provider 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|
+    if ast.xpath(%q{//call/*[self::vcall or self::var_ref/ident/@value='new_resource']/../
+      ident[@value='updated_by_last_action']}).empty?
+      [file_match(filename)]
+    end
+  end
+end
+
+rule "FC018", "LWRP uses deprecated notification syntax" do
+  tags %w{style lwrp deprecated}
+  provider do |ast|
+    ast.xpath("//assign/var_field/ivar[@value='@updated']").map{|class_var| match(class_var)} +
+    ast.xpath(%q{//assign/field/*[self::vcall or self::var_ref/ident/@value='new_resource']/../
+      ident[@value='updated']}).map{|assign| match(assign)}
+  end
 end

data/lib/foodcritic/version.rb

@@ -1,3 +1,3 @@
 module FoodCritic
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000Z
+date: 2011-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &2155159160 !ruby/object:Gem::Requirement
+  requirement: &2152976100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.10.4
   type: :runtime
   prerelease: false
-  version_requirements: *2155159160
+  version_requirements: *2152976100
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2155158600 !ruby/object:Gem::Requirement
+  requirement: &2152975580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2155158600
+  version_requirements: *2152975580
 - !ruby/object:Gem::Dependency
   name: gherkin
-  requirement: &2155157740 !ruby/object:Gem::Requirement
+  requirement: &2152974820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 2.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *2155157740
+  version_requirements: *2152974820
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2155157240 !ruby/object:Gem::Requirement
+  requirement: &2152974340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,7 +57,7 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155157240
+  version_requirements: *2152974340
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -94,12 +94,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2219223099964233335
+      hash: 2590602930680125427
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: foodcritic-0.5.2
+summary: foodcritic-0.6.0
 test_files: []
 has_rdoc: