Class: YARD::Handlers::Base Abstract

Inherits:
Object
  • Object
show all
Includes:
CodeObjects, Parser
Defined in:
lib/yard/handlers/base.rb

Overview

This class is abstract.

Subclass this class to provide a handler for YARD to use during the processing phase.

Handlers are pluggable semantic parsers for YARD's code generation phase. They allow developers to control what information gets generated by YARD, giving them the ability to, for instance, document any Ruby DSLs that a customized framework may use. A good example of this would be the ability to document and generate meta data for the 'describe' declaration of the RSpec testing framework by simply adding a handler for such a keyword. Similarly, any Ruby API that takes advantage of class level declarations could add these to the documentation in a very explicit format by treating them as first- class objects in any outputted documentation.

Overview of a Typical Handler Scenario

Generally, a handler class will declare a set of statements which it will handle using the Base.handles class declaration. It will then implement the #process method to do the work. The processing would usually involve the manipulation of the #namespace, #owner code objects or the creation of new ones, in which case they should be registered by #register, a method that sets some basic attributes for the new objects.

Handlers are usually simple and take up to a page of code to process and register a new object or add new attributes to the current namespace.

Setting up a Handler for Use

A Handler is automatically registered when it is subclassed from the base class. The only other thing that needs to be done is to specify which statement the handler will process. This is done with the handles declaration, taking either a Parser::Ruby::Legacy::RubyToken, String or `Regexp`. Here is a simple example which processes module statements.

class MyModuleHandler < YARD::Handlers::Base
  handles TkMODULE

  def process
    # do something
  end
end

Processing Handler Data

The goal of a specific handler is really up to the developer, and as such there is no real guideline on how to process the data. However, it is important to know where the data is coming from to be able to use it.

statement Attribute

The statement attribute pertains to the Parser::Ruby::Legacy::Statement object containing a set of tokens parsed in by the parser. This is the main set of data to be analyzed and processed. The comments attached to the statement can be accessed by the Parser::Ruby::Legacy::Statement#comments method, but generally the data to be processed will live in the tokens attribute. This list can be converted to a String using #to_s to parse the data with regular expressions (or other text processing mechanisms), if needed.

namespace Attribute

The namespace attribute is a namespace object which represents the current namespace that the parser is in. For instance:

module SomeModule
  class MyClass
    def mymethod; end
  end
end

If a handler was to parse the 'class MyClass' statement, it would be necessary to know that it belonged inside the SomeModule module. This is the value that namespace would return when processing such a statement. If the class was then entered and another handler was called on the method, the namespace would be set to the 'MyClass' code object.

owner Attribute

The owner attribute is similar to the namespace attribute in that it also follows the scope of the code during parsing. However, a namespace object is loosely defined as a module or class and YARD has the ability to parse beyond module and class blocks (inside methods, for instance), so the owner attribute would not be limited to modules and classes.

To put this into context, the example from above will be used. If a method handler was added to the mix and decided to parse inside the method body, the owner would be set to the method object but the namespace would remain set to the class. This would allow the developer to process any method definitions set inside a method (def x; def y; 2 end end) by adding them to the correct namespace (the class, not the method).

In summary, the distinction between namespace and owner can be thought of as the difference between first-class Ruby objects (namespaces) and second-class Ruby objects (methods).

visibility and scope Attributes

Mainly needed for parsing methods, the visibility and scope attributes refer to the public/protected/private and class/instance values (respectively) of the current parsing position.

Parsing Blocks in Statements

In addition to parsing a statement and creating new objects, some handlers may wish to continue parsing the code inside the statement's block (if there is one). In this context, a block means the inside of any statement, be it class definition, module definition, if statement or classic 'Ruby block'.

For example, a class statement would be “class MyClass” and the block would be a list of statements including the method definitions inside the class. For a class handler, the programmer would execute the #parse_block method to continue parsing code inside the block, with the namespace now pointing to the class object the handler created.

YARD has the ability to continue into any block: class, module, method, even if statements. For this reason, the block parsing method must be invoked explicitly out of efficiency sake.

