foodcritic 15.1.0 → 16.3.0

data/foodcritic.gemspec

@@ -4,7 +4,7 @@ require "foodcritic/version"
 Gem::Specification.new do |s|
   s.name = "foodcritic"
   s.version = FoodCritic::VERSION
-  s.description = "Lint tool for Chef cookbooks."
+  s.description = "A code linting tool for Chef Infra cookbooks."
   s.summary = "foodcritic-#{s.version}"
   s.authors = ["Andrew Crump"]
   s.homepage = "http://foodcritic.io"
@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
     Dir["misc/**/*"]
   s.files += Dir["Gemfile", "foodcritic.gemspec", "LICENSE"]
 
-  s.add_dependency("cucumber-core", ">= 1.3", "< 4.0")
   s.add_dependency("nokogiri", ">= 1.5", "< 2.0")
   s.add_dependency("rake")
   s.add_dependency("treetop", "~> 1.4")
@@ -25,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency("erubis")
   s.add_dependency("rufus-lru", "~> 1.0")
 
+  s.add_development_dependency "cucumber-core", ">= 1.3", "< 4.0"
   s.add_development_dependency "rspec", "~> 3.5"
   s.add_development_dependency "fuubar", "~> 2.0"
   s.add_development_dependency "rspec-command", "~> 1.0"

data/lib/foodcritic.rb

@@ -2,7 +2,6 @@ Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
 require "pathname"
-require "cucumber/core"
 require "treetop"
 require "ripper"
 require "ffi_yajl"
@@ -22,3 +21,5 @@ require_relative "foodcritic/output"
 require_relative "foodcritic/rake_task"
 require_relative "foodcritic/template"
 require_relative "foodcritic/version"
+require_relative "foodcritic/gerkin/tag"
+require_relative "foodcritic/gerkin/tag_expression"

data/lib/foodcritic/api.rb

@@ -29,7 +29,7 @@ module FoodCritic
       options = { type: :any, ignore_calls: false }.merge!(options)
       return [] unless ast.respond_to?(:xpath)
 
-      unless [:any, :string, :symbol, :vivified].include?(options[:type])
+      unless %i{any string symbol vivified}.include?(options[:type])
         raise ArgumentError, "Node type not recognised"
       end
 
@@ -56,9 +56,7 @@ module FoodCritic
 
       # get list of items in the dir and intersect with metadata array.
       # until we get an interfact (we have a metadata) walk up the dir structure
-      until (Dir.entries(file) & %w{metadata.rb metadata.json}).any?
-        file = File.dirname(file)
-      end
+      file = File.dirname(file) until (Dir.entries(file) & %w{metadata.rb metadata.json}).any?
 
       file
     end
@@ -69,9 +67,7 @@ module FoodCritic
     # @since 7.0.0
     # @return [String] the value of the metadata field
     def metadata_field(file, field)
-      until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty?
-        file = File.absolute_path(File.dirname(file.to_s))
-      end
+      file = File.absolute_path(File.dirname(file.to_s)) until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty?
       file = File.dirname(file) unless File.extname(file).empty?
 
       md_path = File.join(file, "metadata.rb")
@@ -80,6 +76,7 @@ module FoodCritic
           command[ident/@value='#{field}']/
           descendant::tstring_content/@value").to_s
         raise "Cant read #{field} from #{md_path}" if value.to_s.empty?
+
         return value
       else
         raise "Cant find #{md_path}"
@@ -98,9 +95,7 @@ module FoodCritic
       begin
         metadata_field(file, "name")
       rescue RuntimeError
-        until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty?
-          file = File.absolute_path(File.dirname(file.to_s))
-        end
+        file = File.absolute_path(File.dirname(file.to_s)) until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty?
         file = File.dirname(file) unless File.extname(file).empty?
         File.basename(file)
       end
@@ -156,6 +151,7 @@ module FoodCritic
       if field_name.nil? || field_name.to_s.empty?
         raise ArgumentError, "Field name cannot be nil or empty"
       end
+
       ast.xpath("(.//command[ident/@value='#{field_name}']|.//fcall[ident/@value='#{field_name}']/..)")
     end
 
