Linting: formatting code to suit RuboCop (#611 )

Update git-generate-changelog.md (#607 )
Update license date (#610 )
2018-01-01 17:02:25 +01:00 · 2018-01-01 16:20:54 +01:00 · 2018-01-01 16:08:34 +01:00 · 2017-12-29 16:17:02 +01:00 · 2017-12-15 16:23:29 +01:00 · 2017-12-15 16:01:04 +01:00
26 changed files with 1440 additions and 785 deletions
--- a/.rubocop.yml
+++ b/.rubocop.yml
@ -80,3 +80,10 @@ Metrics/BlockLength:
 Lint/InterpolationCheck:
  Enabled: false

+Style/FormatStringToken:
+  Exclude:
+    - lib/github_changelog_generator/parser.rb
+
+Style/MixinUsage:
+  Exclude:
+    - lib/github_changelog_generator/task.rb
--- a/.travis.yml
+++ b/.travis.yml
@ -6,16 +6,18 @@ before_install:
 matrix:
  fast_finish: true
  include:
-    - rvm: 2.2.8
+    - rvm: 2.2.7
      install: true # This skips 'bundle install'
      script: gem build github_changelog_generator && gem install *.gem
-    - rvm: 2.2.8
+      after_success: true # This skips 'codeclimate-test-reporter'
+    - rvm: 2.2.7
      install: true # This skips 'bundle install'
      script: gem build github_changelog_generator && bundle install
      gemfile: spec/install-gem-in-bundler.gemfile
-    - rvm: 2.3.5
-    - rvm: 2.4.2
-    - rvm: jruby-9.1.13.0
+      after_success: true # This skips 'codeclimate-test-reporter'
+    - rvm: 2.3.4
+    - rvm: 2.4.1
+    - rvm: jruby-9.1.15.0
      jdk: oraclejdk8
      env:
        - JRUBY_OPTS=--debug
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,4 +1,51 @@
-# Change Log
+# Changelog
+
+## [v1.15.0-rc](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0-rc) (2017-10-29)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.beta...v1.15.0-rc)
+
+**Implemented enhancements:**
+
+- Add option --require to load custom Ruby code before starting [\#574](https://github.com/skywinder/github-changelog-generator/pull/574) ([olleolleolle](https://github.com/olleolleolle))
+
+**Fixed bugs:**
+
+- issue\_line\_labels and breaking\_labels fail as rake file config params [\#583](https://github.com/skywinder/github-changelog-generator/issues/583)
+
+**Merged pull requests:**
+
+- Add Rake options reported missing [\#584](https://github.com/skywinder/github-changelog-generator/pull/584) ([olleolleolle](https://github.com/olleolleolle))
+- Aborting on missing --user and --project prints all of usage [\#578](https://github.com/skywinder/github-changelog-generator/pull/578) ([olleolleolle](https://github.com/olleolleolle))
+- Options\#print\_options + API docs for Options, Parser [\#576](https://github.com/skywinder/github-changelog-generator/pull/576) ([olleolleolle](https://github.com/olleolleolle))
+- \[docs\] Contributing file [\#575](https://github.com/skywinder/github-changelog-generator/pull/575) ([olleolleolle](https://github.com/olleolleolle))
+
+## [v1.15.0.pre.beta](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.beta) (2017-10-13)
+[Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.15.0.pre.alpha...v1.15.0.pre.beta)
+
+**Implemented enhancements:**
+
+- add breaking-changes section to changelog [\#530](https://github.com/skywinder/github-changelog-generator/pull/530) ([bastelfreak](https://github.com/bastelfreak))
+- Drop Project-and-Username-finding code [\#451](https://github.com/skywinder/github-changelog-generator/pull/451) ([olleolleolle](https://github.com/olleolleolle))
+
+**Fixed bugs:**
+
+- since\_tag doesn't work when tag specified is the latest tag [\#555](https://github.com/skywinder/github-changelog-generator/issues/555)
+- since\_tag seems to not be working [\#304](https://github.com/skywinder/github-changelog-generator/issues/304)
+- filter tags correctly when `since\_tag` is set to most recent tag [\#566](https://github.com/skywinder/github-changelog-generator/pull/566) ([Crunch09](https://github.com/Crunch09))
+
+**Closed issues:**
+
+- SSL Cert issue on Windows [\#475](https://github.com/skywinder/github-changelog-generator/issues/475)
+
+**Merged pull requests:**
+
+- Fix regression w/ enhancements in issues\_to\_log [\#573](https://github.com/skywinder/github-changelog-generator/pull/573) ([ekohl](https://github.com/ekohl))
+- OctoFetcher: Use defaults for request\_options [\#571](https://github.com/skywinder/github-changelog-generator/pull/571) ([olleolleolle](https://github.com/olleolleolle))
+- OctoFetcher: extract methods [\#570](https://github.com/skywinder/github-changelog-generator/pull/570) ([olleolleolle](https://github.com/olleolleolle))
+- OctoFetcher: extract method fail\_with\_message [\#569](https://github.com/skywinder/github-changelog-generator/pull/569) ([olleolleolle](https://github.com/olleolleolle))
+- OctoFetcher: drop unused number\_of\_pages feature [\#568](https://github.com/skywinder/github-changelog-generator/pull/568) ([olleolleolle](https://github.com/olleolleolle))
+- Travis: Do not test on jruby-head [\#567](https://github.com/skywinder/github-changelog-generator/pull/567) ([olleolleolle](https://github.com/olleolleolle))
+- Drop unused Rake task [\#564](https://github.com/skywinder/github-changelog-generator/pull/564) ([olleolleolle](https://github.com/olleolleolle))
+- Update license date [\#553](https://github.com/skywinder/github-changelog-generator/pull/553) ([benhc123](https://github.com/benhc123))

 ## [v1.15.0.pre.alpha](https://github.com/skywinder/github-changelog-generator/tree/v1.15.0.pre.alpha) (2017-10-01)
 [Full Changelog](https://github.com/skywinder/github-changelog-generator/compare/v1.14.3...v1.15.0.pre.alpha)
@ -6,7 +53,7 @@
 **Implemented enhancements:**

 - Add newline after version name and Full Changelog link [\#548](https://github.com/skywinder/github-changelog-generator/pull/548) ([ianroberts131](https://github.com/ianroberts131))
- Update the token failure example to OctoKit 404 failure [\#525](https://github.com/skywinder/github-changelog-generator/pull/525) ([thebyt3](https://github.com/thebyt3))
+- Update the token failure example to OctoKit 404 failure [\#525](https://github.com/skywinder/github-changelog-generator/pull/525) ([00xcoffee](https://github.com/00xcoffee))
 - Rescue invalid commands and present the valid options list [\#498](https://github.com/skywinder/github-changelog-generator/pull/498) ([Lucashuang0802](https://github.com/Lucashuang0802))
 - bundled cacert.pem with --ssl-ca-file PATH option [\#480](https://github.com/skywinder/github-changelog-generator/pull/480) ([olleolleolle](https://github.com/olleolleolle))
 - Option parsing: Remove tag1, tag2 cruft [\#479](https://github.com/skywinder/github-changelog-generator/pull/479) ([olleolleolle](https://github.com/olleolleolle))
@ -456,7 +503,7 @@

 **Implemented enhancements:**

- Generate change log since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
+- Generate changelog since/due specific tag [\#254](https://github.com/skywinder/github-changelog-generator/issues/254)
 - Add --base option [\#258](https://github.com/skywinder/github-changelog-generator/pull/258) ([raphink](https://github.com/raphink))

 **Merged pull requests:**
@ -513,7 +560,7 @@

 - Show `Unreleased` section even when there is no tags in repo. [\#228](https://github.com/skywinder/github-changelog-generator/issues/228)
 - Add option `--exclude-tags x,y,z` [\#214](https://github.com/skywinder/github-changelog-generator/issues/214)
- Generate change log between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
+- Generate changelog between 2 specific tags [\#172](https://github.com/skywinder/github-changelog-generator/issues/172)
 - Yanked releases support [\#53](https://github.com/skywinder/github-changelog-generator/issues/53)

 **Merged pull requests:**
@ -525,7 +572,7 @@

 **Implemented enhancements:**

- Trees/Archives with missing change log notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)
+- Trees/Archives with missing changelog notes for the current tag. [\#230](https://github.com/skywinder/github-changelog-generator/issues/230)

 **Fixed bugs:**

@ -544,7 +591,7 @@

 **Implemented enhancements:**

- Parsing of existing Change Log file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
+- Parsing of existing Changelog file [\#212](https://github.com/skywinder/github-changelog-generator/issues/212)
 - Warn users about 0 tags in repo. [\#208](https://github.com/skywinder/github-changelog-generator/issues/208)
 - Cleanup [\#220](https://github.com/skywinder/github-changelog-generator/pull/220) ([tuexss](https://github.com/tuexss))

@ -808,4 +855,4 @@
 ## [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)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,60 @@
+# How to contribute
+
+Bug reports and pull requests from users are what keep this project working.
+
+## Basics
+
+1. Create an issue and describe your idea
+2. [Fork it](https://github.com/skywinder/github-changelog-generator/fork)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Publish the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## Checking your work
+
+You can test your workflow with changelog generator with
+[the skywinder/changelog_test repo].
+
+You can run the test suite.
+
+You can run [RuboCop] to check code style.
+
+The default Rake task, runnable using `rake`, calls `rubocop`, then `spec`.
+
+[the skywinder/changelog_test repo]: https://github.com/skywinder/changelog_test/
+[RuboCop]: http://rubocop.readthedocs.io/en/latest/
+
+## Write documentation
+
+This project has documentation in a few places:
+
+### Introduction and usage
+
+A friendly `README.md` written for many audiences.
+
+### Examples and advanced usage
+
+The [wiki].
+
+###  API documentation 
+
+API documentation is written as [YARD] docblocks in the Ruby code.
+
+This is rendered as Web pages on [Rubydoc.info][github-changelog-generator on Rubydoc.info].
+
+The completeness of the API documentation is measured on [our page on the Inch CI website][github-changelog-generator on Inch CI].
+
+### man page
+
+`man/git-generate-changelog.md`
+
+The man page is for the `git generate-changelog` Git sub-command, which is a wrapper for `github_changelog_generator`. That file is a Markdown file.
+
+Use the [ronn] gem to generate `.1` and `.html` artifacts like this: `cd man; ronn git-generate-changelog.md`
+
+[wiki]: https://github.com/skywinder/github-changelog-generator/wiki
+[YARD]: https://yardoc.org/
+[github-changelog-generator on Rubydoc.info]: http://www.rubydoc.info/gems/github_changelog_generator
+[ronn]: https://github.com/rtomayko/ronn
+[github-changelog-generator on Inch CI]: https://inch-ci.org/github/skywinder/github-changelog-generator
--- a/16
+++ b/16
@ -0,0 +1,16 @@
+FROM ruby:2.4-alpine3.6
+
+LABEL maintainer "ferrari.marco@gmail.com"
+
+ENV GITHUB_CHANGELOG_GENERATOR_VERSION "1.14.3"
+
+RUN gem install github_changelog_generator --version $GITHUB_CHANGELOG_GENERATOR_VERSION
+
+ENV SRC_PATH /usr/local/src/your-app
+RUN mkdir -p $SRC_PATH
+
+VOLUME [ "$SRC_PATH" ]
+WORKDIR $SRC_PATH
+
+CMD ["--help"]
+ENTRYPOINT ["github_changelog_generator"]
--- a/2
+++ b/2
@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2016-2017 Petr Korolev
+Copyright (c) 2016-2018 Petr Korolev

 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

--- a/README.md
+++ b/README.md
@ -25,11 +25,11 @@ GitHub Changelog Generator ![GitHub Logo](../master/images/logo.jpg)

 ### Changelog generation has never been so easy

-**Fully automated changelog generation** - This gem generates a change log file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
+**Fully automated changelog generation** - This gem generates a changelog file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.

 Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:

-### *What’s the point of a change log?*
+### *What’s the point of a changelog?*

 To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

@ -43,16 +43,20 @@ release (or version) of the project."

 ## Installation

-    gem install github_changelog_generator
+    $ [sudo] gem install github_changelog_generator

 See also Troubleshooting.

+## Running with Docker
+
+    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app skywinder/github-changelog-generator
+
 ## Output example

 - 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_changelog_generator -u skywinder -p ActionSheetPicker-3.0

 - In general, it looks like this:

@ -79,21 +83,27 @@ See also Troubleshooting.

 -  Run this:

-      `github_changelog_generator -u github_username -p github_project`
-      `github_changelog_generator  github_username/github_project`
+	   $ github_changelog_generator -u github_username -p github_project
+	   
+	or, on the 1.14.x (current stable release)
+
+	   $ github_changelog_generator github_username/github_project
+	   

 - For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:

-      github_changelog_generator --github-site="https://github.yoursite.com" \
-                                 --github-api="https://github.yoursite.com/api/v3/"
+       $ github_changelog_generator --github-site="https://github.yoursite.com" \
+                                  --github-api="https://github.yoursite.com/api/v3/"

 This generates a `CHANGELOG.md`, with pretty Markdown formatting.

 ### Params

-Type `github_changelog_generator --help` for details.
+Print help for all command-line options to learn more details:

-For more details about params, read the Wiki page: [**Advanced change log generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
+    $ github_changelog_generator --help
+
+For more details about params, read the Wiki page: [**Advanced changelog generation examples**](https://github.com/skywinder/github-changelog-generator/wiki/Advanced-change-log-generation-examples)

 ### Params File

@ -167,7 +177,7 @@ You can look for params names from the [parser source code (#setup_parser)](http

 ## Features and advantages of this project

- Generate canonical, neat change log file, followed by [basic change log guidelines](http://keepachangelog.com) :gem:
+- Generate canonical, neat changelog file, followed by [basic changelog guidelines](http://keepachangelog.com) :gem:
 - Optionally generate **Unreleased** changes (closed issues that have not released yet) :dizzy:
 - **GitHub Enterprise support** via command line options! :factory:
 - Flexible format **customization**:
@ -199,7 +209,7 @@ Here's a [wikipage list of projects](https://github.com/skywinder/Github-Changel

 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` to generate your project's changelog, or know of other projects using it, please [add it to this list] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator).*
+*If you are using `github_changelog_generator` to generate your project's changelog, or know of other projects using it, please [add it to this list](https://github.com/skywinder/github-changelog-generator/wiki/Projects-using-Github-Changelog-Generator).*

 ## Am I missing some essential feature?

@ -226,15 +236,15 @@ For example:
 When you find a closed bug, it is very useful to know which release fixed it.
 So that you can easily find the issue by \# in `CHANGELOG.md`.

- it's not quite as easy to find this in handwritten releases notes
- a generated file saves you the trouble of remembering everything;
-  sometimes people forget to add things to a handwritten file
+- It's not quite as easy to find this in handwritten releases notes.
+- A generated file saves you the trouble of remembering everything;
+  sometimes people forget to add things to a handwritten file.

 Ultimately, I think GitHub Releases are ideal for end-users.
 Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
 Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.

- ***I received a warning: "GitHub API rate limit exceed"  What does this mean?***
+- ***I got an "API rate limit exceeded" error message. 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 is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).

@ -270,15 +280,9 @@ can't get the latest version of Ruby installed.

 ## Contributing

-1. Create an issue and describe your idea
-2. [Fork it](https://github.com/skywinder/github-changelog-generator/fork)
-3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Publish the branch (`git push origin my-new-feature`)
-6. Create a new Pull Request
-7. Profit! :white_check_mark:
+We have collected notes on how to contribute to this project in [CONTRIBUTING.md].

-You can test your workflow with changelog generator with [the skywinder/changelog_test repo](https://github.com/skywinder/changelog_test/).
+[CONTRIBUTING.md]: CONTRIBUTING.md

 ## License

--- a/github_changelog_generator.gemspec
+++ b/github_changelog_generator.gemspec
@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
  spec.version            = GitHubChangelogGenerator::VERSION
  spec.default_executable = "github_changelog_generator"

-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 2.2.2"
  spec.authors = ["Petr Korolev", "Olle Jonsson"]
  spec.email = "sky4winder+github_changelog_generator@gmail.com"

  spec.summary = "Script, that automatically generate changelog from your tags, issues, labels and pull requests."
-  spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate change log file based on tags, issues and merged pull requests from Github issue tracker."
+  spec.description = "Changelog generation has never been so easy. Fully automate changelog generation - this gem generate changelog file based on tags, issues and merged pull requests from Github issue tracker."
  spec.homepage = "https://github.com/skywinder/Github-Changelog-Generator"
  spec.license = "MIT"

@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

-  spec.add_runtime_dependency "rake", ">= 10.0"
-  spec.add_runtime_dependency "rainbow", ">= 2.2.1"
-  spec.add_runtime_dependency("octokit", ["~> 4.6"])
-  spec.add_runtime_dependency("faraday-http-cache")
  spec.add_runtime_dependency("activesupport")
-  spec.add_runtime_dependency("retriable", ["~> 3.0"])
+  spec.add_runtime_dependency("faraday-http-cache")
  spec.add_runtime_dependency("multi_json")
+  spec.add_runtime_dependency("octokit", ["~> 4.6"])
+  spec.add_runtime_dependency "rainbow", ">= 2.2.1"
+  spec.add_runtime_dependency "rake", ">= 10.0"
+  spec.add_runtime_dependency("retriable", ["~> 3.0"])
 end
--- a/lib/github_changelog_generator.rb
+++ b/lib/github_changelog_generator.rb
@ -22,14 +22,14 @@ require "github_changelog_generator/reader"
 module GitHubChangelogGenerator
  # Main class and entry point for this script.
  class ChangelogGenerator
-    # Class, responsible for whole change log generation cycle
+    # Class, responsible for whole changelog generation cycle
    # @return initialised instance of ChangelogGenerator
    def initialize
      @options = Parser.parse_options
      @generator = Generator.new @options
    end

-    # The entry point of this script to generate change log
+    # The entry point of this script to generate changelog
    # @raise (ChangelogGeneratorError) Is thrown when one of specified tags was not found in list of tags.
    def run
      log = @generator.compound_changelog
--- a/lib/github_changelog_generator/generator/entry.rb
+++ b/lib/github_changelog_generator/generator/entry.rb
@ -0,0 +1,237 @@
+require "github_changelog_generator/generator/section"
+
+module GitHubChangelogGenerator
+  # This class generates the content for a single changelog entry. An entry is
+  # generally either for a specific tagged release or the collection of
+  # unreleased changes.
+  #
+  # An entry is comprised of header text followed by a series of sections
+  # relating to the entry.
+  #
+  # @see GitHubChangelogGenerator::Generator
+  # @see GitHubChangelogGenerator::Section
+  class Entry
+    attr_reader :content
+
+    def initialize(options = Options.new({}))
+      @content = ""
+      @options = Options.new(options)
+    end
+
+    # Generates log entry with header and body
+    #
+    # @param [Array] pull_requests List or PR's in new section
+    # @param [Array] issues List of issues in new section
+    # @param [String] newer_tag_name Name of the newer tag. Could be nil for `Unreleased` section.
+    # @param [String] newer_tag_link Name of the newer tag. Could be "HEAD" for `Unreleased` section.
+    # @param [Time] newer_tag_time Time of the newer tag
+    # @param [Hash, nil] older_tag Older tag, used for the links. Could be nil for last tag.
+    # @return [String] Ready and parsed section
+    def create_entry_for_tag(pull_requests, issues, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name) # rubocop:disable Metrics/ParameterLists
+      github_site = @options[:github_site] || "https://github.com"
+      project_url = "#{github_site}/#{@options[:user]}/#{@options[:project]}"
+
+      set_sections_and_maps
+
+      @content = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+
+      @content += generate_body(pull_requests, issues)
+
+      @content
+    end
+
+    private
+
+    # Creates section objects and the label and section maps needed for
+    # sorting
+    def set_sections_and_maps
+      @sections = if @options.configure_sections?
+                    parse_sections(@options[:configure_sections])
+                  elsif @options.add_sections?
+                    default_sections.concat parse_sections(@options[:add_sections])
+                  else
+                    default_sections
+                  end
+
+      @lmap = label_map
+      @smap = section_map
+    end
+
+    # Turns a string from the commandline into an array of Section objects
+    #
+    # @param [String, Hash] either string or hash describing sections
+    # @return [Array] array of Section objects
+    def parse_sections(sections_desc)
+      require "json"
+
+      sections_desc = sections_desc.to_json if sections_desc.class == Hash
+
+      begin
+        sections_json = JSON.parse(sections_desc)
+      rescue JSON::ParserError => e
+        raise "There was a problem parsing your JSON string for sections: #{e}"
+      end
+
+      sections_json.collect do |name, v|
+        Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], options: @options)
+      end
+    end
+
+    # Creates a hash map of labels => section objects
+    #
+    # @return [Hash] map of labels => section objects
+    def label_map
+      @sections.each_with_object({}) do |section_obj, memo|
+        section_obj.labels.each do |label|
+          memo[label] = section_obj.name
+        end
+      end
+    end
+
+    # Creates a hash map of 'section name' => section object
+    #
+    # @return [Hash] map of 'section name' => section object
+    def section_map
+      @sections.each_with_object({}) do |section, memo|
+        memo[section.name] = section
+      end
+    end
+
+    # It generates header text for an entry with specific parameters.
+    #
+    # @param [String] newer_tag_name - name of newer tag
+    # @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
+    # @param [Time] newer_tag_time - time, when newer tag created
+    # @param [String] older_tag_name - tag name, used for links.
+    # @param [String] project_url - url for current project.
+    # @return [String] - Header text for a changelog entry.
+    def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
+      header = ""
+
+      # Generate date string:
+      time_string = newer_tag_time.strftime(@options[:date_format])
+
+      # Generate tag name and link
+      release_url = if @options[:release_url]
+                      format(@options[:release_url], newer_tag_link)
+                    else
+                      "#{project_url}/tree/#{newer_tag_link}"
+                    end
+      header += if newer_tag_name.equal?(@options[:unreleased_label])
+                  "## [#{newer_tag_name}](#{release_url})\n\n"
+                else
+                  "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
+                end
+
+      if @options[:compare_link] && older_tag_name
+        # Generate compare link
+        header += "[Full Changelog](#{project_url}/compare/#{older_tag_name}...#{newer_tag_link})\n\n"
+      end
+
+      header
+    end
+
+    # Generates complete body text for a tag (without a header)
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @returns [String] ready-to-go tag body
+    def generate_body(pull_requests, issues)
+      body = ""
+      body += main_sections_to_log(pull_requests, issues)
+      body += merged_section_to_log(pull_requests) if @options[:pulls] && @options[:add_pr_wo_labels]
+      body
+    end
+
+    # Generates main sections for a tag
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @return [string] ready-to-go sub-sections
+    def main_sections_to_log(pull_requests, issues)
+      if @options[:issues]
+        sections_to_log = parse_by_sections(pull_requests, issues)
+
+        sections_to_log.map(&:generate_content).join
+      end
+    end
+
+    # Generates section for prs with no labels (for a tag)
+    #
+    # @param [Array] pull_requests
+    # @return [string] ready-to-go sub-section
+    def merged_section_to_log(pull_requests)
+      merged = Section.new(name: "merged", prefix: @options[:merge_prefix], labels: [], issues: pull_requests, options: @options)
+      @sections << merged unless @sections.find { |section| section.name == "merged" }
+      merged.generate_content
+    end
+
+    # Set of default sections for backwards-compatibility/defaults
+    #
+    # @return [Array] array of Section objects
+    def default_sections
+      [
+        Section.new(name: "breaking", prefix: @options[:breaking_prefix], labels: @options[:breaking_labels], options: @options),
+        Section.new(name: "enhancements", prefix: @options[:enhancement_prefix], labels: @options[:enhancement_labels], options: @options),
+        Section.new(name: "bugs", prefix: @options[:bug_prefix], labels: @options[:bug_labels], options: @options),
+        Section.new(name: "issues", prefix: @options[:issue_prefix], labels: @options[:issue_labels], options: @options)
+      ]
+    end
+
+    # This method sorts issues by types
+    # (bugs, features, or just closed issues) by labels
+    #
+    # @param [Array] pull_requests
+    # @param [Array] issues
+    # @return [Hash] Mapping of filtered arrays: (Bugs, Enhancements, Breaking stuff, Issues)
+    def parse_by_sections(pull_requests, issues)
+      issues.each do |dict|
+        added = false
+
+        dict["labels"].each do |label|
+          break if @lmap[label["name"]].nil?
+          @smap[@lmap[label["name"]]].issues << dict
+          added = true
+
+          break if added
+        end
+        if @smap["issues"]
+          @sections.find { |sect| sect.name == "issues" }.issues << dict unless added
+        end
+      end
+      sort_pull_requests(pull_requests)
+    end
+
+    # This method iterates through PRs and sorts them into sections
+    #
+    # @param [Array] pull_requests
+    # @param [Hash] sections
+    # @return [Hash] sections
+    def sort_pull_requests(pull_requests)
+      added_pull_requests = []
+      pull_requests.each do |pr|
+        added = false
+
+        pr["labels"].each do |label|
+          break if @lmap[label["name"]].nil?
+          @smap[@lmap[label["name"]]].issues << pr
+          added_pull_requests << pr
+          added = true
+
+          break if added
+        end
+      end
+      added_pull_requests.each { |req| pull_requests.delete(req) }
+      @sections
+    end
+
+    def line_labels_for(issue)
+      labels = if @options[:issue_line_labels] == ["ALL"]
+                 issue["labels"]
+               else
+                 issue["labels"].select { |label| @options[:issue_line_labels].include?(label["name"]) }
+               end
+      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
+    end
+  end
+end
--- a/lib/github_changelog_generator/generator/generator.rb
+++ b/lib/github_changelog_generator/generator/generator.rb
@ -1,20 +1,32 @@
 # frozen_string_literal: true

-require_relative "../octo_fetcher"
-require_relative "generator_generation"
-require_relative "generator_fetcher"
-require_relative "generator_processor"
-require_relative "generator_tags"
+require "github_changelog_generator/octo_fetcher"
+require "github_changelog_generator/generator/generator_fetcher"
+require "github_changelog_generator/generator/generator_processor"
+require "github_changelog_generator/generator/generator_tags"
+require "github_changelog_generator/generator/entry"
+require "github_changelog_generator/generator/section"

 module GitHubChangelogGenerator
  # Default error for ChangelogGenerator
  class ChangelogGeneratorError < StandardError
  end

+  # This class is the high-level code for gathering issues and PRs for a github
+  # repository and generating a CHANGELOG.md file. A changelog is made up of a
+  # series of "entries" of all tagged releases, plus an extra entry for the
+  # unreleased changes. Entries are made up of various organizational
+  # "sections," and sections contain the github issues and PRs.
+  #
+  # So the changelog contains entries, entries contain sections, and sections
+  # contain issues and PRs.
+  #
+  # @see GitHubChangelogGenerator::Entry
+  # @see GitHubChangelogGenerator::Section
  class Generator
-    attr_accessor :options, :filtered_tags, :github, :tag_section_mapping, :sorted_tags
+    attr_accessor :options, :filtered_tags, :tag_section_mapping, :sorted_tags

-    # A Generator responsible for all logic, related with change log generation from ready-to-parse issues
+    # A Generator responsible for all logic, related with changelog generation from ready-to-parse issues
    #
    # Example:
    #   generator = GitHubChangelogGenerator::Generator.new
@ -23,6 +35,104 @@ module GitHubChangelogGenerator
      @options        = options
      @tag_times_hash = {}
      @fetcher        = GitHubChangelogGenerator::OctoFetcher.new(options)
+      @sections       = []
+    end
+
+    # Main function to start changelog generation
+    #
+    # @return [String] Generated changelog file
+    def compound_changelog
+      options.load_custom_ruby_files
+      fetch_and_filter_tags
+      fetch_issues_and_pr
+
+      log = ""
+      log += options[:frontmatter] if options[:frontmatter]
+      log += "#{options[:header]}\n\n"
+
+      log += if options[:unreleased_only]
+               generate_entry_between_tags(filtered_tags[0], nil)
+             else
+               generate_entries_for_all_tags
+             end
+
+      log += File.read(options[:base]) if File.file?(options[:base])
+
+      credit_line = "\n\n\\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
+      log.gsub!(credit_line, "") # Remove old credit lines
+      log += credit_line
+
+      @log = log
+    end
+
+    private
+
+    # Generate log only between 2 specified tags
+    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
+    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
+    def generate_entry_between_tags(older_tag, newer_tag)
+      filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
+
+      if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
+        # do not generate empty unreleased section
+        return ""
+      end
+
+      newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
+
+      # If the older tag is nil, go back in time from the latest tag and find
+      # the SHA for the first commit.
+      older_tag_name =
+        if older_tag.nil?
+          @fetcher.commits_before(newer_tag_time).last["sha"]
+        else
+          older_tag["name"]
+        end
+
+      Entry.new(options).create_entry_for_tag(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name)
+    end
+
+    # Filters issues and pull requests based on, respectively, `closed_at` and `merged_at`
+    #  timestamp fields.
+    #
+    # @return [Array] filtered issues and pull requests
+    def filter_issues_for_tags(newer_tag, older_tag)
+      filtered_pull_requests = delete_by_time(@pull_requests, "merged_at", older_tag, newer_tag)
+      filtered_issues        = delete_by_time(@issues, "closed_at", older_tag, newer_tag)
+
+      newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
+
+      if options[:filter_issues_by_milestone]
+        # delete excess irrelevant issues (according milestones). Issue #22.
+        filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
+        filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
+      end
+      [filtered_issues, filtered_pull_requests]
+    end
+
+    # The full cycle of generation for whole project
+    # @return [String] All entries in the changelog
+    def generate_entries_for_all_tags
+      puts "Generating entry..." if options[:verbose]
+
+      entries = generate_unreleased_entry
+
+      @tag_section_mapping.each_pair do |_tag_section, left_right_tags|
+        older_tag, newer_tag = left_right_tags
+        entries += generate_entry_between_tags(older_tag, newer_tag)
+      end
+
+      entries
+    end
+
+    def generate_unreleased_entry
+      entry = ""
+      if options[:unreleased]
+        start_tag        = filtered_tags[0] || sorted_tags.last
+        unreleased_entry = generate_entry_between_tags(start_tag, nil)
+        entry           += unreleased_entry if unreleased_entry
+      end
+      entry
    end

    def fetch_issues_and_pr
@ -35,144 +145,5 @@ module GitHubChangelogGenerator
      fetch_events_for_issues_and_pr
      detect_actual_closed_dates(@issues + @pull_requests)
    end
-
-    ENCAPSULATED_CHARACTERS = %w(< > * _ \( \) [ ] #)
-
-    # Encapsulate characters to make Markdown look as expected.
-    #
-    # @param [String] string
-    # @return [String] encapsulated input string
-    def encapsulate_string(string)
-      string = string.gsub('\\', '\\\\')
-
-      ENCAPSULATED_CHARACTERS.each do |char|
-        string = string.gsub(char, "\\#{char}")
-      end
-
-      string
-    end
-
-    # Generates log for section with header and body
-    #
-    # @param [Array] pull_requests List or PR's in new section
-    # @param [Array] issues List of issues in new section
-    # @param [String] newer_tag Name of the newer tag. Could be nil for `Unreleased` section
-    # @param [Hash, nil] older_tag Older tag, used for the links. Could be nil for last tag.
-    # @return [String] Ready and parsed section
-    def create_log_for_tag(pull_requests, issues, newer_tag, older_tag = nil)
-      newer_tag_link, newer_tag_name, newer_tag_time = detect_link_tag_time(newer_tag)
-
-      github_site = options[:github_site] || "https://github.com"
-      project_url = "#{github_site}/#{options[:user]}/#{options[:project]}"
-
-      # If the older tag is nil, go back in time from the latest tag and find
-      # the SHA for the first commit.
-      older_tag_name =
-        if older_tag.nil?
-          @fetcher.commits_before(newer_tag_time).last["sha"]
-        else
-          older_tag["name"]
-        end
-
-      log = generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_name, project_url)
-
-      if options[:issues]
-        # Generate issues:
-        log += issues_to_log(issues, pull_requests)
-      end
-
-      if options[:pulls] && options[:add_pr_wo_labels]
-        # Generate pull requests:
-        log += generate_sub_section(pull_requests, options[:merge_prefix])
-      end
-
-      log
-    end
-
-    # Generate ready-to-paste log from list of issues and pull requests.
-    #
-    # @param [Array] issues
-    # @param [Array] pull_requests
-    # @return [String] generated log for issues
-    def issues_to_log(issues, pull_requests)
-      sections = parse_by_sections(issues, pull_requests)
-
-      log = ""
-      log += generate_sub_section(sections[:breaking], options[:breaking_prefix])
-      log += generate_sub_section(sections[:enhancements], options[:enhancement_prefix])
-      log += generate_sub_section(sections[:bugs], options[:bug_prefix])
-      log += generate_sub_section(sections[:issues], options[:issue_prefix])
-      log
-    end
-
-    # This method sort issues by types
-    # (bugs, features, or just closed issues) by labels
-    #
-    # @param [Array] issues
-    # @param [Array] pull_requests
-    # @return [Hash] Mapping of filtered arrays: (Bugs, Enhancements, Breaking stuff, Issues)
-    def parse_by_sections(issues, pull_requests)
-      sections = {
-        issues: [],
-        enhancements: [],
-        bugs: [],
-        breaking: []
-      }
-
-      issues.each do |dict|
-        added = false
-
-        dict["labels"].each do |label|
-          if options[:bug_labels].include?(label["name"])
-            sections[:bugs] << dict
-            added = true
-          elsif options[:enhancement_labels].include?(label["name"])
-            sections[:enhancements] << dict
-            added = true
-          elsif options[:breaking_labels].include?(label["name"])
-            sections[:breaking] << dict
-            added = true
-          end
-
-          break if added
-        end
-
-        sections[:issues] << dict unless added
-      end
-
-      sort_pull_requests(pull_requests, sections)
-    end
-
-    # This method iterates through PRs and sorts them into sections
-    #
-    # @param [Array] pull_requests
-    # @param [Hash] sections
-    # @return [Hash] sections
-    def sort_pull_requests(pull_requests, sections)
-      added_pull_requests = []
-      pull_requests.each do |pr|
-        added = false
-
-        pr["labels"].each do |label|
-          if options[:bug_labels].include?(label["name"])
-            sections[:bugs] << pr
-            added_pull_requests << pr
-            added = true
-          elsif options[:enhancement_labels].include?(label["name"])
-            sections[:enhancements] << pr
-            added_pull_requests << pr
-            added = true
-          elsif options[:breaking_labels].include?(label["name"])
-            sections[:breaking] << pr
-            added_pull_requests << pr
-            added = true
-          end
-
-          break if added
-        end
-      end
-      added_pull_requests.each { |p| pull_requests.delete(p) }
-      sections
-    end
  end
 end
--- a/lib/github_changelog_generator/generator/generator_generation.rb
+++ b/lib/github_changelog_generator/generator/generator_generation.rb
@ -1,180 +0,0 @@
-# frozen_string_literal: true
-
-module GitHubChangelogGenerator
-  class Generator
-    # Main function to start change log generation
-    #
-    # @return [String] Generated change log file
-    def compound_changelog
-      fetch_and_filter_tags
-      fetch_issues_and_pr
-
-      log = ""
-      log += options[:frontmatter] if options[:frontmatter]
-      log += "#{options[:header]}\n\n"
-
-      log += if options[:unreleased_only]
-               generate_log_between_tags(filtered_tags[0], nil)
-             else
-               generate_log_for_all_tags
-             end
-
-      log += File.read(options[:base]) if File.file?(options[:base])
-
-      credit_line = "\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
-      log.gsub!(credit_line, "") # Remove old credit lines
-      log += credit_line
-
-      @log = log
-    end
-
-    # @param [Array] issues List of issues on sub-section
-    # @param [String] prefix Name of sub-section
-    # @return [String] Generate ready-to-go sub-section
-    def generate_sub_section(issues, prefix)
-      log = ""
-
-      if issues.any?
-        log += "#{prefix}\n\n" unless options[:simple_list]
-        issues.each do |issue|
-          merge_string = get_string_for_issue(issue)
-          log += "- #{merge_string}\n"
-        end
-        log += "\n"
-      end
-      log
-    end
-
-    # It generate one header for section with specific parameters.
-    #
-    # @param [String] newer_tag_name - name of newer tag
-    # @param [String] newer_tag_link - used for links. Could be same as #newer_tag_name or some specific value, like HEAD
-    # @param [Time] newer_tag_time - time, when newer tag created
-    # @param [String] older_tag_link - tag name, used for links.
-    # @param [String] project_url - url for current project.
-    # @return [String] - Generate one ready-to-add section.
-    def generate_header(newer_tag_name, newer_tag_link, newer_tag_time, older_tag_link, project_url)
-      log = ""
-
-      # Generate date string:
-      time_string = newer_tag_time.strftime(options[:date_format])
-
-      # Generate tag name and link
-      release_url = if options[:release_url]
-                      format(options[:release_url], newer_tag_link)
-                    else
-                      "#{project_url}/tree/#{newer_tag_link}"
-                    end
-      log += if newer_tag_name.equal?(options[:unreleased_label])
-               "## [#{newer_tag_name}](#{release_url})\n\n"
-             else
-               "## [#{newer_tag_name}](#{release_url}) (#{time_string})\n\n"
-             end
-
-      if options[:compare_link] && older_tag_link
-        # Generate compare link
-        log += "[Full Changelog](#{project_url}/compare/#{older_tag_link}...#{newer_tag_link})\n\n"
-      end
-
-      log
-    end
-
-    # Generate log only between 2 specified tags
-    # @param [String] older_tag all issues before this tag date will be excluded. May be nil, if it's first tag
-    # @param [String] newer_tag all issue after this tag will be excluded. May be nil for unreleased section
-    def generate_log_between_tags(older_tag, newer_tag)
-      filtered_issues, filtered_pull_requests = filter_issues_for_tags(newer_tag, older_tag)
-
-      if newer_tag.nil? && filtered_issues.empty? && filtered_pull_requests.empty?
-        # do not generate empty unreleased section
-        return ""
-      end
-
-      create_log_for_tag(filtered_pull_requests, filtered_issues, newer_tag, older_tag)
-    end
-
-    # Filters issues and pull requests based on, respectively, `closed_at` and `merged_at`
-    #  timestamp fields.
-    #
-    # @return [Array] filtered issues and pull requests
-    def filter_issues_for_tags(newer_tag, older_tag)
-      filtered_pull_requests = delete_by_time(@pull_requests, "merged_at", older_tag, newer_tag)
-      filtered_issues        = delete_by_time(@issues, "closed_at", older_tag, newer_tag)
-
-      newer_tag_name = newer_tag.nil? ? nil : newer_tag["name"]
-
-      if options[:filter_issues_by_milestone]
-        # delete excess irrelevant issues (according milestones). Issue #22.
-        filtered_issues = filter_by_milestone(filtered_issues, newer_tag_name, @issues)
-        filtered_pull_requests = filter_by_milestone(filtered_pull_requests, newer_tag_name, @pull_requests)
-      end
-      [filtered_issues, filtered_pull_requests]
-    end
-
-    # The full cycle of generation for whole project
-    # @return [String] The complete change log
-    def generate_log_for_all_tags
-      puts "Generating log..." if options[:verbose]
-
-      log = generate_unreleased_section
-
-      @tag_section_mapping.each_pair do |_tag_section, left_right_tags|
-        older_tag, newer_tag = left_right_tags
-        log += generate_log_between_tags(older_tag, newer_tag)
-      end
-
-      log
-    end
-
-    def generate_unreleased_section
-      log = ""
-      if options[:unreleased]
-        start_tag      = filtered_tags[0] || sorted_tags.last
-        unreleased_log = generate_log_between_tags(start_tag, nil)
-        log           += unreleased_log if unreleased_log
-      end
-      log
-    end
-
-    # Parse issue and generate single line formatted issue line.
-    #
-    # Example output:
-    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
-    #
-    # @param [Hash] issue Fetched issue from GitHub
-    # @return [String] Markdown-formatted single issue
-    def get_string_for_issue(issue)
-      encapsulated_title = encapsulate_string issue["title"]
-
-      title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
-      if options[:issue_line_labels].present?
-        title_with_number = "#{title_with_number}#{line_labels_for(issue)}"
-      end
-      issue_line_with_user(title_with_number, issue)
-    end
-
-    private
-
-    def line_labels_for(issue)
-      labels = if options[:issue_line_labels] == ["ALL"]
-                 issue["labels"]
-               else
-                 issue["labels"].select { |label| options[:issue_line_labels].include?(label["name"]) }
-               end
-      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
-    end
-
-    def issue_line_with_user(line, issue)
-      return line if !options[:author] || issue["pull_request"].nil?
-
-      user = issue["user"]
-      return "#{line} ({Null user})" unless user
-
-      if options[:usernames_as_github_logins]
-        "#{line} (@#{user['login']})"
-      else
-        "#{line} ([#{user['login']}](#{user['html_url']}))"
-      end
-    end
-  end
-end
--- a/lib/github_changelog_generator/generator/section.rb
+++ b/lib/github_changelog_generator/generator/section.rb
@ -0,0 +1,83 @@
+module GitHubChangelogGenerator
+  # This class generates the content for a single section of a changelog entry.
+  # It turns the tagged issues and PRs into a well-formatted list of changes to
+  # be later incorporated into a changelog entry.
+  #
+  # @see GitHubChangelogGenerator::Entry
+  class Section
+    attr_accessor :name, :prefix, :issues, :labels
+
+    def initialize(opts = {})
+      @name = opts[:name]
+      @prefix = opts[:prefix]
+      @labels = opts[:labels] || []
+      @issues = opts[:issues] || []
+      @options = opts[:options] || Options.new({})
+    end
+
+    # @param [Array] issues List of issues on sub-section
+    # @param [String] prefix Name of sub-section
+    # @return [String] Generate section content
+    def generate_content
+      content = ""
+
+      if @issues.any?
+        content += "#{@prefix}\n\n" unless @options[:simple_list]
+        @issues.each do |issue|
+          merge_string = get_string_for_issue(issue)
+          content += "- #{merge_string}\n"
+        end
+        content += "\n"
+      end
+      content
+    end
+
+    private
+
+    # Parse issue and generate single line formatted issue line.
+    #
+    # Example output:
+    # - Add coveralls integration [\#223](https://github.com/skywinder/github-changelog-generator/pull/223) (@skywinder)
+    #
+    # @param [Hash] issue Fetched issue from GitHub
+    # @return [String] Markdown-formatted single issue
+    def get_string_for_issue(issue)
+      encapsulated_title = encapsulate_string issue["title"]
+
+      title_with_number = "#{encapsulated_title} [\\##{issue['number']}](#{issue['html_url']})"
+      if @options[:issue_line_labels].present?
+        title_with_number = "#{title_with_number}#{line_labels_for(issue)}"
+      end
+      issue_line_with_user(title_with_number, issue)
+    end
+
+    def issue_line_with_user(line, issue)
+      return line if !@options[:author] || issue["pull_request"].nil?
+
+      user = issue["user"]
+      return "#{line} ({Null user})" unless user
+
+      if @options[:usernames_as_github_logins]
+        "#{line} (@#{user['login']})"
+      else
+        "#{line} ([#{user['login']}](#{user['html_url']}))"
+      end
+    end
+
+    ENCAPSULATED_CHARACTERS = %w(< > * _ \( \) [ ] #)
+
+    # Encapsulate characters to make Markdown look as expected.
+    #
+    # @param [String] string
+    # @return [String] encapsulated input string
+    def encapsulate_string(string)
+      string = string.gsub('\\', '\\\\')
+
+      ENCAPSULATED_CHARACTERS.each do |char|
+        string = string.gsub(char, "\\#{char}")
+      end
+
+      string
+    end
+  end
+end
--- a/lib/github_changelog_generator/octo_fetcher.rb
+++ b/lib/github_changelog_generator/octo_fetcher.rb
@ -13,7 +13,7 @@ module GitHubChangelogGenerator
    MAX_THREAD_NUMBER = 25
    MAX_FORBIDDEN_RETRIES = 100
    CHANGELOG_GITHUB_TOKEN = "CHANGELOG_GITHUB_TOKEN"
-    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, change log may be " \
+    GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, changelog may be " \
    "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
    NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
    "This script can make only 50 requests to GitHub API per hour without token!"
--- a/lib/github_changelog_generator/options.rb
+++ b/lib/github_changelog_generator/options.rb
@ -1,13 +1,21 @@
 # frozen_string_literal: true

 require "delegate"
+require "github_changelog_generator/helper"
+
 module GitHubChangelogGenerator
+  # This class wraps Options, and knows a list of known options. Others options
+  # will raise exceptions.
  class Options < SimpleDelegator
+    # Raised on intializing with unknown keys in the values hash,
+    # and when trying to store a value on an unknown key.
    UnsupportedOptionError = Class.new(ArgumentError)

+    # List of valid option names
    KNOWN_OPTIONS = %i[
      add_issues_wo_labels
      add_pr_wo_labels
+      add_sections
      author
      base
      between_tags
@ -22,6 +30,7 @@ module GitHubChangelogGenerator
      enhancement_prefix
      breaking_labels
      breaking_prefix
+      configure_sections
      exclude_labels
      exclude_tags
      exclude_tags_regex
@ -43,6 +52,7 @@ module GitHubChangelogGenerator
      pulls
      release_branch
      release_url
+      require
      simple_list
      since_tag
      ssl_ca_file
@ -55,26 +65,66 @@ module GitHubChangelogGenerator
      verbose
    ]

+    # @param values [Hash]
+    #
+    # @raise [UnsupportedOptionError] if given values contain unknown options
    def initialize(values)
      super(values)
      unsupported_options.any? && raise(UnsupportedOptionError, unsupported_options.inspect)
    end

+    # Set option key to val.
+    #
+    # @param key [Symbol]
+    # @param val [Object]
+    #
+    # @raise [UnsupportedOptionError] when trying to set an unknown option
    def []=(key, val)
      supported_option?(key) || raise(UnsupportedOptionError, key.inspect)
      values[key] = val
    end

+    # @return [Hash]
    def to_hash
      values
    end

+    # Loads the configured Ruby files from the --require option.
+    def load_custom_ruby_files
+      self[:require].each { |f| require f }
+    end
+
+    # Pretty-prints a censored options hash, if :verbose.
+    def print_options
+      return unless self[:verbose]
+      Helper.log.info "Using these options:"
+      pp(censored_values)
+      puts ""
+    end
+
+    # Boolean method for whether the user is using configure_sections
+    def configure_sections?
+      !self[:configure_sections].nil? && !self[:configure_sections].empty?
+    end
+
+    # Boolean method for whether the user is using add_sections
+    def add_sections?
+      !self[:add_sections].nil? && !self[:add_sections].empty?
+    end
+
    private

    def values
      __getobj__
    end

+    # Returns a censored options hash.
+    #
+    # @return [Hash] The GitHub `:token` key is censored in the output.
+    def censored_values
+      values.clone.tap { |opts| opts[:token] = opts[:token].nil? ? "No token used" : "hidden value" }
+    end
+
    def unsupported_options
      values.keys - KNOWN_OPTIONS
    end
--- a/lib/github_changelog_generator/parser.rb
+++ b/lib/github_changelog_generator/parser.rb
@ -3,8 +3,9 @@

 require "optparse"
 require "pp"
-require_relative "version"
-require_relative "helper"
+require "github_changelog_generator/version"
+require "github_changelog_generator/helper"
+
 module GitHubChangelogGenerator
  class Parser
    # parse options with optparse
@ -19,43 +20,34 @@ module GitHubChangelogGenerator
        abort [e, parser].join("\n")
      end

-      abort(parser.banner) unless options[:user] && options[:project]
+      unless options[:user] && options[:project]
+        warn "Configure which user and project to work on."
+        warn "Options --user and --project, or settings to that effect. See --help for more."
+        abort(parser.banner)
+      end

-      print_options(options)
+      options.print_options

      options
    end

-    # If options set to verbose, print the parsed options.
+    # Setup parsing options
    #
-    # The GitHub `:token` key is censored in the output.
-    #
-    # @param options [Hash] The options to display
-    # @option options [Boolean] :verbose If false this method does nothing
-    def self.print_options(options)
-      if options[:verbose]
-        Helper.log.info "Performing task with options:"
-        options_to_display = options.clone
-        options_to_display[:token] = options_to_display[:token].nil? ? nil : "hidden value"
-        pp options_to_display
-        puts ""
-      end
-    end
-
-    # setup parsing options
+    # @param options [Options]
+    # @return [OptionParser]
    def self.setup_parser(options)
-      parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
-        opts.banner = "Usage: github_changelog_generator [options]"
-        opts.on("-u", "--user [USER]", "Username of the owner of target GitHub repo") do |last|
+      OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+        opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]"
+        opts.on("-u", "--user USER", "Username of the owner of target GitHub repo") do |last|
          options[:user] = last
        end
-        opts.on("-p", "--project [PROJECT]", "Name of project on GitHub") do |last|
+        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 per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
          options[:token] = last
        end
-        opts.on("-f", "--date-format [FORMAT]", "Date format. Default is %Y-%m-%d") do |last|
+        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d") do |last|
          options[:date_format] = last
        end
        opts.on("-o", "--output [NAME]", "Output file. Default is CHANGELOG.md") do |last|
@ -76,9 +68,15 @@ module GitHubChangelogGenerator
        opts.on("--issues-label [LABEL]", "Setup custom label for closed-issues section. Default is \"**Closed issues:**\"") do |v|
          options[:issue_prefix] = v
        end
-        opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Change Log\"") do |v|
+        opts.on("--header-label [LABEL]", "Setup custom header label. Default is \"# Changelog\"") do |v|
          options[:header] = v
        end
+        opts.on("--configure-sections [Hash, String]", "Define your own set of sections which overrides all default sections") do |v|
+          options[:configure_sections] = v
+        end
+        opts.on("--add-sections [Hash, String]", "Add new sections but keep the default sections") do |v|
+          options[:add_sections] = v
+        end
        opts.on("--front-matter [JSON]", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line") do |v|
          options[:frontmatter] = JSON.parse(v).to_yaml + "---\n"
        end
@ -121,7 +119,7 @@ module GitHubChangelogGenerator
        opts.on("--include-labels  x,y,z", Array, "Only issues with the specified labels will be included in the changelog.") do |list|
          options[:include_labels] = list
        end
-        opts.on("--exclude-labels  x,y,z", Array, 'Issues with the specified labels will be always excluded from changelog. Default is \'duplicate,question,invalid,wontfix\'') do |list|
+        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'") do |list|
          options[:exclude_labels] = list
        end
        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Fixed bugs" section. Default is \'bug,Bug\'') do |list|
@ -136,16 +134,16 @@ module GitHubChangelogGenerator
        opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
          options[:issue_line_labels] = list
        end
-        opts.on("--exclude-tags  x,y,z", Array, "Change log will exclude specified tags") do |list|
+        opts.on("--exclude-tags  x,y,z", Array, "Changelog will exclude specified tags") do |list|
          options[:exclude_tags] = list
        end
        opts.on("--exclude-tags-regex [REGEX]", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\" ") do |last|
          options[:exclude_tags_regex] = last
        end
-        opts.on("--since-tag  x", "Change log will start after specified tag") do |v|
+        opts.on("--since-tag  x", "Changelog will start after specified tag") do |v|
          options[:since_tag] = v
        end
-        opts.on("--due-tag  x", "Change log will end before specified tag") do |v|
+        opts.on("--due-tag  x", "Changelog will end before specified tag") do |v|
          options[:due_tag] = v
        end
        opts.on("--max-issues [NUMBER]", Integer, "Max number of issues to fetch from GitHub. Default is unlimited") do |max|
@ -181,6 +179,9 @@ module GitHubChangelogGenerator
        opts.on("--ssl-ca-file [PATH]", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
          options[:ssl_ca_file] = ssl_ca_file
        end
+        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require.") do |paths|
+          options[:require] = paths
+        end
        opts.on("--[no-]verbose", "Run verbosely. Default is true") do |v|
          options[:verbose] = v
        end
@ -193,10 +194,9 @@ module GitHubChangelogGenerator
          exit
        end
      end
-      parser
    end

-    # @return [Hash] Default options
+    # @return [Options] Default options
    def self.default_options
      Options.new(
        date_format: "%Y-%m-%d",
@ -215,18 +215,21 @@ module GitHubChangelogGenerator
        bug_labels: ["bug", "Bug", "Type: Bug"],
        exclude_labels: ["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"],
        breaking_labels: %w[backwards-incompatible breaking],
+        configure_sections: {},
+        add_sections: {},
        issue_line_labels: [],
        max_issues: nil,
        simple_list: false,
        ssl_ca_file: nil,
        verbose: true,
-        header: "# Change Log",
+        header: "# Changelog",
        merge_prefix: "**Merged pull requests:**",
        issue_prefix: "**Closed issues:**",
        bug_prefix: "**Fixed bugs:**",
        enhancement_prefix: "**Implemented enhancements:**",
        breaking_prefix: "**Breaking changes:**",
-        http_cache: true
+        http_cache: true,
+        require: []
      )
    end
  end
--- a/lib/github_changelog_generator/task.rb
+++ b/lib/github_changelog_generator/task.rb
@ -19,7 +19,7 @@ module GitHubChangelogGenerator
                  between_tags exclude_tags exclude_tags_regex since_tag max_issues
                  github_site github_endpoint simple_list
                  future_release release_branch verbose release_url
-                  base ]
+                  base configure_sections add_sections]

    OPTIONS.each do |o|
      attr_accessor o.to_sym
@ -37,7 +37,7 @@ module GitHubChangelogGenerator
    end

    def define(args, &task_block)
-      desc "Generate a Change log from GitHub"
+      desc "Generate a Changelog from GitHub"

      yield(*[self, args].slice(0, task_block.arity)) if task_block

--- a/lib/github_changelog_generator/version.rb
+++ b/lib/github_changelog_generator/version.rb
@ -1,5 +1,5 @@
 # frozen_string_literal: true

 module GitHubChangelogGenerator
-  VERSION = "1.15.0-beta"
+  VERSION = "1.15.0-rc"
 end
--- a/man/git-generate-changelog.1
+++ b/man/git-generate-changelog.1
@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
+.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2017" "" ""
 .
 .SH "NAME"
 \fBgit\-generate\-changelog\fR \- Generate changelog from github
@ -10,7 +10,7 @@
 \fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
 .
 .SH "DESCRIPTION"
-Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
+Automatically generate changelog from your tags, issues, labels and pull requests on GitHub\.
 .
 .SH "OPTIONS"
 \-u, \-\-user [USER]
@ -70,7 +70,7 @@ Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR
 \-\-header\-label [LABEL]
 .
 .P
-Setup custom header label\. Default is "# Change Log"
+Setup custom header label\. Default is "# Changelog"
 .
 .P
 \-\-front\-matter [JSON]
@ -175,16 +175,10 @@ Issues with the specified labels will be always added to "Fixed bugs" section\.
 Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
 .
 .P
-\-\-between\-tags x,y,z
-.
-.P
-Change log will be filled only between specified tags
-.
-.P
 \-\-exclude\-tags x,y,z
 .
 .P
-Change log will exclude specified tags
+Changelog will exclude specified tags
 .
 .P
 \-\-exclude\-tags\-regex [REGEX]
@ -196,13 +190,13 @@ Apply a regular expression on tag names so that they can be excluded, for exampl
 \-\-since\-tag x
 .
 .P
-Change log will start after specified tag
+Changelog will start after specified tag
 .
 .P
 \-\-due\-tag x
 .
 .P
-Change log will end before specified tag
+Changelog will end before specified tag
 .
 .P
 \-\-max\-issues [NUMBER]
@ -264,6 +258,25 @@ Filename to use for cache\. Default is github\-changelog\-http\-cache in a tempo
 .P
 Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
 .
+.IP "" 4
+.
+.nf
+
+\-\-ssl\-ca\-file [PATH]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Path to cacert\.pem file\. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert\.pem\. Respects SSL_CA_PATH\.
+.
+.P
+\-\-require file1\.rb,file2\.rb
+.
+.P
+Paths to Ruby file(s) to require before generating changelog\.
+.
 .P
 \-\-[no\-]verbose
 .
@ -271,6 +284,18 @@ Filename to use for cache log\. Default is github\-changelog\-logger\.log in a t
 Run verbosely\. Default is true
 .
 .P
+\-\-configure\-sections [HASH, STRING]
+.
+.P
+Define your own set of sections which overrides all default sections") do |v|
+.
+.P
+\-\-add\-sections [HASH, STRING]
+.
+.P
+Add new sections but keep the default sections"
+.
+.P
 \-v, \-\-version
 .
 .P
--- a/man/git-generate-changelog.1.html
+++ b/man/git-generate-changelog.1.html
@ -80,7 +80,7 @@

 <h2 id="DESCRIPTION">DESCRIPTION</h2>

-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>

 <h2 id="OPTIONS">OPTIONS</h2>

@ -122,7 +122,7 @@

 <p>   --header-label [LABEL]</p>

-<p>   Setup custom header label. Default is "# Change Log"</p>
+<p>   Setup custom header label. Default is "# Changelog"</p>

 <p>   --front-matter [JSON]</p>

@ -194,7 +194,7 @@

 <p>   --exclude-tags x,y,z</p>

-<p>   Change log will exclude specified tags</p>
+<p>   Changelog will exclude specified tags</p>

 <p>   --exclude-tags-regex [REGEX]</p>

@ -202,11 +202,11 @@

 <p>   --since-tag x</p>

-<p>   Change log will start after specified tag</p>
+<p>   Changelog will start after specified tag</p>

 <p>   --due-tag x</p>

-<p>   Change log will end before specified tag</p>
+<p>   Changelog will end before specified tag</p>

 <p>   --max-issues [NUMBER]</p>

@ -248,17 +248,34 @@

 <p>   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.</p>

+<pre><code>--ssl-ca-file [PATH]
+</code></pre>
+
+<p>   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.</p>
+
+<p>   --require file1.rb,file2.rb</p>
+
+<p>   Paths to Ruby file(s) to require before generating changelog.</p>
+
 <p>   --[no-]verbose</p>

 <p>   Run verbosely. Default is true</p>

-<p>  -v, --version</p>
+<p>   --configure-sections [HASH, STRING]</p>

-<p>  Print version number</p>
+<p>   Define your own set of sections which overrides all default sections") do |v|</p>

-<p>  -h, --help</p>
+<p>   --add-sections [HASH, STRING]</p>

-<p>  Displays Help</p>
+<p>   Add new sections but keep the default sections"</p>
+
+<p>   -v, --version</p>
+
+<p>   Print version number</p>
+
+<p>   -h, --help</p>
+
+<p>   Displays Help</p>

 <h2 id="EXAMPLES">EXAMPLES</h2>

@ -277,7 +294,7 @@

  <ol class='man-decor man-foot man foot'>
    <li class='tl'></li>
-    <li class='tc'>December 2016</li>
+    <li class='tc'>December 2017</li>
    <li class='tr'>git-generate-changelog(1)</li>
  </ol>

--- a/man/git-generate-changelog.html
+++ b/man/git-generate-changelog.html
@ -80,7 +80,7 @@

 <h2 id="DESCRIPTION">DESCRIPTION</h2>

-<p>Automatically generate change log from your tags, issues, labels and pull requests on GitHub.</p>
+<p>Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.</p>

 <h2 id="OPTIONS">OPTIONS</h2>

@ -122,7 +122,7 @@

 <p>   --header-label [LABEL]</p>

-<p>   Setup custom header label. Default is "# Change Log"</p>
+<p>   Setup custom header label. Default is "# Changelog"</p>

 <p>   --pr-label [LABEL]</p>

@ -186,15 +186,15 @@

 <p>   --exclude-tags x,y,z</p>

-<p>   Change log will exclude specified tags</p>
+<p>   Changelog will exclude specified tags</p>

 <p>   --since-tag x</p>

-<p>   Change log will start after specified tag</p>
+<p>   Changelog will start after specified tag</p>

 <p>   --due-tag x</p>

-<p>   Change log will end before specified tag</p>
+<p>   Changelog will end before specified tag</p>

 <p>   --max-issues [NUMBER]</p>

@ -220,6 +220,18 @@

 <p>   Put the unreleased changes in the specified release number.</p>

+<p>   --configure-sections [HASH, STRING]</p>
+
+<p>   Define your own set of sections which overrides all default sections") do |v|</p>
+
+<p>   --add-sections [HASH, STRING]</p>
+
+<p>   Add new sections but keep the default sections"</p>
+
+<p>   --include-merged</p>
+
+<p>   If configure_sections is set, use this to restore the merged pull requests sections</p>
+
 <p>   --[no-]verbose</p>

 <p>   Run verbosely. Default is true</p>
--- a/man/git-generate-changelog.md
+++ b/man/git-generate-changelog.md
@ -1,4 +1,4 @@
-git-generate-changelog(1) - Generate changelog from github
+git-generate-changelog(1) - Generate changelog from GitHub
 ================================

 ## SYNOPSIS
@ -7,7 +7,7 @@ git-generate-changelog(1) - Generate changelog from github

 ## DESCRIPTION

-Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
+Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.

 ## OPTIONS

@ -49,7 +49,7 @@ Automatically generate change log from your tags, issues, labels and pull reques

   --header-label [LABEL]

-   Setup custom header label. Default is "# Change Log"
+   Setup custom header label. Default is "# Changelog"

   --front-matter [JSON]

@ -121,7 +121,7 @@ Automatically generate change log from your tags, issues, labels and pull reques

   --exclude-tags x,y,z

-   Change log will exclude specified tags
+   Changelog will exclude specified tags

   --exclude-tags-regex [REGEX]

@ -129,11 +129,11 @@ Automatically generate change log from your tags, issues, labels and pull reques

   --since-tag x

-   Change log will start after specified tag
+   Changelog will start after specified tag

   --due-tag x

-   Change log will end before specified tag
+   Changelog will end before specified tag

   --max-issues [NUMBER]

@ -177,19 +177,31 @@ Automatically generate change log from your tags, issues, labels and pull reques

    --ssl-ca-file [PATH]

-   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem.  Respects SSL_CA_PATH.
+   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
+
+   --require file1.rb,file2.rb
+
+   Paths to Ruby file(s) to require before generating changelog.

   --[no-]verbose

   Run verbosely. Default is true

-  -v, --version
+   --configure-sections [HASH, STRING]

-  Print version number
+   Define your own set of sections which overrides all default sections") do |v|

-  -h, --help
+   --add-sections [HASH, STRING]

-  Displays Help
+   Add new sections but keep the default sections"
+
+   -v, --version
+
+   Print version number
+
+   -h, --help
+
+   Displays Help


 ## EXAMPLES
--- a/spec/files/github-changelog-generator.md
+++ b/spec/files/github-changelog-generator.md
@ -1,4 +1,4 @@
-# Change Log
+# Changelog

 ## [1.3.10](https://github.com/skywinder/Github-Changelog-Generator/tree/1.3.10) (2015-03-18)

@ -302,4 +302,4 @@



-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
--- a/spec/unit/generator/entry_spec.rb
+++ b/spec/unit/generator/entry_spec.rb
@ -0,0 +1,362 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ModuleLength
+module GitHubChangelogGenerator
+  RSpec.describe Entry do
+    def label(name)
+      { "name" => name }
+    end
+
+    def issue(title, labels, number = "1", user = { "login" => "user" })
+      {
+        "title" => "issue #{title}",
+        "labels" => labels.map { |l| label(l) },
+        "number" => number,
+        "html_url" => "https://github.com/owner/repo/issue/#{number}",
+        "user" => user
+      }
+    end
+
+    def pr(title, labels, number = "1", user = { "login" => "user" })
+      {
+        "pull_request" => true,
+        "title" => "pr #{title}",
+        "labels" => labels.map { |l| label(l) },
+        "number" => number,
+        "html_url" => "https://github.com/owner/repo/pull/#{number}",
+        "user" => user.merge("html_url" => "https://github.com/#{user['login']}")
+      }
+    end
+
+    def titles_for(issues)
+      issues.map { |issue| issue["title"] }
+    end
+
+    def default_sections
+      %w[enhancements bugs breaking issues]
+    end
+
+    describe "#create_entry_for_tag" do
+      let(:options) do
+        Parser.default_options.merge(
+          user: "owner",
+          project: "repo",
+          bug_labels: ["bug"],
+          enhancement_labels: ["enhancement"],
+          breaking_labels: ["breaking"]
+        )
+      end
+
+      let(:issues) do
+        [
+          issue("no labels", [], "5", "login" => "user1"),
+          issue("enhancement", ["enhancement"], "6", "login" => "user2"),
+          issue("bug", ["bug"], "7", "login" => "user1"),
+          issue("breaking", ["breaking"], "8", "login" => "user5"),
+          issue("all the labels", %w[enhancement bug breaking], "9", "login" => "user9")
+        ]
+      end
+
+      let(:pull_requests) do
+        [
+          pr("no labels", [], "10", "login" => "user1"),
+          pr("enhancement", ["enhancement"], "11", "login" => "user5"),
+          pr("bug", ["bug"], "12", "login" => "user5"),
+          pr("breaking", ["breaking"], "13", "login" => "user5"),
+          pr("all the labels", %w[enhancement bug breaking], "14", "login" => "user5")
+        ]
+      end
+
+      subject { described_class.new(options) }
+      it "generates a header and body" do
+        changelog = <<-CHANGELOG.gsub(/^ {8}/, "")
+        ## [1.0.1](https://github.com/owner/repo/tree/1.0.1) (2017-12-04)
+
+        [Full Changelog](https://github.com/owner/repo/compare/1.0.0...1.0.1)
+
+        **Breaking changes:**
+
+        - issue breaking [\\#8](https://github.com/owner/repo/issue/8)
+        - pr breaking [\\#13](https://github.com/owner/repo/pull/13) ([user5](https://github.com/user5))
+
+        **Implemented enhancements:**
+
+        - issue enhancement [\\#6](https://github.com/owner/repo/issue/6)
+        - issue all the labels [\\#9](https://github.com/owner/repo/issue/9)
+        - pr enhancement [\\#11](https://github.com/owner/repo/pull/11) ([user5](https://github.com/user5))
+        - pr all the labels [\\#14](https://github.com/owner/repo/pull/14) ([user5](https://github.com/user5))
+
+        **Fixed bugs:**
+
+        - issue bug [\\#7](https://github.com/owner/repo/issue/7)
+        - pr bug [\\#12](https://github.com/owner/repo/pull/12) ([user5](https://github.com/user5))
+
+        **Closed issues:**
+
+        - issue no labels [\\#5](https://github.com/owner/repo/issue/5)
+
+        **Merged pull requests:**
+
+        - pr no labels [\\#10](https://github.com/owner/repo/pull/10) ([user1](https://github.com/user1))
+
+        CHANGELOG
+        expect(subject.create_entry_for_tag(pull_requests, issues, "1.0.1", "1.0.1", Time.new(2017, 12, 4), "1.0.0")).to eq(changelog)
+      end
+    end
+    describe "#parse_sections" do
+      before do
+        subject { described_class.new }
+      end
+      context "valid json" do
+        let(:sections_string) { "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}, \"bar\": { \"prefix\": \"barfix\", \"labels\": [\"test3\", \"test4\"]}}" }
+
+        let(:sections_array) do
+          [
+            Section.new(name: "foo", prefix: "foofix", labels: %w[test1 test2]),
+            Section.new(name: "bar", prefix: "barfix", labels: %w[test3 test4])
+          ]
+        end
+
+        it "returns an array with 2 objects" do
+          arr = subject.send(:parse_sections, sections_string)
+          expect(arr.size).to eq 2
+          arr.each { |section| expect(section).to be_an_instance_of Section }
+        end
+
+        it "returns correctly constructed sections" do
+          require "json"
+
+          sections_json = JSON.parse(sections_string)
+          sections_array.each_index do |i|
+            aggregate_failures "checks each component" do
+              expect(sections_array[i].name).to eq sections_json.first[0]
+              expect(sections_array[i].prefix).to eq sections_json.first[1]["prefix"]
+              expect(sections_array[i].labels).to eq sections_json.first[1]["labels"]
+              expect(sections_array[i].issues).to eq []
+            end
+            sections_json.shift
+          end
+        end
+      end
+      context "hash" do
+        let(:sections_hash) do
+          {
+            enhancements: {
+              prefix: "**Enhancements**",
+              labels: %w[feature enhancement]
+            },
+            breaking: {
+              prefix: "**Breaking**",
+              labels: ["breaking"]
+            },
+            bugs: {
+              prefix: "**Bugs**",
+              labels: ["bug"]
+            }
+          }
+        end
+
+        let(:sections_array) do
+          [
+            Section.new(name: "enhancements", prefix: "**Enhancements**", labels: %w[feature enhancement]),
+            Section.new(name: "breaking", prefix: "**Breaking**", labels: ["breaking"]),
+            Section.new(name: "bugs", prefix: "**Bugs**", labels: ["bug"])
+          ]
+        end
+
+        it "returns an array with 3 objects" do
+          arr = subject.send(:parse_sections, sections_hash)
+          expect(arr.size).to eq 3
+          arr.each { |section| expect(section).to be_an_instance_of Section }
+        end
+
+        it "returns correctly constructed sections" do
+          sections_array.each_index do |i|
+            aggregate_failures "checks each component" do
+              expect(sections_array[i].name).to eq sections_hash.first[0].to_s
+              expect(sections_array[i].prefix).to eq sections_hash.first[1][:prefix]
+              expect(sections_array[i].labels).to eq sections_hash.first[1][:labels]
+              expect(sections_array[i].issues).to eq []
+            end
+            sections_hash.shift
+          end
+        end
+      end
+    end
+
+    describe "#parse_by_sections" do
+      context "default sections" do
+        let(:options) do
+          {
+            bug_labels: ["bug"],
+            enhancement_labels: ["enhancement"],
+            breaking_labels: ["breaking"]
+          }
+        end
+
+        let(:issues) do
+          [
+            issue("no labels", []),
+            issue("enhancement", ["enhancement"]),
+            issue("bug", ["bug"]),
+            issue("breaking", ["breaking"]),
+            issue("all the labels", %w[enhancement bug breaking])
+          ]
+        end
+
+        let(:pull_requests) do
+          [
+            pr("no labels", []),
+            pr("enhancement", ["enhancement"]),
+            pr("bug", ["bug"]),
+            pr("breaking", ["breaking"]),
+            pr("all the labels", %w[enhancement bug breaking])
+          ]
+        end
+
+        subject { described_class.new(options) }
+
+        before do
+          subject.send(:set_sections_and_maps)
+          @arr = subject.send(:parse_by_sections, pull_requests, issues)
+        end
+
+        it "returns 4 sections" do
+          expect(@arr.size).to eq 4
+        end
+
+        it "returns default sections" do
+          default_sections.each { |default_section| expect(@arr.select { |section| section.name == default_section }.size).to eq 1 }
+        end
+
+        it "assigns issues to the correct sections" do
+          breaking_section = @arr.select { |section| section.name == "breaking" }[0]
+          enhancement_section = @arr.select { |section| section.name == "enhancements" }[0]
+          issue_section = @arr.select { |section| section.name == "issues" }[0]
+          bug_section = @arr.select { |section| section.name == "bugs" }[0]
+
+          expect(titles_for(breaking_section.issues)).to eq(["issue breaking", "pr breaking"])
+          expect(titles_for(enhancement_section.issues)).to eq(["issue enhancement", "issue all the labels", "pr enhancement", "pr all the labels"])
+          expect(titles_for(issue_section.issues)).to eq(["issue no labels"])
+          expect(titles_for(bug_section.issues)).to eq(["issue bug", "pr bug"])
+          expect(titles_for(pull_requests)).to eq(["pr no labels"])
+        end
+      end
+      context "configure sections" do
+        let(:options) do
+          {
+            configure_sections: "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}, \"bar\": { \"prefix\": \"barfix\", \"labels\": [\"test3\", \"test4\"]}}"
+          }
+        end
+
+        let(:issues) do
+          [
+            issue("no labels", []),
+            issue("test1", ["test1"]),
+            issue("test3", ["test3"]),
+            issue("test4", ["test4"]),
+            issue("all the labels", %w[test1 test2 test3 test4])
+          ]
+        end
+
+        let(:pull_requests) do
+          [
+            pr("no labels", []),
+            pr("test1", ["test1"]),
+            pr("test3", ["test3"]),
+            pr("test4", ["test4"]),
+            pr("all the labels", %w[test1 test2 test3 test4])
+          ]
+        end
+
+        subject { described_class.new(options) }
+
+        before do
+          subject.send(:set_sections_and_maps)
+          @arr = subject.send(:parse_by_sections, pull_requests, issues)
+        end
+
+        it "returns 2 sections" do
+          expect(@arr.size).to eq 2
+        end
+
+        it "returns only configured sections" do
+          expect(@arr.select { |section| section.name == "foo" }.size).to eq 1
+          expect(@arr.select { |section| section.name == "bar" }.size).to eq 1
+        end
+
+        it "assigns issues to the correct sections" do
+          foo_section = @arr.select { |section| section.name == "foo" }[0]
+          bar_section = @arr.select { |section| section.name == "bar" }[0]
+
+          aggregate_failures "checks all sections" do
+            expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "pr test1", "pr all the labels"])
+            expect(titles_for(bar_section.issues)).to eq(["issue test3", "issue test4", "pr test3", "pr test4"])
+            expect(titles_for(pull_requests)).to eq(["pr no labels"])
+          end
+        end
+      end
+      context "add sections" do
+        let(:options) do
+          {
+            bug_labels: ["bug"],
+            enhancement_labels: ["enhancement"],
+            breaking_labels: ["breaking"],
+            add_sections: "{ \"foo\": { \"prefix\": \"foofix\", \"labels\": [\"test1\", \"test2\"]}}"
+          }
+        end
+
+        let(:issues) do
+          [
+            issue("no labels", []),
+            issue("test1", ["test1"]),
+            issue("bugaboo", ["bug"]),
+            issue("all the labels", %w[test1 test2 enhancement bug])
+          ]
+        end
+
+        let(:pull_requests) do
+          [
+            pr("no labels", []),
+            pr("test1", ["test1"]),
+            pr("enhance", ["enhancement"]),
+            pr("all the labels", %w[test1 test2 enhancement bug])
+          ]
+        end
+
+        subject { described_class.new(options) }
+
+        before do
+          subject.send(:set_sections_and_maps)
+          @arr = subject.send(:parse_by_sections, pull_requests, issues)
+        end
+
+        it "returns 5 sections" do
+          expect(@arr.size).to eq 5
+        end
+
+        it "returns default sections" do
+          default_sections.each { |default_section| expect(@arr.select { |section| section.name == default_section }.size).to eq 1 }
+        end
+
+        it "returns added section" do
+          expect(@arr.select { |section| section.name == "foo" }.size).to eq 1
+        end
+
+        it "assigns issues to the correct sections" do
+          foo_section = @arr.select { |section| section.name == "foo" }[0]
+          enhancement_section = @arr.select { |section| section.name == "enhancements" }[0]
+          bug_section = @arr.select { |section| section.name == "bugs" }[0]
+
+          aggregate_failures "checks all sections" do
+            expect(titles_for(foo_section.issues)).to eq(["issue test1", "issue all the labels", "pr test1", "pr all the labels"])
+            expect(titles_for(enhancement_section.issues)).to eq(["pr enhance"])
+            expect(titles_for(bug_section.issues)).to eq(["issue bugaboo"])
+            expect(titles_for(pull_requests)).to eq(["pr no labels"])
+          end
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ModuleLength
--- a/spec/unit/generator/generator_generation_spec.rb
+++ b/spec/unit/generator/generator_generation_spec.rb
@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module GitHubChangelogGenerator
-  describe Generator do
-    describe "#get_string_for_issue" do
-      let(:issue) do
-        { "title" => "Bug in code" }
-      end
-
-      it "formats an issue according to options" do
-        expect do
-          described_class.new.get_string_for_issue(issue)
-        end.not_to raise_error
-      end
-    end
-
-    describe "#parse_by_sections" do
-      def label(name)
-        { "name" => name }
-      end
-
-      def issue(title, labels)
-        { "title" => "issue #{title}", "labels" => labels.map { |l| label(l) } }
-      end
-
-      def pr(title, labels)
-        { "title" => "pr #{title}", "labels" => labels.map { |l| label(l) } }
-      end
-
-      def get_titles(issues)
-        issues.map { |issue| issue["title"] }
-      end
-
-      let(:options) do
-        {
-          bug_labels: ["bug"],
-          enhancement_labels: ["enhancement"],
-          breaking_labels: ["breaking"]
-        }
-      end
-
-      let(:issues) do
-        [
-          issue("no labels", []),
-          issue("enhancement", ["enhancement"]),
-          issue("bug", ["bug"]),
-          issue("breaking", ["breaking"]),
-          issue("all the labels", %w[enhancement bug breaking])
-        ]
-      end
-
-      let(:pull_requests) do
-        [
-          pr("no labels", []),
-          pr("enhancement", ["enhancement"]),
-          pr("bug", ["bug"]),
-          pr("breaking", ["breaking"]),
-          pr("all the labels", %w[enhancement bug breaking])
-        ]
-      end
-
-      it "works" do
-        sections = described_class.new(options).parse_by_sections(issues, pull_requests)
-
-        expect(get_titles(sections[:issues])).to eq(["issue no labels"])
-        expect(get_titles(sections[:enhancements])).to eq(["issue enhancement", "issue all the labels", "pr enhancement", "pr all the labels"])
-        expect(get_titles(sections[:bugs])).to eq(["issue bug", "pr bug"])
-        expect(get_titles(sections[:breaking])).to eq(["issue breaking", "pr breaking"])
-        expect(get_titles(pull_requests)).to eq(["pr no labels"])
-      end
-    end
-  end
-end
--- a/spec/unit/reader_spec.rb
+++ b/spec/unit/reader_spec.rb
@ -51,7 +51,7 @@ describe GitHubChangelogGenerator::Reader do
      it { is_expected.to be_empty }
    end
    context "when file has only the header" do
-      subject { @reader.parse("# Change Log") }
+      subject { @reader.parse("# Changelog") }
      it { is_expected.to be_an(Array) }
      it { is_expected.to be_empty }
    end
Author	SHA1	Message	Date
Olle Jonsson	f977cd1072	Linting: formatting code to suit RuboCop (#611 )	2018-01-01 17:02:25 +01:00
Ben Holden-Crowther	77c7234cf4	Update git-generate-changelog.md (#607 )	2018-01-01 16:20:54 +01:00
Ben Holden-Crowther	bf0b73b1c0	Update license date (#610 )	2018-01-01 16:08:34 +01:00
Olle Jonsson	941a92e96d	RuboCop linting	2017-12-29 16:17:02 +01:00
Olle Jonsson	e2ddb73373	Merge pull request #587 from eputnam/config_sections Add option --configure-sections, --add-sections, --include-merged	2017-12-15 16:23:29 +01:00
Ben Holden-Crowther	8d0bb7d22d	Capitalization and full stops (#605 )	2017-12-15 16:01:04 +01:00
Eric Putnam	587557e1ac	Refactor generation code and allow custom sections There's a lot in this PR. - Added a Section class to more easily make the other changes and hopefully add flexibility for the future - Added an option called `configure_sections` that allows you create your own custom sections. It blows away all other sections and uses only the ones you give it. - Added an option called `add_sections` that allows you to add_sections to the default section set - Added an option called `include_merged` that can be used when configure_sections is defined. Configure sections blows away any and all default sections so to get this one back, you have to set this option. - Added tests for this stuff @HAIL9000 was a co-author. Because of a little git snafu, I accidentally squashed all of our work into one so it looks like it was just me. --- Refactor details: Before this change, the code in generator.rb and generator_generation.rb was conflated and method call flow went back and forth between the two files seemingly randomly. They also both defined the exact same class, which is un-ruby-ish. I tried to separate methods used for the whole changelog generation from methods used for specific parts of the changelog and move them into specific classes. I reasoned that a changelog is a series of "entries" of all tagged releases plus an extra entry for the unreleased entry. Each entry is comprised of a header and a series of "sections" for that entry. Each section is comprized of a list of issues and/or pull requests for that entry. So the log contains entries, entries contain sections, and sections contain issues & prs. I have structured the classes around this idea. - lib/github_changelog_generator/generator/generator.rb is for code related to generating the entire changelog. - lib/github_changelog_generator/generator/entry.rb is for code related to generating entries. - lib/github_changelog_generator/generator/section.rb is for code relating to geneating entry sections. Issues and PRs are already special objects, so it doesn't make sense to break those out into their own class.	2017-12-14 16:13:41 -08:00
Saugat Acharya	d9cf6ffd94	Make 'change log' a single word (#579 )	2017-12-13 22:06:00 +01:00
Ben Holden-Crowther	d5f82c5994	README: Improve readability of GitHub error message explanation (#601 ) - As per #600 - [ci skip]	2017-12-13 21:02:26 +01:00
Olle Jonsson	ab6b38e315	RuboCop 0.52.0 linting (#603 ) * gemspec: Make 2.2.2 the earliest-supported Ruby version * Exclude linting which came out wrong	2017-12-13 21:00:36 +01:00
mueller-ma	9a9e57c9eb	Add $ or # to indicate whether a command needs to be run as root or n… (#602 ) - [ci skip]	2017-12-13 21:00:15 +01:00
Ben Holden-Crowther	ff6a9c0ff3	Minor change (#597 ) Another minor grammar change. [ci skip]	2017-12-10 13:01:28 +01:00
Olle Jonsson	5137c673a7	Merge pull request #596 from benhc123/patch-2 minor cosmetic change	2017-12-09 12:26:59 +01:00
Ben Holden-Crowther	1ded80026f	minor cosmetic change full stop and website vs Web site	2017-12-09 11:07:40 +00:00
Olle Jonsson	11d65548b8	Travis: jruby-9.1.15.0	2017-12-08 09:17:39 +01:00
Marco Ferrari	e87b267b0e	Implemented a Dockerfile (#592 ) * Implemented a Dockerfile. See skywinder/github-changelog-generator#591 * Set Ferrari Marco as a maintainer * Explicitly install the latest released version	2017-11-23 14:08:50 +01:00
Olle Jonsson	72452a1315	CHANGELOG for v1.15.0-rc	2017-10-29 19:03:26 +01:00
Olle Jonsson	9377fe600a	v1.15.0-rc	2017-10-29 18:59:21 +01:00
Olle Jonsson	11a7243de1	README: Markdown typo [ci skip]	2017-10-29 17:54:43 +01:00
Olle Jonsson	307994e11f	Merge pull request #578 from olleolleolle/improve-abort-on-missing-info Aborting on missing --user and --project prints all of usage	2017-10-27 09:48:35 +02:00
Olle Jonsson	4465adf943	Linting	2017-10-27 09:29:17 +02:00
Olle Jonsson	5834fd3766	Update parser.rb	2017-10-27 09:28:52 +02:00
Olle Jonsson	b486425af1	Parser: less wordy output	2017-10-27 09:28:52 +02:00
Olle Jonsson	91ac00c1d3	Abort with friendly message on no user or project	2017-10-27 09:28:52 +02:00
Olle Jonsson	4f640b74ac	Aborting prints all of usage	2017-10-27 09:28:52 +02:00
Olle Jonsson	178ebfb1e7	Travis: in smoke tests, skip codeclimate	2017-10-27 09:00:08 +02:00
Olle Jonsson	eef787d74d	Travis: use pre-installed Rubies - for faster feedback	2017-10-27 08:52:23 +02:00
Olle Jonsson	faf2ddd552	Linting	2017-10-27 08:49:52 +02:00
Olle Jonsson	14c36317f1	Merge pull request #584 from olleolleolle/fix/rake-task-missing-options Add Rake options reported missing	2017-10-26 14:45:02 +02:00
Olle Jonsson	deb902ae13	Add Rake options reported missing	2017-10-26 01:35:51 +02:00
Olle Jonsson	10e6287866	Merge pull request #576 from olleolleolle/fix/docs-for-api Options#print_options + API docs for Options, Parser	2017-10-14 22:13:12 +02:00
Olle Jonsson	5bb4d51b96	Options#print_options: tell don't ask	2017-10-14 21:52:26 +02:00
Olle Jonsson	1fac4efe47	[docs] API docs for Options, Parser - shorten implementation of print_options	2017-10-14 21:28:02 +02:00
Olle Jonsson	ad0d972ed9	Add option --require to load custom Ruby code (#574 )	2017-10-14 21:00:56 +02:00
Olle Jonsson	79518161b8	[docs] Contributing file (#575 ) - [ci skip]	2017-10-14 15:33:34 +02:00
Olle Jonsson	db0e848208	CHANGELOG for v1.15.0.pre.beta	2017-10-13 21:14:22 +02:00