puppet-lint-class_parameter-check 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e75015f13ea813a8d308575f028536653bc84cf
-  data.tar.gz: 95ed706edf7e95efb9b03e7028ebc8990aee9376
+  metadata.gz: 2cc6a4bf5f8538998456c3a4264a06293cca5534
+  data.tar.gz: 0ae21922016a83a566236f4f72812d0a435c9d4a
 SHA512:
-  metadata.gz: 3143d719a396c96967fe5a010114c5d344cb2ba65c4ccc2b4a877a3d43c99819e17e5cdcefa9999bd9b16992ba4cc15534b1d7553b83f5b94931cfb3a5f2d5d1
-  data.tar.gz: d3659ced8a9ddcc5621e11c134bd61a1eb14fcfd85b9e093cfa501883939232e043b8480a27da91bc7970ccda378c25165d6b30607a8d036c63cde0cbff32c0d
+  metadata.gz: 3eadbe8e218b908e4beea58261300069ea7ff61685b108edd6b4630658135d05513b2f8d9a34c9f2f10ebb86752fc20b61e0213b9b58d505d8b02b2dfaad1bad
+  data.tar.gz: 3fd10e790eea0cb463752948a9f0ff889e2e92529d1c71def67b0558576bb30003cadb8c4519c72fae16cb98d4de7f34a7d5feff08a232cd0bd2ca85a7e7caaa

data/lib/model/documentation_list.rb

@@ -0,0 +1,38 @@
+require_relative 'parameter_documentation'
+
+class DocumentationList
+  attr_reader :start_index, :end_index
+
+  def initialize(tokens, start_index, end_index)
+    @tokens, @start_index, @end_index = tokens, start_index, end_index
+  end
+
+  def parameter_documentation_list
+    return @parameter_documentation_list unless @parameter_documentation_list.nil?
+
+    parameter_documentation = ParameterDocumentation.new
+    harvest_tokens = false
+
+    @parameter_documentation_list = @tokens.inject([]) do |memo, token|
+      if token.type == :COMMENT && token.value.match(/@param \w*/)
+        memo << parameter_documentation if parameter_documentation.tokens.any?
+        parameter_documentation = ParameterDocumentation.new
+        harvest_tokens = true
+      end
+
+      if (token.type == :COMMENT && token.value.strip == "")
+        harvest_tokens = false
+      end
+
+      if harvest_tokens
+        parameter_documentation.tokens << token
+      end
+
+      memo
+    end
+
+    @parameter_documentation_list << parameter_documentation if parameter_documentation.tokens.any?
+
+    @parameter_documentation_list
+  end
+end

data/lib/model/{class_parameter.rb → parameter.rb}

@@ -1,4 +1,6 @@
-class ClassParameter
+class Parameter
+  attr_accessor :documentation
+
   def initialize
     @tokens = []
   end

data/lib/model/parameter_documentation.rb

@@ -0,0 +1,15 @@
+class ParameterDocumentation
+  attr_reader :tokens
+
+  def initialize
+    @tokens = []
+  end
+
+  def name
+    @tokens.each do |token|
+      if token.value.match(/@param (\w*)/)
+        return $1
+      end
+    end
+  end
+end

data/lib/model/{class_parameter_list.rb → parameter_list.rb}

@@ -1,6 +1,6 @@
-require_relative 'class_parameter'
+require_relative 'parameter'
 
-class ClassParameterList
+class ParameterList
   attr_reader :errors, :start_index, :end_index
 
   def initialize(tokens, start_index, end_index)
@@ -12,6 +12,12 @@ class ClassParameterList
     parameters.sort
   end
 
+  def each(&block)
+    parameters.each do |parameter|
+      yield parameter
+    end
+  end
+
   def optional_parameters
     parameters.select(&:is_optional?)
   end
@@ -44,7 +50,7 @@ class ClassParameterList
 
   private
   def parameters
-    parameter = ClassParameter.new
+    parameter = Parameter.new
     stack = []
 
     @tokens.inject([]) do |memo, token|
@@ -60,7 +66,7 @@ class ClassParameterList
         end
 
         memo << parameter
-        parameter = ClassParameter.new
+        parameter = Parameter.new
       else
         parameter.add(token)
       end

data/lib/model/puppet_class.rb

@@ -0,0 +1,73 @@
+require_relative 'parameter_list'
+require_relative 'documentation_list'
+
+class PuppetClass
+  def initialize(tokens, index)
+    @tokens, @index = tokens, index
+  end
+
+  def name
+    @name ||= @index[:tokens].select do |token|
+      token.type == :NAME
+    end.first.value
+  end
+
+  def has_parameter_documentation?
+    !parameter_documentation_list.empty?
+  end
+
+  def parameter_list
+    param_tokens = @index[:param_tokens]
+    return if param_tokens.nil?
+
+    @parameter_list ||= ParameterList.new(param_tokens, @tokens.index(param_tokens.first), @tokens.index(param_tokens.last))
+  end
+
+  def documentation_list
+    @documentation_list ||= DocumentationList.new(documentation_tokens, @tokens.index(documentation_tokens.first), @tokens.index(documentation_tokens.last))
+  end
+
+  def parameter_documentation_list
+    documentation_list.parameter_documentation_list
+  end
+
+  def sorted_parameter_documentation_list
+    sorted_parameter_list.inject([]) do |memo, parameter|
+      documentation = parameter_documentation_list.select do |parameter_documentation|
+        parameter_documentation.name == parameter.name
+      end.first
+
+      memo << documentation if documentation
+
+      memo
+    end
+  end
+
+  def sorted_parameter_list
+    parameter_list.sort
+  end
+
+  def parameter_documentation_start_index
+    @tokens.index(parameter_documentation_list.first.tokens.first)
+  end
+
+  def parameter_documentation_end_index
+    @tokens.index(parameter_documentation_list.last.tokens.last) + 1
+  end
+
+  private
+  def documentation_tokens
+    return @doc_tokens unless @doc_tokens.nil? || @doc_tokens.empty?
+
+    @doc_tokens = []
+    prev_token = @index[:tokens].first.prev_token
+    while (prev_token && prev_token.type != :RBRACE)
+      @doc_tokens << prev_token
+
+      prev_token = prev_token.prev_token
+    end
+
+    @doc_tokens.reverse!
+    return @doc_tokens
+  end
+end

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

