milestoner 17.11.0 → 18.0.0

data/lib/milestoner/models/commit.rb

@@ -9,6 +9,8 @@ module Milestoner
       body
       deletions
       files_changed
+      fingerprint
+      fingerprint_key
       insertions
       notes
       sha

data/lib/milestoner/models/tag.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Models
+    # Represents a Git tag comprised of multiple commits.
+    Tag = Struct.new :author, :commits, :committed_at, :sha, :signature, :version
+  end
+end

data/lib/milestoner/renderers/universal.rb

@@ -4,14 +4,14 @@ module Milestoner
   module Renderers
     # The primary renderer for multiple input formats as HTML.
     class Universal
-      include Import[:input]
+      include Import[:settings]
 
       DELEGATES = {asciidoc: Asciidoc.new, markdown: Markdown.new}.freeze
 
       def initialize(delegates: DELEGATES, **)
         super(**)
         @delegates = delegates
-        @default_format = input.commit_format.to_sym
+        @default_format = settings.commit_format.to_sym
       end
 
       def call content, for: default_format

data/lib/milestoner/syndication/builder.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "core"
+require "dry/monads"
+require "rss"
+
+module Milestoner
+  module Syndication
+    # Builds feed in Atom format.
+    # :reek:DataClump
+    class Builder
+      include Import[:settings]
+      include Dry::Monads[:result]
+
+      using Refine
+
+      def initialize(client: RSS::Maker, view: Views::Milestones::Show.new, **)
+        super(**)
+        @client = client
+        @view = view
+      end
+
+      def call tags
+        return Failure "No content." if tags.empty?
+
+        Success build_feed(tags).to_s
+      rescue NoMethodError, RSS::Error => error
+        Failure "#{self.class}: #{error.message.capitalize}."
+      end
+
+      private
+
+      attr_reader :client, :view
+
+      def build_feed tags
+        client.make "atom" do |node|
+          build_channel node.channel, tags
+          build_tags node, tags
+        end
+      end
+
+      def build_channel node, tags
+        at = tags.first.committed_at
+
+        node.merge id: settings.project_uri_home,
+                   title: settings.syndication_label,
+                   subtitle: settings.project_description,
+                   icon: settings.project_uri_icon,
+                   logo: settings.project_uri_logo,
+                   rights: at.strftime("%Y"),
+                   updated: at
+
+        build_channel_elements node, tags
+      end
+
+      def build_channel_elements node, tags
+        build_links node
+        build_generator node
+
+        build_authors node,
+                      tags.flat_map { |tag| tag.commits.map(&:author) }
+                          .uniq
+
+        node.categories.build label: settings.project_label, term: settings.project_name
+      end
+
+      def build_links node
+        node.links.build_for settings.syndication_links,
+                             label: :title,
+                             uri: :href,
+                             relation: :rel,
+                             mime: :type
+      end
+
+      def build_generator node
+        node.generator do |generator|
+          generator.merge content: settings.generator_label,
+                          version: settings.generator_version,
+                          uri: settings.generator_uri
+        end
+      end
+
+      def build_tags node, tags = Core::EMPTY_ARRAY
+        tags.each { |tag| build_item node.items, tag }
+      end
+
+      def build_item node, tag
+        node.new_item do |item|
+          build_item_metadata item, tag
+          build_item_content item.content, tag
+          build_authors item, tag.commits.map(&:author).uniq.select(&:name)
+          item.categories.build_for settings.syndication_categories, label: :label, name: :term
+        end
+      end
+
+      def build_item_metadata node, tag
+        committed_at = tag.committed_at
+        version = tag.version
+
+        node.merge id: format(settings.syndication_id, id: version),
+                   title: format(settings.syndication_entry_label, id: version),
+                   link: format(settings.syndication_entry_uri, id: version),
+                   rights: committed_at.strftime("%Y"),
+                   published: committed_at,
+                   updated: committed_at
+      end
+
+      def build_item_content node, tag
+        content = view.call tag:, layout: settings.build_layout, format: :xml
+        node.merge content:, type: :html
+      end
+
+      def build_authors node, users = Core::EMPTY_ARRAY
+        users.each do |user|
+          node.authors.build name: user.name, uri: format(settings.profile_uri, id: user.handle)
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/syndication/refine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rss"
+
+module Milestoner
+  module Syndication
+    # Smooths out the rough edges of the RSS gem object which are harder to work with.
+    module Refine
+      refine(RSS::Maker::Atom::Feed::Channel) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Channel::Authors) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Channel::Authors::Author) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Channel::Categories) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Channel::Categories::Category) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Channel::Generator) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Channel::Links::Link) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Items::Item) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Channel::Links) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Items::Item::Authors) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Items::Item::Authors::Author) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Items::Item::Categories) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Items::Item::Categories::Category) { import_methods Shared }
+      refine(RSS::Maker::Atom::Feed::Items::Item::Content) { import_methods Shared }
+    end
+  end
+end

