release-notes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 691d3c472f9792ce0e682085a84f2207f6a4fdda
+  data.tar.gz: bb273e2057859b3a70ffcf692ed6f442152df7d9
+SHA512:
+  metadata.gz: e056b89f89730bb42537f613e7dcb23363ee4ff25c74aecb54711882935cd2f29912b0a86ef4e3a4af7ea11d5012c55c371033f661b0248ec224b2bd0fb9601b
+  data.tar.gz: ed86f0d78b8f71c11e8f39766a3e92f403da70c6711e933b375d1c84c061bfffc903c325ea9b494395b817eff227bf5a36933256cf5bab09538c78ebe44a91c1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+RELEASE_NOTES.md
+release-notes.tmp.md

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.12.5
+env:
+  global:
+    secure: ovawk+NnGZGW+hOeC3iPMZ9jKY5FvaxfHLj6XX4Vfe12cq0cdGYirW6pk2uKdJZdE0pC5q4sFv1ZTgcNSTySuNpQ9Gkp4xjcGEVr5JSdmVse8DuxttwkeSPt94DemyMK3f0A3dWN8OJF7/NQbacPeUuXryxmusCqJMlWccVYGeSQQNJ21mFfl2pCf6Z9qls4Q3rzXc4hsVQ5G1B/j9YcMjax0EwXI4cEq/6JadK4OmXrGkCw6M/wvBEqNyhLz+R/gcYiJZqYUETdncRuNiH8N6JKiaCnZUFkGY4bggpOvz29lj3JEQV9jY+3UBeqxuYj3glT7buEuf6//ARedY7IDlupkiDNuSpIKJhzIKAgitc/g+cnUflQV8PiImAEseO0OpoAJ7Bsa688EgyvMgo/kYwjHqZetvlUksQI+XyZ+o7/88LF2Qz4pbuBtdFC4DaKaeqQN5afIHSPtxhYwFA/n+GmY4jymj5ZWod9zZasVdlDgCQzgH5M1W7nEGun8mRW93wf8+3wAx+fXVbB67aDbqJFBJfH6zm/aBCN16kGkHUibRxUyb0F52woBQLUcOIr9Kbujp02D7IK3Z7PFz+DtHfA8aYRXxRDIHxx0tw91UxQzBinsq27kH8EWDmEKMHJeZlMRR4X4ijd6+KFoKUobXFblCeVeO0HCIBxpfTc39w=
+after_success:
+  - bundle exec codeclimate-test-reporter

data/.yardopts

