puppet-lint 4.2.1 → 4.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8fbf6d28ee384ac72918e39f7a578ccbca81041749e612b9d9ead33a72f7e57
-  data.tar.gz: 358cdd9a1c4c1c71986b868897855cd6410a538fdff6f8f625fd60007fe062e2
+  metadata.gz: 0bbb51ba5c4cc604cd5eb02b2d51791f6df279db955fcd9e77747f79b6890cff
+  data.tar.gz: 0e187bb2ab101f20669c387ca3297513ff781edf20d2708e2271ba2778f8df4e
 SHA512:
-  metadata.gz: 0073f5e753d913b7d3fc324646bd04fb46eac444ffe6111422f3b2fddbc7008737d4774ce29bfe7b34e946bbcd3301d0d66836ab04ecc88e4f21198eaa4c192e
-  data.tar.gz: 67f83fcafd14cc225c43f64ddb8326f88a37225700058e83bf2d22fc0a5915bb1096b6e46557c7a88c3e0210bd36ed171136eacef0722e1bb2aa20935efa3b8f
+  metadata.gz: 221dc05dc214701d1ffc688ec01fc2c6aa9c3adddc699c55e62894124c66b08a222f864f285bc1e8a65c4466b90967778e02f4f2f7ab805874057ce02db52b72
+  data.tar.gz: ba771036c9326dbd2e6831c4fc1ec17f7e81f7f4a41967c801ea78e3d74944dc61f51bda246428b62bedfa58891561bff078a7386d64cd61b6f3b78c5bfa6a66

data/lib/puppet-lint/data.rb

@@ -1,24 +1,30 @@
 require 'singleton'
 require 'set'
 
-# Public: A singleton class storing all the information about the manifest
-# being analysed.
+# A singleton class storing all the information about the manifest being
+# analysed.
+#
+# @api public
 class PuppetLint::Data
   include Singleton
 
   class << self
-    # Internal: Get/Set the full expanded path to the manifest file being
-    # checked.
+    # Get/Set the full expanded path to the manifest file being checked.
+    #
+    # @api private
     attr_reader :path, :fullpath, :filename
 
-    # Internal: Get/Set the raw manifest data, split by \n.
+    # Get/Set the raw manifest data, split by \n.
+    #
+    # @api private
     attr_accessor :manifest_lines
 
-    # Internal: Store the tokenised manifest.
+    # Store the tokenised manifest.
     #
-    # tokens - The Array of PuppetLint::Lexer::Token objects to store.
+    # @param [Array[PuppetLint::Lexer::Token]] tokens The Array of PuppetLint::Lexer::Token objects to store.
+    # @return [nil]
     #
-    # Returns nothing.
+    # @api private
     def tokens=(tokens)
       @tokens = tokens
       @title_tokens = nil
@@ -32,14 +38,17 @@ class PuppetLint::Data
       @defaults_indexes = nil
     end
 
+    # @api private
     def ruby1?
       @ruby1 = RbConfig::CONFIG['MAJOR'] == '1' if @ruby1.nil?
       @ruby1
     end
 
-    # Public: Get the tokenised manifest.
+    # Get the tokenised manifest.
+    #
+    # @return [Array[PuppetLint::Lexer::Token]]
     #
-    # Returns an Array of PuppetLint::Lexer::Token objects.
+    # @api public
     def tokens
       calling_method = if ruby1?
                          begin
@@ -62,7 +71,12 @@ class PuppetLint::Data
       end
     end
 
-    # Public: Add new token.
+    # Add new token.
+    #
+    # @param [Integer] index
+    # @param [PuppetLint::Lexer::Token] token
+    #
+    # @api public
     def insert(index, token)
       current_token = tokens[index - 1]
       token.next_token = current_token.next_token
@@ -97,7 +111,11 @@ class PuppetLint::Data
       tokens.insert(index, token)
     end
 
-    # Public: Removes a token
+    # Remove a token
+    #
+    # @param [PuppetLint::Lexer::Token] token
+    #
+    # @api public
     def delete(token)
       token.next_token.prev_token = token.prev_token unless token.next_token.nil?
       token.prev_token.next_token = token.next_token unless token.prev_token.nil?
@@ -109,12 +127,13 @@ class PuppetLint::Data
       tokens.delete(token)
     end
 
-    # Internal: Store the path to the manifest file and populate fullpath and
-    # filename.
+    # Store the path to the manifest file and populate fullpath and filename.
     #
-    # val - The path to the file as a String.
+    # @param [String] val The path to the file
     #
-    # Returns nothing.
+    # @return [nil]
+    #
+    # @api private
     def path=(val)
       @path = val
       if val.nil?
@@ -126,9 +145,11 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Retrieve a list of tokens that represent resource titles
+    # Retrieve a list of tokens that represent resource titles
+    #
+    # @return [Array[PuppetLint::Lexer::Token]]
     #
-    # Returns an Array of PuppetLint::Lexer::Token objects.
+    # @api private
     def title_tokens
       @title_tokens ||= begin
         result = []
