puppet-lint-improved_arrow_alignment 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c99848491e74f1bd13f483d306162aa7471ded63e223e40f0d4829685f9c2510
+  data.tar.gz: eb43057ff3f2b48773860d15618d2708f55e41fb8296d3ee14d30e4839f9aac9
+SHA512:
+  metadata.gz: cce4814a5d75d9a529b0c72240913296a71d7651e693b5492a4c83feec12c81823b10640e9ea7ed0a16ba1e782360b494fa765b456d0745a8b567e160384dba0
+  data.tar.gz: 043d6d59ef125e0c7e67fa0b1c13eb5ea2646672f6b99ebbe98d22f2bbd1e574e74d24b2315ce5c3d080d73b1362616baba1c0270f58c06f870d73b4ed876685

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dean Wilson
+
+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,28 @@
+# puppet-lint-improved_arrow_alignment
+
+[![Gem Version](https://badge.fury.io/rb/puppet-lint-improved_arrow_alignment.svg)](https://badge.fury.io/rb/puppet-lint-improved_arrow_alignment)
+
+## Installation
+To add the provided lint checks into a module utilizing the PDK:
+
+1. Add the following to the `.sync.yml` in the root of your module
+   ``` yaml
+   ---
+   Gemfile:
+     optional:
+       ':development':
+         - gem: 'puppet-lint-improved_arrow_alignment'
+   ```
+2. Run `pdk update` from the root of the module
+3. `pdk validate` will now also use the lint checks provided by this plugin
+
+## Usage
+This plugin provides one new check to `puppet-lint`
+
+### **improved_arrow_alignment**
+`--fix` support: No
+
+This check raises an warning if the arrow alignment is off anywhere within a class.
+```
+warning: indentation of => is not properly aligned (expected in column %d, but found it in column %d)
+```

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

@@ -0,0 +1,87 @@
+PuppetLint.new_check(:improved_arrow_alignment) do
+  def check
+    class_indexes.each do |res_idx|
+      arrow_column = [0]
+      level_idx = 0
+      level_tokens = []
+      param_column = [nil]
+      resource_tokens = res_idx[:tokens]
+      resource_tokens.reject! do |token|
+        COMMENT_TYPES.include?(token.type)
+      end
+
+      # If this is a single line resource, skip it
+      first_arrow = resource_tokens.index { |r| r.type == :FARROW }
+      last_arrow = resource_tokens.rindex { |r| r.type == :FARROW }
+      next if first_arrow.nil?
+      next if last_arrow.nil?
+      next if resource_tokens[first_arrow].line == resource_tokens[last_arrow].line
+
+      resource_tokens.each do |token|
+        if token.type == :FARROW
+          param_token = token.prev_code_token
+
+          if param_token.type == :DQPOST
+            param_length = 0
+            iter_token = param_token
+            while iter_token.type != :DQPRE
+              param_length += iter_token.to_manifest.length
+              iter_token = iter_token.prev_token
+            end
+            param_length += iter_token.to_manifest.length
+          else
+            param_length = param_token.to_manifest.length
+          end
+
+          if param_column[level_idx].nil?
+            param_column[level_idx] = if param_token.type == :DQPOST
+                                        iter_token.column
+                                      else
+                                        param_token.column
+                                      end
+          end
+
+          if (level_tokens[level_idx] ||= []).any? { |t| t.line == token.line }
+            this_arrow_column = param_column[level_idx] + param_length + 1
+          else
+            this_arrow_column = param_token.column + param_token.to_manifest.length
+            this_arrow_column += 1
+          end
+
+          if arrow_column[level_idx] < this_arrow_column
+            arrow_column[level_idx] = this_arrow_column
+          end
+
+          (level_tokens[level_idx] ||= []) << token
+        elsif token.type == :LBRACE
+          level_idx += 1
+          arrow_column << 0
+          level_tokens[level_idx] ||= []
+          param_column << nil
+        elsif token.type == :RBRACE || token.type == :SEMIC
+          if (level_tokens[level_idx] ||= []).map(&:line).uniq.length > 1
+            level_tokens[level_idx].each do |arrow_tok|
+              next if arrow_tok.column == arrow_column[level_idx] || level_tokens[level_idx].size == 1
+
+              arrows_on_line = level_tokens[level_idx].select { |t| t.line == arrow_tok.line }
+              notify(
+                :warning,
+                :message        => "indentation of => is not properly aligned (expected in column #{arrow_column[level_idx]}, but found it in column #{arrow_tok.column})",
+                :line           => arrow_tok.line,
+                :column         => arrow_tok.column,
+                :token          => arrow_tok,
+                :arrow_column   => arrow_column[level_idx],
+                :newline        => arrows_on_line.index(arrow_tok) != 0,
+                :newline_indent => param_column[level_idx] - 1
+              )
+            end
+          end
+          arrow_column[level_idx] = 0
+          level_tokens[level_idx].clear
+          param_column[level_idx] = nil
+          level_idx -= 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'improved_arrow_alignment' do
+  context 'resource default with correctly alligned' do
+    let(:code) do
+      <<-EOS
+        class imatest {
+          File {
+            ensure => present,
+            mode   => '0755'
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  # and these should cause failiures
+
+  context 'resource default with misaligned' do
+    let(:msg) { 'indentation of => is not properly aligned (expected in column %d, but found it in column %d)' }
+
+    let(:code) do
+      <<-EOS
+        class imatest {
+          File {
+            ensure => present,
+            mode  => '0755',
+            owner    => root,
+          }
+        }
+      EOS
+    end
+
+    it 'should detect two problems' do
+      expect(problems).to have(2).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(format(msg, 20, 19)).on_line(4).in_column(19)
+      expect(problems).to contain_warning(format(msg, 20, 22)).on_line(5).in_column(22)
+    end
+  end
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-improved_arrow_alignment
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Garrett Rowell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-08 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.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+description: "    Extends puppet-lint to better handle => alignment.\n"
+email: garrett@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/improved_arrow_alignment.rb
+- spec/puppet-lint/plugins/improved_arrow_alignment_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/puppet-lint-improved_arrow_alignment
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/garrettrowell/puppet-lint-improved_arrow_alignment
+  documentation_uri: https://github.com/garrettrowell/puppet-lint-improved_arrow_alignment/blob/master/README.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: improved puppet-lint arrow alignment checks
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/improved_arrow_alignment_spec.rb