File: arg_node.rb

package info (click to toggle)
ruby-rubocop-ast 1.24.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,256 kB
  • sloc: ruby: 15,071; yacc: 90; makefile: 9
file content (34 lines) | stat: -rw-r--r-- 971 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# frozen_string_literal: true

module RuboCop
  module AST
    # A node extension for `arg`, `optarg`, `restarg`, `kwarg`, `kwoptarg`,
    # `kwrestarg`, `blockarg`, `shadowarg` and `forward_arg` nodes.
    # This will be used in place of a plain node when the builder constructs
    # the AST, making its methods available to all `arg` nodes within RuboCop.
    class ArgNode < Node
      # Returns the name of an argument.
      #
      # @return [Symbol, nil] the name of the argument
      def name
        node_parts[0]
      end

      # Returns the default value of the argument, if any.
      #
      # @return [Node, nil] the default value of the argument
      def default_value
        return unless default?

        node_parts[1]
      end

      # Checks whether the argument has a default value
      #
      # @return [Boolean] whether the argument has a default value
      def default?
        optarg_type? || kwoptarg_type?
      end
    end
  end
end