Sha256: 639852351687463ec78995579c88aaf9c9a9ea01ee65ea5ed7021540b54861ea

Contents?: true

Size: 1.39 KB

Versions: 6789

Compression:

Stored size: 1.39 KB

Contents

# frozen_string_literal: true

module RuboCop
  module AST
    # A node extension for `for` nodes. This will be used in place of a plain
    # node when the builder constructs the AST, making its methods available
    # to all `for` nodes within RuboCop.
    class ForNode < Node
      # Returns the keyword of the `for` statement as a string.
      #
      # @return [String] the keyword of the `until` statement
      def keyword
        'for'
      end

      # Checks whether the `for` node has a `do` keyword.
      #
      # @return [Boolean] whether the `for` node has a `do` keyword
      def do?
        loc.begin && loc.begin.is?('do')
      end

      # Checks whether this node body is a void context.
      # Always `true` for `for`.
      #
      # @return [true] whether the `for` node body is a void context
      def void_context?
        true
      end

      # Returns the iteration variable of the `for` loop.
      #
      # @return [Node] The iteration variable of the `for` loop
      def variable
        node_parts[0]
      end

      # Returns the collection the `for` loop is iterating over.
      #
      # @return [Node] The collection the `for` loop is iterating over
      def collection
        node_parts[1]
      end

      # Returns the body of the `for` loop.
      #
      # @return [Node, nil] The body of the `for` loop.
      def body
        node_parts[2]
      end
    end
  end
end

Version data entries

6,789 entries across 6,783 versions & 25 rubygems

Version Path
rubocop-0.58.0 lib/rubocop/ast/node/for_node.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.4.0/gems/rubocop-0.57.2/lib/rubocop/ast/node/for_node.rb
rubocop-0.57.2 lib/rubocop/ast/node/for_node.rb
rubocop-0.57.1 lib/rubocop/ast/node/for_node.rb
rubocop-0.57.0 lib/rubocop/ast/node/for_node.rb
rubocop-0.56.0 lib/rubocop/ast/node/for_node.rb
rubocop-0.55.0 lib/rubocop/ast/node/for_node.rb
rubocop-0.54.0 lib/rubocop/ast/node/for_node.rb
rubocop-0.53.0 lib/rubocop/ast/node/for_node.rb