release-notes 0.1.0 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 691d3c472f9792ce0e682085a84f2207f6a4fdda
-  data.tar.gz: bb273e2057859b3a70ffcf692ed6f442152df7d9
+SHA256:
+  metadata.gz: cb0b98d5a15dd9a96c2f431aba996b34aafaeeff0b14c402d742b00eadb97fba
+  data.tar.gz: 261217599cb38ffc79908c7039af54f3c263bfcf8fa11c1523f08e0d0b754ab0
 SHA512:
-  metadata.gz: e056b89f89730bb42537f613e7dcb23363ee4ff25c74aecb54711882935cd2f29912b0a86ef4e3a4af7ea11d5012c55c371033f661b0248ec224b2bd0fb9601b
-  data.tar.gz: ed86f0d78b8f71c11e8f39766a3e92f403da70c6711e933b375d1c84c061bfffc903c325ea9b494395b817eff227bf5a36933256cf5bab09538c78ebe44a91c1
+  metadata.gz: 780b3d9e8f55ffa5384f2886ccdfba0192e98fef078dd10a82fe5df72b3dea21ec99f24d1dc1ceb483bb1325a7dbc1e108b54381293e6b2f566ac33c40d57d7a
+  data.tar.gz: 65dd44cd18a4b003b2939f97c2e988081083198ae28f2e4e93296d2e3a583f0753239b12e9a85601d8091fa4663736ea11996f2dd4ffc2a546e2baa672a9b4c7

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+# Issue
+
+Put a brief summary here
+
+## Environment
+
+- Ruby **[version]**
+- Rails **[version]**
+- release-notes **[version]**
+
+## Current behavior
+
+Include code samples, errors, steps to reproduce the error and stacktraces if appropriate.
+
+Will be even more helpful if you provide a test case that reproduces the error.
+
+## Expected behavior

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+# Type of PR (feature, enhancement, bug fix, etc.)
+
+## Description
+
+Please include a summary of the change and which issue is fixed.
+
+Fixes # (issue)
+
+## Programmer Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have rebased the branch with the latest code from master
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas, and at the top of new interactors
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] The build is passing
+
+## Screenshots (if applicable)
+
+## Dependencies introduced

data/.gitignore

@@ -9,4 +9,5 @@
 /tmp/
 
 RELEASE_NOTES.md
-release-notes.tmp.md
+release-notes.tmp.md
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,72 @@
+AllCops:
+  TargetRubyVersion: 2.5.3
+  Exclude:
+    - "bin/*"
+    - "./**/*.gemspec"
+    - "Gemfile"
+    - "Rakefile"
+    - "vendor/**/*"
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 35
+  Exclude:
+    - "./**/spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Exclude:
+    - Gemfile
+
+Layout/DotPosition:
+  # Multi-line method chaining should be done with trailing dots.
+  EnforcedStyle: trailing
+
+Style/TrailingCommaInArguments:
+  # If `comma`, the cop requires a comma after the last argument, but only for
+  # parenthesized method calls where each argument is on its own line.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  # If `comma`, the cop requires a comma after the last item in an array,
+  # but only when each item is on its own line.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  # If `comma`, the cop requires a comma after the last item in a hash,
+  # but only when each item is on its own line.
+  EnforcedStyleForMultiline: comma
+
+Style/MutableConstant:
+  # Do not assign mutable objects to constants.
+  Enabled: false
+
+Style/Documentation:
+  # Document classes and non-namespace modules
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  # Checks style of children classes and modules.
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  # Checks existence of the frozen string literal comment
+  Enabled: true
+
+Style/RescueStandardError:
+  # Checks that you are including the error class
+  # when you rescue
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  # Percent literal delimeters are always parentheses
+  PreferredDelimiters:
+    { default: (),
+    '%i': '()',
+    '%I': '()',
+    '%r': '()',
+    '%w': '()',
+    '%W': '()'
+    }

data/.travis.yml

@@ -1,10 +1,17 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
+  - 2.4.1
+  - 2.4.2
+  - 2.4.5
+  - 2.5.0
+  - 2.5.3
+cache: bundler
 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=
+script:
+  - bundle exec rubocop
 after_success:
-  - bundle exec codeclimate-test-reporter
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -6,7 +6,6 @@ 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/README.md

@@ -8,15 +8,16 @@
 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
