milestoner 18.3.0 → 18.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 282be813b423955e3f7e0d99fed3405b594745d848a8a5db4208ea40f347142f
-  data.tar.gz: 27e309b692ba2cb4d9286a4db612b78011f1ab5bea2fc438fab0de4959e42356
+  metadata.gz: f42cba7a4f2b93a05d7fcf25fb973e2a241c8d1813a143baa779c2e1a310f1ed
+  data.tar.gz: 73635a67814d59b11bae524f45cb4878196aba7e302fa595ecedaaf89e350a6a
 SHA512:
-  metadata.gz: e6e0f24087ab4ee05e0ca5a613a94e12dc45d1b38a71eab1c45c38d9e7e0406ba7438c2c6152fc4579c388f22da07fbc765fc31d13a0583bdd14335373eb011b
-  data.tar.gz: f88afd8bff7deada4f46c0787768c2e3864ccc5a092461638793bf58a29d3b12d7a9763ab0f42f05abf19481be30b68d31708071d4ea652c1c8a8903bc32e192
+  metadata.gz: 9fcf5478cee6c0a63811cb133d27ae4bc292da15bacdbdb65f2edd29375057f87c23f15f4780ae68539439ed3c5c2011989477ea4c530b32effa5659f46735b1
+  data.tar.gz: a9e17509fa39de1247896518da061daa4586afbff8e905b5934728e5269e448ef973c1ffa1ac1136efd6d01a275912fe872c1fe84876c65c25dbaf7e32fed75a

data/README.adoc

@@ -52,7 +52,9 @@ The following are screenshots of using this gem to render release notes for the
 
 === ASCII Doc Format
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc.png[Release Notes,width=882,height=738,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc-collapsed.png[Release Notes,width=1149,height=830,role=focal_point]
+
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc-expanded.png[Release Notes,width=1149,height=1054,role=focal_point]
 
 * *Command*: `milestoner build --format ascii_doc`
 * *Renderer*: {ascii_doc_link}

data/lib/milestoner/commits/enricher.rb

@@ -40,8 +40,8 @@ module Milestoner
       attr_reader :categorizer, :model
 
       def build_attributes commit
-        infused_keys.each.with_object({}) do |command, attributes|
-          attributes[command] = __send__(command).call commit
+        infused_keys.each.with_object({}) do |key, attributes|
+          attributes[key] = __send__(key).call commit
         end
       end
     end

data/lib/milestoner/configuration/transformers/citations/description.rb

@@ -3,7 +3,6 @@
 require "cff"
 require "dry/monads"
 require "pathname"
-require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -13,8 +12,6 @@ module Milestoner
         class Description
           include Dry::Monads[:result]
 
-          using Refinements::Hash
-
           def initialize key = :project_description,
                          path: Pathname.pwd.join("CITATION.cff"),
                          citation: CFF::File
@@ -25,7 +22,8 @@ module Milestoner
 
           def call attributes
             attributes.fetch key do
-              attributes.merge!(key => citation.open(path).abstract).compress!
+              value = citation.open(path).abstract
+              attributes.merge! key => value unless value.empty?
             end
 
             Success attributes

data/lib/milestoner/configuration/transformers/citations/label.rb

@@ -3,7 +3,6 @@
 require "cff"
 require "dry/monads"
 require "pathname"
-require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -13,8 +12,6 @@ module Milestoner
         class Label
           include Dry::Monads[:result]
 
-          using Refinements::Hash
-
           def initialize key = :project_label,
                          path: Pathname.pwd.join("CITATION.cff"),
                          citation: CFF::File
@@ -24,7 +21,11 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { attributes.merge!(key => citation.open(path).title).compress! }
+            attributes.fetch key do
+              value = citation.open(path).title
+              attributes.merge! key => value unless value.empty?
+            end
+
             Success attributes
           end
 

data/lib/milestoner/configuration/transformers/citations/uri.rb

@@ -3,7 +3,6 @@
 require "cff"
 require "dry/monads"
 require "pathname"
-require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -13,8 +12,6 @@ module Milestoner
         class URI
           include Dry::Monads[:result]
 
-          using Refinements::Hash
-
           def initialize key = :project_uri,
                          path: Pathname.pwd.join("CITATION.cff"),
                          citation: CFF::File
@@ -39,7 +36,7 @@ module Milestoner
           def process attributes
             attributes.fetch(key) { citation.open(path).url }
                       .then { |value| value.match?(/%<.+>s/) ? format(value, attributes) : value }
-                      .then { |value| attributes.merge!(key => value).compress! }
+                      .then { |value| attributes.merge! key => value unless value.empty? }
           end
         end
       end

data/lib/milestoner/configuration/transformers/gems/description.rb

@@ -2,7 +2,6 @@
 
 require "dry/monads"
 require "pathname"
-require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -13,8 +12,6 @@ module Milestoner
           include Import[:spec_loader]
           include Dry::Monads[:result]
 
-          using Refinements::Hash
-
           def initialize(key = :project_description, path: "#{Pathname.pwd.basename}.gemspec", **)
             @key = key
             @path = path
@@ -23,7 +20,8 @@ module Milestoner
 
           def call attributes
             attributes.fetch key do
-              attributes.merge!(key => spec_loader.call(path).summary).compress!
+              value = spec_loader.call(path).summary
+              attributes.merge! key => value if value
             end
 
             Success attributes

data/lib/milestoner/configuration/transformers/gems/name.rb

@@ -2,7 +2,6 @@
 
 require "dry/monads"
 require "pathname"
-require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -13,8 +12,6 @@ module Milestoner
           include Import[:spec_loader]
           include Dry::Monads[:result]
 
-          using Refinements::Hash
-
           def initialize(key = :project_name, path: "#{Pathname.pwd.basename}.gemspec", **)
             @key = key
             @path = path
@@ -23,7 +20,8 @@ module Milestoner
 
           def call attributes
             attributes.fetch key do
-              attributes.merge!(key => spec_loader.call(path).name).compress!
+              value = spec_loader.call(path).name
+              attributes.merge! key => value if value
             end
 
             Success attributes

data/lib/milestoner/configuration/transformers/project/author.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "dry/monads"
-require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -12,8 +11,6 @@ module Milestoner
           include Import[:git]
           include Dry::Monads[:result]
 
-          using Refinements::Hash
-
           def initialize(key = :project_author, **)
             @key = key
             super(**)
@@ -21,7 +18,7 @@ module Milestoner
 
           def call attributes
             attributes.fetch key do
-              git.get("user.name", nil).bind { |value| attributes.merge!(key => value).compress! }
+              git.get("user.name", nil).bind { |value| attributes.merge! key => value if value }
             end
 
             Success attributes

data/lib/milestoner/configuration/transformers/project/label.rb

@@ -2,7 +2,6 @@
 
 require "dry/monads"
 require "pathname"
-require "refinements/hash"
 require "refinements/string"
 
 module Milestoner
@@ -11,10 +10,9 @@ module Milestoner
       # Conditionally updates label based on current directory.
       module Project
         using Refinements::String
-        using Refinements::Hash
 
         Label = lambda do |attributes, key = :project_label, default: Pathname.pwd.basename.to_s|
-          attributes.fetch(key) { attributes.merge!(key => default.titleize).compress! }
+          attributes.fetch(key) { attributes.merge! key => default.titleize }
           Dry::Monads::Success attributes
         end
       end

data/lib/milestoner/container.rb

@@ -6,7 +6,6 @@ require "etcher"
 require "gitt"
 require "lode"
 require "runcom"
-require "sanitize"
 require "spek"
 
 module Milestoner
@@ -65,7 +64,7 @@ module Milestoner
 
     register(:settings) { Etcher.call(self[:registry]).dup }
     register(:specification) { self[:spec_loader].call "#{__dir__}/../../milestoner.gemspec" }
-    register :sanitizer, -> content { Sanitize.fragment content, Sanitize::Config::BASIC }
+    register(:sanitizer) { Sanitizer.new }
     register(:spec_loader) { Spek::Loader.new }
     register(:git) { Gitt::Repository.new }
     register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }

data/lib/milestoner/models/commit.rb

