foodcritic 16.1.1 → 16.2.0

data/lib/foodcritic/domain.rb

@@ -34,7 +34,7 @@ module FoodCritic
 
     def to_s
       @rules.sort_by(&:code)
-        .map { |r| r.to_s }.join("\n")
+        .map(&:to_s).join("\n")
     end
 
   end
@@ -50,12 +50,12 @@ module FoodCritic
 
     # If any of the warnings in this review have failed or not.
     def failed?
-      warnings.any? { |w| w.failed? }
+      warnings.any?(&:failed?)
     end
 
     # Returns an array of warnings that are marked as failed.
     def failures
-      warnings.select { |w| w.failed? }
+      warnings.select(&:failed?)
     end
 
     # Returns a string representation of this review. This representation is
@@ -76,8 +76,8 @@ module FoodCritic
   # A rule to be matched against.
   class Rule
     attr_accessor :code, :name, :applies_to, :cookbook, :attributes, :recipe,
-                  :provider, :resource, :metadata, :library, :template, :role,
-                  :environment
+      :provider, :resource, :metadata, :library, :template, :role,
+      :environment
 
     attr_writer :tags
 

data/lib/foodcritic/dsl.rb

@@ -1,3 +1,4 @@
+require "open-uri"
 require "pathname"
 
 module FoodCritic
@@ -76,7 +77,9 @@ module FoodCritic
       paths.map do |path|
         File.directory?(path) ? Dir["#{path}/**/*.rb"].sort : path
       end.flatten.each do |path|
-        dsl.instance_eval(File.read(path), path)
+        rule_file = open(path)
+        dsl.instance_eval(rule_file.read, path)
+        rule_file.close
       end
       dsl.rules
     end

data/lib/foodcritic/linter.rb

@@ -1,3 +1,4 @@
+require "open-uri"
 require "optparse"
 require "ripper"
 require "set"
@@ -9,7 +10,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 = "15.1.36".freeze
+    DEFAULT_CHEF_VERSION = "15.4.45".freeze
     attr_reader :chef_version
 
     # Perform a lint check. This method is intended for use by the command-line
@@ -19,6 +20,7 @@ module FoodCritic
       # The first item is the string output, the second is exit code.
       return [cmd_line.help, 0] if cmd_line.show_help?
       return [cmd_line.version, 0] if cmd_line.show_version?
+
       if !cmd_line.valid_grammar?
         [cmd_line.help, 4]
       elsif cmd_line.list_rules?
@@ -112,8 +114,8 @@ module FoodCritic
           # Convert the matches into warnings
           matches.each do |match|
             warnings << Warning.new(state[:rule],
-                                    { filename: state[:file] }.merge(match),
-                                    options)
+              { filename: state[:file] }.merge(match),
+              options)
             matched_rule_tags << state[:rule].tags
           end
         end
@@ -133,16 +135,19 @@ module FoodCritic
 
       if dsl_method_for_file(state[:file])
         cbk_matches += matches(state[:rule].send(
-          dsl_method_for_file(state[:file])), state[:ast], state[:file])
+          dsl_method_for_file(state[:file])
+        ), state[:ast], state[:file])
       end
 
       per_cookbook_rules(state[:last_dir], state[:file]) do
         if File.basename(state[:file]) == "metadata.rb"
           cbk_matches += matches(
-            state[:rule].metadata, state[:ast], state[:file])
+            state[:rule].metadata, state[:ast], state[:file]
+          )
         end
         cbk_matches += matches(
-          state[:rule].cookbook, cookbook_dir(state[:file]))
+          state[:rule].cookbook, cookbook_dir(state[:file])
+        )
       end
 
       cbk_matches
@@ -197,6 +202,7 @@ module FoodCritic
     # Some rules are version specific.
     def applies_to_version?(rule, version)
       return true unless version
+
       rule.applies_to.yield(Gem::Version.create(version))
     end
 
@@ -217,7 +223,8 @@ module FoodCritic
 
       # if a rule file has been specified use that. Otherwise use the .foodcritic file in the CB
       tags = if @options[:rule_file]
