123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In:
::RuboCop::AST::AliasNode, ::RuboCop::AST::AndAsgnNode, ::RuboCop::AST::AndNode, ::RuboCop::AST::ArgNode, ::RuboCop::AST::ArgsNode, ::RuboCop::AST::ArrayNode, ::RuboCop::AST::AsgnNode, ::RuboCop::AST::BlockNode, ::RuboCop::AST::BreakNode, ::RuboCop::AST::CaseMatchNode, ::RuboCop::AST::CaseNode, ::RuboCop::AST::CasgnNode, ::RuboCop::AST::ClassNode, ::RuboCop::AST::ComplexNode, ::RuboCop::AST::ConstNode, ::RuboCop::AST::CsendNode, ::RuboCop::AST::DefNode, ::RuboCop::AST::DefinedNode, ::RuboCop::AST::DstrNode, ::RuboCop::AST::EnsureNode, ::RuboCop::AST::FloatNode, ::RuboCop::AST::ForNode, ::RuboCop::AST::ForwardArgsNode, ::RuboCop::AST::HashNode, ::RuboCop::AST::IfNode, ::RuboCop::AST::InPatternNode, ::RuboCop::AST::IndexNode, ::RuboCop::AST::IndexasgnNode, ::RuboCop::AST::IntNode, ::RuboCop::AST::KeywordBeginNode, ::RuboCop::AST::KeywordSplatNode, ::RuboCop::AST::LambdaNode, ::RuboCop::AST::MasgnNode, ::RuboCop::AST::MethodDispatchNode, ::RuboCop::AST::MlhsNode, ::RuboCop::AST::ModuleNode, ::RuboCop::AST::NextNode, ::RuboCop::AST::Node, ::RuboCop::AST::OpAsgnNode, ::RuboCop::AST::OrAsgnNode, ::RuboCop::AST::OrNode, ::RuboCop::AST::PairNode, ::RuboCop::AST::Procarg0Node, ::RuboCop::AST::RangeNode, ::RuboCop::AST::RationalNode, ::RuboCop::AST::RegexpNode, ::RuboCop::AST::ResbodyNode, ::RuboCop::AST::RescueNode, ::RuboCop::AST::ReturnNode, ::RuboCop::AST::SelfClassNode, ::RuboCop::AST::SendNode, ::RuboCop::AST::StrNode, ::RuboCop::AST::SuperNode, ::RuboCop::AST::SymbolNode, ::RuboCop::AST::UntilNode, ::RuboCop::AST::VarNode, ::RuboCop::AST::WhenNode, ::RuboCop::AST::WhileNode, ::RuboCop::AST::YieldNode
Defined in: lib/rubocop/ast/node_pattern.rb

Overview

Helpers for defining methods based on a pattern string

Instance Method Summary

Instance Method Details

#def_node_matcher(method_name, pattern_str, **keyword_defaults)

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.

[ GitHub ] 

  


# File 'lib/rubocop/ast/node_pattern.rb', line 36



def def_node_matcher(method_name, pattern_str, **keyword_defaults)
  NodePattern.new(pattern_str).def_node_matcher(self, method_name, **keyword_defaults)
end


  








  

    #def_node_search(method_name, pattern_str, **keyword_defaults)  
  



  

    


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.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/ast/node_pattern.rb', line 46



def def_node_search(method_name, pattern_str, **keyword_defaults)
  NodePattern.new(pattern_str).def_node_search(self, method_name, **keyword_defaults)
end