@@ -153,10 +174,11 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Determine if the given token contains a CLASSREF in
-    # the token chain..
+    # Determine if the given token contains a CLASSREF in the token chain..
     #
-    # Returns a Boolean.
+    # @param [PuppetLint::Lexer::Token] token
+    #
+    # @api private
     def classref?(token)
       current_token = token
       while (current_token = current_token.prev_code_token)
@@ -165,15 +187,15 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Calculate the positions of all resource declarations within the
+    # Calculate the positions of all resource declarations within the
     # tokenised manifest. These positions only point to the content of the
     # resource declarations, they do not include resource types or titles.
     #
-    # Returns an Array of Hashes, each containing:
-    #   :start - An Integer position in the `tokens` Array pointing to the
-    #            first Token of a resource declaration.
-    #   :end   - An Integer position in the `tokens` Array pointing to the last
-    #            Token of a resource declaration.
+    # @return [Array[Hash[Symbol, Integer]]] each hash contains :start and
+    #   :end pointing to the first and last {PuppetLint::Lexer::Token} of a
+    #   resource declaration
+    #
+    # @api private
     def resource_indexes
       @resource_indexes ||= begin
         marker = 0
@@ -204,12 +226,15 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Find the Token representing the type of a resource definition.
+    # Find the Token representing the type of a resource definition.
+    #
+    # @param [Integer] index
+    #   The Integer pointing to the start of the resource in the `tokens`
+    #   array.
     #
-    # index - The Integer pointing to the start of the resource in the `tokens`
-    #         array.
+    # @return [PuppetLint::Lexer::Token]
     #
-    # Returns a Token object.
+    # @api private
     def find_resource_type_token(index)
       lbrace_idx = tokens[0..index].rindex do |token|
         token.type == :LBRACE && token.prev_code_token.type != :QMARK
@@ -220,13 +245,15 @@ class PuppetLint::Data
       tokens[lbrace_idx].prev_code_token
     end
 
-    # Internal: Find all the Token objects representing the parameter names in
+    # Find all the Token objects representing the parameter names in
     # a resource definition.
     #
-    # resource_tokens - An Array of Token objects that comprise the resource
-    #                   definition.
+    # @param [Array[PuppetLint::Lexer::Token]] resource_tokens
+    #   An Array of Token objects that comprise the resource definition.
     #
-    # Returns an Array of Token objects.
+    # @return [Array[PuppetLint::Lexer::Token]]
+    #
+    # @api private
     def find_resource_param_tokens(resource_tokens)
       param_tokens = []
 
@@ -243,8 +270,8 @@ class PuppetLint::Data
       param_tokens
     end
 
-    # Internal: Calculate the positions of all class definitions within the
-    # `tokens` Array.
+    # Calculate the positions of all class definitions within the `tokens`
+    # Array.
     #
     # Returns an Array of Hashes, each containing:
     #   :start  - An Integer position in the `tokens` Array pointing to the
@@ -253,12 +280,14 @@ class PuppetLint::Data
     #             Token of a class definition.
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             class definition.
+    #
+    # @api private
     def class_indexes
       @class_indexes ||= definition_indexes(:CLASS)
     end
 
-    # Internal: Calculate the positions of all defined type definitions within
-    # the `tokens` Array.
+    # Calculate the positions of all defined type definitions within the
+    # `tokens` Array.
     #
     # Returns an Array of Hashes, each containing:
     #   :start  - An Integer position in the `tokens` Array pointing to the
@@ -267,12 +296,14 @@ class PuppetLint::Data
     #             Token of a defined type definition.
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             defined type.
+    #
+    # @api private
     def defined_type_indexes
       @defined_type_indexes ||= definition_indexes(:DEFINE)
     end
 
-    # Internal: Calculate the positions of all node definitions within the
-    # `tokens` Array.
+    # Calculate the positions of all node definitions within the `tokens`
+    # Array.
     #
     # Returns an Array of Hashes, each containing:
     #   :start  - An Integer position in the `tokens` Array pointing to the
@@ -281,12 +312,14 @@ class PuppetLint::Data
     #             Token of a defined type definition.
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             defined type.
+    #
+    # @api private
     def node_indexes
       @node_indexes ||= definition_indexes(:NODE)
     end
 
-    # Internal: Calculate the positions of all the specified defintion types
-    # within the `tokens` Array.
+    # Calculate the positions of all the specified defintion types within the
+    # `tokens` Array.
     #
     # Returns an Array of Hashes, each containing:
     #   :start  - An Integer position in the `tokens` Array pointing to the
@@ -295,6 +328,8 @@ class PuppetLint::Data
     #             Token of a definition.
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             definition.
+    #
+    # @api private
     def definition_indexes(type)
       result = []
       tokens.each_with_index do |token, i|
@@ -336,8 +371,7 @@ class PuppetLint::Data
       result
     end
 
-    # Internal: Calculate the positions of all function calls within
-    # `tokens` Array.
+    # Calculate the positions of all function calls within `tokens` Array.
     #
     # Returns an Array of Hashes, each containing:
     #   :start  - An Integer position in the `tokens` Array pointing to the
