foodcritic 15.1.0 → 16.3.0

data/lib/foodcritic/domain.rb

@@ -1,5 +1,3 @@
-require "cucumber/core/gherkin/tag_expression"
-
 module FoodCritic
   # A warning of a possible issue
   class Warning
@@ -34,7 +32,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 +48,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 +74,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
 
@@ -95,8 +93,8 @@ module FoodCritic
 
     # Checks the rule tags to see if they match a Gherkin (Cucumber) expression
     def matches_tags?(tag_expr)
-      Cucumber::Core::Gherkin::TagExpression.new(tag_expr).evaluate(
-        tags.map { |tag| Cucumber::Core::Ast::Tag.new(nil, tag) }
+      ::Foodcritic::Gherkin::TagExpression.new(tag_expr).evaluate(
+        tags.map { |tag| ::Foodcritic::Gherkin::Tag.new(nil, tag) }
       )
     end
 

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/gerkin/tag.rb

@@ -0,0 +1,55 @@
+# this is vendored from cucumber-core gem with the module/class names changed
+
+module Foodcritic
+  module Gherkin
+    class Tag
+
+      attr_reader :name
+
+      def initialize(location, name)
+        @location = location
+        @name = name
+      end
+
+      def inspect
+        %{#<#{self.class} "#{name}" (#{location})>}
+      end
+
+      def file_colon_line
+        location.to_s
+      end
+
+      def file
+        location.file
+      end
+
+      def line
+        location.line
+      end
+
+      def location
+        raise('Please set @location in the constructor') unless defined?(@location)
+        @location
+      end
+
+      def attributes
+        [tags, comments, multiline_arg].flatten
+      end
+
+      def tags
+        # will be overriden by nodes that actually have tags
+        []
+      end
+
+      def comments
+        # will be overriden by nodes that actually have comments
+        []
+      end
+
+      def multiline_arg
+        # will be overriden by nodes that actually have a multiline_argument
+        Test::EmptyMultilineArgument.new
+      end
+    end
+  end
+end

data/lib/foodcritic/gerkin/tag_expression.rb

@@ -0,0 +1,66 @@
+# this is vendored from cucumber-core gem with the module/class names changed
+# in the 4.0 release of cucumber-core they removed support for legacy tags (~FC100)
+# and we're not going to force everyone to redo their tags on a EOL product
+
+module Foodcritic
+  module Gherkin
+    class TagExpression
+
+      attr_reader :limits
+
+      def initialize(tag_expressions)
+        @ands = []
+        @limits = {}
+        tag_expressions.each do |expr|
+          add(expr.strip.split(/\s*,\s*/))
+        end
+      end
+
+      def empty?
+        @ands.empty?
+      end
+
+      def evaluate(tags)
+        return true if @ands.flatten.empty?
+        vars = Hash[*tags.map{|tag| [tag.name, true]}.flatten]
+        raise "No vars" if vars.nil? # Useless statement to prevent ruby warnings about unused var
+        !!Kernel.eval(ruby_expression)
+      end
+
+    private
+
+      def add(tags_with_negation_and_limits)
+        negatives, positives = tags_with_negation_and_limits.partition{|tag| tag =~ /^~/}
+        @ands << (store_and_extract_limits(negatives, true) + store_and_extract_limits(positives, false))
+      end
+
+      def store_and_extract_limits(tags_with_negation_and_limits, negated)
+        tags_with_negation = []
+        tags_with_negation_and_limits.each do |tag_with_negation_and_limit|
+          tag_with_negation, limit = tag_with_negation_and_limit.split(':')
+          tags_with_negation << tag_with_negation
+          if limit
+            tag_without_negation = negated ? tag_with_negation[1..-1] : tag_with_negation
+            if @limits[tag_without_negation] && @limits[tag_without_negation] != limit.to_i
+              raise "Inconsistent tag limits for #{tag_without_negation}: #{@limits[tag_without_negation]} and #{limit.to_i}"
+            end
+            @limits[tag_without_negation] = limit.to_i
+          end
+        end
+        tags_with_negation
+      end
+
+      def ruby_expression
+        "(" + @ands.map do |ors|
+          ors.map do |tag|
+            if tag =~ /^~(.*)/
+              "!vars['#{$1}']"
+            else
+              "vars['#{tag}']"
+            end
+          end.join("||")
+        end.join(")&&(") + ")"
+      end
+    end
+  end
+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 = "14.8.12".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?
@@ -68,6 +70,7 @@ module FoodCritic
       options = setup_defaults(options)
       @options = options
       @chef_version = options[:chef_version] || DEFAULT_CHEF_VERSION
+      ast_cache(options[:ast_cache_size])
 
       warnings = []; last_dir = nil; matched_rule_tags = Set.new
       load_rules
@@ -111,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
@@ -132,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
@@ -196,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
 
@@ -216,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") : []
@@ -233,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}"
@@ -338,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