Class PuppetLint::Data
In: lib/puppet-lint/data.rb
Parent: Object

Public: A singleton class storing all the information about the manifest being analysed.

Methods

array_indexes   class_indexes   defaults_indexes   defined_type_indexes   definition_indexes   find_resource_param_tokens   find_resource_type_token   formatting_tokens   function_indexes   hash_indexes   ignore_overrides   node_indexes   param_tokens   parse_control_comments   path=   resource_indexes   title_tokens   tokens   tokens=  

Included Modules

Singleton

Attributes

filename  [R]  Internal: Get/Set the full expanded path to the manifest file being checked.
fullpath  [R]  Internal: Get/Set the full expanded path to the manifest file being checked.
manifest_lines  [RW]  Internal: Get/Set the raw manifest data, split by \n.
path  [R]  Internal: Get/Set the full expanded path to the manifest file being checked.

Public Class methods

array_indexes()

Internal: 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
            first Token of an array value
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of an array value
  :tokens - An Array consisting of all the Token objects that make up the
            array value.
class_indexes()

Internal: 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
            first Token of a class definition.
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of a class definition.
  :tokens - An Array consisting of all the Token objects that make up the
            class definition.
defaults_indexes()

Internal: Calculate the positions of all defaults declarations within `tokens` Array.

Returns an Array of Hashes, each containing: 

  :start  - An Integer position in the `tokens` Array pointing to the
            first Token of the defaults declaration
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of the defaults declaration
  :tokens - An Array consisting of all the Token objects that make up the
            defaults declaration.
defined_type_indexes()

Internal: 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
            first Token of a defined type definition.
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of a defined type definition.
  :tokens - An Array consisting of all the Token objects that make up the
            defined type.
definition_indexes(type)

Internal: 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
            first Token of a definition.
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of a definition.
  :tokens - An Array consisting of all the Token objects that make up the
            definition.
find_resource_param_tokens(resource_tokens)

Internal: 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.

Returns an Array of Token objects.

find_resource_type_token(index)

Internal: Find the Token representing the type of a resource definition.

index - The Integer pointing to the start of the resource in the `tokens` 

        array.

Returns a Token object.

formatting_tokens()

Internal: Retrieves a list of token types that are considered to be formatting tokens (whitespace, newlines, etc).

Returns an Array of Symbols.

function_indexes()

Internal: 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
            first Token of a function call
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of a function call
  :tokens - An Array consisting of all the Token objects that make up the
            function call.
hash_indexes()

Internal: 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
            first Token of an hash value
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of an hash value
  :tokens - An Array consisting of all the Token objects that make up the
            hash value.
ignore_overrides()

Internal: 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.

node_indexes()

Internal: 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
            first Token of a defined type definition.
  :end    - An Integer position in the `tokens` Array pointing to the last
            Token of a defined type definition.
  :tokens - An Array consisting of all the Token objects that make up the
            defined type.
param_tokens(these_tokens)

Internal: 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.

Returns an Array of PuppetLint::Lexer::Token objects or nil if it takes no parameters.

parse_control_comments()

Internal: 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.

path=(val)

Internal: Store the path to the manifest file and populate fullpath and filename.

val - The path to the file as a String.

Returns nothing.

resource_indexes()

Internal: 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.
title_tokens()

Internal: Retrieve a list of tokens that represent resource titles

Returns an Array of PuppetLint::Lexer::Token objects.

tokens()

Public: Get the tokenised manifest.

Returns an Array of PuppetLint::Lexer::Token objects.

tokens=(tokens)

Internal: Store the tokenised manifest.

tokens - The Array of PuppetLint::Lexer::Token objects to store.

Returns nothing.

[Validate]