foodcritic 0.7.0 → 0.8.0

data/bin/foodcritic

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require 'foodcritic'
+require_relative '../lib/foodcritic'
 result, status = FoodCritic::Linter.check(ARGV)
-puts result; exit status.to_i
+puts result; exit status.to_i

data/lib/foodcritic.rb

@@ -1,7 +1,8 @@
 require 'chef'
 require 'pry'
-require 'foodcritic/domain'
-require 'foodcritic/helpers'
-require 'foodcritic/dsl'
-require 'foodcritic/linter'
-require 'foodcritic/version'
+require_relative 'foodcritic/domain'
+require_relative 'foodcritic/error_checker'
+require_relative 'foodcritic/helpers'
+require_relative 'foodcritic/dsl'
+require_relative 'foodcritic/linter'
+require_relative 'foodcritic/version'

data/lib/foodcritic/error_checker.rb

@@ -0,0 +1,29 @@
+module FoodCritic
+
+  # Expose if any errors are found in parsing
+  class ErrorChecker < Ripper::SexpBuilder
+
+    # Create a new instance of ErrorChecker
+    #
+    # @see Ripper::SexpBuilder#initialize
+    def initialize(*args)
+      super(*args)
+      @found_error = false
+    end
+
+    # Was an error encountered during parsing?
+    def error?
+      @found_error
+    end
+
+    # Register with all available error handlers.
+    def self.register_error_handlers
+      SexpBuilder.public_instance_methods.grep(/^on_.*_error$/).sort.each do |err_meth|
+        define_method(err_meth) { |*| @found_error = true }
+      end
+    end
+
+    self.register_error_handlers
+
+  end
+end

data/lib/foodcritic/helpers.rb

@@ -76,11 +76,35 @@ module FoodCritic
       end
     end
 
+    # Find attribute accesses by type.
+    #
+    # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check
+    # @param [Symbol] accessed_via The approach used to access the attributes (:string, :symbol or :vivified)
+    # @param [Boolean] exclude_with_dots Exclude attribute accesses that mix strings/symbols with dot notation.
+    # @return [Array] The matching nodes if any
+    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][descendant::ident/@value='#{att_type}']
+            [@value='.']/descendant::ident})
+          (call.size > 1 and call.first['value'] == 'node' and
+              Chef::Node.public_instance_methods.include?(call[1]['value'].to_sym)) ? [] : call
+        else
+          accessed_via = 'tstring_content' if accessed_via == :string
+          expr = '//*[self::aref_field or self::aref][descendant::ident'
+          expr += '[not(ancestor::aref/call)]' if exclude_with_dots
+          expr += "/@value='#{att_type}']/descendant::#{accessed_via}"
+          ast.xpath(expr)
+        end
+      end.flatten.sort
+    end
+
     # Find Chef resources of the specified type.
     # TODO: Include blockless resources
     #
     # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check
     # @param [String] type The type of resource to look for (or nil for all resources)
+    # @return [Array] AST nodes of Chef resources.
     def find_resources(ast, type = nil)
       ast.xpath(%Q{//method_add_block[command/ident#{type.nil? ? '' : "[@value='#{type}']"}]})
     end
@@ -96,6 +120,7 @@ module FoodCritic
     # Retrieve the name attribute associated with the specified resource.
     #
     # @param [Nokogiri::XML::Node] resource The resource AST to lookup the name attribute under
+    # @return [String] The name attribute value
     def resource_name(resource)
       resource.xpath('string(command//tstring_content/@value)')
     end
@@ -227,6 +252,28 @@ module FoodCritic
       build_xml(Ripper::SexpBuilder.new(IO.read(file)).parse)
     end
 
+    # Does the provided string look like ruby code?
+    #
+    # @param [String] str The string to check for rubiness
+    # @return [Boolean] True if this string could be syntactically valid Ruby
+    def ruby_code?(str)
+      checker = FoodCritic::ErrorChecker.new(str)
+      checker.parse
+      ! checker.error?
+    end
+
+    # Does the provided string look like an Operating System command? This is a rough heuristic to be taken with a
+    # pinch of salt.
+    #
+    # @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                  # probably a pipe, could be alternation
+      str.match(/^[\w]+$/) or               # command name only
+      str.match(/ --?[a-z]/i)               # command-line flag
+    end
+
   end
 
 end

data/lib/foodcritic/rules.rb

@@ -1,9 +1,7 @@
 rule "FC001", "Use strings in preference to symbols to access node attributes" do
   tags %w{style attributes}
   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
+    attribute_access(ast, :symbol, false).map{|ar| match(ar)}
   end
 end
 
@@ -150,13 +148,6 @@ 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}
-  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|
@@ -174,4 +165,34 @@ rule "FC018", "LWRP uses deprecated notification syntax" do
     ast.xpath(%q{//assign/field/*[self::vcall or self::var_ref/ident/@value='new_resource']/../
       ident[@value='updated']}).map{|assign| match(assign)}
   end
+end
+
+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}
+    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])]
+    end
+  end
+end
+
+rule "FC020", "Conditional execution string attribute looks like Ruby" do
+  tags %w{correctness}
+  recipe do |ast, filename|
+    conditions = ast.xpath(%q{//command[(ident/@value='only_if' or ident/@value='not_if') and
+      descendant::tstring_content]}).map{|m| match(m)}
+    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}
+      end.find_all{|cond| ruby_code?(cond[:raw_string]) and ! os_command?(cond[:raw_string])}.map{|cond| cond[:match]}
+    end
+  end
 end

data/lib/foodcritic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-31 00:00:00.000000000 Z
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &2160561320 !ruby/object:Gem::Requirement
+  requirement: &2152976460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.10.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160561320
+  version_requirements: *2152976460
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2160560580 !ruby/object:Gem::Requirement
+  requirement: &2152975660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160560580
+  version_requirements: *2152975660
 - !ruby/object:Gem::Dependency
   name: gherkin
-  requirement: &2160559620 !ruby/object:Gem::Requirement
+  requirement: &2152974740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 2.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160559620
+  version_requirements: *2152974740
 - !ruby/object:Gem::Dependency
   name: gist
-  requirement: &2160558760 !ruby/object:Gem::Requirement
+  requirement: &2152974160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +57,10 @@ dependencies:
         version: 2.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160558760
+  version_requirements: *2152974160
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2160557900 !ruby/object:Gem::Requirement
+  requirement: &2152966880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160557900
+  version_requirements: *2152966880
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2160556980 !ruby/object:Gem::Requirement
+  requirement: &2152966140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -79,10 +79,10 @@ dependencies:
         version: 0.9.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160556980
+  version_requirements: *2152966140
 - !ruby/object:Gem::Dependency
   name: pry-doc
-  requirement: &2160556240 !ruby/object:Gem::Requirement
+  requirement: &2152965480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,7 +90,7 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160556240
+  version_requirements: *2152965480
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files:
 - lib/foodcritic/domain.rb
 - lib/foodcritic/dsl.rb
+- lib/foodcritic/error_checker.rb
 - lib/foodcritic/helpers.rb
 - lib/foodcritic/linter.rb
 - lib/foodcritic/rules.rb
@@ -127,12 +128,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1380277540148398826
+      hash: -3790252679895367977
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: foodcritic-0.7.0
+summary: foodcritic-0.8.0
 test_files: []
 has_rdoc: