milestoner 16.2.1 → 17.1.0

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

@@ -0,0 +1,2 @@
+<%= yield %>
+*Generated by [<%= generator_label %>](<%= generator_uri %>).*

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

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

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

@@ -0,0 +1,5 @@
+<% if name %>
+  <img src="<%= url %>" alt="<%= name %>" class="avatar" width="24" height="24" loading="lazy">
+<% else %>
+  <%= render :icon, icon: "missing_avatar", kind: "Unknown" %>
+<% end %>

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

@@ -0,0 +1 @@
+* <%= commit.emoji %> <%= commit.subject %> - _<%= commit.author.name %>_

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

@@ -0,0 +1,104 @@
+<details id="<%= commit.sha %>" class="row" x-bind:open="open">
+  <summary class="summary <%= commit.kind %>">
+    <div class="title">
+      <%= render :icon, icon: commit.icon, kind: commit.kind %>
+      <span class="subject"><%= commit.subject %></span>
+    </div>
+
+    <div class="author">
+      <%= render :avatar, name: commit.author.name, url: commit.avatar_url(commit.author) %>
+    </div>
+
+    <a href="<%= commit.uri %>" class="files"><%= commit.files_changed %></a>
+
+    <span class="lines">
+      <span class="deletions"><%= commit.total_deletions %></span>
+      <span class="delimiter">/</span>
+      <span class="insertions"><%= commit.total_insertions %></span>
+    </span>
+
+    <% if commit.issue.id %>
+      <a href="<%= commit.issue.uri %>" class="issue"><%= commit.issue.id %></a>
+    <% else %>
+      <span class="issue">-</span>
+    <% end %>
+
+    <% if commit.review.id %>
+      <a href="<%= commit.review.uri %>" class="review"><%= commit.review.id %></a>
+    <% else %>
+      <span class="review">-</span>
+    <% end %>
+  </summary>
+
+  <div class="details">
+    <div class="tag <%= commit.tag %>"><%= commit.tag %></div>
+
+    <div class="message">
+      <h1 class="bar">Message</h1>
+
+      <div class="content">
+        <%= commit.safe_body %>
+      </div>
+    </div>
+
+    <% unless commit.notes.empty? %>
+      <div class="notes">
+        <h2 class="bar">Notes</h2>
+
+        <div class="content">
+          <%= commit.notes.html_safe %>
+        </div>
+      </div>
+    <% end %>
+
+    <div class="info">
+      <h2 class="bar">Info</h2>
+
+      <div class="panel">
+        <h3 class="label">Author</h3>
+
+        <p class="item">
+          <%= render :avatar, name: commit.author.name, url: commit.avatar_url(commit.author) %>
+          <%= render :profile, name: commit.author.name, url: commit.profile_url(commit.author) %>
+        </p>
+
+        <% if commit.collaborators.any? %>
+          <h3 class="label">Collaborators</h3>
+
+          <% commit.collaborators.each do |collaborator| %>
+            <p class="item">
+              <%= render :avatar, name: collaborator.name, url: commit.avatar_url(collaborator) %>
+              <%= render :profile, name: collaborator.name, url: commit.profile_url(collaborator) %>
+            </p>
+          <% end %>
+        <% end %>
+
+        <% if commit.signers.any? %>
+          <h3 class="label">Signers</h3>
+
+          <% commit.signers.each do |signer| %>
+            <p class="item">
+              <%= render :avatar, name: signer.name, url: commit.avatar_url(signer) %>
+              <%= render :profile, name: signer.name, url: commit.profile_url(signer) %>
+            </p>
+          <% end %>
+        <% end %>
+
+        <h3 class="label">Signature</h3>
+
+        <p class="item pill <%= commit.security %>">
+          <span class="signature"><%= commit.signature %></span>
+        </p>
+
+        <h3 class="label">Created</h3>
+
+        <p class="item 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>
+        </p>
+      </div>
+    </div>
+  </div>
+</details>

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

@@ -0,0 +1 @@
+- <%= commit.emoji %> <%= commit.subject %> - *<%= commit.author.name %>*

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

@@ -0,0 +1 @@
+<%= commit.emoji %> <%= commit.subject %> - <%= commit.author.name %>

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

@@ -0,0 +1,6 @@
+<img src="https://alchemists.io/images/projects/milestoner/icons/commits/<%= icon %>.png"
+     alt="<%= kind %>"
+     class="icon"
+     width="24"
+     height="24"
+     loading="lazy">

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