+intended to help increase visability to all team members and/or 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
+Release::Notes is different than a changelog. Though it can log all commits, it's
+meant for situations where other team members in your organization need to know about key changes
+to the production software. These key changes are determined by the labeling you set forth
+in the configuration for features, bugs and misc commits.
+If you're looking for a comprehnsive changelog that reflects resolved github issues and uses the
+github api, I'd  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
@@ -52,7 +53,6 @@ This Release::Notes generator creates an initializer file to allow further confi
 
 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`:
@@ -65,16 +65,19 @@ Release::Notes.configure do |config|
   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_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.log_all_title = '**Other:**'
+  config.log_all = false
+  config.link_to_labels = %w()
+  config.link_to_humanize = %w()
+  config.link_to_sites = %w()
   config.timezone = 'America/New_York'
+  config.force_rewrite = false
 end
 ```
 
@@ -85,16 +88,24 @@ For more information about each individual setting checkout Release::Notes's
 
 ### TL;DR
 
+#### Rails
+
 ```sh
-bundle exec update_release_notes:run
+bin/rails update_release_notes:run
+```
+
+#### Non-Rails
+
+```sh
+bundle exec rake 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  
+- 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
@@ -103,18 +114,19 @@ meaningful commit subjects with longer bodies as needed for larger feature addit
 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)
+- [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
+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:
@@ -156,11 +168,11 @@ 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
+- 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)  
+  This also means that your link_to_labels have to be something like `['HB #']` (PR's to make this more flexible are welcome)
 
 ## Development
 
@@ -172,8 +184,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 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/bin/console

@@ -3,14 +3,6 @@
 
 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/lib/generators/release/notes/install/install_generator.rb

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

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

@@ -7,14 +7,16 @@ Release::Notes.configure do |config|
   # 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_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.log_all_title = '**Other:**'
+  # config.log_all = false
+  # 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

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext/time'
+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/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/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/write"
+require "release/notes/log"
 
-require 'release/notes/railtie' if defined?(Rails)
+require "release/notes/railtie" if defined?(Rails)
 
 module Release
   module Notes
@@ -34,7 +34,7 @@ module Release
     end
 
     def self.root
-      File.expand_path('../..', __FILE__)
+      File.expand_path("..", __dir__)
     end
   end
 end

data/lib/release/notes/configuration.rb

@@ -72,6 +72,16 @@ module Release
       # @return [String]
       attr_accessor :misc_title
 
+      # Controls whether all logs that do not match the other labels are listed
+      # Defaults to `false`
+      # @return [Boolean]
+      attr_accessor :log_all
+
+      # Controls the title used in your generated log for all commits listed
+      # Defaults to `**Other:**`.
+      # @return [String]
+      attr_accessor :log_all_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`.
@@ -105,39 +115,47 @@ module Release
       # @return [Boolean]
       attr_accessor :prettify_messages
 
-      def initialize
-        @output_file           = './RELEASE_NOTES.md'
-        @temp_file             = './release-notes.tmp.md'
+      # Controls whether to rewrite the output file or append to it.
+      # Defaults to `false`.
+      # @return [Boolean]
+      attr_accessor :force_rewrite
+
+      def initialize # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        @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'
+        @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:**"
+        @log_all_title         = "**Other**"
+        @log_all               = false
+        @link_to_labels        = %w()
+        @link_to_humanize      = %w()
+        @link_to_sites         = %w()
+        @timezone              = "America/New_York"
         @prettify_messages     = true
+        @force_rewrite         = false
       end
 
       # @return [String]
       def include_merges?
-        @include_merges ? '' : '--no-merges'
+        @include_merges ? "" : "--no-merges"
       end
 
       # @return [String]
       def regex_type
-        @extended_regex ? '-E' : ''
+        @extended_regex ? "-E" : ""
       end
 
       # @return [String]
       def grep_insensitive?
-        @ignore_case ? '-i' : ''
+        @ignore_case ? "-i" : ""
       end
 
       # @return [String]
@@ -176,12 +194,13 @@ module Release
         @prettify_messages
       end
 
+      # :nocov:
       private
 
       # @api private
       # Using over Regexp.union
       def generate_regex(arr)
-        arr.join('|').insert(0, '(').insert(-1, ')')
+        arr.join("|").insert(0, "(").insert(-1, ")")
       end
     end
 
@@ -206,5 +225,6 @@ module Release
     def self.configure
       yield configuration
     end
+    # :nocov:
   end
 end

data/lib/release/notes/date_format.rb

@@ -15,7 +15,7 @@ module Release
 
       def date_humanized(date: nil)
         date = date.present? ? Time.zone.parse(date) : time_now
-        date.strftime('%B %d, %Y %r %Z')
+        date.strftime("%B %d, %Y %r %Z")
       end
     end
   end

