capistrano-committed 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fe7f70c9b07f59c5bc350622702aa0aa9ab7fec
-  data.tar.gz: 21b3b32dcc4195be1bd68cd5cff667ad6f4301ab
+  metadata.gz: 53f9838f0ee36a0fc450a0d4c554aacb0f2c8eff
+  data.tar.gz: e51d3b4e484f15f51d0a3261a99b8cb23c2903e6
 SHA512:
-  metadata.gz: f4677d783f58853501d7705bde6e459916c642d467fe79f83ff02bd6fc814bbbf266b6c566a62fc1c72fef9a78f78ff1ebbe235e7286fa59081a26bee08544ab
-  data.tar.gz: bcc8b8781b1b674e5a026b42acc9cb7fd15ef96bdbc99de0bd93662b7581c6f78a4a694924130c3ae48ea497efff30b13c4f9502c10696efc803ea9d5c6462b9
+  metadata.gz: d25d95dba27120f8cbabc51390886b284787ae1d839c49762da5356bccfbd7a2c60bb890550be10c836be934380211e7de005a7a18e306db329949ec42edd8e5
+  data.tar.gz: beac303f7200b7d85ae0303706d3cb619031bd15b7c952fceaa6dfabd954dcb4b06aff0e87ce1f79c5f4643aa7e64550543a3caa167bc67c9b37da3f6347bdcf

data/README.md

@@ -93,9 +93,14 @@ set :committed_revision_limit, 10
 # How many days beyond the last revision we fetch should we look for commits
 set :committed_commit_buffer, 1
 
-# Where to upload the report - '%s' is replaced with `current_path` if present.
-# `nil` will stop the report from uploading at all, and print to STDOUT instead.
-set :committed_output_path, '%s/public/committed.txt'
+# Where to upload the text report - '%s' is replaced with `current_path` if
+# present. `nil` will stop the report from uploading at all, and print to STDOUT
+# instead.
+set :committed_output_text_path, '%s/public/committed.txt'
+
+# Where to upload the html report - '%s' is replaced with `current_path` if
+# present. `nil` will stop the report from uploading at all.
+set :committed_output_html_path, '%s/public/committed.html'
 
 # This is a regexp pattern that describes issue numbers in commit titles and
 # descriptions. This example matches JIRA numbers enclosed in square braces -

data/capistrano-committed.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "capistrano", '~> 3.4'
   spec.add_dependency "github_api", "~> 0.13.0"
+  spec.add_dependency "mustache", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/capistrano/committed.rb

@@ -1,11 +1,23 @@
 require 'capistrano/committed/version'
 require 'capistrano/committed/i18n'
 require 'capistrano/committed/github_api'
+require 'capistrano/committed/output'
 
 module Capistrano
   module Committed
     class << self
-      def revision_search_regex(revision_line)
+      @@settings = {}
+
+      def import_settings(settings, merge = nil)
+        merge.nil? ? @@settings = settings : @@settings.merge!(settings)
+      end
+
+      def get_setting(setting, variable = nil)
+         variable.nil? ? @@settings[setting] : variable
+      end
+
+      def revision_search_regex(revision_line = nil)
+        revision_line = get_setting(:revision_line, revision_line)
         check_type __callee__, 'revision_line', revision_line.is_a?(String)
 
         search = Regexp.escape(revision_line)
@@ -13,15 +25,21 @@ module Capistrano
         Regexp.new(search)
       end
 
-      def get_revisions_from_lines(lines, search, branch, limit)
+      def get_revisions_from_lines(lines, search = nil, branch = nil, limit = nil)
         check_type __callee__, 'lines', lines.is_a?(Array)
         lines.each_with_index { |line, index|
           check_type __callee__,
                      format('lines[%d]', index),
                      line.is_a?(String)
         }
+
+        search = revision_search_regex if search.nil?
         check_type __callee__, 'search', search.is_a?(Regexp)
+
+        branch = get_setting(:branch, branch)
         check_type __callee__, 'branch', (branch.is_a?(Symbol) || branch.is_a?(String))
+
+        limit = get_setting(:revision_limit, limit)
         check_type __callee__, 'limit', limit.is_a?(Integer)
 
         revisions = {}
@@ -42,10 +60,14 @@ module Capistrano
         pad_revisions(revisions)
       end
 
-      def add_dates_to_revisions(revisions, github, git_user, git_repo)
+      def add_dates_to_revisions(revisions, github, git_user = nil, git_repo = nil)
         check_type __callee__, 'revisions', revisions.is_a?(Hash)
         check_type __callee__, 'github', github.is_a?(Capistrano::Committed::GithubApi)
+
+        git_user = get_setting(:user, git_user)
         check_type __callee__, 'git_user', git_user.is_a?(String)
+
+        git_repo = get_setting(:repo, git_repo)
         check_type __callee__, 'git_repo', git_repo.is_a?(String)
 
         revisions.each do |release, revision|
@@ -72,114 +94,46 @@ module Capistrano
         days * 24 * 60 * 60
       end
 
-      def add_buffer_to_time(time, buffer_in_days)
+      def add_buffer_to_time(time, buffer_in_days = nil)
         check_type __callee__, 'time', time.is_a?(Time)
+
+        buffer_in_days = get_setting(:commit_buffer, buffer_in_days)
         check_type __callee__, 'buffer_in_days', buffer_in_days.is_a?(Numeric)
 
         (time - days_to_seconds(buffer_in_days)).iso8601
       end
 
-      def format_revision_header(release, revision)
-        check_type __callee__, 'release', (release.is_a?(Symbol) || release.is_a?(String))
-        check_type __callee__, 'revision', revision.is_a?(Hash)
-
-        output = ['']
-        output << ('=' * 94)
-        case release
-        when :next
-          output << t('committed.output.next_release')
-        when :previous
-          output << t('committed.output.previous_release',
-                      time: revision[:date])
-        else
-          output << t('committed.output.current_release',
-                      release_time: Time.parse(revision[:release]).iso8601,
-                      sha: revision[:sha],
-                      commit_time: revision[:date])
-        end
-        output << ('=' * 94)
-        output << ''
-      end
-
-      def format_commit(commit, pad, issue_pattern, postprocess, url_pattern)
-        check_type __callee__, 'commit', commit.is_a?(Hash)
-        check_type __callee__, 'pad', pad.is_a?(String)
-        # issue_pattern, postprocess, and url_pattern get type checked by `get_issue_urls`
-
-        # Print the commit ref
-        output = [format('%s * %s',
-                         pad,
-                         t('committed.output.commit_sha', sha: commit[:sha]))]
-        output << pad
-
-        # Print the commit message
-        lines = commit[:commit][:message].chomp.split("\n")
-        unless lines.empty?
-          lines.each do |line|
-            output << format('%s   > %s', pad, line)
-          end
-          output << pad
-
-          # Get any issue numbers referred to in the commit message
-          # and print links to them
-          urls = get_issue_urls(issue_pattern,
-                                postprocess,
-                                url_pattern,
-                                commit[:commit][:message])
-          output += format_issue_urls(urls, pad)
-        end
-
-        # Committer details
-        output << format('%s   %s',
-                         pad,
-                         t('committed.output.committed_on', time: commit[:commit][:committer][:date]))
-        output << format('%s   %s',
-                         pad,
-                         t('committed.output.committed_by', login: commit[:committer][:login]))
-        output << pad
-
-        # Print a link to the commit in GitHub
-        output << format('%s   %s', pad, commit[:html_url])
-        output << pad
-      end
+      def get_issue_urls(message, issue_match = nil, issue_postprocess = nil, issue_url = nil)
+        check_type __callee__, 'message', message.is_a?(String)
 
