Merge branch 'feature/parse-existing-changelog-file' of https://github.com/estahn/github-changelog-generator into estahn-feature/parse-existing-changelog-file
Conflicts: Gemfile Gemfile.lock Rakefile
This commit is contained in:
Petr Korolev
commit
cc6ac05254
|
|
@ -8,6 +8,7 @@ require 'benchmark'
|
||||||
require_relative 'github_changelog_generator/parser'
|
require_relative 'github_changelog_generator/parser'
|
||||||
require_relative 'github_changelog_generator/generator'
|
require_relative 'github_changelog_generator/generator'
|
||||||
require_relative 'github_changelog_generator/version'
|
require_relative 'github_changelog_generator/version'
|
||||||
|
require_relative 'github_changelog_generator/reader'
|
||||||
|
|
||||||
module GitHubChangelogGenerator
|
module GitHubChangelogGenerator
|
||||||
class ChangelogGenerator
|
class ChangelogGenerator
|
||||||
|
|
|
||||||
87
lib/github_changelog_generator/reader.rb
Normal file
87
lib/github_changelog_generator/reader.rb
Normal file
|
|
@ -0,0 +1,87 @@
|
||||||
|
#
|
||||||
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
|
#
|
||||||
|
# Copyright 2014, Zanui, <engineering@zanui.com.au>
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
|
module GitHubChangelogGenerator
|
||||||
|
# A Reader to read an existing ChangeLog file and return a structured object
|
||||||
|
#
|
||||||
|
# Example:
|
||||||
|
# reader = GitHubChangelogGenerator::Reader.new
|
||||||
|
# content = reader.read('./CHANGELOG.md')
|
||||||
|
class Reader
|
||||||
|
def initialize(options = {})
|
||||||
|
defaults = {
|
||||||
|
heading_level: '##',
|
||||||
|
heading_structures: [
|
||||||
|
/^## \[(?<version>.+?)\]\((?<url>.+?)\)( \((?<date>.+?)\))?$/,
|
||||||
|
/^## (?<version>.+?)( \((?<date>.+?)\))?$/
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
@options = options.merge(defaults)
|
||||||
|
|
||||||
|
@heading_level = @options[:heading_level]
|
||||||
|
@heading_structures = @options[:heading_structures]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Parse a single heading and return a Hash
|
||||||
|
#
|
||||||
|
# The following heading structures are currently valid:
|
||||||
|
# - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1) (2015-03-24)
|
||||||
|
# - ## [v1.0.2](https://github.com/zanui/chef-thumbor/tree/v1.0.1)
|
||||||
|
# - ## v1.0.2 (2015-03-24)
|
||||||
|
# - ## v1.0.2
|
||||||
|
#
|
||||||
|
# @param [String] heading Heading from the ChangeLog File
|
||||||
|
# @return [Hash] Returns a structured Hash with version, url and date
|
||||||
|
def parse_heading(heading)
|
||||||
|
captures = { 'version' => nil, 'url' => nil, 'date' => nil }
|
||||||
|
|
||||||
|
@heading_structures.each do |regexp|
|
||||||
|
matches = Regexp.new(regexp).match(heading)
|
||||||
|
captures.merge!(Hash[matches.names.map.zip(matches.captures)]) unless matches.nil?
|
||||||
|
|
||||||
|
# Try Regular Expressions until you find one that delivers results
|
||||||
|
break unless matches.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
captures
|
||||||
|
end
|
||||||
|
|
||||||
|
# Parse the given ChangeLog data into a Hash
|
||||||
|
#
|
||||||
|
# @param [String] data File data from the ChangeLog.md
|
||||||
|
# @return [Hash] Parsed data, e.g. [{ 'version' => ..., 'url' => ..., 'date' => ..., 'content' => ...}, ...]
|
||||||
|
def parse(data)
|
||||||
|
sections = data.split(/^## .+?$/)
|
||||||
|
headings = data.scan(/^## .+?$/)
|
||||||
|
changelog = []
|
||||||
|
|
||||||
|
headings.each_with_index do |heading, index|
|
||||||
|
captures = parse_heading(heading)
|
||||||
|
captures['content'] = sections.at(index + 1)
|
||||||
|
changelog.push captures
|
||||||
|
end
|
||||||
|
|
||||||
|
changelog
|
||||||
|
end
|
||||||
|
|
||||||
|
def read(file_path)
|
||||||
|
parse File.read(file_path)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
9395
spec/files/angular.js.md
Normal file
9395
spec/files/angular.js.md
Normal file
File diff suppressed because it is too large
Load Diff
1911
spec/files/bundler.md
Normal file
1911
spec/files/bundler.md
Normal file
File diff suppressed because it is too large
Load Diff
305
spec/files/github-changelog-generator.md
Normal file
305
spec/files/github-changelog-generator.md
Normal file
|
|
@ -0,0 +1,305 @@
|
||||||
|
# Change Log
|
||||||
|
|
||||||
|
## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.9...1.3.10)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Exclude closed PR's from changelog. [\#69](https://github.com/skywinder/Github-Changelog-Generator/issues/69)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix termination in case of empty unreleased section with `--unreleased-only` option. [\#70](https://github.com/skywinder/Github-Changelog-Generator/pull/70) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.9](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.9) (2015-03-06)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.8...1.3.9)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Improve method of detecting owner and repository [\#63](https://github.com/skywinder/Github-Changelog-Generator/issues/63)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Resolved concurrency problem in case of issues \> 2048 [\#65](https://github.com/skywinder/Github-Changelog-Generator/pull/65) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.8) (2015-03-05)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.6...1.3.8)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix `git remote` parsing in case, when script running without parameters inside destination directory [\#61](https://github.com/skywinder/Github-Changelog-Generator/pull/61) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.3.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.6) (2015-03-05)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.5...1.3.6)
|
||||||
|
|
||||||
|
## [1.3.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.5) (2015-03-04)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.4...1.3.5)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Pull Requests in Wrong Tag [\#60](https://github.com/skywinder/Github-Changelog-Generator/issues/60)
|
||||||
|
|
||||||
|
## [1.3.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.4) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.3...1.3.4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- --no-issues appears to break PRs [\#59](https://github.com/skywinder/Github-Changelog-Generator/issues/59)
|
||||||
|
|
||||||
|
## [1.3.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.3) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.2...1.3.3)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Add \# character to encapsulate list. [\#58](https://github.com/skywinder/Github-Changelog-Generator/issues/58)
|
||||||
|
|
||||||
|
## [1.3.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.2) (2015-03-03)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.1...1.3.2)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- generation failed if github commit api return `404 Not Found` [\#57](https://github.com/skywinder/Github-Changelog-Generator/issues/57)
|
||||||
|
|
||||||
|
## [1.3.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.1) (2015-02-27)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.3.0...1.3.1)
|
||||||
|
|
||||||
|
## [1.3.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.0) (2015-02-26)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.8...1.3.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Do not show `Unreleased` section, when it's empty. [\#55](https://github.com/skywinder/Github-Changelog-Generator/issues/55)
|
||||||
|
|
||||||
|
- Separate list exclude and include labels [\#52](https://github.com/skywinder/Github-Changelog-Generator/issues/52)
|
||||||
|
|
||||||
|
- Unreleased issues in separate section [\#47](https://github.com/skywinder/Github-Changelog-Generator/issues/47)
|
||||||
|
|
||||||
|
- Separate by lists: Enhancements, Bugs, Pull requests. [\#31](https://github.com/skywinder/Github-Changelog-Generator/issues/31)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Test pull request with invalid label \(\#26\) in changelog appeared. [\#44](https://github.com/skywinder/Github-Changelog-Generator/issues/44)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement filtering of Pull Requests by milestones [\#50](https://github.com/skywinder/Github-Changelog-Generator/pull/50) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.2.8](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.8) (2015-02-17)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.7...1.2.8)
|
||||||
|
|
||||||
|
**Closed issues:**
|
||||||
|
|
||||||
|
- Bugs, that closed simultaneously with push not appeared in correct version. [\#37](https://github.com/skywinder/Github-Changelog-Generator/issues/37)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Feature/fix 37 [\#49](https://github.com/skywinder/Github-Changelog-Generator/pull/49) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Prettify output [\#48](https://github.com/skywinder/Github-Changelog-Generator/pull/48) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.2.7](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.7) (2015-01-26)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.6...1.2.7)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add compare link between older version and newer version [\#46](https://github.com/skywinder/Github-Changelog-Generator/pull/46) ([sue445](https://github.com/sue445))
|
||||||
|
|
||||||
|
## [1.2.6](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.6) (2015-01-21)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.5...1.2.6)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- fix link tag format [\#45](https://github.com/skywinder/Github-Changelog-Generator/pull/45) ([sugamasao](https://github.com/sugamasao))
|
||||||
|
|
||||||
|
## [1.2.5](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.5) (2015-01-15)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.4...1.2.5)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Use milestone to specify in which version bug was fixed [\#22](https://github.com/skywinder/Github-Changelog-Generator/issues/22)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Error when trying to generate log for repo without tags [\#32](https://github.com/skywinder/Github-Changelog-Generator/issues/32)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- PrettyPrint class is included using lowercase 'pp' [\#43](https://github.com/skywinder/Github-Changelog-Generator/pull/43) ([schwing](https://github.com/schwing))
|
||||||
|
|
||||||
|
- support enterprise github via command line options [\#42](https://github.com/skywinder/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
|
||||||
|
|
||||||
|
## [1.2.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4) (2014-12-16)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.3...1.2.4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Sometimes user is NULL during merges [\#41](https://github.com/skywinder/Github-Changelog-Generator/issues/41)
|
||||||
|
|
||||||
|
- Crash when try generate log for rails [\#35](https://github.com/skywinder/Github-Changelog-Generator/issues/35)
|
||||||
|
|
||||||
|
## [1.2.3](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3) (2014-12-16)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.2...1.2.3)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
|
||||||
|
|
||||||
|
- Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.2.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2) (2014-12-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.1...1.2.2)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
|
||||||
|
|
||||||
|
## [1.2.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1) (2014-11-22)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.2.0...1.2.1)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- 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) (2014-11-19)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.4...1.2.0)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- 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))
|
||||||
|
|
||||||
|
- Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.4](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4) (2014-11-18)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.2...1.1.4)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- 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)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.2](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2) (2014-11-12)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.1...1.1.2)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.1.0...1.1.1)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [1.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.1...1.1.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Detect username and project form origin [\#11](https://github.com/skywinder/Github-Changelog-Generator/issues/11)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Bug with wrong credentials in 1.0.1 [\#12](https://github.com/skywinder/Github-Changelog-Generator/issues/12)
|
||||||
|
|
||||||
|
- Markdown formating in the last line wrong [\#9](https://github.com/skywinder/Github-Changelog-Generator/issues/9)
|
||||||
|
|
||||||
|
## [1.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1) (2014-11-10)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/1.0.0...1.0.1)
|
||||||
|
|
||||||
|
## [1.0.0](https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0) (2014-11-07)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.1.0...1.0.0)
|
||||||
|
|
||||||
|
**Implemented enhancements:**
|
||||||
|
|
||||||
|
- Add support for fixed issues and implemented enchanments. [\#6](https://github.com/skywinder/Github-Changelog-Generator/issues/6)
|
||||||
|
|
||||||
|
- Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
|
||||||
|
|
||||||
|
**Fixed bugs:**
|
||||||
|
|
||||||
|
- Last tag not appeared in changelog [\#5](https://github.com/skywinder/Github-Changelog-Generator/issues/5)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.1.0](https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0) (2014-11-07)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.2...0.1.0)
|
||||||
|
|
||||||
|
**Merged pull requests:**
|
||||||
|
|
||||||
|
- Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
- Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
|
||||||
|
|
||||||
|
## [0.0.2](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2) (2014-11-06)
|
||||||
|
|
||||||
|
[Full Changelog](https://github.com/skywinder/Github-Changelog-Generator/compare/0.0.1...0.0.2)
|
||||||
|
|
||||||
|
## [0.0.1](https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.1) (2014-11-06)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
|
||||||
113
spec/unit/reader_spec.rb
Normal file
113
spec/unit/reader_spec.rb
Normal file
|
|
@ -0,0 +1,113 @@
|
||||||
|
#
|
||||||
|
# Author:: Enrico Stahn <mail@enricostahn.com>
|
||||||
|
#
|
||||||
|
# Copyright 2014, Zanui, <engineering@zanui.com.au>
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
|
describe GitHubChangelogGenerator::Reader do
|
||||||
|
before(:all) do
|
||||||
|
@reader = GitHubChangelogGenerator::Reader.new
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#parse_heading' do
|
||||||
|
context 'when heading is empty' do
|
||||||
|
subject { @reader.parse_heading('## ') }
|
||||||
|
it { is_expected.to be_a(Hash) }
|
||||||
|
it { is_expected.to include('version', 'url', 'date') }
|
||||||
|
it { is_expected.to include('version' => nil, 'url' => nil, 'date' => nil) }
|
||||||
|
# TODO: Doesn't work?
|
||||||
|
# it { is_expected.to have_all_string_keys }
|
||||||
|
end
|
||||||
|
context 'when given version, url and date' do
|
||||||
|
subject { @reader.parse_heading('## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)') }
|
||||||
|
it { is_expected.to include('version' => '1.3.10') }
|
||||||
|
it { is_expected.to include('url' => 'https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10') }
|
||||||
|
it { is_expected.to include('date' => '2015-03-18') }
|
||||||
|
end
|
||||||
|
context 'when no url and date is provided' do
|
||||||
|
subject { @reader.parse_heading('## foobar') }
|
||||||
|
it { is_expected.to include('version' => 'foobar', 'url' => nil, 'date' => nil) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#parse' do
|
||||||
|
context 'when file is empty' do
|
||||||
|
subject { @reader.parse('') }
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.to be_empty }
|
||||||
|
end
|
||||||
|
context 'when file has only the header' do
|
||||||
|
subject { @reader.parse('# Change Log') }
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.to be_empty }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe 'example CHANGELOG files' do
|
||||||
|
subject { @reader.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'files', self.class.description))) }
|
||||||
|
context 'github-changelog-generator.md' do
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.not_to be_empty }
|
||||||
|
it { expect(subject.count).to eq(28) }
|
||||||
|
it { expect(subject.first).to include('version' => '1.3.10') }
|
||||||
|
it { expect(subject.first).to include('url' => 'https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10') }
|
||||||
|
it { expect(subject.first).to include('date' => '2015-03-18') }
|
||||||
|
it { expect(subject.first).to include('content') }
|
||||||
|
it 'content should not be empty' do
|
||||||
|
expect(subject.first['content']).not_to be_empty
|
||||||
|
end
|
||||||
|
end
|
||||||
|
context 'bundler.md' do
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.not_to be_empty }
|
||||||
|
it { expect(subject.count).to eq(151) }
|
||||||
|
it { expect(subject.first).to include('version' => '1.9.1') }
|
||||||
|
it { expect(subject.first).to include('url' => nil) }
|
||||||
|
it { expect(subject.first).to include('date' => '2015-03-21') }
|
||||||
|
it { expect(subject.first).to include('content') }
|
||||||
|
it 'content should not be empty' do
|
||||||
|
expect(subject.first['content']).not_to be_empty
|
||||||
|
end
|
||||||
|
end
|
||||||
|
context 'angular.js.md' do
|
||||||
|
it { is_expected.to be_an(Array) }
|
||||||
|
it { is_expected.not_to be_empty }
|
||||||
|
it do
|
||||||
|
pending('Implement heading_level for parser.')
|
||||||
|
expect(subject.count).to eq(134)
|
||||||
|
end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('version' => '1.4.0-beta.6 cookie-liberation')
|
||||||
|
# end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('url' => nil)
|
||||||
|
# end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('date' => '2015-03-17')
|
||||||
|
# end
|
||||||
|
# it do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first).to include('content')
|
||||||
|
# end
|
||||||
|
# it 'content should not be empty' do
|
||||||
|
# pending('Implement heading_level for parser.')
|
||||||
|
# expect(subject.first['content']).not_to be_empty
|
||||||
|
# end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Loading…
Reference in New Issue
Block a user