Direct Known Subclasses

C::Base, Ruby::Base, Ruby::Legacy::Base

Constant Summary

Constant Summary

Constants included from CodeObjects

CodeObjects::BUILTIN_ALL, CodeObjects::BUILTIN_CLASSES, CodeObjects::BUILTIN_EXCEPTIONS, CodeObjects::BUILTIN_EXCEPTIONS_HASH, CodeObjects::BUILTIN_MODULES, CodeObjects::CONSTANTMATCH, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ

Instance Attribute Summary (collapse)

Macro Support (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Base) initialize(source_parser, stmt)

Returns a new instance of Base



275
276
277
278
# File 'lib/yard/handlers/base.rb', line 275

def initialize(source_parser, stmt)
  @parser = source_parser
  @statement = stmt
end

Instance Attribute Details

- (Object) extra_state (readonly)

Returns the value of attribute extra_state



332
333
334
# File 'lib/yard/handlers/base.rb', line 332

def extra_state
  @extra_state
end

- (Object) globals (readonly)

Returns the value of attribute globals



329
330
331
# File 'lib/yard/handlers/base.rb', line 329

def globals
  @globals
end

- (Object) namespace

Returns the value of attribute namespace



320
321
322
# File 'lib/yard/handlers/base.rb', line 320

def namespace
  @namespace
end

- (Object) owner

Returns the value of attribute owner



317
318
319
# File 'lib/yard/handlers/base.rb', line 317

def owner
  @owner
end

- (Processor) parser (readonly)

Returns the processor object that manages all global state during handling.

Returns:

  • (Processor)

    the processor object that manages all global state during handling.



309
310
311
# File 'lib/yard/handlers/base.rb', line 309

def parser
  @parser
end

- (Object) scope

Returns the value of attribute scope



326
327
328
# File 'lib/yard/handlers/base.rb', line 326

def scope
  @scope
end

- (Object) statement (readonly)

Returns the statement object currently being processed. Usually refers to one semantic language statement, though the strict definition depends on the parser used.

Returns:

  • (Object)

    the statement object currently being processed. Usually refers to one semantic language statement, though the strict definition depends on the parser used.



314
315
316
# File 'lib/yard/handlers/base.rb', line 314

def statement
  @statement
end

- (Object) visibility

Returns the value of attribute visibility



323
324
325
# File 'lib/yard/handlers/base.rb', line 323

def visibility
  @visibility
end

Class Method Details

+ (void) clear_subclasses

This method returns an undefined value.

Clear all registered subclasses. Testing purposes only



158
159
160
# File 'lib/yard/handlers/base.rb', line 158

def clear_subclasses
  @@subclasses = []
end

+ (Array) handlers

Returns a list of matchers for the handler object.

Returns:

  • (Array)

    a list of matchers for the handler object.

See Also:



210
211
212
# File 'lib/yard/handlers/base.rb', line 210

def handlers
  @handlers ||= []
end

+ (Object) handles(*matches)

Declares the statement type which will be processed by this handler.

A match need not be unique to a handler. Multiple handlers can process the same statement. However, in this case, care should be taken to make sure that #parse_block would only be executed by one of the handlers, otherwise the same code will be parsed multiple times and slow YARD down.

Parameters:

  • matches (Parser::RubyToken, Symbol, String, Regexp)

    statements that match the declaration will be processed by this handler. A String match is equivalent to a /Astring/ regular expression (match from the beginning of the line), and all token matches match only the first token of the statement.



191
192
193
# File 'lib/yard/handlers/base.rb', line 191

def handles(*matches)
  (@handlers ||= []).push(*matches)
end

+ (Boolean) handles?(statement)

This class is implemented by Ruby::Base and Ruby::Legacy::Base. To implement a base handler class for another language, implement this method to return true if the handler should process the given statement object. Use handlers to enumerate the matchers declared for the handler class.

Parameters:

  • statement

    a statement object or node (depends on language type)

Returns:

  • (Boolean)

    whether or not this handler object should process the given statement

Raises:

  • (NotImplementedError)


204
205
206
# File 'lib/yard/handlers/base.rb', line 204

