milestoner 17.7.0 → 17.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1ba81535b2b7f13eee65139650927c6b6fd89d1f4ce7a91bd8bd8b5f193b938
-  data.tar.gz: bf82ebc6322e1509786691305dd7426716db0aa1edb118f244379ed147de9419
+  metadata.gz: 986c8952d2cb94c4ec9ed74b3dd4c973f8052e7330225157b375c7fdd6da6fcb
+  data.tar.gz: 191fb431069d48a29a9b44b161da73af27e84bad35c79fba5e8b4878f8d4ef22
 SHA512:
-  metadata.gz: da5ab0c1fb070b621f23d3cd2109fbc88197bc7ef605245fb92d8fd598a352d8f35ebdc7774b5649a0c9e305a08bfb625c0bf32a4d606a6f7ed25b9c666a4691
-  data.tar.gz: 93aa467526e6ac43d881834499220c0f0a73d1a0a463b85abc6ad2ff2e63aa5210f5bfa06916f7cfbded178af3383fc45f0d65e5438bfc5729f86ef267db6bd9
+  metadata.gz: 4bf70ca9ea15f208610b9220c5b01321f2b5db73cce12de7c7adbd7093ad2dbad9644362ac36639ab3ecab0ee549767873aa9062f6834ab54a511dff95c9f5e0
+  data.tar.gz: f35474567d0502711541f80dc1409b85f2e65801dc06b1b224003cfb44c307013ed0db5b97ef0a6072cda9bb3f7b9a063cbac31ac8982ebfc7bb49e09b714b56

data/README.adoc

@@ -11,7 +11,7 @@
 :git_link: link:https://git-scm.com[Git]
 :git_lint_link: link:https://alchemists.io/projects/git-lint[Git Lint]
 :hanami_link: link:https://hanamirb.org[Hanami]
-:hanami_views_link: link:https://alchemists.io/articles/hanami_views[Hanami View]
+:hanami_views_link: link:https://alchemists.io/articles/hanami_views[Hanami Views]
 :hanamismith_link: link:https://alchemists.io/projects/hanamismith[Hanamismith]
 :lode_link: link:https://alchemists.io/projects/lode[Lode]
 :markdown_link: link:https://daringfireball.net/projects/markdown[Markdown]
@@ -73,7 +73,7 @@ image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-exp
 ** image:https://alchemists.io/images/projects/milestoner/icons/commits/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 current commit trailers. See {git_commit_anatomy_link} for details.
-* Supports multiple release note build formats: {ascii_doc_link}, {markdown_link}, Stream (console), and Web (HTML). Each are fully customizable via your personal {xdg_link} configuration and {hanami_views_link} templates.
+* Supports multiple release note build formats: {ascii_doc_link}, {markdown_link}, Stream (console), and Web (HTML). Each are fully customizable via your personal {xdg_link} configuration and {hanami_views_link}.
 
 == Requirements
 
@@ -105,7 +105,7 @@ gem install milestoner
 
 From the command line, type: `milestoner --help`
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/usage.png[Usage,width=690,height=398,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/usage.png[Usage,width=670,height=412,role=focal_point]
 
 === Customization
 
@@ -174,7 +174,7 @@ The above can be customized as follows:
 ** `uri`: Required. The URI format for linking to avatars as formatted using {string_formats_link}. Default: GitHub. The `id` is dynamically calculated via the `external_id` of the user stored in the {lode_link} cache.
 * `build`: Manages release note builds.
 ** `format`: Required. The build output format. Multiple formats are supported. Default: web.
-** `layout`: Required. The layout used by the {hanami_views_link} gem when building release notes. Default: page.
+** `layout`: Required. The layout used by {hanami_views_link} when building release notes. Default: page.
 ** `root`: Required. The output location. This can be a relative or absolute path. Defaults to the `tmp` directory of your current project. The path is automatically created if missing.
 * `commit`: Manages commit categories, emojis, and hyperlinks.
 ** `categories`: Required. By default, only five categories are supported which pairs well with the {git_lint_link} gem. Category order is important with the first taking precedence over the second and so forth. Special characters are allowed for prefixes but should be enclosed in quotes. To disable categories, use an empty array. Example: `categories: []`.
@@ -339,7 +339,7 @@ Given the above, the resulting version would be: 2.0.0. This is because the high
 
 ==== Templates
 
-Build template functionality is powered by the {hanami_views_link} gem 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 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:
 
 ....
 lib/milestoner/templates
@@ -371,7 +371,7 @@ This means you could, for example, copy all of this gem's templates to your own
 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 will fall 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} handle the final loading and evaluation of your templates.
 
 ==== Web Format
 

data/lib/milestoner/cli/actions/build/layout.rb

@@ -10,11 +10,11 @@ module Milestoner
         class Layout < Sod::Action
           include Import[:input]
 
-          description "Set layout."
+          description "Set view template layout."
 
           ancillary "Use false to disable."
 
-          on %w[-L --layout], argument: "[LAYOUT]"
+          on %w[-L --layout], argument: "[NAME]"
 
           default { Container[:configuration].build_layout }
 

data/lib/milestoner/cli/actions/build/root.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "sod"
 
 module Milestoner
@@ -16,7 +17,7 @@ module Milestoner
 
           default { Container[:configuration].build_root }
 
-          def call(path = nil) = input.build_root = (path || default).expand_path
+          def call(path = nil) = input.build_root = Pathname(path || default).expand_path
         end
       end
     end

data/lib/milestoner/cli/actions/next.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      # Handles calculation of next version.
+      class Next < Sod::Action
+        include Import[:configuration, :kernel]
+
+        description "Show next version."
+
+        ancillary "Calculated from commit trailers."
+
+        on %w[-n --next]
+
+        def call(*) = kernel.puts configuration.project_version
+      end
+    end
+  end
+end

data/lib/milestoner/cli/commands/build.rb

@@ -22,10 +22,10 @@ module Milestoner
 
         # :reek:TooManyStatements
         def call
-          log_info "Building milestone..."
-
           format = input.build_format
 
+          log_info "Building #{input.project_label} milestone (#{format})..."
+
           case format
             when "ascii_doc" then build_ascii_doc
             when "markdown" then build_markdown

data/lib/milestoner/cli/shell.rb

@@ -27,6 +27,7 @@ module Milestoner
           on(Sod::Prefabs::Commands::Config, context:)
           on Commands::Cache
           on Commands::Build
+          on Actions::Next
           on Actions::Publish
           on(Sod::Prefabs::Actions::Version, context:)
           on Sod::Prefabs::Actions::Help, self

data/lib/milestoner/commits/categorizer.rb

@@ -7,41 +7,42 @@ module Milestoner
   module Commits
     # Retrieves and categorizes Git repository commit tagged or untagged history.
     class Categorizer
-      include Import[:git]
+      include Import[:git, :input]
 
       using Refinements::Array
 
-      def initialize(collector: Collector.new, expression: Regexp, **)
+      def initialize(collector: Collector.new, **)
         @collector = collector
-        @expression = expression
         super(**)
-      end
 
-      def call configuration = Container[:configuration]
-        categories = configuration.commit_categories.pluck :label
+        @labels = input.commit_categories.pluck :label
+        @pattern = labels.empty? ? // : Regexp.union(labels)
+      end
 
-        categories.reduce({}) { |group, prefix| group.merge prefix => [] }
-                  .merge("Unknown" => [])
-                  .then { |groups| group_by_category categories, groups }
-                  .each_value { |commits| commits.sort_by!(&:subject) }
-                  .values
-                  .flatten
+      def call min: Collector::MIN, max: Collector::MAX
+        collect(min, max).each_value { |commits| commits.sort_by!(&:subject) }
+                         .values
+                         .flatten
       end
 
       private
 
-      attr_reader :collector, :expression
-
-      def group_by_category categories, groups
-        collector.call.value_or(Core::EMPTY_ARRAY).each.with_object groups do |commit, collection|
-          category = commit.subject[subject_pattern(categories)]
-          key = collection.key?(category) ? category : "Unknown"
-          collection[key] << commit
-        end
+      attr_reader :collector, :labels, :pattern
+
+      def collect min, max
+        collector.call(min:, max:)
+                 .value_or(Core::EMPTY_ARRAY)
+                 .each
+                 .with_object categories do |commit, collection|
+                   category = commit.subject[pattern]
+                   key = collection.key?(category) ? category : "Unknown"
+                   collection[key] << commit
+                 end
       end
 
-      def subject_pattern categories
-        categories.empty? ? expression.new(//) : expression.union(categories)
+      def categories
+        labels.reduce({}) { |group, prefix| group.merge prefix => [] }
+              .merge! "Unknown" => []
       end
     end
   end

data/lib/milestoner/commits/collector.rb

@@ -1,16 +1,28 @@
 # frozen_string_literal: true
 
+require "dry/monads"
+
 module Milestoner
   module Commits
-    # Collects commits since last tag or all commits if untagged.
+    # Collects commits since last tag, a specific range, or all commits if untagged.
     class Collector
+      include Dry::Monads[:result]
       include Import[:git]
 
-      def call = git.tagged? ? latest : all
+      MIN = :last
+      MAX = :HEAD
+
+      def call(min: MIN, max: MAX) = git.tagged? ? slice(min, max) : all
 
       private
 
-      def latest = git.tag_last.bind { |tag| git.commits "#{tag}..HEAD" }
+      def slice min, max
+        case [min, max]
+          in MIN, MAX then git.tag_last.bind { |tag| git.commits "#{tag}..#{max}" }
+          in String, String then git.commits "#{min}..#{max}"
+          else Failure "Invalid minimum and/or maximum range: #{min}..#{max}."
+        end
+      end
 
       def all = git.commits
     end

data/lib/milestoner/commits/enricher.rb

@@ -29,9 +29,9 @@ module Milestoner
         super(**)
       end
 
-      def call
-        categorizer.call
-                   .map { |commit| record_for commit }
+      def call min: Collector::MIN, max: Collector::MAX
+        categorizer.call(min:, max:)
+                   .map { |commit| model.for(commit, **build_attributes(commit)) }
                    .then { |commits| Success commits }
       end
 
@@ -39,8 +39,6 @@ module Milestoner
 
       attr_reader :categorizer, :model
 
-      def record_for(commit) = model.for(commit, **build_attributes(commit))
-
       def build_attributes commit
         infused_keys.each.with_object({}) do |command, attributes|
           attributes[command] = __send__(command).call commit

data/lib/milestoner/configuration/contract.rb

@@ -26,6 +26,7 @@ module Milestoner
       required(:generator_label).filled :string
       required(:generator_uri).filled :string
       required(:generator_version).filled Etcher::Types::Version
+      required(:loaded_at).filled :time
       required(:profile_domain).filled :string
       required(:profile_uri).filled :string
       required(:project_author).filled :string

data/lib/milestoner/configuration/model.rb

@@ -16,6 +16,7 @@ module Milestoner
                        :generator_label,
                        :generator_uri,
                        :generator_version,
+                       :loaded_at,
                        :profile_domain,
                        :profile_uri,
                        :project_author,

data/lib/milestoner/container.rb

@@ -29,13 +29,13 @@ module Milestoner
     end
 
     register :configuration do
-      self[:defaults].add_loader(Etcher::Loaders::YAML.new(self["xdg.config"].active))
+      self[:defaults].add_loader(:yaml, self["xdg.config"].active)
                      .then { |registry| Etcher.call registry }
     end
 
     register :defaults do
       Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
-                      .add_loader(Etcher::Loaders::YAML.new(self[:defaults_path]))
+                      .add_loader(:yaml, self[:defaults_path])
                       .add_transformer(Configuration::Transformers::Build::Root)
                       .add_transformer(Configuration::Transformers::Build::TemplatePaths.new)
                       .add_transformer(Configuration::Transformers::Gems::Label.new)
@@ -56,6 +56,7 @@ module Milestoner
                       .add_transformer(Configuration::Transformers::URI::Profile)
                       .add_transformer(Configuration::Transformers::URI::Review)
                       .add_transformer(Configuration::Transformers::URI::Tracker)
+                      .add_transformer(:time)
     end
 
     register(:specification) { self[:spec_loader].call "#{__dir__}/../../milestoner.gemspec" }

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

@@ -14,7 +14,7 @@ module Milestoner
         using Refinements::Array
 
         def initialize(**)
-          super(**)
+          super
           @prefixes = configuration.commit_categories.pluck :label
           @authored_at = Time.at(value.authored_at.to_i).utc
         end

data/milestoner.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "milestoner"
-  spec.version = "17.7.0"
+  spec.version = "17.9.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/milestoner"
@@ -30,7 +30,7 @@ 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", "~> 1.3"
+  spec.add_dependency "etcher", "~> 1.6"
   spec.add_dependency "gitt", "~> 3.2"
   spec.add_dependency "hanami-view", "~> 2.1"
   spec.add_dependency "infusible", "~> 3.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 17.7.0
+  version: 17.9.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -141,14 +141,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: gitt
   requirement: !ruby/object:Gem::Requirement
@@ -347,6 +347,7 @@ files:
 - lib/milestoner/cli/actions/cache/find.rb
 - lib/milestoner/cli/actions/cache/info.rb
 - lib/milestoner/cli/actions/cache/list.rb
+- lib/milestoner/cli/actions/next.rb
 - lib/milestoner/cli/actions/publish.rb
 - lib/milestoner/cli/commands/build.rb
 - lib/milestoner/cli/commands/cache.rb
@@ -448,7 +449,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A command line interface for automated Git repository milestones.