puppet-lint-class_parameter-check 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3663acc66b36254c1017c9145596504e78c39b5f
+  data.tar.gz: 2c3b8da8980a632060b6b7c73627d5593a80aeda
+SHA512:
+  metadata.gz: f22bc8bc8e4007aa5d4dd409803e4de9d5c829c32396e3d5eba9aebc699a09e14f0706bda227e33063a5fe366761f2ee50b9191a9ac90fddcf1fb8a8482eee7e
+  data.tar.gz: dbecaf74eabb6ca5856916b1e48dce652b83c29aba3147eead6958c64f8993fb676531de6186a2b59769b3d8b0ca192afb806650bbf717528ec81833816b0055

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Coolblue b.v. NL
+
+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,13 @@
+# Puppet-lint plugin for checking class parameters
+A puppet-lint plugin that checks class parameters. Class parameters should be split in two groups, the first group with no default values, the second group with default values. Both groups should be sorted alphabetically.
+
+[ ![Codeship Status for ryreitsma/puppet-lint-class_parameter-check](https://codeship.com/projects/61472600-279e-0131-879c-36bc4bd39c71/status?branch=master)](https://codeship.com/projects/9002)
+
+## Installation
+To use this plugin, add the following like to the Gemfile in your Puppet code base and run `bundle install`.
+
+```ruby
+gem 'puppet-lint-class_parameter-check', git: 'git@github.com:ryreitsma/puppet-lint-class_parameter-check.git'
+```
+## Usage
+This plugin provides a new check to `puppet-lint`.

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

@@ -0,0 +1,41 @@
+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_index[:param_tokens].each do |parameter_token|
+        next unless parameter_token.type == :VARIABLE
+
+        if parameter_token.next_code_token.nil? || parameter_token.next_code_token.type != :EQUALS
+          notify :error, {
+            :message => "Required parameters should be specified before optional parameters",
+            :line    => parameter_token.line,
+            :column  => parameter_token.column
+          } if optional_params.any?
+
+          params.push(parameter_token)
+        elsif parameter_token.next_code_token && parameter_token.next_code_token.type == :EQUALS
+          optional_params.push(parameter_token)
+        end
+      end
+
+      check_alphabetical_order(params)
+      check_alphabetical_order(optional_params)
+    end
+  end
+
+  def check_alphabetical_order(params)
+    parameter_names = params.map(&:value)
+
+    if parameter_names != parameter_names.sort
+      notify :error, {
+        :message => "Parameters not in alphabetical order",
+        :line    => params.first.line,
+        :column  => params.first.column
+      }
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe 'class_parameter' do
+  context 'with fix disabled' do
+    context 'class with no parameters' do
+      let(:code) { <<-EOF
+        class puppet_module() { }
+        EOF
+      }
+
+      it 'has no problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'class with only required parameters' do
+      context 'sorted alphabetically' do
+        let(:code) { <<-EOF
+          class puppet_module(
+            String $alphabetical,
+            String $non_alphabetical
+          ) { }
+          EOF
+        }
+
+        it 'has no problems' do
+          expect(problems).to have(0).problems
+        end
+      end
+
+      context 'not sorted alphabetically' do
+        let(:code) { <<-EOF
+          class puppet_module(
+            String $non_alphabetical,
+            String $alphabetical
+          ) { }
+          EOF
+        }
+
+        it 'has a problem' do
+          expect(problems).to have(1).problems
+        end
+      end
+    end
+
+    context 'class with required and optional parameters' do
+      context 'sorted alphabetically per group' do
+        let(:code) { <<-EOF
+          class puppet_module(
+            String $alphabetical,
+            String $non_alphabetical,
+            String $alphabetical_optional = "default",
+            String $non_alphabetical_optional = "default"
+          ) { }
+          EOF
+        }
+
+        it 'has no problems' do
+          expect(problems).to have(0).problems
+        end
+      end
+
+      context 'not sorted alphabetically per group' do
+        let(:code) { <<-EOF
+          class puppet_module(
+            String $non_alphabetical,
+            String $alphabetical,
+            String $non_alphabetical_optional = "default",
+            String $alphabetical_optional = "default"
+          ) { }
+          EOF
+        }
+
+        it 'has two problems' do
+          expect(problems).to have(2).problems
+        end
+      end
+
+      context 'not sorted in groups' do
+        let(:code) { <<-EOF
+          class puppet_module(
+            String $alphabetical_optional = "default",
+            String $alphabetical,
+            String $non_alphabetical_optional = "default"
+          ) { }
+          EOF
+        }
+
+        it 'has a problem' do
+          expect(problems).to have(1).problems
+        end
+      end
+
+      context 'not sorted in groups and not alphabetically' do
+        let(:code) { <<-EOF
+          class puppet_module(
+            String $non_alphabetical,
+            String $non_alphabetical_optional = "default",
+            String $alphabetical,
+            String $alphabetical_optional = "default"
+          ) { }
+          EOF
+        }
+
+        it 'has three problems' do
+          expect(problems).to have(3).problems
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-class_parameter-check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roelof Reitsma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-28 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
+     A puppet-lint plugin that checks class parameters. Class parameters should be split in two groups,
+     the first group with no default values, the second group with default values. Both groups should be
+     sorted alphabetically.
+email: r.reitsma@coolblue.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/puppet-lint/plugins/check_class_parameter.rb
+- spec/puppet-lint/plugins/check_class_parameter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ryreitsma/puppet-lint-class_parameter-check
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Puppet lint check for class parameters
+test_files: []