github_changelog_generator 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 252bfdf546f6b2c416fcf8b85dd231fb96417153
-  data.tar.gz: ff44c3c803bfd6609e2728d9e96d68fae222a88e
+  metadata.gz: 8155f1e7ea3677c3d367f637a07fb6de0cea418d
+  data.tar.gz: 4e2f2af6c503c0900dab6b473f03aaecaa23fa4a
 SHA512:
-  metadata.gz: 0b67d7a6b43035f09de7d98886df5bd8e48243d9135b370811fd3c9679ff171937d6c3e2916673690c5b9b1036b3a7b9bb2157d0a9ecc7e5aed400ec510b6a25
-  data.tar.gz: 4054d1d2c7e3f60947b9a783a9f73d7125f8dc5498cb440341a213869750dabd572a03bc50a18f09c019ea38696d65f788009e9b37054356ff20a134c58ed323
+  metadata.gz: 17d13e3e44f54241ced0f06c58b2f5fbfa24235a3e5c104c218157c15b063edabd84a39b096e6714a5cef539e733882170866364754d251d21fd570a211dacc6
+  data.tar.gz: fb0c0aa4a2173ad2b6137626270b25d2fe91821099b6f0f60fdd494ac58e627e54f27970afc9946b128eb0cb0e442b79e35a410235f43707a7d43a93a4f39790

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+before_install:
+  - gem update --system
+  - gem --version
+rvm:
+  - 2.1.0
+gemfile:
+  - Gemfile
+
+notifications:
+  email:
+    recipients:
+      - sky4winder+githubchangeloggenerator@gmail.com
+    on_success: never # [always|never|change]
+    on_failure: change # [always|never|change]

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.2.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1)
+#### 22/11/14
+- *Merged pull-request:* Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
+
 ## [1.2.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0)
 #### 19/11/14
 - *Merged pull-request:* Add filter for pull-requests labels. (option --filter-pull-requests) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))

data/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 gem 'github_api'
-gem 'colorize'
+gem 'colorize'
+gem 'rake'

data/Gemfile.lock

@@ -30,6 +30,7 @@ GEM
       multi_xml (~> 0.5)
       rack (~> 1.2)
     rack (1.5.2)
+    rake (10.4.2)
     thread_safe (0.3.4)
 
 PLATFORMS
@@ -38,3 +39,4 @@ PLATFORMS
 DEPENDENCIES
   colorize
   github_api
+  rake

data/README.md

@@ -2,6 +2,7 @@ GitHub Changelog Generator
 ==================
 
 [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/skywinder/Github-Changelog-Generator)
 
 Changelog generation has never been so easy.
 
@@ -15,17 +16,17 @@ You're almost done!
 ## Usage
 **It's really simple**: 
 
-- `cd` to your Project folder with configured git and just type:
+- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder  just run:
 
 		github_changelog_generator
 
-- from anywhere:
+-  or from anywhere:
 
 		github_changelog_generator -u github-username -p github-project
      
 As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
 
-## Params:
+### Params:
 Type `github_changelog_generator --help` for detailed usage.
 
     Usage: changelog_generator [options]
@@ -44,22 +45,16 @@ Type `github_changelog_generator --help` for detailed usage.
             --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:
-
-- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for **this** project
-- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
-
-		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
 
+### GitHub token
 
-## FAQ:
 Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
 
 **You can easily [generate it here](https://github.com/settings/applications)**.
 
 And:
 
-- Run with key `-t [your-16-digit-token]` that 
+- Run with key `-t [your-16-digit-token]` 
 - Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
  		
 	i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string `export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'`
@@ -69,6 +64,19 @@ So, if you got error like this:
 
 It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
 
+## Examples:
+
+- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for **this** project
+- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
+
+		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+
+
+## Projects using this library
+[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
+
+*If you are using `github_changelog_generator` for generation chamgelog in your project or know of 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 missed some essential feature?
 
 **Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
@@ -87,3 +95,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
 ## License
 
 Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/skywinder/github-changelog-generator/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.libs.push("demo", "test")
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/github_changelog_generator.rb

@@ -4,6 +4,7 @@ require 'github_api'
 require 'json'
 require 'colorize'
 require_relative 'github_changelog_generator/parser'
+require_relative 'github_changelog_generator/generator'
 require_relative 'github_changelog_generator/version'
 
 module GitHubChangelogGenerator
@@ -29,6 +30,8 @@ module GitHubChangelogGenerator
         @github = Github.new oauth_token: @github_token
       end
 
+      @generator = Generator.new(@options)
+
       @all_tags = self.get_all_tags
       @pull_requests = self.get_all_closed_pull_requests
       if @options[:issues]
@@ -111,7 +114,6 @@ module GitHubChangelogGenerator
       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 = []
@@ -140,7 +142,7 @@ module GitHubChangelogGenerator
       output_filename = "#{@options[:output]}"
       File.open(output_filename, 'w') { |file| file.write(log) }
 
-      puts "Done! Generated log placed in #{output_filename}"
+      puts "Done! Generated log placed in #{`pwd`.strip!}/#{output_filename}"
 
     end
 
@@ -159,11 +161,11 @@ module GitHubChangelogGenerator
         puts "Generating log.."
       end
 
-      for index in 1 ... self.all_tags.size
+      (1 ... self.all_tags.size).each { |index|
         log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
-      end
+      }
 
-      log += self.generate_log_before_tag(self.all_tags.last)
+      log += generate_log_between_tags(nil, self.all_tags.last)
 
       log
     end
@@ -216,14 +218,14 @@ module GitHubChangelogGenerator
 
       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)
+        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)
-        issues = delete_by_time(@issues, :closed_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, issues, newer_tag_name, newer_tag_time)
+      self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time)
 
     end
 