@@ -163,13 +159,14 @@ module FoodCritic
     def field_value(ast, field_name)
       field(ast, field_name).xpath('.//args_add_block//tstring_content
         [count(ancestor::args_add) = 1][count(ancestor::string_add) = 1]
-        /@value').map { |a| a.to_s }.last
+        /@value').map(&:to_s).last
     end
 
     # Create a match for a specified file. Use this if the presence of the file
     # triggers the warning rather than content.
     def file_match(file)
       raise ArgumentError, "Filename cannot be nil" if file.nil?
+
       { filename: file, matched: file, line: 1, column: 1 }
     end
 
@@ -189,10 +186,11 @@ module FoodCritic
     def find_resources(ast, options = {})
       options = { type: :any }.merge!(options)
       return [] unless ast.respond_to?(:xpath)
+
       scope_type = ""
       unless options[:type] == :any
-        type_array =  Array(options[:type]).map { |x| "@value='#{x}'" }
-        scope_type = "[#{type_array.join(' or ')}]"
+        type_array = Array(options[:type]).map { |x| "@value='#{x}'" }
+        scope_type = "[#{type_array.join(" or ")}]"
       end
 
       # TODO: Include nested resources (provider actions)
@@ -241,6 +239,7 @@ module FoodCritic
     # Searches with a query formed from a subexpression will be ignored.
     def literal_searches(ast)
       return [] unless ast.respond_to?(:xpath)
+
       ast.xpath("//method_add_arg[fcall/ident/@value = 'search' and
         count(descendant::string_embexpr) = 0]/descendant::tstring_content")
     end
@@ -250,23 +249,31 @@ module FoodCritic
       raise_unless_xpath!(node)
       pos = node.xpath("descendant::pos").first
       return nil if pos.nil?
+
       { matched: node.respond_to?(:name) ? node.name : "",
         line: pos["line"].to_i, column: pos["column"].to_i }
     end
 
+    # Returns a global LRU cache holding the AST of a file
+    # @since 16.1
+    # @param size [Integer] the size of the cache (will be resized)
+    def ast_cache(size = nil)
+      @@ast_cache ||= Rufus::Lru::Hash.new(size || 5)
+      if size && @@ast_cache.maxsize != size
+        @@ast_cache.maxsize = size
+      end
+      @@ast_cache
+    end
+
     # Read the AST for the given Ruby source file
     def read_ast(file)
-      @ast_cache ||= Rufus::Lru::Hash.new(5)
-      if @ast_cache.include?(file)
-        @ast_cache[file]
-      else
-        @ast_cache[file] = uncached_read_ast(file)
-      end
+      ast_cache[file] ||= uncached_read_ast(file)
     end
 
     # Retrieve a single-valued attribute from the specified resource.
     def resource_attribute(resource, name)
       raise ArgumentError, "Attribute name cannot be empty" if name.empty?
+
       resource_attributes(resource)[name.to_s]
     end
 
@@ -300,7 +307,8 @@ module FoodCritic
         if name.xpath("descendant::string_add").size == 1 &&
             name.xpath("descendant::string_literal").size == 1 &&
             name.xpath(
-              "descendant::*[self::call or self::string_embexpr]").empty?
+              "descendant::*[self::call or self::string_embexpr]"
+            ).empty?
           name.xpath("descendant::tstring_content/@value").to_s
         else
           name
@@ -314,7 +322,7 @@ module FoodCritic
     # Resources in an AST, keyed by type.
     def resources_by_type(ast)
       raise_unless_xpath!(ast)
-      result = Hash.new { |hash, key| hash[key] = Array.new }
+      result = Hash.new { |hash, key| hash[key] = [] }
       find_resources(ast).each do |resource|
         result[resource_type(resource)] << resource
       end
@@ -328,6 +336,7 @@ module FoodCritic
       if type.empty?
         raise ArgumentError, "Provided AST node is not a resource"
       end
+
       type
     end
 
@@ -344,6 +353,7 @@ module FoodCritic
     # Searches performed by the provided AST.
     def searches(ast)
       return [] unless ast.respond_to?(:xpath)
+
       ast.xpath("//fcall/ident[@value = 'search']")
     end
 
@@ -392,9 +402,10 @@ module FoodCritic
 
     def templates_included(all_templates, template_path, depth = 1)
       raise RecursedTooFarError.new(template_path) if depth > 10
