foodcritic 0.6.0 → 0.7.0

data/bin/foodcritic

@@ -1,19 +1,4 @@
 #!/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])
-  puts parser.help
-  exit 1
-end
-
-review = FoodCritic::Linter.new.check(ARGV[0], options)
-puts review unless review.warnings.empty?
+result, status = FoodCritic::Linter.check(ARGV)
+puts result; exit status.to_i

data/lib/foodcritic.rb

@@ -1,4 +1,5 @@
 require 'chef'
+require 'pry'
 require 'foodcritic/domain'
 require 'foodcritic/helpers'
 require 'foodcritic/dsl'

data/lib/foodcritic/domain.rb

@@ -24,8 +24,17 @@ module FoodCritic
     # Create a new review
     #
     # @param [Array] warnings The warnings raised in this review
-    def initialize(warnings)
+    # @param [Boolean] is_failed Have warnings been raised that mean this should be considered failed?
+    def initialize(warnings, is_failed)
       @warnings = warnings
+      @is_failed = is_failed
+    end
+
+    # If this review has failed or not.
+    #
+    # @return [Boolean] True if this review has failed.
+    def failed?
+      @is_failed
     end
 
     # Returns a string representation of this review.
@@ -40,7 +49,7 @@ module FoodCritic
 
   # A rule to be matched against.
   class Rule
-    attr_accessor :code, :name, :description, :cookbook, :recipe, :provider, :tags
+    attr_accessor :code, :name, :cookbook, :recipe, :provider, :tags
 
     # Create a new rule
     #
@@ -50,6 +59,13 @@ module FoodCritic
       @code, @name = code, name
       @tags = [code]
     end
+
+    # Returns a string representation of this rule.
+    #
+    # @return [String] Rule as a string.
+    def to_s
+      "#{@code}: #{@name}"
+    end
   end
 
 end

data/lib/foodcritic/dsl.rb

@@ -1,5 +1,6 @@
 require 'pathname'
 
+# FoodCritic is a lint tool for Chef cookbooks.
 module FoodCritic
 
   # The DSL methods exposed for defining rules.
@@ -26,13 +27,6 @@ module FoodCritic
       rules.last.tags += tags
     end
 
-    # Set the rule description
-    #
-    # @param [String] description Set the rule description.
-    def description(description)
-      rules.last.description = description
-    end
-
     # Define a matcher that will be passed the AST with this method.
     #
     # @param [block] block Your implemented matcher that returns a match Hash.
@@ -58,9 +52,10 @@ module FoodCritic
     #
     # @param [String] filename The path to the ruleset to load
     # @return [Array] The loaded rules, ready to be matched against provided cookbooks.
-    def self.load(filename)
+    def self.load(filename, with_repl)
       dsl = RuleDsl.new
       dsl.instance_eval(File.read(filename), filename)
+      dsl.instance_eval { binding.pry } if with_repl
       dsl.rules
     end
   end

data/lib/foodcritic/helpers.rb

@@ -15,6 +15,11 @@ module FoodCritic
       {:matched => node.respond_to?(:name) ? node.name : '', :line => pos['line'], :column => pos['column']}
     end
 
+    # Create a match for a specified file. Use this if the presence of the file triggers the warning rather than content.
+    #
+    # @param [String] file The filename to create a match for
+    # @return [Hash] Hash with the match details
+    # @see FoodCritic::Helpers#match
     def file_match(file)
       {:filename => file, :matched => file, :line => 1, :column => 1}
     end
@@ -28,6 +33,18 @@ module FoodCritic
           count(descendant::ident[@value='solo']) > 0]}).empty?
     end
 
+    # Is the chef-solo-search library available?
+    #
+    # @param [String] recipe_path The path to the current recipe
+    # @return [Boolean] True if the chef-solo-search library is available.
+    def chef_solo_search_supported?(recipe_path)
+      search_libs = Dir[File.join(Pathname.new(File.join(recipe_path, '../../..')).realpath, "**/libraries/search.rb")]
+      search_libs.any? do |lib|
+        ! read_file(lib).xpath(%q{//class[count(descendant::const[@value='Chef' or @value='Recipe']) = 2]/
+            descendant::def/ident[@value='search']}).empty?
+      end
+    end
+
     # Searches performed by the specified recipe.
     #
     # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check.
@@ -173,7 +190,7 @@ module FoodCritic
 
     # Recurse the nested arrays provided by Ripper to create a tree we can more easily apply expressions to.
     #
-    # @param [Hash] node The AST
+    # @param [Array] node The AST
     # @param [Nokogiri::XML::Document] doc The document being constructed
     # @param [Nokogiri::XML::Node] xml_node The current node
     # @return [Nokogiri::XML::Node] The XML representation

data/lib/foodcritic/linter.rb

@@ -1,3 +1,4 @@
+require 'optparse'
 require 'ripper'
 require 'gherkin/tag_expression'
 
@@ -8,9 +9,35 @@ module FoodCritic
 
     include FoodCritic::Helpers
 
-    # Create a new Linter, loading any defined rules.
+    # Perform option parsing from the provided arguments and do a lint check based on those arguments.
+    #
+    # @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)
+        [review, review.failed? ? 3 : 0]
+      else
+        [parser.help, 2]
+      end
+    end
+
+    # Create a new Linter.
     def initialize
-      load_rules
+
     end
 
     # Review the cookbooks at the provided path, identifying potential improvements.
@@ -18,10 +45,14 @@ module FoodCritic
     # @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
