puppet-lint-class_parameter-check 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a346b76ae507c5db92f75a789160e4667e8ad1
-  data.tar.gz: f2ba54e52a3884ca98087c347e52c7da5b7a4e26
+  metadata.gz: 6c5361e935c4344c4564501bec96dcadf862bc2e
+  data.tar.gz: 204b0beec1bee3ce66024ebe875c5dd667bf2d49
 SHA512:
-  metadata.gz: d3a5e3e6635291883e3b58faf49a40ae4520532b0a0e5bb52b24bb9204a105cfb75f3282ca6e347f30e0ce631af9113bfa70a866e0af169cfed740ff94bfd19a
-  data.tar.gz: 2f5e8dd8de2d17b2b7dd9dbfe5f6ab9fe90082292aca1cca83833a86146bd91a1875a549f9ce6646e249db3301a0bbbe3772ddfdad9c63b1ef55a3bb3bac7292
+  metadata.gz: 4cbced68e79a4d40abd5c346f94026cccae7587a422313e1cb53496502d3eba3626b21a57e3dd81c1cf4886353ee39171a4f0d992173f326e1bd3b958726ca22
+  data.tar.gz: e5f3c4cfeac458dd3a10003ff6656c6abd2564952af1d3c8a30b8255a32ae09738540f264541dd80ea6ba535a13f54f4652f314c48dd0ec36395cddd71e8ebeb

data/README.md

@@ -10,4 +10,4 @@ To use this plugin, add the following like to the Gemfile in your Puppet code ba
 gem 'puppet-lint-class_parameter-check'
 ```
 ## Usage
-This plugin provides a new check to `puppet-lint`.
+This plugin provides a new check to `puppet-lint`. It supports the `--fix` option.

data/lib/model/class_parameter.rb

@@ -0,0 +1,43 @@
+class ClassParameter
+  attr_reader :tokens
+
+  def initialize
+    @tokens = []
+  end
+
+  def is_optional?
+    tokens.any? { |token| token.type == :EQUALS }
+  end
+
+  def is_required?
+    !is_optional?
+  end
+
+  def name
+    tokens.select do |token|
+      token.type == :VARIABLE
+    end.first.value
+  end
+
+  def add(token)
+    tokens << token
+  end
+
+  def line
+    tokens.first.line
+  end
+
+  def column
+    tokens.first.column
+  end
+
+  def <=>(other)
+    if (self.is_optional? && other.is_optional?) || (self.is_required? && other.is_required?)
+      return self.name <=> other.name
+    elsif self.is_optional? && other.is_required?
+      return 1
+    else
+      return -1
+    end
+  end
+end

data/lib/model/class_parameter_list.rb

@@ -0,0 +1,72 @@
+require_relative 'class_parameter'
+
+class ClassParameterList
+  attr_reader :errors, :start_index, :end_index
+
+  def initialize(tokens, start_index, end_index)
+    @tokens, @start_index, @end_index = tokens, start_index, end_index
+    @errors = []
+  end
+
+  def sort
+    parameters.sort
+  end
+
+  def optional_parameters
+    parameters.select(&:is_optional?)
+  end
+
+  def required_parameters
+    parameters.select(&:is_required?)
+  end
+
+  def validate
+    optional_parameter_found = false
+
+    parameters.each do |parameter|
+      if parameter.is_required? && optional_parameter_found
+        errors << {
+          :message => "Required parameter #{parameter.name} should be specified before optional parameters",
+          :line    => parameter.line,
+          :column  => parameter.column
+        }
+      elsif parameter.is_optional?
+        optional_parameter_found = true
+      end
+    end
+
+    validate_alphabetical_order(required_parameters)
+    validate_alphabetical_order(optional_parameters)
+
+    errors.empty?
+  end
+
+
+  private
+  def parameters
+    parameter = ClassParameter.new
+
+    @tokens.inject([]) do |memo, token|
+      if (token.type == :COMMA || token == @tokens.last) && parameter.tokens.any?
+        # always add a comma and a newline token at the end of each parameter
+        parameter.add(PuppetLint::Lexer::Token.new(:COMMA, ",", 0,0))
+        parameter.add(PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0,0))
+        memo << parameter
+        parameter = ClassParameter.new
+      elsif token.type != :NEWLINE
+        parameter.add(token)
+      end
+      memo
+    end
+  end
+
+  def validate_alphabetical_order(params)
+    if params != params.sort
+      errors << {
+        :message => "Parameter list not in alphabetical order",
+        :line    => params.first.line,
+        :column  => params.first.column
+      }
+    end
+  end
+end

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

@@ -1,41 +1,43 @@
+require_relative '../../model/class_parameter_list'
+
 PuppetLint.new_check(:class_parameter) do
   def check
-    class_indexes.each do |class_index|
-      next if class_index[:param_tokens].nil?
-
-      params = []
-      optional_params = []
+    class_parameter_lists.each do |class_parameter_list|
+      unless class_parameter_list.validate
+        class_parameter_list.errors.each { |error| notify :error, error }
+      end
+    end
+  end
 
-      class_index[:param_tokens].each do |param_token|
-        next unless param_token.type == :VARIABLE && param_token.prev_code_token.type != :EQUALS
+  def fix(problem)
+    resorted_tokens = []
+    token_index = 0
 
-        if param_token.next_code_token.nil? || param_token.next_code_token.type != :EQUALS
-          notify :error, {
-            :message => "Required parameter #{param_token.value} should be specified before optional parameters",
-            :line    => param_token.line,
-            :column  => param_token.column
-          } if optional_params.any?
+    class_parameter_lists.each do |class_parameter_list|
+      resorted_tokens += tokens[token_index..class_parameter_list.start_index]
 
-          params.push(param_token)
-        elsif param_token.next_code_token && param_token.next_code_token.type == :EQUALS
-          optional_params.push(param_token)
-        end
+      class_parameter_list.sort.each do |parameter|
+        resorted_tokens += parameter.tokens
       end
 
-      check_alphabetical_order(params)
-      check_alphabetical_order(optional_params)
+      token_index = class_parameter_list.end_index
     end
+
+    resorted_tokens += tokens[token_index..-1]
+    tokens.replace(resorted_tokens)
   end
 
-  def check_alphabetical_order(params)
-    parameter_names = params.map(&:value)
+  private
+  def class_parameter_lists
+    lists = []
 
-    if parameter_names != parameter_names.sort
-      notify :error, {
-        :message => "Parameter list not in alphabetical order",
-        :line    => params.first.line,
-        :column  => params.first.column
-      }
+    class_indexes.each do |class_index|
+      param_tokens = class_index[:param_tokens]
+      next if param_tokens.nil?
+
+      lists << ClassParameterList.new(param_tokens, tokens.index(param_tokens.first), tokens.index(param_tokens.last))
     end
+
+    lists
   end
 end

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

@@ -134,4 +134,89 @@ describe 'class_parameter' do
       end
     end
   end
+
+  context 'with fix enabled' do
+    before do
+     PuppetLint.configuration.fix = true
+    end
+
+    after do
+     PuppetLint.configuration.fix = false
+    end
+
+    context 'class with no parameters' do
+      let(:code) { "class puppet_module() { }" }
+
+      it 'does not change the code' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'class sorted alphabetically' do
+      let(:code) { <<-EOF
+          class puppet_module(
+            String $alphabetical,
+            String $non_alphabetical,
+          ) { }
+          EOF
+      }
+      it 'does not change the code' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'multiple classes not sorted alphabetically' do
+      let(:code) { <<-EOF
+          class puppet_module(
+            String $non_alphabetical,
+            String $alphabetical
+          ) { }
+
+          class puppet_module2(
+            String $non_alphabetical,
+            String $alphabetical
+          ) { }
+        EOF
+      }
+
+      it 'fixes the problem' do
+        expect(manifest).to eq(<<-EOF
+          class puppet_module(
+            String $alphabetical,
+            String $non_alphabetical,
+          ) { }
+
+          class puppet_module2(
+            String $alphabetical,
+            String $non_alphabetical,
+          ) { }
+          EOF
+        )
+      end
+    end
+
+    context 'not sorted in groups and not alphabetically' do
+      let(:code) { <<-EOF
+          class puppet_module(
+            String $non_alphabetical,
+            String $non_alphabetical_optional = $puppet_module::params::non_alphabetical_optional,
+            String $alphabetical,
+            String $alphabetical_optional = "default"
+          ) inherits puppet_module::params { }
+          EOF
+      }
+
+      it 'fixes the problem' do
+        expect(manifest).to eq(<<-EOF
+          class puppet_module(
+            String $alphabetical,
+            String $non_alphabetical,
+            String $alphabetical_optional = "default",
+            String $non_alphabetical_optional = $puppet_module::params::non_alphabetical_optional,
+          ) inherits puppet_module::params { }
+          EOF
+        )
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_parameter-check
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Roelof Reitsma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -91,6 +91,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - LICENSE
+- lib/model/class_parameter.rb
+- lib/model/class_parameter_list.rb
 - lib/puppet-lint/plugins/check_class_parameter.rb
 - spec/puppet-lint/plugins/check_class_parameter_spec.rb
 - spec/spec_helper.rb