+
       partials = read_ast(template_path).xpath('//*[self::command or
         child::fcall][descendant::ident/@value="render"]//args_add/
-        string_literal//tstring_content/@value').map { |p| p.to_s }
+        string_literal//tstring_content/@value').map(&:to_s)
       Array(template_path) + partials.map do |included_partial|
         partial_path = Array(all_templates).find do |path|
           (Pathname.new(template_path).dirname + included_partial).to_s == path
@@ -410,10 +421,10 @@ module FoodCritic
     def template_paths(recipe_path)
       Dir.glob(Pathname.new(recipe_path).dirname.dirname + "templates" +
         "**/*", File::FNM_DOTMATCH).select do |path|
-        File.file?(path)
-      end.reject do |path|
-        File.basename(path) == ".DS_Store" || File.extname(path) == ".swp"
-      end
+          File.file?(path)
+        end.reject do |path|
+          File.basename(path) == ".DS_Store" || File.extname(path) == ".swp"
+        end
     end
 
     # Give a filename path it returns the hash of the JSON contents
@@ -441,11 +452,11 @@ module FoodCritic
       atts = {}
       resource.xpath("do_block/descendant::method_add_block[
         count(ancestor::do_block) = 1][brace_block | do_block]").each do |batt|
-        att_name = batt.xpath("string(method_add_arg/fcall/ident/@value)")
-        if att_name && !att_name.empty? && batt.children.length > 1
-          atts[att_name] = batt.children[1]
+          att_name = batt.xpath("string(method_add_arg/fcall/ident/@value)")
+          if att_name && !att_name.empty? && batt.children.length > 1
+            atts[att_name] = batt.children[1]
+          end
         end
-      end
       atts
     end
 
@@ -517,7 +528,7 @@ module FoodCritic
     # those exist in cookbooks, but are not longer part of chef 14+
     # this prevents false positives in FC019 anytime node.set is found
     def node_method?(meth, cookbook_dir)
-      chef_dsl_methods.include?(meth) || meth == :set || meth == :set_unless ||
+      chef_node_methods.include?(meth) || meth == :set || meth == :set_unless ||
         patched_node_method?(meth, cookbook_dir)
     end
 
@@ -525,14 +536,15 @@ module FoodCritic
       atts = {}
       resource.xpath('do_block/descendant::*[self::command or
         self::method_add_arg][count(ancestor::do_block) >= 1]').each do |att|
-        blocks = att.xpath("ancestor::method_add_block/method_add_arg/fcall")
-        next if blocks.any? { |a| block_depth(a) > block_depth(resource) }
-        att_name = att.xpath('string(ident/@value |
-          fcall/ident[@value="variables"]/@value)')
-        unless att_name.empty?
-          atts[att_name] = extract_attribute_value(att, options)
+          blocks = att.xpath("ancestor::method_add_block/method_add_arg/fcall")
+          next if blocks.any? { |a| block_depth(a) > block_depth(resource) }
+
+          att_name = att.xpath('string(ident/@value |
+            fcall/ident[@value="variables"]/@value)')
+          unless att_name.empty?
+            atts[att_name] = extract_attribute_value(att, options)
+          end
         end
-      end
       atts
     end
 
@@ -573,6 +585,7 @@ module FoodCritic
     class AttFilter
       def is_att_type(value)
         return [] unless value.respond_to?(:select)
+
         value.select do |n|
           %w{
             automatic_attrs
@@ -599,7 +612,7 @@ module FoodCritic
 
     def standard_attribute_access(ast, options)
       if options[:type] == :any
-        [:string, :symbol].map do |type|
+        %i{string symbol}.map do |type|
           standard_attribute_access(ast, options.merge(type: type))
         end.inject(:+)
       else
@@ -644,13 +657,13 @@ module FoodCritic
         call.xpath("aref/args_add_block").size == 0 &&
           (call.xpath("descendant::ident").size > 1 &&
             !node_method?(call.xpath("ident/@value").to_s.to_sym,
-                          options[:cookbook_dir]))
+              options[:cookbook_dir]))
       end.sort
     end
 
     def word_list_values(ast, xpath = nil)
       # Find the node for the field argument variable. (e.g. given `foo d`, find `d`)