+    # @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)
-      warnings = []; last_dir = nil
+      @last_cookbook_path, @last_options = cookbook_path, options
+      load_rules unless defined? @rules
+      warnings = []; last_dir = nil; matched_rule_tags = Set.new
       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)
@@ -29,11 +60,37 @@ module FoodCritic
           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))}
+          rule_matches.each do |match|
+            warnings << Warning.new(rule, {:filename => file}.merge(match))
+            matched_rule_tags += rule.tags
+          end
         end
         last_dir = cookbook_dir
       end
-      Review.new(warnings)
+
+      @review = Review.new(warnings, should_fail_build?(options[:fail_tags], matched_rule_tags))
+
+      binding.pry if options[:repl]
+      @review
+    end
+
+    # Convenience method to repeat the last check. Intended to be used from the REPL.
+    def recheck
+      check(@last_cookbook_path, @last_options)
+    end
+
+    # Load the rules from the (fairly unnecessary) DSL.
+    def load_rules
+      @rules = RuleDsl.load(File.join(File.dirname(__FILE__), 'rules.rb'), @last_options[:repl])
+    end
+
+    alias_method :reset_rules, :load_rules
+
+    # Convenience method to retrieve the last review. Intended to be used from the REPL.
+    #
+    # @return [Review] The last review performed.
+    def review
+      @review
     end
 
     private
@@ -49,11 +106,6 @@ module FoodCritic
       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'))
-    end
-
     # Return the files within a cookbook tree that we are interested in trying to match rules against.
     #
     # @param [String] dir The cookbook directory
@@ -64,5 +116,20 @@ module FoodCritic
           Dir.glob(File.join(dir, '*/{attributes,providers,recipes}/*.rb'))
     end
 
+    # Whether to fail the build.
+    #
+    # @param [Array] fail_tags The tags that should cause the build to fail, or special value 'any' for any tag.
+    # @param [Set] matched_tags The tags of warnings we have matches for
+    # @return [Boolean] True if the build should be failed
+    def should_fail_build?(fail_tags, matched_tags)
+      if fail_tags.empty?
+        false
+      elsif fail_tags.include? 'any'
+        true
+      else
+        Gherkin::TagExpression.new(fail_tags).eval(matched_tags)
+      end
+    end
+
   end
 end

data/lib/foodcritic/rules.rb

@@ -1,6 +1,5 @@
 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)}
@@ -10,7 +9,6 @@ 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."
   recipe do |ast|
     ast.xpath(%q{//string_literal[count(descendant::string_embexpr) = 1 and
       count(string_add/tstring_content|string_add/string_add/tstring_content) = 0]}).map{|str| match(str)}
@@ -19,15 +17,13 @@ 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)}
+  recipe do |ast,filename|
+    searches(ast).map{|s| match(s)} unless checks_for_chef_solo?(ast) or chef_solo_search_supported?(filename)
   end
 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|
       cmd_str = (resource_attribute('command', cmd) || resource_name(cmd)).to_s
@@ -39,7 +35,6 @@ 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 = []
     # do all of the attributes for all resources of a given type match apart aside from one?
@@ -55,7 +50,6 @@ 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]/
       ancestor::method_add_block}).map{|resource| match(resource)}
@@ -64,21 +58,19 @@ 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
     next unless File.exists? metadata_path
     undeclared = included_recipes(ast).keys.map{|recipe|recipe.split('::').first} - [cookbook_name(filename)] -
         declared_dependencies(read_file(metadata_path))
     included_recipes(ast).map do |recipe, resource|
-      match(resource).merge(:filename => metadata_path) if undeclared.include?(recipe) || undeclared.any?{|u| recipe.start_with?("#{u}::")}
+      match(resource) if undeclared.include?(recipe) || undeclared.any?{|u| recipe.start_with?("#{u}::")}
     end.compact
   end
 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."
   cookbook do |filename|
     metadata_path = Pathname.new(File.join(filename, 'metadata.rb')).cleanpath
     next unless File.exists? metadata_path
@@ -93,7 +85,6 @@ 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 = []
     resource_attributes_by_type(ast).each do |type,resources|
@@ -113,7 +104,6 @@ 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)}

data/lib/foodcritic/version.rb

@@ -1,3 +1,4 @@
 module FoodCritic
-  VERSION = '0.6.0'
+  # The current version of foodcritic
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-18 00:00:00.000000000 Z
+date: 2011-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &2152976100 !ruby/object:Gem::Requirement
+  requirement: &2160561320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.10.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152976100
+  version_requirements: *2160561320
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2152975580 !ruby/object:Gem::Requirement
+  requirement: &2160560580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152975580
+  version_requirements: *2160560580
 - !ruby/object:Gem::Dependency
   name: gherkin
-  requirement: &2152974820 !ruby/object:Gem::Requirement
+  requirement: &2160559620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,21 @@ dependencies:
         version: 2.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152974820
+  version_requirements: *2160559620
+- !ruby/object:Gem::Dependency
+  name: gist
+  requirement: &2160558760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160558760
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152974340 !ruby/object:Gem::Requirement
+  requirement: &2160557900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,7 +68,29 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152974340
+  version_requirements: *2160557900
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2160556980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160556980
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: &2160556240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160556240
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -94,12 +127,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2590602930680125427
+      hash: -1380277540148398826
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: foodcritic-0.6.0
+summary: foodcritic-0.7.0
 test_files: []
 has_rdoc: