github_changelog_generator 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc28a7bacd92b9bd2e5abdef760d348fc711540c
-  data.tar.gz: fb8856f86cd8e9988481f407b667f22209307563
+  metadata.gz: 04d90423721767edc0514ae6301fb296e3dacca8
+  data.tar.gz: 2ab86b4d1d8fc0ab004eafc26ffede1a6bd0e08a
 SHA512:
-  metadata.gz: 0e0d0694c082fc9f51f47f30baa3d1f1572ecbf20d773564c1e8fd22fb9f31f421fd60c76f695502082c258193716689e904cc762cb5f1eefea214a62233073e
-  data.tar.gz: d1a2a0aef52861f68563d3fec4fca64e46b5f794a09669cfdc49fbfc0336f763e61ad1d0676291a9f218834bf4bbcf27e237902129adb2947c209447743a1606
+  metadata.gz: bcc94ae00a530a5202704fc94ed76b8118234d1b1a45b6a78f928470bdb49e3f6cd9d38dc6af6e2a4cc5d63cc92df4041fcf769c6febc8f306d23036d1b50381
+  data.tar.gz: e5a2346e221265eb2e620d2a3224f3a6a584c80d49392711b8ee3aebafdec166bdeda33d5ae19efdefd0d9ec19fafbb226784788cad82f67f4da53a2b5b5c38e

data/CHANGELOG.md

@@ -1,10 +1,10 @@
 # Changelog
 
-## [1.1.3] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.3)
+## [1.1.4] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4)
 #### 18/11/14
 - *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23)
 
-- *Implemented enhancement:* Implement ability to retrieve GitHub token from some shell variable (to not put it to script directly) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
+- *Implemented enhancement:* Implement ability to retrieve GitHub token from ENV variable (to not put it to script directly) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
 
 - *Fixed bug:* Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
 

data/README.md

@@ -27,18 +27,20 @@ As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* chan
 Type `github_changelog_generator --help` for detailed usage.
 
     Usage: changelog_generator [options]
-    -u, --user [USER]                Username of the owner of target GitHub repo
-    -p, --project [PROJECT]          Name of project on GitHub
-    -t, --token [TOKEN]              To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-    -h, --help                       Displays Help
-    -v, --[no-]verbose               Run verbosely. Default is true
-        --[no-]issues                Include closed issues to changelog. Default is true
-        --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
-        --[no-]pull-requests         Include pull-requests to changelog. Default is true
-    -l, --last-changes               Generate log between last 2 tags only
-    -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
-    -o, --output [NAME]              Output file. Default is CHANGELOG.md
-        --labels  x,y,z              List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
+        -u, --user [USER]                Username of the owner of target GitHub repo
+        -p, --project [PROJECT]          Name of project on GitHub
+        -t, --token [TOKEN]              To make more than 50 requests this script required your OAuth token for GitHub. You can generate here: https://github.com/settings/tokens/new
+        -h, --help                       Displays Help
+            --[no-]verbose               Run verbosely. Default is true
+            --[no-]issues                Include closed issues to changelog. Default is true
+            --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
+            --[no-]pull-requests         Include pull-requests to changelog. Default is true
+        -l, --last-changes               Generate log between last 2 tags only
+            --[no-]author                Add author of pull-request in the end. Default is true
+        -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
+        -o, --output [NAME]              Output file. Default is CHANGELOG.md
+            --labels  x,y,z              List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
+        -v, --version                    Print version number
 
 ## Examples:
 

data/lib/github_changelog_generator.rb

@@ -25,7 +25,11 @@ module GitHubChangelogGenerator
 
       @all_tags = self.get_all_tags
       @pull_requests = self.get_all_closed_pull_requests
-      @issues = self.get_all_issues
+      if @options[:issues]
+        @issues = self.get_all_issues
+      else
+        @issues = []
+      end
 
       @tag_times_hash = {}
     end
@@ -41,6 +45,11 @@ module GitHubChangelogGenerator
 
 
     def get_all_closed_pull_requests
+
+      if @options[:verbose]
+        puts 'Fetching pull requests..'
+      end
+
       response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
 
       pull_requests = []
@@ -49,9 +58,39 @@ module GitHubChangelogGenerator
       end
 
       if @options[:verbose]
-        puts "Receive all pull requests: #{pull_requests.count}"
+        puts "Received all 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
 
@@ -128,11 +167,8 @@ module GitHubChangelogGenerator
 
     def get_all_tags
 
-      url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
-
       if @options[:verbose]
-
-        puts "Receive tags for repo #{url}"
+        puts 'Fetching all tags..'
       end
 
       response = @github.repos.tags @options[:user], @options[:project]
@@ -167,83 +203,47 @@ module GitHubChangelogGenerator
 
 
     def generate_log_between_tags(older_tag, newer_tag)
-      older_tag_time = self.get_time_of_tag(older_tag)
-      newer_tag_time = self.get_time_of_tag(newer_tag)
-
-      # if we mix up tags order - lits fix it!
-      # if older_tag_time < newer_tag_time
-      #   older_tag, newer_tag = newer_tag, older_tag
-      #   older_tag_time, newer_tag_time = newer_tag_time, older_tag_time
-      #   puts "Swap tags!"
-      # end
 