-               raise "ERROR: Could not find the specified rule file at #{@options[:rule_file]}" unless File.exist?(@options[:rule_file])
+               raise "ERROR: Could not find the specified rule file at #{@options[:rule_file]}" if is_local_file?(@options[:rule_file]) && ! File.exist?(@options[:rule_file])
+
                parse_rule_file(@options[:rule_file])
              else
                File.exist?("#{cookbook}/.foodcritic") ? parse_rule_file("#{cookbook}/.foodcritic") : []
@@ -234,7 +241,9 @@ module FoodCritic
     def parse_rule_file(file)
       tags = []
       begin
-        tag_text = File.read file
+        rule_file = open(file)
+        tag_text = rule_file.read
+        rule_file.close
         tags = tag_text.split(/\s/)
       rescue
         raise "ERROR: Could not read or parse the specified rule file at #{file}"
@@ -339,9 +348,15 @@ module FoodCritic
       end.flatten
     end
 
+    # Determine if the rule file name is a local file or a url
+    def is_local_file?(file_name)
+      ! /^(ftps*:|https*:|file:)/.match(file_name)
+    end
+
     # Invoke the DSL method with the provided parameters.
     def matches(match_method, *params)
       return [] unless match_method.respond_to?(:yield)
+
       matches = match_method.yield(*params)
       return [] unless matches.respond_to?(:each)
 

data/lib/foodcritic/notifications.rb

