milestoner 18.11.0 → 19.0.0

data/lib/milestoner/models/commit.rb

@@ -6,9 +6,12 @@ module Milestoner
   module Models
     COMMIT_COMMON_ATTRIBUTES = %i[
       authored_at
+      authored_relative_at
       body
-      body_lines
+      committed_at
+      committed_relative_at
       deletions
+      encoding
       files_changed
       fingerprint
       fingerprint_key
@@ -21,12 +24,17 @@ module Milestoner
 
     COMMIT_ENRICHED_ATTRIBUTES = %i[
       author
+      body_html
       collaborators
+      created_at
       format
       issue
       milestone
+      notes_html
+      position
       review
       signers
+      updated_at
       uri
     ].freeze
 

data/lib/milestoner/renderers/universal.rb

@@ -6,7 +6,7 @@ module Milestoner
   module Renderers
     # The primary renderer for multiple input formats as HTML.
     class Universal
-      include Import[:settings]
+      include Dependencies[:settings]
 
       using Refinements::Binding
 

data/lib/milestoner/tags/builder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Tags
+    # Builds tag message.
+    class Builder
+      include Milestoner::Dependencies[:settings, :logger]
+
+      def initialize(enricher: Enricher.new, view: Views::Milestones::Show.new, **)
+        super(**)
+        @enricher = enricher
+        @view = view
+      end
+
+      def call version
+        force_minimum
+
+        enricher.call
+                .fmap { |tags| render tags.first, version }
+                .alt_map { |message| failure message }
+      end
+
+      private
+
+      attr_reader :enricher, :view
+
+      def force_minimum = settings.build_max = 1
+
+      def render tag, version
+        tag.version = version
+        view.call(tag:, layout: settings.build_layout, format: :git).to_s.lstrip
+      end
+
+      def failure message
+        logger.error { message }
+        message
+      end
+    end
+  end
+end

data/lib/milestoner/tags/creator.rb

@@ -7,17 +7,13 @@ module Milestoner
   module Tags
     # Handles the creation of project repository tags.
     class Creator
-      include Import[:git, :logger]
+      include Dependencies[:settings, :git, :logger]
       include Dry::Monads[:result]
 
-      def initialize(
-        collector: Commits::Collector.new,
-        builder: Builders::Stream.new(io: StringIO.new),
-        **
-      )
+      def initialize(collector: Commits::Collector.new, builder: Builder.new, **)
+        super(**)
         @collector = collector
         @builder = builder
-        super(**)
       end
 
       def call version
@@ -41,9 +37,11 @@ module Milestoner
 
       def collect = collector.call.alt_map { |message| message.sub("fatal: y", "Y").sub("\n", ".") }
 
-      def create(version) = build(version).bind { |body| git.tag_create version, body }
+      def create version
+        builder.call(version).bind { |body| git.tag_create version, "#{subject}\n\n#{body}\n\n" }
+      end
 
-      def build(version) = builder.call.fmap { |body| "Version #{version}\n\n#{body}\n\n" }
+      def subject = format(settings.tag_subject, **settings.to_h)
     end
   end
 end

data/lib/milestoner/{commits/tagger.rb → tags/enricher.rb}

@@ -6,42 +6,54 @@ require "refinements/struct"
 require "versionaire"
 
 module Milestoner
-  module Commits
-    # Assembles all commits for a tag.
-    class Tagger
-      include Milestoner::Import[:git, :settings, :logger]
-      include Enrichers::Import[author_enricher: :author]
+  module Tags
+    # Builds a collection of enriched tags and associated commits.
+    class Enricher
+      include Milestoner::Dependencies[:git, :settings, :logger]
+      include Commits::Enrichers::Dependencies[author_enricher: :author]
       include Dry::Monads[:result]
 
       using Refinements::Pathname
       using Versionaire::Cast
       using Refinements::Struct
 
-      def initialize(enricher: Commits::Enricher.new, model: Models::Tag, **)
-        @enricher = enricher
-        @model = model
+      def initialize(committer: Commits::Enricher.new, model: Models::Tag, **)
         super(**)
+        @committer = committer
+        @model = model
       end
 
       def call
-        collect.fmap { |tags| tail tags.last(settings.build_max).map(&:version) }
+        collect.fmap { |tags| adjust tags }
                .fmap { |references| slice(references).reverse }
                .bind { |tags| tags.empty? ? Failure("No tags or commits.") : Success(tags) }
       end
 
       private
 
-      attr_reader :enricher, :model
+      attr_reader :committer, :model
 
       def collect = git.tagged? ? git.tags("--sort=taggerdate") : placeholder_with_commits
 
-      # :reek:FeatureEnvy
-      def tail references
-        references.append "HEAD" if settings.build_tail == "head"
-        references.prepend nil if references.one?
+      def adjust tags
+        references = tags.last(settings.build_max).map(&:version)
+
+        maybe_append_head references
+        maybe_prepend_nil references, tags
         references
       end
 
+      def maybe_append_head references
+        references.append "HEAD" if settings.build_tail == "head"
+      end
+
+      def maybe_prepend_nil references, tags
+        max =  settings.build_max
+        tail = settings.build_tail
+
+        references.prepend nil if references.one? || (tail == "tag" && max >= tags.size)
+      end
+
       def slice references
         references.each_cons(2).with_object [] do |(min, max), entries|
           add_enrichment entries, min, max
@@ -51,7 +63,7 @@ module Milestoner
       def add_enrichment(all, *) = enrich(*).bind { |entry| all.append entry }
 
       def enrich min, max
-        enricher.call(min:, max:).bind { |commits| build_record git.tag_show(max), commits }
+        committer.call(min:, max:).bind { |commits| build_record git.tag_show(max), commits }
       end
 
       def build_record result, commits
@@ -72,7 +84,7 @@ module Milestoner
         ]
       end
 
