puppet-lint-class_parameter-check 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cc6a4bf5f8538998456c3a4264a06293cca5534
-  data.tar.gz: 0ae21922016a83a566236f4f72812d0a435c9d4a
+  metadata.gz: 4a1424d519f31f7e5324cd29be719b7631113624
+  data.tar.gz: 4856bd7161747732ce8d7287927c44ec758f6bf3
 SHA512:
-  metadata.gz: 3eadbe8e218b908e4beea58261300069ea7ff61685b108edd6b4630658135d05513b2f8d9a34c9f2f10ebb86752fc20b61e0213b9b58d505d8b02b2dfaad1bad
-  data.tar.gz: 3fd10e790eea0cb463752948a9f0ff889e2e92529d1c71def67b0558576bb30003cadb8c4519c72fae16cb98d4de7f34a7d5feff08a232cd0bd2ca85a7e7caaa
+  metadata.gz: 7849f33bca1d49b2a1ad21531cb86d4bab80438109376c97c3eaa890963e3904bdbdcd6f05c3a6b93e9f75435ef795c179acecd5197babf29ad8cb8447b14426
+  data.tar.gz: 4dd399a06ff5a3165536b5126745a9a509919db405273ce64cbef575e6eeca5b88e2a4287982783ca449268c224aef86041dcefbb0fef72ffa715d51d0867ea1

data/README.md

@@ -3,6 +3,8 @@ A puppet-lint plugin that checks class parameters. Class parameters should be sp
 
 [ ![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)
 
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](http://forthebadge.com)
+
 ## Installation
 To use this plugin, add the following like to the Gemfile in your Puppet code base and run `bundle install`.
 

data/lib/model/parameter.rb

@@ -1,4 +1,5 @@
 class Parameter
+  class SyntaxError < StandardError; end
   attr_accessor :documentation
 
   def initialize
@@ -20,15 +21,16 @@ class Parameter
   end
 
   def add(token)
-    # A parameter never starts with a newline token
-    unless @tokens.empty? && token.type == :NEWLINE
-      @tokens << token
-    end
+    # A parameter never starts with a newline token, so skip that one
+    return if @tokens.empty? && token.type == :NEWLINE
+    # Raise a syntax error if the parameter starts with a comma.
+    raise SyntaxError, "Syntax error: Expected a parameter definition, found comma on line #{token.line}, column #{token.column}" if @tokens.empty? && token.type == :COMMA
+
+    @tokens << token
   end
 
   def tokens
-    sanitized_tokens = strip_starting_newlines(@tokens)
-    return strip_ending_newlines(sanitized_tokens)
+    strip_newlines(@tokens)
   end
 
   def line
@@ -50,6 +52,11 @@ class Parameter
   end
 
   private
+  def strip_newlines(tokens)
+    stripped_tokens = strip_starting_newlines(tokens)
+    strip_ending_newlines(stripped_tokens)
+  end
+
   def strip_starting_newlines(tokens)
     tokens.inject([]) do |memo, token|
       unless memo.empty? && token.type == :NEWLINE

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

@@ -13,9 +13,13 @@ PuppetLint.new_check(:class_parameter) do
         puppet_class.parameter_list.errors.each { |error| notify :error, error }
       end
     end
+  rescue Parameter::SyntaxError => error
+    notify :error, { message: error, line: nil, column: nil }
   end
 
   def fix(problem)
+    # Puppet linter wants to fix each problem. This method fixes all problems
+    # at once. Checking the @fixed makes sure code is executed only once.
     return if @fixed
 
     resorted_tokens = []

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

@@ -167,6 +167,20 @@ describe 'class_parameter' do
           expect(problems).to have(3).problems
         end
       end
+
+      context 'with a double comma syntax error' do
+        let(:code) { <<-EOF
+          class puppet_module(
+            String $alphabetical,
+            String $alphabetical_optional = "default",,
+          ) { }
+          EOF
+        }
+
+        it 'has a problem' do
+          expect(problems).to have(1).problems
+        end
+      end
     end
   end
 

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_parameter-check
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Roelof Reitsma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2017-10-03 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'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.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: simplecov
+  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: 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
@@ -89,8 +103,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - LICENSE
+- README.md
 - lib/model/documentation_list.rb
 - lib/model/parameter.rb
 - lib/model/parameter_documentation.rb
@@ -109,17 +123,17 @@ 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
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Puppet lint check for class parameters