puppet-lint 2.2.1 → 2.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Checks your Puppet manifests against the Puppetlabs
@@ -42,15 +42,43 @@ files:
 - lib/puppet-lint/monkeypatches/string_prepend.rb
 - lib/puppet-lint/optparser.rb
 - lib/puppet-lint/plugins.rb
-- lib/puppet-lint/plugins/check_classes.rb
-- lib/puppet-lint/plugins/check_comments.rb
-- lib/puppet-lint/plugins/check_conditionals.rb
-- lib/puppet-lint/plugins/check_documentation.rb
-- lib/puppet-lint/plugins/check_nodes.rb
-- lib/puppet-lint/plugins/check_resources.rb
-- lib/puppet-lint/plugins/check_strings.rb
-- lib/puppet-lint/plugins/check_variables.rb
-- lib/puppet-lint/plugins/check_whitespace.rb
+- lib/puppet-lint/plugins/check_classes/arrow_on_right_operand_line.rb
+- lib/puppet-lint/plugins/check_classes/autoloader_layout.rb
+- lib/puppet-lint/plugins/check_classes/class_inherits_from_params_class.rb
+- lib/puppet-lint/plugins/check_classes/code_on_top_scope.rb
+- lib/puppet-lint/plugins/check_classes/inherits_across_namespaces.rb
+- lib/puppet-lint/plugins/check_classes/names_containing_dash.rb
+- lib/puppet-lint/plugins/check_classes/names_containing_uppercase.rb
+- lib/puppet-lint/plugins/check_classes/nested_classes_or_defines.rb
+- lib/puppet-lint/plugins/check_classes/parameter_order.rb
+- lib/puppet-lint/plugins/check_classes/right_to_left_relationship.rb
+- lib/puppet-lint/plugins/check_classes/variable_scope.rb
+- lib/puppet-lint/plugins/check_comments/slash_comments.rb
+- lib/puppet-lint/plugins/check_comments/star_comments.rb
+- lib/puppet-lint/plugins/check_conditionals/case_without_default.rb
+- lib/puppet-lint/plugins/check_conditionals/selector_inside_resource.rb
+- lib/puppet-lint/plugins/check_documentation/documentation.rb
+- lib/puppet-lint/plugins/check_nodes/unquoted_node_name.rb
+- lib/puppet-lint/plugins/check_resources/duplicate_params.rb
+- lib/puppet-lint/plugins/check_resources/ensure_first_param.rb
+- lib/puppet-lint/plugins/check_resources/ensure_not_symlink_target.rb
+- lib/puppet-lint/plugins/check_resources/file_mode.rb
+- lib/puppet-lint/plugins/check_resources/unquoted_file_mode.rb
+- lib/puppet-lint/plugins/check_resources/unquoted_resource_title.rb
+- lib/puppet-lint/plugins/check_strings/double_quoted_strings.rb
+- lib/puppet-lint/plugins/check_strings/only_variable_string.rb
+- lib/puppet-lint/plugins/check_strings/puppet_url_without_modules.rb
+- lib/puppet-lint/plugins/check_strings/quoted_booleans.rb
+- lib/puppet-lint/plugins/check_strings/single_quote_string_with_variables.rb
+- lib/puppet-lint/plugins/check_strings/variables_not_enclosed.rb
+- lib/puppet-lint/plugins/check_variables/variable_contains_dash.rb
+- lib/puppet-lint/plugins/check_variables/variable_is_lowercase.rb
+- lib/puppet-lint/plugins/check_whitespace/140chars.rb
+- lib/puppet-lint/plugins/check_whitespace/2sp_soft_tabs.rb
+- lib/puppet-lint/plugins/check_whitespace/80chars.rb
+- lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb
+- lib/puppet-lint/plugins/check_whitespace/hard_tabs.rb
+- lib/puppet-lint/plugins/check_whitespace/trailing_whitespace.rb
 - lib/puppet-lint/tasks/puppet-lint.rb
 - lib/puppet-lint/version.rb
 - puppet-lint.gemspec
@@ -128,63 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ensure your Puppet manifests conform with the Puppetlabs style guide
-test_files:
-- spec/fixtures/test/manifests/fail.pp
-- spec/fixtures/test/manifests/ignore.pp
-- spec/fixtures/test/manifests/ignore_multiple_block.pp
-- spec/fixtures/test/manifests/ignore_multiple_line.pp
-- spec/fixtures/test/manifests/ignore_reason.pp
-- spec/fixtures/test/manifests/init.pp
-- spec/fixtures/test/manifests/malformed.pp
-- spec/fixtures/test/manifests/mismatched_control_comment.pp
-- spec/fixtures/test/manifests/unterminated_control_comment.pp
-- spec/fixtures/test/manifests/url_interpolation.pp
-- spec/fixtures/test/manifests/warning.pp
-- spec/puppet-lint/bin_spec.rb
-- spec/puppet-lint/configuration_spec.rb
-- spec/puppet-lint/ignore_overrides_spec.rb
-- spec/puppet-lint/lexer/token_spec.rb
-- spec/puppet-lint/lexer_spec.rb
-- spec/puppet-lint/plugins/check_classes/arrow_on_right_operand_line_spec.rb
-- spec/puppet-lint/plugins/check_classes/autoloader_layout_spec.rb
-- spec/puppet-lint/plugins/check_classes/class_inherits_from_params_class_spec.rb
-- spec/puppet-lint/plugins/check_classes/code_on_top_scope_spec.rb
-- spec/puppet-lint/plugins/check_classes/inherits_across_namespaces_spec.rb
-- spec/puppet-lint/plugins/check_classes/name_contains_uppercase_spec.rb
-- spec/puppet-lint/plugins/check_classes/names_containing_dash_spec.rb
-- spec/puppet-lint/plugins/check_classes/nested_classes_or_defines_spec.rb
-- spec/puppet-lint/plugins/check_classes/parameter_order_spec.rb
-- spec/puppet-lint/plugins/check_classes/right_to_left_relationship_spec.rb
-- spec/puppet-lint/plugins/check_classes/variable_scope_spec.rb
-- spec/puppet-lint/plugins/check_comments/slash_comments_spec.rb
-- spec/puppet-lint/plugins/check_comments/star_comments_spec.rb
-- spec/puppet-lint/plugins/check_conditionals/case_without_default_spec.rb
-- spec/puppet-lint/plugins/check_conditionals/selector_inside_resource_spec.rb
-- spec/puppet-lint/plugins/check_documentation/documentation_spec.rb
-- spec/puppet-lint/plugins/check_nodes/unquoted_node_name_spec.rb
-- spec/puppet-lint/plugins/check_resources/duplicate_params_spec.rb
-- spec/puppet-lint/plugins/check_resources/ensure_first_param_spec.rb
-- spec/puppet-lint/plugins/check_resources/ensure_not_symlink_target_spec.rb
-- spec/puppet-lint/plugins/check_resources/file_mode_spec.rb
-- spec/puppet-lint/plugins/check_resources/unquoted_file_mode_spec.rb
-- spec/puppet-lint/plugins/check_resources/unquoted_resource_title_spec.rb
-- spec/puppet-lint/plugins/check_strings/double_quoted_strings_spec.rb
-- spec/puppet-lint/plugins/check_strings/only_variable_string_spec.rb
-- spec/puppet-lint/plugins/check_strings/puppet_url_without_modules_spec.rb
-- spec/puppet-lint/plugins/check_strings/quoted_booleans_spec.rb
-- spec/puppet-lint/plugins/check_strings/single_quote_string_with_variables_spec.rb
-- spec/puppet-lint/plugins/check_strings/variables_not_enclosed_spec.rb
-- spec/puppet-lint/plugins/check_variables/variable_contains_dash_spec.rb
-- spec/puppet-lint/plugins/check_variables/variable_is_lowercase_spec.rb
-- spec/puppet-lint/plugins/check_whitespace/140chars_spec.rb
-- spec/puppet-lint/plugins/check_whitespace/2sp_soft_tabs_spec.rb
-- spec/puppet-lint/plugins/check_whitespace/80chars_spec.rb
-- spec/puppet-lint/plugins/check_whitespace/arrow_alignment_spec.rb
-- spec/puppet-lint/plugins/check_whitespace/hard_tabs_spec.rb
-- spec/puppet-lint/plugins/check_whitespace/trailing_whitespace_spec.rb
-- spec/puppet-lint_spec.rb
-- spec/spec_helper.rb
+test_files: []

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