-      def placeholder_with_commits = enricher.call.fmap { |commits| placeholder_for commits }
+      def placeholder_with_commits = committer.call.fmap { |commits| placeholder_for commits }
 
       def placeholder_for commits
         return commits if commits.empty?

data/lib/milestoner/tags/publisher.rb

@@ -6,7 +6,7 @@ module Milestoner
   module Tags
     # Handles the tagging and pushing of a tag to a remote repository.
     class Publisher
-      include Import[:logger]
+      include Dependencies[:logger]
       include Dry::Monads[:result]
 
       def initialize(creator: Tags::Creator.new, pusher: Tags::Pusher.new, **)

data/lib/milestoner/tags/pusher.rb

@@ -6,7 +6,7 @@ module Milestoner
   module Tags
     # Handles publishing of tags to a remote repository.
     class Pusher
-      include Import[:git, :logger]
+      include Dependencies[:git, :logger]
       include Dry::Monads[:result]
 
       def call version

data/lib/milestoner/templates/layouts/page.adoc.erb

@@ -1,2 +1,6 @@
+[.text-center]
+<%= scope(:logo).call %>
+
 <%= yield %>
+
 _Generated by link:<%= generator_uri %>[<%= generator_label %> <%= generator_version %>]._

data/lib/milestoner/templates/layouts/page.git.erb

@@ -0,0 +1 @@
+<%= yield %>

data/lib/milestoner/templates/layouts/page.html.erb

@@ -25,28 +25,35 @@
             sizes="200x200">
     <% end %>
 
-    <% if build_stylesheet %>
-      <link title="<%= project_label %>: Stylesheet"
-            rel="stylesheet"
-            href="<%= build_stylesheet %>.css"
-            type="text/css">
-    <% end %>
+    <link title="<%= project_label %>: Stylesheet"
+          rel="stylesheet"
+          href="<%= stylesheet_uri %>.css"
+          type="text/css">
 
     <script src="https://unpkg.com/alpinejs@3.14.3"
             integrity="sha384-iZD2X8o1Zdq0HR5H/7oa8W30WS4No+zWCKUPD7fHRay9I1Gf+C4F8sVmw7zec1wW"
             crossorigin="anonymous"
             defer>
     </script>