@@ -0,0 +1,5 @@
+<% if name %>
+  <a href="<%= url %>"><%= name %></a>
+<% else %>
+  <span>Unknown</span>
+<% end %>

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

@@ -0,0 +1,9 @@
+= <%= project_label %> <%= project_version %> (<%= date %>)
+
+<% if commits.empty? %>
+*<%= total_commits %>. <%= total_files %>. <%= total_deletions %>. <%= total_insertions %>.*
+<% else %>
+<% commits.each do |commit| %><%= commit.render :commit %><% end %>
+
+*<%= total_commits %>. <%= total_files %>. <%= total_deletions %>. <%= total_insertions %>.*
+<% end %>

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

@@ -0,0 +1,46 @@
+<article class="milestone">
+  <header class="header">
+    <h1 class="title">
+      <a href="<%= uri %>" class="label"><%= project_label %></a>
+      <span class="version"><%= project_version %></span>
+    </h1>
+
+    <time datetime="<%= datetime %>" class="date"><%= date %></time>
+  </header>
+
+  <% if commits.empty? %>
+    <p class="dormant"></p>
+  <% else %>
+    <section class="body" x-data="{open: false}">
+      <div class="actions">
+        <button class="toggle"
+                x-on:click="open = !open"
+                x-text="open ? 'Collapse' : 'Expand'">
+          Expand
+        </button>
+      </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>
+
+      <% commits.each do |commit| %>
+        <%= commit.render :commit %>
+      <% end %>
+    </section>
+  <% end %>
+
+  <footer class="footer">
+    <p class="totals">
+      <span class="commits"><%= total_commits %>.</span>
+      <span class="files"><%= total_files %>.</span>
+      <span class="deletions"><%= total_deletions %>.</span>
+      <span class="insertions"><%= total_insertions %>.</span>
+    </p>
+  </footer>
+</article>

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

@@ -0,0 +1,9 @@
+# <%= project_label %> <%= project_version %> (<%= date %>)
+
+<% if commits.empty? %>
+**<%= total_commits %>. <%= total_files %>. <%= total_deletions %>. <%= total_insertions %>.**
+<% else %>
+<% commits.each do |commit| %><%= commit.render :commit %><% end %>
+
+**<%= total_commits %>. <%= total_files %>. <%= total_deletions %>. <%= total_insertions %>.**
+<% end %>

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

@@ -0,0 +1,9 @@
+<%= project_label %> <%= project_version %> (<%= date %>)
+
+<% if commits.empty? %>
+<%= total_commits %>. <%= total_files %>. <%= total_deletions %>. <%= total_insertions %>.
+<% else %>
+<% commits.each do |commit| %><%= commit.render :commit %><% end %>
+
+<%= total_commits %>. <%= total_files %>. <%= total_deletions %>. <%= total_insertions %>.
+<% end %>

data/lib/milestoner/templates/public/page.css.erb

