release-notes 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3db50bbc2d93a02a0f3734d38418ed4cfb9ccf7b51cfd0eb33e78ac9c26fa2f4
-  data.tar.gz: 886d3f94f4b06ba7bf4d7c9b3bd67802c4ffe48a885e84067489d56b8c804dda
+  metadata.gz: 31ee4556cc27e70fe6a0ff59e5e243afb02b265e616ca781f6b233a1938ca7c3
+  data.tar.gz: 140afbc526063d8df64f56a54e35d96ffe2ff4745905643a6559f9bc7c73667c
 SHA512:
-  metadata.gz: f31ea87a15850deaf208c6dba14eed22e9bc844318e7ac40b4781e1f351d6a71ff6dfa56decdf759b764aeb3edfecff9ac9a932bbd197bb74927fc802f6134f1
-  data.tar.gz: 2c7d83dbcba108213ac4d464cdb998a3e88da136d5850969ba98e77686de3b338d9066827757f1424b4dc4fbcb4bdb41577c72445ce1d7f3245481729d4852f3
+  metadata.gz: 90acbf098787bd9968b148844dc308ce28dd7b2633e163ba349eea114ac3e26c15e3a61eddb52ff8e6d0dc2bce1b934d20f95c0ed134244a87196744a2ab2cab
+  data.tar.gz: 8b5507ba334994659166eec6c5396dc6fabc1c0289638fdbd4bc56937d6728bd952b43a8247f4bf0866d162ef2b1983c3baa3b6b39e505dc84f29e88d0843df0

data/.travis.yml

@@ -1,7 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.5
   - 2.5.3
   - 2.6.0
 cache: bundler

data/CHANGELOG.md

@@ -1,12 +1,43 @@
 # Release Notes
 
+## v2.0.0
+
+**Implemented enhancements:**
+
+- Add our own release notes
+- Add travis test for ruby 2.6.0
+- Fix error when tracking commits
+- Add ruby gems doc link
+- Add integration test for file that already exists
+- Add confiugration to not dupe commits
+- Add first round of integration tests for default configuration :tada:
+- Fix fact that we aren't writing first tags' commits
+
+**Fixed bugs:**
+
+- Yet another fix on bin/publish. Close block
+- Fix cops
+- Fix bin/publish to actually update version.rb
+- Remove extraneous binstub from last commit
+- Fix cognitive method complexity in log.rb
+- Remove note about multiple commits.
+- Fix link to CONTRIBUTING.md in README
+- Remove empty (duped) messages from array
+- Fix cops
+- Fix force_rewrite bug to allow appending new commits to old relase notes
+- Remove :nocov: labels now that we have integration testing
+- Fix git tags reference
+
+**Miscellaneous:**
+
+- Update code of conduct to 1.4.0 of contributor covenant
+- Refactor - set prettify_messages to false by default
+
 ## v1.3.0
 
 **Implemented enhancements:**
 
 - Add Configuration#header_title
-- More updates to README
-- Update README to explain how grep works
 - Add logo
 - Remove System#invert_log ;B
 
@@ -16,7 +47,8 @@
 
 **Miscellaneous:**
 
-- Bump release-notes to 1.3.0
+- More updates to README
+- Update README to explain how grep works
 
 ## v1.2.1
 
@@ -24,10 +56,6 @@
 
 - Fix cognitive complexity of split_words ;F
 
-**Miscellaneous:**
-
-- Bump release-notes to 1.2.1
-
 ## v1.2.0
 
 **Implemented enhancements:**
@@ -39,34 +67,22 @@
 - Fix log_all option and invert-grep ;B
 - Fix travis - actually run rspec tests ;B
 
-**Miscellaneous:**
-
-- Bump release-notes to 1.2.0
-
 ## v1.1.2
 
-**Implemented enhancements:**
-
-- Update binstub to support config file in config/ folder
-
 **Miscellaneous:**
 
-- Bump release-notes to 1.1.2
+- Update binstub to support config file in config/ folder
 
 ## v1.1.1
 
-**Implemented enhancements:**
-
-- Update README
-- Update binstub to check non-rails config file
-
 **Fixed bugs:**
 
 - Fix README
 
 **Miscellaneous:**
 
-- Bump release-notes to 1.1.1
+- Update README
+- Update binstub to check non-rails config file
 
 ## v1.1.0
 
