foodcritic 7.0.1 → 7.1.0

data/lib/foodcritic/chef.rb

@@ -23,7 +23,7 @@ module FoodCritic
 
     # Is this a valid Lucene query?
     def valid_query?(query)
-      fail ArgumentError, 'Query cannot be nil or empty' if query.to_s.empty?
+      raise ArgumentError, "Query cannot be nil or empty" if query.to_s.empty?
 
       # Attempt to create a search query parser
       search = FoodCritic::Chef::Search.new
@@ -51,7 +51,7 @@ module FoodCritic
                 else
                   Linter::DEFAULT_CHEF_VERSION
                 end
-      metadata_path = [version, version.sub(/\.[a-z].*/, ''),
+      metadata_path = [version, version.sub(/\.[a-z].*/, ""),
         Linter::DEFAULT_CHEF_VERSION].map do |version|
           metadata_path(version)
         end.find { |m| File.exist?(m) }
@@ -60,13 +60,13 @@ module FoodCritic
     end
 
     def metadata_path(chef_version)
-      File.join(File.dirname(__FILE__), '..', '..',
+      File.join(File.dirname(__FILE__), "..", "..",
                 "chef_dsl_metadata/chef_#{chef_version}.json")
     end
 
     def resource_check?(key, resource_type, field)
       if resource_type.to_s.empty? || field.to_s.empty?
-        fail ArgumentError, 'Arguments cannot be nil or empty.'
+        raise ArgumentError, "Arguments cannot be nil or empty."
       end
 
       load_metadata
@@ -85,23 +85,23 @@ module FoodCritic
       # lucene.treetop used to be provided by chef gem
       # We're keeping a local copy from chef 10.x
       def chef_search_grammars
-        [File.expand_path('../../..', __FILE__) + "/misc/lucene.treetop"]
+        [File.expand_path("../../..", __FILE__) + "/misc/lucene.treetop"]
       end
 
       # Create the search parser from the first loadable grammar.
       def create_parser(grammar_paths)
         @search_parser ||=
           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(/<[^>]+>/, ''))
-            LuceneParser.new
-          rescue
-            # Silently swallow and try the next grammar
+            begin
+              break parser unless parser.nil?
+              # Don't instantiate custom nodes
+              Treetop.load_from_string(
+                IO.read(lucene_grammar).gsub(/<[^>]+>/, ""))
+              LuceneParser.new
+            rescue
+              # Silently swallow and try the next grammar
+            end
           end
-        end
       end
 
       # Has the search parser been loaded?

data/lib/foodcritic/command_line.rb

@@ -14,75 +14,75 @@ module FoodCritic
         cookbook_paths: [],
         role_paths: [],
         environment_paths: [],
-        exclude_paths: []
+        exclude_paths: [],
       }
       @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|
+        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
-        opts.on('-l', '--list',
-                'List all enabled rules and their descriptions.') do |t|
+        opts.on("-l", "--list",
+                "List all enabled rules and their descriptions.") do |t|
           @options[:list] = t
