milestoner 18.12.0 → 19.1.0

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[:settings, :io]
+        include Dependencies[:settings, :io]
 
         description "Show next version."
 

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

@@ -9,7 +9,7 @@ module Milestoner
     module Actions
       # Handles tag creation and pushing of tag to local repository.
       class Publish < Sod::Action
-        include Import[:settings, :logger]
+        include Dependencies[:settings, :logger]
         include Dry::Monads[:result]
 
         using Versionaire::Cast

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

@@ -7,8 +7,8 @@ module Milestoner
     module Commands
       # Handles the building of different milestone formats.
       class Build < Sod::Command
-        include Import[:settings, :logger, :io]
-        include Builders::Import[:ascii_doc, :feed, :markdown, :stream, :web]
+        include Dependencies[:settings, :logger, :io]
+        include Builders::Dependencies[:ascii_doc, :feed, :markdown, :stream, :web]
 
         handle "build"
 
@@ -16,10 +16,11 @@ module Milestoner
 
         on Actions::Build::Basename
         on Actions::Build::Format
+        on Actions::Build::Index
         on Actions::Build::Label
         on Actions::Build::Layout
         on Actions::Build::Max
-        on Actions::Build::Root
+        on Actions::Build::Output
         on Actions::Build::Stylesheet
         on Actions::Build::Tail
         on Actions::Build::Version
@@ -38,8 +39,6 @@ module Milestoner
 
         private
 
-        attr_reader :view, :enricher
-
         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[:settings, :logger]
+        include Dependencies[:settings, :logger]
 
         handle "cache"
 

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, :specification, xdg_config: "xdg.config"]
+      include Dependencies[:defaults_path, :specification, xdg_config: "xdg.config"]
 
       def initialize(context: Sod::Context, dsl: Sod, **)
         super(**)

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[:settings]
+      include Dependencies[:settings]
 
       using Refinements::Array
 
@@ -19,10 +19,11 @@ module Milestoner
         @pattern = labels.empty? ? // : Regexp.union(labels)
       end
 
+      # :reek:NestedIterators
       def call min: Collector::MIN, max: Collector::MAX
-        collect(min, max).each_value { |commits| commits.sort_by!(&:subject) }
+        collect(min, max).each_value { |commits| commits.sort_by! { |_, commit| commit.subject } }
                          .values
-                         .flatten
+                         .reduce(&:concat)
       end
 
       private
@@ -33,10 +34,11 @@ module Milestoner
         collector.call(min:, max:)
                  .value_or(Core::EMPTY_ARRAY)
                  .each
-                 .with_object categories do |commit, collection|
+                 .with_index(1)
+                 .with_object categories do |(commit, position), collection|
                    category = commit.subject[pattern]
                    key = collection.key?(category) ? category : "Unknown"
-                   collection[key] << commit
+                   collection[key] << [position, commit]
                  end
       end
 

data/lib/milestoner/commits/collector.rb

@@ -7,7 +7,7 @@ module Milestoner
     # Collects commits since last tag, a specific range, or all commits if untagged.
     class Collector
       include Dry::Monads[:result]
-      include Import[:git]
+      include Dependencies[:git]
 
       MIN = :last
       MAX = :HEAD

data/lib/milestoner/commits/enricher.rb

@@ -6,17 +6,17 @@ module Milestoner
   module Commits
     # Enriches commits and associated trailers for final processing.
     class Enricher
-      include Import[:settings]
+      include Dependencies[:settings]
 
