milestoner 18.12.0 → 19.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9ed4141a024a3afb6dd224f6d8f6e52db2c189bfc7ff121d39d29bf0423abb9
-  data.tar.gz: 966e8a280416c847a955b4ed3f674c42ea1ccebe7b8a1c8e8a48012df5743c26
+  metadata.gz: cb9c88f85ee84022276a2ef4f5ebb9a4c1f6cd63551fb7e67ae485b625330441
+  data.tar.gz: 0ae364c293ad1b41cd5176fc072d063c6d07e8cc43e9d4b68bd74a6b054d66b9
 SHA512:
-  metadata.gz: '04963da39631d44ed1617b4e341c846a270359002cd2ab1b4728e2fce374fc0f96ea335bba338d0f005a07cb07ad2f5fd69864a901652d8418d0ab42c78d990d'
-  data.tar.gz: 9c8a92faff3f870ccf7ba95bb2d5bf889273952465ed4ce6931c9386c578e50f042651bbc853acfc20d6fdc1dddf553e67ffa66d356eb0199434cd68d5a9c11a
+  metadata.gz: 7158fa4011bcb552f0f812c9018263125d82181c0cfe2db6b552ec073c68a1943d9755d251f9b755edcca37c8d987feef8f12fb94c7d5912704cf5dbd13b4e4a
+  data.tar.gz: b8f252c5994c5e7b14949016a6a3ad8a41ac1ea71edad6477bc0a4afa07a0c5dd93623a041d8fd51593e99b514e844cab35df85d4d5ef187bbf5790295335aaf

data/README.adoc