@@ -1,433 +0,0 @@
-# Public: Test the manifest tokens for any right-to-left (<-) chaining
-# operators and record a warning for each instance found.
-#
-# https://docs.puppet.com/guides/style_guide.html#chaining-arrow-syntax
-PuppetLint.new_check(:right_to_left_relationship) do
-  def check
-    tokens.select { |r| r.type == :OUT_EDGE }.each do |token|
-      notify :warning, {
-        :message =>  'right-to-left (<-) relationship',
-        :line    => token.line,
-        :column  => token.column,
-      }
-    end
-  end
-end
-
-# Public: Test the manifest tokens for chaining arrow that is
-# on the line of the left operand when the right operand is on another line.
-#
-# https://docs.puppet.com/guides/style_guide.html#chaining-arrow-syntax
-PuppetLint.new_check(:arrow_on_right_operand_line) do
-  def check
-    tokens.select { |r| Set[:IN_EDGE, :IN_EDGE_SUB].include?(r.type) }.each do |token|
-      if token.next_code_token.line != token.line
-        notify :warning, {
-          :message =>  'arrow should be on the right operand\'s line',
-          :line    => token.line,
-          :column  => token.column,
-          :token   => token,
-        }
-      end
-    end
-  end
-
-  def fix(problem)
-    token = problem[:token]
-    tokens.delete(token)
-
-    # remove any excessive whitespace on the line
-    temp_token = token.prev_code_token
-    while (temp_token = temp_token.next_token)
-      tokens.delete(temp_token) if whitespace?(temp_token)
-      break if temp_token.type == :NEWLINE
-    end
-
-    temp_token.next_token = token
-    token.prev_token = temp_token
-    index = tokens.index(token.next_code_token)
-    tokens.insert(index, token)
-
-    whitespace_token = PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', temp_token.line + 1, 3)
-    whitespace_token.prev_token = token
-    token.next_token = whitespace_token
-    whitespace_token.next_token = tokens[index + 1]
-    tokens[index + 1].prev_token = whitespace_token
-    tokens.insert(index + 1, whitespace_token)
-  end
-
-  def whitespace?(token)
-    Set[:INDENT, :WHITESPACE].include?(token.type)
-  end
-end
-
-# Public: Test the manifest tokens for any classes or defined types that are
-# not in an appropriately named file for the autoloader to detect and record
-# an error of each instance found.
-#
-# https://docs.puppet.com/guides/style_guide.html#separate-files
-PuppetLint.new_check(:autoloader_layout) do
-  def check
-    unless fullpath.nil? || fullpath == ''
-      (class_indexes + defined_type_indexes).each do |class_idx|
-        title_token = class_idx[:name_token]
-        split_title = title_token.value.split('::')
-        mod = split_title.first
-        if split_title.length > 1
-          expected_path = "/#{mod}/manifests/#{split_title[1..-1].join('/')}.pp"
-        else
-          expected_path = "/#{title_token.value}/manifests/init.pp"
-        end
-
-        if PuppetLint.configuration.relative
-          expected_path = expected_path.gsub(/^\//,'').split('/')[1..-1].join('/')
-        end
-
-        unless fullpath.end_with? expected_path
-          notify :error, {
-            :message => "#{title_token.value} not in autoload module layout",
-            :line    => title_token.line,
-            :column  => title_token.column,
-          }
-        end
-      end
-    end
-  end
-end
-
-# Public: Check the manifest tokens for any classes or defined types that
-# have a dash in their name and record an error for each instance found.
-#
-# No style guide reference
-PuppetLint.new_check(:names_containing_dash) do
-  def check
-    (class_indexes + defined_type_indexes).each do |class_idx|
-      if class_idx[:name_token].value.include? '-'
-        if class_idx[:type] == :CLASS
-          obj_type = 'class'
-        else
-          obj_type = 'defined type'
-        end
-
-        notify :error, {
-          :message => "#{obj_type} name containing a dash",
-          :line    => class_idx[:name_token].line,
-          :column  => class_idx[:name_token].column,
-        }
-      end
-    end
-  end
-end
-
-# Public: Check the manifest tokens for any classes that inherit a params
-# subclass and record a warning for each instance found.
-#
-# No style guide reference
-PuppetLint.new_check(:class_inherits_from_params_class) do
-  def check
-    class_indexes.each do |class_idx|
-      unless class_idx[:inherited_token].nil?
-        if class_idx[:inherited_token].value.end_with? '::params'
-          notify :warning, {
-            :message => 'class inheriting from params class',
-            :line    => class_idx[:inherited_token].line,
-            :column  => class_idx[:inherited_token].column,
-          }
-        end
-      end
-    end
-  end
-end
-PuppetLint.configuration.send('disable_class_inherits_from_params_class')
-
-# Public: Test the manifest tokens for any parameterised classes or defined
-# types that take parameters and record a warning if there are any optional
-# parameters listed before required parameters.
-#
-# https://docs.puppet.com/guides/style_guide.html#display-order-of-parameters
-PuppetLint.new_check(:parameter_order) do
-  def check
-    (class_indexes + defined_type_indexes).each do |class_idx|
-      unless class_idx[:param_tokens].nil?
-        paren_stack = []
-        hash_or_array_stack = []
-        class_idx[:param_tokens].each_with_index do |token, i|
-          if token.type == :LPAREN
-            paren_stack.push(true)
-          elsif token.type == :RPAREN
-            paren_stack.pop
-          elsif token.type == :LBRACE || token.type == :LBRACK
-            hash_or_array_stack.push(true)
-          elsif token.type == :RBRACE || token.type == :RBRACK
-            hash_or_array_stack.pop
-          end
-          next if (! hash_or_array_stack.empty?)
-          next unless paren_stack.empty?
-
-          if token.type == :VARIABLE
-            if token.next_code_token.nil? || [:COMMA, :RPAREN].include?(token.next_code_token.type)
-              prev_tokens = class_idx[:param_tokens][0..i]
-              unless prev_tokens.rindex { |r| r.type == :EQUALS }.nil?
-                unless token.prev_code_token.nil? or token.prev_code_token.type == :EQUALS
-                  msg = 'optional parameter listed before required parameter'
-                  notify :warning, {
-                    :message => msg,
-                    :line    => token.line,
-                    :column  => token.column,
-                  }
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-# Public: Test the manifest tokens for any classes that inherit across
-# namespaces and record a warning for each instance found.
-#
-# https://docs.puppet.com/guides/style_guide.html#class-inheritance
-PuppetLint.new_check(:inherits_across_namespaces) do
-  def check
-    class_indexes.each do |class_idx|
-      unless class_idx[:inherited_token].nil?
-        inherited_module_name = class_idx[:inherited_token].value.split('::').reject { |r| r.empty? }.first
-        class_module_name = class_idx[:name_token].value.split('::').reject { |r| r.empty? }.first
-
-        unless class_module_name == inherited_module_name
-          notify :warning, {
-            :message => "class inherits across module namespaces",
-            :line    => class_idx[:inherited_token].line,
-            :column  => class_idx[:inherited_token].column,
-          }
-        end
-      end
-    end
-  end
-end
-
-# Public: Test the manifest tokens for any classes or defined types that are
-# defined inside another class.
-#
-# https://docs.puppet.com/guides/style_guide.html#nested-classes-or-defined-types
-PuppetLint.new_check(:nested_classes_or_defines) do
-  TOKENS = Set[:CLASS, :DEFINE]
-
-  def check
-    class_indexes.each do |class_idx|
-      # Skip the first token so that we don't pick up the first :CLASS
-      class_tokens = class_idx[:tokens][1..-1]
-
-      class_tokens.each do |token|
-        if TOKENS.include?(token.type)
-          if token.next_code_token.type != :LBRACE
-            type = token.type == :CLASS ? 'class' : 'defined type'
-
-            notify :warning, {
-              :message => "#{type} defined inside a class",
-              :line    => token.line,
-              :column  => token.column,
-            }
-          end
-        end
-      end
-    end
-  end
-end
-
-# Public: Find and warn about module names with illegal uppercase characters.
-#
-# https://docs.puppet.com/puppet/latest/reference/modules_fundamentals.html#allowed-module-names
-# Provides a fix. [puppet-lint #554]
-PuppetLint.new_check(:names_containing_uppercase) do
-  def check
-    (class_indexes + defined_type_indexes).each do |class_idx|
-      if class_idx[:name_token].value =~ /[A-Z]/
-        if class_idx[:type] == :CLASS
-          obj_type = 'class'
-        else
-          obj_type = 'defined type'
-        end
-
-        notify :error, {
-          :message => "#{obj_type} '#{class_idx[:name_token].value}' contains illegal uppercase",
-          :line    => class_idx[:name_token].line,
-          :column  => class_idx[:name_token].column,
-          :token   => class_idx[:name_token],
-        }
-      end
-    end
-  end
-
-  def fix(problem)
-    problem[:token].value.downcase!
-  end
-end
-
-# Public: Test that no code is outside of a class or define scope.
-#
-# No style guide reference
-PuppetLint.new_check(:code_on_top_scope) do
-  def check
-    class_scope = (class_indexes + defined_type_indexes).map { |e| tokens[e[:start]..e[:end]] }.flatten
-    top_scope   = tokens - class_scope
-
-    top_scope.each do |token|
-      unless formatting_tokens.include? token.type
-        notify :warning, {
-          :message => "code outside of class or define block - #{token.value}",
-          :line    => token.line,
-          :column  => token.column
-        }
-      end
-    end
-  end
-end
-PuppetLint.configuration.send("disable_code_on_top_scope")
-
-# Public: Test the manifest tokens for any variables that are referenced in
-# the manifest.  If the variables are not fully qualified or one of the
-# variables automatically created in the scope, check that they have been
-# defined in the local scope and record a warning for each variable that has
-# not.
-#
-# https://docs.puppet.com/guides/style_guide.html#namespacing-variables
-PuppetLint.new_check(:variable_scope) do
-  DEFAULT_SCOPE_VARS = Set[
-    'name',
-    'title',
-    'module_name',
-    'environment',
-    'clientcert',
-    'clientversion',
-    'servername',
-    'serverip',
-    'serverversion',
-    'caller_module_name',
-    'alias',
-    'audit',
-    'before',
-    'loglevel',
-    'noop',
-    'notify',
-    'require',
-    'schedule',
-    'stage',
-    'subscribe',
-    'tag',
-    'facts',
-    'trusted',
-    'server_facts',
-  ]
-  POST_VAR_TOKENS = Set[:COMMA, :EQUALS, :RPAREN]
-
-  def check
-    variables_in_scope = DEFAULT_SCOPE_VARS.clone
-
-    (class_indexes + defined_type_indexes).each do |idx|
-      referenced_variables = Set[]
-      object_tokens = idx[:tokens]
-
-      unless idx[:param_tokens].nil?
-        idx[:param_tokens].each do |token|
-          if token.type == :VARIABLE
-            if POST_VAR_TOKENS.include? token.next_code_token.type
-              variables_in_scope << token.value
-            end
-          end
-        end
-      end
-
-      future_parser_scopes = {}
-      in_pipe = false
-      block_params_stack = []
-
-      object_tokens.each do |token|
-        case token.type
-        when :EQUALS
-          if token.prev_code_token.type == :VARIABLE
-            variables_in_scope << token.prev_code_token.value
-          elsif token.prev_code_token.type == :RBRACK
-            temp_token = token
-
-            brack_depth = 0
-            while temp_token = temp_token.prev_code_token
-              case temp_token.type
-              when :VARIABLE
-                variables_in_scope << temp_token.value
-              when :RBRACK
-                brack_depth += 1
-              when :LBRACK
-                brack_depth -= 1
-                break if brack_depth == 0
-              when :COMMA
-                # ignore
-              else  # unexpected
-                break
-              end
-            end
-          end
-        when :VARIABLE
-          if in_pipe
-            block_params_stack[-1] << token.value
-          else
-            referenced_variables << token
-          end
-        when :PIPE
-          in_pipe = !in_pipe
-
-          if in_pipe
-            block_params_stack << []
-          else
-            start_idx = tokens.find_index(token)
-            end_token = nil
-            brace_depth = 0
-
-            tokens[start_idx..-1].each do |sub_token|
-              case sub_token.type
-              when :LBRACE
-                brace_depth += 1
-              when :RBRACE
-                brace_depth -= 1
-                if brace_depth == 0
-                  end_token = sub_token
-                  break
-                end
-              end
-            end
-
-            params = block_params_stack.pop
-            (token.line..end_token.line).each do |line|
-              future_parser_scopes[line] ||= []
-              future_parser_scopes[line].concat(params)
-            end
-          end
-        end
-      end
-
-      msg = "top-scope variable being used without an explicit namespace"
-      referenced_variables.each do |token|
-        unless future_parser_scopes[token.line].nil?
-          next if future_parser_scopes[token.line].include?(token.value.gsub(/\[.+\]\Z/, ''))
-        end
-
-        unless token.value.include? '::'
-          unless token.value =~ /^(facts|trusted)\[.+\]/
-            unless variables_in_scope.include? token.value.gsub(/\[.+\]\Z/, '')
-              unless token.value =~ /\A\d+\Z/
-                notify :warning, {
-                  :message => msg,
-                  :line    => token.line,
-                  :column  => token.column,
-                }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
-