milestoner 16.2.1 → 17.0.0

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,35 @@ 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(:profile_domain).filled :string
+      required(:profile_uri).filled :string
+      required(:project_author).filled :string
+      optional(:project_description).filled :string
+      required(:project_generator).filled :string
+      optional(:project_label).filled :string
+      required(:project_name).filled :string
+      optional(:project_owner).filled :string
+      optional(:project_uri).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(: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,29 @@
 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,
+                       :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,35 @@
+# 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
+            content[key] = xdg_config.all.append default
+            Success content
+          end
+
+          private
+
+          attr_reader :key, :default, :xdg_config
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "cff"
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Citations
+        # Conditionally updates project description based on citation details.
+        class Description
+          include Dry::Monads[:result]
+
+          def initialize key = :project_description,
+                         path: Pathname.pwd.join("CITATION.cff"),
+                         citation: CFF::File
+            @key = key
+            @path = path
+            @citation = citation
+          end
+
+          def call(content) = Success process(content)
+
+          private
+
+          attr_reader :key, :path, :citation
+
+          def process content
+            content.fetch(key) { citation.open(path).abstract }
+                   .then { |value| String(value).empty? ? content : content.merge!(key => value) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "cff"
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Citations
+        # Conditionally updates project label based on citation details.
+        class Label
+          include Dry::Monads[:result]
+
+          def initialize key = :project_label,
+                         path: Pathname.pwd.join("CITATION.cff"),
+                         citation: CFF::File
+            @key = key
+            @path = path
+            @citation = citation
+          end
+
+          def call(content) = Success process(content)
+
+          private
+
+          attr_reader :key, :path, :citation
+
+          def process content
+            content.fetch(key) { citation.open(path).title }
+                   .then { |value| String(value).empty? ? content : content.merge!(key => value) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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) = Success process(content)
+
+          private
+
+          attr_reader :key, :path
+
+          def process content
+            content.fetch(key) { spec_loader.call(path).summary }
+                   .then { |value| String(value).empty? ? content : content.merge!(key => value) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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) = Success process(content)
+
+          private
+
+          attr_reader :key, :path
+
+          def process content
+            content.fetch(key) { spec_loader.call(path).label }
+                   .then { |value| value == "Undefined" ? content : content.merge!(key => value) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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) = Success process(content)
+
+          private
+
+          attr_reader :key, :path
+
+          def process content
+            content.fetch(key) { spec_loader.call(path).name }
+                   .then { |value| String(value).empty? ? content : content.merge!(key => value) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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) = Success process(content)
+
+          private
+
+          attr_reader :key, :path
+
+          def process content
+            content.fetch(key) { spec_loader.call(path).homepage_url }
+                   .then { |value| String(value).empty? ? content : content.merge!(key => value) }
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,28 @@
+# 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) = Success({key => specification.labeled_version}.merge!(content))
+
+          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/string"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      # Conditionally updates label based on current directory.
+      module Project
+        using Refinements::String
+
+        Label = lambda do |content, key = :project_label, default: Pathname.pwd.basename.to_s|
+          content.fetch(key) { default }
+                 .tap { |value| content[key] = value.titleize }
+
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "pathname"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Project
+        Name = lambda do |content, key = :project_name, default: Pathname.pwd.basename.to_s|
+          content.fetch(key) { default }
+                 .tap { |value| content[key] = value }
+
+          Dry::Monads::Success content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Milestoner
+  module Configuration
+    module Transformers
+      module Project
+        # Conditionally updates version based on last Git tag.
+        class Version
+          include Dry::Monads[:result]
+
+          def initialize key = :project_version, versioner: Commits::Versioner.new
+            @key = key
+            @versioner = versioner
+          end
+
+          def call content
+            content.fetch(key) { versioner.call }
+                   .then { |value| content.merge! key => value }
+                   .then { |update| Success update }
+          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