Contents

# frozen_string_literal: true

module RuboCop
  module AST
    # A node extension for `pair` nodes. This will be used in place of a plain
    # node when the builder constructs the AST, making its methods available
    # to all `pair` nodes within RuboCop.
    class PairNode < Node
      include HashElementNode

      HASH_ROCKET = '=>'.freeze
      SPACED_HASH_ROCKET = ' => '.freeze
      COLON = ':'.freeze
      SPACED_COLON = ': '.freeze

      # Checks whether the `pair` uses a hash rocket delimiter.
      #
      # @return [Boolean] whether this `pair` uses a hash rocket delimiter
      def hash_rocket?
        loc.operator.is?(HASH_ROCKET)
      end

      # Checks whether the `pair` uses a colon delimiter.
      #
      # @return [Boolean] whether this `pair` uses a colon delimiter
      def colon?
        loc.operator.is?(COLON)
      end

      # Returns the delimiter of the `pair` as a string. Returns `=>` for a
      # colon delimited `pair`, and `:` for a hash rocket delimited `pair`.
      #
      # @param [Boolean] with_spacing whether to include spacing
      # @return [String] the delimiter of the `pair`
      def delimiter(with_spacing = false)
        if with_spacing
          hash_rocket? ? SPACED_HASH_ROCKET : SPACED_COLON
        else
          hash_rocket? ? HASH_ROCKET : COLON
        end
      end

      # Returns the inverse delimiter of the `pair` as a string.
      #
      # @param [Boolean] with_spacing whether to include spacing
      # @return [String] the inverse delimiter of the `pair`
      def inverse_delimiter(with_spacing = false)
        if with_spacing
          hash_rocket? ? SPACED_COLON : SPACED_HASH_ROCKET
        else
          hash_rocket? ? COLON : HASH_ROCKET
        end
      end

      # Custom destructuring method. This is used to normalize the branches
      # for `pair` and `kwsplat` nodes, to add duck typing to `hash` elements.
      #
      # @return [Array<Node>] the different parts of the `pair`
      def node_parts
        to_a
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
rubocop-0.52.1	lib/rubocop/ast/node/pair_node.rb
rubocop-0.52.0	lib/rubocop/ast/node/pair_node.rb
rubocop-0.51.0	lib/rubocop/ast/node/pair_node.rb
rubocop-0.50.0	lib/rubocop/ast/node/pair_node.rb
rubocop-0.49.1	lib/rubocop/ast/node/pair_node.rb
rubocop-0.49.0	lib/rubocop/ast/node/pair_node.rb