puppet-lint-class_alignment-check 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a840e9e2d88d40af098ce22a8a2ca7d8dde090b727f85af6e05f72c84b79c95
-  data.tar.gz: be0f893935808ba8c07682dd5bd7457ca686ba8adc973a85a04d40d2785b656d
+  metadata.gz: bea9133383ac53f7e568261f0b752c267b49773265c6dd71cbf76b7082cf5326
+  data.tar.gz: 7db3d124fb3714902d13da0db06f2ba31baa469b16e0b236cf124f77258b7b2d
 SHA512:
-  metadata.gz: 4c312626c1d7b3b23584963c138b324ee11b5c1931c6f2bcf1f34a85a9aa95d99850c1fd31fb6ef96659d2646fa3bc4dfa40b516e102bc82944612bb0c5fcf39
-  data.tar.gz: 8cd001ccd8620fd4fd4f57ba946d36a23a2115d1ce2c2c0835e30c533f42cc064e426edcbaf87a42ce2d88c2d18ed8efc443bd8f91768fda2c7389329ba29696
+  metadata.gz: 538a2f9bb3dbe6575673a5ee8a5207a6ec09f2c1c3f245957f5f4f5149434f24ba7af08da337df97f6fa853158de9459b0332e2df4eceed91a094ec974716ebc
+  data.tar.gz: ec62f9ae3a83cbcf445dfd7607ae3aeb4bd70dedf266767a4b26385d18e516689db06dc70db43fbd0f7f7cb6ba87913a15e703a6b92edfd8da41f769e5f4485d

data/README.md