data/lib/milestoner/syndication/shared.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Syndication
+    # Provides shared functionality for refinements.
+    module Shared
+      def merge(**attributes) = attributes.each { |key, value| public_send :"#{key}=", value }
+
+      def build_for(collection, **)
+        collection.each { |attributes| build(**attributes.transform_keys(**)) }
+      end
+
+      def build(**attributes)
+        node = public_send :"new_#{kind}"
+        attributes.each { |key, value| node.public_send :"#{key}=", value }
+      end
+
+      private
+
+      def kind
+        self.class.name.downcase.split("::").last.sub("categories", "category").delete_suffix("s")
+      end
+    end
+  end
+end

data/lib/milestoner/tags/creator.rb

@@ -1,50 +1,34 @@
 # frozen_string_literal: true
 
 require "core"
+require "dry/monads"
 require "refinements/string_io"
-require "versionaire"
 
 module Milestoner
   module Tags
     # Handles the creation of project repository tags.
     class Creator
-      include Import[:input, :git, :logger]
+      include Import[:git, :logger]
+      include Dry::Monads[:result]
 
       using Refinements::StringIO
-      using Versionaire::Cast
 
-      def initialize(
-        collector: Commits::Collector.new,
-        builder: Builders::Stream.new(kernel: StringIO.new),
-        **
-      )
+      def initialize(collector: Commits::Collector.new, builder: Builders::Stream.new, **)
         @collector = collector
         @builder = builder
         super(**)
       end
 
-      def call override = nil
-        version = compute_version override
+      def call version
+        return Success version if local? version
 
-        return false if local? version
-
-        collection = collector.call.value_or Core::EMPTY_ARRAY
-
-        fail Error, "Unable to tag without commits." if collection.empty?
-
-        create version
+        collect.bind { create version }
       end
 
       private
 
       attr_reader :collector, :builder
 
-      def compute_version value
-        Version value || input.project_version
-      rescue Versionaire::Error => error
-        raise Error, error
-      end
-
       def local? version
         if git.tag_local? version
           logger.warn { "Local tag exists: #{version}. Skipped." }
@@ -54,17 +38,11 @@ module Milestoner
         end
       end
 
-      def create version
-        build(version).fmap { |body| git.tag_create version, body }
-                      .or { |error| fail Error, error }
-                      .bind { true }
-      end
+      def collect = collector.call.alt_map { |message| message.sub("fatal: y", "Y").sub("\n", ".") }
 
-      def build version
-        builder.call.fmap do |body|
-          "Version #{version}\n\n#{body.reread}\n\n"
-        end
-      end
+      def create(version) = build(version).bind { |body| git.tag_create version, body }
+
+      def build(version) = builder.call.fmap { |body| "Version #{version}\n\n#{body.reread}\n\n" }
     end
   end
 end

data/lib/milestoner/tags/publisher.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require "dry/monads"
+
 module Milestoner
   module Tags
     # Handles the tagging and pushing of a tag to a remote repository.
     class Publisher
-      include Import[:input, :logger]
+      include Import[:logger]
+      include Dry::Monads[:result]
 
       def initialize(creator: Tags::Creator.new, pusher: Tags::Pusher.new, **)
         super(**)
@@ -12,15 +15,20 @@ module Milestoner
         @pusher = pusher
       end
 
-      def call override = nil
-        creator.call override
-        pusher.call override
-        logger.info { "Published: #{input.project_version}!" }
+      def call version
+        creator.call(version)
+               .bind { pusher.call version }
+               .bind { log_info version }
       end
 
       private
 
       attr_reader :creator, :pusher
+
+      def log_info version
+        logger.info { "Published: #{version}" }
+        Success version
+      end
     end
   end
 end

data/lib/milestoner/tags/pusher.rb

@@ -1,29 +1,38 @@
 # frozen_string_literal: true
 
-require "versionaire"
+require "dry/monads"
 
 module Milestoner
   module Tags
     # Handles publishing of tags to a remote repository.
     class Pusher
-      include Import[:input, :git, :logger]
+      include Import[:git, :logger]
+      include Dry::Monads[:result]
 
-      using Versionaire::Cast
+      def call version
+        check_remote_repo(version).bind { check_remote_tag version }
+                                  .bind { push version }
+      end
+
+      private
 
