puppet-lint-trailing_newline-check 1.0.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Sharpe
+
+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,28 @@
+# puppet-lint plugin tutorial example code
+
+**Note, this is code is part of the puppet-lint plugin development tutorial.
+It should not be used as a real check and is provided as an example only.**
+
+## 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-tutorial-check'
+```
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+### trailing_newlines
+
+**--fix support: Yes**
+
+This check will raise a warning for any files that don't end in a trailing
+newline.
+
+```
+WARNING: expected newline at the end of the file on line 56
+```

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

@@ -0,0 +1,17 @@
+PuppetLint.new_check(:trailing_newline) do
+  def check
+    last_token = tokens.last
+
+    unless last_token.type == :NEWLINE
+      notify :warning, {
+        :message => 'expected newline at the end of the file',
+        :line    => last_token.line,
+        :column  => manifest_lines.last.length,
+      }
+    end
+  end
+
+  def fix(problem)
+    tokens << PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0, 0)
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe 'trailing_newline' do
+  let(:msg) { 'expected newline at the end of the file' }
+
+  context 'with fix disabled' do
+    context 'code not ending with a newline' do
+      let(:code) { "'test'" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(1).in_column(6)
+      end
+    end
+
+    context 'code ending with a newline' do
+      let(:code) { "'test'\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'code not ending in a newline' do
+      let(:code) { "'test'" }
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the problem' do
+        expect(problems).to contain_fixed(msg).on_line(1).in_column(6)
+      end
+
+      it 'should add a newline to the end of the manifest' do
+        expect(manifest).to eq("'test'\n")
+      end
+    end
+
+    context 'code ending in a newline' do
+      let(:code) { "'test'\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      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,145 @@
+--- !ruby/object:Gem::Specification 
+name: puppet-lint-trailing_newline-check
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Sharpe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-08-18 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: puppet-lint
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-its
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-collection_matchers
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: "    Extends puppet-lint to ensure that your manifest files end with newlines.\n"
+email: tim@sharpe.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- LICENSE
+- lib/puppet-lint/plugins/check_trailing_newline.rb
+- spec/puppet-lint/plugins/check_trailing_newline_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/rodjek/puppet-lint-trailing_newline-check
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: puppet-lint trailing_newline check
+test_files: 
+- spec/puppet-lint/plugins/check_trailing_newline_spec.rb
+- spec/spec_helper.rb