class DevTraining::Issue

Class representing a GitHub issue, lazily instantiated.

Attributes

description [RW]

The issue description – part of the body, optional, read from the data

subtasks [RW]

An array of tasks – rendered as a task list as part of the body, optional, and read from the data

title [RW]

The issue title – read from, and required to be in the data

Public Class Methods

new (client, repo, milestone, data)

Source

# File lib/dev_training/issue.rb, line 29
def initialize(client, repo, milestone, data)
  @client = client
  @repo = repo
  @milestone = milestone
  @title = data.fetch('title')
  @description = data['description']
  @subtasks = data['subtasks']
end

Arguments:

client: An Octokit::Client
repo: A DevTraining::Repository
milestone: A DevTraining::Milestone
data: A Hash containing the keys, title, description (optional), and subtasks (optional). Likely read in from a YAML file.

Public Instance Methods

body ()

Source

# File lib/dev_training/issue.rb, line 40
def body
  format_body(@description, @subtasks)
end

The text of this issue’s body (uses DevTraining::FormattingHelpers.format_body)

resource ()

Source

# File lib/dev_training/issue.rb, line 47
def resource
  @resource ||= find || create
end

The Sawyer::Resource representing the GitHub issue. It will be found by title and milestone, or created in the repository if not found.