@@ -74,46 +90,40 @@
 
 - Light refactoring and add binstub and non-rails install
 
-**Miscellaneous:**
+## v1.0.1
 
-- Bump release-notes to 1.1.0
+**Fixed bugs:**
 
-## v1.0.1
+- Update README.md
+- Remove environment from rake task
+- Fix contributing.md
+
+## v1.0.0
 
 **Implemented enhancements:**
 
-- Update README.md
 - Updates to README, CONTRIBUTING and add bin/test
-- Update README and install template
 
 **Fixed bugs:**
 
-- Remove environment from rake task
-- Fix contributing.md
 - Fix linking/writing of none linked lines and frozen string modification
 - Fix guard clause for rubocop
 
 **Miscellaneous:**
 
-- Bump release-notes to 1.0.1
-- Bump release-notes to 1.0.0
+- Update README and install template
 
 ## v1.0.0.pre
 
-## v1.0.0
-
 **Implemented enhancements:**
 
-- Update README
 - Add log_all option for configuration
 - Add force_rewrite option to configuration
 - Fix linking not adding the issue number correctly
 - Add GH templates
 - Add test around puts on rake task
-- Refactor link.rb and increase test coverage
 - Add rubocop & fix cops
 - ignore .ruby-version since it's irrelevant and add different rubies to travis
-- ruby version update -> 2.5.3
 - Update README
 
 **Fixed bugs:**
@@ -121,27 +131,31 @@
 - Fix cops and depreciation warnings
 - Fix spelling error
 - Reduce cyclomatic complexity of Write.rb
+- Refactor link.rb and increase test coverage
 - Remove extra new line on output
 - Remove extra header underline on output md file
 - fix readme typo
 
 **Miscellaneous:**
 
-- Bump release-notes to 1.0.0.pre
-- Utilize bundler caching on travis
+- Update README
+- ruby version update -> 2.5.3
 
 ## v0.1.0
 
 **Implemented enhancements:**
 
-- Update prettify class
-- update readme
-- Update to linking commit messages
 - Minor updates to layout of gem
-- more readme updates
 - add docs badge to readme
 - add yard config
-- update readme
 - WIP adding test coverage to code climate
 - Add badges to README
 - Add some initial tests
+
+**Miscellaneous:**
+
+- Update prettify class
+- update readme
+- Update to linking commit messages
+- more readme updates
+- update readme

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project maintainer at dvmonroe6@gmail.com. All
+reported by contacting the project maintainer at shackl3ton@pm.me. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Drew Monroe
+Copyright (c) 2019 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

data/lib/release/notes.rb

@@ -3,9 +3,10 @@
 require "active_support"
 require "active_support/core_ext/time"
 
-require "release/notes/date_format"
+require "release/notes/configurable"
+require "release/notes/date_formatter"
 require "release/notes/link"
-require "release/notes/pretty_print"
+require "release/notes/prettify"
 
 require "release/notes/version"
 require "release/notes/configuration"
@@ -14,24 +15,30 @@ require "release/notes/system"
 
 require "release/notes/write"
 require "release/notes/log"
+require "release/notes/tag"
+require "release/notes/commits"
 
 require "release/notes/railtie" if defined?(Rails)
 require "release/notes/install" unless defined?(Rails)
 
 module Release
   module Notes
+    NEWLINE = "\n"
+
     class << self
       def generate
         log.perform
       end
 
-      def log
-        Release::Notes::Log.new
-      end
-
       def root
         File.expand_path("..", __dir__)
       end
+
+      private
+
+      def log
+        Log.new
+      end
     end
   end
 end

data/lib/release/notes/commits.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class Commits
+      include Configurable
+      REGEX_DELIMETER = /(?=-)/
+
+      attr_reader :title, :value
+      delegate :digest_title, prefix: :writer, to: :@writer
+
+      #
+      # Release::Notes::Commits initializer method
+      #
+      # @param [String] title - a label (**Implemented enhancements.**)
+      # @param [String] value - all commits and commit subjects (sha - message\n)
+      # @param [Release::Notes::Writer] writer - Writer obeject containing the message header (v2.0.0)
+      #
+      def initialize(title:, value:, writer:, tagger:)
+        @title = title
+        @value = value
+        @writer = writer
+
+        @tagger = tagger
+      end
+
+      #
+      # Perform method
+      #
+      # @return [File] File with array of git sha's
+      #
+      def perform
+        choose_messages_by_hash.tap do |obj|
+          next if obj.empty?
+
+          @tagger._hashes += obj.keys
+          output_unique_messages(obj.values)
+        end
+
+        self
+      end
+
+      private
+
+      #
+      # Determine what messages will be added to final output
+      #
+      # @return [Array] non-duplicated log messages
+      #
+      def choose_messages_by_hash
+        split_commits.tap do |obj|
+          remove_duplicate_hashes(obj)
+        end
+      end
+
+      #
+      # Create the commits hash
+      #
+      # @param [Array] arr - Array where [0] is a commit hash and [1] is the first formatted commit message for...
+      # @param [Hash] hsh - Hash of formatted commit messages to be injected per sha
+      #
+      # @return [String] Commit message
+      #
+      def create_commits_hash(arr, hsh)
+        hsh[arr[0].strip] = arr[1..-1].join
+      end
+
+      #
+      # Determines whether key has already been added to the release_notes
+      #
+      # @param [String] key - commit sha
+      #
+      # @return [Boolean] Is this a duplicate commit message?
+      #
+      def duplicate_commit?(key)
+        config_single_label && @tagger._hashes.include?(key)
+      end
+
+      #
+      # Transforms an array of messages into a single
+      #
+      # @param [Array] arr - array formatted log messages
+      #
+      # @return [String] formatted log messages
+      #
+      def join_messages(arr)
+        "#{arr.join(NEWLINE)}#{NEWLINE}"
+      end
+
+      #
+      # Log messages without duplicates
+      #
+      # @param [Array] messages - Array of git commit subjects
+      #
+      # @return [String] - formatted messages
+      #
+      def output_unique_messages(messages)
+        writer_digest_title(title: title, log_message: join_messages(messages))
+      end
+
+      #
+      # Remove duplicate log messages
+      #
+      # @param [Hash] obj - Commit sha's and messages
+      #
+      # @return [Array] Array of unique git sha's
+      #
+      def remove_duplicate_hashes(obj)
+        obj.keys.each { |key| obj.delete(key) if duplicate_commit?(key) }
+      end
+
+      #
+      # Split commits by sha
+      #
+      # @return [Hash] Commit and message
+      #
+      def split_commits
+        split_values do |arr, obj|
+          arr.split(REGEX_DELIMETER).tap do |split_arr|
+            create_commits_hash(split_arr, obj) # "- Add our own release notes"
+          end
+        end
+      end
+
+      #
+      # Split messages by sha
+      #
+      # @param [Proc] &_block - optional block
+      #
+      # @return [Hash] commits and commit sha's
+      #
+      # NEWLINE = "\n"
+      #
+      def split_values(&_block)
+        value.split(NEWLINE).each_with_object({}) do |arr, obj|
+          yield arr, obj
+        end
+      end
+    end
+  end
+end

data/lib/release/notes/configurable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    module Configurable
+      delegate :timezone, :grep_insensitive?, :regex_type,
+               :include_merges?, :link_to_labels, :link_to_sites, :link_to_humanize,
+               :log_all, :header_title, :header_title_type, :features,
+               :bugs, :misc, :feature_title,
+               :bug_title, :misc_title, :log_all_title, :single_label,
+               :output_file, :temp_file, :link_commits?, :all_labels,
+               :prettify_messages?, :release_notes_exist?,
+               :force_rewrite, prefix: :config, to: :"Release::Notes.configuration"
+    end
+  end
+end

data/lib/release/notes/date_formatter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class DateFormatter
+      include Configurable
+      attr_reader :date
+      HUMANIZED = "%B %d, %Y %r %Z"
+
+      #
+      # Format the date
+      #
+      # @param [Date] date - parse date or return the current date/time
+      #
+      def initialize(date = nil)
+        Time.zone = config_timezone
+        @date = date.present? ? Time.zone.parse(date) : Time.zone.now
+      end
+
+      #
+      # Format date
+      #
+      # @return [String] Month Day, Year, Time AM/PM Time Zone
+      # ex: "January 17, 2019 10:22:53 PM EST"
+      #
+      def humanize
+        date.strftime(HUMANIZED)
+      end
+    end
+  end
+end