foodcritic 16.2.0 → 16.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a5293509a41fb55bb81758349336f643ff49e24408c10cfb4a7653038bcb938
-  data.tar.gz: b64e3be433dc68df2176178a83454bc876f8483ae8273216e7cfa05d415ad949
+  metadata.gz: 2122adab9b427f5729d3be4d5ebd1a3eefe6e6f23e013433885752286ccd8d2b
+  data.tar.gz: 36ddd91e875713be1ce6f4c99965b943e2d5c9f590ca62e11ce972dd6ad73b7d
 SHA512:
-  metadata.gz: b55c9651d02c5bc186b5fd30d4e9defde93f0b108e1c44490825de01ed8cbeb0b42421a72a19a81b2b7f8610d5c0d5f8bbabb302dec3670ea2042fc4e8544348
-  data.tar.gz: f2ea8ec75bbb269e07c3aabd6f0be0a268f6f3befd6f4ee7e73690d97e2a902c0e700db1bed93bade477f2bc268ab8bff764fa45e9463d6735692134cf209984
+  metadata.gz: a4fb33c61d62ebdab3843fb9918e26b94b65316b109d79458ed38be148f6c20084e0b657f57197414845bbd1f5371e9c59b6635100e9e2d90a29d05e7fe31ce2
+  data.tar.gz: a27169770e288482837b07e80f292a8882347df9f6587bd426ec03436bf43d69080f28942e4372cc3246a67cec728ba65770efba92e4929312cdf54c91974f55

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 group :test do
   gem "aruba", "~> 0.5"
   gem "cucumber", ">= 2"
-  gem "minitest", "~> 5.3"
+  gem "minitest", "~> 5.13.0"
   gem "minitest-reporters"
   gem "simplecov", "~> 0.8"
   gem "chefstyle", "= 0.13.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/command_line.rb

@@ -111,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.
@@ -118,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?

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
@@ -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/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/rules/fc123.rb

@@ -4,12 +4,10 @@ rule "FC123", "Content of a cookbook file is larger than 1MB" do
     values = []
     files_path = File.join(path, "files")
     if File.exist?(files_path)
-      Dir.foreach(files_path) do |file|
-        next if [".", ".."].member?(file)
-
-        size = File.size(File.join(files_path, file))
+      Dir.glob("#{files_path}/**/*").each do |file|
+        size = File.size(file)
         if size > 1024 * 1024 # 1 megabyte
-          values += [file_match(File.join(files_path, file))]
+          values += [file_match(file)]
         end
       end
     end

data/lib/foodcritic/version.rb

@@ -1,4 +1,4 @@
 module FoodCritic
   # The current version of foodcritic
-  VERSION = "16.2.0".freeze
+  VERSION = "16.3.0".freeze
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 16.2.0
+  version: 16.3.0
 platform: ruby
 authors:
 - Andrew Crump
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: cucumber-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +100,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -162,8 +162,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Lint tool for Chef cookbooks.
-email: 
+description: A code linting tool for Chef Infra cookbooks.
+email:
 executables:
 - foodcritic
 extensions: []
@@ -183,6 +183,8 @@ files:
 - lib/foodcritic/domain.rb
 - lib/foodcritic/dsl.rb
 - lib/foodcritic/error_checker.rb
+- lib/foodcritic/gerkin/tag.rb
+- lib/foodcritic/gerkin/tag_expression.rb
 - lib/foodcritic/linter.rb
 - lib/foodcritic/notifications.rb
 - lib/foodcritic/output.rb
@@ -307,7 +309,7 @@ homepage: http://foodcritic.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -322,8 +324,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: foodcritic-16.2.0
+summary: foodcritic-16.3.0
 test_files: []