Class: YARD::Handlers::Ruby::HandlesExtension

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses: MethodCallWrapper, TestNodeWrapper
Inherits:	Object
Defined in:	lib/yard/handlers/ruby/base.rb

Overview

To implement a custom handler matcher, subclass this class and implement #matches? to return whether a node matches the handler.

Examples:

A Custom Handler Matcher Extension

# Implements a handler that checks for a specific string
# in the node's source.
class MyExtension < HandlesExtension
  def matches?(node) node.source.include?(name) end
end

# This handler will handle any node where the source includes 'foo'
class MyHandler < Handlers::Ruby::Base
  handles MyExtension.new('foo')
end

Class Method Summary

.new(name) ⇒ HandlesExtension constructor

Creates a new extension with a specific matcher value #name

Instance Method Summary

#matches?(node) ⇒ Boolean

Tests if the node matches the handler.

Constructor Details

.new(name) ⇒ `HandlesExtension`

Creates a new extension with a specific matcher value #name

Parameters:

name (Object) —
the matcher value to check against #matches?

[ GitHub ]

# File 'lib/yard/handlers/ruby/base.rb', line 22


def initialize(name) @name = name end

Instance Method Details

#matches?(node) ⇒ `Boolean`

Tests if the node matches the handler