-      def call override = nil
-        version = compute_version override
+      def check_remote_repo version
+        git.origin? ? Success(version) : Failure("Remote repository not configured.")
+      end
 
-        fail Error, "Remote repository not configured." unless git.origin?
-        fail Error, "Remote tag exists: #{version}." if git.tag_remote? version
-        fail Error, "Tags could not be pushed to remote repository." if git.tags_push.failure?
+      def check_remote_tag version
+        git.tag_remote?(version) ? Failure("Remote tag exists: #{version}.") : Success(version)
+      end
 
-        logger.debug "Local tag pushed: #{version}."
+      def push version
+        git.tags_push
+           .either proc { debug version },
+                   proc { Failure "Tags could not be pushed to remote repository." }
       end
 
-      def compute_version value
-        Version value || input.project_version
-      rescue Versionaire::Error => error
-        raise Error, error
+      def debug version
+        logger.debug { "Local tag pushed: #{version}." }
+        Success version
       end
     end
   end

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

@@ -19,7 +19,13 @@
           href="https://alchemists.io/images/projects/milestoner/logo.png"
           type="image/png"
           sizes="200x200">
-    <link title="<%= project_label %>: Stylesheet" rel="stylesheet" href="page.css" type="text/css">
+
+<% if build_stylesheet %>
+    <link title="<%= project_label %>: Stylesheet"
+          rel="stylesheet"
+          href="<%= build_stylesheet %>.css"
+          type="text/css">
+<% end %>
 
     <script src="https://unpkg.com/alpinejs@3.14" defer></script>
   </head>

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

@@ -0,0 +1,11 @@
+<article>
+  <%= yield %>
+
+  <hr/>
+
+  <footer>
+    <em>
+      Generated by <a href="<%= generator_uri %>"><%= generator_label %> <%= generator_version %></a>.
+    </em>
+  </footer>
+</article>

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

@@ -0,0 +1 @@
+<% if name %>image:<%= url %>[<%= name %>,24,24]<% else %><%= render :icon, name: "missing", alt: "Unknown" %><% end %>

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

@@ -1,5 +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" %>
+  <%= render :icon, name: "missing", alt: "Unknown" %>
 <% end %>

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

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

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

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

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

@@ -1 +1 @@
-* <%= commit.emoji %> <%= commit.subject %> - _<%= commit.author.name %>_
+* <%= commit.emoji %> <%= commit.subject %> - <%= render :profile, name: commit.author.name, url: commit.profile_url(commit.author) %>

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

@@ -1,13 +1,13 @@
 <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 %>
+      <%= render :icon, name: commit.icon, alt: commit.kind %>
       <span class="subject"><%= commit.subject %></span>
     </div>
 
-    <div class="author">
+    <a href="<%= commit.profile_url commit.author %>" class="author">
       <%= render :avatar, name: commit.author.name, url: commit.avatar_url(commit.author) %>
-    </div>
+    </a>
 
     <a href="<%= commit.uri %>" class="files"><%= commit.files_changed %></a>
 
@@ -48,7 +48,7 @@
       <div class="panel">
         <h3 class="label">Author</h3>
 
-        <p class="item">
+        <p class="line">
           <%= 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>
@@ -57,7 +57,7 @@
           <h3 class="label">Collaborators</h3>
 
           <% commit.collaborators.each do |collaborator| %>
-            <p class="item">
+            <p class="line">
               <%= render :avatar, name: collaborator.name, url: commit.avatar_url(collaborator) %>
               <%= render :profile, name: collaborator.name, url: commit.profile_url(collaborator) %>
             </p>
@@ -68,7 +68,7 @@
           <h3 class="label">Signers</h3>
 
           <% commit.signers.each do |signer| %>
-            <p class="item">
+            <p class="line">
               <%= render :avatar, name: signer.name, url: commit.avatar_url(signer) %>
               <%= render :profile, name: signer.name, url: commit.profile_url(signer) %>
             </p>
@@ -77,13 +77,23 @@
 
         <h3 class="label">Signature</h3>
 
-        <p class="item pill <%= commit.security %>">
+        <p class="line pill <%= commit.security %>">
           <span class="signature"><%= commit.signature %></span>
         </p>
 
+        <% unless String(commit.fingerprint).empty? %>
+          <h3 class="label">Fingerprint</h3>
+          <p class="line"><%= commit.fingerprint %></p>
+        <% end %>
+
+        <% unless String(commit.fingerprint_key).empty? %>
+          <h3 class="label">Fingerprint Primary Key</h3>
+          <p class="line"><%= commit.fingerprint_key %></p>
+        <% end %>
+
         <h3 class="label">Created</h3>
 
