milestoner 17.11.0 → 18.0.0

data/lib/milestoner/builders/web.rb

@@ -4,39 +4,69 @@ require "refinements/pathname"
 
 module Milestoner
   module Builders
-    # Builds web page output (i.e. HTML and CSS).
+    # Builds web output (i.e. HTML and CSS).
     class Web
-      include Milestoner::Import[:input]
+      include Milestoner::Import[:settings, :logger]
 
       using Refinements::Pathname
 
-      def initialize(view: Views::Milestones::Show.new, enricher: Commits::Enricher.new, **)
+      def initialize(tagger: Commits::Tagger.new, view: Views::Milestones::Show.new, **)
+        @tagger = tagger
         @view = view
-        @enricher = enricher
         super(**)
       end
 
       def call
-        input.build_root.tap do |path|
-          stylesheet_path.copy path.make_path.join("page.css")
-          write path
-        end
+        settings.build_root.make_path
+        copy_stylesheet
+
+        tagger.call
+              .fmap { |tags| build tags }
+              .alt_map { |message| failure message }
       end
 
       private
 
-      attr_reader :view, :enricher
+      attr_reader :tagger, :view
+
+      def build tags
+        tags.each { |tag| write tag }
+        settings.build_root
+      end
+
+      def copy_stylesheet
+        return unless settings.build_stylesheet
+
+        stylesheet_template.copy stylesheet_path
+        logger.info { "Built: #{stylesheet_path}." }
+      end
+
+      def stylesheet_template
+        settings.build_template_paths
+                .map { |path| path.join "public/page.css.erb" }
+                .find(&:exist?)
+                .copy settings.build_root.make_path.join stylesheet_path
+      end
 
       def stylesheet_path
-        input.build_template_paths
-             .map { |path| path.join "public/page.css.erb" }
-             .find(&:exist?)
+        settings.build_root.join "#{Pathname(settings.build_stylesheet).name}.css"
+      end
+
+      def write tag
+        path = make_path tag
+
+        path.write view.call(tag:, layout: settings.build_layout)
+        logger.info { "Built: #{path}." }
+      end
+
+      def make_path tag
+        version = settings.build_max == 1 ? "" : tag.version
+        settings.build_root.join(version, settings.build_basename).make_ancestors.sub_ext ".html"
       end
 
-      def write path
-        enricher.call.fmap do |commits|
-          path.join("index.html").write view.call commits:, layout: input.build_layout
-        end
+      def failure message
+        logger.error { message }
+        message
       end
     end
   end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Build
+        # Handles output path.
+        class Basename < Sod::Action
+          include Import[:settings]
+
+          description "Set basename."
+
+          ancillary "The file extension is dynamically calculated from format."
+
+          on %w[-b --basename], argument: "[NAME]"
+
+          default { Container[:settings].build_basename }
+
+          def call(name = nil) = settings.build_basename = name || default
+        end
+      end
+    end
+  end
+end

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

@@ -8,15 +8,15 @@ module Milestoner
       module Build
         # Handles build output format.
         class Format < Sod::Action
-          include Import[:input]
+          include Import[:settings]
 
           description "Set output format."
 
-          on %w[-f --format], argument: "[KIND]", allow: %w[ascii_doc markdown stream web]
+          on %w[-f --format], argument: "[KIND]", allow: %w[ascii_doc feed markdown stream web]
 
-          default { Container[:configuration].build_format }
+          default { Container[:settings].build_format }
 
-          def call(kind = nil) = input.build_format = kind || default
+          def call(kind = nil) = settings.build_format = kind || default
         end
       end
     end

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

@@ -8,15 +8,15 @@ module Milestoner
       module Build
         # Handles build label.
         class Label < Sod::Action
-          include Import[:input]
+          include Import[:settings]
 
           description "Set label."
 
           on %w[-l --label], argument: "[TEXT]"
 
-          default { Container[:configuration].project_label }
+          default { Container[:settings].project_label }
 
-          def call(label = nil) = input.project_label = label || default
+          def call(label = nil) = settings.project_label = label || default
         end
       end
     end

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

@@ -8,7 +8,7 @@ module Milestoner
       module Build
         # Handles build layout.
         class Layout < Sod::Action
-          include Import[:input]
+          include Import[:settings]
 
           description "Set view template layout."
 
@@ -16,9 +16,9 @@ module Milestoner
 
           on %w[-L --layout], argument: "[NAME]"
 
-          default { Container[:configuration].build_layout }
+          default { Container[:settings].build_layout }
 
-          def call(layout = nil) = input.build_layout = parse(layout)
+          def call(layout = nil) = settings.build_layout = parse(layout)
 
           private
 

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Build
+        # Handles build maximum.
+        class Max < Sod::Action
+          include Import[:settings]
+
+          description "Set maximum number of tags to process."
+
+          on %w[-m --max], argument: "[NUMBER]", type: Integer
+
+          default { Container[:settings].build_max }
+
+          def call(max = nil) = settings.build_max = max || default
+        end
+      end
+    end
+  end
+end

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

@@ -9,15 +9,15 @@ module Milestoner
       module Build
         # Handles build root path.
         class Root < Sod::Action
-          include Import[:input]
+          include Import[:settings]
 
           description "Set root output path."
 
           on %w[-r --root], argument: "[PATH]"
 
-          default { Container[:configuration].build_root }
+          default { Container[:settings].build_root }
 
-          def call(path = nil) = input.build_root = Pathname(path || default).expand_path
+          def call(path = nil) = settings.build_root = Pathname(path || default).expand_path
         end
       end
     end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Build
+        # Handles build stylesheet.
+        class Stylesheet < Sod::Action
+          include Import[:settings]
+
+          description "Set stylesheet file name or relative path."
+
+          ancillary "Only used by web format. Use false to disable."
+
+          on %w[-s --stylesheet], argument: "[NAME]"
+
+          default { Container[:settings].build_stylesheet }
+
+          def call(name = nil) = settings.build_stylesheet = parse(name)
+
+          private
+
+          def parse value
+            case value
+              in "false" then false
+              in String then value
+              else default
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Build
+        # Handles build tail.
+        class Tail < Sod::Action
+          include Import[:settings]
+
+          description "Set tail reference."
+
+          ancillary "Defines the Git reference at which to cap the build."
+
+          on %w[-t --tail], argument: "[REFERENCE]", allow: %w[head tag]
+
+          default { Container[:settings].build_tail }
+
+          def call(reference = nil) = settings.build_tail = reference || default
+        end
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module Milestoner
       module Build
         # Handles build version.
         class Version < Sod::Action
-          include Import[:input]
+          include Import[:settings, :logger]
 
           using Versionaire::Cast
 
@@ -19,9 +19,13 @@ module Milestoner
 
           on %w[-v --version], argument: "[VERSION]"
 
-          default { Container[:configuration].project_version }
+          default { Container[:settings].project_version }
 
-          def call(version = nil) = input.project_version = Version(version || default)
+          def call version = nil
+            settings.project_version = Version(version || default)
+          rescue Versionaire::Error => error
+            logger.error { error.message }
+          end
         end
       end
     end

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

@@ -8,7 +8,7 @@ module Milestoner
       module Cache
         # Handles deleting a user from the cache.
         class Delete < Sod::Action
-          include Import[:kernel, :logger, client: :cache]
+          include Import[:logger, client: :cache]
 
           description "Delete user."
 

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

@@ -8,7 +8,7 @@ module Milestoner
       module Cache
         # Handles finding a user in the cache.
         class Find < Sod::Action
-          include Import[:kernel, :logger, client: :cache]
+          include Import[:logger, :io, client: :cache]
 
           description "Find user."
 
@@ -21,7 +21,7 @@ module Milestoner
 
           private
 
-          def success(user) = kernel.puts user.to_h.values.join(", ")
+          def success(user) = io.puts user.to_h.values.join(", ")
 
           def failure(message) = logger.abort message
         end

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

@@ -8,7 +8,7 @@ module Milestoner
       module Cache
         # Handles cache information.
         class Info < Sod::Action
-          include Import[:kernel, :logger, client: :cache]
+          include Import[:logger, client: :cache]
 
           description "Show information."
 

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

@@ -8,7 +8,7 @@ module Milestoner
       module Cache
         # Handles listing users within the cache.
         class List < Sod::Action
-          include Import[:kernel, :logger, client: :cache]
+          include Import[:logger, :io, client: :cache]
 
           description "List users."
 
@@ -24,7 +24,7 @@ module Milestoner
           def print users
             return logger.info { "No users found." } if users.empty?
 
-            users.each { |user| kernel.puts user.to_h.values.join ", " }
+            users.each { |user| io.puts user.to_h.values.join ", " }
           end
         end
       end

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

@@ -7,7 +7,7 @@ module Milestoner
     module Actions
       # Handles calculation of next version.
       class Next < Sod::Action
-        include Import[:configuration, :kernel]
+        include Import[:settings, :io]
 
         description "Show next version."
 
@@ -15,7 +15,7 @@ module Milestoner
 
         on %w[-n --next]
 
-        def call(*) = kernel.puts configuration.project_version
+        def call(*) = io.puts settings.project_version
       end
     end
   end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "dry/monads"
 require "sod"
 require "versionaire"
 
@@ -8,28 +9,42 @@ module Milestoner
     module Actions
       # Handles tag creation and pushing of tag to local repository.
       class Publish < Sod::Action
-        include Import[:configuration]
+        include Import[:settings, :logger]
+        include Dry::Monads[:result]
 
         using Versionaire::Cast
 
         description "Publish milestone."
 
-        ancillary "Build, commit, tag, and push to remote repository."
+        ancillary "Tag and push to remote repository."
 
         on %w[-p --publish], argument: "[VERSION]"
 
-        default { Container[:configuration].project_version }
+        default { Container[:settings].project_version }
 
         def initialize(publisher: Tags::Publisher.new, **)
           super(**)
           @publisher = publisher
         end
 
