github_changelog_generator 1.3.11 → 1.4.0

data/Gemfile

@@ -1,4 +1,14 @@
-source 'https://rubygems.org'
-gem 'github_api'
-gem 'colorize'
-gem 'rake'
+source "https://rubygems.org"
+
+gem "rake"
+
+gem "github_api"
+gem "colorize"
+
+group :test do
+  gem "rspec"
+  gem "rubocop"
+  gem "coveralls", require: false
+  gem "simplecov", require: false
+  gem "codeclimate-test-reporter"
+end

data/Gemfile.lock

@@ -1,13 +1,28 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.6)
-    colorize (0.7.4)
+    addressable (2.3.7)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    colorize (0.7.5)
+    coveralls (0.7.12)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    faraday (0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.23)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    github_api (0.12.2)
+    github_api (0.12.3)
       addressable (~> 2.3)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
@@ -15,13 +30,17 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.3.2)
-    jwt (1.2.0)
-    mini_portile (0.6.1)
-    multi_json (1.10.1)
+    hashie (3.4.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    jwt (1.4.1)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    multi_json (1.11.0)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.5)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
@@ -29,14 +48,59 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    rack (1.5.2)
+    parser (2.2.0.3)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.0)
+    rack (1.6.0)
+    rainbow (2.0.0)
     rake (10.4.2)
