puppet-lint-uncuddled_else-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3c9358c21f974ca626106734ba001ebca25142288f2c07b5339a7d682d919d7
+  data.tar.gz: 9d1e69cf348a673320290c427096d18d384f5f7084a68954b4cfce94304f1b87
+SHA512:
+  metadata.gz: b30fa6f47b2174ceabdb49a2492c3d66f4b8520d316e3221cb1255d184b437b0d5d1fd325ee5c7e5afe930ac1fbddfa925583565a6f9d826fda6aa605d671a92
+  data.tar.gz: 8168f465e2a4ee39a4349674244fd9fa0f4c4305dad16c32291420768fb17148739a4c9d81b91b98934f8c4d0eec08450fab878ddfd4f480ec25753ab9d51b21

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2019] [Christian Bartolomäus]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+puppet-lint-uncuddled_else-check
+================================
+
+A puppet-lint plugin to check for [uncuddled else blocks](http://wiki.c2.com/?CuddledElseBlocks).
+
+## Installation
+
+### From the command line
+
+```shell
+$ gem install puppet-lint-uncuddled_else-check
+```
+
+## Checks
+
+### Uncuddled else/elsif
+
+There are two different styles regarding the placement of `else` and `elsif` keywords. It can be placed on the same line as the closing curly of the preceding if block (`cuddled`) or on a separate line below that closing curly (`uncuddled`). There are pros and cons for both styles -- cmp. http://wiki.c2.com/?CuddledElseBlocks.
+
+This check helps to enforce a consistent style by warning about `uncuddled` else/elsif keywords.
+
+#### What you have done
+
+The `else` (or `elsif`) keyword is on a new line below the closing curly brace of the preceding if block.
+
+```puppet
+if $foo == 'bar' {
+  ## some stuff
+}
+else {
+  ## other stuff
+}
+```
+
+#### What you should have done
+
+The `else` (or `elsif`) keyword is on the same line as the closing curly brace of the preceding if block.
+
+```puppet
+if $foo == 'bar' {
+  ## some stuff
+} else {
+  ## other stuff
+}
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-uncuddled_else-check' to your puppet-lint command line.
+
+```
+$ puppet-lint --no-uncuddled_else-check /path/to/file.pp
+```
+
+## See also
+
+There is a corresponding plugin `puppet-lint-cuddled_else-check` that warns for cuddled else blocks. Most probably you only want one of both checks. ;)
+
+## Acknowledgments
+
+This plugin for `puppet-lint` has been written owing to the very nice [tutorial for writing puppet-lint checks](http://puppet-lint.com/developer/tutorial/).

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

@@ -0,0 +1,19 @@
+PuppetLint.new_check(:uncuddled_else) do
+  def check
+    tokens.each do |token|
+      next unless token.type == :ELSE || token.type == :ELSIF
+
+      ## 'else/elsif' should follow closing curly and whitespaces
+      prev1 = token.prev_token
+      prev2 = prev1.prev_token
+      next if prev1.type == :WHITESPACE && prev2.type == :RBRACE
+
+      ## otherwise it's not a cuddled else/elsif
+      notify :warning, {
+        :message => "found uncuddled #{token.type.to_s.downcase}, should be on same line as closing curly",
+        :line    => token.line,
+        :column  => token.column,
+      }
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+# rubocop:disable Metrics/BlockLength, Metrics/LineLength
+describe 'uncuddled_else' do
+  ## uncuddled else
+  context 'with fix disabled' do
+    let(:msg) { 'found uncuddled else, should be on same line as closing curly' }
+
+    ## no indentation
+    context 'else on same line as closing curly of preceding if block' do
+      let(:code) { "if $foo == 'bar' {\n  ## some stuff\n} else {\n  ## other stuff\n}\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'else on next line after closing curly of preceding if block' do
+      let(:code) { "if $foo == 'bar' {\n  ## some stuff\n}\nelse {\n  ## other stuff\n}\n" }
+
+      it 'should detect a single problems' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(4).in_column(1)
+      end
+    end
+
+    ## with indentation
+    context 'else on same line as indented closing curly of preceding if block' do
+      let(:code) { "  if $foo == 'bar' {\n    ## some stuff\n  } else {\n    ## other stuff\n  }\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'indented else on next line after closing curly of preceding if block' do
+      let(:code) { "  if $foo == 'bar' {\n    ## some stuff\n  }\n  else {\n    ## other stuff\n  }\n" }
+
+      it 'should detect a single problems' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(4).in_column(3)
+      end
+    end
+  end
+
+  ## uncuddled elsif
+  context 'with fix disabled' do
+    let(:msg) { 'found uncuddled elsif, should be on same line as closing curly' }
+
+    ## no identation
+    context 'elsif on same line as closing curly of preceding if block' do
+      let(:code) { "if $foo == 'bar' {\n  ## some stuff\n} elsif $foo == 'baz' {\n  ## other stuff\n}\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'elsif on next line after closing curly of preceding if block' do
+      let(:code) { "if $foo == 'bar' {\n  ## some stuff\n}\nelsif $foo == 'baz' {\n  ## other stuff\n}\n" }
+
+      it 'should detect a single problems' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(4).in_column(1)
+      end
+    end
+
+    ## with identation
+    context 'indented elsif on same line as closing curly of preceding if block' do
+      let(:code) { "  if $foo == 'bar' {\n    ## some stuff\n  } elsif $foo == 'baz' {\n    ## other stuff\n  }\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'elsif on next line after indented closing curly of preceding if block' do
+      let(:code) { "  if $foo == 'bar' {\n    ## some stuff\n  }\n  elsif $foo == 'baz' {\n    ## other stuff\n  }\n" }
+
+      it 'should detect a single problems' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(4).in_column(3)
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength, Metrics/LineLength

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-uncuddled_else-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Bartolomäus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A puppet-lint plugin to check that manifest files do not have uncuddled
+  else blocks.\n"
+email: use_v6@aglaz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_uncuddled_else.rb
+- spec/puppet-lint/plugins/check_uncuddled_else_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/optivo-org/puppet-lint-uncuddled_else-check
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check for uncuddled else blocks.
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_uncuddled_else_spec.rb