-        <p class="item at">
+        <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>

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

@@ -1 +1 @@
-- <%= commit.emoji %> <%= commit.subject %> - *<%= commit.author.name %>*
+- <%= commit.emoji %> <%= commit.subject %> - <%= render :profile, name: commit.author.name, url: commit.profile_url(commit.author) %>

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

@@ -0,0 +1,84 @@
+<details>
+  <summary style="display: inline-flex; align-items: center; gap: 0.5rem; flex-wrap: wrap;">
+    <%= render :icon, name: commit.icon, alt: commit.kind %>
+    <%= commit.subject %>
+  </summary>
+
+  <h4>Message</h4>
+
+  <% if commit.body.empty? %>
+    <p>No message.</p>
+  <% else %>
+    <%= commit.safe_body %>
+  <% end %>
+
+  <% unless commit.notes.empty? %>
+    <details>
+      <summary>Notes</summary>
+      <%= commit.notes.html_safe %>
+    </details>
+  <% end %>
+
+  <h4>Author</h4>
+
+  <span style="display: inline-flex; align-items: center; gap: 0.5rem;">
+    <%= render :avatar, name: commit.author.name, url: commit.avatar_url(commit.author) %>
+    <%= render :profile, name: commit.author.name, url: commit.profile_url(commit.author) %>
+  </span>
+
+  <% if commit.collaborators.any? %>
+    <h4>Collaborators</h4>
+
+    <ul>
+      <% commit.collaborators.each do |collaborator| %>
+        <li style="display: inline-flex; align-items: center; gap: 0.5rem;">
+          <%= render :avatar, name: collaborator.name, url: commit.avatar_url(collaborator) %>
+          <%= render :profile, name: collaborator.name, url: commit.profile_url(collaborator) %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+
+  <% if commit.signers.any? %>
+    <h4>Signers</h4>
+
+    <ul>
+      <% commit.signers.each do |signer| %>
+        <li style="display: inline-flex; align-items: center; gap: 0.5rem;">
+          <%= render :avatar, name: signer.name, url: commit.avatar_url(signer) %>
+          <%= render :profile, name: signer.name, url: commit.profile_url(signer) %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+
+  <h4>Details</h4>
+
+  <ul>
+    <li>Milestone: <%= commit.tag.capitalize %></li>
+    <li>Signature: <%= commit.signature %></li>
+    <li>Files: <a href="<%= commit.uri %>"><%= commit.files_changed %></a></li>
+
+    <li>
+      Lines:
+      <span><%= commit.total_deletions %></span>
+      <span>/</span>
+      <span><%= commit.total_insertions %></span>
+    </li>
+
+    <li>Issue: <a href="<%= commit.issue.uri %>"><%= commit.issue.id %></a></li>
+    <li>Review: <a href="<%= commit.review.uri %>"><%= commit.review.id %></a></li>
+  </ul>
+
+  <p>
+    <em style="display: inline-flex; align-items: center; gap: 0.5rem; margin-top: 1rem;">
+      <time datetime="<%= commit.at %>"><%= commit.date %></time>
+      <time datetime="<%= commit.at %>">(<%= commit.weekday %>)</time>
+      at
+      <time datetime="<%= commit.at %>"><%= commit.time %></time>
+      <time datetime="<%= commit.at %>"><%= commit.zone %></time>
+    </em>
+  </p>
+
+  <hr/>
+</details>

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

@@ -0,0 +1 @@
+image::https://alchemists.io/images/projects/milestoner/icons/<%= name %>[<%= alt %>,24,24]

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+<% if name %>link:<%= url %>[<%= name %>]<% else %>Unknown<% end %>

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

@@ -0,0 +1 @@
+<% if name %>[<%= name %>](<%= url %>)<% else %>Unknown<% end %>

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

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

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

@@ -0,0 +1,13 @@
+<% if tag.empty? %>
+= pass:[ ]<% if project_uri_logo %>image:<%= project_uri_logo %>[Logo,50,50]pass:[ ]<% end %>link:<%= project_uri_home %>[<%= project_label %>] (<%= tag.committed_date %>)
+
+*<%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.total_deletions %>. <%= tag.total_insertions %>.*
+<% else %>
+= pass:[ ]<% if project_uri_logo %>image:<%= project_uri_logo %>[Logo,50,50]pass:[ ]<% end %>link:<%= project_uri_home %>[<%= project_label %>] <%= project_version %> (<%= tag.committed_date %>)
+
+<%= render :avatar, name: tag.author.name, url: tag.avatar_url(tag.author) %> <%= render :profile, name: tag.author.name, url: tag.profile_url(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 %>.*
+<% end %>