Version bump v1.4.0

- Destroys all generated cookbooks after each test
- Fixes missing dependencies
- Fixes tons of rubocop errors
- Centralizes "good" cookbook layout definition to one spot
- Refactors tests to start from "good" layout
- More resilient regex for detecting a date in comments
- Skip checking for comments in `metadata.rb`
- Calls `cookstyle` directly instead of `rubocop --require cookstyle`
- Checks for copyright, date, and license in header comment block
- Adds support for detecting if license is BSD 3-clause
- Reads `.foodcritic` file, passing through directives

Author: TheLonelyGhost

.rubocop.yml

@@ -29,18 +29,22 @@ Metrics/MethodLength:
   Enabled: false
 
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 12
 
-Style/BlockDelimiters:
+Naming/FileName:
   Exclude:
-    - 'spec/**/*_spec.rb'
+    - '.simplecov'
 
-Style/FileName:
+Style/BlockDelimiters:
   Exclude:
-    - '.simplecov'
+    - 'spec/**/*_spec.rb'
 
+# These two are for supporting usage of the `paint` gem
 Style/FormatString:
   Enabled: false
 
+Style/FormatStringToken:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false

CHANGELOG.md

@@ -3,11 +3,18 @@
 We follow [Semantic Versioning](http://semver.org/) as a way of measuring stability of an update. This
 means we will never make a backwards-incompatible change within a major version of the project.
 
-## _[UNRELEASED]_
+## v1.4.0 (2018-09-15)
 
 - Adds Simplecov for measuring test coverage
 - Increases test coverage
 - [BUG] Spelling inconsistencies (`Pass` -> `Passed`, `Fail` -> `Failed`, `Foodcritic` -> `FoodCritic`)
+- Centralizes generating test data for a cookbook (or monolithic repository) to one spot
+- Fixes tons of rubocop errors
+- [BUG] Undeclared dependency: `foodcritic`
+- Upgrades dependencies to be based on what is available as part of ChefDK v3.1.0
+- [BUG] Processes `*.rb` files in non-profile InSpec directory, when InSpec only processes `*_test.rb`
+- Adds support for detecting BSD licenses
+- Supports reading `.foodcritic` file for rule skips
 
 ## v1.3.2 (2017-06-08)
 

Rakefile

@@ -33,6 +33,6 @@ task :_guard_against_focus do
   abort "PRECONDITION FAILURE:\n\t- #{errors.join("\n\t- ")}" unless errors.empty?
 end
 
-task ci: %w(_guard_against_focus spec)
+task ci: %w[_guard_against_focus spec]
 
-task default: %w(spec)
+task default: %w[spec]

lib/rordan_gramsay/chef_tasks/lint.rb

@@ -2,7 +2,7 @@
 
 # Meta-task for all linting tasks
 namespace :lint do
-  task all: %w(lint:rubocop lint:foodcritic lint:comments lint:tests lint:kitchen)
+  task all: %w[lint:rubocop lint:foodcritic lint:comments lint:tests lint:kitchen]
 end
 desc 'Lints cookbook using all tools'
 task lint: ['lint:all']

lib/rordan_gramsay/chef_tasks/lint/foodcritic.rb

@@ -7,9 +7,15 @@
   task :foodcritic do
     puts Paint['Inspecting files with FoodCritic', :yellow, :bold]
 
+    tags = if File.exist?('.foodcritic')
+             File.read('.foodcritic').lines.map(&:strip)
+           else
+             %w[~FC001 ~FC003 ~FC019 ~FC023 ~FC064 ~FC065 ~FC066 ~license]
+           end
+
     task_obj = RordanGramsay::Lint::Foodcritic.new(
       fail_tags: ['any'],
-      tags: %w(~FC001 ~FC003 ~FC019 ~FC023 ~FC064 ~FC065 ~FC066 ~license)
+      tags: tags
     )
 
     task_obj.call

lib/rordan_gramsay/chef_tasks/master_repo.rb

@@ -18,6 +18,7 @@ def run_command(cmd, log)
       # Finished giving output or otherwise a broken pipe
     end
   end
+  # rubocop:enable Lint/HandleExceptions
 
   log.info 'Cleaning up...'
 end

lib/rordan_gramsay/cli.rb

@@ -27,8 +27,8 @@ def call
       when 'init'
         action_init!
       else
-        $stderr.puts "Unknown action: #{@action.inspect}"
-        $stderr.puts @parser
+        warn "Unknown action: #{@action.inspect}"
+        warn @parser
       end
       @action_status = :complete
     end
@@ -42,20 +42,20 @@ def action_init!
       when /(?:chef[_-])?(?:master|server)[_-]?rakefile$/i
         init_master_rakefile!
       else
-        $stderr.puts "Unknown subject: #{@subject.inspect}"
-        $stderr.puts @parser
+        warn "Unknown subject: #{@subject.inspect}"
+        warn @parser
       end
     end
 
     def cookbook_rakefile_contents
-      <<-EOF
-require '#{GEM_NAME}/chef_tasks/kitchen'
-require '#{GEM_NAME}/chef_tasks/lint'
-require '#{GEM_NAME}/chef_tasks/test'
-
-task default: ['lint']
-# Further rake tasks go here
-      EOF
+      <<~RAKEFILE
+        require '#{GEM_NAME}/chef_tasks/kitchen'
+        require '#{GEM_NAME}/chef_tasks/lint'
+        require '#{GEM_NAME}/chef_tasks/test'
+
+        task default: ['lint']
+        # Further rake tasks go here
+      RAKEFILE
     end
 
     def init_rakefile!
@@ -71,9 +71,9 @@ def init_rakefile!
     end
 
     def master_rakefile_contents
-      <<-EOF
-require '#{GEM_NAME}/chef_tasks/master_repo'
-      EOF
+      <<~RAKEFILE
+        require '#{GEM_NAME}/chef_tasks/master_repo'
+      RAKEFILE
     end
 
     def init_master_rakefile!

lib/rordan_gramsay/lint/cookbook_comments_checker.rb

@@ -16,7 +16,7 @@ class CookbookFile
         def initialize(file_name)
           @file_name = file_name
           # Limit read to first 30 lines of file
-          @lines = File.foreach(file_name).first(30)
+          @lines = ::File.foreach(file_name).first(30)
         end
 
         # Detects if authorship line is included
@@ -35,7 +35,7 @@ def author?
         def copyright?
           @copyright ||= @lines.any? do |line|
             break true if line =~ /(?:^| )\(c\)(?:$| )/i # copyright symbol as "(c)"
-            break true if line.includes? '©' # Actual copyright symbol
+            break true if line.include? '©' # Actual copyright symbol
             break true if line =~ /copyright/i
             break true if line =~ /©/i # HTML entity is still indicative of copyright
 
@@ -46,10 +46,11 @@ def copyright?
         # Detects if there is a date (e.g., copyright date or date of authorship) included
         def date?
           @date ||= @lines.any? do |line|
-            break true if line =~ /(?:mon(?:day)?|tue(?:s(?:day)?)?|wed(?:nes(?:day)?)?|thu(?:rs(?:day)?)?|fri(?:day)?|sat(?:urday)?|sun(?:day)?)/i
-            break true if line =~ %r{(?:/|-|\(| |^)20[012][0-9](?:/|-|\)| |$)}i # some year between 2000 and 2029
+            break true if line =~ %r{(?:/|-|\(| |^)(?:20|19)[0-9]{2}(?:/|-|\)| |$)}i # some year between 1900 and 2099
             # Similar to ISO date format (e.g., 2017-03-14, 2010/11/19, 2001/9/3)
-            break true if line =~ %r{(?<year>(?:20|19)[0-9][0-9])[/-](?<month>0?[1-9]|1[0-2])[/-](?<day>0?[1-9]|[1,2][0-9]|3[01])}i
+            break true if line =~ %r{(?<year>(?:20|19)[0-9]{2})[/-](?<month>0?[1-9]|1[0-2])[/-](?<day>0?[1-9]|[1,2][0-9]|3[01])}i
+            # Just a given year
+            break true if line =~ /\b(?:20|19)[0-9]{2}\b/i
 
             false
           end
@@ -62,6 +63,7 @@ def license?
             break true if line =~ /all rights(?: reserved)?/i # "All rights reserved"
 
             # Popular licenses
+            break true if line =~ /(?:^|\W)\(?BSD(?:v?3)\)?(?:$|\W)/ # "BSD", "BSD3", "BSDv3" or wrapping any of those in parentheses
             break true if line =~ /(?:^|\W)\(?MIT\)?(?:$|\W)/ # "MIT" or "(MIT)"
             break true if line =~ /(?:^|\W)Apache(?:$|\W)/i # "Apache"
             break true if line =~ /(?:^|\W)Creative Commons(?:$|\W)/i
@@ -90,9 +92,9 @@ def call
         @files.each do |file|
           errors = []
           # errors << :author unless file.author?
-          # errors << :license unless file.license?
-          # errors << :copyright unless file.copyright?
-          # errors << :date unless file.date?
+          errors << :license unless file.license?
+          errors << :copyright unless file.copyright?
+          errors << :date unless file.date?
           errors << :comments_at_top_of_file unless file.leading_comment_lines?
 
           # Compile the error message
@@ -117,7 +119,7 @@ def error_count
       end
 
       def files
-        Dir.glob("#{base_dir}/{attributes,recipes,libraries}/**/*.rb")
+        ::Dir.glob(::File.join(base_dir, '{attributes,recipes,resources,libraries}', '**', '*.rb'))
       end
 
       private

lib/rordan_gramsay/lint/foodcritic.rb

@@ -89,7 +89,7 @@ def rules
       def default_opts
         {
           cookbook_paths: [Dir.pwd],
-          exclude_paths: %w(test/**/* spec/**/* features/**/*),
+          exclude_paths: %w[test/**/* spec/**/* features/**/*],
           fail_tags: ['any'],
           tags: []
         }

lib/rordan_gramsay/lint/kitchen_checker.rb

@@ -26,7 +26,7 @@ def inspec?
         # Just in case default for the box is not set to headless,
         # all Windows VMs should have "gui: false" by default
         def no_windows_gui?
-          @inspec ||= begin
+          @no_windows_gui ||= begin
             if @lines.any? { |line| line =~ /winrm/i }
               @lines.any? { |line| line =~ /^.*(?<!#).*\s+gui:\s+(?:false|no?|off)\s*$/i }
             else