Class: Issuesrc::Sourcers::SourcerInterface

Inherits:
Object
  • Object
show all
Defined in:
lib/sourcers/sourcers.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(args, config) ⇒ SourcerInterface

Returns a new instance of SourcerInterface.

Parameters:

  • args —

    Command line arguments, as key => value.

  • config —

    Arguments from the configuration file, as key => value.



18
 
# File 'lib/sourcers/sourcers.rb', line 18

def initialize(args, config); end

Instance Method Details

#finish(created_tags, updated_tags, closed_issue_ids) ⇒ Object

Optional. Called when the execution of the program finishes.

Parameters:

  • created_tags —

    Array of Tag.

  • updated_tags —

    Array of Tag.

  • closed_issue_ids —

    Array of IDs, which are Strings.



30
 
# File 'lib/sourcers/sourcers.rb', line 30

def finish(created_tags, updated_tags, closed_issue_ids); end

#retrieve_files ⇒ Enumerator

Retrieves all the files in which there may be tags to find.

Returns:



23
 
# File 'lib/sourcers/sourcers.rb', line 23

def retrieve_files; end