+
+    <script src="https://unpkg.com/htmx.org@2.0.4"
+            integrity="sha384-HGfztofotfshcF7+8n44JQL2oJmowVChPTg48S+jvZoztPfvwD79OC/LTtG6dMp+"
+            crossorigin="anonymous">
+    </script>
   </head>
 
-  <body>
-    <main>
+  <body class="milestoner">
+    <header class="page-header">
+      <%= scope(:logo).call %>
+    </header>
+
+    <main class="page-body">
       <%= yield %>
     </main>
 
-    <footer class="footer">
+    <footer class="page-footer">
       <p class="generator">
-        Generated by <a href="<%= generator_uri %>" class="link"><%= generator_label %> <%= generator_version %></a>.
+        Generated by <a href="<%= generator_uri %>"><%= generator_label %> <%= generator_version %></a>.
       </p>
     </footer>
   </body>

data/lib/milestoner/templates/layouts/page.md.erb

@@ -1,2 +1,5 @@
+<%= scope(:logo).call %>
+
 <%= yield %>
+
 *Generated by [<%= generator_label %> <%= generator_version %>](<%= generator_uri %>).*

data/lib/milestoner/templates/layouts/page.stream.erb

@@ -1 +1,2 @@
-<%= yield %>Generated by <%= generator_label %> <%= generator_version %>.
+<%= yield %>
+Generated by <%= generator_label %> <%= generator_version %>.

data/lib/milestoner/templates/layouts/page.xml.erb

@@ -1,4 +1,8 @@
 <article>
+  <header>
+    <%= scope(:logo).call %>
+  </header>
+
   <%= yield %>
 
   <hr/>

data/lib/milestoner/templates/milestones/_commit.adoc.erb

@@ -3,11 +3,11 @@
 ====
 *Message*
 
-<%= scope(:content, content: Array(commit.body_lines).join("\n")).call %>
+<%= scope(:content, content: commit.body).call %>
 
 *Notes*
 
-<%= scope(:content, content: commit.safe_notes).call %>
+<%= scope(:content, content: commit.notes).call %>
 
 *Author*
 
@@ -29,6 +29,6 @@
 * Lines: <%= commit.total_deletions %>/<%= commit.total_insertions %>
 * Issue: link:<%= commit.issue.uri %>[<%= commit.issue.id %>]
 * Review: link:<%= commit.review.uri %>[<%= commit.review.id %>]
-
-_<%= commit.datetime %>_
+* Created: <%= commit.created_at_human %>
+* Updated: <%= commit.updated_at_human %>
 ====

data/lib/milestoner/templates/milestones/_commit.html.erb

@@ -77,10 +77,13 @@
         <h3 class="label">Created</h3>
 
         <p class="line at">
-          <time datetime="<%= commit.at %>" class="date"><%= commit.date %></time>
-          <time datetime="<%= commit.at %>" class="weekday"><%= commit.weekday %></time>
-          <time datetime="<%= commit.at %>" class="time"><%= commit.time %></time>
-          <time datetime="<%= commit.at %>" class="zone"><%= commit.zone %></time>
+          <time datetime="<%= commit.created_at_machine %>"><%= commit.created_at_human %></time>
+        </p>
+
+        <h3 class="label">Updated</h3>
+
+        <p class="line at">
+          <time datetime="<%= commit.updated_at_machine %>"><%= commit.updated_at_human %></time>
         </p>
       </div>
     </div>

data/lib/milestoner/templates/milestones/_commit.stream.erb

@@ -1 +1 @@
-<%= commit.emoji %> <%= commit.subject %> - <%= commit.author.name %>
+<%= commit.colored_sha %> <%= commit.signature_emoji %> <%= commit.milestone_emoji %> <%= commit.emoji %> <%= commit.subject %> <%= commit.colored_author %> <%= commit.colored_created_relative_at %> <%= commit.colored_updated_relative_at %>

data/lib/milestoner/templates/milestones/_commit.xml.erb

@@ -40,13 +40,9 @@
 
     <li>Issue: <a href="<%= commit.issue.uri %>"><%= commit.issue.id %></a></li>
     <li>Review: <a href="<%= commit.review.uri %>"><%= commit.review.id %></a></li>