@@ -2,6 +2,9 @@
 
 [![License](https://img.shields.io/github/license/anhpt379/puppet-lint-class_alignment-check.svg)](https://github.com/anhpt379/puppet-lint-class_alignment-check/blob/master/LICENSE)
 [![Test](https://github.com/anhpt379/puppet-lint-class_alignment-check/actions/workflows/test.yml/badge.svg)](https://github.com/anhpt379/puppet-lint-class_alignment-check/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/anhpt379/puppet-lint-class_alignment-check/branch/master/graph/badge.svg?token=2DI8JYJ8AZ)](https://codecov.io/gh/anhpt379/puppet-lint-class_alignment-check)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-class_alignment-check.svg)](https://rubygems.org/gems/puppet-lint-class_alignment-check)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-class_alignment-check.svg)](https://rubygems.org/gems/puppet-lint-class_alignment-check)
 
 A puppet-lint plugin to check and fix class params/equals alignment.
 

data/spec/spec_helper.rb

@@ -1,5 +1,29 @@
 # frozen_string_literal: true
 
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError
+else
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    enable_coverage :branch
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov
+  ]
+end
+
 require 'puppet-lint'
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_alignment-check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anh Pham
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2022-05-08 00:00:00.000000000 Z
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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
@@ -87,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,7 +122,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/puppet-lint/plugins/check_class_params_alignment.rb
 - spec/puppet-lint/plugins/check_class_equals_alignment_spec.rb
 - spec/puppet-lint/plugins/check_class_params_alignment_spec.rb
 - spec/spec_helper.rb
@@ -116,7 +129,7 @@ homepage: https://github.com/anhpt379/puppet-lint-class_alignment-check
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -131,8 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check & fix class params/equals alignment.
 test_files:

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

@@ -1,213 +0,0 @@
-# Parameters to classes or defined types must be uniformly indented in two
-# spaces from the title. The equals sign should be aligned.
-#
-# https://puppet.com/docs/puppet/7/style_guide.html#style_guide_classes-param-indentation-alignment
-
-require 'debug'
-
-def a_param?(token)
-  if token.prev_code_token.type == :EQUALS
-    false
-  elsif token.prev_code_token.type == :FARROW
-    false
-  elsif token.type == :VARIABLE && !%i[DQPRE DQMID].include?(token.prev_code_token.type)
-    true
-  end
-end
-
-def first_param_on_the_line?(token)
-  origin = token
-  while token&.prev_token
-    token = token.prev_token
-
-    break if token.type == :NEWLINE
-  end
-
-  while token&.next_token
-    token = token.next_token
-
-    break if token.type == :VARIABLE
-  end
-
-  origin == token
-end
-
-def the_one?(token, character)
-  case character
-  when '='
-    true if token.type == :EQUALS
-  when '$'
-    true if token.type == :VARIABLE && a_param?(token) && first_param_on_the_line?(token)
-  end
-end
-
-def get_the_first_param(token)
-  while token&.prev_code_token
-    token = token.prev_code_token
-    break if token.type == :CLASS
-  end
-
-  while token&.next_code_token
-    token = token.next_code_token
-    return token if token.type == :VARIABLE
-  end
-end
-
-def get_prev_code_token(token, character)
-  case character
-  when '='
-    token.prev_code_token
-  when '$'
-    if token.prev_code_token
-      if %i[CLASSREF RBRACK].include?(token.prev_code_token.type)
-        token.prev_code_token
-      elsif token.prev_code_token.type == :LPAREN
-        token
-      elsif token.prev_code_token.type == :COMMA
-        get_the_first_param(token)
-      end
-    end
-  end
-end
-
-# This function is copied & modified from puppet-lint arrow_alignment check
-# https://github.com/puppetlabs/puppet-lint/blob/020143b705b023946739eb44e7c7d99fcd087527/lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb#L8
-def check_for(character)
-  # I intentionally didn't rename `arrow` to another name, to keep the code as
-  # similar as the original one, to easier to update in the future.
-  (class_indexes + defined_type_indexes).each do |res_idx|
-    arrow_column = [0]
-    level_idx = 0
-    level_tokens = []
-    param_column = [nil]
-    resource_tokens = res_idx[:param_tokens]
-    next if resource_tokens.nil?
-
-    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| the_one?(r, character) }
-    last_arrow = resource_tokens.rindex { |r| the_one?(r, character) }
-    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 the_one?(token, character)
-        param_token = get_prev_code_token(token, character)
-        param_token = token if param_token.nil?
-
-        param_length = param_token.to_manifest.length
-
-        param_column[level_idx] = param_token.column if param_column[level_idx].nil?
-
-        if (level_tokens[level_idx] ||= []).any? { |t| t.line == token.line }
-          this_arrow_column = param_column[level_idx] + param_length + 1
-        elsif character == '$' && param_token.type == :VARIABLE
-          this_arrow_column = param_token.column
-        else
-          this_arrow_column = param_token.column + param_token.to_manifest.length
-          this_arrow_column += 1 if param_token.type != :INDENT
-        end
-
-        arrow_column[level_idx] = this_arrow_column if arrow_column[level_idx] < this_arrow_column
-
-        (level_tokens[level_idx] ||= []) << token
-      elsif token.prev_token.type == :LPAREN
-        level_idx += 1
-        arrow_column << 0
-        level_tokens[level_idx] ||= []
-        param_column << nil
-      elsif token.next_token.type == :RPAREN
-        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 #{character} 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
-
-# This function is copied & modified from puppet-lint arrow_alignment fix
-# https://github.com/puppetlabs/puppet-lint/blob/020143b705b023946739eb44e7c7d99fcd087527/lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb#L94
-def fix_for(problem)
-  if problem[:newline]
-    index = tokens.index(problem[:token].prev_code_token.prev_token)
-
-    # insert newline
-    tokens.insert(index, PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0, 0))
-
-    # indent the parameter to the correct depth
-    problem[:token].prev_code_token.prev_token.type = :INDENT
-    problem[:token].prev_code_token.prev_token.value = ' ' * problem[:newline_indent]
-
-    end_param_idx = tokens.index(problem[:token].prev_code_token)
-    start_param_idx = tokens.index(problem[:token].prev_token_of(%i[INDENT NEWLINE]))
-    param_length = tokens[start_param_idx..end_param_idx].map do |r|
-                     r.to_manifest.length
-                   end.reduce(0) { |sum, x| sum + x } + 1
-    new_ws_len = problem[:arrow_column] - param_length
-  else
-    new_ws_len = if problem[:token].prev_token.type == :WHITESPACE
-                   problem[:token].prev_token.to_manifest.length
-                 else
-                   0
-                 end
-    new_ws_len += (problem[:arrow_column] - problem[:token].column)
-  end
-
-  if new_ws_len.negative?
-    raise PuppetLint::NoFix if problem[:token].prev_token.type != :INDENT
-
-    new_ws = problem[:token].prev_token.to_manifest[0...new_ws_len]
-    problem[:token].prev_token.value = new_ws
-  else
-    new_ws = ' ' * new_ws_len
-
-    if problem[:token].prev_token.type == :WHITESPACE
-      problem[:token].prev_token.value = new_ws
-    else
-      index = tokens.index(problem[:token].prev_token)
-      tokens.insert(index + 1, PuppetLint::Lexer::Token.new(:WHITESPACE, new_ws, 0, 0))
-    end
-  end
-end
-
-PuppetLint.new_check(:class_params_alignment) do
-  def check
-    check_for('$')
-  end
-
-  def fix(problem)
-    fix_for(problem)
-  end
-end
-
-PuppetLint.new_check(:class_equals_alignment) do
-  def check
-    check_for('=')
-  end
-
-  def fix(problem)
-    fix_for(problem)
-  end
-end