-    thread_safe (0.3.4)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubocop (0.29.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.3.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter
   colorize
+  coveralls
   github_api
   rake
+  rspec
+  rubocop
+  simplecov

data/README.md

@@ -1,5 +1,9 @@
 [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![Dependency Status](https://gemnasium.com/skywinder/github-changelog-generator.svg)](https://gemnasium.com/skywinder/github-changelog-generator)
 [![Build Status](https://travis-ci.org/skywinder/github-changelog-generator.svg?branch=master)](https://travis-ci.org/skywinder/github-changelog-generator)
+[![Inline docs](http://inch-ci.org/github/skywinder/github-changelog-generator.svg)](http://inch-ci.org/github/skywinder/github-changelog-generator)
+[![Code Climate](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/gpa.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
+[![Test Coverage](https://codeclimate.com/github/skywinder/github-changelog-generator/badges/coverage.svg)](https://codeclimate.com/github/skywinder/github-changelog-generator)
 
 GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)
 ==================
@@ -96,6 +100,7 @@ Type `github_changelog_generator --help` for detailed usage.
         --[no-]compare-link          Include compare link between older version and newer version. Default is true
         --include-labels  x,y,z      Issues only with that labels will be included to changelog. Default is 'bug,enhancement'
         --exclude-labels  x,y,z      Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
+        --max-issues [NUMBER]        Max number of issues to fetch from GitHub. Default is unlimited.
         --github-site [URL]          The Enterprise Github site on which your project is hosted.
         --github-api [URL]           The enterprise endpoint to use for your Github API.
     -v, --version                    Print version number
@@ -106,7 +111,7 @@ Type `github_changelog_generator --help` for detailed usage.
 
 Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
 
-**You can easily [generate it here](https://github.com/settings/applications)**.
+**You can easily [generate it here](https://github.com/settings/tokens)**.
 
 And:
 
@@ -151,6 +156,8 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
 ### Projects using this library
 [Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
 
+If you've used this project in a live app, please let me know! Nothing makes me happier than seeing someone else take my work and go wild with it.
+
 *If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
 
 ## Am I missing some essential feature?
@@ -186,6 +193,15 @@ I think, that GitHub Releases is more for end-users.
 But `CHANGELOG.md` could stay in the repo for developers with detailed list of changes.
 And it's nothing bad to combine GitHub Releases and `CHANGELOG.md` file together in that manner.
 
+- ***I received a warning: GitHub API rate limit exceed, what does this mean?***
+
+GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.
+
+If you're seeing this warning:
+
+1. Make sure you're providing an OAuth token so you're not anonymously making requests. This will increase the number of requests from 60 to 5000 per hour.
+2. You probably have a large repo with lots of issues/PRs. You can use the `--max-issues NUM` argument to limit the number of issues that are pulled back. For example: `--max-issues 1000`
+
 ## Contributing
 
 1. Create an issue to discuss about your idea

data/Rakefile

@@ -1,9 +1,7 @@
-require "rake/testtask"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
 
-task :default => [:test]
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:rspec)
 
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.libs.push("demo", "test")
-  t.pattern = "test/**/*_test.rb"
-end
+task default: [:rubocop, :rspec]

data/bin/github_changelog_generator

@@ -1,4 +1,4 @@
 #! /usr/bin/env ruby
 
-require 'github_changelog_generator'
-GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
+require_relative "../lib/github_changelog_generator"
+GitHubChangelogGenerator::ChangelogGenerator.new.compound_changelog

data/bump_gemfile.rb

@@ -1,30 +1,30 @@
 #!/usr/bin/env ruby
-require 'optparse'
+require "optparse"
 
-SPEC_TYPE = 'gemspec'
+SPEC_TYPE = "gemspec"
 
 :major
 :minor
 :patch
 
-@options = {:dry_run => false, :bump_number => :patch}
+@options = { dry_run: false, bump_number: :patch }
 
 OptionParser.new { |opts|
-  opts.banner = 'Usage: bump.rb [options]'
+  opts.banner = "Usage: bump.rb [options]"
 
-  opts.on('-d', '--dry-run', 'Dry run') do |v|
+  opts.on("-d", "--dry-run", "Dry run") do |v|
     @options[:dry_run] = v
   end
-  opts.on('-a', '--major', 'Bump major version') do |v|
+  opts.on("-a", "--major", "Bump major version") do |_v|
     @options[:bump_number] = :major
   end
-  opts.on('-m', '--minor', 'Bump minor version') do |v|
+  opts.on("-m", "--minor", "Bump minor version") do |_v|
     @options[:bump_number] = :minor
   end
-  opts.on('-p', '--patch', 'Bump patch version') do |v|
+  opts.on("-p", "--patch", "Bump patch version") do |_v|
     @options[:bump_number] = :patch
   end
-  opts.on('-r', '--revert', 'Revert last bump') do |v|
+  opts.on("-r", "--revert", "Revert last bump") do |v|
     @options[:revert] = v
   end
 }.parse!
@@ -32,26 +32,25 @@ OptionParser.new { |opts|
 p @options
 
 def check_repo_is_clean_or_dry_run
-  value =%x[#{'git status --porcelain'}]
+  value = `#{"git status --porcelain"}`
 
   if value.empty?
-    puts 'Repo is clean -> continue'
+    puts "Repo is clean -> continue"
   else
     if @options[:dry_run]
       puts 'Repo not clean, "Dry run" enabled -> continue'
     else
-      puts 'Repository not clean -> exit'
+      puts "Repository not clean -> exit"
       exit
     end
   end
 end
 
-
 def find_spec_file
   list_of_specs = execute_line("find . -name '*.#{SPEC_TYPE}'")
   arr = list_of_specs.split("\n")
 
-  spec_file = ''
+  spec_file = ""
 
   case arr.count
     when 0
@@ -60,26 +59,25 @@ def find_spec_file
     when 1
       spec_file = arr[0]
     else
-      puts 'Which spec should be used?'
-      arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
+      puts "Which spec should be used?"
+      arr.each_with_index { |file, index| puts "#{index + 1}. #{file}" }
       input_index = Integer(gets.chomp)
-      spec_file = arr[input_index-1]
+      spec_file = arr[input_index - 1]
   end
 
-  if spec_file == nil
+  if spec_file.nil?
     puts "Can't find specified spec file -> exit"
     exit
   end
 
-  spec_file.sub('./', '')
-
+  spec_file.sub("./", "")
 end
 
 def find_current_gem_file
   list_of_specs = execute_line("find . -name '*.gem'")
   arr = list_of_specs.split("\n")
 
-  spec_file = ''
+  spec_file = ""
 
   case arr.count
     when 0
@@ -88,41 +86,40 @@ def find_current_gem_file
     when 1
       spec_file = arr[0]
     else
-      puts 'Which spec should be used?'
-      arr.each_with_index { |file, index| puts "#{index+1}. #{file}" }
+      puts "Which spec should be used?"
+      arr.each_with_index { |file, index| puts "#{index + 1}. #{file}" }
       input_index = Integer(gets.chomp)
-      spec_file = arr[input_index-1]
+      spec_file = arr[input_index - 1]
   end
 
-  if spec_file == nil
+  if spec_file.nil?
     puts "Can't find specified spec file -> exit"
     exit
   end
 
-  spec_file.sub('./', '')
-
+  spec_file.sub("./", "")
 end
 
 def find_version_in_podspec(podspec)
   readme = File.read(podspec)
 
-  #try to find version in format 1.22.333
+  # try to find version in format 1.22.333
   re = /(\d+)\.(\d+)\.(\d+)/m
 
   match_result = re.match(readme)
 
   unless match_result
-    puts 'Not found any versions'
+    puts "Not found any versions"
     exit
   end
 
   puts "Found version #{match_result[0]}"
-  return match_result[0], match_result.captures
+  [match_result[0], match_result.captures]
 end
 
 def bump_version(versions_array)
   bumped_result = versions_array.dup
-  bumped_result.map! { |x| x.to_i }
+  bumped_result.map!(&:to_i)
 
   case @options[:bump_number]
     when :major
@@ -135,11 +132,10 @@ def bump_version(versions_array)
     when :patch
       bumped_result[2] += 1
     else
-      raise('unknown bump_number')
+      fail("unknown bump_number")
   end
 
-
-  bumped_version = bumped_result.join('.')
+  bumped_version = bumped_result.join(".")
   puts "Bump version: #{versions_array.join('.')} -> #{bumped_version}"
   bumped_version
 end
@@ -157,7 +153,7 @@ def execute_line_if_not_dry_run(line)
     nil
   else
     puts line
-    value = %x[#{line}]
+    value = `#{line}`
     puts value
     check_exit_status(value)
     value
@@ -165,24 +161,23 @@ def execute_line_if_not_dry_run(line)
 end
 
 def check_exit_status(output)
-  if $?.exitstatus != 0
-    puts "Output:\n#{output}\nExit status = #{$?.exitstatus} ->Terminate script."
+  if $CHILD_STATUS.exitstatus != 0
+    puts "Output:\n#{output}\nExit status = #{$CHILD_STATUS.exitstatus} ->Terminate script."
     exit
   end
 end
 
 def run_bumping_script
-
   check_repo_is_clean_or_dry_run
   spec_file = find_spec_file
   result, versions_array = find_version_in_podspec(spec_file)
   bumped_version = bump_version(versions_array)
 
   unless @options[:dry_run]
-    puts 'Are you sure? Press Y to continue:'
+    puts "Are you sure? Press Y to continue:"
     str = gets.chomp
-    if str != 'Y'
-      puts '-> exit'
+    if str != "Y"
+      puts "-> exit"
       exit
     end
   end
@@ -191,14 +186,13 @@ def run_bumping_script
   execute_line_if_not_dry_run("sed -i \"\" \"s/#{result}/#{bumped_version}/\" #{spec_file}")
   execute_line_if_not_dry_run("git commit --all -m \"Update #{$SPEC_TYPE} to version #{bumped_version}\"")
   execute_line_if_not_dry_run("git tag #{bumped_version}")
-  execute_line_if_not_dry_run('git push')
-  execute_line_if_not_dry_run('git push --tags')
+  execute_line_if_not_dry_run("git push")
+  execute_line_if_not_dry_run("git push --tags")
   execute_line_if_not_dry_run("gem build #{spec_file}")
 
   gem = find_current_gem_file
   execute_line_if_not_dry_run("gem push #{gem}")
   # execute_line_if_not_dry_run("pod trunk push #{spec_file}")
-
 end
 
 def revert_last_bump
@@ -207,16 +201,16 @@ def revert_last_bump
 
   puts "DELETE tag #{result} and HARD reset HEAD~1?\nPress Y to continue:"
   str = gets.chomp
-  if str != 'Y'
-    puts '-> exit'
+  if str != "Y"
+    puts "-> exit"
     exit
   end
   execute_line_if_not_dry_run("git tag -d #{result}")
-  execute_line_if_not_dry_run('git reset --hard HEAD~1')
+  execute_line_if_not_dry_run("git reset --hard HEAD~1")
   execute_line_if_not_dry_run("git push --delete origin #{result}")
 end
 
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
 
   if @options[:revert]
     revert_last_bump