milestoner 17.11.0 → 18.0.0

data/lib/milestoner/commits/tagger.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/pathname"
+require "versionaire"
+
+module Milestoner
+  module Commits
+    # Assembles all commits for a tag.
+    class Tagger
+      include Milestoner::Import[:git, :settings, :logger]
+      include Enrichers::Import[author_enricher: :author]
+      include Dry::Monads[:result]
+
+      using Refinements::Pathname
+      using Versionaire::Cast
+
+      def initialize(enricher: Commits::Enricher.new, model: Models::Tag, **)
+        @enricher = enricher
+        @model = model
+        super(**)
+      end
+
+      def call
+        git.tags("--sort=taggerdate")
+           .fmap { |tags| tail tags.last(settings.build_max).map(&:version) }
+           .fmap { |references| slice(references).reverse }
+      end
+
+      private
+
+      attr_reader :enricher, :model
+
+      def tail references
+        references.append "HEAD" if settings.build_tail == "head"
+        references
+      end
+
+      def slice references
+        references.each_cons(2).with_object [] do |(min, max), entries|
+          add_enrichment entries, min, max
+        end
+      end
+
+      def add_enrichment(all, *) = enrich(*).bind { |entry| all.append entry }
+
+      def enrich min, max
+        enricher.call(min:, max:).bind { |commits| build_record git.tag_show(max), commits }
+      end
+
+      def build_record result, commits
+        result.fmap { |tag| record_for tag, commits }
+      rescue Versionaire::Error => error
+        logger.error error.message
+        Failure error
+      end
+
+      def record_for tag, commits
+        model[
+          author: author(tag),
+          commits:,
+          committed_at: committed_at(tag.committed_at),
+          sha: tag.sha,
+          signature: tag.signature,
+          version: Version(tag.version || settings.project_version),
+        ]
+      end
+
+      def author tag
+        tag = tag.dup
+        tag.author_name ||= settings.project_author
+        author_enricher.call tag
+      end
+
+      def committed_at(at) = at ? Time.at(at.to_i).utc : settings.loaded_at
+    end
+  end
+end

data/lib/milestoner/configuration/contract.rb

@@ -8,11 +8,14 @@ Dry::Schema.load_extensions :monads
 module Milestoner
   module Configuration
     Contract = Dry::Schema.Params do
-      required(:avatar_domain).filled :string
       required(:avatar_uri).filled :string
+      required(:build_basename).filled :string
       required(:build_format).filled :string
       required(:build_layout) { str? | bool? }
+      required(:build_max).filled :integer
       required(:build_root).filled Etcher::Types::Pathname
+      required(:build_stylesheet) { bool? | str? }
+      required(:build_tail).filled :string
       required(:build_template_paths).array Etcher::Types::Pathname
 
       required(:commit_categories).array(:hash) do
@@ -20,25 +23,44 @@ module Milestoner
         required(:label).filled :string
       end
 
-      required(:commit_domain).filled :string
       required(:commit_format).filled :string
       required(:commit_uri).filled :string
       required(:generator_label).filled :string
       required(:generator_uri).filled :string
       required(:generator_version).filled Etcher::Types::Version
       required(:loaded_at).filled :time
-      required(:profile_domain).filled :string
+      required(:organization_label).filled :string
+      required(:organization_uri).filled :string
       required(:profile_uri).filled :string
       required(:project_author).filled :string
-      optional(:project_description).maybe :string
+      optional(:project_description).filled :string
       optional(:project_label).filled :string
       required(:project_name).filled :string
-      optional(:project_owner).filled :string
-      optional(:project_uri).maybe :string
+      required(:project_owner).filled :string
+      required(:project_uri_home).filled :string
+      optional(:project_uri_icon).filled :string
+      optional(:project_uri_logo).filled :string
+      required(:project_uri_version).filled :string
       required(:project_version).filled Etcher::Types::Version
-      required(:review_domain).filled :string
       required(:review_uri).filled :string
-      required(:tracker_domain).filled :string
+
+      required(:syndication_categories).array(:hash) do
+        required(:label).filled :string
+        required(:name).filled :string
+      end
+
+      required(:syndication_entry_label).filled :string
+      required(:syndication_entry_uri).filled :string
+      required(:syndication_id).filled :string
+      required(:syndication_label).filled :string
+
+      required(:syndication_links).array(:hash) do
+        required(:label).filled :string
+        required(:mime).filled :string
+        required(:relation).filled :string
+        required(:uri).filled :string
+      end
+
       required(:tracker_uri).filled :string
     end
   end

data/lib/milestoner/configuration/defaults.yml

@@ -1,31 +1,56 @@
 avatar:
-  domain: https://avatars.githubusercontent.com
-  uri: "%<domain>s/u/%<id>s"
+  uri: "https://avatars.githubusercontent.com/u/%<id>s"
 build:
-  format: web
-  layout: page
-  root: tmp/milestone
+  basename: "index"
+  format: "stream"
+  layout: "page"
+  max: 1
+  root: "tmp/milestones"
+  stylesheet: "page"
+  tail: "head"
 commit:
   categories:
-    - emoji: ✅
-      label: Fixed
-    - emoji: 🟢
-      label: Added
-    - emoji: 🔼
-      label: Updated
-    - emoji: ⛔️
-      label: Removed
-    - emoji: 🔁
-      label: Refactored
-  domain: https://github.com
-  format: asciidoc
-  uri: "%<domain>s/%<owner>s/%<name>s/commit/%<id>s"
+    - emoji: "✅"
+      label: "Fixed"
+    - emoji: "🟢"
+      label: "Added"
+    - emoji: "🔼"
+      label: "Updated"
+    - emoji: "⛔️"
+      label: "Removed"
+    - emoji: "🔁"
+      label: "Refactored"
+  format: "asciidoc"
+  uri: "https://github.com/%<project_owner>s/%<project_name>s/commit/%<id>s"
+organization:
+  label: "Undefined"
+  uri: "https://undefined.io"
 profile:
-  domain: https://github.com
-  uri: "%<domain>s/%<id>s"
+  uri: "https://github.com/%<id>s"
+project:
+  owner: "undefined"
+  uri:
+    home: "%<organization_uri>s/projects/%<project_name>s"
+    version: "%<project_uri_home>s/versions/%<id>s"
 review:
-  domain: https://github.com
-  uri: "%<domain>s/%<owner>s/%<name>s/pulls/%<id>s"
+  uri: "https://github.com/%<project_owner>s/%<project_name>s/pulls/%<id>s"
+syndication:
+  categories:
+    - label: "Milestones"
+      name: "milestones"
+  entry:
+    label: "%<id>s"
+    uri: "%<project_uri_version>s"
+  id: "%<project_uri_version>s"
+  label: "%<organization_label>s: %<project_label>s"
+  links:
+    - label: "%<organization_label>s: %<project_label>s (web)"
+      mime: "text/html"
+      relation: "alternate"
+      uri: "%<project_uri_home>s/versions"
+    - label: "%<organization_label>s: %<project_label>s (feed)"
+      mime: "application/atom+xml"
+      relation: "self"
+      uri: "%<project_uri_home>s/versions.xml"
 tracker:
-  domain: https://github.com
-  uri: "%<domain>s/%<owner>s/%<name>s/issues/%<id>s"
+  uri: "https://github.com/%<project_owner>s/%<project_name>s/issues/%<id>s"

data/lib/milestoner/configuration/model.rb

@@ -3,33 +3,42 @@
 module Milestoner
   module Configuration
     # Defines configuration content as the primary source of truth for use throughout the gem.
-    Model = Struct.new :avatar_domain,
-                       :avatar_uri,
+    Model = Struct.new :avatar_uri,
+                       :build_basename,
                        :build_format,
                        :build_layout,
+                       :build_max,
                        :build_root,
+                       :build_stylesheet,
+                       :build_tail,
                        :build_template_paths,
                        :commit_categories,
-                       :commit_domain,
                        :commit_format,
                        :commit_uri,
                        :generator_label,
                        :generator_uri,
                        :generator_version,
                        :loaded_at,
-                       :profile_domain,
+                       :organization_label,
+                       :organization_uri,
                        :profile_uri,
                        :project_author,
                        :project_description,
-                       :project_generator,
                        :project_label,
                        :project_name,
                        :project_owner,
-                       :project_uri,
+                       :project_uri_home,
+                       :project_uri_icon,
+                       :project_uri_logo,
+                       :project_uri_version,
                        :project_version,
-                       :review_domain,
                        :review_uri,
-                       :tracker_domain,
+                       :syndication_categories,
+                       :syndication_entry_label,
+                       :syndication_entry_uri,
+                       :syndication_id,
+                       :syndication_label,
+                       :syndication_links,
                        :tracker_uri
   end
 end

data/lib/milestoner/configuration/transformers/build/template_paths.rb

@@ -14,17 +14,17 @@ module Milestoner
 
           def initialize key = :build_template_paths,
                          default: Pathname(__dir__).join("../../../templates"),
-                         xdg_config: Runcom::Config.new("milestoner/templates")
+                         xdg: Runcom::Config.new("milestoner/templates")
             @key = key
             @default = default
-            @xdg_config = xdg_config
+            @xdg = xdg
           end
 