+      newer_tag_time = self.get_time_of_tag(newer_tag)
       newer_tag_name = newer_tag['name']
 
-      pull_requests = Array.new(@pull_requests)
+      if older_tag.nil?
+        filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
+        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)
+        issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
+      end
 
-      pull_requests.delete_if { |req|
-        if req[:merged_at]
-          t = Time.parse(req[:merged_at]).utc
-          tag_is_older_of_older = t > older_tag_time
-          tag_is_newer_than_new = t <= newer_tag_time
+      self.create_log(filtered_pull_requests, issues, newer_tag_name, newer_tag_time)
 
-          tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
-          !tag_not_in_range
-        else
-          true
-        end
+    end
 
-      }
+    def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
+      array_new = Array.new(array)
+      array_new.delete_if { |req|
+        if req[hash_key]
+          t = Time.parse(req[hash_key]).utc
 
-      issues = Array.new(@issues)
+          if older_tag_time.nil?
+            tag_is_older_of_older = false
+          else
+            tag_is_older_of_older = t > older_tag_time
+          end
 
-      issues.delete_if { |issue|
-        if issue[:closed_at]
-          t = Time.parse(issue[:closed_at]).utc
-          tag_is_later_since = t > older_tag_time
-          tag_is_before_till = t <= newer_tag_time
+          tag_is_newer_than_new = t <= newer_tag_time
 
-          in_range = (tag_is_later_since) && (tag_is_before_till)
-          !in_range
+          tag_not_in_range = (tag_is_older_of_older) && (tag_is_newer_than_new)
+          !tag_not_in_range
         else
           true
         end
-
       }
-
-      self.create_log(pull_requests, issues, newer_tag_name, newer_tag_time)
-
     end
 
     def generate_log_before_tag(tag)
-      tag_time = self.get_time_of_tag(tag)
-      tag_name = tag['name']
-
-      pull_requests = Array.new(@pull_requests)
-
-      pull_requests.delete_if { |req|
-        if req[:merged_at]
-          t = Time.parse(req[:merged_at]).utc
-          t > tag_time
-        else
-          true
-        end
-
-      }
-
-      issues = Array.new(@issues)
-
-      issues.delete_if { |issue|
-        if issue[:closed_at]
-          t = Time.parse(issue[:closed_at]).utc
-          t > tag_time
-        else
-          true
-        end
-      }
-
-      self.create_log(pull_requests, issues, tag_name, tag_time)
-
+      generate_log_between_tags(nil, tag)
     end
 
     def create_log(pull_requests, issues, tag_name, tag_time)
@@ -259,10 +259,18 @@ module GitHubChangelogGenerator
       if @options[:pulls]
         # Generate pull requests:
         if pull_requests
-          pull_requests.each { |dict|
-            merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
-            log += "- #{merge}"
-          }
+          if @options[:author]
+            pull_requests.each { |dict|
+              merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url}) ([#{dict.user.login}](#{dict.user.html_url}))\n\n"
+              log += "- #{merge}"
+            }
+          else
+            pull_requests.each { |dict|
+              merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
+              log += "- #{merge}"
+            }
+          end
+
         end
       end
 
@@ -330,6 +338,11 @@ module GitHubChangelogGenerator
     end
 
     def get_all_issues
+
+      if @options[:verbose]
+        puts 'Fetching closed issues..'
+      end
+
       response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
 
 
@@ -344,7 +357,7 @@ module GitHubChangelogGenerator
       }
 
       if @options[:verbose]
-        puts "Receive all closed issues: #{issues.count}"
+        puts "Received closed issues: #{issues.count}"
       end
 
       filtered_issues = issues.select { |issue|

data/lib/github_changelog_generator/parser.rb

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
 require 'optparse'
+require 'PP'
 require_relative 'version'
 
 module GitHubChangelogGenerator
   class Parser
     def self.parse_options
-      options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* '}
+      options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ', :author => true, :pull_request_labels => %w(bug enhancement)}
 
       parser = OptionParser.new { |opts|
         opts.banner = 'Usage: changelog_generator [options]'
@@ -37,15 +38,21 @@ module GitHubChangelogGenerator
         opts.on('-l', '--last-changes', 'Generate log between last 2 tags only') do |last|
           options[:last] = last
         end
+        opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
+          options[:last] = author
+        end
         opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
           options[:format] = last
         end
         opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
           options[:output] = last
         end
-        opts.on('--labels  x,y,z', Array, 'List of labels. Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
+        opts.on('--labels  x,y,z', Array, 'Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
           options[:labels] = list
         end
+        opts.on('--filter-pull-requests  x,y,z', Array, 'Pull requests with that labels will be included to changelog. pull requests w\o labels will be included anyway.  Default is \'bug,enhancement\'') do |list|
+          options[:pull_request_labels] = list
+        end
         opts.on('-v', '--version', 'Print version number') do |v|
           puts "Version: #{GitHubChangelogGenerator::VERSION}"
           exit
@@ -54,6 +61,12 @@ module GitHubChangelogGenerator
 
       parser.parse!
 
+      if options[:verbose]
+        puts 'Input options:'
+        pp options
+        puts ''
+      end
+
       #udefined case with 1 parameter:
       if ARGV[0] && !ARGV[1]
         puts parser.banner

data/lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = '1.1.4'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Petr Korolev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler