puppet-lint-strict_indent-check 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: feb8dee2777ebf6abdfc11c8d5369963d316b7aa
+  data.tar.gz: 972df005087cfd211b697829aeee989906113543
+SHA512:
+  metadata.gz: 51b9ceeef1fc715949bba52f2533783b5b4f286383621a4c43922ea048b83bbf6d962aadf91fb867e9699ec21daa9751150d9ac40770fc4efa1e69004a2c34a2
+  data.tar.gz: 3c8b2a98562412ea40ca184ccfe27890c073cf642bb5e19c2c0ad5c18a2fea375abc1af98c8adce906b600425c4a035518987f1445fe4293fcce2a44ed4b735c

data/LICENSE

@@ -0,0 +1,3 @@
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at http://mozilla.org/MPL/2.0/

data/README.md

@@ -0,0 +1,44 @@
+Installation
+===
+
+<pre>
+gem install puppet-lint-strict_indent-check
+</pre>
+
+Usage
+===
+
+This plugin provides an indentation check for puppet-lint `strict_indent`. The check has a strict expectation for all indentation, except comments and whitespace/blank lines.
+
+supports --fix flag
+
+Check will raise a warning for any files that don't have 2-space indent, and follow specific guidelines for increase/decrease of indent.
+
+Alternate Indentation
+===
+
+Indentation defaults to 2 spaces. To use a different number of spaces, use the `-l` option to load ruby file changing the `chars_per_indent` config.
+
+config file `chars_per_indent_4.rb`:
+<pre>
+# This could also be set in your Rakefile
+PuppetLint.configuration.chars_per_indent = 4
+</pre>
+
+lint command:
+<pre>
+puppet-lint -l chars_per_indent_4.rb puppet-mysql/manifests/init.pp
+</pre>
+
+Acceptable Identation
+===
+
+* indent should increase by one step the line after each opened brace (square, curly, paren)
+* indent should decrease by one step the line of every closed brace.
+* indent should increase by one step the line after a resource title, unless it already increased due to a bracket.
+* indent should decrease by one step the line after the end of a resource due to semicolon, if it was indented for resource title.
+* indent should decrease by one step the line of the end of a resource due to right curly brace, if it was indented for resource title, and not ended by a semicolon.
+* indent should increase by one step the line after an equals `=` or farrow `=>` that ends a line, but only for that one line.
+
+see `spec/fixtures/pass/` for good indentation examples
+see `spec/fixtures/fail/` for bad indentation examples

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

@@ -0,0 +1,154 @@
+# Public: Check the manifest tokens for correct indent levels and
+# record a warning for each instance found.
+
+PuppetLint.new_check(:'strict_indent') do
+  def match(tokens)
+    open = {
+      :LBRACE => [],
+      :LBRACK => [],
+      :LPAREN => [],
+    }
+
+    matches = {}
+
+    tokens.each do |token|
+      if [:LBRACE, :LBRACK, :LPAREN].include?(token.type)
+        open[token.type] << token
+      elsif [:RBRACE, :RBRACK, :RPAREN].include?(token.type)
+        match = open[("L" + token.type[1..-1]).to_sym].pop
+        if not match.nil?
+          matches[token] = match
+          matches[match] = token
+        end
+      end
+    end
+
+    matches
+  end
+
+  def check
+    chars_per_indent = PuppetLint.configuration.chars_per_indent || 2
+    indent = 0
+    colon_indent = nil
+
+    matches = match(tokens)
+
+    tokens.select { |token|
+      token.type == :NEWLINE
+    }.reject { |token|
+      # ignore newline at end of code
+      token.next_token.nil?
+    }.each do |token|
+      temp_indent = 0
+
+      # indent for open groups in the previous line
+      open_groups = 0
+      prev_token = token.prev_token
+      while not prev_token.nil? and prev_token.type != :NEWLINE
+        if [:LBRACE, :LBRACK, :LPAREN].include?(prev_token.type)
+          if matches[prev_token].nil? or matches[prev_token].line > prev_token.line
+            # left braces not matched in the same line increase indent
+            open_groups += 1
+          end
+        end
+        prev_token = prev_token.prev_token
+      end
+      indent += open_groups
+
+      # reset prev_token to last non-whitespace token on previous line
+      prev_token = token.prev_token
+      while not prev_token.nil? and prev_token.type == :WHITESPACE
+        prev_token = prev_token.prev_token
+      end
+
+      # get type if available
+      prev_type = prev_token.nil? ? nil : prev_token.type
+
+      # handle change in indent based on last token
+      case prev_type
+      when :COLON
+        if open_groups == 0
+          if colon_indent.nil?
+            # only indent for a colon when you haven't indented yet
+            colon_indent = prev_token.line
+            indent += 1
+          else
+            # you probably missed a semicolon two lines ago
+          end
+        end
+      when :SEMIC
+        if not colon_indent.nil?
+          # only unindent for a semicolon when we've indented for a colon
+          colon_indent = nil
+          indent -= 1
+        end
+      when :EQUALS, :FARROW
+        temp_indent += 1
+      end
+
+      # unindent for closing brackets in the current line
+      next_token = token.next_token
+      while not next_token.nil? and next_token.type != :NEWLINE
+        if [:RBRACE, :RBRACK, :RPAREN].include?(next_token.type)
+          if not matches[next_token].nil? and matches[next_token].line < next_token.line
+            # right braces matched in a previous line decrease indent
+            indent -= 1
+          end
+          if next_token.type == :RBRACE and not colon_indent.nil?
+            if not matches[next_token].nil? and matches[next_token].line < colon_indent
+              # unindent at the end of resources if needed
+              indent -= 1
+              colon_indent = nil
+            end
+          end
+        end
+        next_token = next_token.next_token
+      end
+
+      # obviously we have a problem
+      if indent < 0
+        notify :error, {
+          :message => 'Error calculating indent. Please file an issue at https://github.com/relud/puppet-lint-indent-check/issues',
+          :line    => token.next_token.line,
+          :column  => token.next_token.column,
+        }
+        # stop parsing indent
+        break
+      end
+
+      # get actual indent
+      actual = 0
+      if token.next_token.type == :INDENT
+        actual = token.next_token.value.length
+      else
+        actual = 0
+      end
+
+      # expected indent
+      expected = (indent + temp_indent) * chars_per_indent
+
+      # oh no! incorrect indent!
+      if actual != expected
+        # no one cares if blank lines and comments are indented correctly
+        if not [:COMMENT, :NEWLINE].include?(token.next_token.type)
+          notify :warning, {
+            :message => "indent should be #{expected} chars and is #{actual}",
+            :line    => token.line,
+            :column  => token.column,
+            :token   => token,
+            :indent  => expected,
+          }
+        end
+      end
+    end
+  end
+
+  def fix(problem)
+    char_for_indent = ' '
+    if problem[:token].next_token.type == :INDENT
+      problem[:token].next_token.value = char_for_indent * problem[:indent]
+    else
+      problem[:token].next_token.value = char_for_indent * problem[:indent] + problem[:token].next_token.value
+    end
+  end
+end