@@ -241,7 +243,7 @@ module GitHubChangelogGenerator
           tag_in_range_new = t <= newer_tag_time
 
           tag_in_range = (tag_in_range_old) && (tag_in_range_new)
-          
+
           tag_in_range
         else
           false
@@ -249,15 +251,15 @@ module GitHubChangelogGenerator
       }
     end
 
-    def generate_log_before_tag(tag)
-      generate_log_between_tags(nil, tag)
-    end
-
+# @param [Array] pull_requests
+# @param [Array] issues
+# @param [String] tag_name
+# @param [String] tag_time
+# @return [String]
     def create_log(pull_requests, issues, tag_name, tag_time)
 
       # Generate tag name and link
-      trimmed_tag = tag_name.tr('v', '')
-      log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
+      log = "## [#{tag_name}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
 
       #Generate date string:
       time_string = tag_time.strftime @options[:format]
@@ -265,20 +267,11 @@ module GitHubChangelogGenerator
 
       if @options[:pulls]
         # Generate pull requests:
-        if pull_requests
-          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
+        pull_requests.each { |pull_request|
+          merge = @generator.get_string_for_pull_request(pull_request)
+          log += "- #{merge}"
 
-        end
+        } if pull_requests
       end
 
       if @options[:issues]
@@ -321,7 +314,9 @@ module GitHubChangelogGenerator
             intro = 'Implemented enhancement'
           end
 
-          merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
+          enc_string = @generator.encapsulate_string dict[:title]
+
+          merge = "*#{intro}:* #{enc_string} [\\##{dict[:number]}](#{dict.html_url})\n\n"
           log += "- #{merge}"
         }
       end

data/lib/github_changelog_generator/generator.rb

@@ -0,0 +1,34 @@
+module GitHubChangelogGenerator
+  class Generator
+
+    def initialize(options = nil)
+      @options = options
+    end
+
+    def get_string_for_pull_request(pull_request)
+      encapsulated_title = self.encapsulate_string pull_request[:title]
+
+      merge = "#{@options[:merge_prefix]}#{encapsulated_title} [\\##{pull_request[:number]}](#{pull_request.html_url})"
+      if @options[:author]
+        merge += " ([#{pull_request.user.login}](#{pull_request.user.html_url}))\n\n"
+      else
+        merge += "\n\n"
+      end
+      merge
+    end
+
+    def encapsulate_string(string)
+
+      string.gsub! '\\', '\\\\'
+
+      encpas_chars = %w(> * _ \( \) [ ])
+      encpas_chars.each{ |char|
+        string.gsub! char, "\\#{char}"
+      }
+
+      string
+    end
+
+  end
+
+end

data/lib/github_changelog_generator/parser.rb

@@ -16,12 +16,14 @@ module GitHubChangelogGenerator
         opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
           options[:project] = last
         end
-        opts.on('-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') do |last|
+        opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
           options[:token] = last
         end
-        opts.on('-h', '--help', 'Displays Help') do
-          puts opts
-          exit
+        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('--[no-]verbose', 'Run verbosely. Default is true') do |v|
           options[:verbose] = v
@@ -35,28 +37,23 @@ module GitHubChangelogGenerator
         opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
           options[:pulls] = v
         end
-        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, '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.') do |list|
+        opts.on('--labels-pr x,y,z', Array, 'Only pull requests with specified labels will be included to changelog. Default is nil') do |list|
           options[:pull_request_labels] = list
         end
         opts.on('-v', '--version', 'Print version number') do |v|
           puts "Version: #{GitHubChangelogGenerator::VERSION}"
           exit
         end
+        opts.on('-h', '--help', 'Displays Help') do
+          puts opts
+          exit
+        end
       }
 
       parser.parse!

data/lib/github_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitHubChangelogGenerator
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Petr Korolev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,14 +74,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
+- Rakefile
 - bin/github_changelog_generator
 - bump_gemfile.rb
 - github_changelog_generator.gemspec
 - lib/github_changelog_generator.rb
+- lib/github_changelog_generator/generator.rb
 - lib/github_changelog_generator/parser.rb
 - lib/github_changelog_generator/version.rb
 homepage: https://github.com/skywinder/Github-Changelog-Generator
@@ -104,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Script, that automatically generate change-log from your tags and pull-requests.