Merge pull request #56 from puppetlabs/maint-spec_rubocop_updates

(MAINT) Rubocop updates for spec

Author: GSPatton

.rubocop.yml

@@ -518,3 +518,5 @@ Style/RedundantArgument:
   Enabled: false
 Style/SwapValues:
   Enabled: false
+RSpec/FilePath:
+  Enabled: false

spec/puppet-lint/bin_spec.rb

@@ -26,7 +26,7 @@ def initialize(args)
 end
 
 describe PuppetLint::Bin do
-  subject do
+  subject(:bin) do
     sane_args = if args.is_a?(Array)
                   args
                 else
@@ -57,18 +57,19 @@ def initialize(args)
 
   context 'when asked to display available checks' do
     let(:args) { '--list-checks' }
+
     all_checks = PuppetLint.configuration.checks.map(&:to_s)
 
     its(:exitstatus) { is_expected.to eq(0) }
 
     all_checks.each do |c|
       it "includes check #{c} in its output" do
-        expect(subject.stdout).to include c
+        expect(bin.stdout).to include c
       end
     end
   end
 
-  context 'when passed a backslash separated path on Windows', :if => Gem.win_platform? do
+  context 'when passed a backslash separated path on Windows', if: Gem.win_platform? do
     let(:args) do
       [
         'spec\fixtures\test\manifests',
@@ -93,7 +94,7 @@ def initialize(args)
         [
           "#{args[0]} - WARNING: optional parameter listed before required parameter on line 2 (check: parameter_order)",
           "#{args[1]} - ERROR: test::foo not in autoload module layout on line 2 (check: autoloader_layout)",
-        ].join("\n")
+        ].join("\n"),
       )
     end
   end
@@ -144,8 +145,10 @@ def initialize(args)
     end
 
     its(:exitstatus) { is_expected.to eq(1) }
-    its(:stdout) { is_expected.to match(%r{WARNING}) }
-    its(:stdout) { is_expected.to_not match(%r{ERROR}) }
+    its(:stdout) do
+      is_expected.to match(%r{WARNING})
+      is_expected.not_to match(%r{ERROR})
+    end
   end
 
   context 'when specifying a specific check to run' do
@@ -159,8 +162,10 @@ def initialize(args)
     end
 
     its(:exitstatus) { is_expected.to eq(0) }
-    its(:stdout) { is_expected.to_not match(%r{ERROR}) }
-    its(:stdout) { is_expected.to match(%r{WARNING}) }
+    its(:stdout) do
+      is_expected.not_to match(%r{ERROR})
+      is_expected.to match(%r{WARNING})
+    end
   end
 
   context 'when asked to display filenames ' do
@@ -202,7 +207,7 @@ def initialize(args)
           '',
           "  define test::warning($foo='bar', $baz) { }",
           '                                   ^',
-        ].join("\n")
+        ].join("\n"),
       )
     end
   end
@@ -440,7 +445,7 @@ def initialize(args)
     end
 
     its(:exitstatus) { is_expected.to eq(0) }
-    its(:stdout) { is_expected.to_not match(%r{IGNORED}) }
+    its(:stdout) { is_expected.not_to match(%r{IGNORED}) }
   end
 
   context 'when showing ignored problems' do
@@ -469,7 +474,7 @@ def initialize(args)
         [
           'IGNORED: double quoted string containing no variables on line 3 (check: double_quoted_strings)',
           '  for a good reason',
-        ].join("\n")
+        ].join("\n"),
       )
     end
   end
@@ -517,44 +522,48 @@ def initialize(args)
   end
 
   context 'when fixing a file with \n line endings' do
-    before(:context) do
-      @windows_file = Tempfile.new('windows')
-      @posix_file = Tempfile.new('posix')
-
-      @windows_file.binmode
-      @posix_file.binmode
-
-      @windows_file.write("\r\n")
-      @posix_file.write("\n")
-
-      @windows_file.close
-      @posix_file.close
+    let(:windows_file) do
+      Tempfile.new('windows')
     end
 
-    after(:context) do
-      @windows_file.unlink
-      @posix_file.unlink
+    let(:posix_file) do
+      Tempfile.new('posix')
     end
 
     let(:args) do
       [
         '--fix',
-        @posix_file.path,
-        @windows_file.path,
+        posix_file.path,
+        windows_file.path,
       ]
     end
 
+    before(:each) do
+      windows_file.binmode
+      windows_file.write("\r\n")
+      windows_file.close
+
+      posix_file.binmode
+      posix_file.write("\n")
+      posix_file.close
+    end
+
+    after(:each) do
+      windows_file.unlink
+      posix_file.unlink
+    end
+
     its(:exitstatus) { is_expected.to eq(0) }
 
     it 'does not change the line endings' do
-      File.open(@posix_file.path, 'rb') do |f|
+      File.open(posix_file.path, 'rb') do |f|
         data = f.read
 
         expect(data).to match(%r{\n\Z}m)
-        expect(data).to_not match(%r{\r\n\Z}m)
+        expect(data).not_to match(%r{\r\n\Z}m)
       end
 
-      File.open(@windows_file.path, 'rb') do |f|
+      File.open(windows_file.path, 'rb') do |f|
         data = f.read
 
         expect(data).to match(%r{\r\n\Z}m)

spec/puppet-lint/checks_spec.rb

@@ -7,18 +7,18 @@
   let(:content) { "notify { 'test': }" }
 
   describe '#initialize' do
-    it { is_expected.to have_attributes(:problems => []) }
+    it { is_expected.to have_attributes(problems: []) }
   end
 
   describe '#load_data' do
     let(:lexer) { PuppetLint::Lexer.new }
 
