puppet-lint-no_chaining_arrows-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c8658a8b1133c39c0688ca268245e146fb1f88d
+  data.tar.gz: cea1663c148890be6d75bc85526c2baa085115ea
+SHA512:
+  metadata.gz: 7d5d004d080718bec4475f0cd1f5de699ec6bc8d98d4dbda9481200db0999aa9bd9fea626757be62bc7a7ef1eac0d7fbdb8ce23508e19205a7ffe3aa1c4699dc
+  data.tar.gz: 34b3287d0091db0f8c92783e9ac4d8a36c8fd03b29600f985469ffd1357e1b30df7a66c14e9d9faae532a60a9da624b2ae706bcdbe268224f1929e320ca2faf9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dean Wilson
+
+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,65 @@
+# puppet-lint no chaining arrows check
+
+Extends puppet-lint to issue warnings if any chaining arrows
+(`->`, `~>`, `<-`, `<~`) are found.
+
+[![Build Status](https://travis-ci.org/deanwilson/puppet-lint-no_chaining_arrows-check.svg?branch=master)](https://travis-ci.org/deanwilson/puppet-lint-no_chaining_arrows-check)
+
+Although puppet-lint has the included
+[Right To Left Relationship](http://puppet-lint.com/checks/right_to_left_relationship/)
+check I wanted one that went further and warned on any use of chaining
+arrows. In my puppet code I'd rather have resources connected with
+parameters, such as `require` and `notify`. I also find the indentation nicer
+without the `type` being offset by the arrow.
+
+```puppet
+
+  # I think this -
+  file { '/tmp/foo':
+    content => 'foo',
+    require => Class['bar'],
+    ...
+  }
+
+  # - looks nicer than this
+  -> file { '/tmp/foo':
+    content => 'foo',
+    ...
+  }
+```
+
+This plugin has one side effect, it disables the
+[Right To Left Relationship](http://puppet-lint.com/checks/right_to_left_relationship/)
+check that produces
+
+    WARNING: right-to-left (<-) relationship on line $foo
+
+This is to ensure that some relationships, specified with
+`<-` and `<~`, are not reported twice.
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-no_chaining_arrows-check'
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+    WARNING: chaining arrow found on line 3
+
+## Other puppet-lint plugins
+
+You can find a list of my `puppet-lint` plugins in the
+[unixdaemon puppet-lint-plugins](https://github.com/deanwilson/unixdaemon-puppet-lint-plugins) repo.
+
+### Author
+
+[Dean Wilson](https://www.unixdaemon.net)
+
+### License
+
+ * MIT

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

@@ -0,0 +1,19 @@
+PuppetLint.new_check(:no_chaining_arrows) do
+
+  # stop puppet-lint raising its own arrow check
+  # this way we don't get two warnings on <- and <~
+  PuppetLint.configuration.send('disable_right_to_left_relationship')
+
+  def check
+    arrow_tokens = [:OUT_EDGE, :OUT_EDGE_SUB, :IN_EDGE, :IN_EDGE_SUB]
+
+    tokens.select { |r| arrow_tokens.include? r.type }.each do |token|
+      notify(
+        :warning,
+        :message => 'chaining arrow found',
+        :line    => token.line,
+        :column  => token.column
+      )
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'no_chaining_arrows' do
+  let(:msg) { 'chaining arrow found' }
+
+  %w[-> ~> <- <~].each do |op|
+    context "chaining resources with #{op}" do
+      let(:code) { "Class[foo] #{op} Class[bar]" }
+
+      it 'should only 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(12)
+      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,170 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-no_chaining_arrows-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-10 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.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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'
+description: |2
+      Extends puppet-lint to issue warnings if any chaining arrows
+      ('->', '~>', '<-', '<~') are found.
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/no_chaining_arrows.rb
+- spec/puppet-lint/plugins/puppet-lint-no_chaining_arrows_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint-no_chaining_arrows-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.6.11
+signing_key: 
+specification_version: 4
+summary: puppet-lint no_chaining_arrows check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/puppet-lint-no_chaining_arrows_spec.rb