def handles?(statement)
  raise NotImplementedError, "override #handles? in a subclass"
end

+ (void) in_file(filename)

This method returns an undefined value.

Declares that a handler should only be called when inside a filename by its basename or a regex match for the full path.

Parameters:

  • filename (String, Regexp)

    a matching filename or regex

Since:

  • 0.6.2



234
235
236
# File 'lib/yard/handlers/base.rb', line 234

def in_file(filename)
  (@in_files ||= []) << filename
end

+ (Boolean) matches_file?(filename)

Returns whether the filename matches the declared file match for a handler. If no file match is specified, returns true.

Returns:

  • (Boolean)

    whether the filename matches the declared file match for a handler. If no file match is specified, returns true.

Since:

  • 0.6.2



241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/yard/handlers/base.rb', line 241

def matches_file?(filename)
  @in_files ||= nil # avoid ruby warnings
  return true unless @in_files
  @in_files.any? do |in_file|
    case in_file
    when String
      File.basename(filename) == in_file
    when Regexp
      filename =~ in_file
    else
      true
    end
  end
end

+ (void) namespace_only

This method returns an undefined value.

Declares that the handler should only be called when inside a CodeObjects::NamespaceObject, not a method body.



218
219
220
# File 'lib/yard/handlers/base.rb', line 218

def namespace_only
  @namespace_only = true
end

+ (Boolean) namespace_only?

Returns whether the handler should only be processed inside a namespace.

Returns:

  • (Boolean)

    whether the handler should only be processed inside a namespace.



224
225
226
# File 'lib/yard/handlers/base.rb', line 224

def namespace_only?
  (@namespace_only ||= false) ? true : false
end

+ (void) process(&block)

This method returns an undefined value.

Generates a process method, equivalent to def process; … end. Blocks defined with this syntax will be wrapped inside an anonymous module so that the handler class can be extended with mixins that override the process method without alias chaining.

See Also:

Since:

  • 0.5.4



268
269
270
271
272
# File 'lib/yard/handlers/base.rb', line 268

def process(&block)
  mod = Module.new
  mod.send(:define_method, :process, &block)
  include mod
end

+ (Array<Base>) subclasses

Returns all registered handler subclasses.

Returns:



164
165
166
# File 'lib/yard/handlers/base.rb', line 164

def subclasses
  @@subclasses ||= []
end

Instance Method Details

- (Object) abort!

Aborts a handler by raising HandlerAborted. An exception will only be logged in debugging mode for this kind of handler exit.

Raises:

Since:

  • 0.8.4



354
355
356
# File 'lib/yard/handlers/base.rb', line 354

def abort!
  raise Handlers::HandlerAborted
end

- (Array<String>) call_params

This method is abstract.

Implement this method to return the parameters in a method call statement. It should return an empty list if the statement is not a method call.

Returns a list of argument names

Returns:

Raises:

  • (NotImplementedError)


583
584
585
# File 'lib/yard/handlers/base.rb', line 583

def call_params
  raise NotImplementedError
end

- (String?) caller_method

This method is abstract.

Implement this method to return the method being called in a method call. It should return nil if the statement is not a method call.

Returns:

  • (String)

    the method name being called

  • (nil)

    if the statement is not a method call

Raises:

  • (NotImplementedError)


592
593
594
# File 'lib/yard/handlers/base.rb', line 592

def caller_method
  raise NotImplementedError
end

- (Object) ensure_loaded!(object, max_retries = 1)

Ensures that a specific object has been parsed and loaded into the registry. This is necessary when adding data to a namespace, for instance, since the namespace may not have been processed yet (it can be located in a file that has not been handled).

Calling this method defers the handler until all other files have been processed. If the object gets resolved, the rest of the handler continues, otherwise an exception is raised.

Examples:

Adding a mixin to the String class programmatically

ensure_loaded! P('String')
# "String" is now guaranteed to be loaded
P('String').mixins << P('MyMixin')

Parameters:

  • object (Proxy, CodeObjects::Base)

    the object to resolve.

  • max_retries (Integer) (defaults to: 1)

    the number of times to defer the handler before raising a NamespaceMissingError.

