milestoner 16.2.1 → 17.1.0

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/hash"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Project
+        # Conditionally updates author based on Git user.
+        class Author
+          include Import[:git]
+          include Dry::Monads[:result]
+
+          using Refinements::Hash
+
+          def initialize(key = :project_author, **)
+            @key = key
+            super(**)
+          end
+
+          def call content
+            content.fetch_value(key) { git.get("user.name", nil).value_or(nil) }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Project
+        # Conditionally updates generator based on gem specification.
+        class Generator
+          include Import[:specification]
+          include Dry::Monads[:result]
+
+          def initialize(key = :project_generator, **)
+            @key = key
+            super(**)
+          end
+
+          def call content
+            warn "`#{self.class}##{__method__}` is deprecated, use " \
+                 "`Milestoner::Configuration::Transformers::Generator::Label` or " \
+                 "`Milestoner::Configuration::Transformers::Generator::URI` instead.",
+                 category: :deprecated
+
+            Success({key => specification.labeled_version}.merge!(content))
+          end
+
+          private
+
+          attr_reader :key
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "refinements/hash"
+require "refinements/string"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      # Conditionally updates label based on current directory.
+      module Project
+        using Refinements::String
+        using Refinements::Hash
+
+        Label = lambda do |content, key = :project_label, default: Pathname.pwd.basename.to_s|
+          content.fetch_value(key) { default }
+                 .then { |value| Dry::Monads::Success content.merge!(key => value.titleize) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "refinements/hash"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      # Conditionally updates name based on current directory.
+      module Project
+        using Refinements::Hash
+
+        Name = lambda do |content, key = :project_name, default: Pathname.pwd.basename.to_s|
+          content.fetch_value(key) { default }
+                 .then { |value| Dry::Monads::Success content.merge!(key => value) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/hash"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Project
+        # Conditionally updates version based on last Git tag.
+        class Version
+          include Dry::Monads[:result]
+
+          using Refinements::Hash
+
+          def initialize key = :project_version, versioner: Commits::Versioner.new
+            @key = key
+            @versioner = versioner
+          end
+
+          def call content
+            content.fetch_value(key) { versioner.call }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key, :versioner
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module URI
+        Avatar = lambda do |content, key = :avatar_uri|
+          domain, uri = content.values_at :avatar_domain, key
+
+          return Dry::Monads::Success content unless uri
+
+          content[key] = format uri, domain:, id: "%<id>s"
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module URI
+        Commit = lambda do |content, key = :commit_uri|
+          owner, name, domain, uri = content.values_at :project_owner,
+                                                       :project_name,
+                                                       :commit_domain,
+                                                       key
+
+          return Dry::Monads::Success content unless uri
+
+          content[key] = format uri, domain:, owner:, name:, id: "%<id>s"
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module URI
+        Profile = lambda do |content, key = :profile_uri|
+          domain, uri = content.values_at :profile_domain, key
+
+          return Dry::Monads::Success content unless uri
+
+          content[key] = format uri, domain:, id: "%<id>s"
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module URI
+        Review = lambda do |content, key = :review_uri|
+          owner, name, domain, uri = content.values_at :project_owner,
+                                                       :project_name,
+                                                       :review_domain,
+                                                       key
+
+          return Dry::Monads::Success content unless uri
+
+          content[key] = format uri, domain:, owner:, name:, id: "%<id>s"
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module URI
+        Tracker = lambda do |content, key = :tracker_uri|
+          owner, name, domain, uri = content.values_at :project_owner,
+                                                       :project_name,
+                                                       :tracker_domain,
+                                                       key
+
+          return Dry::Monads::Success content unless uri
+
+          content[key] = format uri, domain:, owner:, name:, id: "%<id>s"
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/container.rb

@@ -4,7 +4,9 @@ require "cogger"
 require "dry-container"
 require "etcher"
 require "gitt"
+require "lode"
 require "runcom"
+require "sanitize"
 require "spek"
 
 module Milestoner
@@ -12,21 +14,62 @@ module Milestoner
   module Container
     extend Dry::Container::Mixin
 
-    register :configuration do
-      self[:defaults].add_loader(Etcher::Loaders::YAML.new(self[:xdg_config].active))
+    namespace :xdg do
+      register(:cache, memoize: true) { Runcom::Cache.new "milestoner/database.store" }
+      register(:config, memoize: true) { Runcom::Config.new "milestoner/configuration.yml" }
+    end
+
+    register :cache, memoize: true do
+      # :nocov:
+      Lode.new self["xdg.cache"].passive do |config|
+        config.mode = :max
+        config.table = Lode::Tables::Value
+        config.register :users, model: Models::User, primary_key: :name
+      end
+    end
+
+    register :configuration, memoize: true do
+      self[:defaults].add_loader(Etcher::Loaders::YAML.new(self["xdg.config"].active))
                      .then { |registry| Etcher.call registry }
     end
 
-    register :defaults do
+    register :defaults, memoize: true do
       Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
                       .add_loader(Etcher::Loaders::YAML.new(self[:defaults_path]))
+                      .add_transformer(Configuration::Transformers::Build::Root)
+                      .add_transformer(Configuration::Transformers::Build::TemplatePaths.new)
+                      .add_transformer(Configuration::Transformers::Gems::Label.new)
+                      .add_transformer(Configuration::Transformers::Gems::Description.new)
+                      .add_transformer(Configuration::Transformers::Gems::Name.new)
+                      .add_transformer(Configuration::Transformers::Gems::URI.new)
+                      .add_transformer(Configuration::Transformers::Citations::Label.new)
+                      .add_transformer(Configuration::Transformers::Citations::Description.new)
+                      .add_transformer(Configuration::Transformers::Project::Author.new)
+                      .add_transformer(Configuration::Transformers::Project::Label)
+                      .add_transformer(Configuration::Transformers::Project::Name)
+                      .add_transformer(Configuration::Transformers::Project::Version.new)
+                      .add_transformer(Configuration::Transformers::Generator::Label.new)
+                      .add_transformer(Configuration::Transformers::Generator::URI.new)
+                      .add_transformer(Configuration::Transformers::URI::Avatar)
+                      .add_transformer(Configuration::Transformers::URI::Commit)
+                      .add_transformer(Configuration::Transformers::URI::Profile)
+                      .add_transformer(Configuration::Transformers::URI::Review)
+                      .add_transformer(Configuration::Transformers::URI::Tracker)
+    end
+
+    register :specification, memoize: true do
+      self[:spec_loader].call "#{__dir__}/../../milestoner.gemspec"
+    end
+
+    register :sanitizer, memoize: true do
+      -> content { Sanitize.fragment content, Sanitize::Config::BASIC }
     end
 
-    register(:git) { Gitt::Repository.new }
-    register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
-    register(:xdg_config) { Runcom::Config.new "milestoner/configuration.yml" }
-    register(:specification) { Spek::Loader.call "#{__dir__}/../../milestoner.gemspec" }
-    register(:kernel) { Kernel }
-    register(:logger) { Cogger.new id: :milestoner }
+    register(:spec_loader, memoize: true) { Spek::Loader.new }
+    register(:git, memoize: true) { Gitt::Repository.new }
+    register(:input, memoize: true) { self[:configuration].dup }
+    register(:defaults_path, memoize: true) { Pathname(__dir__).join("configuration/defaults.yml") }
+    register(:logger, memoize: true) { Cogger.new id: :milestoner }
+    register :kernel, Kernel
   end
 end

data/lib/milestoner/models/commit.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "gitt"
+
+module Milestoner
+  module Models
+    COMMIT_COMMON_ATTRIBUTES = %i[
+      authored_at
+      body
+      deletions
+      files_changed
+      insertions
+      notes
+      sha
+      signature
+      subject
+    ].freeze
+
+    COMMIT_ENRICHED_ATTRIBUTES = %i[
+      author
+      collaborators
+      format
+      issue
+      milestone
+      review
+      signers
+      uri
+    ].freeze
+
+    # Represents an enriched commit.
+    Commit = Struct.new(*COMMIT_COMMON_ATTRIBUTES, *COMMIT_ENRICHED_ATTRIBUTES) do
+      include Gitt::Directable
+
+      def self.for(commit, **) = new(**commit.to_h.slice(*COMMIT_COMMON_ATTRIBUTES), **)
+
+      def initialize(**)
+        super
+        freeze
+      end
+    end
+  end
+end

data/lib/milestoner/models/link.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Models
+    # Represents a hyperlink.
+    Link = Data.define :id, :uri do
+      def initialize id: nil, uri: nil
+        super
+      end
+    end
+  end
+end

data/lib/milestoner/models/user.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Models
+    # Represents an external user.
+    User = Data.define :external_id, :handle, :name do
+      def initialize external_id: nil, handle: nil, name: nil
+        super
+      end
+    end
+  end
+end

data/lib/milestoner/renderers/asciidoc.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "asciidoctor"
+
+module Milestoner
+  module Renderers
+    # Renders ASCII Doc as HTML.
+    class Asciidoc
+      def initialize client: Asciidoctor
+        @client = client
+      end
+
+      def call(content) = client.convert content
+
+      private
+
+      attr_reader :client
+    end
+  end
+end

data/lib/milestoner/renderers/markdown.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "redcarpet"
+
+module Milestoner
+  module Renderers
+    # Renders Markdown as HTML.
+    class Markdown
+      def initialize client: Redcarpet::Markdown.new(Redcarpet::Render::HTML.new)
+        @client = client
+      end
+
+      def call(content) = client.render content
+
+      private
+
+      attr_reader :client
+    end
+  end
+end

data/lib/milestoner/renderers/universal.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Renderers
+    # The primary renderer for multiple input formats as HTML.
+    class Universal
+      include Import[:input]
+
+      DELEGATES = {asciidoc: Asciidoc.new, markdown: Markdown.new}.freeze
+
+      def initialize(delegates: DELEGATES, **)
+        super(**)
+        @delegates = delegates
+        @default_format = input.commit_format.to_sym
+      end
+
+      def call content, for: default_format
+        delegates.fetch(binding.local_variable_get(:for)).call content
+      end
+
+      private
+
+      attr_reader :delegates, :default_format
+    end
+  end
+end

data/lib/milestoner/tags/creator.rb

@@ -1,38 +1,48 @@
 # frozen_string_literal: true
 
 require "gitt"
+require "refinements/string_io"
 require "versionaire"
 
 module Milestoner
   module Tags
     # Handles the creation of project repository tags.
     class Creator
-      include Import[:git, :logger]
+      include Import[:input, :git, :logger]
 
+      using Refinements::StringIO
       using Versionaire::Cast
 
-      def initialize(categorizer: Commits::Categorizer.new, presenter: Presenters::Commit, **)
+      def initialize(
+        collector: Commits::Collector.new,
+        builder: Builders::Stream.new(kernel: StringIO.new),
+        **
+      )
+        @collector = collector
+        @builder = builder
         super(**)
-        @categorizer = categorizer
-        @presenter = presenter
       end
 
-      def call configuration = Container[:configuration]
-        return false if local? configuration
-        fail Error, "Unable to tag without commits." if categorizer.call.empty?
+      def call override = nil
+        version = compute_version override
 
-        create configuration
-      rescue Versionaire::Error => error
-        raise Error, error.message
+        return false if local? version
+        fail Error, "Unable to tag without commits." if collector.call.value_or([]).empty?
+
+        create version
       end
 
       private
 
-      attr_reader :categorizer, :presenter
+      attr_reader :collector, :builder
 
-      def local? configuration
-        version = Version configuration.version
+      def compute_version value
+        Version value || input.project_version
+      rescue Versionaire::Error => error
+        raise Error, error
+      end
 
+      def local? version
         if git.tag_local? version
           logger.warn { "Local tag exists: #{version}. Skipped." }
           true
@@ -41,18 +51,16 @@ module Milestoner
         end
       end
 
-      def create configuration
-        git.tag_create(configuration.version, message(configuration))
-           .or { |error| fail Error, error }
-           .bind { true }
+      def create version
+        build(version).fmap { |body| git.tag_create version, body }
+                      .or { |error| fail Error, error }
+                      .bind { true }
       end
 
-      def message configuration
-        categorizer.call(configuration)
-                   .map { |record| presenter.new(record).line_item }
-                   .then do |line_items|
-                     %(Version #{configuration.version}\n\n#{line_items.join "\n"}\n\n)
-                   end
+      def build version
+        builder.call.fmap do |body|
+          "Version #{version}\n\n#{body.reread}\n\n"
+        end
       end
     end
   end

data/lib/milestoner/tags/publisher.rb

@@ -4,7 +4,7 @@ module Milestoner
   module Tags
     # Handles the tagging and pushing of a tag to a remote repository.
     class Publisher
-      include Import[:logger]
+      include Import[:input, :logger]
 
       def initialize(creator: Tags::Creator.new, pusher: Tags::Pusher.new, **)
         super(**)
@@ -12,10 +12,10 @@ module Milestoner
         @pusher = pusher
       end
 
-      def call configuration = Container[:configuration]
-        creator.call configuration
-        pusher.call configuration
-        logger.info { "Published: #{configuration.version}!" }
+      def call override = nil
+        creator.call override
+        pusher.call override
+        logger.info { "Published: #{input.project_version}!" }
       end
 
       private

data/lib/milestoner/tags/pusher.rb

@@ -6,12 +6,12 @@ module Milestoner
   module Tags
     # Handles publishing of tags to a remote repository.
     class Pusher
-      include Import[:git, :logger]
+      include Import[:input, :git, :logger]
 
       using Versionaire::Cast
 
-      def call configuration = Container[:configuration]
-        version = Version configuration.version
+      def call override = nil
+        version = compute_version override
 
         fail Error, "Remote repository not configured." unless git.origin?
         fail Error, "Remote tag exists: #{version}." if git.tag_remote? version
@@ -19,6 +19,12 @@ module Milestoner
 
         logger.debug "Local tag pushed: #{version}."
       end
+
+      def compute_version value
+        Version value || input.project_version
+      rescue Versionaire::Error => error
+        raise Error, error
+      end
     end
   end
 end

data/lib/milestoner/templates/layouts/page.adoc.erb

@@ -0,0 +1,2 @@
+<%= yield %>
+_Generated by link:<%= generator_uri %>[<%= generator_label %>]._

data/lib/milestoner/templates/layouts/page.html.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <title><%= project_title %></title>
+
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="description" content="<%= project_description %>">
+    <meta name="author" content="<%= project_author %>">
+    <meta name="generator" content="<%= generator_label %>">
+
+    <link title="<%= project_label %>: Favorite Icon"
+          rel="icon"
+          href="https://alchemists.io/images/projects/milestoner/icons/brand/favicon.ico"
+          sizes="32x32">
+    <link title="<%= project_label %>: Apple Icon"
+          rel="apple-touch-icon"
+          href="https://alchemists.io/images/projects/milestoner/icons/brand/apple.png"
+          type="image/png">
+    <link title="<%= project_label %>: Stylesheet" rel="stylesheet" href="page.css" type="text/css">
+
+    <script src="https://unpkg.com/alpinejs@3.13" defer></script>
+  </head>
+
+  <body>
+    <main>
+      <%= yield %>
+    </main>
+
+    <footer class="footer">
+      <p class="generator">
+        Generated by <a href="<%= generator_uri %>" class="link"><%= generator_label %></a>.
+      </p>
+    </footer>
+  </body>
+</html>