release-notes 2.0.0 → 3.0.0

data/lib/release/notes/system.rb

@@ -2,40 +2,73 @@
 
 module Release
   module Notes
-    module System
-      module_function
+    class System
+      include Configurable
+      attr_reader :opts
 
-      extend ActiveSupport::Concern
-      include Git
+      #
+      # Release::Notes::System initializer
+      #
+      # @param **opts
+      #
+      # @return none
+      #
+      def initialize(**opts)
+        @opts = opts
 
-      delegate :all_labels, to: :"Release::Notes.configuration"
+        return unless opts.delete(:log_all) == true
 
-      included do
-        def system_log(**opts)
-          if opts.delete(:log_all) == true
-            opts[:label] = all_labels
-            opts[:invert_grep] = " --invert-grep"
-          end
-
-          `#{log(opts)}`
-        end
+        opts[:label] = config_all_labels
+        opts[:invert_grep] = " --invert-grep"
       end
 
-      def first_commit
-        `#{Git.first_commit}`
+      #
+      # Call Git.log method with configurable options
+      #
+      # @return [String] shell output of running Git.log
+      #
+      def log
+        `#{Git.log(opts)}`
       end
 
-      def all_tags
-        `#{Git.read_all_tags}`
-      end
+      class << self
+        #
+        # Call Git.first_commit method
+        #
+        # @return [String] shell output of running Git.first_commit
+        #
+        def first_commit
+          `#{Git.first_commit}`
+        end
 
-      def system_last_tag
-        `#{Git.last_tag}`
-      end
+        #
+        # Call Git.read_all_tags method
+        #
+        # @return [String] shell output of running Git.read_all_tags
+        #
+        def all_tags
+          `#{Git.read_all_tags}`
+        end
+
+        #
+        # Call Git.last_tag method
+        #
+        # @return [String] shell output of running Git.last_tag
+        #
+        def last_tag
+          `#{Git.last_tag}`
+        end
 
-      def tag_date(tag: nil)
-        tag ||= system_last_tag
-        `#{Git.tag_date(tag)}`
+        #
+        # Call Git.tag_date method
+        #
+        # @param [String] tag - a tag that you want to get the date created for
+        #
+        # @return [String] shell output of running Git.tag_date
+        #
+        def tag_date(tag: nil)
+          `#{Git.tag_date(tag || last_tag)}`
+        end
       end
     end
   end