-      def get_issue_urls(issue_pattern, postprocess, url_pattern, message)
+        issue_match = get_setting(:issue_match, issue_match)
         check_type __callee__,
-                   'issue_pattern',
-                   (issue_pattern.is_a?(String) || issue_pattern.is_a?(Regexp))
+                   'issue_match',
+                   (issue_match.is_a?(String) || issue_match.is_a?(Regexp))
 
-        check_type __callee__, 'postprocess', postprocess.is_a?(Array)
-        postprocess.each { |method|
+        issue_postprocess = get_setting(:issue_postprocess, issue_postprocess)
+        check_type __callee__, 'issue_postprocess', issue_postprocess.is_a?(Array)
+        issue_postprocess.each { |method|
           check_type __callee__,
-                     format('postprocess[:%s]', method.to_s),
+                     format('issue_postprocess[:%s]', method.to_s),
                      method.is_a?(Symbol)
         }
 
-        check_type __callee__, 'url_pattern', url_pattern.is_a?(String)
-        check_type __callee__, 'message', message.is_a?(String)
+        issue_url = get_setting(:issue_url, issue_url)
+        check_type __callee__, 'issue_url', issue_url.is_a?(String)
 
-        matches = message.scan(Regexp.new(issue_pattern))
+        matches = message.scan(Regexp.new(issue_match))
         return [] unless matches
         matches.map! { |match|
           issue = match[0]
-          postprocess.each { |method|
+          issue_postprocess.each { |method|
             issue = issue.send(method)
           }
-          format(url_pattern, issue)
+          format(issue_url, issue)
         }
         matches.uniq
       end
 
-      def format_issue_urls(urls, pad = '')
-        return [] if urls.nil? || urls.empty?
-        output = []
-        output << format('%s   %s', pad, t('committed.output.issue_links'))
-        urls.each do |url|
-          output << format('%s   - %s', pad, url)
-        end
-        output << format('%s', pad)
-      end
-
     private
       def check_type(method, param, condition)
         fail TypeError, t('committed.error.helpers.valid_param',
@@ -194,9 +148,9 @@ module Capistrano
           # Sort revisions by release date
           revisions = Hash[revisions.sort { |a, b| b[1][:release] <=> a[1][:release] }]
           # Add the "previous" revision
-          revisions.merge!(previous: { entries: {} })
+          revisions.merge!(previous: { release: :previous, entries: {} })
           # Add the "next" revision
-          revisions = {next: { entries: {} }}.merge(revisions)
+          revisions = {next: { release: :next, entries: {} }}.merge(revisions)
         end
         revisions
       end

data/lib/capistrano/committed/i18n.rb

@@ -16,6 +16,7 @@ en = {
       string_or_nil:            '`:%{variable}` variable is not a string or `nil`.',
       string_or_regexp_or_nil:  '`:%{variable}` variable is not a string or `Regexp` object or `nil`.'
     },
+    deprecated: '`%{deprecated}` variable is deprecated. Use `%{replacement}` instead.',
     runtime: {
       revisions_empty:          'The %{branch} branch has never been deployed to the %{stage} stage. No log has been generated.',
       revision_commit_missing:  'No commit data has been found for the %{branch} branch on the %{stage} stage. No log has been generated.',
@@ -23,6 +24,7 @@ en = {
     }
   },
   output: {
+    page_title:           'Git Deployment Report for %{repo}',
     next_release:         'Next release',
     previous_release:     'Commits before %{time} are omitted from the report   ¯\_(ツ)_/¯',
     current_release:      'Release on %{release_time} from commit %{sha} at %{commit_time}',

data/lib/capistrano/committed/output.rb

@@ -0,0 +1,147 @@
+require 'mustache'
+
+module Capistrano
+  module Committed
+    class Output < Mustache
+      @@template_format = 'txt'
+
+      self.template_path = format('%s/output', File.dirname(__FILE__))
+      self.template_file = format('%s/output/output_%s.mustache', File.dirname(__FILE__), @@template_format)
+
+      def get_output_path(file)
+        format('%s/output/%s', File.dirname(__FILE__), file)
+      end
+
+      def get_output_template_path(format = 'txt', set_template_format = true)
+        @@template_format = format if set_template_format
+        get_output_path(format('output_%s.mustache', format))
+      end
+
+      def release_header
+        case context.current[:release]
+        when :next
+          t('committed.output.next_release')
+        when :previous
+          t('committed.output.previous_release',
+            time: context.current[:date])
+        else
+          t('committed.output.current_release',
+            release_time: Time.parse(context.current[:release]).iso8601,
+            sha: context.current[:sha],
+            commit_time: context.current[:date])
+        end
+      end
+
+      def items
+        return unless context.current[:entries]
+        Hash[context.current[:entries].sort_by { |date, _entries| date }.reverse].values.flatten
+      end
+
+      def item_title
+        return unless context.current[:info]
+        case context.current[:type]
+        when :commit
+          t('committed.output.commit_sha',
+            sha: context.current[:info][:sha])
+        when :pull_request
+          t('committed.output.pull_request_number',
+            number: context.current[:info][:number])
+        end
+      end
+
+      def item_subtitle
+        return unless context.current[:type] == :pull_request
+        return unless context.current[:info]
+        context.current[:info][:title]
+      end
+
+      def has_item_subtitle
+        !item_subtitle.nil?
+      end
+
+      def item_lines
+        return unless context.current[:info]
+        case context.current[:type]
+        when :commit
+          context.current[:info][:commit][:message].chomp.delete("\r").split("\n")
+        when :pull_request
+          context.current[:info][:body].chomp.delete("\r").split("\n")
+        end
+      end
+
+      def has_item_lines
+        !item_lines.empty?
+      end
+
+      def issue_links
+        return unless context.current[:info]
+        case context.current[:type]
+        when :commit
+          ::Capistrano::Committed.get_issue_urls(context.current[:info][:commit][:message])
+        when :pull_request
+          ::Capistrano::Committed.get_issue_urls(context.current[:info][:title] + context.current[:info][:body])
+        end
+      end
+
+      def issue_link
+        format_link(context.current)
+      end
+
+      def has_issue_links
+        !issue_links.empty?
+      end
+
+      def item_created_on
+        return unless context.current[:info]
+        case context.current[:type]
+        when :commit
+          t('committed.output.committed_on', time: context.current[:info][:commit][:committer][:date])
+        when :pull_request
+          t('committed.output.merged_on', time: context.current[:info][:merged_at])
+        end
+      end
+
+      def item_created_by
+        return unless context.current[:info]
+        case context.current[:type]
+        when :commit
+          t('committed.output.committed_by', login: context.current[:info][:committer][:login])
+        when :pull_request
+          t('committed.output.merged_by', login: context.current[:info][:merged_by][:login])
+        else
+
+        end
+      end
+
+      def item_link
+        case context.current[:type]
+        when :commit, :pull_request
+          return unless context.current[:info]
+          format_link(context.current[:info][:html_url])
+        end
+      end
+
+      def commits
+        return unless context.current[:type] == :pull_request
+        return if context.current[:commits].nil?
+        return if context.current[:commits].empty?
+        context.current[:commits].flatten
+      end
+
+      def has_commits
+        !commits.nil?
+      end
+
+    private
+
+      def format_link(url)
+        case @@template_format
+        when 'html'
+          format('<a href="%s">%s</a>', url, url)
+        when 'txt'
+          url
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/committed/output/output_html.mustache

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title>{{page_title}}</title>
+  </head>
+  <body>
+    <pre>
+{{>output_txt}}
+    </pre>
+  </body>
+</html>

data/lib/capistrano/committed/output/output_txt.mustache

@@ -0,0 +1,63 @@
+{{page_title}}
+{{#revisions}}
+
+==============================================================================================
+{{release_header}}
+==============================================================================================
+  {{#items}}
+
+ * {{item_title}}
+    {{#has_item_subtitle}}
+   {{item_subtitle}}
+    {{/has_item_subtitle}}
+    {{#has_item_lines}}
+
+      {{#item_lines}}
+   > {{.}}
+      {{/item_lines}}
+      {{#has_issue_links}}
+
+   Issue links:
+        {{#issue_links}}
+   - {{{issue_link}}}
+        {{/issue_links}}
+      {{/has_issue_links}}
+    {{/has_item_lines}}
+
+   {{item_created_on}}
+   {{item_created_by}}
+
+   {{{item_link}}}
+
+    {{#has_commits}}
+      {{#commits}}
+    ------------------------------------------------------------------------------------------
+   |
+   | * {{item_title}}
+        {{#has_item_lines}}
+   |
+          {{#item_lines}}
+   |   > {{.}}
+          {{/item_lines}}
+          {{#has_issue_links}}
+   |
+   |   Issue links:
+            {{#issue_links}}
+   |   - {{{issue_link}}}
+            {{/issue_links}}
+          {{/has_issue_links}}
+        {{/has_item_lines}}
+   |
+   |   {{item_created_on}}
+   |   {{item_created_by}}
+   |
+   |   {{{item_link}}}
+   |
+      {{/commits}}
+    ------------------------------------------------------------------------------------------
+
+    {{/has_commits}}
+----------------------------------------------------------------------------------------------
+  {{/items}}
+
+{{/revisions}}

data/lib/capistrano/committed/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Committed
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

data/lib/capistrano/tasks/committed.rake

@@ -33,10 +33,20 @@ namespace :committed do
                       variable: 'committed_commit_buffer') unless
                         fetch(:committed_commit_buffer).is_a?(Integer)
 
+    fail TypeError, t('committed.error.deprecated',
+                      deprecated: 'committed_output_path',
+                      replacement: 'committed_output_text_path') if
+                        fetch(:committed_output_path).is_a?(String)
+
+    fail TypeError, t('committed.error.prerequisites.string_or_nil',
+                      variable: 'committed_output_text_path') unless
+                        fetch(:committed_output_text_path).is_a?(String) ||
+                        fetch(:committed_output_text_path).nil?
+
     fail TypeError, t('committed.error.prerequisites.string_or_nil',
-                      variable: 'committed_output_path') unless
-                        fetch(:committed_output_path).is_a?(String) ||
-                        fetch(:committed_output_path).nil?
+                      variable: 'committed_output_html_path') unless
+                        fetch(:committed_output_html_path).is_a?(String) ||
+                        fetch(:committed_output_html_path).nil?
 
     fail TypeError, t('committed.error.prerequisites.string_or_regexp_or_nil',
                       variable: 'committed_issue_match') unless
@@ -88,17 +98,30 @@ namespace :committed do
     invoke 'committed:check_prerequisites'
     invoke 'committed:check_report_prerequisites'
 
+    ::Capistrano::Committed.import_settings({
+      branch:            fetch(:branch),
+      user:              fetch(:committed_user),
+      repo:              fetch(:committed_repo),
+      revision_line:     fetch(:committed_revision_line),
+      github_config:     fetch(:committed_github_config),
+      revision_limit:    fetch(:committed_revision_limit),
+      commit_buffer:     fetch(:committed_commit_buffer),
+      output_text_path:  fetch(:committed_output_text_path),
+      output_html_path:  fetch(:committed_output_html_path),
+      issue_match:       fetch(:committed_issue_match),
+      issue_postprocess: fetch(:committed_issue_postprocess),
+      issue_url:         fetch(:committed_issue_url),
+      deployments:       fetch(:committed_deployments),
+      deployment_id:     fetch(:committed_deployment_id)
+    })
+
     # Only do this on the primary web server
     on primary :web do
       # Get the Capistrano revision log
       lines = capture(:cat, revision_log).split("\n").reverse
 
-      # Build the regex to search for revision data in the log, by default this
-      # is the localised string from Capistrano
-      search = ::Capistrano::Committed.revision_search_regex(fetch(:committed_revision_line))
-
       # Build the revisions hash
-      revisions = ::Capistrano::Committed.get_revisions_from_lines(lines, search, fetch(:branch), fetch(:committed_revision_limit))
+      revisions = ::Capistrano::Committed.get_revisions_from_lines(lines)
 
       # No revisions, no log
       if revisions.empty?
@@ -112,7 +135,7 @@ namespace :committed do
       github = ::Capistrano::Committed::GithubApi.new(fetch(:committed_github_config))
 
       # Get the actual date of the commit referenced to by the revision
-      revisions = ::Capistrano::Committed.add_dates_to_revisions(revisions, github, fetch(:committed_user), fetch(:committed_repo))
+      revisions = ::Capistrano::Committed.add_dates_to_revisions(revisions, github)
 
       # Get the earliest revision date
       earliest_date = ::Capistrano::Committed.get_earliest_date_from_revisions(revisions)
@@ -126,7 +149,7 @@ namespace :committed do
       end
 
       # Go back an extra N days
-      earliest_date = ::Capistrano::Committed.add_buffer_to_time(earliest_date, fetch(:committed_commit_buffer))
+      earliest_date = ::Capistrano::Committed.add_buffer_to_time(earliest_date)
       revisions[:previous][:date] = earliest_date
 
       # Get all the commits on this branch
@@ -175,10 +198,17 @@ namespace :committed do
 
         # Push pull request data in to the revision entries hash
         key = revisions.keys[revision_index]
+        sub_commits = []
+        pull_request[:commits].each do |c|
+          sub_commits << {
+            type: :commit,
+            info: c
+          }
+        end
         revisions[key][:entries][pull_request[:info][:merged_at]] = [{
           type:     :pull_request,
           info:     pull_request[:info],
-          commits:  pull_request[:commits]
+          commits:  sub_commits
         }]
 
         # Delete commits which are in this pull request from the hash of commits
@@ -210,100 +240,38 @@ namespace :committed do
         }
       end
 
-      # Loop through the revisions to create the output
-      output = []
-      revisions.each do |release, revision|
-        # Build the revision header
-        output += ::Capistrano::Committed.format_revision_header(release,
-                                                                 revision)
-
-        # Loop through the entries in this revision
-        items = Hash[revision[:entries].sort_by { |date, _entries| date }.reverse]
-        items.each do |_date, entries|
-          entries.each do |entry|
-            case entry[:type]
-            when :pull_request
-              # These are pull requests that are included in this revision
-
-              # Print out the pull request number and title
-              output << format(' * %s',
-                               t('committed.output.pull_request_number',
-                                 number: entry[:info][:number]))
-              output << format('   %s', entry[:info][:title])
-              output << ''
-
-              # Print out each line of the pull request description
-              lines = entry[:info][:body].chomp.split("\n")
-              unless lines.empty?
-                output << format('   %s', lines.join("\n   "))
-                output << ''
-              end
-
-              # Get any issue numbers referred to in the commit info and print
-              # links to them
-              urls = ::Capistrano::Committed.get_issue_urls(fetch(:committed_issue_match),
-                                                            fetch(:committed_issue_postprocess),
-                                                            fetch(:committed_issue_url),
-                                                            entry[:info][:title] + entry[:info][:body])
-              output += ::Capistrano::Committed.format_issue_urls(urls)
-
-              # Merger details
-              output << format('   %s',
-                               t('committed.output.merged_on',
-                                 time: entry[:info][:merged_at]))
-              output << format('   %s',
-                               t('committed.output.merged_by',
-                                 login: entry[:info][:merged_by][:login]))
-              output << ''
-
-              # Print a link to the pull request on GitHub
-              output << format('   %s', entry[:info][:html_url])
-              output << ''
-
-              # Loop through the commits in this pull request
-              unless entry[:commits].nil?
-                entry[:commits].each do |commit|
-                  output << ('    ' + ('-' * 90))
-                  output << '   |'
-                  output += ::Capistrano::Committed.format_commit(commit,
-                                                                  '   |',
-                                                                  fetch(:committed_issue_match),
-                                                                  fetch(:committed_issue_postprocess),
-                                                                  fetch(:committed_issue_url))
-                end
-                output << ('    ' + ('-' * 90))
-                output << ''
-              end
-
-            when :commit
-              # These are commits that are included in this revision, but are
-              # not in any pull requests
-              output += ::Capistrano::Committed.format_commit(entry[:info],
-                                                              '',
-                                                              fetch(:committed_issue_match),
-                                                              fetch(:committed_issue_postprocess),
-                                                              fetch(:committed_issue_url))
-            end
-
-            output << ('-' * 94)
-            output << ''
-          end
-        end
+      # Send the text output to screen, or to a file on the server
 
-        output << ''
-      end
+      # Create the mustache instance and plug in the revisions
+      output = ::Capistrano::Committed::Output.new()
+      output[:revisions] = revisions.values
+      output[:page_title] = t('committed.output.page_title',
+                              repo: format('%s/%s', fetch(:committed_user), fetch(:committed_repo)))
 
-      # Send the output to screen, or to a file on the server
-      if fetch(:committed_output_path).nil?
+      # Send the text output to a file on the server
+      if fetch(:committed_output_text_path).nil?
         # Just print to STDOUT
-        puts output
+        puts output.render
       else
         # Determine the output path and upload the output there
-        output_path = format(fetch(:committed_output_path), current_path)
-        upload! StringIO.new(output.join("\n")), output_path
+        output_text_path = format(fetch(:committed_output_text_path), current_path)
+        upload! StringIO.new(output.render), output_text_path
+
+        # Make sure the report is world readable
+        execute(:chmod, 'a+r', output_text_path)
+      end
+
+      # Send the html output to a file on the server
+      unless fetch(:committed_output_html_path).nil?
+        # Switch to the HTML template
+        output.template_file = output.get_output_template_path('html')
+
+        # Determine the output path and upload the output there
+        output_html_path = format(fetch(:committed_output_html_path), current_path)
+        upload! StringIO.new(output.render), output_html_path
 
         # Make sure the report is world readable
-        execute(:chmod, 'a+r', output_path)
+        execute(:chmod, 'a+r', output_html_path)
       end
     end
   end
@@ -319,7 +287,8 @@ namespace :load do
     set :committed_github_config,     -> { {} }
     set :committed_revision_limit,    -> { 10 }
     set :committed_commit_buffer,     -> { 1 }
-    set :committed_output_path,       -> { '%s/public/committed.txt' }
+    set :committed_output_text_path,  -> { '%s/public/committed.txt' }
+    set :committed_output_html_path,  -> { '%s/public/committed.html' }
     set :committed_issue_match,       -> { '\[\s?([a-zA-Z0-9]+\-[0-9]+)\s?\]' }
     set :committed_issue_postprocess, -> { [] }
     set :committed_issue_url,         -> { 'https://example.jira.com/browse/%s' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-committed
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Sam Bauers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,9 @@ files:
 - lib/capistrano/committed.rb
 - lib/capistrano/committed/github_api.rb
 - lib/capistrano/committed/i18n.rb
+- lib/capistrano/committed/output.rb
+- lib/capistrano/committed/output/output_html.mustache
+- lib/capistrano/committed/output/output_txt.mustache
 - lib/capistrano/committed/version.rb
 - lib/capistrano/tasks/committed.rake
 homepage: https://github.com/sambauers/capistrano-committed