-      include Enrichers::Import[
+      include Enrichers::Dependencies[
         :author,
-        :body,
+        :body_html,
         :collaborators,
         :created_at,
         :format,
         :issue,
         :milestone,
-        :notes,
+        :notes_html,
         :review,
         :signers,
         :updated_at,
@@ -33,7 +33,7 @@ module Milestoner
 
       def call min: Collector::MIN, max: Collector::MAX
         categorizer.call(min:, max:)
-                   .map { |commit| model.for(commit, **build_attributes(commit)) }
+                   .map { |(position, commit)| build_record position, commit }
                    .then { |commits| Success commits }
       end
 
@@ -41,6 +41,8 @@ module Milestoner
 
       attr_reader :categorizer, :model
 
+      def build_record(position, commit) = model.for commit, position:, **build_attributes(commit)
+
       def build_attributes commit
         infused_keys.each.with_object({}) do |key, attributes|
           attributes[key] = __send__(key).call commit

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

@@ -5,7 +5,7 @@ module Milestoner
     module Enrichers
       # Enriches a commit author by using cache.
       class Author
-        include Milestoner::Import[:cache]
+        include Milestoner::Dependencies[:cache]
 
         def initialize(model: Models::User, **)
           super(**)

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[:settings]
+        include Milestoner::Dependencies[:settings]
 
         def initialize(key: "Format", renderer: Renderers::Universal.new, **)
           super(**)

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

@@ -7,7 +7,7 @@ module Milestoner
     module Enrichers
       # Enriches a commit colleague by using cache.
       class Colleague
-        include Milestoner::Import[:cache]
+        include Milestoner::Dependencies[:cache]
 
         def initialize(key:, parser: Gitt::Parsers::Person.new, **)
           super(**)

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

@@ -10,13 +10,13 @@ module Milestoner
         extend Containable
 
         register(:author) { Author.new }
-        register(:body) { Body.new }
+        register(:body_html) { Body.new }
         register(:collaborators) { Colleague.new key: "Co-authored-by" }
         register(:created_at) { Time.new key: :authored_at }
         register(:format) { Format.new }
         register(:issue) { Issue.new }
         register(:milestone) { Milestone.new }
-        register(:notes) { Note.new }
+        register(:notes_html) { Note.new }
         register(:review) { Review.new }
         register(:signers) { Colleague.new key: "Signed-off-by" }
         register(:updated_at) { Time.new key: :committed_at }

data/lib/milestoner/commits/enrichers/{import.rb → dependencies.rb}

@@ -5,7 +5,7 @@ require "infusible"
 module Milestoner
   module Commits
     module Enrichers
-      Import = Infusible[Container]
+      Dependencies = Infusible[Container]
     end
   end
 end

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

@@ -5,7 +5,7 @@ module Milestoner
     module Enrichers
       # Enriches a commit format based on trailer information.
       class Format
-        include Milestoner::Import[:settings]
+        include Milestoner::Dependencies[:settings]
 
         def initialize(key: "Format", **)
           super(**)

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[:settings]
+        include Milestoner::Dependencies[:settings]
 
         def initialize(key: "Issue", model: Models::Link, **)
           super(**)

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[:settings]
+        include Milestoner::Dependencies[:settings]
 
         def initialize(key: "Milestone", default: "unknown", **)
           super(**)

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[:settings]
+        include Milestoner::Dependencies[:settings]
 
         def initialize(key: "Format", renderer: Renderers::Universal.new, **)
           super(**)

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

@@ -5,7 +5,7 @@ module Milestoner
     module Enrichers
       # Enriches a commit review based on trailer information.
       class Review
-        include Milestoner::Import[:settings]
+        include Milestoner::Dependencies[:settings]
 
         def initialize(model: Models::Link, **)
           super(**)

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

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

data/lib/milestoner/commits/versioner.rb

@@ -8,7 +8,7 @@ module Milestoner
   module Commits
     # Calculates next version based on commit trailer version keys.
     class Versioner
-      include Import[:git, :logger]
+      include Dependencies[:git, :logger]
       include Dry::Monads[:result]
 
       using Versionaire::Cast

data/lib/milestoner/configuration/contract.rb

@@ -11,10 +11,11 @@ module Milestoner
       required(:avatar_uri).filled :string
       required(:build_basename).filled :string
       required(:build_format).filled :string
+      required(:build_index).filled :bool
       required(:build_layout) { str? | bool? }
       required(:build_max).filled :integer
-      required(:build_root).filled Etcher::Types::Pathname
-      required(:build_stylesheet) { bool? | str? }
+      required(:build_output).filled Etcher::Types::Pathname
+      required(:build_stylesheet).filled :bool
       required(:build_tail).filled :string
       required(:build_template_paths).array Etcher::Types::Pathname
 
@@ -43,6 +44,8 @@ module Milestoner
       required(:project_uri_version).filled :string
       required(:project_version).filled Etcher::Types::Version
       required(:review_uri).filled :string
+      required(:stylesheet_path).filled :string
+      required(:stylesheet_uri).filled :string
 
       required(:syndication_categories).array(:hash) do
         required(:label).filled :string
@@ -61,6 +64,7 @@ module Milestoner
         required(:uri).filled :string
       end
 
+      required(:tag_subject).filled :string
       required(:tracker_uri).filled :string
     end
   end

data/lib/milestoner/configuration/defaults.yml

@@ -3,19 +3,20 @@ avatar:
 build:
   basename: "index"
   format: "stream"
+  index: true
   layout: "page"
   max: 1
-  root: "tmp/milestones"
-  stylesheet: "page"
+  output: "tmp/milestones"
+  stylesheet: true
   tail: "head"
 commit:
   categories:
-    - emoji: "✅"
-      label: "Fixed"
     - emoji: "🟢"
       label: "Added"
     - emoji: "🔼"
       label: "Updated"
+    - emoji: "✅"
+      label: "Fixed"
     - emoji: "⛔️"
       label: "Removed"
     - emoji: "🔁"
@@ -34,6 +35,9 @@ project:
     version: "%<project_uri_home>s/versions/%<id>s"
 review:
   uri: "https://github.com/%<project_owner>s/%<project_name>s/pulls/%<id>s"
+stylesheet:
+  path: "page.css"
+  uri: "../page"
 syndication:
   categories:
     - label: "Milestones"
@@ -52,5 +56,7 @@ syndication:
       mime: "application/atom+xml"
       relation: "self"
       uri: "%<project_uri_home>s/versions.xml"
+tag:
+  subject: "Version %<project_version>s"
 tracker:
   uri: "https://github.com/%<project_owner>s/%<project_name>s/issues/%<id>s"

data/lib/milestoner/configuration/model.rb

@@ -6,9 +6,10 @@ module Milestoner
     Model = Struct.new :avatar_uri,
                        :build_basename,
                        :build_format,
+                       :build_index,
                        :build_layout,
                        :build_max,
-                       :build_root,
+                       :build_output,
                        :build_stylesheet,
                        :build_tail,
                        :build_template_paths,
@@ -33,12 +34,15 @@ module Milestoner
                        :project_uri_version,
                        :project_version,
                        :review_uri,
+                       :stylesheet_path,
+                       :stylesheet_uri,
                        :syndication_categories,
                        :syndication_entry_label,
                        :syndication_entry_uri,
                        :syndication_id,
                        :syndication_label,
                        :syndication_links,
+                       :tag_subject,
                        :tracker_uri
   end
 end

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

@@ -9,7 +9,7 @@ module Milestoner
       module Gems
         # Conditionally updates project description based on specification summary.
         class Description
-          include Import[:spec_loader]
+          include Dependencies[:spec_loader]
           include Dry::Monads[:result]
 
           def initialize(key = :project_description, path: "#{Pathname.pwd.basename}.gemspec", **)

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

@@ -9,7 +9,7 @@ module Milestoner
       module Gems
         # Conditionally updates project label based on specification label.
         class Label
-          include Import[:spec_loader]
+          include Dependencies[:spec_loader]
           include Dry::Monads[:result]
 
           def initialize(key = :project_label, path: "#{Pathname.pwd.basename}.gemspec", **)
@@ -21,7 +21,7 @@ module Milestoner
           def call attributes
             attributes.fetch key do
               value = spec_loader.call(path).label
-              attributes.merge! key => value unless value == "Undefined"
+              attributes.merge! key => value unless value.empty?
             end
 
             Success attributes

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

@@ -9,7 +9,7 @@ module Milestoner
       module Gems
         # Conditionally updates project name based on specification name.
         class Name
-          include Import[:spec_loader]
+          include Dependencies[:spec_loader]
           include Dry::Monads[:result]
 
           def initialize(key = :project_name, path: "#{Pathname.pwd.basename}.gemspec", **)

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

@@ -9,7 +9,7 @@ module Milestoner
       module Gems
         # Conditionally updates project URI based on specification home page URL.
         class URI
-          include Import[:spec_loader]
+          include Dependencies[:spec_loader]
           include Dry::Monads[:result]
 
           def initialize(key = :project_uri, path: "#{Pathname.pwd.basename}.gemspec", **)

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

@@ -8,7 +8,7 @@ module Milestoner
       module Generator
         # Conditionally updates generator label based on gem specification.
         class Label
-          include Import[:specification]
+          include Dependencies[:specification]
           include Dry::Monads[:result]
 
           def initialize(key = :generator_label, **)

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

@@ -8,7 +8,7 @@ module Milestoner
       module Generator
         # Conditionally updates generator URI based on gem specification.
         class URI
-          include Import[:specification]
+          include Dependencies[:specification]
           include Dry::Monads[:result]
 
           def initialize(key = :generator_uri, **)

data/lib/milestoner/configuration/transformers/generator/version.rb

@@ -8,7 +8,7 @@ module Milestoner
       module Generator
         # Conditionally updates generator version based on gem specification.
         class Version
-          include Import[:specification]
+          include Dependencies[:specification]
           include Dry::Monads[:result]
 
           def initialize(key = :generator_version, **)

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

@@ -8,7 +8,7 @@ module Milestoner
       module Project
         # Conditionally updates author based on Git user.
         class Author
-          include Import[:git]
+          include Dependencies[:git]
           include Dry::Monads[:result]
 
           def initialize(key = :project_author, **)

data/lib/milestoner/container.rb

@@ -28,11 +28,11 @@ module Milestoner
       end
     end
 
-    register :registry do
+    register :registry, as: :fresh do
       Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
                       .add_loader(:yaml, self[:defaults_path])
                       .add_loader(:yaml, self["xdg.config"].active)
-                      .add_transformer(Configuration::Transformers::Build::Root)
+                      .add_transformer(:root, :build_output)
                       .add_transformer(Configuration::Transformers::Build::TemplatePaths.new)
                       .add_transformer(Configuration::Transformers::Gems::Label.new)
                       .add_transformer(Configuration::Transformers::Gems::Description.new)
@@ -70,6 +70,7 @@ module Milestoner
     register(:git) { Gitt::Repository.new }
     register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
     register(:color) { Tone.new }
+    register :durationer, Durationer
     register(:logger) { Cogger.new id: :milestoner }
     register :io, STDOUT
   end

data/lib/milestoner/{import.rb → dependencies.rb}

@@ -3,5 +3,5 @@
 require "infusible"
 
 module Milestoner
-  Import = Infusible[Container]
+  Dependencies = Infusible[Container]
 end

data/lib/milestoner/durationer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/array"
+require "refinements/string"
+
+# Computes duration (in seconds) into human readable days, hours, minutes, and seconds.
+module Milestoner
+  using Refinements::Array
+  using Refinements::String
+
+  DURATION_UNITS = {"second" => 60, "minute" => 60, "hour" => 24, "day" => 86_400}.freeze
+
+  Durationer = lambda do |seconds, units: DURATION_UNITS|
+    result = units.map do |unit, value|
+      next unless seconds.positive?
+
+      seconds, number = seconds.divmod value
+      number = number.to_i
+
+      %(#{number} #{unit.pluralize "s", number}) if number.nonzero?
+    end
+
+    result.compact.reverse.to_sentence
+  end
+end

data/lib/milestoner/models/commit.rb

@@ -8,7 +8,6 @@ module Milestoner
       authored_at
       authored_relative_at
       body
-      body_lines
       committed_at
       committed_relative_at
       deletions
@@ -25,11 +24,13 @@ module Milestoner
 
     COMMIT_ENRICHED_ATTRIBUTES = %i[
       author
+      body_html
       collaborators
       created_at
       format
       issue
       milestone
+      notes_html
       position
       review
       signers

data/lib/milestoner/renderers/universal.rb

@@ -6,7 +6,7 @@ module Milestoner
   module Renderers
     # The primary renderer for multiple input formats as HTML.
     class Universal
-      include Import[:settings]
+      include Dependencies[:settings]
 
       using Refinements::Binding
 

data/lib/milestoner/tags/builder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Tags
+    # Builds tag message.
+    class Builder
+      include Milestoner::Dependencies[:settings, :logger]
+
+      def initialize(enricher: Enricher.new, view: Views::Milestones::Show.new, **)
+        super(**)
+        @enricher = enricher
+        @view = view
+      end
+
+      def call version
+        force_minimum
+
+        enricher.call
+                .fmap { |tags| render tags.first, version }
+                .alt_map { |message| failure message }
+      end
+
+      private
+
+      attr_reader :enricher, :view
+
+      def force_minimum = settings.build_max = 1
+
+      def render tag, version
+        tag.version = version
+        view.call(tag:, layout: settings.build_layout, format: :git).to_s.lstrip
+      end
+
+      def failure message
+        logger.error { message }
+        message
+      end
+    end
+  end
+end

data/lib/milestoner/tags/creator.rb

@@ -7,17 +7,13 @@ module Milestoner
   module Tags
     # Handles the creation of project repository tags.
     class Creator
-      include Import[:git, :logger]
+      include Dependencies[:settings, :git, :logger]
       include Dry::Monads[:result]
 
-      def initialize(
-        collector: Commits::Collector.new,
-        builder: Builders::Stream.new(io: StringIO.new),
-        **
-      )
+      def initialize(collector: Commits::Collector.new, builder: Builder.new, **)
+        super(**)
         @collector = collector
         @builder = builder
-        super(**)
       end
 
       def call version
@@ -41,9 +37,11 @@ module Milestoner
 
       def collect = collector.call.alt_map { |message| message.sub("fatal: y", "Y").sub("\n", ".") }
 
-      def create(version) = build(version).bind { |body| git.tag_create version, body }
+      def create version
+        builder.call(version).bind { |body| git.tag_create version, "#{subject}\n\n#{body}\n\n" }
+      end
 
-      def build(version) = builder.call.fmap { |body| "Version #{version}\n\n#{body}\n\n" }
+      def subject = format(settings.tag_subject, **settings.to_h)
     end
   end
 end