+    <li>Created: <%= commit.created_at_human %></li>
+    <li>Updated: <%= commit.updated_at_human %></li>
   </ul>
 
-  <p>
-    <em style="display: inline-flex; align-items: center; gap: 0.5rem; margin-top: 1rem;">
-      <%= commit.datetime %>
-    </em>
-  </p>
-
   <hr/>
 </details>

data/lib/milestoner/templates/milestones/_logo.adoc.erb

@@ -1 +1 @@
-image:<%= project_uri_logo %>[Logo,50,50]pass:[ ]
+image:<%= project_uri_logo %>[Logo,100,100]

data/lib/milestoner/templates/milestones/_logo.html.erb

@@ -1 +1 @@
-<img src="<%= project_uri_logo %>" alt="Logo" width="30" height="30">
+<img src="<%= project_uri_logo %>" alt="Logo" width="100" height="100">

data/lib/milestoner/templates/milestones/index.adoc.erb

@@ -0,0 +1,13 @@
+== link:<%= project_uri_home %>[<%= project_label %>] Versions
+
+All versions adhere to the link:https://alchemists.io/articles/strict_semantic_versioning[Strict Semantic Versioning] as enforced with link:https://alchemists.io/projects/versionaire[Versionaire] and automated by link:<%= generator_uri %>[<%= generator_label %>]. Briefly, this means:
+
+* *Major* (X.y.z): Incremented for any backwards incompatible public API changes.
+* *Minor* (x.Y.z): Incremented for new, backwards compatible, public API enhancements/fixes.
+* *Patch* (x.y.Z): Incremented for small, backwards compatible, bug fixes.
+
+=== History
+
+<% tags.each do |tag| %>
+* link:<%= tag.version %>[<%= tag.version %>] (<%= tag.committed_date %>)
+<% end %>

data/lib/milestoner/templates/milestones/index.html.erb

@@ -0,0 +1,31 @@
+<section class="milestones">
+  <h1 class="title">
+    <a href="<%= project_uri_home %>" class="label"><%= project_label %></a> Versions
+  </h1>
+
+  <p>All versions adhere to the <a href="https://alchemists.io/articles/strict_semantic_versioning">Strict Semantic Versioning</a> as enforced with <a href="https://alchemists.io/projects/versionaire">Versionaire</a> and automated by <a href="<%= generator_uri %>"><%= generator_label %></a>. Briefly, this means:</p>
+
+  <ul>
+    <li><strong>Major</strong> (X.y.z): Incremented for any backwards incompatible public API changes.</li>
+    <li><strong>Minor</strong> (x.Y.z): Incremented for new, backwards compatible, public API enhancements/fixes.</li>
+    <li><strong>Patch</strong> (x.y.Z): Incremented for small, backwards compatible, bug fixes.</li>
+  </ul>
+
+  <ul class="list">
+    <% tags.each do |tag| %>
+      <li class="item">
+        <a href="<%= tag.version %>"
+           class="version"
+           hx-get="<%= tag.version %>"
+           hx-select=".milestone"
+           hx-target=".milestones"
+           hx-swap="outerHTML"
+           hx-push-url="true">
+          <%= tag.version %>
+        </a>
+
+        <span class="date"><%= tag.committed_date %></span>
+      </li>
+    <% end %>
+  </ul>
+</section>

data/lib/milestoner/templates/milestones/index.md.erb

