Class: SyntaxTree::CommandCall

Inherits:
Node
  • Object
show all
Defined in:
lib/syntax_tree/node.rb

Overview

CommandCall represents a method call on an object with arguments and no parentheses.

object.method argument

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #end_char, #pretty_print, #start_char, #to_json, #to_mermaid

Constructor Details

#initialize(receiver:, operator:, message:, arguments:, block:, location:) ⇒ CommandCall

Returns a new instance of CommandCall.



3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
 
# File 'lib/syntax_tree/node.rb', line 3597

def initialize(
  receiver:,
  operator:,
  message:,
  arguments:,
  block:,
  location:
)
  @receiver = receiver
  @operator = operator
  @message = message
  @arguments = arguments
  @block = block
  @location = location
  @comments = []
end

Instance Attribute Details

#arguments ⇒ Object (readonly)

nil | Args | ArgParen

the arguments going along with the message



3589
3590
3591
 
# File 'lib/syntax_tree/node.rb', line 3589

def arguments
  @arguments
end

#block ⇒ Object (readonly)

nil | BlockNode

the block associated with this method call



3592
3593
3594
 
# File 'lib/syntax_tree/node.rb', line 3592

def block
  @block
end

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



3595
3596
3597
 
# File 'lib/syntax_tree/node.rb', line 3595

def comments
  @comments
end

#message ⇒ Object (readonly)

:call | Const | Ident | Op

the message being send



3586
3587
3588
 
# File 'lib/syntax_tree/node.rb', line 3586

def message
  @message
end

#operator ⇒ Object (readonly)

nil | :“::” | Op | Period

the operator used to send the message



3583
3584
3585
 
# File 'lib/syntax_tree/node.rb', line 3583

def operator
  @operator
end

#receiver ⇒ Object (readonly)

nil | Node

the receiver of the message



3580
3581
3582
 
# File 'lib/syntax_tree/node.rb', line 3580

def receiver
  @receiver
end

Instance Method Details

#===(other) ⇒ Object 



3701
3702
3703
3704
3705
 
# File 'lib/syntax_tree/node.rb', line 3701

def ===(other)
  other.is_a?(CommandCall) && receiver === other.receiver &&
    operator === other.operator && message === other.message &&
    arguments === other.arguments && block === other.block
end

#accept(visitor) ⇒ Object 



3614
3615
3616
 
# File 'lib/syntax_tree/node.rb', line 3614

def accept(visitor)
  visitor.visit_command_call(self)
end

#arity ⇒ Object 



3707
3708
3709
 
# File 'lib/syntax_tree/node.rb', line 3707

def arity
  arguments&.arity || 0
end

#child_nodes ⇒ Object Also known as: deconstruct 



3618
3619
3620
 
# File 'lib/syntax_tree/node.rb', line 3618

def child_nodes
  [receiver, message, arguments, block]
end

#copy(receiver: nil, operator: nil, message: nil, arguments: nil, block: nil, location: nil) ⇒ Object 



3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
 
# File 'lib/syntax_tree/node.rb', line 3622

def copy(
  receiver: nil,
  operator: nil,
  message: nil,
  arguments: nil,
  block: nil,
  location: nil
)
  node =
    CommandCall.new(
      receiver: receiver || self.receiver,
      operator: operator || self.operator,
      message: message || self.message,
      arguments: arguments || self.arguments,
      block: block || self.block,
      location: location || self.location
    )

  node.comments.concat(comments.map(&:copy))
  node
end

#deconstruct_keys(_keys) ⇒ Object 



3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
 
# File 'lib/syntax_tree/node.rb', line 3646

def deconstruct_keys(_keys)
  {
    receiver: receiver,
    operator: operator,
    message: message,
    arguments: arguments,
    block: block,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object 



3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
 
# File 'lib/syntax_tree/node.rb', line 3658

def format(q)
  message = self.message
  arguments = self.arguments
  block = self.block

  q.group do
    doc =
      q.nest(0) do
        q.format(receiver)

        # If there are leading comments on the message then we know we have
        # a newline in the source that is forcing these things apart. In
        # this case we will have to use a trailing operator.
        if message != :call && message.comments.any?(&:leading?)
          q.format(CallOperatorFormatter.new(operator), stackable: false)
          q.indent do
            q.breakable_empty
            q.format(message)
          end
        else
          q.format(CallOperatorFormatter.new(operator), stackable: false)
          q.format(message)
        end
      end

    # Format the arguments for this command call here. If there are no
    # arguments, then print nothing.
    if arguments
      parts = arguments.parts

      if parts.length == 1 && parts.first.is_a?(IfOp)
        q.if_flat { q.text(" ") }
        q.format(arguments)
      else
        q.text(" ")
        q.nest(argument_alignment(q, doc)) { q.format(arguments) }
      end
    end
  end

  q.format(block) if block
end