Raises:

  • (NamespaceMissingError)

    if the object is not resolved within max_retries attempts, this exception is raised and the handler finishes processing.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
# File 'lib/yard/handlers/base.rb', line 560

def ensure_loaded!(object, max_retries = 1)
  return if object.root?
  return object unless object.is_a?(Proxy)

  retries = 0
  while object.is_a?(Proxy)
    if retries <= max_retries
      log.debug "Missing object #{object} in file `#{parser.file}', moving it to the back of the line."
      parser.parse_remaining_files
    else
      raise NamespaceMissingError, object
    end
    retries += 1
  end
  object
end

- (Object) parse_block(*args)

This method is abstract.

Subclasses should call parser.process

Parses the semantic “block” contained in the statement node.

Raises:

  • (NotImplementedError)


303
304
305
# File 'lib/yard/handlers/base.rb', line 303

def parse_block(*args)
  raise NotImplementedError, "#{self} did not implement a #parse_block method for handling"
end

- (Array<CodeObjects::Base>, ...) process

The main handler method called by the parser on a statement that matches the handles declaration.

Subclasses should override this method to provide the handling functionality for the class.

Returns:

  • (Array<CodeObjects::Base>, CodeObjects::Base, Object)

    If this method returns a code object (or a list of them), they are passed to the #register method which adds basic attributes. It is not necessary to return any objects and in some cases you may want to explicitly avoid the returning of any objects for post-processing by the register method.

Raises:

  • (NotImplementedError)

See Also:



296
297
298
# File 'lib/yard/handlers/base.rb', line 296

def process
  raise NotImplementedError, "#{self} did not implement a #process method for handling."
end

- (Object) push_state(opts = {}, &block) { ... }

Executes a given block with specific state values for #owner, #namespace and #scope.

Parameters:

  • block (Proc)

    the block to execute with specific state

  • opts (Hash) (defaults to: {})

    a customizable set of options

Options Hash (opts):

  • :namespace (CodeObjects::NamespaceObject) — default: value of #namespace

    the namespace object that #namespace will be equal to for the duration of the block.

  • :scope (Symbol) — default: :instance

    the scope for the duration of the block.

  • :owner (CodeObjects::Base) — default: value of #owner

    the owner object (method) for the duration of the block

Yields:

  • a block to execute with the given state values.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'lib/yard/handlers/base.rb', line 370

def push_state(opts = {}, &block)
  opts = {
    :namespace => namespace,
    :scope => :instance,
    :owner => owner || namespace,
    :visibility => nil
  }.update(opts)

  ns, vis, sc, oo = namespace, visibility, scope, owner
  self.namespace = opts[:namespace]
  self.visibility = opts[:visibility] || :public
  self.scope = opts[:scope]
  self.owner = opts[:owner]

  yield

  self.namespace = ns
  self.visibility = vis
  self.scope = sc
  self.owner = oo
end

- (CodeObjects::Base+) register(*objects)

Do some post processing on a list of code objects. Adds basic attributes to the list of objects like the filename, line number, CodeObjects::Base#dynamic, source code and CodeObjects::Base#docstring, but only if they don't exist.

Parameters:

Returns:



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/yard/handlers/base.rb', line 404

def register(*objects)
  objects.flatten.each do |object|
    next unless object.is_a?(CodeObjects::Base)
    register_ensure_loaded(object)
    yield(object) if block_given?
    register_file_info(object)
    register_source(object)
    register_visibility(object)
    register_docstring(object)
    register_group(object)
    register_dynamic(object)
    register_module_function(object)
  end
  objects.size == 1 ? objects.first : objects
end

- (void) register_docstring(object, docstring = statement.comments, stmt = statement)

This method returns an undefined value.

Registers any docstring found for the object and expands macros

Parameters:

Since:

  • 0.8.0



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
# File 'lib/yard/handlers/base.rb', line 448