-          def call(attributes) = Success attributes.merge!(key => xdg_config.all.append(default))
+          def call(attributes) = Success attributes.merge!(key => xdg.all.append(default))
 
           private
 
-          attr_reader :key, :default, :xdg_config
+          attr_reader :key, :default, :xdg
         end
       end
     end

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

@@ -24,9 +24,11 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch_value(key) { citation.open(path).abstract }
-                      .then { |value| value unless String(value).empty? }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch key do
+              attributes.merge!(key => citation.open(path).abstract).compress!
+            end
+
+            Success attributes
           end
 
           private

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

@@ -24,9 +24,8 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch_value(key) { citation.open(path).title }
-                      .then { |value| value unless String(value).empty? }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch(key) { attributes.merge!(key => citation.open(path).title).compress! }
+            Success attributes
           end
 
           private

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "cff"
+require "dry/monads"
+require "pathname"
+require "refinements/hash"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Citations
+        # Conditionally updates project URI based on citation URL.
+        class URI
+          include Dry::Monads[:result]
+
+          using Refinements::Hash
+
+          def initialize key = :project_uri,
+                         path: Pathname.pwd.join("CITATION.cff"),
+                         citation: CFF::File
+            @key = key
+            @path = path
+            @citation = citation
+          end
+
+          def call attributes
+            process attributes
+            Success attributes
+          rescue KeyError => error
+            Failure step: :transform,
+                    payload: "Unable to transform #{key.inspect}, missing specifier: " \
+                             "\"#{error.message[/<.+>/]}\"."
+          end
+
+          private
+
+          attr_reader :key, :path, :citation
+
+          def process attributes
+            attributes.fetch(key) { citation.open(path).url }
+                      .then { |value| value.match?(/%<.+>s/) ? format(value, attributes) : value }
+                      .then { |value| attributes.merge!(key => value).compress! }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@
 
 require "dry/monads"
 require "pathname"
+require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -12,6 +13,8 @@ module Milestoner
           include Import[:spec_loader]
           include Dry::Monads[:result]
 
+          using Refinements::Hash
+
           def initialize(key = :project_description, path: "#{Pathname.pwd.basename}.gemspec", **)
             @key = key
             @path = path
@@ -19,8 +22,11 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { spec_loader.call(path).summary }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch key do
+              attributes.merge!(key => spec_loader.call(path).summary).compress!
+            end
+
+            Success attributes
           end
 
           private

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

@@ -19,9 +19,12 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { spec_loader.call(path).label }
-                      .then { |value| value unless value == "Undefined" }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch key do
+              value = spec_loader.call(path).label
+              attributes.merge! key => value unless value == "Undefined"
+            end
+
+            Success attributes
           end
 
           private

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

@@ -2,6 +2,7 @@
 
 require "dry/monads"
 require "pathname"
+require "refinements/hash"
 
 module Milestoner
   module Configuration
@@ -12,6 +13,8 @@ module Milestoner
           include Import[:spec_loader]
           include Dry::Monads[:result]
 
+          using Refinements::Hash
+
           def initialize(key = :project_name, path: "#{Pathname.pwd.basename}.gemspec", **)
             @key = key
             @path = path
@@ -19,8 +22,11 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { spec_loader.call(path).name }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch key do
+              attributes.merge!(key => spec_loader.call(path).name).compress!
+            end
+
+            Success attributes
           end
 
           private

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

@@ -19,14 +19,23 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { spec_loader.call(path).homepage_url }
-                      .then { |value| value unless String(value).empty? }
-                      .then { |value| Success attributes.merge!(key => value) }
+            process attributes
+            Success attributes
+          rescue KeyError => error
+            Failure step: :transform,
+                    payload: "Unable to transform #{key.inspect}, missing specifier: " \
+                             "\"#{error.message[/<.+>/]}\"."
           end
 
           private
 
           attr_reader :key, :path
+
+          def process attributes
+            attributes.fetch(key) { spec_loader.call(path).homepage_url }
+                      .then { |value| value.match?(/%<.+>s/) ? format(value, attributes) : value }
+                      .then { |value| attributes.merge! key => value unless value.empty? }
+          end
         end
       end
     end

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

@@ -17,8 +17,8 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { specification.label }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch(key) { attributes.merge! key => specification.label }
+            Success attributes
           end
 
           private

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

@@ -17,8 +17,8 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { specification.homepage_url }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch(key) { attributes.merge! key => specification.homepage_url }
+            Success attributes
           end
 
           private

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

@@ -17,8 +17,8 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch(key) { specification.version }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch(key) { attributes.merge! key => specification.version }
+            Success attributes
           end
 
           private

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