data/lib/release/notes/git.rb

@@ -8,17 +8,23 @@ module Release
       extend ActiveSupport::Concern
 
       included do
-        delegate :log_format, :grep_insensitive?, :regex_type, :include_merges?, to: :config
+        delegate :all_labels, :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
+
+        def invert_log(**opts)
+          "git log '#{opts[:tag_from]}'..'#{opts[:tag_to]}' --grep='#{all_labels}'" \
+            " #{regex_type} #{grep_insensitive?} --invert-grep" \
+            " #{include_merges?} --format='#{log_format}'"
+        end
       end
 
       def last_tag
-        'git describe --abbrev=0 --tags'
+        "git describe --abbrev=0 --tags"
       end
 
       def tag_date(tag)
@@ -26,7 +32,7 @@ module Release
       end
 
       def read_all_tags
-        'git tags | sort -u -r'
+        "git tags | sort -u -r"
       end
     end
   end

data/lib/release/notes/link.rb

@@ -9,35 +9,49 @@ module Release
         delegate :link_to_labels, :link_to_sites, :link_to_humanize, to: :config
 
         def link_lines(lines:)
-          new_lines = ''
+          @new_lines = ""
+          split_lines(lines)
+          @new_lines
+        end
+
+        # :nocov:
+        private
+
+        # @api private
+        def split_lines(lines)
           lines.split("\n").each do |line|
-            unless link_to_labels.any? { |la| line.include? la }
-              new_lines += "#{line}\n"
+            unless link_to_labels { |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
+            split_words(line)
           end
-          new_lines
         end
 
-        private
+        # @api private
+        def split_words(line)
+          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
 
         # @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]})"
+          linked = "[#{humanized}](#{link_to_sites[index]}\/#{issue_number.tr('^0-9', '')})"
 
           line.gsub! identifier, linked
           line
         end
+        # :nocov:
       end
     end
   end

data/lib/release/notes/log.rb

@@ -9,11 +9,10 @@ module Release
       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 :force_rewrite, :all_labels, :log_all, :features, :bugs, :misc, :feature_title,
+               :bug_title, :misc_title, :log_all_title, :release_notes_exist?, to: :config
       delegate :date_humanized, :format_tag_date, to: :date_formatter
-      delegate :digest, to: :writer
+      delegate :digest_date, :digest_title, to: :writer
 
       def initialize(config)
         @config = config
@@ -23,7 +22,7 @@ module Release
       end
 
       def perform
-        if release_notes_exist?
+        if release_notes_exist? && !force_rewrite
           # Find the last tag and group all commits
           # under a date header at the time this is run
           find_last_tag_and_log
@@ -35,20 +34,26 @@ module Release
         writer.write_new_file
       end
 
+      # :nocov:
       private
 
-      def all_tags
+      def all_tags # rubocop:disable Lint/DuplicateMethods
         @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'
+        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?
+          log = system_call(tag_from: tag_from, tag_to: tag_to, label: regex, log_all: false)
+          digest_title(title: titles[i], log_message: log) if log.present?
         end
+
+        return unless log_all
+
+        log = system_call(tag_from: tag_from, tag_to: tag_to, log_all: true)
+        digest_title(title: log_all_title, log_message: log) if log.present?
       end
 
       # @api private
@@ -57,7 +62,7 @@ module Release
         return false unless system_call(tag_from: last_tag, label: all_labels).present?
 
         # output the date right now
-        digest date: date_humanized
+        digest_date date: date_humanized
         copy_single_tag_of_activity(tag_from: last_tag)
       end
 
@@ -78,7 +83,7 @@ module Release
           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))
+          digest_date date: date_humanized(date: System.tag_date(tag: ta))
           copy_single_tag_of_activity(tag_from: previous_tag, tag_to: ta)
         end
       end
@@ -90,10 +95,10 @@ module Release
         end
       end
 
-      # @api private
       def titles
         [feature_title, bug_title, misc_title]
       end
+      # :nocov:
     end
   end
 end

data/lib/release/notes/pretty_print.rb

@@ -9,16 +9,18 @@ module Release
         delegate :all_labels, to: :config
 
         def prettify(line:)
-          line.gsub(labels_regex, '').strip
+          line.gsub(labels_regex, "").strip
         end
       end
 
+      # :nocov:
       private
 
       # @api private
       def labels_regex
         Regexp.new all_labels, Regexp::IGNORECASE
       end
+      # :nocov:
     end
   end
 end

data/lib/release/notes/railtie.rb

