foodcritic 0.4.0 → 0.5.0

data/bin/foodcritic

@@ -1,8 +1,19 @@
 #!/usr/bin/env ruby
 require 'foodcritic'
+require 'optparse'
+
+options = {}
+options[:tags] = []
+parser = OptionParser.new do |opts|
+  opts.banner = 'foodcritic [cookbook_path]'
+  opts.on("-t", "--tags TAGS", "Only check against rules with the specified tags.") {|t|options[:tags] << t}
+end
+parser.parse!
+
 unless ARGV.length == 1 and Dir.exists?(ARGV[0])
-  STDERR.puts 'foodcritic [cookbook_path]'
+  puts parser.help
   exit 1
 end
-review = FoodCritic::Linter.new.check(ARGV[0])
-puts review unless review.warnings.empty?
+
+review = FoodCritic::Linter.new.check(ARGV[0], options)
+puts review unless review.warnings.empty?

data/lib/foodcritic/domain.rb

@@ -38,7 +38,7 @@ module FoodCritic
 
   # A rule to be matched against.
   class Rule
-    attr_accessor :code, :name, :description, :recipe
+    attr_accessor :code, :name, :description, :recipe, :tags
 
     # Create a new rule
     #
@@ -46,6 +46,7 @@ module FoodCritic
     # @param [String] name The short descriptive name of this rule presented to the end user.
     def initialize(code, name)
       @code, @name = code, name
+      @tags = [code]
     end
   end
 

data/lib/foodcritic/dsl.rb

@@ -19,6 +19,13 @@ module FoodCritic
       yield self
     end
 
+    # Add tags to the rule which can be used to filter the rules to be applied.
+    #
+    # @param [Array] tags The tags associated with this rule.
+    def tags(tags)
+      rules.last.tags += tags
+    end
+
     # Set the rule description
     #
     # @param [String] description Set the rule description.

data/lib/foodcritic/helpers.rb

@@ -1,4 +1,5 @@
 require 'nokogiri'
+require 'chef/solr_query/query_transform'
 
 module FoodCritic
 
@@ -31,6 +32,29 @@ module FoodCritic
       ast.xpath("//fcall/ident[@value = 'search']")
     end
 
+    # Searches performed by the specified recipe that are literal strings. Searches with a query formed from a
+    # subexpression will be ignored.
+    #
+    # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check.
+    # @return [Nokogiri::XML::Node] The matching nodes
+    def literal_searches(ast)
+      ast.xpath("//method_add_arg[fcall/ident/@value = 'search' and count(descendant::string_embexpr) = 0]/descendant::tstring_content")
+    end
+
+    # Is this a valid Lucene query?
+    #
+    # @param [String] query The query to check for syntax errors
+    # @return [Boolean] True if the query is well-formed
+    def valid_query?(query)
+      # Exceptions for flow control. Alternatively we could re-implement the parse method.
+      begin
+        Chef::SolrQuery::QueryTransform.parse(query)
+        true
+      rescue Chef::Exceptions::QueryParseError
+        false
+      end
+    end
+
     # Find Chef resources of the specified type.
     # TODO: Include blockless resources
     #

data/lib/foodcritic/linter.rb

@@ -1,4 +1,5 @@
 require 'ripper'
+require 'gherkin/tag_expression'
 
 module FoodCritic
 
@@ -15,12 +16,15 @@ 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 [Hash] options Options to apply to the linting
+    # @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)
+    def check(cookbook_path, options)
       warnings = []
+      tag_expr = Gherkin::TagExpression.new(options[:tags])
       files_to_process(cookbook_path).each do |file|
         ast = read_file(file)
-        @rules.each do |rule|
+        @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?
         end

data/lib/foodcritic/rules.rb

@@ -1,4 +1,5 @@
 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."
   recipe do |ast|
     ast.xpath(%q{//string_literal[count(descendant::string_embexpr) = 1 and
@@ -7,6 +8,7 @@ rule "FC002", "Avoid string interpolation where not required" do
 end
 
 rule "FC003", "Check whether you are running with chef server before using server-specific features" do
+  tags %w{portability solo}
   description "Ideally your cookbooks should be usable without requiring chef server."
   recipe do |ast|
     checks_for_chef_solo?(ast) ? [] : searches(ast).map{|s| match(s)}
@@ -14,6 +16,7 @@ rule "FC003", "Check whether you are running with chef server before using serve
 end
 
 rule "FC004", "Use a service resource to start and stop services" do
+  tags %w{style services}
   description "Avoid use of execute to control services - use the service resource instead."
   recipe do |ast|
     find_resources(ast, 'execute').find_all do |cmd|
@@ -24,6 +27,7 @@ rule "FC004", "Use a service resource to start and stop services" do
 end
 
 rule "FC005", "Avoid repetition of resource declarations" do
+  tags %w{style}
   description "Where you have a lot of resources that vary in only a single attribute wrap them in a loop for brevity."
   recipe do |ast|
     matches = []
@@ -39,6 +43,7 @@ rule "FC005", "Avoid repetition of resource declarations" do
 end
 
 rule "FC006", "Mode should be quoted or fully specified when setting file permissions" do
+  tags %w{correctness files}
   description "Not quoting mode when setting permissions can lead to incorrect permissions being set."
   recipe do |ast|
     ast.xpath(%q{//ident[@value='mode']/parent::command/descendant::int[string-length(@value) < 4]/
@@ -47,6 +52,7 @@ rule "FC006", "Mode should be quoted or fully specified when setting file permis
 end
 
 rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
+  tags %w{correctness metadata}
   description "You are including a recipe that is not in the current cookbook and not defined as a dependency in your cookbook metadata."
   recipe do |ast,filename|
     metadata_path = Pathname.new(File.join(File.dirname(filename), '..', 'metadata.rb')).cleanpath
@@ -60,6 +66,7 @@ rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
 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
@@ -74,6 +81,7 @@ rule "FC008", "Generated cookbook metadata needs updating" do
 end
 
 rule "FC009", "Resource attribute not recognised" do
+  tags %w{correctness}
   description "You appear to be using an unrecognised attribute on a standard Chef resource. Please check for typos."
   recipe do |ast|
     matches = []
@@ -90,4 +98,13 @@ rule "FC009", "Resource attribute not recognised" do
     end
     matches
   end
+end
+
+rule "FC010", "Invalid search syntax" do
+  tags %w{correctness search}
+  description "The search expression in the recipe could not be parsed. Please check your syntax."
+  recipe do |ast|
+    # This only works for literal search strings
+    literal_searches(ast).reject{|search| valid_query?(search['value'])}.map{|search| match(search)}
+  end
 end

data/lib/foodcritic/version.rb

@@ -1,3 +1,3 @@
 module FoodCritic
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-10 00:00:00.000000000 Z
+date: 2011-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &2153103960 !ruby/object:Gem::Requirement
+  requirement: &2152896120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 0.10.4
   type: :runtime
   prerelease: false
-  version_requirements: *2153103960
+  version_requirements: *2152896120
+- !ruby/object:Gem::Dependency
+  name: gherkin
+  requirement: &2152893520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152893520
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2153103180 !ruby/object:Gem::Requirement
+  requirement: &2152891580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +43,7 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153103180
+  version_requirements: *2152891580
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -69,12 +80,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1643437083715464422
+      hash: -2449883706857306958
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: foodcritic-0.4.0
+summary: foodcritic-0.5.0
 test_files: []
 has_rdoc: