milestoner 18.0.1 → 18.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9888c9ada1acc15633b75033d7fa867f9ce726de015e8eecdd61bf17c65d1db9
-  data.tar.gz: 3dc30214f99ac8da3f7245c953cec6e4af593bd18283543f760b9ceec1e3fea5
+  metadata.gz: 27103ea8c0c11529358a9af74ba09984649748fd1420d5a87033935a3f7cd0c3
+  data.tar.gz: 71b5a313d296be4198631273b6b7520c1ea1a99350a829a38e7eec0aa9cdd690
 SHA512:
-  metadata.gz: f120d8414ac38e182b72eead7588c2ef3ec6fec02f1d781ed7e90783ee478eedec9c985311617bf2438d7b3775f6a45ad875374f0e84f550dd2b5c5a2593e5bd
-  data.tar.gz: 0fc33409f7fd90d29b9187c226a63544e8189442c28ee4908543b6ffdb03ffb5321c9c7844adb5f4a60ad93ded831cf59a837dcc77ffd593175ecb9e100ab4b3
+  metadata.gz: 7260fdf39ccf76b5e7b65000851345b66ec85d1c2f8fd8db3337ad3bc8bef4842926ceefbd9d8da271b9a977f74eaee9fac6022a39928b67859c6f3fd34194d9
+  data.tar.gz: 1533468fce1026cf42692d347318d4ba17732aa20549d6aa4d5ffb6ea34a576baa567b98e885c11618628092ac83628462a981fb186c12528fd7640f7950e95a

data/README.adoc

@@ -12,6 +12,7 @@
 :git_link: link:https://git-scm.com[Git]
 :git_lint_link: link:https://alchemists.io/projects/git-lint[Git Lint]
 :git_trailers_link: link:https://alchemists.io/articles/git_trailers[Git Trailers]
+:git_notes_link: link:https://alchemists.io/articles/git_notes[Git Notes]
 :hanami_link: link:https://hanamirb.org[Hanami]
 :hanami_views_link: link:https://alchemists.io/articles/hanami_views[Hanami Views]
 :hanamismith_link: link:https://alchemists.io/projects/hanamismith[Hanamismith]
@@ -38,7 +39,7 @@ You can use Milestoner to inspect the current state of the next milestone, celeb
 
 Milestoner pairs well with the following gems:
 
-* {git_lint_link}: Lints each {git_link} commit to ensure they are of high quality for historic inspection and release note generation.
+* {git_lint_link}: Lints each {git_link} commit to ensure they are of high quality for readability, historic inspection, and release note generation.
 * {rubysmith_link}: Automates building new {ruby_link} projects.
 * {gemsmith_link}: Automates building new {rubygems_link} projects.
 * {hanamismith_link}: Automates building new {hanami_link} projects.
@@ -47,43 +48,43 @@ toc::[]
 
 == Screenshots
 