-      var_ref = ast.xpath("#{xpath ? xpath + '/' : ''}descendant::var_ref/ident")
+      var_ref = ast.xpath("#{xpath ? xpath + "/" : ""}descendant::var_ref/ident")
       if var_ref.empty?
         # The field is either a static value, or took no arguments, or something
         # more complex than we care to evaluate.
@@ -659,7 +672,7 @@ module FoodCritic
         # Look back out the tree for a method_add_block which contains a block
         # variable matching the field argument variable, and then drill down to
         # all the literal content nodes.
-        ast.xpath(%Q{ancestor::method_add_block[//block_var//ident/@value='#{var_ref.first['value']}']/call//tstring_content})
+        ast.xpath(%Q{ancestor::method_add_block[//block_var//ident/@value='#{var_ref.first["value"]}']/call//tstring_content})
       end
     end
   end

data/lib/foodcritic/chef.rb

@@ -56,12 +56,12 @@ module FoodCritic
           metadata_path(ver)
         end.find { |m| File.exist?(m) }
       @dsl_metadata ||= FFI_Yajl::Parser.parse(IO.read(metadata_path),
-                                           symbolize_keys: true)
+        symbolize_keys: true)
     end
 
     def metadata_path(chef_version)
       File.join(File.dirname(__FILE__), "..", "..",
-                "chef_dsl_metadata/chef_#{chef_version}.json")
+        "chef_dsl_metadata/chef_#{chef_version}.json")
     end
 
     def resource_check?(key, resource_type, field)
@@ -94,9 +94,11 @@ module FoodCritic
           grammar_paths.inject(nil) do |parser, lucene_grammar|
             begin
               break parser unless parser.nil?
+
               # Don't instantiate custom nodes
               Treetop.load_from_string(
-                IO.read(lucene_grammar).gsub(/<[^>]+>/, ""))
+                IO.read(lucene_grammar).gsub(/<[^>]+>/, "")
+              )
               LuceneParser.new
             rescue
               # Silently swallow and try the next grammar

data/lib/foodcritic/command_line.rb

@@ -24,74 +24,79 @@ module FoodCritic
         environment_paths: [],
         exclude_paths: ["test/**/*", "spec/**/*", "features/**/*"],
         progress: true,
+        ast_cache_size: 5,
       }
       @parser = OptionParser.new do |opts|
         opts.banner = "foodcritic [cookbook_paths]"
         opts.on("-t", "--tags TAGS",
-                "Check against (or exclude ~) rules with the "\
-                "specified tags.") do |t|
-          @options[:tags] << t
-        end
+          "Check against (or exclude ~) rules with the "\
+          "specified tags.") do |t|
+            @options[:tags] << t
+          end
         opts.on("-l", "--list",
-                "List all enabled rules and their descriptions.") do |t|
-          @options[:list] = t
-        end
+          "List all enabled rules and their descriptions.") do |t|
+            @options[:list] = t
+          end
         opts.on("-f", "--epic-fail TAGS",
-                "Fail the build based on tags. Default of 'any' to fail "\
-                "on all warnings.") do |t|
-          @options[:fail_tags] << t
-        end
+          "Fail the build based on tags. Default of 'any' to fail "\
+          "on all warnings.") do |t|
+            @options[:fail_tags] << t
+          end
         opts.on("-c", "--chef-version VERSION",
-                "Only check against rules valid for this version "\
-                "of Chef.") do |c|
-          @options[:chef_version] = c
-        end
+          "Only check against rules valid for this version "\
+          "of Chef.") do |c|
+            @options[:chef_version] = c
+          end
         opts.on("-r", "--rule-file PATH",
-                "Specify file with rules to be used or ignored ") do |c|
-          @options[:rule_file] = c
-        end
+          "Specify file with rules to be used or ignored ") do |c|
+            @options[:rule_file] = c
+          end
+        opts.on("-s", "--ast-cache-size NUM", Integer,
+          "Change the size of the AST cache.") do |s|
+            @options[:ast_cache_size] = s
+          end
         opts.on("-B", "--cookbook-path PATH",
-                "Cookbook path(s) to check.") do |b|
-          @options[:cookbook_paths] << b
-        end
+          "Cookbook path(s) to check.") do |b|
+            @options[:cookbook_paths] << b
+          end
         opts.on("-C", "--[no-]context",
-                "Show lines matched against rather than the "\
-                "default summary.") do |c|
-          @options[:context] = c
-        end
+          "Show lines matched against rather than the "\
+          "default summary.") do |c|
+            @options[:context] = c
+          end
         opts.on("-E", "--environment-path PATH",
-                "Environment path(s) to check.") do |e|
-          @options[:environment_paths] << e
-        end
+          "Environment path(s) to check.") do |e|
+            @options[:environment_paths] << e
+          end
         opts.on("-I", "--include PATH",
-                "Additional rule file path(s) to load.") do |i|
-          @options[:include_rules] << i
-        end
+          "Additional rule file path(s) to load.") do |i|
+            @options[:include_rules] << i
+          end
         opts.on("-G", "--search-gems",
-                "Search rubygems for rule files with the path "\
-                "foodcritic/rules/**/*.rb") do |g|
-          @options[:search_gems] = true
-        end
+          "Search rubygems for rule files with the path "\
+          "foodcritic/rules/**/*.rb") do |g|
+            @options[:search_gems] = true
+          end
         opts.on("-P", "--[no-]progress",
-                "Show progress of files being checked. default: true") do |q|
-          @options[:progress] = q
-        end
+          "Show progress of files being checked. default: true") do |q|
+            @options[:progress] = q
+          end
         opts.on("-R", "--role-path PATH",
-                "Role path(s) to check.") do |r|
-          @options[:role_paths] << r
-        end
+          "Role path(s) to check.") do |r|
+            @options[:role_paths] << r
+          end
         opts.on("-S", "--search-grammar PATH",
-                "Specify grammar to use when validating search syntax.") do |s|
-          @options[:search_grammar] = s
-        end
+          "Specify grammar to use when validating search syntax.") do |s|
+            @options[:search_grammar] = s
+          end
         opts.on("-V", "--version",
-                "Display the foodcritic version.") do |v|
-          @options[:version] = true
-        end
+          "Display the foodcritic version.") do |v|
+            @options[:version] = true
+          end
         opts.on("-X", "--exclude PATH",
-                "Exclude path(s) from being linted. PATH is relative to the cookbook, not an absolute PATH. Default test/**/*,spec/**/*,features/**/*") do |e|
-          options[:exclude_paths] << e
-        end
+          "Exclude path(s) from being linted. PATH is relative to the cookbook, not an absolute PATH. Default test/**/*,spec/**/*,features/**/*") do |e|
+            options[:exclude_paths] << e
+          end
       end
       # -v is not implemented but OptionParser gives the Foodcritic's version
       # if that flag is passed
