milestoner 18.11.0 → 19.0.0

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module Site
+      # Defines web dependencies.
+      module Container
+        extend Containable
+
+        register(:indexer) { Indexer.new }
+        register(:pager) { Pager.new }
+        register(:styler) { Styler.new }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Milestoner
+  module Builders
+    module Site
+      # Builds web index.
+      class Indexer
+        include Dry::Monads[:result]
+        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
+          return Success() unless settings.build_index
+
+          path_resolver.call settings.build_output.join("index.html"), logger: do |path|
+            path.write view.call(tags:, layout: settings.build_layout)
+          end
+        end
+
+        private
+
+        attr_reader :path_resolver, :view
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module Site
+      # Builds web 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 ".html"
+
+          path_resolver.call path, logger: do
+            path.write view.call(past:, tag:, future:, layout: settings.build_layout)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/builders/site/styler.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/pathname"
+
+module Milestoner
+  module Builders
+    module Site
+      # Builds web stylesheet.
+      class Styler
+        include Milestoner::Dependencies[:settings, :logger]
+        include Dry::Monads[:result]
+
+        using Refinements::Pathname
+
+        def initialize(path_resolver: PathResolver, **)
+          super(**)
+          @path_resolver = path_resolver
+        end
+
+        def call
+          return Success() unless settings.build_stylesheet
+
+          path = build_path
+
+          path_resolver.call(path, logger:) { copy path }
+        end
+
+        private
+
+        attr_reader :path_resolver
+
+        def build_path
+          path = Pathname settings.stylesheet_path
+          path.absolute? ? path : settings.build_output.join(path)
+        end
+
+        def copy build_path
+          settings.build_template_paths
+                  .map { |template| template.join "public/page.css.erb" }
+                  .find(&:exist?)
+                  .copy build_path.make_ancestors
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/builders/stream.rb

@@ -4,12 +4,12 @@ module Milestoner
   module Builders
     # Builds I/O stream output.
     class Stream
-      include Milestoner::Import[:settings, :logger, :io]
+      include Milestoner::Dependencies[:settings, :logger, :io]
 
-      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