-The following are screenshots of using this gem to render release notes for the {lode_link} gem. Even though {lode_link} is used for example purposes, please keep in mind that Milestoner can be used for _any project, any programming language_.
+The following are screenshots of using this gem to render release notes for the {lode_link} gem. Even though {lode_link} is used for example purposes, keep in mind that Milestoner can be used for _any project and/or programming language_.
 
 === ASCII Doc Format
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc-rendered.png[Release Notes,width=890,height=742,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc.png[Release Notes,width=882,height=738,role=focal_point]
 
 * *Command*: `milestoner build --format ascii_doc`
 * *Renderer*: {ascii_doc_link}
 
 === Feed Format
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-rendered-collapsed.png[Release Notes,width=1121,height=1154,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-collapsed.png[Release Notes,width=1109,height=1143,role=focal_point]
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-rendered-expanded.png[Release Notes,width=1121,height=1154,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-expanded.png[Release Notes,width=1109,height=1143,role=focal_point]
 
 * *Command*: `milestoner build --format feed`
 * *Renderer*: {net_news_wire_link}
 
 === Markdown Format
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-markdown-rendered.png[Release Notes,width=712,height=717,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-markdown.png[Release Notes,width=789,height=718,role=focal_point]
 
 * *Command*: `milestoner build --format markdown`
 * *Renderer*: {marked_link}
 
 === Stream Format
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-stream.png[Release Notes,width=451,height=370,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-stream.png[Release Notes,width=586,height=341,role=focal_point]
 
 * *Command*: `milestoner build --format stream`
 * *Renderer*: {iterm_link}
 
 === Web Format
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-collapsed.png[Release Notes,width=1150,height=878,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-collapsed.png[Release Notes,width=1195,height=878,role=focal_point]
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-expanded.png[Release Notes,width=1150,height=878,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-expanded.png[Release Notes,width=1195,height=878,role=focal_point]
 
 * *Command*: `milestoner build --format web`
 * *Renderer*: {firefox_link}
@@ -95,14 +96,21 @@ image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-exp
 ** Example: `0.0.0`.
 * Defaults to including {git_link} commits since last tag (or initialization of repository) when building release notes. This can be customized further if desired.
 * Ensures {git_link} commit messages are grouped by prefix, in order defined, for categorization. For more details, see link:https://alchemists.io/projects/git-lint/#_commit_subject_prefix[Git Lint Commit Subject Prefix]. Defaults (can be customized):
-** image:https://alchemists.io/images/projects/milestoner/icons/commits/fixed.png[Fixed] Fixed
-** image:https://alchemists.io/images/projects/milestoner/icons/commits/added.png[Added] Added
-** image:https://alchemists.io/images/projects/milestoner/icons/commits/updated.png[Updated] Updated
-** image:https://alchemists.io/images/projects/milestoner/icons/commits/removed.png[Removed] Removed
-** image:https://alchemists.io/images/projects/milestoner/icons/commits/refactored.png[Refactored] Refactored
+** image:https://alchemists.io/images/projects/milestoner/icons/fixed.png[Fixed] Fixed
+** image:https://alchemists.io/images/projects/milestoner/icons/added.png[Added] Added
+** image:https://alchemists.io/images/projects/milestoner/icons/updated.png[Updated] Updated
+** image:https://alchemists.io/images/projects/milestoner/icons/removed.png[Removed] Removed
+** image:https://alchemists.io/images/projects/milestoner/icons/refactored.png[Refactored] Refactored
 * Ensures {git_link} commit messages are alphabetically sorted for release note categorization and readability.
 * Provides automatic versioning based on last {git_link} tag and {git_trailers_link}. See {git_commit_anatomy_link} for details.
-* Supports multiple build formats: {ascii_doc_link}, {syndication_link}, {markdown_link}, Stream (console), and Web (HTML). Each are fully customizable via your personal {xdg_link} and {hanami_views_link} configuration.
+* Supports multiple build formats:
+** {ascii_doc_link}
+** {syndication_link}
+** {markdown_link}
+** Stream (console)
+** link:https://html.spec.whatwg.org/multipage[Web]
+* Supports {git_notes_link}.
+* Supports customization via your personal {xdg_link} and {hanami_views_link} configuration.
 
 == Requirements
 
@@ -268,7 +276,7 @@ The above can be customized as follows:
 
 As hinted at above, all URIs (including syndication), support {string_formats_link}. This means you can use the `%<key>s` format -- replacing `key` with the key of your choice -- to customize your configuration further.
 
-💡 If you ever need to know what your current configuration looks like you can jump into your applications IRB console and inspect `Milestoner::Container[:configuration]` to see full details.
+💡 If you need to know what your current configuration looks like, you can jump into your applications IRB console and inspect `Milestoner::Container[:settings]` to see full details.
 
 === Config
 
@@ -321,7 +329,7 @@ milestoner cache --info
 
 Once team member information is stored in your cache, you'll be able to build release notes which automatically link to GitHub user information without constantly hitting the GitHub API. _Users are identified by name so the full author name used for each commit message needs to match the same user name as stored in your source repository hosting service._
 
-If you don't update your cache, your release note display a question mark (?) and _unknown_ for team members as highlighted below:
+If you don't use the cache, your release notes use a question mark (?) and _unknown_ for team members as highlighted below:
 
 image:https://alchemists.io/images/projects/milestoner/screenshots/no_cache.png[Usage,width=851,height=571,role=focal_point]
 
@@ -338,7 +346,7 @@ milestoner build --format web
 # 🟢 Milestone built: /Users/bkuhlmann/Engineering/OSS/milestoner/tmp/milestone
 ----
 
-The above command is so useful that I use the following `msw` (i.e. Milestoner Web) Bash alias to build currest release notes or release notes for several tags:
+The above command is so useful that I use the following `msw` (i.e. Milestoner Web) Bash alias to build current release notes or release notes for several tags:
 
 [source,bash]
 ----
@@ -365,7 +373,7 @@ Check out the help documentation (i.e. `milestoner build --help`) for addition u
 
 ==== Automatic Versioning
 
-As mentioned earlier, the calculation of version information happens automatically for you based on your last {git_link} tag and any {git_link} commit trailer metadata used. If none of this information is present, then the default version of `0.0.0` is used instead. All of this information is available to you via the following command:
+As mentioned earlier, the calculation of version information happens automatically based on your last {git_link} tag and any {git_link} commit trailer metadata used. If none of this information is present, then the default version of `0.0.0` is used instead. All of this information is available to you via the following command:
 
 [source,bash]
 ----
@@ -383,7 +391,7 @@ milestoner build --format stream
 milestoner build --format stream --version 1.2.3
 ----
 
-By default, automatic versioning is based on your last known {git_link} tag and the version is bumped based on {git_link} commit trailer information from untagged commits (i.e. those commits created since the last tag). All of this is managed via the {versionaire_link} gem. To ensure automatic versioning works properly, you only need to add the `Milestone` {git_link} commit trailer with a value of: `patch`, `minor`, or `major`. Here's an example assuming you have published Version 1.0.0:
+By default, automatic versioning is based on your last known {git_link} tag. The version is bumped based on {git_link} commit trailer information from untagged commits (i.e. commits created since the last tag). All of this is managed via the {versionaire_link} gem. To ensure automatic versioning works properly, you only need to add the `Milestone` {git_link} commit trailer with a value of: `patch`, `minor`, or `major`. Here's an example assuming you have published Version 1.0.0:
 
 ....
 # First commit.
@@ -426,7 +434,8 @@ Given the above, the resulting version would be: 2.0.0. This is because the high
 
 ==== Templates
 
-Build template functionality is powered by {hanami_views_link} which means you can customize the HTML structure, CSS style, and more. The quickest way to get started is to copy the `templates` folder structure -- included with this gem -- to your preferred {runcom_link} configuration. For example, this gem's template structure is:
+Build template functionality is powered by {hanami_views_link} which means you can completely customize _all_ build formats, templates, partials, stylesheets, images, and so much more.
+The quickest way to start customization is to copy the `templates` folder structure -- included with this gem -- to your preferred {runcom_link} configuration (i.e. global or local). For example, this gem's template structure is:
 
 ....
 lib/milestoner/templates
@@ -468,28 +477,42 @@ lib/milestoner/templates
    └── page.css.erb
 ....
 
-This means you could, for example, copy all of this gem's templates to your own {runcom_link} configuration to customize how you like. Example:
+This means you could, for example, copy all of Milestoner's default templates to your own {runcom_link} configuration and customize as you see fit. Example (using global configuration):
 
 [source,bash]
 ----
 cp -r <milestoner_gem_root>/lib/milestoner/templates $HOME/.config/milestoner/templates
 ----
 
-Milestoner searches your {runcom_link} configuration first and, if templates are detected, will be used instead. Otherwise, Milestoner falls back to it's own templates. Once {runcom_link} has calculated all possible template locations, {hanami_views_link} handles the final loading and evaluation of your templates.
+Milestoner searches your {runcom_link} configuration first and, if templates are detected, will be used instead. Otherwise, Milestoner falls back to it's own templates. Once {runcom_link} has calculated all possible template locations, {hanami_views_link} handles the final loading and rendering of the templates.
 
-==== Web Format
+==== Formats
 
-Of all the build formats supported, the web format is the most powerful and feature rich. The following showcases _some_ of the information rendered in this format based on commit activity.
+Of all build formats supported, the web format is the most powerful and feature rich. The following showcases _some_ of the information rendered in this format based on commit activity.
 
-*Wit Basic Git Commit*
+*With Basic Git Commit*
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/web_format-overview.png[Usage,width=1228,height=808,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/web_format-overview.png[Overview,width=1119,height=910,role=focal_point]
 
-*With Git Commit Notes and Trailers*
+*With Collaborators and Signers*
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/web_format-notes_and_collaborators.png[Usage,width=1228,height=808,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/web_format-collaborators_and_signers.png[Collaborators and Signers,width=1118,height=1003,role=focal_point]
 
-Each milestone is meant to provide you with the right amount of statistical information you can make informed decisions.
+*With Invalid Tag*
+
+image:https://alchemists.io/images/projects/milestoner/screenshots/web_format-tag_invalid.png[Invalid Tag,width=1119,height=910,role=focal_point]
+
+*With Valid Tag*
+
+image:https://alchemists.io/images/projects/milestoner/screenshots/web_format-tag_valid.png[Valid Tag,width=1119,height=910,role=focal_point]
+
+*With Notes*
+
+image:https://alchemists.io/images/projects/milestoner/screenshots/web_format-notes.png[Notes,width=1119,height=910,role=focal_point]
+
+💡 See {git_notes_link} to learn more.
+
+You'll find all formats render similar information with the feed format being the closest but most formats are not as feature rich as the web format. Each milestone is meant to provide you with the right amount of statistical information you can make informed decisions.
 
 == Security
 

data/lib/milestoner/builders/stream.rb

@@ -30,7 +30,7 @@ module Milestoner
 
       def build tags
         tags.reduce([]) { |content, tag| content.append render(tag) }
-            .join(%(\n\n))
+            .join(%(\n#{"-" * 80}\n\n))
       end
 
       def render(tag) = view.call tag:, layout: settings.build_layout, format: :stream

data/lib/milestoner/builders/web.rb

@@ -54,6 +54,7 @@ module Milestoner
 
       def write tag
         path = make_path tag
+        settings.project_version = tag.version
 
         path.write view.call(tag:, layout: settings.build_layout)
         logger.info { "Built: #{path}." }

data/lib/milestoner/commits/tagger.rb

@@ -2,6 +2,7 @@
 
 require "dry/monads"
 require "refinements/pathname"
+require "refinements/struct"
 require "versionaire"
 
 module Milestoner
@@ -14,6 +15,7 @@ module Milestoner
 
       using Refinements::Pathname
       using Versionaire::Cast
+      using Refinements::Struct
 
       def initialize(enricher: Commits::Enricher.new, model: Models::Tag, **)
         @enricher = enricher
@@ -67,9 +69,7 @@ module Milestoner
       end
 
       def author tag
-        tag = tag.dup
-        tag.author_name ||= settings.project_author
-        author_enricher.call tag
+        author_enricher.call tag.with(author_name: tag.author_name || settings.project_author)
       end
 
       def committed_at(at) = at ? Time.at(at.to_i).utc : settings.loaded_at

data/lib/milestoner/renderers/universal.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "refinements/binding"
+
 module Milestoner
   module Renderers
     # The primary renderer for multiple input formats as HTML.
     class Universal
       include Import[:settings]
 
+      using Refinements::Binding
+
       DELEGATES = {asciidoc: Asciidoc.new, markdown: Markdown.new}.freeze
 
       def initialize(delegates: DELEGATES, **)
@@ -14,9 +18,7 @@ module Milestoner
         @default_format = settings.commit_format.to_sym
       end
 
-      def call content, for: default_format
-        delegates.fetch(binding.local_variable_get(:for)).call content
-      end
+      def call(content, for: default_format) = delegates.fetch(binding[:for]).call content
 
       private
 

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

@@ -10,24 +10,33 @@
     <meta name="author" content="<%= project_author %>">
     <meta name="generator" content="<%= generator_label %> <%= generator_version %>">
 
-    <link title="<%= project_label %>: Favorite Icon"
-          rel="icon"
-          href="https://alchemists.io/images/projects/milestoner/favicon.ico"
-          sizes="32x32">
-    <link title="<%= project_label %>: Apple Icon"
-          rel="apple-touch-icon"
-          href="https://alchemists.io/images/projects/milestoner/logo.png"
-          type="image/png"
-          sizes="200x200">
-
-<% 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>
+    <% if project_uri_icon %>
+      <link title="<%= project_label %>: Favorite Icon"
+            rel="icon"
+            href="<%= project_uri_icon %>"
+            sizes="32x32">
+    <% end %>
+
+    <% if project_uri_logo %>
+      <link title="<%= project_label %>: Apple Icon"
+            rel="apple-touch-icon"
+            href="<%= project_uri_logo %>"
+            type="image/png"
+            sizes="200x200">
+    <% end %>
+
+    <% 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.1"
+            integrity="sha384-l8f0VcPi/M1iHPv8egOnY/15TDwqgbOR1anMIJWvU6nLRgZVLTLSaNqi/TOoT5Fh"
+            crossorigin="anonymous"
+            defer>
+    </script>
   </head>
 
   <body>

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

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

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

@@ -4,8 +4,8 @@
 <%= tag.total_commits %>. <%= tag.total_files %>. <%= tag.total_deletions %>. <%= tag.total_insertions %>.
 <% else %>
 <%= project_label %> <%= tag.version %> (<%= tag.committed_date %>)
-
 <% if tag.version != project_version %>
+
 <%= tag.author.name %> | <%= tag.security %>
 <% end %>
 

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

@@ -10,16 +10,15 @@
   --color-cheese: hsl(51, 100%, 93%);
   --color-cloud: hsl(219, 100%, 93%);
   --color-ghost: hsl(171.4, 17.1%, 92%);
-  --color-green: hsl(112.6, 85.6%, 46.3%);
+  --color-green: hsl(121, 73%, 35%);
   --color-grey: hsl(240, 7%, 97%);
-  --color-sea: hsl(210, 24%, 15%);
   --color-ice: hsl(216, 100%, 98%);
   --color-major: hsl(7, 79%, 32%);
   --color-minor: hsl(221, 79%, 32%);
   --color-orange: hsl(24.8, 100%, 50.2%);
   --color-patch: hsl(156, 79%, 32%);
   --color-powder: hsl(0, 0%, 98%);
-  --color-red: hsl(0, 100%, 50%);
+  --color-red: hsl(0, 84.1%, 44.5%);
   --color-slate: hsl(211, 23%, 41%);
   --color-smoke: hsl(229, 31%, 93%);
   --color-white: hsl(0, 0%, 100%);

data/milestoner.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "milestoner"
-  spec.version = "18.0.1"
+  spec.version = "18.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/milestoner"
@@ -30,13 +30,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "core", "~> 1.3"
   spec.add_dependency "dry-monads", "~> 1.6"
   spec.add_dependency "dry-schema", "~> 1.13"
-  spec.add_dependency "etcher", "~> 2.0"
+  spec.add_dependency "etcher", "~> 2.1"
   spec.add_dependency "gitt", "~> 3.6"
   spec.add_dependency "hanami-view", "~> 2.1"
   spec.add_dependency "infusible", "~> 3.8"
   spec.add_dependency "lode", "~> 1.4"
   spec.add_dependency "redcarpet", "~> 3.6"
-  spec.add_dependency "refinements", "~> 12.5"
+  spec.add_dependency "refinements", "~> 12.7"
   spec.add_dependency "rss", "~> 0.3"
   spec.add_dependency "runcom", "~> 11.5"
   spec.add_dependency "sanitize", "~> 6.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 18.0.1
+  version: 18.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -141,14 +141,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: gitt
   requirement: !ruby/object:Gem::Requirement
@@ -225,14 +225,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.5'
+        version: '12.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.5'
+        version: '12.7'
 - !ruby/object:Gem::Dependency
   name: rss
   requirement: !ruby/object:Gem::Requirement
@@ -485,7 +485,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A command line interface for automated Git repository milestones.