@@ -0,0 +1,13 @@
+# [<%= project_label %>](<%= project_uri_home %>) Versions
+
+All versions adhere to the [Strict Semantic Versioning](https://alchemists.io/articles/strict_semantic_versioning) as enforced with [Versionaire](https://alchemists.io/projects/versionaire) and automated by [<%= generator_label %>](<%= generator_uri %>). Briefly, this means:
+
+- **Major** (X.y.z): Incremented for any backwards incompatible public API changes.
+- **Minor** (x.Y.z): Incremented for new, backwards compatible, public API enhancements/fixes.
+- **Patch** (x.y.Z): Incremented for small, backwards compatible, bug fixes.
+
+## History
+
+<% tags.each do |tag| %>
+- [<%= tag.version %>](<%= tag.version %>) (<%= tag.committed_date %>)
+<% end %>

data/lib/milestoner/templates/milestones/show.adoc.erb

@@ -1 +1,17 @@
-<%= tag.render :tag %>
+<% if tag.empty? %>
+== link:<%= project_uri_home %>[<%= project_label %>] (<%= tag.committed_date %>)
+
+*<%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.total_deletions %>. <%= tag.total_insertions %>.*
+*<%= tag.total_duration %>.*
+<% else %>
+== link:<%= project_uri_home %>[<%= project_label %>] <%= tag.version %> (<%= tag.committed_date %>)
+
+<%= render :user, user: tag.author %> | <%= tag.security %>
+
+<% tag.commits.each do |commit| %><%= commit.render :commit %><% end %>
+
+*<%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.total_deletions %>. <%= tag.total_insertions %>.* +
+*<%= tag.total_duration %>.*
+
+link:<%= past.version %>[Previous (<%= past.version %>)] | link:<%= future.version %>[Next (<%= future.version %>)]
+<% end %>

data/lib/milestoner/templates/milestones/show.git.erb

@@ -0,0 +1,8 @@
+Generated by <%= generator_label %> <%= generator_version %>.
+
+Commits: <%= tag.commit_count %>
+Deletions: <%= tag.deletion_count %>
+Duration: <%= tag.duration %>
+Files: <%= tag.file_count %>
+Insertions: <%= tag.insertion_count %>
+URI: <%= tag.uri %>

data/lib/milestoner/templates/milestones/show.html.erb

@@ -1 +1,119 @@
-<%= tag.render :tag %>
+<article class="milestone">
+  <header class="header">
+    <% if tag.index? %>
+      <a href="../"
+         class="root"
+         hx-get="../"
+         hx-select=".milestones"
+         hx-trigger="click, keyup[key=='v'] from:body"
+         hx-target=".milestone"
+         hx-swap="outerHTML"
+         hx-push-url="true">
+        Versions
+      </a>
+    <% end %>
+
+    <h1 class="title">
+      <a href="<%= project_uri_home %>" class="label">
+        <%= project_label %>
+      </a>
+
+      <% if tag.commits.any? %>
+        <span class="version"><%= tag.version %></span>
+      <% end %>
+    </h1>
+
+    <time datetime="<%= tag.committed_datetime %>" class="date"><%= tag.committed_date %></time>
+  </header>
+
+  <% if tag.empty? %>
+    <p class="dormant"></p>
+  <% else %>
+    <section class="body" x-data="{open: false}">
+      <div class="overview">
+        <div class="owner">
+          <%= render :user, user: tag.author %>
+        </div>
+
+        <%= scope(:tag_signature, tag:).call %>
+
+        <div class="actions">
+          <button class="button toggle" x-on:click="open = true">Expand</button>
+          <button class="button toggle" x-on:click="open = false">Collapse</button>
+        </div>
+      </div>
+
+      <div class="columns">
+        <span class="label">Commit</span>
+        <span class="label">Author</span>
+        <span class="label">Files</span>
+        <span class="label">Lines</span>
+        <span class="label">Issue</span>
+        <span class="label">Review</span>
+      </div>
+
+      <% tag.commits.each do |commit| %>
+        <%= commit.render :commit %>
+      <% end %>
+    </section>
+  <% end %>
+
+  <footer class="footer">
+    <p class="totals">
+      <span class="commits"><%= tag.total_commits %>.</span>
+      <span class="files"><%= tag.total_files %>.</span>
+      <span class="deletions"><%= tag.total_deletions %>.</span>
+      <span class="insertions"><%= tag.total_insertions %>.</span>
+    </p>
+
+    <p class="totals">
+      <span class="duration"><%= tag.total_duration %>.</span>
+    </p>
+
+    <ul class="actions">
+      <li>
+        <a href="/<%= past.version %>"
+           class="action"
+           data-direction="previous"
+           hx-get="/<%= past.version %>"
+           hx-select=".milestone"
+           hx-trigger="click, keyup[key=='ArrowLeft'] from:body"
+           hx-target=".milestone"
+           hx-swap="outerHTML"
+           hx-push-url="true">
+          Previous
+          (<%= past.version %>)
+        </a>
+      </li>
+
+      <li>
+        <button class="help" popovertarget="po-shortcuts">ℹ️</button>
+
+        <div id="po-shortcuts" class="popover" popover="auto">
+          <h2 class="label">Keyboard Shortcuts</h2>
+
+          <ul>
+            <li class="shortcut"><kbd class="key">v</kbd>: View versions.</li>
+            <li class="shortcut"><kbd class="key">←</kbd>: View previous version.</li>
+            <li class="shortcut"><kbd class="key">→</kbd>: View next version.</li>
+          </ul>
+        </div>
+      </li>
+
+      <li>
+        <a href="/<%= future.version %>"
+           class="action"
+           data-direction="next"
+           hx-get="/<%= future.version %>"
+           hx-select=".milestone"
+           hx-trigger="click, keyup[key=='ArrowRight'] from:body"
+           hx-target=".milestone"
+           hx-swap="outerHTML"
+           hx-push-url="true">
+          Next
+          (<%= future.version %>)
+        </a>
+      </li>
+    </ul>
+  </footer>
+</article>

data/lib/milestoner/templates/milestones/show.md.erb

@@ -1 +1,16 @@
-<%= tag.render :tag %>
+<% if tag.empty? %>
+# [<%= project_label %>](<%= project_uri_home %>) (<%= tag.committed_date %>)
+
+**<%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.total_deletions %>. <%= tag.total_insertions %>.**
+**<%= tag.total_duration %>.**
+<% else %>
+# [<%= project_label %>](<%= project_uri_home %>) <%= tag.version %> (<%= tag.committed_date %>)
+<%= render :user, user: tag.author %> | <%= tag.security %>
+
+<% tag.commits.each do |commit| %><%= commit.render :commit %><% end %>
+
+**<%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.total_deletions %>. <%= tag.total_insertions %>.**
+**<%= tag.total_duration %>.**
+
+[Previous (<%= past.version %>)](<%= past.version %>) | [Next (<%= future.version %>)](<%= future.version %>)
+<% end %>

data/lib/milestoner/templates/milestones/show.stream.erb

@@ -1 +1,17 @@
-<%= tag.render :tag %>
+<% if tag.empty? %>
+<%= project_label %> (<%= tag.committed_date %>)
+
+<%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.colored_total_deletions %>. <%= tag.colored_total_insertions %>.
+<%= tag.total_duration %>.
+<% else %>
+<%= project_label %> <%= tag.version %> (<%= tag.committed_date %>)
+<% if tag.version != project_version %>
+
+<%= tag.author.name %> | <%= tag.security %>
+<% end %>
+
+<% tag.commits.each do |commit| %><%= commit.render :commit %><% end %>
+
+<%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.colored_total_deletions %>. <%= tag.colored_total_insertions %>.
+<%= tag.total_duration %>.
+<% end %>

data/lib/milestoner/templates/milestones/show.xml.erb

@@ -1 +1,22 @@
-<%= tag.render :tag %>
+<section>
+  <% unless tag.empty? %>
+    <p style="display: inline-flex; align-items: center; gap: 0.5rem; flex-wrap: wrap;">
+      <%= render :user, user: tag.author %> | <%= tag.security %>
+    </p>
+
+    <% tag.commits.each do |commit| %>
+      <%= commit.render :commit %>
+    <% end %>
+  <% end %>
+
+  <p>
+    <strong>
+      <span><%= tag.total_commits %>.</span>
+      <span><%= tag.total_files %>.</span>
+      <span><%= tag.total_deletions %>.</span>
+      <span><%= tag.total_insertions %>.</span>
+    </strong>
+  </p>
+
+  <p><strong><%= tag.total_duration %>.</strong></p>
+</section>