@@ -7,6 +7,7 @@ module Milestoner
     COMMIT_COMMON_ATTRIBUTES = %i[
       authored_at
       body
+      body_lines
       deletions
       files_changed
       fingerprint

data/lib/milestoner/sanitizer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "refinements/array"
+require "sanitize"
+
+module Milestoner
+  # A custom HTML sanitizer.
+  class Sanitizer
+    using Refinements::Array
+
+    def initialize defaults: Sanitize::Config::BASIC, client: Sanitize
+      @defaults = defaults
+      @client = client
+    end
+
+    def call(content) = client.fragment content, configuration
+
+    private
+
+    attr_reader :defaults, :client
+
+    def configuration
+      client::Config.merge defaults,
+                           elements: defaults[:elements].including("img", "video"),
+                           attributes: defaults[:attributes].merge(
+                             "img" => %w[alt class height id loading src width],
+                             "video" => %w[class controls height id poster src width]
+                           )
+    end
+  end
+end

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

@@ -1 +1,48 @@
-* <%= commit.emoji %> <%= commit.subject %> - <%= render :profile, name: commit.author.name, url: commit.profile_url(commit.author) %>
+.<%= commit.emoji %> <%= commit.subject %> - <%= render :profile, name: commit.author.name, url: commit.profile_url(commit.author) %>
+[%collapsible]
+====
+*Message*
+
+<% if commit.body_lines && commit.body_lines.any? %>
+<%= commit.body_lines.join "\n" %>
+<% else %>
+None.
+<% end %>
+
+<% unless commit.notes.empty? %>
+*Notes*
+
+_Notes are detected but can't be rendered at the moment. Support will be added in the next Milestoner version._
+<% end %>
+
+*Author*
+
+<%= render :avatar, name: commit.author.name, url: commit.avatar_url(commit.author) %> <%= render :profile, name: commit.author.name, url: commit.profile_url(commit.author) %>
+
+<% if commit.collaborators.any? %>
+*Collaborators*
+
+<% commit.collaborators.each do |collaborator| %>
+* <%= render :avatar, name: collaborator.name, url: commit.avatar_url(collaborator) %> <%= render :profile, name: collaborator.name, url: commit.profile_url(collaborator) %>
+<% end %>
+<% end %>
+
+<% if commit.signers.any? %>
+*Signers*
+
+<% commit.signers.each do |signer| %>
+* <%= render :avatar, name: signer.name, url: commit.avatar_url(signer) %> <%= render :profile, name: signer.name, url: commit.profile_url(signer) %>
+<% end %>
+<% end %>
+
+*Details*
+
+* Milestone: <%= commit.tag.capitalize %>
+* Signature: <%= commit.signature %>
+* Files: link:<%= commit.uri %>[<%= commit.files_changed %>]
+* 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 %>_
+====

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

@@ -28,7 +28,11 @@
       <h1 class="bar">Message</h1>
 
       <div class="content">
-        <%= commit.safe_body %>
+        <% if commit.body.empty? %>
+          <p>None.</p>
+        <% else %>
+          <%= commit.safe_body %>
+        <% end %>
       </div>
     </div>
 

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

@@ -7,7 +7,7 @@
   <h4>Message</h4>
 
   <% if commit.body.empty? %>
-    <p>No message.</p>
+    <p>None.</p>
   <% else %>
     <%= commit.safe_body %>
   <% end %>
@@ -72,11 +72,7 @@
 
   <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>
+      <%= commit.datetime %>
     </em>
   </p>
 

data/lib/milestoner/views/parts/commit.rb

@@ -65,6 +65,8 @@ module Milestoner
 
         def at = authored_at.strftime "%Y-%m-%dT%H:%M:%S%z"
 
+        def datetime = authored_at.strftime "%Y-%m-%d (%A) at %H:%M %p %Z"
+
         def weekday = authored_at.strftime "%A"
 
         def date = authored_at.strftime "%Y-%m-%d"

data/milestoner.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "milestoner"
-  spec.version = "18.3.0"
+  spec.version = "18.4.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/milestoner"
@@ -31,10 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-monads", "~> 1.6"
   spec.add_dependency "dry-schema", "~> 1.13"
   spec.add_dependency "etcher", "~> 2.1"
-  spec.add_dependency "gitt", "~> 3.8"
+  spec.add_dependency "gitt", "~> 3.9"
   spec.add_dependency "hanami-view", "~> 2.1"
   spec.add_dependency "infusible", "~> 3.8"
-  spec.add_dependency "lode", "~> 1.4"
+  spec.add_dependency "lode", "~> 1.8"
   spec.add_dependency "redcarpet", "~> 3.6"
   spec.add_dependency "refinements", "~> 12.8"
   spec.add_dependency "rss", "~> 0.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 18.3.0
+  version: 18.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -155,14 +155,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: hanami-view
   requirement: !ruby/object:Gem::Requirement
@@ -197,14 +197,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -415,6 +415,7 @@ files:
 - lib/milestoner/renderers/asciidoc.rb
 - lib/milestoner/renderers/markdown.rb
 - lib/milestoner/renderers/universal.rb
+- lib/milestoner/sanitizer.rb
 - lib/milestoner/syndication/builder.rb
 - lib/milestoner/syndication/refine.rb
 - lib/milestoner/syndication/shared.rb