puppet-lint-extended 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b52caed1cfd754a66dd8657f64364b630a08db3
+  data.tar.gz: 0f1a8757f542bf87a77b0625164caa2ab4cad93e
+SHA512:
+  metadata.gz: 05e2977d293da5e2e95f7827027ad611c7168f169d77ab92eea3230a26f62beceef5f2cec02c3b4eb5938b6b5a0f04d936f23bf87eba01ffc09c2380b747df1f
+  data.tar.gz: 9260397fb170e0cc5a64293bbd67aba30b96094927692ac55aad729f101bc8a7a0b493b9d06ed82a1742705cf075aacd404bf4b65eb929602e5dae6b225368f8

data/README.md

@@ -0,0 +1,52 @@
+# puppet-lint-extended
+Provides additional checks for [puppet-lint](https://github.com/rodjek/puppet-lint) that are not part of the puppet style guide but still make for good  code.
+
+## List of the checks:
+
+### leading_comment_space
+```
+ # bad
+ #comment
+
+ # good
+ # comment
+
+ # allows
+ ########
+```
+
+
+### space_after_comma
+```
+ # bad
+ [foo,bar]
+
+ # good
+ [foo, bar]
+
+ # allows
+ [foo, bar,]
+ foo,;
+ ```
+### space_around_operator
+```
+ # bad
+ $foo='bar'
+ if $baz<1
+
+ # good
+ $foo = 'bar'
+ if $baz < 1
+ ```
+
+### space_inside_braces
+```
+ # bad
+ {foo:'bar'}
+
+ # good
+ { foo:'bar' }
+
+ # allows
+ {}
+ ```

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

@@ -0,0 +1,20 @@
+# Checks that there is a space after comma
+PuppetLint.new_check(:leading_comment_space) do
+  def check
+    tokens.select { |r| r.type == :COMMENT }.each do |token|
+      next if token.value =~ /^\#+$/
+
+      unless token.value =~ /^\s/
+        notify :warning,
+               message: "Add space after #",
+               line: token.line,
+               column: token.column,
+               token: token
+      end
+    end
+  end
+
+  def fix(problem)
+    problem[:token].value = ' ' + problem[:token].value
+  end
+end

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

@@ -0,0 +1,28 @@
+# Checks that there is a space after comma
+PuppetLint.new_check(:space_after_comma) do
+  def check
+    tokens.select { |r| r.type == :COMMA }.each do |token|
+      if token.next_token && !allowed?(token.next_token.type)
+        next if last_comma_in_list?(token)
+        notify :warning,
+               message: "Add space after the comma",
+               line: token.line,
+               column: token.column,
+               token: token
+      end
+    end
+  end
+
+  def fix(problem)
+    index = tokens.index(problem[:token])
+    add_token(index + 1, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+  end
+
+  def allowed?(type)
+    [:WHITESPACE, :NEWLINE, :SEMIC].include?(type)
+  end
+
+  def last_comma_in_list?(token)
+    [:RBRACK, :RBRACE, :RPAREN].include?(token.next_token.type)
+  end
+end

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

@@ -0,0 +1,47 @@
+# Checks that operators have space around them
+PuppetLint.new_check(:space_around_operators) do
+  OPERATORS = %i(EQUALS ISEQUAL NOTEQUAL MATCH APPENDS PLUS GREATEREQUAL
+                 LESSEQUAL GREATERTHAN LESSTHAN NOMATCH).freeze
+
+  def check
+    tokens.select { |r| OPERATORS.include? r.type }.each do |token|
+      missing_space_on_left(token) do
+        display_error(token, "Surrounding space missing for operator #{token.value}")
+        return
+      end
+
+      missing_space_on_right(token) do
+        display_error(token, "Surrounding space missing for operator #{token.value}")
+        return
+      end
+    end
+  end
+
+  def fix(problem)
+    missing_space_on_left(problem[:token]) do
+      index = tokens.index(problem[:token])
+      add_token(index, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+    end
+
+    missing_space_on_right(problem[:token]) do
+      index = tokens.index(problem[:token])
+      add_token(index + 1, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+    end
+  end
+
+  def missing_space_on_left(token)
+    yield if token.prev_token.type != :WHITESPACE
+  end
+
+  def missing_space_on_right(token)
+    yield unless [:WHITESPACE, :NEWLINE].include?(token.next_token.type)
+  end
+
+  def display_error(token, message)
+    notify :warning,
+           message: message,
+           line: token.line,
+           column: token.column,
+           token: token
+  end
+end

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

@@ -0,0 +1,47 @@
+# Checks that operators have space around them
+PuppetLint.new_check(:space_inside_braces) do
+
+  def check
+    tokens.select { |r| [:LBRACE, :RBRACE].include? r.type }.each do |token|
+      missing_space_after_opening(token) do
+        display_error(token, "Add space after opening brace")
+      end
+
+      missing_space_before_closing(token) do
+        display_error(token, "Add space before closing brace")
+      end
+    end
+  end
+
+  def fix(problem)
+    missing_space_after_opening(problem[:token]) do
+      index = tokens.index(problem[:token])
+      add_token(index + 1, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+    end
+
+    missing_space_before_closing(problem[:token]) do
+      index = tokens.index(problem[:token])
+      add_token(index, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+    end
+  end
+
+  def missing_space_after_opening(token)
+    return unless token.type == :LBRACE
+    return if token.next_token.nil? || token.next_token.type == :RBRACE
+    yield unless [:WHITESPACE, :NEWLINE, :INDENT].include?(token.next_token.type)
+  end
+
+  def missing_space_before_closing(token)
+    return unless token.type == :RBRACE
+    return if token.prev_token.nil? || token.prev_token.type == :LBRACE
+    yield unless [:WHITESPACE, :NEWLINE, :INDENT].include?(token.prev_token.type)
+  end
+
+  def display_error(token, message)
+    notify :warning,
+           message: message,
+           line: token.line,
+           column: token.column,
+           token: token
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe 'leading_comment_space' do
+  let(:message) { 'Add space after #' }
+
+  context 'with missing leading space in the comment' do
+    let(:code) { "#this should have a whitespace in the beginning" }
+
+    it { expect(problems).to contain_warning(message).on_line(1).in_column(1) }
+  end
+
+  context 'with leading space in the comment' do
+    let(:code) { "# this should have a whitespace in the beginning" }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with only #' do
+    let(:code) { "######" }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    let(:code) { "#this should have a whitespace in the beginning" }
+    let(:fixed) { "# this should have a whitespace in the beginning" }
+
+    it { expect(manifest).to eq(fixed) }
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+RSpec.describe 'space_after_comma' do
+  let(:message) { 'Add space after the comma' }
+
+  context 'with missing space after single comma' do
+    let(:code) { "'vivid','wily'" }
+
+    it { expect(problems).to contain_warning(message).on_line(1).in_column(8) }
+  end
+
+  context 'with missing space after two commas' do
+    let(:code) { "'vivid','wily', 'xenial','yakketi'" }
+
+    it { expect(problems).to have(2).problems }
+    it { expect(problems).to contain_warning(message).on_line(1).in_column(8) }
+    it { expect(problems).to contain_warning(message).on_line(1).in_column(25) }
+  end
+
+  context 'with space after comma' do
+    let(:code) { "'vivid', 'wily'" }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with trailing comma' do
+    let(:code) { "'vivid', 'wily'," }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with new line after comma' do
+    let(:code) { "'vivid',\n'wily',\n'xenial'" }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with semicolon after comma' do
+    let(:code) { "'vivid', 'wily', 'xenial',;" }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with missing comma after the last element of a list' do
+    let(:code) { "['vivid', 'wily', 'xenial',]" }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    let(:code) { "'vivid','wily', 'xenial','yakketi'" }
+    let(:fixed) { "'vivid', 'wily', 'xenial', 'yakketi'" }
+
+    it { expect(manifest).to eq(fixed) }
+  end
+end

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

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe 'space_around_operators' do
+
+  shared_examples_for 'missing space' do |operator|
+    let(:message) { "Surrounding space missing for operator #{operator}" }
+
+    context 'with missing space on the left side of the operator' do
+      let(:code) { "a#{operator} b" }
+      it { expect(problems).to contain_warning(message).on_line(1) }
+    end
+
+    context 'with missing space on the right side of the operator' do
+      let(:code) { "a #{operator}b" }
+      it { expect(problems).to contain_warning(message).on_line(1) }
+    end
+
+    context 'with new line after the operator' do
+      let(:code) { "a #{operator}\nb" }
+      it { expect(problems).to have(0).problems }
+    end
+
+    context 'with space on both side of operator' do
+      let(:code) { "a #{operator} b" }
+      it { expect(problems).to have(0).problems }
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      let(:code) { "a#{operator}b" }
+      let(:fixed) { "a #{operator} b" }
+
+      it { expect(manifest).to eq(fixed) }
+    end
+  end
+
+  it_behaves_like('missing space', '=')
+  it_behaves_like('missing space', '==')
+  it_behaves_like('missing space', '!=')
+  it_behaves_like('missing space', '=~')
+  it_behaves_like('missing space', '!~')
+  it_behaves_like('missing space', '+=')
+  it_behaves_like('missing space', '+')
+  it_behaves_like('missing space', '>=')
+  it_behaves_like('missing space', '>')
+  it_behaves_like('missing space', '<=')
+  it_behaves_like('missing space', '<')
+end

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

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+RSpec.describe 'space_inside_braces' do
+  let(:message_for_opening_brace) { 'Add space after opening brace' }
+  let(:message_for_closing_brace) { 'Add space before closing brace' }
+
+  context 'with missing space after opening brace' do
+    let(:code) { "if $url {do_something }" }
+
+    it { expect(problems).to contain_warning(message_for_opening_brace).on_line(1).in_column(9) }
+  end
+
+  context 'with empty braces' do
+    let(:code) { "if $url {}" }
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with new line after opening brace' do
+    let(:code) do <<-RUBY
+      if $url {
+
+        }
+      RUBY
+    end
+
+    it { expect(problems).to have(0).problems }
+  end
+
+  context 'with missing space before closing brace' do
+    let(:code) { "if $url { do_something}" }
+
+    it { expect(problems).to contain_warning(message_for_closing_brace).on_line(1).in_column(23) }
+  end
+
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    let(:code) { "if $url {do_something}" }
+    let(:fixed) { "if $url { do_something }" }
+
+    it { expect(manifest).to eq(fixed) }
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-extended
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Tradeo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-29 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.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-its
+  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: rspec-collection_matchers
+  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: 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: rubocop
+  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'
+description: "    Extends puppet-lint with additional checks.\n"
+email: opensource@tradeo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppet-lint/plugins/leading_comment_space.rb
+- lib/puppet-lint/plugins/space_after_comma.rb
+- lib/puppet-lint/plugins/space_around_operators.rb
+- lib/puppet-lint/plugins/space_inside_braces.rb
+- spec/puppet-lint/plugins/leading_comment_space.rb
+- spec/puppet-lint/plugins/space_after_comma_spec.rb
+- spec/puppet-lint/plugins/space_around_operators_spec.rb
+- spec/puppet-lint/plugins/space_inside_braces_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tradeo/puppet-lint-extended
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Additional checks for puppet-lint
+test_files:
+- spec/puppet-lint/plugins/leading_comment_space.rb
+- spec/puppet-lint/plugins/space_after_comma_spec.rb
+- spec/puppet-lint/plugins/space_around_operators_spec.rb
+- spec/puppet-lint/plugins/space_inside_braces_spec.rb
+- spec/spec_helper.rb