@@ -133,13 +133,15 @@ module FoodCritic
       is_variable = true unless notify.xpath("args_add_block/args_add//args_add[aref or vcall or call or var_ref]").empty?
       string_val = notify.xpath("descendant::args_add/string_literal/string_add/tstring_content/@value").first
       symbol_val = notify.xpath('descendant::args_add/args_add//symbol/ident/@value |
-        descendant::dyna_symbol[1]/xstring_add/tstring_content/@value').first
+        descendant::dyna_symbol[1]/xstring_add/tstring_content/@value |
+        descendant::args_add/args_add//dyna_symbol/string_add/tstring_content/@value').first
 
       # 1) return a nil if the action is a variable like node['foo']['bar']
       # 2) return the symbol if it exists
       # 3) return the string since we're positive that we're not a symbol or variable
       return nil if is_variable
       return symbol_val.value.to_sym unless symbol_val.nil?
+
       string_val.value
     end
 

data/lib/foodcritic/output.rb

@@ -128,7 +128,7 @@ module FoodCritic
       fmt << 40 + colors.index(bg.to_s) if bg
       fmt << attrs.index(attr.to_s) if attr
       if fmt
-        puts "#{escape % fmt.join(';')}#{text}#{escape % 0}"
+        puts "#{escape % fmt.join(";")}#{text}#{escape % 0}"
       else
         puts text
       end

data/lib/foodcritic/rules/fc001.rb

@@ -1,8 +1,8 @@
 rule "FC001",
-     "Use strings in preference to symbols to access node attributes" do
-  tags %w{style attributes}
-  recipe do |ast|
-    # node.run_state is not actually an attribute so ignore that
-    attribute_access(ast, type: :symbol, ignore: "run_state")
+  "Use strings in preference to symbols to access node attributes" do
+    tags %w{style attributes}
+    recipe do |ast|
+      # node.run_state is not actually an attribute so ignore that
+      attribute_access(ast, type: :symbol, ignore: "run_state")
+    end
   end
-end

data/lib/foodcritic/rules/fc004.rb

@@ -4,6 +4,7 @@ rule "FC004", "Use a service resource to start and stop services" do
     find_resources(ast, type: "execute").find_all do |cmd|
       cmd_str = (resource_attribute(cmd, "command") || resource_name(cmd)).to_s
       next if cmd_str.include?(".exe") # don't catch windows commands
+
       cmd_str.start_with?( "start ", "stop ", "reload ", "restart ") || # upstart jobs
         ( [ "/etc/init.d", "service ", "/sbin/service ", "invoke-rc.d ", "systemctl "].any? do |service_cmd| # upstart / sys-v / systemd
           cmd_str.start_with?(service_cmd)

data/lib/foodcritic/rules/fc006.rb

@@ -1,11 +1,11 @@
 rule "FC006", "Mode should be quoted or fully specified when "\
      "setting file permissions" do
-  tags %w{correctness files}
-  recipe do |ast|
-    ast.xpath(%q{//ident[@value='mode']/parent::command/
-      descendant::int[string-length(@value) < 5
-      and not(starts-with(@value, "0")
-      and string-length(@value) = 4)][count(ancestor::aref) = 0]/
-      ancestor::method_add_block})
-  end
-end
+       tags %w{correctness files}
+       recipe do |ast|
+         ast.xpath(%q{//ident[@value='mode']/parent::command/
+           descendant::int[string-length(@value) < 5
+           and not(starts-with(@value, "0")
+           and string-length(@value) = 4)][count(ancestor::aref) = 0]/
+           ancestor::method_add_block})
+       end
+     end

data/lib/foodcritic/rules/fc007.rb

@@ -2,8 +2,10 @@ rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
   tags %w{correctness metadata}
   recipe do |ast, filename|
     metadata_path = Pathname.new(
-      File.join(File.dirname(filename), "..", "metadata.rb")).cleanpath
+      File.join(File.dirname(filename), "..", "metadata.rb")
+    ).cleanpath
     next unless File.exist? metadata_path
+
     actual_included = included_recipes(ast, with_partial_names: false)
     undeclared = actual_included.keys.map do |recipe|
       recipe.split("::").first unless recipe =~ /^::/ # skip shorthand included recipes. They're local

data/lib/foodcritic/rules/fc016.rb

@@ -3,6 +3,7 @@ rule "FC016", "LWRP does not declare a default action" do
   resource do |ast, filename|
     # See if we're in a custom resource not an LWRP. Only LWRPs need the default_action
     next if ast.xpath("//ident/@value='action'")
+
     unless ["//ident/@value='default_action'",
      "//def/bodystmt/descendant::assign/
       var_field/ivar/@value='@action'"].any? { |expr| ast.xpath(expr) }

data/lib/foodcritic/rules/fc019.rb

@@ -3,20 +3,21 @@ rule "FC019", "Access node attributes in a consistent manner" do
   cookbook do |cookbook_dir|
     asts = {}; files = Dir["#{cookbook_dir}/*/*.rb"].reject do |file|
       relative_path = Pathname.new(file).relative_path_from(
-        Pathname.new(cookbook_dir))
+        Pathname.new(cookbook_dir)
+      )
       relative_path.to_s.split(File::SEPARATOR).include?("spec")
     end.map do |file|
       { path: file, ast: read_ast(file) }
     end
-    types = [:string, :symbol, :vivified].map do |type|
+    types = %i{string symbol vivified}.map do |type|
       {
         access_type: type, count: files.map do |file|
           attribute_access(file[:ast], type: type, ignore_calls: true,
                                        cookbook_dir: cookbook_dir, ignore: "run_state").tap do |ast|
-            unless ast.empty?
-              (asts[type] ||= []) << { ast: ast, path: file[:path] }
-            end
-          end.size
+                                         unless ast.empty?
+                                           (asts[type] ||= []) << { ast: ast, path: file[:path] }
+                                         end
+                                       end.size
         end.inject(:+)
       }
     end.reject { |type| type[:count] == 0 }

data/lib/foodcritic/rules/fc022.rb

@@ -4,30 +4,29 @@ rule "FC022", "Resource condition within loop may not behave as expected" do
     ast.xpath("//call[ident/@value='each']/../do_block[count(ancestor::
               method_add_block/method_add_arg/fcall/ident[@value='only_if' or
               @value = 'not_if']) = 0]").map do |lp|