@@ -106,6 +111,26 @@ module FoodCritic
       end
     end
 
+    # The end of life message.
+    #
+    # @return [String] A text to warn end users about foodcritic's end of life
+    def show_end_of_life_msg
+      "
+    *******************************************************************************
+    WARNING: Foodcritic will be end of life in April 2020
+    *******************************************************************************
+    Please use Cookstyle to ensure all of your Chef Infra code meets the latest
+    best practices.
+
+    Cookstyle is a code linting tool that helps you to write better Chef Infra
+    Cookbooks by detecting and automatically correct cookbook code.
+
+    For more information, use the command:
+
+    cookstyle -h
+      "
+    end
+
     # Show the command help to the end user?
     #
     # @return [Boolean] True if help should be shown.
@@ -113,11 +138,11 @@ module FoodCritic
       @args.length == 1 && @args.first == "--help"
     end
 
-    # The help text.
+    # The help text plus the end of life message.
     #
     # @return [String] Help text describing the command-line options available.
     def help
-      @parser.help
+      @parser.help + show_end_of_life_msg
     end
 
     # Show the current version to the end user?
@@ -157,6 +182,7 @@ module FoodCritic
     def valid_grammar?
       return true unless options.key?(:search_grammar)
       return false unless File.exist?(options[:search_grammar])
+
       search = FoodCritic::Chef::Search.new
       search.create_parser([options[:search_grammar]])
       search.parser?