@@ -56,41 +56,41 @@ The following are screenshots of using this gem to render release notes for the
 
 === ASCII Doc
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc-collapsed.png[Release Notes,width=1160,height=831,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc-collapsed.png[Release Notes,width=924,height=1224,role=focal_point]
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc-expanded.png[Release Notes,width=1160,height=1335,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-ascii_doc-expanded.png[Release Notes,width=924,height=1552,role=focal_point]
 
 * *Command*: `milestoner build --format ascii_doc`
 * *Renderer*: {ascii_doc_link}
 
 === Feed
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-collapsed.png[Release Notes,width=1275,height=954,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-collapsed.png[Release Notes,width=1450,height=972,role=focal_point]
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-expanded.png[Release Notes,width=1275,height=1613,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-feed-expanded.png[Release Notes,width=1350,height=1731,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.png[Release Notes,width=796,height=703,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-markdown.png[Release Notes,width=967,height=919,role=focal_point]
 
 * *Command*: `milestoner build --format markdown`
 * *Renderer*: {marked_link}
 
 === Stream
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-stream.png[Release Notes,width=566,height=320,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-stream.png[Release Notes,width=1001,height=407,role=focal_point]
 
 * *Command*: `milestoner build --format stream`
 * *Renderer*: {iterm_link}
 
 === Web
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-collapsed.png[Release Notes,width=1296,height=647,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-collapsed.png[Release Notes,width=1323,height=1048,role=focal_point]
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-expanded.png[Release Notes,width=1296,height=1032,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/build-web-expanded.png[Release Notes,width=1323,height=1540,role=focal_point]
 
 * *Command*: `milestoner build --format web`
 * *Renderer*: {firefox_link}
@@ -102,9 +102,9 @@ 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/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/fixed.png[Fixed] Fixed
 ** 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.
@@ -169,19 +169,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: "🔁"
@@ -200,6 +201,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"
@@ -218,6 +222,8 @@ 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"
 ----
@@ -229,10 +235,11 @@ The above can be customized as follows:
 * `build`: Manages build details.
 ** `basename`: Required. The build file basename. Default: `index`. Used to customize the built file name.
 ** `format`: Required. The build output format. Default: `stream`. Used to determine what format to build the release notes as. Multiple formats are supported.
+** `index`: Required. Enables (or disables) building the versions index page for web format only. Default: true.
 ** `layout`: Required. The {hanami_views_link} layout used when building release notes. Default: page. This can be disabled when using `false` or customized further -- via your own {xdg_link} configuration -- when providing your own templates and/or partials.
 ** `max`: Required. The maximum number of {git_link} tags to build. Default: 1. By default, you are limited to building release notes for changes (commits) since the last tag but you can increase the maximum to build release notes for as many tags as you like.
-** `root`: Required. The the root build directory. Default: `tmp/milestones`. This can be a relative or absolute path and defaults your current project. The path is automatically created if missing.
-** `stylesheet`: Required. The stylesheet basename which is only used by the _web_ format. Default: `page`. This can be a relative path (i.e. `../page`) which is especially handy when build `max` is set to a number greater than one so the release notes for each tag you build loads the stylesheet properly. The path is automatically created if missing.
+** `output`: Required. The the directory for all generated output. Default: `tmp/milestones`. This can be a relative or absolute path and defaults to the current working directory. The path is automatically created if missing.
+** `stylesheet`: Required. Enables (or disables) building the stylesheet for web format only. Default: true.
 * `commit`: Manages commit categories, emojis, hyperlinks, and formatting.
 ** `categories`: Required. Defaults to five categories 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: []`.
 *** `emoji`: Required. The emoji associated with the label for output purposes. _Used by the {ascii_doc_link}, {markdown_link}, and stream build formats_. Defaults to the provided emojis.
@@ -263,6 +270,9 @@ The above can be customized as follows:
 ** `version`: Required. The project version. Dynamically calculated based on the last {git_link} tag of your project and {git_link} `Milestone` commit trailer metadata. The default is: `0.0.0`. For more on this see, the _Automatic Versioning_ section below. You can configure a value but is _not recommended_ since any custom value you supply will be used for _all_ deployments and release notes. You're better off letting this gem compute this for you.
 * `review`: Manages code review details.
 ** `uri`: Required. The URI format for linking to code reviews as formatted using {string_formats_link}. Default: GitHub. The `id` is currently a _placeholder_ for future feature support when API support is added. For now this links to _all_ code reviews with the goal to link to individual code reviews based on {git_trailers_link}.
+* `stylesheet`: Manages stylesheet configuration for `web` build format.
+** `path`: Required. The relative (or absolute) path to where the stylesheet is built. Default: `page.css`. The path is automatically created if non-existing. A relative path is always relative to the build root as configured above.
+** `uri`: Required. The relative (or absolute) path for linking to the stylesheet within the page layout. Default: "../page".
 * `syndication`: Manages syndicated feed details when used with the `feed` build format.
 ** `categories`: Required. Manages category details.
 *** `label`: Required. The category label. Default: Milestones.
@@ -277,6 +287,8 @@ The above can be customized as follows:
 *** `mime`: Required. The mime type. Defaults to HTML and XML.
 *** `relation`: Required. Identifies the relation of the link which can either be `self` (i.e. XML) or `alternate` (i.e. HTML).
 *** `uri`: Required. The link URI to follow for more information. Defaults to dynamic string formatting based on existing configuration values.
+* `tag`: Required. Manages tag creation.
+** `subject`: Required. The tag subject. Default: `+Version %<project_version>s+`. Example: "Version 1.2.3". You can use a string literal or include any configuration key for a dynamic subject. In the case of `project_version` this is calculated at runtime.
 * `tracker`: Required. Manages issue tracker details.
 ** `uri`: Required. The URI format for linking to issues as formatted using {string_formats_link}. Default: GitHub. The `id` is dynamically calculated via the commit `Issue` trailer as linted by {git_lint_link}. When no ID can be found, this will default to _All_ issues.
 
@@ -341,11 +353,11 @@ Once team member information is stored in your cache, you'll be able to build re
 
 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=916,height=397,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/no_cache.png[Usage,width=978,height=618,role=focal_point]
 
 === Build
 
-image:https://alchemists.io/images/projects/milestoner/screenshots/usage-build.png[Usage,width=679,height=437,role=focal_point]
+image:https://alchemists.io/images/projects/milestoner/screenshots/usage-build.png[Usage,width=787,height=675,role=focal_point]
 
 The build command allows you to quickly build release notes to check the current status of your project or deploy a new milestone. By default, the build command uses either the default or custom configuration as documented in the _Configuration_ section above. This means, when using the defaults, you can immediately build the release notes for your project in a temporary directory:
 
@@ -353,8 +365,8 @@ The build command allows you to quickly build release notes to check the current
 ----
 milestoner build --format web
 # 🟢 [milestoner] Building Milestoner (web)...
-# 🟢 [milestoner] Built: /Users/bkuhlmann/Engineering/OSS/milestoner/tmp/milestones/page.css.
-# 🟢 [milestoner] Built: /Users/bkuhlmann/Engineering/OSS/milestoner/tmp/milestones/index.html.
+# 🟢 [milestoner] Created: /Users/bkuhlmann/Engineering/OSS/milestoner/tmp/milestones/page.css.
+# 🟢 [milestoner] Created: /Users/bkuhlmann/Engineering/OSS/milestoner/tmp/milestones/index.html.
 ----
 
 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:
@@ -378,7 +390,7 @@ msw() {
       open "$path"
     fi
   else
-    milestoner build --max "$max" --stylesheet "../page" --format web
+    milestoner build --max "$max" --format web
 
     if [[ -d "$root" ]]; then
       ruby -run -e httpd "tmp/milestones" --port 3030 &
@@ -544,56 +556,58 @@ The quickest way to start customization is to copy the `templates` folder struct
 ....
 lib/milestoner/templates
 ├── layouts
-│  ├── page.adoc.erb
-│  ├── page.html.erb
-│  ├── page.md.erb
-│  ├── page.stream.erb
-│  └── page.xml.erb
+│   ├── page.adoc.erb
+│   ├── page.git.erb
+│   ├── page.html.erb
+│   ├── page.md.erb
+│   ├── page.stream.erb
+│   └── page.xml.erb
 ├── milestones
-│  ├── _avatar.adoc.erb
-│  ├── _avatar.html.erb
-│  ├── _avatar.md.erb
-│  ├── _avatar.xml.erb
-│  ├── _commit.adoc.erb
-│  ├── _commit.html.erb
-│  ├── _commit.md.erb
-│  ├── _commit.stream.erb
-│  ├── _commit.xml.erb
-│  ├── _content.adoc.erb
-│  ├── _content.html.erb
-│  ├── _content.xml.erb
-│  ├── _logo.adoc.erb
-│  ├── _logo.html.erb
-│  ├── _logo.md.erb
-│  ├── _logo.xml.erb
-│  ├── _none.adoc.erb
-│  ├── _none.html.erb
-│  ├── _none.xml.erb
-│  ├── _profile.adoc.erb
-│  ├── _profile.html.erb
-│  ├── _profile.md.erb
-│  ├── _profile.xml.erb
-│  ├── _tag-insecure.html.erb
-│  ├── _tag-secure.html.erb
-│  ├── _tag.adoc.erb
-│  ├── _tag.html.erb
-│  ├── _tag.md.erb
-│  ├── _tag.stream.erb
-│  ├── _tag.xml.erb
-│  ├── _user.adoc.erb
-│  ├── _user.html.erb
-│  ├── _user.md.erb
-│  ├── _user.xml.erb
-│  ├── _users.adoc.erb
-│  ├── _users.html.erb
-│  ├── _users.xml.erb
-│  ├── show.adoc.erb
-│  ├── show.html.erb
-│  ├── show.md.erb
-│  ├── show.stream.erb
-│  └── show.xml.erb
+│   ├── _avatar.adoc.erb
+│   ├── _avatar.html.erb
+│   ├── _avatar.md.erb
+│   ├── _avatar.xml.erb
+│   ├── _commit.adoc.erb
+│   ├── _commit.git.erb
+│   ├── _commit.html.erb
+│   ├── _commit.md.erb
+│   ├── _commit.stream.erb
+│   ├── _commit.xml.erb
+│   ├── _content.adoc.erb
+│   ├── _content.html.erb
+│   ├── _content.xml.erb
+│   ├── _logo.adoc.erb
+│   ├── _logo.html.erb
+│   ├── _logo.md.erb
+│   ├── _logo.xml.erb
+│   ├── _none.adoc.erb
+│   ├── _none.html.erb
+│   ├── _none.xml.erb
+│   ├── _profile.adoc.erb
+│   ├── _profile.html.erb
+│   ├── _profile.md.erb
+│   ├── _profile.xml.erb
+│   ├── _tag-insecure.html.erb
+│   ├── _tag-secure.html.erb
+│   ├── _user.adoc.erb
+│   ├── _user.html.erb
+│   ├── _user.md.erb
+│   ├── _user.xml.erb
+│   ├── _users.adoc.erb
+│   ├── _users.html.erb
+│   ├── _users.md.erb
+│   ├── _users.xml.erb
+│   ├── index.adoc.erb
+│   ├── index.html.erb
+│   ├── index.md.erb
+│   ├── show.adoc.erb
+│   ├── show.git.erb
+│   ├── show.html.erb
+│   ├── show.md.erb
+│   ├── show.stream.erb
+│   └── show.xml.erb
 └── public
-   └── page.css.erb
+    └── page.css.erb
 ....
 
 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):

data/lib/milestoner/builders/adoc/container.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module ADoc
+      # Defines ASCII Doc dependencies.
+      module Container
+        extend Containable
+
+        register(:indexer) { Indexer.new }
+        register(:pager) { Pager.new }
+      end
+    end
+  end
+end

data/lib/milestoner/builders/adoc/dependencies.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module ADoc
+      Dependencies = Infusible[Container]
+    end
+  end
+end

data/lib/milestoner/builders/adoc/indexer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module ADoc
+      # Builds ASCII Doc index.
+      class Indexer
+        include Milestoner::Dependencies[:settings, :logger]
+
+        def initialize(path_resolver: PathResolver, view: Views::Milestones::Index.new, **)
+          super(**)
+          @path_resolver = path_resolver
+          @view = view
+        end
+
+        def call tags
+          path_resolver.call settings.build_output.join("index.adoc"), logger: do |path|
+            path.write view.call(tags:, layout: settings.build_layout, format: :adoc)
+          end
+        end
+
+        private
+
+        attr_reader :path_resolver, :view
+      end
+    end
+  end
+end

data/lib/milestoner/builders/adoc/pager.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module ADoc
+      # Builds ASCII Doc version.
+      class Pager
+        include Milestoner::Dependencies[:settings, :logger]
+
+        def initialize(path_resolver: PathResolver, view: Views::Milestones::Show.new, **)
+          super(**)
+          @path_resolver = path_resolver
+          @view = view
+        end
+
+        def call past, tag, future
+          settings.project_version = tag.version
+          write past, tag, future
+        end
+
+        private
+
+        attr_reader :path_resolver, :view
+
+        def write past, tag, future
+          path = settings.build_output.join(tag.version, settings.build_basename).sub_ext ".adoc"
+
+          path_resolver.call path, logger: do
+            path.write view.call(past:, tag:, future:, layout: settings.build_layout, format: :adoc)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/builders/ascii_doc.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
+require "refinements/array"
 require "refinements/pathname"
 
 module Milestoner
   module Builders
-    # Builds ASCII Doc output.
+    # Builds ASCII Doc files.
     class ASCIIDoc
-      include Milestoner::Import[:settings, :logger]
+      include Milestoner::Dependencies[:settings, :logger]
+      include ADoc::Dependencies[:indexer, :pager]
 
+      using Refinements::Array
       using Refinements::Pathname
 
-      def initialize(tagger: Commits::Tagger.new, view: Views::Milestones::Show.new, **)
+      def initialize(tagger: Tags::Enricher.new, view: Views::Milestones::Show.new, **)
+        super(**)
         @tagger = tagger
         @view = view
-        super(**)
       end
 
       def call
@@ -27,20 +30,9 @@ module Milestoner
       attr_reader :tagger, :view
 
       def build tags
-        tags.each { |tag| write tag }
-        settings.build_root
-      end
-
-      def write tag
-        path = make_path tag
-
-        path.write view.call(tag:, layout: settings.build_layout, format: :adoc)
-        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 ".adoc"
+        indexer.call tags
+        tags.ring { |future, present, past| pager.call past, present, future }
+        settings.build_output
       end
 
       def failure message

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

@@ -4,6 +4,6 @@ require "infusible"
 
 module Milestoner
   module Builders
-    Import = Infusible[Container]
+    Dependencies = Infusible[Container]
   end
 end

data/lib/milestoner/builders/feed.rb

@@ -6,34 +6,25 @@ module Milestoner
   module Builders
     # Builds syndicated feed output.
     class Feed
-      include Milestoner::Import[:settings, :logger]
+      include Milestoner::Dependencies[:logger]
 
       using Refinements::Pathname
 
-      def initialize(tagger: Commits::Tagger.new, syndicator: Syndication::Builder.new, **)
-        @tagger = tagger
-        @syndicator = syndicator
+      def initialize(tagger: Tags::Enricher.new, indexer: Syndication::Indexer.new, **)
         super(**)
+        @tagger = tagger
+        @indexer = indexer
       end
 
       def call
         tagger.call
-              .bind { |tags| syndicator.call tags }
-              .fmap { |body| write body }
+              .bind { |tags| indexer.call tags }
               .alt_map { |message| failure message }
       end
 
       private
 
-      attr_reader :tagger, :syndicator
-
-      def write body
-        root = settings.build_root
-        path = root.join(settings.build_basename).make_ancestors.sub_ext(".xml").write body
-
-        logger.info { "Built: #{path}." }
-        root
-      end
+      attr_reader :tagger, :indexer
 
       def failure message
         logger.error { message }

data/lib/milestoner/builders/markdown.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
+require "refinements/array"
 require "refinements/pathname"
 
 module Milestoner
   module Builders
-    # Builds Markdown output.
+    # Builds Markdown files.
     class Markdown
-      include Milestoner::Import[:settings, :logger]
+      include Milestoner::Dependencies[:settings, :logger]
+      include MD::Dependencies[:indexer, :pager]
 
+      using Refinements::Array
       using Refinements::Pathname
 
-      def initialize(tagger: Commits::Tagger.new, view: Views::Milestones::Show.new, **)
+      def initialize(tagger: Tags::Enricher.new, view: Views::Milestones::Show.new, **)
+        super(**)
         @tagger = tagger
         @view = view
-        super(**)
       end
 
       def call
@@ -27,20 +30,9 @@ module Milestoner
       attr_reader :tagger, :view
 
       def build tags
-        tags.each { |tag| write tag }
-        settings.build_root
-      end
-
-      def write tag
-        path = make_path tag
-
-        path.write view.call(tag:, layout: settings.build_layout, format: :md)
-        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 ".md"
+        indexer.call tags
+        tags.ring { |future, present, past| pager.call past, present, future }
+        settings.build_output
       end
 
       def failure message

data/lib/milestoner/builders/md/container.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module MD
+      # Defines Markdown dependencies.
+      module Container
+        extend Containable
+
+        register(:indexer) { Indexer.new }
+        register(:pager) { Pager.new }
+      end
+    end
+  end
+end

data/lib/milestoner/builders/md/dependencies.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module MD
+      Dependencies = Infusible[Container]
+    end
+  end
+end

data/lib/milestoner/builders/md/indexer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module MD
+      # Builds Markdown index.
+      class Indexer
+        include Milestoner::Dependencies[:settings, :logger]
+
+        def initialize(path_resolver: PathResolver, view: Views::Milestones::Index.new, **)
+          super(**)
+          @path_resolver = path_resolver
+          @view = view
+        end
+
+        def call tags
+          path_resolver.call settings.build_output.join("index.md"), logger: do |path|
+            path.write view.call(tags:, layout: settings.build_layout, format: :md)
+          end
+        end
+
+        private
+
+        attr_reader :path_resolver, :view
+      end
+    end
+  end
+end

data/lib/milestoner/builders/md/pager.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module MD
+      # Builds Markdown version.
+      class Pager
+        include Milestoner::Dependencies[:settings, :logger]
+
+        def initialize(path_resolver: PathResolver, view: Views::Milestones::Show.new, **)
+          super(**)
+          @path_resolver = path_resolver
+          @view = view
+        end
+
+        def call past, tag, future
+          settings.project_version = tag.version
+          write past, tag, future
+        end
+
+        private
+
+        attr_reader :path_resolver, :view
+
+        def write past, tag, future
+          path = settings.build_output.join(tag.version, settings.build_basename).sub_ext ".md"
+
+          path_resolver.call path, logger: do
+            path.write view.call(past:, tag:, future:, layout: settings.build_layout, format: :md)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/builders/path_resolver.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/pathname"
+
+module Milestoner
+  # Safely handles file paths which may or may not exist.
+  module Builders
+    using Refinements::Pathname
+
+    PathResolver = lambda do |path, logger:, &block|
+      if path.exist?
+        logger.warn { "Skipped (exists): #{path}." }
+      else
+        path.make_ancestors
+        block.call path if block
+        logger.info { "Created: #{path}." }
+      end
+
+      Dry::Monads::Success path
+    end
+  end
+end