-      block_vars = lp.xpath("block_var/params/child::*").map do |n|
-        n.name.sub(/^ident/, "")
-      end + lp.xpath("block_var/params/child::*/descendant::ident").map do |v|
-        v["value"]
-      end
-      find_resources(lp).map do |resource|
-        # if any of the parameters to the block are used in a condition then we
-        # have a match
-        unless (block_vars &
-          (resource.xpath(%q{descendant::ident[@value='not_if' or
-          @value='only_if']/ancestor::*[self::method_add_block or
-          self::command][1]/descendant::ident/@value}).map do |a|
-            a.value
-          end)).empty?
-          c = resource.xpath("command[count(descendant::string_embexpr) = 0]")
-          if resource.xpath("command/ident/@value").first.value == "define"
-            next
-          end
-          resource unless c.empty? || block_vars.any? do |var|
-            !resource.xpath(%Q{command/args_add_block/args_add/
-              var_ref/ident[@value='#{var}']}).empty?
-          end
-        end
-      end
-    end.flatten.compact
+                block_vars = lp.xpath("block_var/params/child::*").map do |n|
+                  n.name.sub(/^ident/, "")
+                end + lp.xpath("block_var/params/child::*/descendant::ident").map do |v|
+                  v["value"]
+                end
+                find_resources(lp).map do |resource|
+                  # if any of the parameters to the block are used in a condition then we
+                  # have a match
+                  unless (block_vars &
+                    (resource.xpath(%q{descendant::ident[@value='not_if' or
+                    @value='only_if']/ancestor::*[self::method_add_block or
+                    self::command][1]/descendant::ident/@value}).map(&:value))).empty?
+                    c = resource.xpath("command[count(descendant::string_embexpr) = 0]")
+                    if resource.xpath("command/ident/@value").first.value == "define"
+                      next
+                    end
+
+                    resource unless c.empty? || block_vars.any? do |var|
+                      !resource.xpath(%Q{command/args_add_block/args_add/
+                        var_ref/ident[@value='#{var}']}).empty?
+                    end
+                  end
+                end
+              end.flatten.compact
   end
 end

data/lib/foodcritic/rules/fc024.rb

@@ -3,11 +3,14 @@ rule "FC024", "Consider adding platform equivalents" do
   RHEL = %w{centos redhat scientific oracle}.freeze
   recipe do |ast, filename|
     next if Pathname.new(filename).basename.to_s == "metadata.rb"
+
     metadata_path = Pathname.new(
-      File.join(File.dirname(filename), "..", "metadata.rb")).cleanpath
+      File.join(File.dirname(filename), "..", "metadata.rb")
+    ).cleanpath
     md_platforms = if File.exist?(metadata_path)
                      supported_platforms(read_ast(
-                       metadata_path)).map { |p| p[:platform] }
+                       metadata_path
+                     )).map { |p| p[:platform] }
                    else
                      []
                    end
@@ -16,16 +19,16 @@ rule "FC024", "Consider adding platform equivalents" do
     ['//method_add_arg[fcall/ident/@value="platform?"]/
       arg_paren/args_add_block',
      "//when"].map do |expr|
