milestoner 16.2.1 → 17.1.0

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "dry-container"
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Registers all enrichers for injection.
+      module Container
+        extend Dry::Container::Mixin
+
+        register(:author, memoize: true) { Author.new }
+        register(:body, memoize: true) { Body.new }
+        register(:collaborators, memoize: true) { Colleague.new key: "Co-authored-by" }
+        register(:format, memoize: true) { Format.new }
+        register(:issue, memoize: true) { Issue.new }
+        register(:milestone) { Milestone.new }
+        register(:notes, memoize: true) { Note.new }
+        register(:review, memoize: true) { Review.new }
+        register(:signers, memoize: true) { Colleague.new key: "Signed-off-by" }
+        register(:uri, memoize: true) { URI.new }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit format based on trailer information.
+      class Format
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Format", **)
+          @key = key
+          super(**)
+        end
+
+        def call(commit) = commit.trailer_value_for(key).value_or(input.commit_format)
+
+        private
+
+        attr_reader :key
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "infusible"
+
+module Milestoner
+  module Commits
+    module Enrichers
+      Import = Infusible.with Container
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit issue based on trailer information.
+      class Issue
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Issue", model: Models::Link, **)
+          @key = key
+          @model = model
+          super(**)
+        end
+
+        def call commit
+          commit.trailer_value_for(key)
+                .fmap { |value| model[id: value, uri: format(input.tracker_uri, id: value)] }
+                .value_or(model.new)
+        end
+
+        private
+
+        attr_reader :key, :model
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit milestone based on trailer information.
+      class Milestone
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Milestone", default: "unknown", **)
+          @key = key
+          @default = default
+          super(**)
+        end
+
+        def call(commit) = commit.trailer_value_for(key).value_or(default)
+
+        private
+
+        attr_reader :key, :default
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches commit notes by rendering as HTML based on trailer information.
+      class Note
+        include Milestoner::Import[:input]
+
+        def initialize(key: "Format", renderer: Renderers::Universal.new, **)
+          @key = key
+          @renderer = renderer
+          super(**)
+        end
+
+        def call commit
+          commit.trailer_value_for(key)
+                .value_or(input.commit_format)
+                .then { |format| renderer.call commit.notes, for: format.to_sym }
+        end
+
+        private
+
+        attr_reader :key, :renderer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit review based on trailer information.
+      class Review
+        include Milestoner::Import[:input]
+
+        def initialize(model: Models::Link, **)
+          @model = model
+          super(**)
+        end
+
+        def call(*) = model[id: "All", uri: format(input.review_uri, id: nil)]
+
+        private
+
+        attr_reader :model
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Commits
+    module Enrichers
+      # Enriches a commit URI based on trailer information.
+      class URI
+        include Milestoner::Import[:input]
+
+        def call(commit) = format input.commit_uri, id: commit.sha
+      end
+    end
+  end
+end

data/lib/milestoner/commits/versioner.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "versionaire"
+
+module Milestoner
+  module Commits
+    # Calculates next version based on commit trailer version keys.
+    class Versioner
+      include Import[:git]
+      include Dry::Monads[:result]
+
+      using Versionaire::Cast
+
+      DEFAULTS = {trailer_key: "Milestone", fallback: Versionaire::Version.new}.freeze
+
+      def initialize(defaults: DEFAULTS, collector: Collector.new, **)
+        @defaults = defaults
+        @collector = collector
+        super(**)
+      end
+
+      def call
+        trailer_milestones.then { |milestones| bump milestones }
+                          .value_or(fallback)
+      end
+
+      private
+
+      attr_reader :defaults, :collector
+
+      def trailer_milestones
+        collector.call.value_or([]).each.with_object [] do |commit, values|
+          commit.trailer_value_for(trailer_key).bind { |milestone| values.append milestone.to_sym }
+        end
+      end
+
+      def bump milestones
+        target = fallback.members.intersection(milestones).first
+        git.tag_last.fmap { |tag| target ? Version(tag).bump(target) : fallback }
+      end
+
+      def trailer_key = defaults.fetch __method__
+
+      def fallback = defaults.fetch __method__
+    end
+  end
+end

data/lib/milestoner/configuration/contract.rb

@@ -8,9 +8,36 @@ Dry::Schema.load_extensions :monads
 module Milestoner
   module Configuration
     Contract = Dry::Schema.Params do
-      required(:documentation_format).filled :string
-      required(:prefixes).array :string
-      optional(:version).filled :string
+      required(:avatar_domain).filled :string
+      required(:avatar_uri).filled :string
+      required(:build_format).filled :string
+      required(:build_layout) { str? | bool? }
+      required(:build_root).filled Etcher::Types::Pathname
+      required(:build_template_paths).array Etcher::Types::Pathname
+
+      required(:commit_categories).array(:hash) do
+        required(:emoji).filled :string
+        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(:profile_domain).filled :string
+      required(:profile_uri).filled :string
+      required(:project_author).filled :string
+      optional(:project_description).maybe :string
+      optional(:project_label).filled :string
+      required(:project_name).filled :string
+      optional(:project_owner).filled :string
+      optional(:project_uri).maybe :string
+      required(:project_version).filled Etcher::Types::Version
+      required(:review_domain).filled :string
+      required(:review_uri).filled :string
+      required(:tracker_domain).filled :string
+      required(:tracker_uri).filled :string
     end
   end
 end

data/lib/milestoner/configuration/defaults.yml

