Class: ChangesSince::ChangelogPrinter

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

Constant Summary collapse

TAGS = 
{
  :public   => 'Public',
  :bug      => 'Bugs',
  :internal => 'Internal'
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(commits, teams, options, repo) ⇒ ChangelogPrinter

Returns a new instance of ChangelogPrinter.



11
12
13
14
15
16
 
# File 'lib/changes_since/changelog_printer.rb', line 11

def initialize(commits, teams, options, repo)
  @commits = commits
  @teams   = teams
  @options = options
  @repo    = repo
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



3
4
5
 
# File 'lib/changes_since/changelog_printer.rb', line 3

def options
  @options
end

#repo ⇒ Object (readonly)

Returns the value of attribute repo.



3
4
5
 
# File 'lib/changes_since/changelog_printer.rb', line 3

def repo
  @repo
end

#teams ⇒ Object (readonly)

Returns the value of attribute teams.



3
4
5
 
# File 'lib/changes_since/changelog_printer.rb', line 3

def teams
  @teams
end

Instance Method Details

#print! ⇒ Object 



18
19
20
21
22
23
24
25
 
# File 'lib/changes_since/changelog_printer.rb', line 18

def print!
  if teams
    print_team_commits!
  else
    print_commits!(@commits)
  end
  return
end

#print_commits!(output_commits) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/changes_since/changelog_printer.rb', line 57

def print_commits!(output_commits)
  output_commits.sort! { |a, b| a.author.name <=> b.author.name }

  if options[:tags]
    TAGS.each do |type, title|
      tagged_commits = output_commits.select { |commit| commit.message.include?("##{type}") }
      next if tagged_commits.empty?

      puts "\n#{title}:\n\n"
      tagged_commits.each { |commit| print_message(commit, type) }
      output_commits -= tagged_commits
    end
    return if output_commits.empty?
    puts "\nUnclassified:\n\n"
  end

  output_commits.each { |commit| print_message(commit) }
end

#print_message(commit, tag = nil) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/changes_since/changelog_printer.rb', line 76

def print_message(commit, tag=nil)
  message_lines = commit.message.split("\n\n")
  if message_lines.first =~ /Merge pull request/
    title = message_lines.last
    pr    = message_lines.first.split(" from ").first.split("#").last
  else
    title = message_lines.first
    sha   = options[:sha] ? commit.sha[0..9] : ''
  end
  title.gsub!("##{tag}", "") if tag
  branch_author = commit.author.name
  if options[:markdown]
    text = "|#{title}|"
    text << "#{branch_author}|"
    text << "[##{pr}|#{@repo}/pull/#{pr}]|" if @repo && pr
    text << "[#{sha}|#{@repo}/commit/#{sha}]|" if sha
    text << "|" if options[:risks]
  else
    text = "* #{title} (#{branch_author})"
  end
  puts text
end

#print_team_commits! ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/changes_since/changelog_printer.rb', line 27

def print_team_commits!
  teams.each do |team, members|
    author_re = /#{members.join("|")}/i
    team_commits = @commits.select do |commit|
      [commit.author.name, commit.author.email].any? do |str|
        str =~ author_re
      end
    end
    next if team_commits.empty?
    @commits -= team_commits
    print_team_name(team)
    print_commits!(team_commits)
  end

  return if @commits.empty?
  print_team_name("Other")
  print_commits!(@commits)
end

#print_team_name(name) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/changes_since/changelog_printer.rb', line 46

def print_team_name(name)
  if options[:markdown]
    row = "||*#{name}*||Author||PR||"
    row << "Commit||" if options[:sha]
    row << "Risks||" if options[:risks]
    puts row
  else
    puts "\n*#{name}*\n"
  end
end