@@ -0,0 +1,373 @@
+:root {
+  --font-family: Verdana;
+}
+
+.milestone {
+  --border-width: 0.15rem;
+  --color-black: hsl(0, 0%, 0%);
+  --color-butter: hsl(52, 100%, 83%);
+  --color-carbon: hsl(219, 6%, 58%);
+  --color-cheese: hsl(51, 100%, 93%);
+  --color-cloud: hsl(219, 100%, 93%);
+  --color-ghost: hsl(171.4, 17.1%, 92%);
+  --color-green: hsl(110, 88%, 37%);
+  --color-grey: hsl(240, 7%, 97%);
+  --color-sea: hsl(210, 24%, 15%);
+  --color-ice: hsl(216, 100%, 98%);
+  --color-major: hsl(231, 97%, 29%);
+  --color-minor: hsl(203, 74%, 45%);
+  --color-orange: hsl(24.8, 100%, 50.2%);
+  --color-patch: hsl(199, 83%, 62%);
+  --color-powder: hsl(0, 0%, 98%);
+  --color-red: hsl(0, 100%, 50%);
+  --color-slate: hsl(211, 23%, 41%);
+  --color-smoke: hsl(229, 31%, 93%);
+  --color-white: hsl(0, 0%, 100%);
+
+  display: flex;
+  flex-direction: column;
+  font-family: var(--font-family);
+  margin: 0 12vw;
+
+  .header {
+    display: flex;
+    justify-content: space-between;
+    margin: 1rem 0 1rem 0;
+
+    .title {
+      margin: 0;
+    }
+
+    .date {
+      font-size: 1.4rem;
+      font-weight: 600;
+      margin: 0;
+    }
+  }
+
+  .actions {
+    display: flex;
+    justify-content: flex-end;
+    margin-bottom: 0.5rem;
+  }
+
+  .toggle {
+    background-color: var(--color-white);
+    border: 0.1rem solid var(--color-sea);
+    border-radius: 0.5rem;
+    color: var(--color-sea);
+    cursor: pointer;
+    padding: 0.2rem;
+    font-size: 0.9rem;
+    width: 5rem;
+  }
+
+  .normal {
+    border-width: var(--border-width);
+    border-style: solid;
+    border-color: transparent;
+    border-bottom-color: var(--color-ghost);
+  }
+
+  .alert {
+    border: var(--border-width) solid var(--color-orange);
+  }
+
+  .error {
+    border: var(--border-width) solid var(--color-red);
+  }
+
+  .avatar {
+    border-radius: 50%;
+  }
+
+  .columns {
+    background-color: var(--color-black);
+    border-top-left-radius: 0.5rem;
+    border-top-right-radius: 0.5rem;
+    color: var(--color-white);
+    display: grid;
+    grid-template: 1fr / 4.7fr 1fr 1fr 1fr 1fr 1fr;
+    padding: 0.3rem 0;
+
+    .label {
+      font-weight: 600;
+      text-align: center;
+    }
+  }
+
+  .row {
+    .label {
+      font-weight: 600;
+    }
+  }
+
+  .row[open] > .summary::before {
+    content: "\25BC";
+    width: 0.5rem;
+  }
+
+  .summary {
+    align-items: center;
+    display: grid;
+    gap: 0 1rem;
+    grid-template: 1fr / auto 5fr 1fr 1fr 1fr 1fr 1fr;
+    padding: 0.15rem 0;
+    margin: 0.25rem 0 0 0;
+
+    &::-webkit-details-marker {
+      display:none;
+    }
+
+    &::before {
+      content: "\25B6";
+      cursor: pointer;
+      width: 0.5rem;
+    }
+
+    &:hover {
+      background-color: var(--color-powder);
+    }
+
+    .title {
+      align-items: center;
+      display: flex;
+      gap: 0 0.5rem;
+    }
+
+    .subject {
+      word-break: break-word;
+    }
+
+    .author,
+    .files,
+    .lines,
+    .issue,
+    .review {
+      text-align: center;
+    }
+
+    .avatar {
+      vertical-align: middle;
+    }
+
+    .lines {
+      .deletions {
+        color: var(--color-green);
+      }
+
+      .insertions {
+        color: var(--color-red);
+      }
+    }
+  }
+
+  .details {
+    display: grid;
+    gap: 1rem;
+    grid-template: auto auto auto / auto 1fr;
+    grid-template-areas:
+      "tag message"
+      "tag notes"
+      "tag info";
+
+    @media (width >= 1000px) {
+      grid-template: 1fr auto / auto 2fr 1fr;
+      grid-template-areas:
+        "tag message info"
+        "tag notes info";
+    }
+
+    .tag {
+      align-self: stretch;
+      grid-area: tag;
+      padding: 0.5rem 0.2rem 0.5rem 0.1rem;
+      text-align: center;
+      text-transform: capitalize;
+      writing-mode: vertical-lr;
+      padding: 0 0.2rem;
+    }
+
+    .major {
+      background-color: var(--color-major);
+      color: var(--color-white);
+    }
+
+    .minor {
+      background-color: var(--color-minor);
+      color: var(--color-white);
+    }
+
+    .patch {
+      background-color: var(--color-patch);
+      color: var(--color-black);
+    }
+
+    .rebase {
+      background-color: var(--color-orange);
+      color: var(--color-white);
+    }
+
+    .invalid {
+      background-color: var(--color-red);
+      color: var(--color-white);
+    }
+
+    .unknown {
+      background-color: var(--color-carbon);
+      color: var(--color-white);
+    }
+
+    .bar {
+      border-radius: 0.5rem 0.5rem 0 0;
+      color: var(--color-black);
+      font-size: 1rem;
+      font-weight: 600;
+      padding: 0 0 0 0.5rem;
+      margin: 0;
+    }
+
+    .panel {
+      display: flex;
+      flex-direction: column;
+      padding: 0 0.5rem 0.5rem 0.5rem;
+    }
+
+    .message {
+      background-color: var(--color-grey);
+      border-radius: 0.5rem;
+      grid-area: message;
+      margin-top: 1rem;
+
+      .bar {
+        background-color: var(--color-smoke);
+      }
+
+      .content {
+        margin: 0 0.5rem;
+        word-break: break-word;
+      }
+    }
+
+    .notes {
+      background-color: var(--color-cheese);
+      border-radius: 0.5rem;
+      grid-area: notes;
+      margin-bottom: 1rem;
+
+      .bar {
+        background-color: var(--color-butter);
+      }
+
+      .content {
+        margin: 0 0.5rem;
+      }
+    }
+
+    .info {
+      grid-area: info;
+      background-color: var(--color-ice);
+      border-radius: 0.5rem;
+      margin: 1rem 0;
+
+      .bar {
+        background-color: var(--color-cloud);
+      }
+
+      .label {
+        font-size: 0.9rem;
+      }
+
+      .item {
+        align-self: start;
+        display: flex;
+        gap: 0.5rem;
+        margin: 0;
+      }
+
+      .pill {
+        border-radius: 0.5rem;
+        padding: 0.1rem 0.4rem;
+      }
+
+      .secure {
+        background-color: var(--color-green);
+        color: var(--color-white);
+
+        .signature::before {
+          content: "\1F512";
+          margin-right: 0.5rem;
+        }
+      }
+
+      .insecure {
+        background-color: var(--color-red);
+        color: var(--color-white);
+
+        .signature::before {
+          content: "\1F513";
+          margin-right: 0.5rem;
+        }
+      }
+
+      .at {
+        flex-wrap: wrap;
+
+        .weekday {
+          &:before {
+            content: "(";
+          }
+
+          &:after {
+            content: ")";
+          }
+        }
+      }
+    }
+  }
+
+  .dormant {
+    align-items: center;
+    display: flex;
+    justify-content: center;
+    flex-direction: column;
+
+    &::before {
+      content: "\1F303";
+      font-size: 10rem;
+    }
+  }
+
+  .totals {
+    display: flex;
+    gap: 0 0.5rem;
+    font-weight: 600;
+    justify-content: center;
+
+    .files {
+      color: var(--color-slate);
+    }
+
+    .deletions {
+      color: var(--color-green);
+    }
+
+    .insertions {
+      color: var(--color-red);
+    }
+  }
+}
+
+.footer {
+  .generator {
+    display: flex;
+    font-family: var(--font-family);
+    font-style: italic;
+    justify-content: center;
+    margin-top: 2rem;
+  }
+
+  .link {
+    padding-left: 0.3rem;
+  }
+}

