Class: GitHubChangelogGenerator::ChangelogGenerator

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

Constant Summary collapse

PER_PAGE_NUMBER = 
30

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ChangelogGenerator

Returns a new instance of ChangelogGenerator.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/github_changelog_generator.rb', line 19

def initialize

  @options = Parser.parse_options

  if options[:verbose]
    puts 'Input options:'
    pp options
    puts ''
  end

  github_token

  if @github_token.nil?
    @github = Github.new per_page: PER_PAGE_NUMBER
  else
    @github = Github.new oauth_token: @github_token,
                         per_page: PER_PAGE_NUMBER
  end

  @generator = Generator.new(@options)

  @all_tags = self.get_all_tags
  @pull_requests = self.get_all_closed_pull_requests
  if @options[:issues]
    @issues = self.get_all_issues
  else
    @issues = []
  end

  @tag_times_hash = {}
end

Instance Attribute Details

#all_tags ⇒ Object

Returns the value of attribute all_tags.



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

def all_tags
  @all_tags
end

#github ⇒ Object

Returns the value of attribute github.



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

def github
  @github
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

Instance Method Details

#compund_changelog ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/github_changelog_generator.rb', line 117

def compund_changelog
  if @options[:verbose]
    puts 'Generating changelog:'
  end

  log = "# Changelog\n\n"

  if @options[:last]
    log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
  elsif @options[:tag1] and @options[:tag2]
    tag1 = @options[:tag1]
    tag2 = @options[:tag2]
    tags_strings = []
    self.all_tags.each { |x| tags_strings.push(x['name']) }

    if tags_strings.include?(tag1)
      if tags_strings.include?(tag2)
        hash = Hash[tags_strings.map.with_index.to_a]
        index1 = hash[tag1]
        index2 = hash[tag2]
        log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
      else
        puts "Can't find tag #{tag2} -> exit"
        exit
      end
    else
      puts "Can't find tag #{tag1} -> exit"
      exit
    end
  else
    log += self.generate_log_for_all_tags
  end

  log += "\n\n\\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"

  output_filename = "#{@options[:output]}"
  File.open(output_filename, 'w') { |file| file.write(log) }

  puts "Done! Generated log placed in #{`pwd`.strip!}/#{output_filename}"

end

#create_log(pull_requests, issues, tag_name, tag_time) ⇒ String

Parameters:

  • pull_requests (Array)
  • issues (Array)
  • tag_name (String)
  • tag_time (String)

Returns:

  • (String) 


277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/github_changelog_generator.rb', line 277

def create_log(pull_requests, issues, tag_name, tag_time)

  # Generate tag name and link
  log = "## [#{tag_name}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"

  #Generate date string:
  time_string = tag_time.strftime @options[:format]
  log += "#### #{time_string}\n"

  if @options[:pulls]
    # Generate pull requests:
    pull_requests.each { |pull_request|
      merge = @generator.get_string_for_pull_request(pull_request)
      log += "- #{merge}"

    } if pull_requests
  end

  if @options[:issues]
    # Generate issues:
    if issues
      issues.sort! { |x, y|
        if x.labels.any? && y.labels.any?
          x.labels[0].name <=> y.labels[0].name
        else
          if x.labels.any?
            1
          else
            if y.labels.any?
              -1
            else
              0
            end
          end
        end
      }.reverse!
    end
    issues.each { |dict|
      is_bug = false
      is_enhancement = false
      dict.labels.each { |label|
        if label.name == 'bug'
          is_bug = true
        end
        if label.name == 'enhancement'
          is_enhancement = true
        end
      }

      intro = 'Closed issue'
      if is_bug
        intro = 'Fixed bug'
      end

      if is_enhancement
        intro = 'Implemented enhancement'
      end

      enc_string = @generator.encapsulate_string dict[:title]

      merge = "*#{intro}:* #{enc_string} [\\##{dict[:number]}](#{dict.html_url})\n\n"
      log += "- #{merge}"
    }
  end
  log
end

#delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/github_changelog_generator.rb', line 250

def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
  array.select { |req|
    if req[hash_key]
      t = Time.parse(req[hash_key]).utc

      if older_tag_time.nil?
        tag_in_range_old = true
      else
        tag_in_range_old = t > older_tag_time
      end

      tag_in_range_new = t <= newer_tag_time

      tag_in_range = (tag_in_range_old) && (tag_in_range_new)

      tag_in_range
    else
      false
    end
  }
end

#exec_command(cmd) ⇒ Object 



55
56
57
58
 
# File 'lib/github_changelog_generator.rb', line 55

def exec_command(cmd)
  exec_cmd = "cd #{$project_path} and #{cmd}"
  %x[#{exec_cmd}]
end

#generate_log_between_tags(older_tag, newer_tag) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/github_changelog_generator.rb', line 232

def generate_log_between_tags(older_tag, newer_tag)

  newer_tag_time = self.get_time_of_tag(newer_tag)
  newer_tag_name = newer_tag['name']

  if older_tag.nil?
    filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
    filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time)
  else
    older_tag_time = self.get_time_of_tag(older_tag)
    filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag_time)
    filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
  end

  self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time)

