milestoner 16.2.0 → 17.0.0

data/lib/milestoner/cli/actions/cache/delete.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Cache
+        # Handles deleting a user from the cache.
+        class Delete < Sod::Action
+          include Import[:kernel, :logger, client: :cache]
+
+          description "Delete user."
+
+          on %w[-d --delete], argument: "NAME"
+
+          def call name
+            client.commit(:users) { delete name }
+                  .either(method(:success), method(:failure))
+          end
+
+          private
+
+          def success(user) = logger.info { "Deleted: #{user.name.inspect}." }
+
+          def failure message
+            logger.error { message }
+            kernel.abort
+          end
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/cli/actions/cache/find.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Cache
+        # Handles finding a user in the cache.
+        class Find < Sod::Action
+          include Import[:kernel, :logger, client: :cache]
+
+          description "Find user."
+
+          on %w[-f --find], argument: "NAME"
+
+          def call name
+            client.commit(:users) { find name }
+                  .either(method(:success), method(:failure))
+          end
+
+          private
+
+          def success(user) = kernel.puts user.to_h.values.join(", ")
+
+          def failure message
+            logger.error { message }
+            kernel.abort
+          end
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/cli/actions/cache/info.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Cache
+        # Handles cache information.
+        class Info < Sod::Action
+          include Import[:kernel, :logger, client: :cache]
+
+          description "Show information."
+
+          on %w[-i --info]
+
+          def call(*)
+            path = client.path
+            path.exist? ? log_info("Path: #{path}.") : log_info("No cache found.")
+          end
+
+          private
+
+          def log_info(message) = logger.info { message }
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/cli/actions/cache/list.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Cache
+        # Handles listing users within the cache.
+        class List < Sod::Action
+          include Import[:kernel, :logger, client: :cache]
+
+          description "List users."
+
+          on %w[-l --list]
+
+          def call(*)
+            logger.info { "Listing users..." }
+            client.commit(:users, &:all).bind { |users| print users }
+          end
+
+          private
+
+          def print users
+            return logger.info { "No users found." } if users.empty?
+
+            users.each { |user| kernel.puts user.to_h.values.join ", " }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 require "sod"
+require "versionaire"
 
 module Milestoner
   module CLI
@@ -10,20 +11,23 @@ module Milestoner
       class Publish < Sod::Action
         include Import[:configuration]
 
-        using Refinements::Structs
+        using Refinements::Struct
+        using Versionaire::Cast
 
         description "Publish milestone."
 
-        ancillary "(tags and pushes to remote repository)"
+        ancillary "Build, commit, tag, and push to remote repository."
 
-        on %w[-p --publish], argument: "VERSION"
+        on %w[-p --publish], argument: "[VERSION]"
+
+        default { Commits::Versioner.new.call }
 
         def initialize(publisher: Tags::Publisher.new, **)
           super(**)
           @publisher = publisher
         end
 
-        def call(version) = publisher.call configuration.merge(version:)
+        def call(version = nil) = publisher.call Version(version || default)
 
         private
 

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "refinements/pathname"
+require "sod"
+
+module Milestoner
+  module CLI
+    module Commands
+      # Handles the building of milestone output.
+      class Build < Sod::Command
+        include Import[:input, :logger, :kernel]
+        include Builders::Import[:stream, :web]
+
+        using Refinements::Pathname
+
+        handle "build"
+
+        description "Build milestone."
+
+        on Actions::Build::Label
+        on Actions::Build::Version
+        on Actions::Build::Layout
+        on Actions::Build::Format
+        on Actions::Build::Root
+
+        def call
+          log_info "Building milestone..."
+
+          format = input.build_format
+
+          case format
+            when "stream" then build_stream
+            when "web" then build_web
+            else log_error "Invalid build format: #{format}."
+          end
+        end
+
+        private
+
+        attr_reader :view, :enricher
+
+        def build_stream
+          kernel.puts
+          stream.call
+        end
+
+        def build_web = log_info "Milestone built: #{web.call}."
+
+        def log_info(message) = logger.info { message }
+
+        def log_error(message) = logger.error { message }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "refinements/pathname"
+require "sod"
+
+module Milestoner
+  module CLI
+    module Commands
+      # Handles the building of milestone output.
+      class Cache < Sod::Command
+        include Import[:input, :logger]
+
+        using Refinements::Pathname
+
+        handle "cache"
+
+        description "Manage cache."
+
+        on Actions::Cache::Info
+        on Actions::Cache::List
+        on Actions::Cache::Find
+        on Actions::Cache::Create
+        on Actions::Cache::Delete
+      end
+    end
+  end
+end

data/lib/milestoner/cli/shell.rb

@@ -6,7 +6,7 @@ module Milestoner
   module CLI
     # The main Command Line Interface (CLI) object.
     class Shell
-      include Import[:defaults_path, :xdg_config, :specification]
+      include Import[:defaults_path, :specification, xdg_config: "xdg.config"]
 
       def initialize(context: Sod::Context, dsl: Sod, **)
         super(**)
@@ -25,8 +25,9 @@ module Milestoner
 
         dsl.new :milestoner, banner: specification.banner do
           on(Sod::Prefabs::Commands::Config, context:)
+          on Commands::Cache
+          on Commands::Build
           on Actions::Publish
-          on Actions::Status
           on(Sod::Prefabs::Actions::Version, context:)
           on Sod::Prefabs::Actions::Help, self
         end

data/lib/milestoner/commits/categorizer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "refinements/array"
 require "versionaire"
 
 module Milestoner
@@ -8,49 +9,40 @@ module Milestoner
     class Categorizer
       include Import[:git]
 
-      def initialize(expression: Regexp, **)
-        super(**)
+      using Refinements::Array
+
+      def initialize(collector: Collector.new, expression: Regexp, **)
+        @collector = collector
         @expression = expression
+        super(**)
       end
 
       def call configuration = Container[:configuration]
-        prefixes = configuration.prefixes
-
-        prefixes.reduce({}) { |group, prefix| group.merge prefix => [] }
-                .merge("Unknown" => [])
-                .then { |groups| group_by_prefix prefixes, groups }
-                .each_value { |commits| commits.sort_by!(&:subject) }
-                .values
-                .flatten
-                .uniq(&:subject)
+        categories = configuration.commit_categories.pluck :label
+
+        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
       end
 
       private
 
-      attr_reader :expression
+      attr_reader :collector, :expression
 
-      def group_by_prefix prefixes, groups
-        computed_commits.each.with_object groups do |commit, collection|
-          prefix = commit.subject[subject_pattern(prefixes)]
-          key = collection.key?(prefix) ? prefix : "Unknown"
+      def group_by_category categories, groups
+        collector.call.value_or([]).each.with_object groups do |commit, collection|
+          category = commit.subject[subject_pattern(categories)]
+          key = collection.key?(category) ? category : "Unknown"
           collection[key] << commit
         end
       end
 
-      def subject_pattern prefixes
-        prefixes.empty? ? expression.new(//) : expression.union(prefixes)
+      def subject_pattern categories
+        categories.empty? ? expression.new(//) : expression.union(categories)
       end
-
-      def computed_commits = git.tagged? ? tagged_commits : saved_commits
-
-      def tagged_commits
-        git.tag_last
-           .value_or(nil)
-           .then { |tag| git.commits "#{tag}..HEAD" }
-           .value_or([])
-      end
-
-      def saved_commits = git.commits.value_or([])
     end
   end
 end

data/lib/milestoner/commits/collector.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    # Collects commits since last tag or all commits if untagged.
+    class Collector
+      include Import[:git]
+
+      def call = git.tagged? ? latest : all
+
+      private
+
+      def latest = git.tag_last.bind { |tag| git.commits "#{tag}..HEAD" }
+
+      def all = git.commits
+    end
+  end
+end

data/lib/milestoner/commits/enricher.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Milestoner
+  module Commits
+    # Enriches commits and associated trailers for final processing.
+    class Enricher
+      include Import[:input]
+
+      include Enrichers::Import[
+        :author,
+        :body,
+        :collaborators,
+        :format,
+        :issue,
+        :milestone,
+        :notes,
+        :review,
+        :signers,
+        :uri
+      ]
+
+      include Dry::Monads[:result]
+
+      def initialize(categorizer: Commits::Categorizer.new, model: Models::Commit, **)
+        @categorizer = categorizer
+        @model = model
+        super(**)
+        @commands = %i[author body collaborators format issue milestone notes review signers uri]
+      end
+
+      def call
+        categorizer.call
+                   .map { |commit| record_for commit }
+                   .then { |commits| Success commits }
+      end
+
+      private
+
+      attr_reader :categorizer, :model, :commands
+
+      def record_for(commit) = model.for(commit, **build_attributes(commit))
+
+      def build_attributes commit
+        commands.each.with_object({}) do |command, attributes|
+          attributes[command] = __send__(command).call commit
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/author.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit author by using cache.
+      class Author
+        include Milestoner::Import[:cache]
+
+        def initialize(model: Models::User, **)
+          @model = model
+          super(**)
+        end
+
+        def call commit
+          cache.commit(:users) { |table| table.find commit.author_name }
+               .value_or(model.new)
+        end
+
+        private
+
+        attr_reader :model
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/body.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches commit text by rendering as HTML based on trailer information.
+      class Body
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Format", renderer: Renderers::Universal.new, **)
+          @key = key
+          @renderer = renderer
+          super(**)
+        end
+
+        def call commit
+          commit.trailer_value_for(key)
+                .value_or(input.commit_format)
+                .then { |format| renderer.call commit.body, for: format.to_sym }
+        end
+
+        private
+
+        attr_reader :key, :renderer
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/colleague.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "gitt"
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit colleague by using cache.
+      class Colleague
+        include Milestoner::Import[:cache]
+
+        def initialize(key:, parser: Gitt::Parsers::Person.new, **)
+          @key = key
+          @parser = parser
+          super(**)
+        end
+
+        def call(commit) = commit.find_trailers(key).bind { |trailers| users_for(trailers).compact }
+
+        private
+
+        attr_reader :key, :parser
+
+        def users_for(trailers) = trailers.map { |trailer| user_for parser.call(trailer.value) }
+
+        def user_for person
+          cache.commit(:users) { find person.name }
+               .value_or(nil)
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/container.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "dry-container"
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Registers all enrichers for injection.
+      module Container
+        extend Dry::Container::Mixin
+
+        register(:author, memoize: true) { Author.new }
+        register(:body, memoize: true) { Body.new }
+        register(:collaborators, memoize: true) { Colleague.new key: "Co-authored-by" }
+        register(:format, memoize: true) { Format.new }
+        register(:issue, memoize: true) { Issue.new }
+        register(:milestone) { Milestone.new }
+        register(:notes, memoize: true) { Note.new }
+        register(:review, memoize: true) { Review.new }
+        register(:signers, memoize: true) { Colleague.new key: "Signed-off-by" }
+        register(:uri, memoize: true) { URI.new }
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/format.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit format based on trailer information.
+      class Format
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Format", **)
+          @key = key
+          super(**)
+        end
+
+        def call(commit) = commit.trailer_value_for(key).value_or(input.commit_format)
+
+        private
+
+        attr_reader :key
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/import.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "infusible"
+
+module Milestoner
+  module Commits
+    module Enrichers
+      Import = Infusible.with Container
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/issue.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit issue based on trailer information.
+      class Issue
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Issue", model: Models::Link, **)
+          @key = key
+          @model = model
+          super(**)
+        end
+
+        def call commit
+          commit.trailer_value_for(key)
+                .fmap { |value| model[id: value, uri: format(input.tracker_uri, id: value)] }
+                .value_or(model.new)
+        end
+
+        private
+
+        attr_reader :key, :model
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/milestone.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit milestone based on trailer information.
+      class Milestone
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Milestone", default: "unknown", **)
+          @key = key
+          @default = default
+          super(**)
+        end
+
+        def call(commit) = commit.trailer_value_for(key).value_or(default)
+
+        private
+
+        attr_reader :key, :default
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/note.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches commit notes by rendering as HTML based on trailer information.
+      class Note
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Format", renderer: Renderers::Universal.new, **)
+          @key = key
+          @renderer = renderer
+          super(**)
+        end
+
+        def call commit
+          commit.trailer_value_for(key)
+                .value_or(input.commit_format)
+                .then { |format| renderer.call commit.notes, for: format.to_sym }
+        end
+
+        private
+
+        attr_reader :key, :renderer
+      end
+    end
+  end
+end

data/lib/milestoner/commits/enrichers/review.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit review based on trailer information.
+      class Review
+        include Milestoner::Import[:input]
+
+        def initialize(model: Models::Link, **)
+          @model = model
+          super(**)
+        end
+
+        def call(*) = model[id: "All", uri: format(input.review_uri, id: nil)]
+
+        private
+
+        attr_reader :model
+      end
+    end
+  end
+end