Module: RuboCop::AST::NodePattern::Macros

Included in:
MethodDispatchNode, RuboCop::AST::Node
Defined in:
lib/rubocop/ast/node_pattern.rb

Overview

Helpers for defining methods based on a pattern string

Instance Method Summary collapse

Instance Method Details

#def_node_matcher(method_name, pattern_str) ⇒ Object

Define a method which applies a pattern to an AST node

The new method will return nil if the node does not match If the node matches, and a block is provided, the new method will yield to the block (passing any captures as block arguments). If the node matches, and no block is provided, the new method will return the captures, or ‘true` if there were none.



768
769
770
771
772
773
774
775
776
 
# File 'lib/rubocop/ast/node_pattern.rb', line 768

def def_node_matcher(method_name, pattern_str)
  compiler = Compiler.new(pattern_str, 'node')
  src = "def #{method_name}(node = self" \
        "#{compiler.emit_trailing_params});" \
        "#{compiler.emit_method_code};end"

  location = caller_locations(1, 1).first
  class_eval(src, location.path, location.lineno)
end

#def_node_search(method_name, pattern_str) ⇒ Object

Define a method which recurses over the descendants of an AST node, checking whether any of them match the provided pattern

If the method name ends with ‘?’, the new method will return ‘true` as soon as it finds a descendant which matches. Otherwise, it will yield all descendants which match.



784
785
786
787
788
789
790
791
792
793
 
# File 'lib/rubocop/ast/node_pattern.rb', line 784

def def_node_search(method_name, pattern_str)
  compiler = Compiler.new(pattern_str, 'node')
  called_from = caller(1..1).first.split(':')

  if method_name.to_s.end_with?('?')
    node_search_first(method_name, compiler, called_from)
  else
    node_search_all(method_name, compiler, called_from)
  end
end

#node_search(method_name, compiler, on_match, prelude, called_from) ⇒ Object 



807
808
809
810
811
812
 
# File 'lib/rubocop/ast/node_pattern.rb', line 807

def node_search(method_name, compiler, on_match, prelude, called_from)
  src = node_search_body(method_name, compiler.emit_trailing_params,
                         prelude, compiler.match_code, on_match)
  filename, lineno = *called_from
  class_eval(src, filename, lineno.to_i)
end

#node_search_all(method_name, compiler, called_from) ⇒ Object 



799
800
801
802
803
804
805
 
# File 'lib/rubocop/ast/node_pattern.rb', line 799

def node_search_all(method_name, compiler, called_from)
  yield_code = compiler.emit_yield_capture('node')
  prelude = "return enum_for(:#{method_name}, node0" \
            "#{compiler.emit_trailing_params}) unless block_given?"

  node_search(method_name, compiler, yield_code, prelude, called_from)
end

#node_search_body(method_name, trailing_params, prelude, match_code, on_match) ⇒ Object 



814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/rubocop/ast/node_pattern.rb', line 814

def node_search_body(method_name, trailing_params, prelude, match_code,
                     on_match)
  <<~RUBY
    def #{method_name}(node0#{trailing_params})
      #{prelude}
      node0.each_node do |node|
        if #{match_code}
          #{on_match}
        end
      end
      nil
    end
  RUBY
end

#node_search_first(method_name, compiler, called_from) ⇒ Object 



795
796
797
 
# File 'lib/rubocop/ast/node_pattern.rb', line 795

def node_search_first(method_name, compiler, called_from)
  node_search(method_name, compiler, 'return true', '', called_from)
end