-        def call(version = nil) = publisher.call Version(version || default)
+        def call version = nil
+          case publisher.call Version(version || default)
+            in Success(version) then version
+            in Failure(message) then log_error message
+            else log_error "Publish failed, unable to parse result."
+          end
+        rescue Versionaire::Error => error
+          log_error error.message
+        end
 
         private
 
         attr_reader :publisher
+
+        def log_error message
+          logger.error { message }
+          message
+        end
       end
     end
   end

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

@@ -5,33 +5,34 @@ require "sod"
 module Milestoner
   module CLI
     module Commands
-      # Handles the building of milestone output.
+      # Handles the building of different milestone formats.
       class Build < Sod::Command
-        include Import[:input, :logger, :kernel]
-        include Builders::Import[:ascii_doc, :markdown, :stream, :web]
+        include Import[:settings, :logger, :io]
+        include Builders::Import[:ascii_doc, :feed, :markdown, :stream, :web]
 
         handle "build"
 
         description "Build milestone."
 
+        on Actions::Build::Basename
+        on Actions::Build::Format
         on Actions::Build::Label
-        on Actions::Build::Version
         on Actions::Build::Layout
-        on Actions::Build::Format
+        on Actions::Build::Max
         on Actions::Build::Root
+        on Actions::Build::Stylesheet
+        on Actions::Build::Tail
+        on Actions::Build::Version
 
-        # :reek:TooManyStatements
         def call
-          format = input.build_format
+          format = settings.build_format
 
-          log_info "Building #{input.project_label} milestone (#{format})..."
+          log_info "Building #{settings.project_label} (#{format})..."
 
-          case format
-            when "ascii_doc" then build_ascii_doc
-            when "markdown" then build_markdown
-            when "stream" then build_stream
-            when "web" then build_web
-            else logger.abort "Invalid build format: #{format}."
+          if infused_keys.include? format.to_sym
+            __send__(format).call
+          else
+            logger.abort "Invalid build format: #{format}."
           end
         end
 
@@ -39,17 +40,6 @@ module Milestoner
 
         attr_reader :view, :enricher
 
-        def build_ascii_doc = log_info("Milestone built: #{ascii_doc.call}.")
-
-        def build_markdown = log_info("Milestone built: #{markdown.call}.")
-
-        def build_stream
-          kernel.puts
-          stream.call
-        end
-
-        def build_web = log_info "Milestone built: #{web.call}."
-
         def log_info(message) = logger.info { message }
       end
     end

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

@@ -7,7 +7,7 @@ module Milestoner
     module Commands
       # Handles the building of milestone output.
       class Cache < Sod::Command
-        include Import[:input, :logger]
+        include Import[:settings, :logger]
 
         handle "cache"
 

data/lib/milestoner/commits/categorizer.rb

@@ -7,7 +7,7 @@ module Milestoner
   module Commits
     # Retrieves and categorizes Git repository commit tagged or untagged history.
     class Categorizer
-      include Import[:git, :input]
+      include Import[:settings]
 
       using Refinements::Array
 
@@ -15,7 +15,7 @@ module Milestoner
         @collector = collector
         super(**)
 
-        @labels = input.commit_categories.pluck :label
+        @labels = settings.commit_categories.pluck :label
         @pattern = labels.empty? ? // : Regexp.union(labels)
       end
 

data/lib/milestoner/commits/enricher.rb

@@ -6,7 +6,7 @@ module Milestoner
   module Commits
     # Enriches commits and associated trailers for final processing.
     class Enricher
-      include Import[:input]
+      include Import[:settings]
 
       include Enrichers::Import[
         :author,

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

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

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

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

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

@@ -5,7 +5,7 @@ module Milestoner
     module Enrichers
       # Enriches a commit issue based on trailer information.
       class Issue
-        include Milestoner::Import[:input]
+        include Milestoner::Import[:settings]
 
         def initialize(key: "Issue", model: Models::Link, **)
           @key = key
@@ -14,7 +14,7 @@ module Milestoner
         end
 
         def call commit
-          uri = input.tracker_uri
+          uri = settings.tracker_uri
 
           commit.trailer_value_for(key)
                 .either -> value { model[id: value, uri: format(uri, id: value)] },

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

@@ -5,7 +5,7 @@ module Milestoner
     module Enrichers
       # Enriches a commit milestone based on trailer information.
       class Milestone
-        include Milestoner::Import[:input]
+        include Milestoner::Import[:settings]
 
         def initialize(key: "Milestone", default: "unknown", **)
           @key = key

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

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

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

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

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

@@ -5,9 +5,9 @@ module Milestoner
     module Enrichers
       # Enriches a commit URI based on trailer information.
       class URI
-        include Milestoner::Import[:input]
+        include Milestoner::Import[:settings]
 
-        def call(commit) = format input.commit_uri, id: commit.sha
+        def call(commit) = format settings.commit_uri, id: commit.sha
       end
     end
   end