Class: Issuesrc::TagFinders::TagFinderInterface

Inherits:

Object

• Object
• Issuesrc::TagFinders::TagFinderInterface

Defined in:

lib/tag_finders/tag_finders.rb

Overview

This class is here for documentation only. All classes in the TagFinders module that want to be considered tag finders need to implement this interface.

Instance Method Summary

• #accepts?(file) ⇒ Bool

  Tells if the tag finder can process the given file or not.

• #find_tags(file) {|tag| ... } ⇒ Object

  Finds all the tags in a file.

• #initialize(tag_extractor, args, config) ⇒ TagFinderInterface constructor

  A new instance of TagFinderInterface.

Constructor Details

#initialize(tag_extractor, args, config) ⇒ TagFinderInterface

# File 'lib/tag_finders/tag_finders.rb', line 19

def initialize(tag_extractor, args, config); end

Instance Method Details

#accepts?(file) ⇒ Bool

Tells if the tag finder can process the given file or not.

# File 'lib/tag_finders/tag_finders.rb', line 25

def accepts?(file); end

#find_tags(file) {|tag| ... } ⇒ Object

Finds all the tags in a file.

Reads in the file’s body looking for tags, using the instance’s tag_extractor.

Yield Parameters:

• tag (Issuesrc::Tag)

# File 'lib/tag_finders/tag_finders.rb', line 34

def find_tags(file); end