data/lib/milestoner/views/context.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "hanami/view"
+
+module Milestoner
+  module Views
+    # Provides a common context for all views.
+    class Context < Hanami::View::Context
+      extend Forwardable
+
+      include Import[:input]
+
+      delegate %i[
+        generator_label
+        generator_uri
+        project_author
+        project_description
+        project_generator
+        project_label
+        project_version
+      ] => :input
+
+      def project_title = [project_label, project_version].compact.join " "
+    end
+  end
+end

data/lib/milestoner/views/milestones/show.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "hanami/view"
+require "pathname"
+require "refinements/string"
+
+module Milestoner
+  module Views
+    module Milestones
+      # Produces release notes in HTML format.
+      class Show < Hanami::View
+        using Refinements::String
+
+        config.default_context = Context.new
+        config.part_namespace = Parts
+        config.paths = Container[:configuration].build_template_paths
+        config.template = "milestones/show"
+
+        expose :commits
+        expose :uri, default: Container[:configuration].project_uri
+        expose :at, default: Time.now.utc
+        expose(:date) { |at| at.strftime "%Y-%m-%d" }
+        expose(:datetime) { |at| at.strftime "%Y-%m-%dT%H:%M:%S%z" }
+
+        expose :total_commits do |commits|
+          total = commits.size
+          "#{total} commit".pluralize "s", total
+        end
+
+        expose :total_files do |commits|
+          total = commits.sum(&:files_changed)
+          "#{total} file".pluralize "s", total
+        end
+
+        expose :total_deletions do |commits|
+          total = commits.sum(&:deletions)
+          "#{total} deletion".pluralize "s", total
+        end
+
+        expose :total_insertions do |commits|
+          total = commits.sum(&:insertions)
+          "#{total} insertion".pluralize "s", total
+        end
+      end
+    end
+  end
+end