def register_docstring(object, docstring = statement.comments, stmt = statement)
  docstring = docstring.join("\n") if Array === docstring
  parser = Docstring.parser
  parser.parse(docstring || "", object, self)

  if object && docstring
    object.docstring = parser.to_docstring

    # Add hash_flag/line_range
    if stmt
      object.docstring.hash_flag = stmt.comments_hash_flag
      object.docstring.line_range = stmt.comments_range
    end
  end

  register_transitive_tags(object)
end

- (void) register_dynamic(object)

This method returns an undefined value.

Registers the object as dynamic if the object is defined inside a method or block (owner != namespace)

Parameters:

Since:

  • 0.8.0



536
537
538
# File 'lib/yard/handlers/base.rb', line 536

def register_dynamic(object)
  object.dynamic = true if owner != namespace
end

- (void) register_ensure_loaded(object)

This method returns an undefined value.

Ensures that the object's namespace is loaded before attaching it to the namespace.

Parameters:

Since:

  • 0.8.0



426
427
428
429
430
431
432
# File 'lib/yard/handlers/base.rb', line 426

def register_ensure_loaded(object)
  begin
    ensure_loaded!(object.namespace)
    object.namespace.children << object
  rescue NamespaceMissingError
  end
end

- (void) register_file_info(object, file = parser.file, line = statement.line, comments = statement.comments)

This method returns an undefined value.

Registers the file/line of the declaration with the object

Parameters:

Since:

  • 0.8.0



439
440
441
# File 'lib/yard/handlers/base.rb', line 439

def register_file_info(object, file = parser.file, line = statement.line, comments = statement.comments)
  object.add_file(file, line, comments)
end

- (void) register_group(object, group = extra_state.group)

This method returns an undefined value.

Registers the object as being inside a specific group

Parameters:

Since:

  • 0.8.0



471
472
473
474
475
476
477
478
# File 'lib/yard/handlers/base.rb', line 471

def register_group(object, group = extra_state.group)
  if group
    unless object.namespace.is_a?(Proxy)
      object.namespace.groups |= [group]
    end
    object.group = group
  end
end

- (Object) register_module_function(object)

Registers the same method information on the module function, if the object was defined as a module function.

Parameters:

  • object (CodeObjects::Base)

    the possible module function object to copy data for

Since:

  • 0.8.0



522
523
524
525
526
527
528
# File 'lib/yard/handlers/base.rb', line 522

def register_module_function(object)
  return unless object.is_a?(MethodObject)
  return unless object.module_function?
  modobj = MethodObject.new(object.namespace, object.name)
  object.copy_to(modobj)
  modobj.visibility = :private
end

- (void) register_source(object, source = statement, type = parser.parser_type)

This method returns an undefined value.

Parameters:

Since:

  • 0.8.0



498
499
500
501
502
# File 'lib/yard/handlers/base.rb', line 498

def register_source(object, source = statement, type = parser.parser_type)
  return unless object.is_a?(MethodObject)
  object.source ||= source
  object.source_type = type
end

- (void) register_transitive_tags(object)

This method returns an undefined value.

Registers any transitive tags from the namespace on the object

Parameters:

Since:

  • 0.8.0



485
486
487
488
489
490
491
492
493
# File 'lib/yard/handlers/base.rb', line 485

def register_transitive_tags(object)
  return unless object
  Tags::Library.transitive_tags.each do |tag|
    next if object.namespace.is_a?(Proxy)
    next unless object.namespace.has_tag?(tag)
    next if object.has_tag?(tag)
    object.add_tag(*object.namespace.tags(tag))
  end
end

- (Object) register_visibility(object, visibility = self.visibility)

Registers visibility on a method object. If the object does not respond to setting visibility, nothing is done.

Parameters:

  • object (#visibility=)

    the object to register

  • visibility (Symbol) (defaults to: self.visibility)

    the visibility to set on the object

Since:

  • 0.8.0



510
511
512
513
514
# File 'lib/yard/handlers/base.rb', line 510

def register_visibility(object, visibility = self.visibility)
  return unless object.respond_to?(:visibility=)
  return if object.is_a?(NamespaceObject)
  object.visibility = visibility
end