@@ -0,0 +1,6 @@
+--protected
+--private
+--hide-api private
+--exclude templates
+--markup markdown
+--markup-provider redcarpet

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dvmonroe6@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in release-notes.gemspec
+gemspec
+
+group :test do
+  gem 'aruba', '~> 0.14.2'
+  gem 'codeclimate-test-reporter', require: false
+  gem 'pry-byebug', '~> 3.4.2'
+  gem 'rspec', '~> 3.6.0'
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Drew Monroe
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,179 @@
+# Release::Notes
+
+[![Build Status](https://travis-ci.org/dvmonroe/release-notes.svg?branch=master)](https://travis-ci.org/dvmonroe/release-notes)
+[![Code Climate](https://codeclimate.com/github/dvmonroe/release-notes/badges/gpa.svg)](https://codeclimate.com/github/dvmonroe/release-notes)
+[![Test Coverage](https://codeclimate.com/github/dvmonroe/release-notes/badges/coverage.svg)](https://codeclimate.com/github/dvmonroe/release-notes/coverage)
+[![Inline docs](http://inch-ci.org/github/dvmonroe/release-notes.svg?branch=master)](http://inch-ci.org/github/dvmonroe/release-notes)
+
+Release notes for the stakeholders.
+
+Release::Notes is a small wrapper around your project's git log. The gem is
+intended to help increase visability to all team members and stakeholders with
+automated documentation of important changes made to your code base for a given production
+deployment based on tags and labels in your commit messages.
+
+Release::Notes is different than a changelog. It's meant for situations where other
+team members (non-devs) in your organization need to know about key changes
+to the production software.  If your looking for a comprehnsive changelog that
+reflects resolved github issues or logging all merges to your project, I would
+suggest you look at something else like
+[github-changelog-generator](https://github.com/skywinder/github-changelog-generator).
+
+Not looking for a tested gem or prefer the rawness of a bash script? Checkout the similar
+[bash implementation](https://gist.github.com/dvmonroe/300226a1ed4435fb38d72e72e1bbc5a0)
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'release-notes'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install release-notes
+```
+
+After you install Release::Notes, if you're using with rails, you can run the generator:
+
+```sh
+$ rails generate release:notes:install
+```
+
+This Release::Notes generator creates an initializer file to allow further configuration.
+
+If you're not in a rails project you can create the file yourself.
+
+
+## Configure
+
+Override any of these defaults in `config/initializers/release_notes.rb`:
+
+```ruby
+Release::Notes.configure do |config|
+  config.output_file = './RELEASE_NOTES.md'
+  config.temp_file = './release-notes.tmp.md'
+  config.include_merges = false
+  config.ignore_case = true
+  config.log_format = '- %s'
+  config.extended_regex = true
+  config.bug_labels = %w[Fix Update]
+  config.feature_labels = %w[Add Create]
+  config.misc_labels = %w[Refactor]
+  config.bug_title = '**Fixed bugs:**'
+  config.feature_title = '**Implemented enhancements:**'
+  config.misc_title = '**Miscellaneous:**'
+  config.link_to_labels = %w[]
+  config.link_to_humanize = %w[]
+  config.link_to_sites = %w[]
+  config.timezone = 'America/New_York'
+end
+```
+
+For more information about each individual setting checkout Release::Notes's
+[config docs](http://www.rubydoc.info/github/dvmonroe/release-notes/master/Release/Notes/Configuration).
+
+## Usage
+
+### TL;DR
+
+```sh
+bundle exec update_release_notes:run
+```
+
+### Git Worklow
+
+Release::Notes works best with a rebase workflow and requires tagging. General rebase benefits include:
+
+* One clear commit per feature, bug or miscellaneous addition to the codebase  
+* Commits in logical time manner  
+
+By default configuration, Release::Notes ignores merges. Along with rebasing, by deafult,
+Release::Notes relies mainly on the subject of a commit. Therefore, it's important to craft concise and
+meaningful commit subjects with longer bodies as needed for larger feature additions or bug fixes.
+
+For more information about a rebase workflow or crafting solid commit messages
+check out the following links
+
+* [Commit Messages](http://chris.beams.io/posts/git-commit/)  
+* [Git Rebase Workflow](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
+
+### Deploying with Capistrano
+
+If using Rails, a rake task is included and would be best utilized within your deploy script.
+
+If not on rails, but using rake, you can easily craft your own rake task.  At the very least calling
+
+```ruby
+Release::Notes::Update.new.run
+```
+is the only instance that needs to be instantiated and invoked.
+
+A sample capistrano production file might look something like this:
+
+```ruby
+# config/deploy/production.rb
+server 'the_name_for_my_server', user: 'deploy', roles: %w{app web}
+
+set :application, 'my_app'
+set :deploy_to, '/var/www/my_app'
+
+
+namespace :deploy do
+  before :starting, :update_release_notes
+
+  task :update_release_notes do
+    sh 'RAILS_ENV=development bin/rake "update_release_notes:run"'
+    # run a second task that generates an auto commit
+    # this would be created by you
+    sh 'RAILS_ENV=development bin/rake "release_notes:commit"'
+  end
+end
+```
+
+Useful information can be found here regarding the
+[capistrano flow](http://capistranorb.com/documentation/getting-started/flow/).
+
+As you can see above, it's suggested that after generating your release notes you would
+run an automated commit with a rake task like:
+
+```ruby
+# lib/tasks/commit.rake
+`git commit -am "Release to production #{Time.zone.now}"`
+`git push origin master`
+```
+
+From there, make sure you tag your release after the deploy script runs so that your tag
+includes this last commit.
+
+## Note
+
+* Your project must tag releases(release-notes uses the tag date to output the changes)
+  (PR's to make this more flexible are welcome)  
+* Linking is opinionated and will link to a URI structure of `#{site-url}/#{issue_number}`. It
+  will ouput something like: `[HONEYBADGER #33150353](https://app.honeybadger.io/projects/9999/faults/33150353)`.
+  This also means that your link_to_labels have to be something like `['HB #']` (PR's to make this more flexible are welcome)  
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/release-notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'release/notes'
+require 'pry-byebug'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/release/notes/install/install_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module Release
+  module Notes
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path('../templates', __FILE__)
+
+        def create_release_notes_initializer
+          copy_file 'release_notes.rb', 'config/initializers/release_notes.rb'
+        end
+
+        def display_readme
+          readme 'README'
+        end
+      end
+    end
+  end
+end

data/lib/generators/release/notes/install/templates/README

@@ -0,0 +1,11 @@
+*******************************************************************************
+
+Next step:
+
+1. Configure release and tag options :
+
+    # config/initializers/release_notes.rb
+    config.by_tag_date = false
+
+
+*******************************************************************************

data/lib/generators/release/notes/install/templates/release_notes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Release::Notes.configure do |config|
+  # config.output_file = './RELEASE_NOTES.md'
+  # config.temp_file = './release-notes.tmp.md'
+  # config.include_merges = false
+  # config.ignore_case = true
+  # config.log_format = '- %s'
+  # config.extended_regex = true
+  # config.bug_labels = %w[Fix Update]
+  # config.feature_labels = %w[Add Create]
+  # config.misc_labels = %w[Refactor]
+  # config.bug_title = '**Fixed bugs:**'
+  # config.feature_title = '**Implemented enhancements:**'
+  # config.misc_title = '**Miscellaneous:**'
+  # config.link_to_labels = %w[]
+  # config.link_to_humanize = %w[]
+  # config.link_to_sites = %w[]
+  # config.timezone = 'America/New_York'
+end

data/lib/release/notes.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/time'
+
+require 'release/notes/date_format'
+require 'release/notes/link'
+require 'release/notes/pretty_print'
+
+require 'release/notes/version'
+require 'release/notes/configuration'
+require 'release/notes/git'
+require 'release/notes/system'
+require 'release/notes/with_configuration'
+
+require 'release/notes/write'
+require 'release/notes/log'
+
+require 'release/notes/railtie' if defined?(Rails)
+
+module Release
+  module Notes
+    class Update
+      attr_reader :logger
+
+      def initialize
+        @options = Release::Notes.configuration
+        @logger = Release::Notes::Log.new @options
+      end
+
+      def run
+        logger.perform
+      end
+    end
+
+    def self.root
+      File.expand_path('../..', __FILE__)
+    end
+  end
+end

data/lib/release/notes/configuration.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class Configuration
+      # The absolute path of your generated log.
+      # Defaults to `./RELEASE_NOTES.md`.
+      # @return [String]
+      attr_accessor :output_file
+
+      # The absolute path of the temporary generated log.
+      # Defaults to `./release-notes.tmp.md`.
+      # @return [String]
+      attr_accessor :temp_file
+
+      # Determines whether to print commits with more than one parent.
+      # Defaults to `false`. For more, see
+      # [Git Log Docs](https://git-scm.com/docs/git-log)
+      # @return [Boolean]
+      attr_accessor :include_merges
+
+      # Match the regular expression limiting patterns without regard to letter case
+      # when printing your git log.
+      # Defaults to `true`. For more, see
+      # [Git Log Docs](https://git-scm.com/docs/git-log)
+      # @return [Boolean]
+      attr_accessor :ignore_case
+
+      # Consider the limiting patterns to be extended regular expressions patterns
+      # when printing your git log.
+      # Defaults to `true`. For more, see
+      # [Git Log Docs](https://git-scm.com/docs/git-log)
+      # @return [Boolean]
+      attr_accessor :extended_regex
+
+      # Allows you to specify what information you want to print from your git log
+      # Defaults to `%s` for subject. For more, see
+      # [Git Log Docs](https://git-scm.com/docs/git-log)
+      # @return [String]
+      attr_accessor :log_format
+
+      # Controls the labels grepped for in your commit subjects that will
+      # be add under you bug title
+      # Defaults to `%w(Fix Update)`.
+      # @return [Array]
+      attr_accessor :bug_labels
+
+      # Controls the labels grepped for in your commit subjects that will
+      # be add under you feature title
+      # Defaults to `%w(Add Create)`.
+      # @return [Array]
+      attr_accessor :feature_labels
+
+      # Controls the labels grepped for in your commit subjects that will
+      # be add under you miscellaneous title
+      # Defaults to `%w(Refactor)`.
+      # @return [Array]
+      attr_accessor :misc_labels
+
+      # Controls the title used in your generated log for all bugs listed
+      # Defaults to `**Fixed bugs:**`.
+      # @return [String]
+      attr_accessor :bug_title
+
+      # Controls the title used in your generated log for all features listed
+      # Defaults to `**Implemented enhancements:**`.
+      # @return [String]
+      attr_accessor :feature_title
+
+      # Controls the title used in your generated log for all misc commits listed
+      # Defaults to `**Miscellaneous:**`.
+      # @return [String]
+      attr_accessor :misc_title
+
+      # The labels grepped for in your commit subject that you want to linkify.
+      # The index within the array must match the index for the site
+      # in `:link_to_humanize` and `:link_to_sites`.
+      # Defaults to `[]`.
+      # @return [Array]
+      attr_accessor :link_to_labels
+
+      # The humanized output that you'd like to represent the associated `:link_to_label`
+      # The index within the array must match the index for the site
+      # in `:link_to_label` and `:link_to_sites`.
+      # Defaults to `[]`.
+      # @return [Array]
+      attr_accessor :link_to_humanize
+
+      # The url for the site that you'd like to represent the associated `:link_to_label`
+      # The index within the array must match the index for the site
+      # in `:link_to_label` and `:link_to_humanize`.
+      # Defaults to `[]`.
+      # @return [Array]
+      attr_accessor :link_to_sites
+
+      # Sets the timezone that should be used for setting the date.
+      # Defaults to `America/New_York`. For more, see
+      # [ActiveSupport Time Zones](http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
+      # @return [String]
+      attr_accessor :timezone
+
+      # Controls whether your commit subject labels should be removed from the final
+      # ouput of your message on the generated log.
+      # Defaults to `true`.
+      # @return [Boolean]
+      attr_accessor :prettify_messages
+
+      def initialize
+        @output_file           = './RELEASE_NOTES.md'
+        @temp_file             = './release-notes.tmp.md'
+        @include_merges        = false
+        @ignore_case           = true
+        @extended_regex        = true
+        @log_format            = '- %s'
+        @bug_labels            = %w[Fix Update]
+        @feature_labels        = %w[Add Create]
+        @misc_labels           = %w[Refactor]
+        @bug_title             = '**Fixed bugs:**'
+        @feature_title         = '**Implemented enhancements:**'
+        @misc_title            = '**Miscellaneous:**'
+        @link_to_labels        = %w[]
+        @link_to_humanize      = %w[]
+        @link_to_sites         = %w[]
+        @timezone              = 'America/New_York'
+        @prettify_messages     = true
+      end
+
+      # @return [String]
+      def include_merges?
+        @include_merges ? '' : '--no-merges'
+      end
+
+      # @return [String]
+      def regex_type
+        @extended_regex ? '-E' : ''
+      end
+
+      # @return [String]
+      def grep_insensitive?
+        @ignore_case ? '-i' : ''
+      end
+
+      # @return [String]
+      def bugs
+        @bugs ||= generate_regex(@bug_labels)
+      end
+
+      # @return [String]
+      def features
+        @features ||= generate_regex(@feature_labels)
+      end
+
+      # @return [String]
+      def misc
+        @misc ||= generate_regex(@misc_labels)
+      end
+
+      # @return [String]
+      def all_labels
+        @all_labels ||= generate_regex(@bug_labels + @feature_labels + @misc_labels)
+      end
+
+      # @return [Boolean]
+      def release_notes_exist?
+        File.exist? output_file
+      end
+
+      # @return [Boolean]
+      def link_commits?
+        link_to_labels.present? && link_to_humanize.present? &&
+          link_to_sites.present?
+      end
+
+      # @return [Boolean]
+      def prettify_messages?
+        @prettify_messages
+      end
+
+      private
+
+      # @api private
+      # Using over Regexp.union
+      def generate_regex(arr)
+        arr.join('|').insert(0, '(').insert(-1, ')')
+      end
+    end
+
+    # @return [Release::Notes::Configuration] Release::Notes's current configuration
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Set Release::Notes's configuration
+    # @param config [Release::Notes::Configuration]
+    def self.configuration=(config)
+      @configuration = config
+    end
+
+    # Modify Release::Notes's current configuration
+    # @yieldparam [Release::Notes] config current Release::Notes config
+    # ```
+    # Release::Notes.configure do |config|
+    #   config.routes = false
+    # end
+    # ```
+    def self.configure
+      yield configuration
+    end
+  end
+end

data/lib/release/notes/date_format.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class DateFormat
+      attr_reader :config, :time_now
+      delegate :timezone, to: :config
+
+      def initialize(config)
+        @config               = config
+        Time.zone             = timezone
+
+        @time_now             = Time.zone.now
+      end
+
+      def date_humanized(date: nil)
+        date = date.present? ? Time.zone.parse(date) : time_now
+        date.strftime('%B %d, %Y %r %Z')
+      end
+    end
+  end
+end

data/lib/release/notes/git.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    module Git
+      module_function
+
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :log_format, :grep_insensitive?, :regex_type, :include_merges?, to: :config
+
+        def log(**opts)
+          "git log '#{opts[:tag_from]}'..'#{opts[:tag_to]}' --grep='#{opts[:label]}'" \
+            " #{regex_type} #{grep_insensitive?}" \
+            " #{include_merges?} --format='#{log_format}'"
+        end
+      end
+
+      def last_tag
+        'git describe --abbrev=0 --tags'
+      end
+
+      def tag_date(tag)
+        "git log -1 --format=%ai #{tag}"
+      end
+
+      def read_all_tags
+        'git tags | sort -u -r'
+      end
+    end
+  end
+end

data/lib/release/notes/link.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    module Link
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :link_to_labels, :link_to_sites, :link_to_humanize, to: :config
+
+        def link_lines(lines:)
+          new_lines = ''
+          lines.split("\n").each do |line|
+            unless link_to_labels.any? { |la| line.include? la }
+              new_lines += "#{line}\n"
+              next
+            end
+            link_to_labels.each_with_index do |label, i|
+              next unless line.include? label
+              words = line.split(/\s/)
+              words.each do |word|
+                next unless (word =~ /^#.*/)&.zero?
+                new_lines += "#{replace(line, word, label, i)}\n"
+              end
+            end
+          end
+          new_lines
+        end
+
+        private
+
+        # @api private
+        def replace(line, issue_number, label, index)
+          identifier = "#{label.split(/\s/)[0]} #{issue_number}"
+          humanized = "#{link_to_humanize[index]} #{issue_number}"
+          linked = "[#{humanized}](#{link_to_sites[index]})"
+
+          line.gsub! identifier, linked
+          line
+        end
+      end
+    end
+  end
+end

data/lib/release/notes/log.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class Log
+      include System
+      include WithConfiguration
+
+      attr_reader :config, :writer, :date_formatter
+      attr_reader :all_tags
+
+      delegate :all_labels, :features, :bugs, :misc, :feature_title,
+               :bug_title, :misc_title, :release_notes_exist?, to: :config
+
+      delegate :date_humanized, :format_tag_date, to: :date_formatter
+      delegate :digest, to: :writer
+
+      def initialize(config)
+        @config = config
+
+        setup_writer
+        setup_date_formatter
+      end
+
+      def perform
+        if release_notes_exist?
+          # Find the last tag and group all commits
+          # under a date header at the time this is run
+          find_last_tag_and_log
+        else
+          # Find all tags and get the logs between each tag
+          # run this the first time if nothing exists
+          find_all_tags_and_log_all
+        end
+        writer.write_new_file
+      end
+
+      private
+
+      def all_tags
+        @all_tags ||= System.all_tags.split("\n")
+        # return Error.new(msg: :missing_tags) unless all_tags.present?
+      end
+
+      # @api private
+      def copy_single_tag_of_activity(tag_from:, tag_to: nil)
+        tag_to ||= 'HEAD'
+        [features, bugs, misc].each_with_index do |regex, i|
+          log = system_call(tag_from: tag_from, tag_to: tag_to, label: regex)
+          digest(date: nil, title: titles[i], log_message: log) if log.present?
+        end
+      end
+
+      # @api private
+      def find_last_tag_and_log
+        last_tag = system_last_tag.delete!("\n")
+        return false unless system_call(tag_from: last_tag, label: all_labels).present?
+
+        # output the date right now
+        digest date: date_humanized
+        copy_single_tag_of_activity(tag_from: last_tag)
+      end
+
+      # @api private
+      def setup_writer
+        @writer = Release::Notes::Write.new config
+      end
+
+      # @api private
+      def setup_date_formatter
+        @date_formatter = Release::Notes::DateFormat.new config
+      end
+
+      # @api private
+      def find_all_tags_and_log_all
+        all_tags.each_with_index do |ta, i|
+          previous_tag = all_tags[i + 1]
+          next unless previous_tag.present? &&
+                      system_call(tag_from: previous_tag, tag_to: ta, label: all_labels).present?
+
+          digest date: date_humanized(date: System.tag_date(tag: ta))
+          copy_single_tag_of_activity(tag_from: previous_tag, tag_to: ta)
+        end
+      end
+
+      # @api private
+      def system_call(**opts)
+        with_config(config: config) do
+          system_log(opts)
+        end
+      end
+
+      # @api private
+      def titles
+        [feature_title, bug_title, misc_title]
+      end
+    end
+  end
+end

data/lib/release/notes/pretty_print.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    module PrettyPrint
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :all_labels, to: :config
+
+        def prettify(line:)
+          line.gsub(labels_regex, '').strip
+        end
+      end
+
+      private
+
+      # @api private
+      def labels_regex
+        Regexp.new all_labels, Regexp::IGNORECASE
+      end
+    end
+  end
+end

data/lib/release/notes/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load 'tasks/update_release_notes.rake'
+      end
+
+      generators do
+        require 'generators/release/notes/install/install_generator.rb'
+      end
+    end
+  end
+end

data/lib/release/notes/system.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    module System
+      module_function
+
+      extend ActiveSupport::Concern
+      include Git
+
+      included do
+        def system_log(**opts)
+          `#{log(opts)}`
+        end
+      end
+
+      def all_tags
+        `#{Git.read_all_tags}`
+      end
+
+      def system_last_tag
+        `#{Git.last_tag}`
+      end
+
+      def tag_date(tag: nil)
+        tag ||= system_last_tag
+        `#{Git.tag_date(tag)}`
+      end
+    end
+  end
+end

data/lib/release/notes/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    VERSION = '0.1.0'
+  end
+end

data/lib/release/notes/with_configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    module WithConfiguration
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :config, :date_formatter
+
+        def with_config(**opts, &_block)
+          @confg = opts.fetch(:config, {})
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/release/notes/write.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class Write
+      include Link
+      include PrettyPrint
+      include WithConfiguration
+
+      attr_accessor :config
+
+      delegate :output_file, :temp_file, :link_commits?, :all_labels,
+               :prettify_messages?, :release_notes_exist?, to: :config
+
+      def initialize(config)
+        @config = config
+        # create a new temp file regardless if it exists
+        new_temp_file_template
+      end
+
+      def digest(date: nil, title: nil, log_message: nil)
+        File.open(temp_file, 'a') do |fi|
+          fi << "\n\n## #{date}\n" if date
+          fi << "\n#{title}\n\n" if title && !date
+          fi << "#{title}\n\n" if title && date
+
+          break unless log_message
+          # link messages if needed
+          msg = link_message log_message
+          # remove tags if needed
+          msg = with_config(config: config) { prettify(line: msg) } if prettify_messages?
+          fi << "#{msg}\n"
+        end
+      end
+
+      # append old file to new temp file
+      # overwrite output file with tmp file
+      def write_new_file
+        copy_over_notes if release_notes_exist?
+
+        FileUtils.cp(temp_file, output_file)
+        FileUtils.rm temp_file
+      end
+
+      private
+
+      # @api private
+      def copy_over_notes
+        File.open(temp_file, 'a') do |f|
+          f << "\n"
+          IO.readlines(output_file)[2..-1].each { |line| f << line }
+        end
+      end
+
+      # @api private
+      def link_message(log_message)
+        return log_message unless link_commits?
+        with_config(config: config) do
+          link_lines(lines: log_message)
+        end
+      end
+
+      # @api private
+      def new_temp_file_template
+        File.new(temp_file, 'w')
+        File.open(temp_file, 'a') do |fi|
+          fi << "# Release Notes\n----------------------"
+        end
+      end
+    end
+  end
+end

data/lib/tasks/update_release_notes.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+namespace :update_release_notes do
+  task run: :environment do
+    Release::Notes::Update.new.run
+  end
+end

data/release-notes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'release/notes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "release-notes"
+  spec.version       = Release::Notes::VERSION
+  spec.authors       = ["Drew Monroe"]
+  spec.email         = ["dvmonroe6@gmail.com"]
+
+  spec.summary       = "Release notes for stakeholders"
+  spec.description   = spec.summary
+  spec.homepage      = "http://github.com/dvmonroe/release-notes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: release-notes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drew Monroe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Release notes for stakeholders
+email:
+- dvmonroe6@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/release/notes/install/install_generator.rb
+- lib/generators/release/notes/install/templates/README
+- lib/generators/release/notes/install/templates/release_notes.rb
+- lib/release/notes.rb
+- lib/release/notes/configuration.rb
+- lib/release/notes/date_format.rb
+- lib/release/notes/git.rb
+- lib/release/notes/link.rb
+- lib/release/notes/log.rb
+- lib/release/notes/pretty_print.rb
+- lib/release/notes/railtie.rb
+- lib/release/notes/system.rb
+- lib/release/notes/version.rb
+- lib/release/notes/with_configuration.rb
+- lib/release/notes/write.rb
+- lib/tasks/update_release_notes.rake
+- release-notes.gemspec
+homepage: http://github.com/dvmonroe/release-notes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Release notes for stakeholders
+test_files: []