end

#generate_log_for_all_tags ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/github_changelog_generator.rb', line 159

def generate_log_for_all_tags
  log = ''

  # Async fetching tags:
  threads = []
  @all_tags.each { |tag|
    threads << Thread.new { self.get_time_of_tag(tag) }
  }
  threads.each { |thr| thr.join }

  if @options[:verbose]
    puts "Sorting tags.."
  end

  @all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!

  if @options[:verbose]
    puts "Generating log.."
  end

  (1 ... self.all_tags.size).each { |index|
    log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
  }

  log += generate_log_between_tags(nil, self.all_tags.last)

  log
end

#get_all_closed_pull_requests ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/github_changelog_generator.rb', line 61

def get_all_closed_pull_requests

  if @options[:verbose]
    print "Fetching pull requests...\r"
  end

  response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'

  pull_requests = []
  page_i = 0
  response.each_page do |page|
    page_i += PER_PAGE_NUMBER
    print "Fetching pull requests... #{page_i}\r"
    pull_requests.concat(page)
  end

  print "\r"

  if @options[:verbose]
    puts "Received closed pull requests: #{pull_requests.count}"
  end

  unless @options[:pull_request_labels].nil?

    if @options[:verbose]
      puts 'Filter all pull requests by labels.'
    end

    filtered_pull_requests = pull_requests.select { |pull_request|
      #We need issue to fetch labels
      issue = @github.issues.get @options[:user], @options[:project], pull_request.number
      #compare is there any labels from @options[:labels] array
      select_no_label = !issue.labels.map { |label| label.name }.any?

      if @options[:verbose]
        puts "Filter request \##{issue.number}."
      end

      if @options[:pull_request_labels].any?
        select_by_label = (issue.labels.map { |label| label.name } & @options[:pull_request_labels]).any?
      else
        select_by_label = false
      end

      select_by_label | select_no_label
    }

    if @options[:verbose]
      puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
    end
    return filtered_pull_requests
  end

  pull_requests
end

#get_all_issues ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/github_changelog_generator.rb', line 356

def get_all_issues

  if @options[:verbose]
    print "Fetching closed issues...\r"
  end

  response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil

  issues = []
  page_i = 0
  response.each_page do |page|
    page_i += PER_PAGE_NUMBER
    print "Fetching closed issues... #{page_i}\r"
    issues.concat(page)
  end

  print "\r"

  # remove pull request from issues:
  issues.select! { |x|
    x.pull_request == nil
  }

  if @options[:verbose]
    puts "Received closed issues: #{issues.count}"
  end


  if @options[:verbose]
    puts "Filtering issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}"
  end

  filtered_issues = issues.select { |issue|
    #compare is there any labels from @options[:labels] array
    (issue.labels.map { |label| label.name } & @options[:labels]).any?
  }

  if @options[:add_issues_wo_labels]
    issues_wo_labels = issues.select {
      # add issues without any labels
        |issue| !issue.labels.map { |label| label.name }.any?
    }
    filtered_issues.concat(issues_wo_labels)
  end

  if @options[:verbose]
    puts "Filtered issues: #{filtered_issues.count}"
  end

  filtered_issues

end

#get_all_tags ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/github_changelog_generator.rb', line 192

def get_all_tags

  if @options[:verbose]
    print "Fetching tags...\r"
  end

  response = @github.repos.tags @options[:user], @options[:project]

  tags = []
  page_i = 0
  response.each_page do |page|
    page_i += PER_PAGE_NUMBER
    print "Fetching tags... #{page_i}\r"
    tags.concat(page)
  end
  print "\r"
  if @options[:verbose]
    puts "Found #{tags.count} tags"
  end

  tags
end

#get_time_of_tag(prev_tag) ⇒ Object 



344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/github_changelog_generator.rb', line 344

def get_time_of_tag(prev_tag)

  if @tag_times_hash[prev_tag['name']]
    return @tag_times_hash[prev_tag['name']]
  end

  github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
  time_string = github_git_data_commits_get['committer']['date']
  Time.parse(time_string)
  @tag_times_hash[prev_tag['name']] = Time.parse(time_string)
end

#github_token ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/github_changelog_generator.rb', line 215

def github_token
  if @options[:token]
    return @github_token ||= @options[:token]
  end

  env_var = ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil

  unless env_var
    puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
    puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
  end

  @github_token ||= env_var

end

#is_megred(number) ⇒ Object 



188
189
190
 
# File 'lib/github_changelog_generator.rb', line 188

def is_megred(number)
  @github.pull_requests.merged? @options[:user], @options[:project], number
end

#print_json(json) ⇒ Object 



51
52
53
 
# File 'lib/github_changelog_generator.rb', line 51

def print_json(json)
  puts JSON.pretty_generate(json)
end