data/lib/milestoner/builders/syndication/builder.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "core"
+require "dry/monads"
+require "rss"
+
+module Milestoner
+  module Builders
+    module Syndication
+      # Builds feed in Atom format.
+      # :reek:DataClump
+      class Builder
+        include Milestoner::Dependencies[:settings]
+        include Dry::Monads[:result]
+
+        using Refine
+
+        def self.authors_for tags
+          tags.flat_map { |tag| tag.commits.map(&:author) }
+              .then { |users| users.any? ? users : tags.map(&:author) }
+              .uniq
+        end
+
+        def initialize(client: RSS::Maker, view: Views::Milestones::Show.new, **)
+          super(**)
+          @client = client
+          @view = view
+        end
+
+        def call tags
+          return Failure "No tags or commits." if tags.empty?
+
+          Success build_feed(tags).to_s
+        rescue NoMethodError, RSS::Error => error
+          Failure "#{self.class}: #{error.message.capitalize}."
+        end
+
+        private
+
+        attr_reader :client, :view
+
+        def build_feed tags
+          client.make "atom" do |node|
+            build_channel node.channel, tags
+            build_tags node, tags
+          end
+        end
+
+        def build_channel node, tags
+          at = tags.first.committed_at
+
+          node.merge id: settings.project_uri_home,
+                     title: settings.syndication_label,
+                     subtitle: settings.project_description,
+                     icon: settings.project_uri_icon,
+                     logo: settings.project_uri_logo,
+                     rights: at.strftime("%Y"),
+                     updated: at
+
+          build_channel_elements node, tags
+        end
+
+        def build_channel_elements node, tags
+          build_links node
+          build_generator node
+          build_authors node, self.class.authors_for(tags)
+
+          node.categories.build label: settings.project_label, term: settings.project_name
+        end
+
+        def build_links node
+          node.links.build_for settings.syndication_links,
+                               label: :title,
+                               uri: :href,
+                               relation: :rel,
+                               mime: :type
+        end
+
+        def build_generator node
+          node.generator do |generator|
+            generator.merge content: settings.generator_label,
+                            version: settings.generator_version,
+                            uri: settings.generator_uri
+          end
+        end
+
+        def build_tags node, tags = Core::EMPTY_ARRAY
+          tags.each { |tag| build_item node.items, tag }
+        end
+
+        def build_item node, tag
+          node.new_item do |item|
+            build_item_metadata item, tag
+            build_item_content item.content, tag
+            build_authors item, tag.commits.map(&:author).uniq.select(&:name)
+            item.categories.build_for settings.syndication_categories, label: :label, name: :term
+          end
+        end
+
+        def build_item_metadata node, tag
+          committed_at = tag.committed_at
+          version = tag.version
+
+          node.merge id: format(settings.syndication_id, id: version),
+                     title: format(settings.syndication_entry_label, id: version),
+                     link: format(settings.syndication_entry_uri, id: version),
+                     rights: committed_at.strftime("%Y"),
+                     published: committed_at,
+                     updated: committed_at
+        end
+
+        def build_item_content node, tag
+          content = view.call tag:, layout: settings.build_layout, format: :xml
+          node.merge content:, type: :html
+        end
+
+        def build_authors node, users = Core::EMPTY_ARRAY
+          users.each do |user|
+            node.authors.build name: user.name, uri: format(settings.profile_uri, id: user.handle)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module Syndication
+      # Builds syndicated feed output.
+      class Indexer
+        include Milestoner::Dependencies[:settings, :logger]
+
+        def initialize(path_resolver: PathResolver, syndicator: Syndication::Builder.new, **)
+          super(**)
+          @path_resolver = path_resolver
+          @syndicator = syndicator
+        end
+
+        def call(tags) = syndicator.call(tags).bind { |body| write body }
+
+        private
+
+        attr_reader :path_resolver, :syndicator
+
+        def write body
+          path = settings.build_output.join(settings.build_basename).sub_ext(".xml")
+          path_resolver.call(path, logger:) { path.write body }
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/builders/syndication/refine.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rss"
+
+module Milestoner
+  module Builders
+    module Syndication
+      # Smooths out the rough edges of the RSS gem object which are harder to work with.
+      module Refine
+        refine(RSS::Maker::Atom::Feed::Channel) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Channel::Authors) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Channel::Authors::Author) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Channel::Categories) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Channel::Categories::Category) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Channel::Generator) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Channel::Links::Link) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Items::Item) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Channel::Links) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Items::Item::Authors) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Items::Item::Authors::Author) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Items::Item::Categories) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Items::Item::Categories::Category) { import_methods Shared }
+        refine(RSS::Maker::Atom::Feed::Items::Item::Content) { import_methods Shared }
+      end
+    end
+  end
+end

data/lib/milestoner/builders/syndication/shared.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Builders
+    module Syndication
+      # Provides shared functionality for refinements.
+      module Shared
+        def merge(**attributes) = attributes.each { |key, value| public_send :"#{key}=", value }
+
+        def build_for(collection, **)
+          collection.each { |attributes| build(**attributes.transform_keys(**)) }
+        end
+
+        def build(**attributes)
+          node = public_send :"new_#{kind}"
+          attributes.each { |key, value| node.public_send :"#{key}=", value }
+        end
+
+        private
+
+        def kind
+          self.class.name.downcase.split("::").last.sub("categories", "category").delete_suffix("s")
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/builders/web.rb

@@ -5,16 +5,17 @@ require "refinements/pathname"
 
 module Milestoner
   module Builders
-    # Builds web output (i.e. HTML and CSS).
+    # Builds web files,
     class Web
-      include Milestoner::Import[:settings, :logger]
+      include Milestoner::Dependencies[:settings, :logger]
+      include Site::Dependencies[:indexer, :pager, :styler]
 
+      using Refinements::Array
       using Refinements::Pathname
 
-      def initialize(tagger: Commits::Tagger.new, view: Views::Milestones::Show.new, **)
-        @tagger = tagger
-        @view = view
+      def initialize(tagger: Tags::Enricher.new, **)
         super(**)
+        @tagger = tagger
       end
 
       def call
@@ -25,46 +26,13 @@ module Milestoner
 
       private
 