@@ -20,8 +20,11 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch_value(key) { git.get("user.name", nil).value_or(nil) }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch key do
+              git.get("user.name", nil).bind { |value| attributes.merge!(key => value).compress! }
+            end
+
+            Success attributes
           end
 
           private

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

@@ -14,8 +14,8 @@ module Milestoner
         using Refinements::Hash
 
         Label = lambda do |attributes, key = :project_label, default: Pathname.pwd.basename.to_s|
-          attributes.fetch_value(key) { default.titleize }
-                    .then { |value| Dry::Monads::Success attributes.merge!(key => value) }
+          attributes.fetch(key) { attributes.merge!(key => default.titleize).compress! }
+          Dry::Monads::Success attributes
         end
       end
     end

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

@@ -19,8 +19,8 @@ module Milestoner
           end
 
           def call attributes
-            attributes.fetch_value(key) { versioner.call }
-                      .then { |value| Success attributes.merge!(key => value) }
+            attributes.fetch_value(key) { attributes.merge! key => versioner.call }
+            Success attributes
           end
 
           private

data/lib/milestoner/configuration/transformers/syndication/link.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "core"
+require "dry/monads"
+require "refinements/hash"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      # Conditionally updates links based on project details.
+      module Syndication
+        using Refinements::Hash
+
+        Link = lambda do |attributes, key = :syndication_links|
+          links = attributes.fetch key, Core::EMPTY_ARRAY
+
+          links.each do |link|
+            link.symbolize_keys!
+
+            link[:label] = format link[:label], attributes
+            link[:uri] = format link[:uri], attributes
+          end
+
+          Dry::Monads::Success attributes.merge!(key => links)
+        rescue KeyError => error
+          Dry::Monads::Failure step: :transform,
+                               payload: "Unable to transform #{key.inspect}, missing specifier: " \
+                                        "\"#{error.message[/<.+>/]}\"."
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/container.rb

@@ -28,14 +28,10 @@ module Milestoner
       end
     end
 
-    register :configuration do
-      self[:defaults].add_loader(:yaml, self["xdg.config"].active)
-                     .then { |registry| Etcher.call registry }
-    end
-
-    register :defaults do
+    register :registry 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(Configuration::Transformers::Build::TemplatePaths.new)
                       .add_transformer(Configuration::Transformers::Gems::Label.new)
@@ -44,28 +40,36 @@ module Milestoner
                       .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::Citations::URI.new)
                       .add_transformer(Configuration::Transformers::Project::Author.new)
                       .add_transformer(Configuration::Transformers::Project::Label)
-                      .add_transformer(Configuration::Transformers::Project::Name)
+                      .add_transformer(:basename, :project_name)
                       .add_transformer(Configuration::Transformers::Project::Version.new)
+                      .add_transformer(:format, :project_uri_home)
+                      .add_transformer(:format, :project_uri_icon)
+                      .add_transformer(:format, :project_uri_logo)
+                      .add_transformer(:format, :project_uri_version, id: "%<id>s")
                       .add_transformer(Configuration::Transformers::Generator::Label.new)
                       .add_transformer(Configuration::Transformers::Generator::URI.new)
                       .add_transformer(Configuration::Transformers::Generator::Version.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)
-                      .add_transformer(:time)
+                      .add_transformer(:format, :syndication_entry_label, id: "%<id>s")
+                      .add_transformer(:format, :syndication_entry_uri, id: "%<id>s")
+                      .add_transformer(:format, :syndication_id, id: "%<id>s")
+                      .add_transformer(:format, :syndication_label)
+                      .add_transformer(Configuration::Transformers::Syndication::Link)
+                      .add_transformer(:format, :commit_uri, id: "%<id>s")
+                      .add_transformer(:format, :review_uri, id: "%<id>s")
+                      .add_transformer(:format, :tracker_uri, id: "%<id>s")
+                      .add_transformer(:time, :loaded_at)
     end
 
+    register(:settings) { Etcher.call(self[:registry]).dup }
     register(:specification) { self[:spec_loader].call "#{__dir__}/../../milestoner.gemspec" }
-    register(:sanitizer) { -> content { Sanitize.fragment content, Sanitize::Config::BASIC } }
+    register :sanitizer, -> content { Sanitize.fragment content, Sanitize::Config::BASIC }
     register(:spec_loader) { Spek::Loader.new }
     register(:git) { Gitt::Repository.new }
-    register(:input) { self[:configuration].dup }
     register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
     register(:logger) { Cogger.new id: :milestoner }
-    register :kernel, Kernel
+    register :io, STDOUT
   end
 end