-        end                
-        opts.on('-f', '--epic-fail TAGS',
+        end
+        opts.on("-f", "--epic-fail TAGS",
                 "Fail the build based on tags. Use 'any' to fail "\
-                'on all warnings.') do |t|
+                "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|
+        opts.on("-c", "--chef-version VERSION",
+                "Only check against rules valid for this version "\
+                "of Chef.") do |c|
           @options[:chef_version] = c
         end
-        opts.on('-B', '--cookbook-path PATH',
-                'Cookbook path(s) to check.') do |b|
+        opts.on("-B", "--cookbook-path PATH",
+                "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|
+        opts.on("-C", "--[no-]context",
+                "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|
+        opts.on("-E", "--environment-path PATH",
+                "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|
+        opts.on("-I", "--include PATH",
+                "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|
+        opts.on("-G", "--search-gems",
+                "Search rubygems for rule files with the path "\
+                "foodcritic/rules/**/*.rb") do |g|
           @options[:search_gems] = true
         end
         opts.on("-P", "--progress",
                 "Show progress of files being checked") do
           @options[:progress] = true
         end
-        opts.on('-R', '--role-path PATH',
-                'Role path(s) to check.') do |r|
+        opts.on("-R", "--role-path PATH",
+                "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|
+        opts.on("-S", "--search-grammar PATH",
+                "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|
+        opts.on("-V", "--version",
+                "Display the foodcritic version.") do |v|
           @options[:version] = true
         end
-        opts.on('-X', '--exclude PATH',
-                'Exclude path(s) from being linted.') do |e|
+        opts.on("-X", "--exclude PATH",
+                "Exclude path(s) from being linted.") do |e|
           options[:exclude_paths] << e
         end
       end
       # -v is not implemented but OptionParser gives the Foodcritic's version
       # if that flag is passed
-      if args.include? '-v'
+      if args.include? "-v"
         help
       else
         begin
@@ -97,7 +97,7 @@ module FoodCritic
     #
     # @return [Boolean] True if help should be shown.
     def show_help?
-      @args.length == 1 && @args.first == '--help'
+      @args.length == 1 && @args.first == "--help"
     end
 
     # The help text.

data/lib/foodcritic/domain.rb

@@ -1,4 +1,4 @@
-require 'cucumber/core/gherkin/tag_expression'
+require "cucumber/core/gherkin/tag_expression"
 
 module FoodCritic
   # A warning of a possible issue
@@ -33,7 +33,7 @@ module FoodCritic
     end
 
     def to_s
-      @rules.sort { |a,b| a.code <=> b.code }.
+      @rules.sort { |a, b| a.code <=> b.code }.
         map { |r| r.to_s }.join("\n")
     end
 
@@ -69,7 +69,7 @@ module FoodCritic
          w.match[:line].to_i]
       end.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.map { |w| "#{w.first}:#{w[1]}" }.uniq.join("\n")
     end
   end
 
@@ -90,7 +90,7 @@ module FoodCritic
     # The tags associated with this rule. Rule is always tagged with the tag
     # `any` and the rule code.
     def tags
-      ['any'] + @tags
+      ["any"] + @tags
     end
 
     # Checks the rule tags to see if they match a Gherkin (Cucumber) expression

data/lib/foodcritic/dsl.rb

@@ -1,4 +1,4 @@
-require 'pathname'
+require "pathname"
 
 module FoodCritic
   # The DSL methods exposed for defining rules. A minimal example rule:
@@ -59,7 +59,6 @@ module FoodCritic
     # `recipe` rule blocks are also evaluated against providers.
     rule_block :recipe
 
-
     rule_block :cookbook
     rule_block :metadata
     rule_block :resource

data/lib/foodcritic/linter.rb

@@ -1,6 +1,6 @@
-require 'optparse'
-require 'ripper'
-require 'set'
+require "optparse"
+require "ripper"
+require "set"
 
 module FoodCritic
   # The main entry point for linting your Chef cookbooks.
@@ -9,7 +9,7 @@ module FoodCritic
 
     # The default version that will be used to determine relevant rules. This
     # can be over-ridden at the command line with the `--chef-version` option.
-    DEFAULT_CHEF_VERSION = '12.11.18'
+    DEFAULT_CHEF_VERSION = "12.13.37"
     attr_reader :chef_version
 
     # Perform a lint check. This method is intended for use by the command-line
@@ -51,7 +51,6 @@ module FoodCritic
       RuleList.new(@rules)
     end
 
-
     # Review the cookbooks at the provided path, identifying potential
     # improvements.
     #
@@ -88,7 +87,7 @@ module FoodCritic
                           cookbook_tags(p[:filename])
                         end
 
-        progress = '.'
+        progress = "."
 
         active_rules(relevant_tags).each do |rule|
           state = {
@@ -96,7 +95,7 @@ module FoodCritic
             file: p[:filename],
             ast: read_ast(p[:filename]),
             rule: rule,
-            last_dir: last_dir
+            last_dir: last_dir,
           }
 
           matches = if p[:path_type] == :cookbook
@@ -107,7 +106,7 @@ module FoodCritic
 
           matches = remove_ignored(matches, state[:rule], state[:file])
 
-          progress = 'x' if matches.any?
+          progress = "x" if matches.any?
 
           # Convert the matches into warnings
           matches.each do |match|
@@ -123,7 +122,7 @@ module FoodCritic
         last_dir = cookbook_dir(p[:filename])
       end
 
-      puts '' if options[:progress]
+      puts "" if options[:progress]
 
       Review.new(paths, warnings)
     end
@@ -137,7 +136,7 @@ module FoodCritic
       end
 
       per_cookbook_rules(state[:last_dir], state[:file]) do
-        if File.basename(state[:file]) == 'metadata.rb'
+        if File.basename(state[:file]) == "metadata.rb"
           cbk_matches += matches(
             state[:rule].metadata, state[:ast], state[:file])
         end
@@ -158,7 +157,7 @@ module FoodCritic
     end
 
     def load_rules!(options)
-      rule_files = [File.join(File.dirname(__FILE__), 'rules.rb')]
+      rule_files = [File.join(File.dirname(__FILE__), "rules.rb")]
       rule_files << options[:include_rules]
       rule_files << rule_files_in_gems if options[:search_gems]
       @rules = RuleDsl.load(rule_files.flatten.compact, chef_version)
@@ -168,7 +167,7 @@ module FoodCritic
 
     def rule_files_in_gems
       Gem::Specification.latest_specs(true).map do |spec|
-        spec.matches_for_glob('foodcritic/rules/**/*.rb')
+        spec.matches_for_glob("foodcritic/rules/**/*.rb")
       end.flatten
     end
 
@@ -176,14 +175,14 @@ module FoodCritic
       matches.reject do |m|
         matched_file = m[:filename] || file
         (line = m[:line]) && File.exist?(matched_file) &&
-           !File.directory?(matched_file) &&
-           ignore_line_match?(File.readlines(matched_file)[line - 1], rule)
+          !File.directory?(matched_file) &&
+          ignore_line_match?(File.readlines(matched_file)[line - 1], rule)
       end
     end
 
     def ignore_line_match?(line, rule)
       ignores = line.to_s[/\s+#\s*(.*)/, 1]
-      if ignores && ignores.include?('~')
+      if ignores && ignores.include?("~")
         !rule.matches_tags?(ignores.split(/[ ,]/))
       else
         false
@@ -220,21 +219,21 @@ module FoodCritic
     def cookbook_dir(file)
       Pathname.new(File.join(File.dirname(file),
                              case File.basename(file)
-                             when 'metadata.rb' then ''
-                             when /\.erb$/ then '../..'
-                             else '..'
+                             when "metadata.rb" then ""
+                             when /\.erb$/ then "../.."
+                             else ".."
                              end)).cleanpath
     end
 
     def dsl_method_for_file(file)
       dir_mapping = {
-        'attributes' => :attributes,
-        'libraries' => :library,
-        'providers' => :provider,
-        'resources' => :resource,
-        'templates' => :template
+        "attributes" => :attributes,
+        "libraries" => :library,
+        "providers" => :provider,
+        "resources" => :resource,
+        "templates" => :template,
       }
-      if file.end_with? '.erb'
+      if file.end_with? ".erb"
         dir_mapping[File.basename(File.dirname(File.dirname(file)))]
       else
         dir_mapping[File.basename(File.dirname(file))]
@@ -250,16 +249,16 @@ module FoodCritic
 
           unless paths[:exclude].empty?
             exclusions = Dir.glob(paths[:exclude].map do |p|
-              File.join(dir, p, '**/**')
+              File.join(dir, p, "**/**")
             end)
           end
 
           if File.directory?(dir)
             glob = if path_type == :cookbook
-                     '{metadata.rb,{attributes,definitions,libraries,'\
-                     'providers,recipes,resources}/*.rb,templates/*/*.erb}'
+                     "{metadata.rb,{attributes,definitions,libraries,"\
+                     "providers,recipes,resources}/*.rb,templates/*/*.erb}"
                    else
-                     '*.rb'
+                     "*.rb"
                    end
 
             (Dir.glob(File.join(dir, glob)) +
@@ -297,21 +296,21 @@ module FoodCritic
 
     def specified_paths!(options)
       paths = Hash[options.map do |key, value|
-        [key, Array(value)] if key.to_s.end_with?('paths')
+        [key, Array(value)] if key.to_s.end_with?("paths")
       end.compact]
 
       unless paths.find { |k, v| k != :exclude_paths && !v.empty? }
-        fail ArgumentError, 'A cookbook path or role path must be specified'
+        raise ArgumentError, "A cookbook path or role path must be specified"
       end
 
       Hash[paths.map do |key, value|
-        [key.to_s.sub(/_paths$/, '').to_sym, value]
+        [key.to_s.sub(/_paths$/, "").to_sym, value]
       end]
     end
 
     def setup_defaults(options)
       { tags: [], fail_tags: [], include_rules: [], exclude_paths: [],
-       cookbook_paths: [], role_paths: [] }.merge(options)
+        cookbook_paths: [], role_paths: [] }.merge(options)
     end
   end
 end

data/lib/foodcritic/notifications.rb

@@ -51,7 +51,7 @@ module FoodCritic
             action: notification_action(notify),
 
             # The notification timing: `:before`, `:immediate` or `:delayed`.
-            timing: notification_timing(notify)
+            timing: notification_timing(notify),
           }
         )
       end.compact
@@ -80,11 +80,11 @@ module FoodCritic
       # Normally the `resource_name` will be a simple string. However in the
       # case where it has an embedded sub-expression then we will return the
       # AST to the caller to handle.
-      if notify.xpath('descendant::string_embexpr').empty?
+      if notify.xpath("descendant::string_embexpr").empty?
         return nil if resource_name.empty?
       else
         resource_name =
-          notify.xpath('args_add_block/args_add/string_literal')
+          notify.xpath("args_add_block/args_add/string_literal")
       end
       { resource_name: resource_name, resource_type: resource_type }
     end
@@ -93,7 +93,7 @@ module FoodCritic
     # notification.
     def old_style_notification(notify)
       resources = resource_hash_references(notify)
-      resource_type = resources.xpath('symbol[1]/ident/@value').to_s.to_sym
+      resource_type = resources.xpath("symbol[1]/ident/@value").to_s.to_sym
       resource_name = resources.xpath('string_add[1][count(../
         descendant::string_add) = 1]/tstring_content/@value').to_s
       resource_name = resources if resource_name.empty?
@@ -136,7 +136,7 @@ module FoodCritic
     end
 
     def notification_type(notify)
-      notify.xpath('ident/@value[1] | fcall/ident/@value[1]').to_s.to_sym
+      notify.xpath("ident/@value[1] | fcall/ident/@value[1]").to_s.to_sym
     end
 
     def resource_hash_references(ast)