data/lib/release/notes/tag.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class Tag
+      include Configurable
+      attr_accessor :_hashes
+      attr_reader :tag, :previous_tag
+
+      delegate :digest_header, prefix: :writer, to: :@writer
+
+      # Release::Notes::Tag initializer
+      #
+      # @param [String] tag - a git tag (ex: v2.0.0)
+      # @param [Release::Notes::Write] writer - an object containing a header, title, and associated log messages
+      # @param [String] previous_tag - the previous git tag (ex: v1.3.0)
+      def initialize(tag:, writer:, previous_tag:)
+        @tag = tag
+        @writer = writer
+        @previous_tag = previous_tag
+
+        @_commits = {}
+        @_hashes = []
+      end
+
+      #
+      # Adds log messages to @_commits variable, and if there are commits that need to be added to
+      # changelog, add the header and associated log messages
+      #
+      # @return none
+      #
+      def perform
+        store_commits # adds to @_commits
+
+        if commits_available? # true
+          writer_digest_header(header_title) # <File:./release-notes.tmp.md (closed)>
+          log_commits # hash [0,1,2...], messages for sha
+        end
+
+        self
+      end
+
+      private
+
+      #
+      # Are there git sha's with commits?
+      #
+      # @return [Boolean] true: commits are present, false: there are no commits
+      #
+      def commits_available?
+        @_commits.present?
+      end
+
+      #
+      # Formats a supplied date
+      #
+      # @param [String] date - a date
+      #
+      # @return [String] formatted date
+      #
+      def formatted_date(date = nil)
+        DateFormatter.new(date).humanize
+      end
+
+      #
+      # Generate header title
+      #
+      # @return [String] the header to be added to changelog
+      #
+      def header_title
+        config_header_title.yield_self { |t| title(t) } # config_header_title = "tag"
+      end
+
+      #
+      # Creates new commit objects from the @_commits object
+      #
+      # @return [Hash] unique log messages per tag
+      #
+      def log_commits
+        @_commits.each do |key, val|
+          Commits.new(title: titles[key], value: val, writer: @writer, tagger: self).perform
+        end
+      end
+
+      #
+      # Transform tag into date
+      #
+      # @return [String] date the tag was created
+      #
+      def tag_date
+        System.tag_date(tag: tag)
+      end
+
+      #
+      # Adds log messages to @_commits
+      #
+      # @return none
+      #
+      def store_commits
+        all_labels.each_with_index do |lab, i|
+          system_log(label: lab).tap { |str| @_commits[i] = str if str.present? }
+        end
+
+        # if log_all = true
+        @_commits[all_labels.size] = system_log(log_all: true) if config_log_all
+      end
+
+      #
+      # Create new system object that contains log messages between tag_from and tag_to
+      # with the relevant options
+      #
+      # @param [Hash] opts - options like the label to grep
+      #
+      # @return [String] log messages that meet the criteria
+      #
+      def system_log(**opts)
+        System.new({ tag_from: previous_tag, tag_to: tag }.merge(opts)).log
+      end
+
+      #
+      # Array of strings containing all labels
+      #
+      # @return [Array] array of all labels
+      #
+      def all_labels
+        [config_features, config_bugs, config_misc]
+      end
+
+      #
+      # Array of strings containing all titles
+      #
+      # @return [Array] array of all titles
+      #
+      def titles
+        [config_feature_title, config_bug_title,
+         config_misc_title, config_log_all_title]
+      end
+
+      #
+      # Title or formatted tag date
+      #
+      # @param [String] title - should the title be the git tag? If yes, use the git
+      # tag as the title, if not use the tag date
+      #
+      # @return [String] tag title or formatted tag date to be added to changelog
+      #
+      def title(title)
+        title == "tag" ? tag : formatted_date(tag_date)
+      end
+    end
+  end
+end

data/lib/release/notes/version.rb

@@ -2,6 +2,6 @@
 
 module Release
   module Notes
-    VERSION = "2.0.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/release/notes/write.rb

@@ -4,24 +4,33 @@ module Release
   module Notes
     class Write
       include Link
-      include PrettyPrint
-
-      delegate :output_file, :temp_file, :link_commits?, :all_labels,
-               :prettify_messages?, :release_notes_exist?,
-               :force_rewrite, to: :"Release::Notes.configuration"
+      include Configurable
 
+      #
+      # Release::Notes::Write initializer
+      #
+      # @return none
+      #
       def initialize
-        # create a new temp file regardless if it exists
         new_temp_file_template
       end
 
-      # write strings to tempfile
+      #
+      # Write strings to tempfile
+      #
+      # @param [String] str - string to add to the temp file
+      #
       def digest(str)
-        File.open(temp_file, "a") { |fi| fi << str }
+        File.open(config_temp_file, "a") { |fi| fi << str }
       end
 
-      # formats titles to be added to the new file
-      # removes tags from title if configured
+      # Formats titles to be added to the new file and removes tags from title if configured
+      #
+      # @param [String] title - string representing a label title
+      # @param [String] log_message - string containing log messages that fall under the title
+      #
+      # @return [String] formatted label title and log messages that fall under it.
+      #
       def digest_title(title: nil, log_message: nil)
         @title = title
         @log_message = log_message
@@ -30,64 +39,111 @@ module Release
         digest(titles)
       end
 
-      # formats the headers to be added to the new file
+      #
+      # Adds formatted header to changelog
+      #
+      # @param [String] header - unformatted header that needs to be added to changelog
+      #
       def digest_header(header)
         @header = header
         digest(header_present)
       end
 