@@ -346,6 +380,8 @@ class PuppetLint::Data
     #             Token of a function call
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             function call.
+    #
+    # @api private
     def function_indexes
       @function_indexes ||= begin
         functions = []
@@ -385,8 +421,7 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Calculate the positions of all array values within
-    # `tokens` Array.
+    # Calculate the positions of all array values within `tokens` Array.
     #
     # Returns an Array of Hashes, each containing:
     #   :start  - An Integer position in the `tokens` Array pointing to the
@@ -395,6 +430,8 @@ class PuppetLint::Data
     #             Token of an array value
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             array value.
+    #
+    # @api private
     def array_indexes
       @array_indexes ||= begin
         arrays = []
@@ -421,8 +458,7 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Calculate the positions of all hash values within
-    # `tokens` Array.
+    # Calculate the positions of all hash values within `tokens` Array.
     #
     # Returns an Array of Hashes, each containing:
     #   :start  - An Integer position in the `tokens` Array pointing to the
@@ -431,6 +467,8 @@ class PuppetLint::Data
     #             Token of an hash value
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             hash value.
+    #
+    # @api private
     def hash_indexes
       @hash_indexes ||= begin
         hashes = []
@@ -459,7 +497,7 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Calculate the positions of all defaults declarations within
+    # Calculate the positions of all defaults declarations within
     # `tokens` Array.
     #
     # Returns an Array of Hashes, each containing:
@@ -469,6 +507,8 @@ class PuppetLint::Data
     #             Token of the defaults declaration
     #   :tokens - An Array consisting of all the Token objects that make up the
     #             defaults declaration.
+    #
+    # @api private
     def defaults_indexes
       @defaults_indexes ||= begin
         defaults = []
@@ -493,14 +533,17 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Finds all the tokens that make up the defined type or class
+    # Finds all the tokens that make up the defined type or class
     # definition parameters.
     #
-    # these_tokens - An Array of PuppetLint::Lexer::Token objects that make up
-    #                the defined type or class definition.
+    # @param [Array[PuppetLint::Lexer::Token]] these_tokens
+    #   An Array of PuppetLint::Lexer::Token objects that make up the defined
+    #   type or class definition.
     #
-    # Returns an Array of PuppetLint::Lexer::Token objects or nil if it takes
-    # no parameters.
+    # @return [Array[PuppetLint::Lexer::Token], nil] objects or nil if it takes
+    #   no parameters.
+    #
+    # @api private
     def param_tokens(these_tokens)
       depth = 0
       lparen_idx = nil
@@ -529,28 +572,34 @@ class PuppetLint::Data
       end
     end
 
-    # Internal: Retrieves a list of token types that are considered to be
+    # Retrieves a list of token types that are considered to be
     # formatting tokens (whitespace, newlines, etc).
     #
-    # Returns an Array of Symbols.
+    # @return [Array[Symbol]]
+    #
+    # @api private
     def formatting_tokens
       @formatting_tokens ||= PuppetLint::Lexer::FORMATTING_TOKENS
     end
 
-    # Internal: Retrieves a Hash of Sets. Each key is a check name Symbol and
+    # Retrieves a Hash of Sets. Each key is a check name Symbol and
     # the Set of Integers returned lists all the lines that the check results
     # should be ignored on.
     #
-    # Returns a Hash of Sets of Integers.
+    # @return [Hash[Symbol, Set[Integer]]]
+    #
+    # @api private
     def ignore_overrides
       @ignore_overrides ||= {}
     end
 
-    # Internal: Parses all COMMENT, MLCOMMENT and SLASH_COMMENT tokens looking
+    # Parses all COMMENT, MLCOMMENT and SLASH_COMMENT tokens looking
     # for control comments (comments that enable or disable checks). Builds the
     # contents of the `ignore_overrides` hash.
     #
-    # Returns nothing.
+    # @return [nil]
+    #
+    # @api private
     def parse_control_comments
       @ignore_overrides.each_key { |check| @ignore_overrides[check].clear }
 

data/lib/puppet-lint/plugins/check_whitespace/line_length.rb

@@ -9,7 +9,7 @@ class PuppetLint::LineLengthCheck
   # @param content [String] The content of the current line.
   # @param character_count [Integer] The maximum number of characters allowed
   #
-  # @return problem [Array] An array containing a description of the problem.
+  # @return [Array] An array containing a description of the problem.
   # Can be passed directly to notify..
   def self.check(line_number, content, character_count)
     return if content.include? '://'

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '4.2.1'.freeze
+  VERSION = '4.2.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.2.3
 platform: ruby
 authors:
 - Tim Sharpe
@@ -10,12 +10,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies: []
-description: |2
-      Checks your Puppet manifests against the Puppetlabs style guide and alerts you to any discrepancies.
-      Note: Support for this gem has been moved under a new namespace and as such any future updates from
-      the Puppet team will be released as `puppetlabs-puppet-lint`.
+description: "    Checks your Puppet manifests against the Puppetlabs style guide
+  and alerts you to any discrepancies.\n"
 email:
 - tim@sharpe.id.au
 - modules-team@puppet.com