@@ -4,11 +4,11 @@ module Release
   module Notes
     class Railtie < Rails::Railtie
       rake_tasks do
-        load 'tasks/update_release_notes.rake'
+        load "tasks/update_release_notes.rake"
       end
 
       generators do
-        require 'generators/release/notes/install/install_generator.rb'
+        require "generators/release/notes/install/install_generator.rb"
       end
     end
   end

data/lib/release/notes/system.rb

@@ -10,7 +10,11 @@ module Release
 
       included do
         def system_log(**opts)
-          `#{log(opts)}`
+          if opts[:log_all] == true
+            `#{invert_log(opts)}`
+          else
+            `#{log(opts)}`
+          end
         end
       end
 

data/lib/release/notes/version.rb

@@ -2,6 +2,6 @@
 
 module Release
   module Notes
-    VERSION = '0.1.0'
+    VERSION = "1.0.0.pre"
   end
 end

data/lib/release/notes/write.rb

@@ -10,7 +10,7 @@ module Release
       attr_accessor :config
 
       delegate :output_file, :temp_file, :link_commits?, :all_labels,
-               :prettify_messages?, :release_notes_exist?, to: :config
+               :prettify_messages?, :release_notes_exist?, :force_rewrite, to: :config
 
       def initialize(config)
         @config = config
@@ -18,35 +18,64 @@ module Release
         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
+      # write strings to tempfile
+      def digest(str)
+        File.open(temp_file, "a") { |fi| fi << str }
+      end
+
+      # formats titles to be added to the new file
+      # removes tags from title if configured
+      def digest_title(title: nil, log_message: nil)
+        @title = title
+        @log_message = log_message
+
+        titles = ""
+        titles << title_present
+        titles << "#{remove_tags}\n"
+        digest(titles)
+      end
+
+      # formats dates to be added to the new file
+      def digest_date(date: nil)
+        @date = date
+        digest(date_present)
       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?
+        copy_over_notes if release_notes_exist? && !force_rewrite
 
         FileUtils.cp(temp_file, output_file)
         FileUtils.rm temp_file
       end
 
+      # :nocov:
       private
 
+      # @api private
+      def date_present
+        "\n## #{@date}\n"
+      end
+
+      # @api private
+      def title_present
+        "\n#{@title}\n\n"
+      end
+
+      # @api private
+      def remove_tags
+        with_config(config: config) { prettify(line: link_messages) } if prettify_messages?
+      end
+
+      # @api private
+      def link_messages
+        link_message @log_message
+      end
+
       # @api private
       def copy_over_notes
-        File.open(temp_file, 'a') do |f|
+        File.open(temp_file, "a") do |f|
           f << "\n"
           IO.readlines(output_file)[2..-1].each { |line| f << line }
         end
@@ -55,6 +84,7 @@ module Release
       # @api private
       def link_message(log_message)
         return log_message unless link_commits?
+
         with_config(config: config) do
           link_lines(lines: log_message)
         end
@@ -62,11 +92,12 @@ module Release
 
       # @api private
       def new_temp_file_template
-        File.new(temp_file, 'w')
-        File.open(temp_file, 'a') do |fi|
-          fi << "# Release Notes\n----------------------"
+        File.new(temp_file, "w")
+        File.open(temp_file, "a") do |fi|
+          fi << "# Release Notes\n"
         end
       end
+      # :nocov:
     end
   end
 end

data/lib/tasks/update_release_notes.rake

@@ -2,6 +2,8 @@
 
 namespace :update_release_notes do
   task run: :environment do
+    puts "generating release notes..."
     Release::Notes::Update.new.run
+    puts "done!"
   end
 end

data/release-notes.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'release/notes/version'
+require "release/notes/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "release-notes"
@@ -9,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Drew Monroe"]
   spec.email         = ["dvmonroe6@gmail.com"]
 
-  spec.summary       = "Release notes for stakeholders"
-  spec.description   = spec.summary
+  spec.summary       = "Automated release notes for your project"
+  spec.description   = "Generate automated release notes for any project"
   spec.homepage      = "http://github.com/dvmonroe/release-notes"
   spec.license       = "MIT"
 
@@ -19,7 +18,10 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_dependency "activesupport", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.60.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: release-notes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - Drew Monroe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-14 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,16 +66,32 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Release notes for stakeholders
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+description: Generate automated release notes for any project
 email:
 - dvmonroe6@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
@@ -103,13 +133,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Release notes for stakeholders
+summary: Automated release notes for your project
 test_files: []

data/.ruby-version

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