Class: GitHubChangelogGenerator::Generator

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

Instance Method Summary collapse

Constructor Details

#initialize(options = nil) ⇒ Generator

Returns a new instance of Generator.



3
4
5
 
# File 'lib/github_changelog_generator/generator.rb', line 3

def initialize(options = nil)
  @options = options
end

Instance Method Details

#encapsulate_string(string) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/github_changelog_generator/generator.rb', line 31

def encapsulate_string(string)
  string.gsub! '\\', '\\\\'

  encpas_chars = %w(> * _ \( \) [ ] #)
  encpas_chars.each do |char|
    string.gsub! char, "\\#{char}"
  end

  string
end

#get_string_for_issue(issue) ⇒ String

Parse issue and generate single line formatted issue line.

Example output:

Parameters:

  • issue (Hash) —

    Fetched issue from GitHub

Returns:

  • (String) —

    Markdown-formatted single issue



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/github_changelog_generator/generator.rb', line 14

def get_string_for_issue(issue)
  encapsulated_title = encapsulate_string issue[:title]

  title_with_number = "#{encapsulated_title} [\\##{issue[:number]}](#{issue.html_url})"

  unless issue.pull_request.nil?
    if @options[:author]
      if issue.user.nil?
        title_with_number += " ({Null user})"
      else
        title_with_number += " ([#{issue.user.}](#{issue.user.html_url}))"
      end
    end
  end
  title_with_number
end