Class: Inch::CodeObject::Provider::YARD::Parser

Inherits:

Object

• Object
• Inch::CodeObject::Provider::YARD::Parser

Defined in:

lib/inch/code_object/provider/yard/parser.rb

Overview

Parses the source tree (using YARD)

Constant Summary

IGNORE_TYPES =

[:macro]

Class Method Summary

• .parse(*args) ⇒ CodeObject::Provider::YARD::Parser

  Helper method to parse an instance with the given args.

Instance Method Summary

• #objects ⇒ Array<YARD::Object::Base>
• #parse(dir, config) ⇒ void

Class Method Details

.parse(*args) ⇒ CodeObject::Provider::YARD::Parser

Helper method to parse an instance with the given args

Returns:

• (CodeObject::Provider::YARD::Parser) —

  the instance that ran

See Also:

• #parse

# File 'lib/inch/code_object/provider/yard/parser.rb', line 13

def self.parse(*args)
  parser = self.new
  parser.parse(*args)
  parser
end

Instance Method Details

#objects ⇒ Array<YARD::Object::Base>

Returns:

• (Array<YARD::Object::Base>)

# File 'lib/inch/code_object/provider/yard/parser.rb', line 30

def objects
  @objects ||= parsed_objects.map do |o|
    YARD::Object.for(o) unless IGNORE_TYPES.include?(o.type)
  end.compact
end

#parse(dir, config) ⇒ void

This method returns an undefined value.

Parameters:

• dir (String) —

  directory

• config (Inch::Config::Codebase) —

  configuration for codebase

# File 'lib/inch/code_object/provider/yard/parser.rb', line 22

def parse(dir, config)
  Dir.chdir(dir) do
    parse_yard_objects(config.included_files, config.excluded_files)
    inject_base_dir(dir)
  end
end