@@ -1,8 +1,31 @@
-documentation:
-  format: "adoc"
-prefixes:
-  - Fixed
-  - Added
-  - Updated
-  - Removed
-  - Refactored
+avatar:
+  domain: https://avatars.githubusercontent.com
+  uri: "%<domain>s/u/%<id>s"
+build:
+  format: web
+  layout: page
+  root: tmp/milestone
+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"
+profile:
+  domain: https://github.com
+  uri: "%<domain>s/%<id>s"
+review:
+  domain: https://github.com
+  uri: "%<domain>s/%<owner>s/%<name>s/pulls/%<id>s"
+tracker:
+  domain: https://github.com
+  uri: "%<domain>s/%<owner>s/%<name>s/issues/%<id>s"

data/lib/milestoner/configuration/model.rb

@@ -3,6 +3,31 @@
 module Milestoner
   module Configuration
     # Defines configuration content as the primary source of truth for use throughout the gem.
-    Model = Struct.new :documentation_format, :prefixes, :version
+    Model = Struct.new :avatar_domain,
+                       :avatar_uri,
+                       :build_format,
+                       :build_layout,
+                       :build_root,
+                       :build_template_paths,
+                       :commit_categories,
+                       :commit_domain,
+                       :commit_format,
+                       :commit_uri,
+                       :generator_label,
+                       :generator_uri,
+                       :profile_domain,
+                       :profile_uri,
+                       :project_author,
+                       :project_description,
+                       :project_generator,
+                       :project_label,
+                       :project_name,
+                       :project_owner,
+                       :project_uri,
+                       :project_version,
+                       :review_domain,
+                       :review_uri,
+                       :tracker_domain,
+                       :tracker_uri
   end
 end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "refinements/hash"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      # Ensures build root is expanded.
+      module Build
+        using Refinements::Hash
+
+        Root = lambda do |content, key = :build_root|
+          content.transform_with! key => -> value { Pathname(value).expand_path }
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "runcom"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Build
+        # Ensures XDG configuration and gem template paths are configured.
+        class TemplatePaths
+          include Dry::Monads[:result]
+
+          def initialize key = :build_template_paths,
+                         default: Pathname(__dir__).join("../../../templates"),
+                         xdg_config: Runcom::Config.new("milestoner/templates")
+            @key = key
+            @default = default
+            @xdg_config = xdg_config
+          end
+
+          def call(content) = Success content.merge!(key => xdg_config.all.append(default))
+
+          private
+
+          attr_reader :key, :default, :xdg_config
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 description based on citation details.
+        class Description
+          include Dry::Monads[:result]
+
+          using Refinements::Hash
+
+          def initialize key = :project_description,
+                         path: Pathname.pwd.join("CITATION.cff"),
+                         citation: CFF::File
+            @key = key
+            @path = path
+            @citation = citation
+          end
+
+          def call content
+            content.fetch_value(key) { citation.open(path).abstract }
+                   .then { |value| value unless String(value).empty? }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key, :path, :citation
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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 label based on citation details.
+        class Label
+          include Dry::Monads[:result]
+
+          using Refinements::Hash
+
+          def initialize key = :project_label,
+                         path: Pathname.pwd.join("CITATION.cff"),
+                         citation: CFF::File
+            @key = key
+            @path = path
+            @citation = citation
+          end
+
+          def call content
+            content.fetch_value(key) { citation.open(path).title }
+                   .then { |value| value unless String(value).empty? }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key, :path, :citation
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "spek"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Gems
+        # Conditionally updates project description based on specification summary.
+        class Description
+          include Import[:spec_loader]
+          include Dry::Monads[:result]
+
+          def initialize(key = :project_description, path: "#{Pathname.pwd.basename}.gemspec", **)
+            @key = key
+            @path = path
+            super(**)
+          end
+
+          def call content
+            content.fetch(key) { spec_loader.call(path).summary }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key, :path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "spek"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Gems
+        # Conditionally updates project label based on specification label.
+        class Label
+          include Import[:spec_loader]
+          include Dry::Monads[:result]
+
+          def initialize(key = :project_label, path: "#{Pathname.pwd.basename}.gemspec", **)
+            @key = key
+            @path = path
+            super(**)
+          end
+
+          def call content
+            content.fetch(key) { spec_loader.call(path).label }
+                   .then { |value| value unless value == "Undefined" }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key, :path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "spek"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Gems
+        # Conditionally updates project name based on specification name.
+        class Name
+          include Import[:spec_loader]
+          include Dry::Monads[:result]
+
+          def initialize(key = :project_name, path: "#{Pathname.pwd.basename}.gemspec", **)
+            @key = key
+            @path = path
+            super(**)
+          end
+
+          def call content
+            content.fetch(key) { spec_loader.call(path).name }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key, :path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+require "spek"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Gems
+        # Conditionally updates project URI based on specification home page URL.
+        class URI
+          include Import[:spec_loader]
+          include Dry::Monads[:result]
+
+          def initialize(key = :project_uri, path: "#{Pathname.pwd.basename}.gemspec", **)
+            @key = key
+            @path = path
+            super(**)
+          end
+
+          def call content
+            content.fetch(key) { spec_loader.call(path).homepage_url }
+                   .then { |value| value unless String(value).empty? }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key, :path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Generator
+        # Conditionally updates generator label based on gem specification.
+        class Label
+          include Import[:specification]
+          include Dry::Monads[:result]
+
+          def initialize(key = :generator_label, **)
+            @key = key
+            super(**)
+          end
+
+          def call content
+            content.fetch(key) { specification.labeled_version }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Generator
+        # Conditionally updates generator URI based on gem specification.
+        class URI
+          include Import[:specification]
+          include Dry::Monads[:result]
+
+          def initialize(key = :generator_uri, **)
+            @key = key
+            super(**)
+          end
+
+          def call content
+            content.fetch(key) { specification.homepage_url }
+                   .then { |value| Success content.merge!(key => value) }
+          end
+
+          private
+
+          attr_reader :key
+        end
+      end
+    end
+  end
+end