-      attr_reader :tagger, :view
+      attr_reader :tagger
 
       def build tags
-        make_root
-        copy_stylesheet
-        tags.each { |tag| write tag }
-        settings.build_root
-      end
-
-      def make_root = settings.build_root.make_path
-
-      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
-        settings.build_root.join "#{Pathname(settings.build_stylesheet).name}.css"
-      end
-
-      def write tag
-        path = make_path tag
-        settings.project_version = tag.version
-
-        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"
+        styler.call
+        indexer.call tags
+        tags.ring { |future, present, past| pager.call past, present, future }
+        settings.build_output
       end
 
       def failure message

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

@@ -9,7 +9,7 @@ module Milestoner
       module Build
         # Handles output path.
         class Basename < Sod::Action
-          include Import[:settings]
+          include Dependencies[:settings]
 
           description "Set basename."
 

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

@@ -8,7 +8,7 @@ module Milestoner
       module Build
         # Handles build output format.
         class Format < Sod::Action
-          include Import[:settings]
+          include Dependencies[:settings]
 
           description "Set output format."
 

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Build
+        # Handles build index.
+        class Index < Sod::Action
+          include Dependencies[:settings]
+
+          description "Enable/disable versions index."
+
+          ancillary "Only used by web format."
+
+          on "--[no-]index"
+
+          default { Container[:settings].build_index }
+
+          def call(boolean) = settings.build_index = boolean
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Milestoner
       module Build
         # Handles build label.
         class Label < Sod::Action
-          include Import[:settings]
+          include Dependencies[:settings]
 
           description "Set label."
 

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[:settings]
+          include Dependencies[:settings]
 
           description "Set view template layout."
 

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

@@ -8,7 +8,7 @@ module Milestoner
       module Build
         # Handles build maximum.
         class Max < Sod::Action
-          include Import[:settings]
+          include Dependencies[:settings]
 
           description "Set maximum number of tags to process."
 

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "sod"
+
+module Milestoner
+  module CLI
+    module Actions
+      module Build
+        # Handles build output path.
+        class Output < Sod::Action
+          include Dependencies[:settings]
+
+          description "Set output path."
+
+          on %w[-o --output], argument: "[PATH]"
+
+          default { Container[:settings].build_output }
+
+          def call(path = default) = settings.build_output = Pathname(path).expand_path
+        end
+      end
+    end
+  end
+end

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

@@ -8,19 +8,17 @@ module Milestoner
       module Build
         # Handles build stylesheet.
         class Stylesheet < Sod::Action
-          include Import[:settings]
+          include Dependencies[:settings]
 
-          description "Set stylesheet file name or relative path."
+          description "Enable/disable stylesheet."
 
-          ancillary "Only used by web format. Use false to disable."
+          ancillary "Only used by web format."
 
-          on %w[-s --stylesheet], argument: "[NAME]"
+          on "--[no-]stylesheet"
 
           default { Container[:settings].build_stylesheet }
 
-          def call name = default
-            settings.build_stylesheet = name == "false" ? false : name
-          end
+          def call(boolean) = settings.build_stylesheet = boolean
         end
       end
     end

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

@@ -8,7 +8,7 @@ module Milestoner
       module Build
         # Handles build tail.
         class Tail < Sod::Action
-          include Import[:settings]
+          include Dependencies[:settings]
 
           description "Set tail reference."
 

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[:settings, :logger]
+          include Dependencies[:settings, :logger]
 
           using Versionaire::Cast
 

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

@@ -9,7 +9,7 @@ module Milestoner
       module Cache
         # Handles creating or updating a user within the cache.
         class Create < Sod::Action
-          include Import[:logger, client: :cache]
+          include Dependencies[:logger, client: :cache]
 
           description "Create user."
 

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[:logger, client: :cache]
+          include Dependencies[: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[:logger, :io, client: :cache]
+          include Dependencies[:logger, :io, client: :cache]
 
           description "Find user."
 

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[:logger, client: :cache]
+          include Dependencies[: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[:logger, :io, client: :cache]
+          include Dependencies[:logger, :io, client: :cache]
 
           description "List users."
 

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