@@ -1,22 +1,40 @@
-require_relative '../../model/class_parameter_list'
+require_relative '../../model/puppet_class'
 
 PuppetLint.new_check(:class_parameter) do
+  @fixed = false
+
   def check
-    class_parameter_lists.each do |class_parameter_list|
-      unless class_parameter_list.validate
-        class_parameter_list.errors.each { |error| notify :error, error }
+    class_indexes.each do |class_index|
+      puppet_class = PuppetClass.new(tokens, class_index)
+
+      next unless puppet_class.parameter_list
+
+      unless puppet_class.parameter_list.validate
+        puppet_class.parameter_list.errors.each { |error| notify :error, error }
       end
     end
   end
 
   def fix(problem)
+    return if @fixed
+
     resorted_tokens = []
     token_index = 0
 
-    class_parameter_lists.each do |class_parameter_list|
-      resorted_tokens += tokens[token_index..class_parameter_list.start_index]
+    class_indexes.each do |class_index|
+      puppet_class = PuppetClass.new(tokens, class_index)
 
-      sorted_class_parameter_list = class_parameter_list.sort
+      if puppet_class.has_parameter_documentation?
+        resorted_tokens += tokens[token_index...puppet_class.parameter_documentation_start_index]
+        puppet_class.sorted_parameter_documentation_list.each do |parameter_documentation|
+          resorted_tokens += parameter_documentation.tokens
+        end
+        resorted_tokens += tokens[puppet_class.parameter_documentation_end_index..puppet_class.parameter_list.start_index]
+      else
+        resorted_tokens += tokens[token_index..puppet_class.parameter_list.start_index]
+      end
+
+      sorted_class_parameter_list = puppet_class.sorted_parameter_list
       sorted_class_parameter_list.each do |parameter|
         resorted_tokens += parameter.tokens
 
@@ -24,27 +42,15 @@ PuppetLint.new_check(:class_parameter) do
           resorted_tokens << PuppetLint::Lexer::Token.new(:COMMA, ",", 0,0)
         end
 
-        resorted_tokens << PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0,0)
+        resorted_tokens << PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0,0) unless parameter == sorted_class_parameter_list.last
       end
 
-      token_index = class_parameter_list.end_index
+      token_index = puppet_class.parameter_list.end_index
     end
 
     resorted_tokens += tokens[token_index..-1]
     tokens.replace(resorted_tokens)
-  end
-
-  private
-  def class_parameter_lists
-    lists = []
-
-    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
+    @fixed = true
   end
 end

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

@@ -202,54 +202,100 @@ describe 'class_parameter' do
 
     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
+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
+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
+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
+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
+
+    context 'with documented parameters not sorted alphabetically' do
+      let(:code) { <<-EOF
+#
+# @param non_alphabetical The non_alphabetical parameter
+# @param alphabetical The alphabetical parameter
+#
+class puppet_module(
+  String $non_alphabetical,
+  String $alphabetical
+) { }
+
+#
+# @param non_alphabetical The non_alphabetical parameter
+# @param alphabetical The alphabetical parameter
+#
+class puppet_module2(
+  String $non_alphabetical,
+  String $alphabetical
+) { }
+EOF
+      }
+
+      it 'fixes the problem' do
+        expect(manifest).to eq(<<-EOF
+#
+# @param alphabetical The alphabetical parameter
+# @param non_alphabetical The non_alphabetical parameter
+#
+class puppet_module(
+  String $alphabetical,
+  String $non_alphabetical
+) { }
+
+#
+# @param alphabetical The alphabetical parameter
+# @param non_alphabetical The non_alphabetical parameter
+#
+class puppet_module2(
+  String $alphabetical,
+  String $non_alphabetical
+) { }
+EOF
         )
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_parameter-check
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Roelof Reitsma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -91,8 +91,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - LICENSE
-- lib/model/class_parameter.rb
-- lib/model/class_parameter_list.rb
+- lib/model/documentation_list.rb
+- lib/model/parameter.rb
+- lib/model/parameter_documentation.rb
+- lib/model/parameter_list.rb
+- lib/model/puppet_class.rb
 - lib/puppet-lint/plugins/check_class_parameter.rb
 - spec/puppet-lint/plugins/check_class_parameter_spec.rb
 - spec/spec_helper.rb