Merge pull request #738 from rodjek/rubocop

Rubocop compliance

Author: rnelson0

.rubocop.yml

@@ -0,0 +1,74 @@
+---
+inherit_from: './.rubocop_todo.yml'
+AllCops:
+    TargetRubyVersion: 1.9
+
+Style/HashSyntax:
+    EnforcedStyle: hash_rockets
+
+Layout/FirstArrayElementLineBreak:
+    Enabled: true
+Layout/FirstHashElementLineBreak:
+    Enabled: true
+Layout/FirstMethodArgumentLineBreak:
+    Enabled: true
+Layout/FirstMethodParameterLineBreak:
+    Enabled: true
+Layout/IndentArray:
+    EnforcedStyle: consistent
+Layout/MultilineArrayBraceLayout:
+    EnforcedStyle: new_line
+Layout/MultilineAssignmentLayout:
+    Enabled: true
+    EnforcedStyle: same_line
+Layout/MultilineHashBraceLayout:
+    EnforcedStyle: new_line
+Layout/MultilineMethodDefinitionBraceLayout:
+    EnforcedStyle: new_line
+
+Style/AutoResourceCleanup:
+    Enabled: true
+Style/BlockDelimiters:
+    EnforcedStyle: braces_for_chaining
+Style/BracesAroundHashParameters:
+    EnforcedStyle: context_dependent
+Style/Encoding:
+    Enabled: false
+Style/MethodCallWithArgsParentheses:
+    Enabled: true
+    IgnoreMacros: true
+    IgnoredMethods:
+        - puts
+        - require
+        - include
+        - it
+        - context
+        - describe
+        - to
+        - to_not
+        - raise
+        - desc
+        - task
+        - exit
+        - should
+        - gem
+        - group
+        - attr_reader
+        - attr_accessor
+        - attr_writer
+        - source
+Style/MethodCalledOnDoEndBlock:
+    Enabled: true
+Style/RegexpLiteral:
+    EnforcedStyle: percent_r
+Style/TrailingCommaInArguments:
+    EnforcedStyleForMultiline: comma
+Style/TrailingCommaInLiteral:
+    EnforcedStyleForMultiline: comma
+Style/FormatStringToken:
+    Enabled: false
+Style/FileName:
+    Exclude:
+        - 'lib/puppet-lint.rb'
+        - 'lib/puppet-lint/tasks/puppet-lint.rb'
+        - 'spec/puppet-lint_spec.rb'

.rubocop_todo.yml

@@ -0,0 +1,89 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-08-28 12:57:58 +1000 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: Include.
+# Include: **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
+# Include: **/Gemfile, **/gems.rb
+Bundler/OrderedGems:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 9
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/puppet-lint/lexer.rb'
+    - 'lib/puppet-lint/plugins/check_classes/variable_scope.rb'
+
+# Offense count: 52
+Metrics/AbcSize:
+  Max: 153
+
+# Offense count: 121
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 1136
+
+# Offense count: 8
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 5
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 383
+
+# Offense count: 20
+Metrics/CyclomaticComplexity:
+  Max: 26
+
+# Offense count: 238
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 223
+
+# Offense count: 65
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 94
+
+# Offense count: 18
+Metrics/PerceivedComplexity:
+  Max: 25
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/RedundantBlockCall:
+  Exclude:
+    - 'lib/puppet-lint/tasks/puppet-lint.rb'
+
+# Offense count: 7
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/puppet-lint.rb'
+    - 'lib/puppet-lint/bin.rb'
+    - 'lib/puppet-lint/checkplugin.rb'
+    - 'lib/puppet-lint/checks.rb'
+    - 'lib/puppet-lint/data.rb'
+    - 'lib/puppet-lint/optparser.rb'
+
+# Offense count: 20
+Style/MultilineBlockChain:
+  Enabled: false

.travis.yml

@@ -6,10 +6,18 @@ branches:
   only:
     - master
 bundler_args: --without development system_tests
+script:
+    - bundle exec rake $CHECK
+env:
+    - CHECK=test
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.10
   - 2.2.7
   - 2.3.4
   - 2.4.1
+matrix:
+    include:
+        - rvm: 2.4.1
+          env: CHECK=rubocop

Gemfile

@@ -25,6 +25,8 @@ group :test do
     # requires ruby 1.9+, on 1.8 we'll fall back to the old regex parsing
     gem 'rspec-json_expectations', '~> 1.4'
   end
+
+  gem 'rubocop', '0.49.1' if RUBY_VERSION > '2.0'
 end
 
 group :development do

Rakefile

@@ -8,12 +8,23 @@ RSpec::Core::RakeTask.new(:test)
 
 begin
   require 'github_changelog_generator/task'
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  GitHubChangelogGenerator::RakeTask.new(:changelog) do |config|
     version = PuppetLint::VERSION