-    before do
+    before(:each) do
       allow(PuppetLint::Lexer).to receive(:new).and_return(lexer)
     end
 
     context 'when the tokeniser encounters an error' do
-      before do
+      before(:each) do
         allow(lexer).to receive(:tokenise).with(content).and_raise(lexer_error)
         instance.load_data(path, content)
       end
@@ -33,14 +33,14 @@
         it 'creates a syntax error problem for the file' do
           expect(instance.problems).to have(1).problem
           expect(instance.problems.first).to include(
-            :kind     => :error,
-            :check    => :syntax,
-            :message  => 'Syntax error',
-            :line     => 1,
-            :column   => 2,
-            :path     => anything,
-            :fullpath => anything,
-            :filename => anything
+            kind: :error,
+            check: :syntax,
+            message: 'Syntax error',
+            line: 1,
+            column: 2,
+            path: anything,
+            fullpath: anything,
+            filename: anything,
           )
         end
       end
@@ -55,14 +55,14 @@
         it 'creates a syntax error problem for the file' do
           expect(instance.problems).to have(1).problem
           expect(instance.problems.first).to include(
-            :kind     => :error,
-            :check    => :syntax,
-            :message  => 'Syntax error (some reason)',
-            :line     => 1,
-            :column   => 2,
-            :path     => anything,
-            :fullpath => anything,
-            :filename => anything
+            kind: :error,
+            check: :syntax,
+            message: 'Syntax error (some reason)',
+            line: 1,
+            column: 2,
+            path: anything,
+            fullpath: anything,
+            filename: anything,
           )
         end
       end
@@ -74,12 +74,12 @@
     let(:data) { "notify { 'test': }" }
     let(:enabled_checks) { [] }
 
-    before do
-      allow(instance).to receive(:enabled_checks).and_return(enabled_checks)
+    before(:each) do
+      allow(instance).to receive(:enabled_checks).and_return(enabled_checks) # rubocop: disable RSpec/SubjectStub
     end
 
     it 'loads the manifest data' do
-      expect(instance).to receive(:load_data).with(fileinfo, data).and_call_original
+      expect(instance).to receive(:load_data).with(fileinfo, data).and_call_original # rubocop: disable RSpec/SubjectStub
       instance.run(fileinfo, data)
     end
 
@@ -98,7 +98,7 @@
       it 'does not run the disabled checks' do
         # expect().to_not all(matcher) is not supported
         disabled_check_classes.each do |check_class|
-          expect(check_class).to_not receive(:new)
+          expect(check_class).not_to receive(:new)
         end
 
         instance.run(fileinfo, data)
@@ -110,12 +110,12 @@
         let(:mock_arrow_alignment) do
           instance_double(
             PuppetLint::CheckPlugin,
-            :run          => [{ :kind => :error, :check => :arrow_alignment }],
-            :fix_problems => [{ :kind => :fixed, :check => :arrow_alignment }]
+            run: [{ kind: :error, check: :arrow_alignment }],
+            fix_problems: [{ kind: :fixed, check: :arrow_alignment }],
           )
         end
         let(:mock_hard_tabs) do
-          instance_double(PuppetLint::CheckPlugin, :run => [], :fix_problems => [])
+          instance_double(PuppetLint::CheckPlugin, run: [], fix_problems: [])
         end
         let(:fix_state) { false }
 
@@ -127,22 +127,22 @@
         end
 
         it 'adds the found problems to the problems array' do
-          expect(instance).to have_attributes(:problems => [{ :kind => :error, :check => :arrow_alignment }])
+          expect(instance).to have_attributes(problems: [{ kind: :error, check: :arrow_alignment }])
         end
 
         context 'and fix is enabled' do
           let(:fix_state) { true }
 
           it 'calls #fix_problems on the check and adds the results to the problems array' do
-            expect(instance).to have_attributes(:problems => [{ :kind => :fixed, :check => :arrow_alignment }])
+            expect(instance).to have_attributes(problems: [{ kind: :fixed, check: :arrow_alignment }])
           end
         end
       end
     end
 
     context 'when an unhandled exception is raised' do
-      before do
-        allow(instance).to receive(:load_data).with(fileinfo, data).and_raise(StandardError.new('test message'))
+      before(:each) do
+        allow(instance).to receive(:load_data).with(fileinfo, data).and_raise(StandardError.new('test message')) # rubocop: disable RSpec/SubjectStub
         allow($stdout).to receive(:puts).with(anything)
       end
 
@@ -173,7 +173,7 @@
       end
 
       context 'and the file being linted is readable' do
-        before do
+        before(:each) do
           allow(File).to receive(:readable?).with(fileinfo).and_return(true)
           allow(File).to receive(:read).with(fileinfo).and_return(data)
         end
@@ -196,7 +196,7 @@
 
     let(:expected_enabled_checks) { [:arrow_alignment, :trailing_whitespace] }
 
-    before do
+    before(:each) do
       PuppetLint.configuration.checks.each do |check|
         allow(PuppetLint.configuration).to receive("#{check}_enabled?").and_return(expected_enabled_checks.include?(check))
       end
@@ -212,13 +212,13 @@
 
     let(:tokens) do
       [
-        instance_double(PuppetLint::Lexer::Token, :to_manifest => '1'),
-        instance_double(PuppetLint::Lexer::Token, :to_manifest => '2'),
-        instance_double(PuppetLint::Lexer::Token, :to_manifest => '3'),
+        instance_double(PuppetLint::Lexer::Token, to_manifest: '1'),
+        instance_double(PuppetLint::Lexer::Token, to_manifest: '2'),
+        instance_double(PuppetLint::Lexer::Token, to_manifest: '3'),
       ]
     end
 
-    before do
+    before(:each) do
       allow(PuppetLint::Data).to receive(:tokens).and_return(tokens)
     end