Class: SyntaxTree::BodyStmt

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

Overview

bodystmt can’t actually determine its bounds appropriately because it doesn’t necessarily know where it started. So the parent node needs to report back down into this one where it goes.

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#pretty_print, #to_json

Constructor Details

#initialize(statements:, rescue_clause:, else_keyword:, else_clause:, ensure_clause:, location:, comments: []) ⇒ BodyStmt

Returns a new instance of BodyStmt.



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
 
# File 'lib/syntax_tree/node.rb', line 1761

def initialize(
  statements:,
  rescue_clause:,
  else_keyword:,
  else_clause:,
  ensure_clause:,
  location:,
  comments: []
)
  @statements = statements
  @rescue_clause = rescue_clause
  @else_keyword = else_keyword
  @else_clause = else_clause
  @ensure_clause = ensure_clause
  @location = location
  @comments = comments
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



1759
1760
1761
 
# File 'lib/syntax_tree/node.rb', line 1759

def comments
  @comments
end

#else_clause ⇒ Object (readonly)

nil | Statements

the optional set of statements inside the else clause



1753
1754
1755
 
# File 'lib/syntax_tree/node.rb', line 1753

def else_clause
  @else_clause
end

#else_keyword ⇒ Object (readonly)

nil | Kw

the optional else keyword



1750
1751
1752
 
# File 'lib/syntax_tree/node.rb', line 1750

def else_keyword
  @else_keyword
end

#ensure_clause ⇒ Object (readonly)

nil | Ensure

the optional ensure clause



1756
1757
1758
 
# File 'lib/syntax_tree/node.rb', line 1756

def ensure_clause
  @ensure_clause
end

#rescue_clause ⇒ Object (readonly)

nil | Rescue

the optional rescue chain attached to the begin clause



1747
1748
1749
 
# File 'lib/syntax_tree/node.rb', line 1747

def rescue_clause
  @rescue_clause
end

#statements ⇒ Object (readonly)

Statements

the list of statements inside the begin clause



1744
1745
1746
 
# File 'lib/syntax_tree/node.rb', line 1744

def statements
  @statements
end

Instance Method Details

#accept(visitor) ⇒ Object 



1815
1816
1817
 
# File 'lib/syntax_tree/node.rb', line 1815

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

#bind(start_char, start_column, end_char, end_column) ⇒ Object 



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/syntax_tree/node.rb', line 1779

def bind(start_char, start_column, end_char, end_column)
  @location =
    Location.new(
      start_line: location.start_line,
      start_char: start_char,
      start_column: start_column,
      end_line: location.end_line,
      end_char: end_char,
      end_column: end_column
    )

  parts = [rescue_clause, else_clause, ensure_clause]

  # Here we're going to determine the bounds for the statements
  consequent = parts.compact.first
  statements.bind(
    start_char,
    start_column,
    consequent ? consequent.location.start_char : end_char,
    consequent ? consequent.location.start_column : end_column
  )

  # Next we're going to determine the rescue clause if there is one
  if rescue_clause
    consequent = parts.drop(1).compact.first
    rescue_clause.bind_end(
      consequent ? consequent.location.start_char : end_char,
      consequent ? consequent.location.start_column : end_column
    )
  end
end

#child_nodes ⇒ Object Also known as: deconstruct 



1819
1820
1821
 
# File 'lib/syntax_tree/node.rb', line 1819

def child_nodes
  [statements, rescue_clause, else_keyword, else_clause, ensure_clause]
end

#deconstruct_keys(keys) ⇒ Object 



1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
 
# File 'lib/syntax_tree/node.rb', line 1825

def deconstruct_keys(keys)
  {
    statements: statements,
    rescue_clause: rescue_clause,
    else_clause: else_clause,
    ensure_clause: ensure_clause,
    location: location,
    comments: comments
  }
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


1811
1812
1813
 
# File 'lib/syntax_tree/node.rb', line 1811

def empty?
  statements.empty? && !rescue_clause && !else_clause && !ensure_clause
end

#format(q) ⇒ Object 



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
 
# File 'lib/syntax_tree/node.rb', line 1836

def format(q)
  q.group do
    q.format(statements) unless statements.empty?

    if rescue_clause
      q.nest(-2) do
        q.breakable(force: true)
        q.format(rescue_clause)
      end
    end

    if else_clause
      q.nest(-2) do
        q.breakable(force: true)
        q.format(else_keyword)
      end

      unless else_clause.empty?
        q.breakable(force: true)
        q.format(else_clause)
      end
    end

    if ensure_clause
      q.nest(-2) do
        q.breakable(force: true)
        q.format(ensure_clause)
      end
    end
  end
end