-      ast.xpath(expr).map do |whn|
-        platforms = whn.xpath('args_add/
-                               descendant::tstring_content').map do |p|
-          p["value"]
-        end.sort
-        unless platforms.size == 1 || (md_platforms & platforms).empty?
-          whn unless (platforms & RHEL).empty? ||
-              ((md_platforms & RHEL) - (platforms & RHEL)).empty?
-        end
-      end.compact
-    end.flatten
+       ast.xpath(expr).map do |whn|
+         platforms = whn.xpath('args_add/
+                                descendant::tstring_content').map do |p|
+                                  p["value"]
+                                end.sort
+         unless platforms.size == 1 || (md_platforms & platforms).empty?
+           whn unless (platforms & RHEL).empty? ||
+             ((md_platforms & RHEL) - (platforms & RHEL)).empty?
+         end
+       end.compact
+     end.flatten
   end
 end

data/lib/foodcritic/rules/fc029.rb

@@ -3,6 +3,7 @@ rule "FC029", "No leading cookbook name in recipe metadata" do
   metadata do |ast, filename|
     field(ast, "recipe").map do |declared_recipe|
       next unless declared_recipe.xpath("count(//vcall|//var_ref)").to_i == 0
+
       recipe_name = declared_recipe.xpath('args_add_block/
         descendant::tstring_content[1]/@value').to_s
       unless recipe_name.empty? ||

data/lib/foodcritic/rules/fc031.rb

@@ -1,7 +1,7 @@
 rule "FC031", "Cookbook without metadata.rb file" do
   tags %w{correctness metadata}
   cookbook do |filename|
-    if !File.exist?(File.join(filename, "metadata.rb"))
+    unless File.exist?(File.join(filename, "metadata.rb"))
       [file_match(File.join(filename, "metadata.rb"))]
     end
   end

data/lib/foodcritic/rules/fc032.rb

@@ -2,9 +2,9 @@ rule "FC032", "Invalid notification timing" do
   tags %w{correctness notifications}
   recipe do |ast|
     valid_timings = if resource_attribute?("file", "notifies_before")
-                      [:delayed, :immediate, :before]
+                      %i{delayed immediate before}
                     else
-                      [:delayed, :immediate]
+                      %i{delayed immediate}
                     end
     find_resources(ast).select do |resource|
       notifications(resource).any? do |notification|

data/lib/foodcritic/rules/fc033.rb

@@ -9,7 +9,7 @@ rule "FC033", "Missing template file" do
     end.map do |resource|
       # fetch the specified file to the template
       file = template_file(resource_attributes(resource,
-                                               return_expressions: true))
+        return_expressions: true))
       { resource: resource, file: file }
     end.reject do |resource|
       # skip the check if the file path is derived since
@@ -25,7 +25,7 @@ rule "FC033", "Missing template file" do
           # templates/ubuntu/something.erb down to something.erb, which breaks
           # legit nested dirs in the templates dir like templates/something/something.erb
           break if template_path.dirname.basename.to_s == "templates" ||
-              template_path.dirname.dirname.basename.to_s == "templates"
+            template_path.dirname.dirname.basename.to_s == "templates"
         end
         File.join(relative_path.reverse) == resource[:file]
       end

data/lib/foodcritic/rules/fc034.rb

@@ -9,13 +9,16 @@ rule "FC034", "Unused template variables" do
         File.basename(path) == template_file(resource)
       end
       next unless template_paths.any?
+
       passed_vars = resource["variables"].xpath(
-        "symbol/ident/@value").map { |tv| tv.to_s }
+        "symbol/ident/@value"
+      ).map(&:to_s)
 
       unused_vars_exist = template_paths.all? do |template_path|
         begin
           template_vars = templates_included(
-            all_templates, template_path).map do |template|
+            all_templates, template_path
+          ).map do |template|
             read_ast(template).xpath("//var_ref/ivar/@value").map do |v|
               v.to_s.sub(/^@/, "")
             end

data/lib/foodcritic/rules/fc039.rb

@@ -3,17 +3,17 @@ rule "FC039", "Node method cannot be accessed with key" do
   recipe do |ast|
     [{ type: :string, path: "@value" },
      { type: :symbol, path: "ident/@value" }].map do |access_type|
-      attribute_access(ast, type: access_type[:type]).select do |att|
-        att_name = att.xpath(access_type[:path]).to_s.to_sym
-        att_name != :tags && chef_node_methods.include?(att_name)
-      end.select do |att|
-        !att.xpath('ancestor::args_add_block[position() = 1]
-          [preceding-sibling::vcall | preceding-sibling::var_ref]').empty?
-      end.select do |att|
-        att_type = att.xpath('ancestor::args_add_block[position() = 1]
-          /../var_ref/ident/@value').to_s
-        ast.xpath("//assign/var_field/ident[@value='#{att_type}']").empty?
-      end
-    end.flatten
+       attribute_access(ast, type: access_type[:type]).select do |att|
+         att_name = att.xpath(access_type[:path]).to_s.to_sym
+         att_name != :tags && chef_node_methods.include?(att_name)
+       end.select do |att|
+         !att.xpath('ancestor::args_add_block[position() = 1]
+           [preceding-sibling::vcall | preceding-sibling::var_ref]').empty?
+       end.select do |att|
+         att_type = att.xpath('ancestor::args_add_block[position() = 1]
+           /../var_ref/ident/@value').to_s
+         ast.xpath("//assign/var_field/ident[@value='#{att_type}']").empty?
+       end
+     end.flatten
   end
 end