-    config.future_release = "#{version}"
-    config.exclude_labels = %w{duplicate question invalid wontfix release-pr}
+    config.future_release = version.to_s
+    config.exclude_labels = %w[duplicate question invalid wontfix release-pr]
   end
 rescue LoadError
+  $stderr.puts 'Changelog generation requires Ruby 2.0 or higher'
+end
+
+begin
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.options = %w[-D -E]
+  end
+rescue LoadError
+  $stderr.puts 'Rubocop is not available for this version of Ruby.'
 end
 
 # vim: syntax=ruby

bin/puppet-lint

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'puppet-lint'
 

lib/puppet-lint.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require 'set'
 require 'json'
 require 'puppet-lint/version'
@@ -48,7 +49,7 @@ class PuppetLint
   # Public: Initialise a new PuppetLint object.
   def initialize
     @code = nil
-    @statistics = {:error => 0, :warning => 0, :fixed => 0, :ignored => 0}
+    @statistics = { :error => 0, :warning => 0, :fixed => 0, :ignored => 0 }
     @manifest = ''
   end
 
@@ -71,14 +72,16 @@ def configuration
   #
   # Returns nothing.
   def file=(path)
-    if File.exist? path
-      @path = path
-      @code = File.open(path, 'r:UTF-8').read
+    return unless File.exist?(path)
 
-      # Check if the input is an SE Linux policy package file (which also use
-      # the .pp extension), which all have the first 4 bytes 0xf97cff8f.
-      @code = '' if @code[0..3].unpack('V').first == 0xf97cff8f
+    @path = path
+    File.open(path, 'r:UTF-8') do |f|
+      @code = f.read
     end
+
+    # Check if the input is an SE Linux policy package file (which also use
+    # the .pp extension), which all have the first 4 bytes 0xf97cff8f.
+    @code = '' if @code[0..3].unpack('V').first == 0xf97cff8f
   end
 
   # Internal: Retrieve the format string to be used when writing problems to
@@ -90,12 +93,11 @@ def log_format
     if configuration.log_format == ''
       ## recreate previous old log format as far as thats possible.
       format = '%{KIND}: %{message} on line %{line}'
-      if configuration.with_filename
-        format.prepend '%{path} - '
-      end
+      format.prepend('%{path} - ') if configuration.with_filename
       configuration.log_format = format
     end
-    return configuration.log_format
+
+    configuration.log_format
   end
 
   # Internal: Format a problem message and print it to STDOUT.
@@ -106,9 +108,8 @@ def log_format
   def format_message(message)
     format = log_format
     puts format % message
-    if message[:kind] == :ignored && !message[:reason].nil?
-      puts "  #{message[:reason]}"
-    end
+
+    puts "  #{message[:reason]}" if message[:kind] == :ignored && !message[:reason].nil?
   end
 
   # Internal: Get the line of the manifest on which the problem was found
@@ -117,8 +118,7 @@ def format_message(message)
   #
   # Returns the problematic line as a string.
   def get_context(message)
-    line = PuppetLint::Data.manifest_lines[message[:line] - 1]
-    return line.strip
+    PuppetLint::Data.manifest_lines[message[:line] - 1].strip
   end
 
   # Internal: Print out the line of the manifest on which the problem was found
@@ -131,9 +131,9 @@ def print_context(message)
     return if message[:check] == 'documentation'
     return if message[:kind] == :fixed
     line = get_context(message)
-    offset = line.index(/\S/) || 1
+    offset = line.index(%r{\S}) || 1
     puts "\n  #{line.strip}"
-    printf "%#{message[:column] + 2 - offset}s\n\n", '^'
+    printf("%#{message[:column] + 2 - offset}s\n\n", '^')
   end
 
   # Internal: Print the reported problems with a manifest to stdout.
@@ -154,16 +154,14 @@ def report(problems)
           message['context'] = get_context(message) if configuration.with_context
           json << message
         else
-          format_message message
+          format_message(message)
           print_context(message) if configuration.with_context
         end
       end
     end
     puts JSON.pretty_generate(json) if configuration.json
 
-    if problems.any? { |p| p[:check] == :syntax }
-      $stderr.puts "Try running `puppet parser validate <file>`"
-    end
+    $stderr.puts 'Try running `puppet parser validate <file>`' if problems.any? { |p| p[:check] == :syntax }
   end
 
   # Public: Determine if PuppetLint found any errors in the manifest.
@@ -186,9 +184,7 @@ def warnings?
   # Returns nothing.
   # Raises PuppetLint::NoCodeError if no manifest code has been loaded.
   def run
-    if @code.nil?
-      raise PuppetLint::NoCodeError
-    end
+    raise PuppetLint::NoCodeError if @code.nil?
 
     if @code.empty?
       @problems = []
@@ -207,7 +203,7 @@ def run
   #
   # Returns nothing.
   def print_problems
-    report @problems
+    report(@problems)
   end
 
   # Public: Define a new check.