Class: ChangelogGenerator::Generator

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user, repo, from_ref, to_ref, label_filter = nil, include_pr_links = false, include_issue_links = false, formatting = "slack") ⇒ Generator 



18
19
20
21
22
23
24
25
26
27
 
# File 'lib/changelog_generator/generator.rb', line 18

def initialize(user, repo, from_ref, to_ref, label_filter = nil, include_pr_links = false, include_issue_links = false, formatting = "slack")
  self.user = user
  self.repo_name = repo
  self.from_ref = from_ref
  self.to_ref = to_ref || "now"
  self.label_filter = label_filter
  self.include_pr_links = include_pr_links
  self.include_issue_links = include_issue_links
  self.formatting = TextFormatter.text_formatter(formatting)
end

Instance Attribute Details

#formatting ⇒ Object

Returns the value of attribute formatting.



16
17
18
 
# File 'lib/changelog_generator/generator.rb', line 16

def formatting
  @formatting
end

#from_ref ⇒ Object

Returns the value of attribute from_ref.



11
12
13
 
# File 'lib/changelog_generator/generator.rb', line 11

def from_ref
  @from_ref
end

#include_issue_links ⇒ Object

Returns the value of attribute include_issue_links.



15
16
17
 
# File 'lib/changelog_generator/generator.rb', line 15

def include_issue_links
  @include_issue_links
end

#include_pr_links ⇒ Object

Returns the value of attribute include_pr_links.



14
15
16
 
# File 'lib/changelog_generator/generator.rb', line 14

def include_pr_links
  @include_pr_links
end

#label_filter ⇒ Object

Returns the value of attribute label_filter.



13
14
15
 
# File 'lib/changelog_generator/generator.rb', line 13

def label_filter
  @label_filter
end

#repo_name ⇒ Object

Returns the value of attribute repo_name.



10
11
12
 
# File 'lib/changelog_generator/generator.rb', line 10

def repo_name
  @repo_name
end

#to_ref ⇒ Object

Returns the value of attribute to_ref.



12
13
14
 
# File 'lib/changelog_generator/generator.rb', line 12

def to_ref
  @to_ref
end

#user ⇒ Object

Returns the value of attribute user.



9
10
11
 
# File 'lib/changelog_generator/generator.rb', line 9

def user
  @user
end

Instance Method Details

#changelog ⇒ Object 



37
38
39
 
# File 'lib/changelog_generator/generator.rb', line 37

def changelog
  generate_changelog(user, repo_name, from_ref, to_ref, label_filter)
end

#description ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/changelog_generator/generator.rb', line 29

def description
  description = "Changes for `#{user}/#{repo_name}` from `#{from_ref}` to `#{to_ref}`"
  if label_filter
    description << " with label `#{label_filter}`"
  end
  description
end