data/spec/fixtures/fail/1.pp

@@ -0,0 +1,9 @@
+# failing manifest
+class 1 (
+) {
+  file { 'this':
+    ensure  => 'present',
+    require => [ 'abc',
+                 'def', ],
+  }
+}

data/spec/fixtures/pass/1.pp

@@ -0,0 +1,55 @@
+# passing manifest 1
+class 1 (
+  $arg1 = 1,
+  $arg2 =
+    2,
+  $arg3 = [
+    1,
+    2,
+  ],
+  $arg4 = {
+    1 => 2,
+    3 => 4,
+  },
+  $arg5 = (
+    1 + 1
+  ),
+) {
+  file { '/abc':
+    ensure  => 'file',
+    content =>
+      file('abc'),
+    require => [
+      File['def'],
+    ],
+  }
+
+  file {
+    [
+      '/def',
+    ]:
+      ensure  => 'directory';
+
+    'ghi':
+      ensure  => 'file',
+      content => file('ghi');
+
+    'jkl':
+      ensure  => 'file'
+      content => $::osfamily ? {
+        'RedHat' => 'jkl',
+        default  => 'jklol',
+      };
+
+    [
+      'mno',
+      'pqr',
+    ]:
+      ensure => (
+        'file'
+      ),
+      content => (
+        'stuff'
+      );
+  }
+}

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

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe 'strict_indent' do
+  before do
+    # disable all other checks
+    PuppetLint.configuration.checks.reject{ |check|
+      check == :indent
+    }.each do |check|
+      PuppetLint.configuration.send("disable_#{check}")
+    end
+  end
+
+  after do
+    # re-enable other checks
+    PuppetLint.configuration.checks.reject{ |check|
+      check == :indent
+    }.each do |check|
+      PuppetLint.configuration.send("enable_#{check}")
+    end
+  end
+
+  context 'on manifest' do
+    Dir['spec/fixtures/pass/*'].each do |manifest|
+      context manifest do
+        let(:code) { File.read(manifest) }
+
+        it 'should detect no problems' do
+          expect(problems).to have(0).problems
+        end
+      end
+    end
+
+    Dir['spec/fixtures/fail/*'].each do |manifest|
+      context manifest do
+        let(:code) { File.read(manifest) }
+
+        it 'should detect problems' do
+          expect(problems).to have(1).problems
+        end
+      end
+    end
+  end
+
+  context 'invalid array indent' do
+    let(:code) {
+      <<-EOF.gsub(/^ {8}/, '')
+        class (
+        ) {
+          file { 'this':
+            ensure  => 'present',
+            require => [ 'abc',
+                         'def', ],
+          }
+        }
+      EOF
+    }
+
+    it 'should detect 1 problems' do
+      expect(problems).to have(1).problems
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-strict_indent-check
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Daniel Thornton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: 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: |2
+      Extends puppet-lint to ensure that your manifests follow a strict indentation pattern.
+email: daniel@relud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_strict_indent.rb
+- spec/fixtures/fail/1.pp
+- spec/fixtures/pass/1.pp
+- spec/puppet-lint/plugins/check_strict_indent_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/relud/puppet-lint-strict_indent-check
+licenses:
+- Mozilla 2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: puppet-lint strict indent check
+test_files:
+- spec/puppet-lint/plugins/check_strict_indent_spec.rb
+- spec/fixtures/fail/1.pp
+- spec/fixtures/pass/1.pp
+- spec/spec_helper.rb