puppet-lint-empty_trailing_lines 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63566c23dfbecc1869cfcc8c47df00154713d49c4509bfe2536a9b977223c8dd
-  data.tar.gz: '090fd98728a66866c1afe3eac21c51d2a6979ed6f09f988bfbb0118ff63a310e'
+  metadata.gz: '086a73bc19cbeb146a546829950c64bc028fc3ab31831b5d0f3521a1a49ccd5a'
+  data.tar.gz: 35fb6fbfa646fc859d3b3aa1fcd7869bca8ed9f2f0f5655abc42b6353b4ce2ca
 SHA512:
-  metadata.gz: 0db2caeca0703fcd6160493af14944981041c026290f0ecdade43b6ec1e31513cc9b9d2572a1296d18de3925b435a9c30f50385714893ad3856d05551bcbff32
-  data.tar.gz: dcb7532bd161b635fc9ba8b838b1f0291bce76f320ac821a57d34bb14afc6c848ef319dd080f0b0d9bf491853e7bf6def760363c3ff2dfe32d3239b1a9648d4d
+  metadata.gz: 9278506115ddba69597b13ab44d7c9e7518824a56fccde745deec01f737f7f4af49db6b3c42b5d5eca0dc14cab37c8c2c1080eeb4d499a8dab42128383a5c27a
+  data.tar.gz: f21a9bbf8302de74146a9982721f01b919ace0b96c8e1b2aba098ea087a99452293a86d88a18c18d5d3e5d23a60ed48eac2c92ca4b287cb01730c6ba6d57fee7

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2019 Garrett Honeycutt <code@garretthoneycutt.com>
+Copyright (C) 2019-2020 Garrett Honeycutt <code@garretthoneycutt.com>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -37,7 +37,7 @@ This plugin provides a new check to `puppet-lint`.
 ### What you should have done
 
 ```puppet
-  # Not left empty lines at the end of the file
+  # No empty lines left at the end of the file
     file { '/foo':
       ensure => 'file',
     }
@@ -46,6 +46,20 @@ This plugin provides a new check to `puppet-lint`.
 
 ### Disabling the check
 
+#### Control comment
+
+```
+# lint:ignore:empty_trailing_lines
+```
+
 #### From the command line
 
+```
+--no-empty_trailing_lines-check
+```
+
 #### In your `Rakefile`
+
+```
+PuppetLint.configuration.send("disable_empty_trailing_lines")
+```

data/lib/puppet-lint/plugins/check_empty_trailing_lines.rb

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
+
 PuppetLint.new_check(:empty_trailing_lines) do
   def check
     last_token = tokens.last
 
-    if [:NEWLINE, :WHITESPACE, :INDENT].include?(last_token.prev_token.type)
-      notify :warning, {
-        :message => 'too many empty lines at the end of the file',
-        :line    => last_token.prev_token.line,
-        :column  => manifest_lines.last.length,
-      }
-    end
+    return unless %i[NEWLINE WHITESPACE INDENT].include?(last_token.prev_token.type)
+
+    notify :warning, {
+      message: 'too many empty lines at the end of the file',
+      line: last_token.prev_token.line,
+      column: manifest_lines.last.length
+    }
   end
 
   def fix(problem)
     remove_token(tokens.last.prev_token)
-    if tokens.last.prev_token.type == :NEWLINE && tokens.last.type == :NEWLINE
-      fix(problem)
-    end
+    fix(problem) if tokens.last.prev_token.type == :NEWLINE && tokens.last.type == :NEWLINE
   end
 end

data/spec/puppet-lint/plugins/check_empty_trailing_lines_spec.rb

@@ -1,37 +1,39 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'empty_trailing_lines' do
   let(:msg) { 'too many empty lines at the end of the file' }
 
   context 'with fix disabled' do
-    context 'code ending with an extra newline' do
+    context 'when code ending with an extra newline' do
       let(:code) { "foo\n\n\n'test'\n\n" }
 
-      it 'should detect a single problem' do
+      it 'detects a single problem' do
         expect(problems).to have(1).problem
       end
 
-      it 'should create a warning' do
+      it 'creates a warning' do
         expect(problems).to contain_warning(msg).on_line(4).in_column(0)
       end
     end
 
-    context 'code ending with many extra newlines' do
+    context 'when code ending with many extra newlines' do
       let(:code) { "foo\n\n\n'test'\n\n\n\n" }
 
-      it 'should detect a single problem' do
+      it 'detects a single problem' do
         expect(problems).to have(1).problem
       end
 
-      it 'should create a warning' do
+      it 'creates a warning' do
         expect(problems).to contain_warning(msg).on_line(6).in_column(0)
       end
     end
 
-    context 'code ending with a newline' do
+    context 'when code ending with a newline' do
       let(:code) { "foo\n\n\n'test'\n" }
 
-      it 'should not detect any problems' do
+      it 'does not detect any problems' do
         expect(problems).to have(0).problems
       end
     end
@@ -46,46 +48,46 @@ describe 'empty_trailing_lines' do
       PuppetLint.configuration.fix = false
     end
 
-    context 'code ending with an extra newline' do
+    context 'when code ending with an extra newline' do
       let(:code) { "foo\n\n\n'test'\n\n" }
 
-      it 'should only detect a single problem' do
+      it 'onlies detect a single problem' do
         expect(problems).to have(1).problem
       end
 
-      it 'should fix the problem' do
+      it 'fixes the problem' do
         expect(problems).to contain_fixed(msg).on_line(4).in_column(0)
       end
 
-      it 'should add a newline to the end of the manifest' do
+      it 'adds a newline to the end of the manifest' do
         expect(manifest).to eq("foo\n\n\n'test'\n")
       end
     end
 
-    context 'code ending with many extra newlines' do
+    context 'when code ending with many extra newlines' do
       let(:code) { "foo\n\n\n'test'\n\n\n\n" }
 
-      it 'should only detect a single problem' do
+      it 'onlies detect a single problem' do
         expect(problems).to have(1).problem
       end
 
-      it 'should fix the problem' do
+      it 'fixes the problem' do
         expect(problems).to contain_fixed(msg).on_line(6).in_column(0)
       end
 
-      it 'should add a newline to the end of the manifest' do
+      it 'adds a newline to the end of the manifest' do
         expect(manifest).to eq("foo\n\n\n'test'\n")
       end
     end
 
-    context 'code ending in a newline' do
+    context 'when code ending in a newline' do
       let(:code) { "foo\n\n\n'test'\n" }
 
-      it 'should not detect any problems' do
+      it 'does not detect any problems' do
         expect(problems).to have(0).problems
       end
 
-      it 'should not modify the manifest' do
+      it 'does not modify the manifest' do
         expect(manifest).to eq(code)
       end
     end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-lint'
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-empty_trailing_lines
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tailored Automation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-26 00:00:00.000000000 Z
+date: 2023-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -19,7 +19,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -93,12 +93,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.22.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -108,10 +108,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.22.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -163,11 +183,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: puppet-lint empty_trailing_line check
 test_files:
-- spec/spec_helper.rb
 - spec/puppet-lint/plugins/check_empty_trailing_lines_spec.rb
+- spec/spec_helper.rb