+      #
       # append old file to new temp file
       # overwrite output file with tmp file
+      #
+      # @return none
+      #
       def write_new_file
-        copy_over_notes if release_notes_exist? && !force_rewrite
+        copy_over_notes if config_release_notes_exist? && !config_force_rewrite
 
-        FileUtils.cp(temp_file, output_file)
-        FileUtils.rm temp_file
+        FileUtils.cp(config_temp_file, config_output_file)
+        FileUtils.rm config_temp_file
       end
 
       private
 
-      # @api private
+      #
+      # Formats the header
+      #
+      # @return [String] formatted header to be added to changelog
+      #
       def header_present
-        "\n## #{@header}\n"
+        "#{NEWLINE}## #{@header}#{NEWLINE}"
       end
 
-      # @api private
+      #
+      # Formats the title
+      #
+      # @return [String] formatted title to be added to changelog
+      #
       def title_present
-        "\n#{@title}\n\n"
+        "#{NEWLINE}#{@title}#{NEWLINE}#{NEWLINE}"
       end
 
-      # @api private
+      #
+      # If prettify_messages is true, remove the label keyword from log message
+      # else, just return the log message
+      #
+      # @return [String] log message to be added to changelog
+      #
       def format_line
-        return "#{prettify(line: link_messages)}\n" if prettify_messages?
+        return "#{prettify_linked_messages}#{NEWLINE}" if config_prettify_messages?
 
         link_messages
       end
 
-      # @api private
+      #
+      # Calls link_message method with a log message
+      #
+      # @return [String] log message to be added to the changelog
+      #
       def link_messages
         link_message @log_message
       end
 
-      # @api private
+      #
+      # Prettifies linked log messages
+      #
+      # @return [String] formatted log message
+      #
+      def prettify_linked_messages
+        Prettify.new(line: link_messages).perform
+      end
+
+      #
+      # Appends previous changelog to a temporary file
+      #
+      # @return none
+      #
       def copy_over_notes
-        File.open(temp_file, "a") do |f|
-          f << "\n"
-          IO.readlines(output_file)[2..-1].each { |line| f << line }
+        File.open(config_temp_file, "a") do |f|
+          f << NEWLINE
+          IO.readlines(config_output_file)[2..-1].each { |line| f << line }
         end
       end
 
-      # @api private
+      #
+      # Returns the log message if message linking is not configured
+      # else, return the linked log_message
+      #
+      # @return [String] original or updated log essage
+      #
       def link_message(log_message)
-        return log_message unless link_commits?
+        return log_message unless config_link_commits?
 
         link_lines(lines: log_message)
       end
 
-      # @api private
+      #
+      # Open temp file and output release notes header
+      #
+      # @return none
+      #
       def new_temp_file_template
-        File.open(temp_file, "w") do |fi|
-          fi << "# Release Notes\n"
+        File.open(config_temp_file, "w") do |fi|
+          fi << "# Release Notes#{NEWLINE}"
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release-notes
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Drew Monroe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,15 +112,18 @@ files:
 - lib/generators/release/notes/install/templates/README
 - lib/generators/release/notes/install/templates/release_notes.rb
 - lib/release/notes.rb
+- lib/release/notes/commits.rb
+- lib/release/notes/configurable.rb
 - lib/release/notes/configuration.rb
-- lib/release/notes/date_format.rb
+- lib/release/notes/date_formatter.rb
 - lib/release/notes/git.rb
 - lib/release/notes/install.rb
 - lib/release/notes/link.rb
 - lib/release/notes/log.rb
-- lib/release/notes/pretty_print.rb
+- lib/release/notes/prettify.rb
 - lib/release/notes/railtie.rb
 - lib/release/notes/system.rb
+- lib/release/notes/tag.rb
 - lib/release/notes/tasks/install.rake
 - lib/release/notes/version.rb
 - lib/release/notes/write.rb