milestoner 16.2.1 → 17.0.0

data/lib/milestoner/templates/public/page.css.erb

@@ -0,0 +1,356 @@
+.milestone {
+  --border-width: 0.15rem;
+  --color-black: hsl(0, 0%, 0%);
+  --color-butter: hsl(52, 100%, 83%);
+  --color-carbon: hsl(219, 6%, 58%);
+  --color-cheese: hsl(51, 100%, 93%);
+  --color-cloud: hsl(219, 100%, 93%);
+  --color-ghost: hsl(171.4, 17.1%, 92%);
+  --color-green: hsl(110, 88%, 37%);
+  --color-grey: hsl(240, 7%, 97%);
+  --color-sea: hsl(210, 24%, 15%);
+  --color-ice: hsl(216, 100%, 98%);
+  --color-major: hsl(231, 97%, 29%);
+  --color-minor: hsl(203, 74%, 45%);
+  --color-orange: hsl(24.8, 100%, 50.2%);
+  --color-patch: hsl(199, 83%, 62%);
+  --color-powder: hsl(0, 0%, 98%);
+  --color-red: hsl(0, 100%, 50%);
+  --color-slate: hsl(211, 23%, 41%);
+  --color-smoke: hsl(229, 31%, 93%);
+  --color-white: hsl(0, 0%, 100%);
+  --font-family: Verdana;
+
+  display: flex;
+  flex-direction: column;
+  font-family: var(--font-family);
+  margin: 0 12vw;
+
+  .header {
+    display: flex;
+    justify-content: space-between;
+    margin: 1rem 0 1rem 0;
+
+    .title {
+      margin: 0;
+    }
+
+    .date {
+      font-size: 1.4rem;
+      font-weight: 600;
+      margin: 0;
+    }
+  }
+
+  .actions {
+    display: flex;
+    justify-content: flex-end;
+    margin-bottom: 0.5rem;
+  }
+
+  .toggle {
+    background-color: var(--color-white);
+    border: 0.1rem solid var(--color-sea);
+    border-radius: 0.5rem;
+    color: var(--color-sea);
+    cursor: pointer;
+    padding: 0.2rem;
+    font-size: 0.9rem;
+    width: 5rem;
+  }
+
+  .normal {
+    border-width: var(--border-width);
+    border-style: solid;
+    border-color: transparent;
+    border-bottom-color: var(--color-ghost);
+  }
+
+  .alert {
+    border: var(--border-width) solid var(--color-orange);
+  }
+
+  .error {
+    border: var(--border-width) solid var(--color-red);
+  }
+
+  .avatar {
+    border-radius: 50%;
+  }
+
+  .columns {
+    background-color: var(--color-black);
+    border-top-left-radius: 0.5rem;
+    border-top-right-radius: 0.5rem;
+    color: var(--color-white);
+    display: grid;
+    grid-template: 1fr / 4.7fr 1fr 1fr 1fr 1fr 1fr;
+    padding: 0.3rem 0;
+
+    .label {
+      font-weight: 600;
+      text-align: center;
+    }
+  }
+
+  .row {
+    .label {
+      font-weight: 600;
+    }
+  }
+
+  .row[open] > .summary::before {
+    content: "\25BC";
+    width: 0.5rem;
+  }
+
+  .summary {
+    align-items: center;
+    display: grid;
+    gap: 0 1rem;
+    grid-template: 1fr / auto 5fr 1fr 1fr 1fr 1fr 1fr;
+    padding: 0.15rem 0;
+    margin: 0.25rem 0 0 0;
+
+    &::-webkit-details-marker {
+      display:none;
+    }
+
+    &::before {
+      content: "\25B6";
+      cursor: pointer;
+      width: 0.5rem;
+    }
+
+    &:hover {
+      background-color: var(--color-powder);
+    }
+
+    .title {
+      align-items: center;
+      display: flex;
+      gap: 0 0.5rem;
+    }
+
+    .subject {
+      word-break: break-word;
+    }
+
+    .author,
+    .files,
+    .lines,
+    .issue,
+    .review {
+      text-align: center;
+    }
+
+    .avatar {
+      vertical-align: middle;
+    }
+
+    .lines {
+      .deletions {
+        color: var(--color-green);
+      }
+
+      .insertions {
+        color: var(--color-red);
+      }
+    }
+  }
+
+  .details {
+    display: grid;
+    gap: 1rem;
+    grid-template: auto auto auto / auto 1fr;
+    grid-template-areas:
+      "tag message"
+      "tag notes"
+      "tag info";
+
+    @media (width >= 1000px) {
+      grid-template: 1fr auto / auto 2fr 1fr;
+      grid-template-areas:
+        "tag message info"
+        "tag notes info";
+    }
+
+    .tag {
+      align-self: stretch;
+      grid-area: tag;
+      padding: 0.5rem 0.2rem 0.5rem 0.1rem;
+      text-align: center;
+      text-transform: capitalize;
+      writing-mode: vertical-lr;
+      padding: 0 0.2rem;
+    }
+
+    .major {
+      background-color: var(--color-major);
+      color: var(--color-white);
+    }
+
+    .minor {
+      background-color: var(--color-minor);
+      color: var(--color-white);
+    }
+
+    .patch {
+      background-color: var(--color-patch);
+      color: var(--color-black);
+    }
+
+    .rebase {
+      background-color: var(--color-orange);
+      color: var(--color-white);
+    }
+
+    .invalid {
+      background-color: var(--color-red);
+      color: var(--color-white);
+    }
+
+    .unknown {
+      background-color: var(--color-carbon);
+      color: var(--color-white);
+    }
+
+    .bar {
+      border-radius: 0.5rem 0.5rem 0 0;
+      color: var(--color-black);
+      font-size: 1rem;
+      font-weight: 600;
+      padding: 0 0 0 0.5rem;
+      margin: 0;
+    }
+
+    .panel {
+      display: flex;
+      flex-direction: column;
+      padding: 0 0.5rem 0.5rem 0.5rem;
+    }
+
+    .message {
+      background-color: var(--color-grey);
+      border-radius: 0.5rem;
+      grid-area: message;
+      margin-top: 1rem;
+
+      .bar {
+        background-color: var(--color-smoke);
+      }
+
+      .content {
+        margin: 0 0.5rem;
+        word-break: break-word;
+      }
+    }
+
+    .notes {
+      background-color: var(--color-cheese);
+      border-radius: 0.5rem;
+      grid-area: notes;
+      margin-bottom: 1rem;
+
+      .bar {
+        background-color: var(--color-butter);
+      }
+
+      .content {
+        margin: 0 0.5rem;
+      }
+    }
+
+    .info {
+      grid-area: info;
+      background-color: var(--color-ice);
+      border-radius: 0.5rem;
+      margin: 1rem 0;
+
+      .bar {
+        background-color: var(--color-cloud);
+      }
+
+      .label {
+        font-size: 0.9rem;
+      }
+
+      .item {
+        align-self: start;
+        display: flex;
+        gap: 0.5rem;
+        margin: 0;
+      }
+
+      .pill {
+        border-radius: 0.5rem;
+        padding: 0.1rem 0.4rem;
+      }
+
+      .secure {
+        background-color: var(--color-green);
+        color: var(--color-white);
+
+        .signature::before {
+          content: "\1F512";
+          margin-right: 0.5rem;
+        }
+      }
+
+      .insecure {
+        background-color: var(--color-red);
+        color: var(--color-white);
+
+        .signature::before {
+          content: "\1F513";
+          margin-right: 0.5rem;
+        }
+      }
+
+      .at {
+        flex-wrap: wrap;
+
+        .weekday {
+          &:before {
+            content: "(";
+          }
+
+          &:after {
+            content: ")";
+          }
+        }
+      }
+    }
+  }
+
+  .quiet {
+    align-items: center;
+    display: flex;
+    justify-content: center;
+    flex-direction: column;
+
+    &::before {
+      content: "\1F303";
+      font-size: 10rem;
+    }
+  }
+
+  .totals {
+    display: flex;
+    gap: 0 0.5rem;
+    font-weight: 600;
+    justify-content: center;
+
+    .files {
+      color: var(--color-slate);
+    }
+
+    .deletions {
+      color: var(--color-green);
+    }
+
+    .insertions {
+      color: var(--color-red);
+    }
+  }
+}

data/lib/milestoner/views/context.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "hanami/view"
+
+module Milestoner
+  module Views
+    # Provides a common context for all views.
+    class Context < Hanami::View::Context
+      extend Forwardable
+
+      include Import[:input]
+
+      delegate %i[
+        project_author
+        project_description
+        project_generator
+        project_label
+        project_version
+      ] => :input
+
+      def project_title = [project_label, project_version].compact.join " "
+    end
+  end
+end

data/lib/milestoner/views/milestones/show.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "hanami/view"
+require "pathname"
+require "refinements/string"
+
+module Milestoner
+  module Views
+    module Milestones
+      # Produces release notes in HTML format.
+      class Show < Hanami::View
+        using Refinements::String
+
+        config.default_context = Context.new
+        config.part_namespace = Parts
+        config.paths = Container[:configuration].build_template_paths
+        config.template = "milestones/show"
+
+        expose :at, default: Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S%z")
+        expose :date, default: Time.now.utc.strftime("%Y-%m-%d")
+        expose :commits
+        expose :uri, default: Container[:configuration].project_uri
+
+        expose :total_commits do |commits|
+          total = commits.size
+          "#{total} commit".pluralize "s", total
+        end
+
+        expose :total_files do |commits|
+          total = commits.sum(&:files_changed)
+          "#{total} file".pluralize "s", total
+        end
+
+        expose :total_deletions do |commits|
+          total = commits.sum(&:deletions)
+          "#{total} deletion".pluralize "s", total
+        end
+
+        expose :total_insertions do |commits|
+          total = commits.sum(&:insertions)
+          "#{total} insertion".pluralize "s", total
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/views/parts/commit.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "asciidoctor"
+require "hanami/view"
+require "refinements/array"
+
+module Milestoner
+  module Views
+    module Parts
+      # Provides presentation for an individual commit.
+      # :reek:RepeatedConditional
+      class Commit < Hanami::View::Part
+        include Import[:configuration, :sanitizer]
+
+        using Refinements::Array
+
+        def initialize(**)
+          super(**)
+          @prefixes = configuration.commit_categories.pluck :label
+          @authored_at = Time.at(value.authored_at.to_i).utc
+        end
+
+        def avatar_url(user) = format configuration.avatar_uri, id: user.external_id
+
+        def profile_url(user) = format configuration.profile_uri, id: user.handle
+
+        def kind
+          if prefixes.include? prefix then "normal"
+          elsif value.directive? then "alert"
+          else "error"
+          end
+        end
+
+        def emoji
+          configuration.commit_categories
+                       .find { |category| category.fetch(:label) == prefix }
+                       .then { |category| category ? category.fetch(:emoji) : "🔶" }
+        end
+
+        def icon
+          if prefixes.include? prefix then String(prefix).downcase
+          elsif value.directive? then "rebase"
+          else "invalid"
+          end
+        end
+
+        def safe_body = sanitizer.call(value.body).html_safe
+
+        def safe_notes = sanitizer.call(value.notes).html_safe
+
+        def total_deletions = format "%d", -value.deletions
+
+        # :reek:FeatureEnvy
+        def total_insertions
+          value.insertions.then { |total| total.positive? ? "+#{total}" : total.to_s }
+        end
+
+        def tag
+          return "rebase" if value.directive?
+          return "invalid" unless prefixes.include? prefix
+
+          value.milestone
+        end
+
+        def security = value.signature == "Good" ? "secure" : "insecure"
+
+        def at = authored_at.strftime "%Y-%m-%dT%H:%M:%S%z"
+
+        def weekday = authored_at.strftime "%A"
+
+        def date = authored_at.strftime "%Y-%m-%d"
+
+        def time = authored_at.strftime "%H:%M %p"
+
+        def zone = authored_at.strftime "%Z"
+
+        private
+
+        attr_reader :prefixes, :authored_at
+
+        def prefix = value.prefix
+      end
+    end
+  end
+end

data/lib/milestoner.rb

@@ -3,7 +3,7 @@
 require "zeitwerk"
 
 Zeitwerk::Loader.new.then do |loader|
-  loader.inflector.inflect "cli" => "CLI"
+  loader.inflector.inflect "cli" => "CLI", "uri" => "URI"
   loader.tag = File.basename __FILE__, ".rb"
   loader.push_dir __dir__
   loader.setup

data/milestoner.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "milestoner"
-  spec.version = "16.2.1"
+  spec.version = "17.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/milestoner"
@@ -22,19 +22,25 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = [">= 3.2", "<= 3.3"]
-  spec.add_dependency "cogger", "~> 0.12"
+  spec.required_ruby_version = "~> 3.3"
+  spec.add_dependency "asciidoctor", "~> 2.0"
+  spec.add_dependency "cff", "~> 1.1"
+  spec.add_dependency "cogger", "~> 0.15"
   spec.add_dependency "dry-container", "~> 0.11"
   spec.add_dependency "dry-monads", "~> 1.6"
   spec.add_dependency "dry-schema", "~> 1.13"
-  spec.add_dependency "etcher", "~> 0.2"
-  spec.add_dependency "gitt", "~> 2.0"
-  spec.add_dependency "infusible", "~> 2.2"
-  spec.add_dependency "refinements", "~> 11.0"
-  spec.add_dependency "runcom", "~> 10.0"
-  spec.add_dependency "sod", "~> 0.0"
-  spec.add_dependency "spek", "~> 2.0"
-  spec.add_dependency "versionaire", "~> 12.0"
+  spec.add_dependency "etcher", "~> 1.0"
+  spec.add_dependency "gitt", "~> 3.0"
+  spec.add_dependency "hanami-view", "~> 2.1.0.rc2"
+  spec.add_dependency "infusible", "~> 3.0"
+  spec.add_dependency "lode", "~> 1.0"
+  spec.add_dependency "redcarpet", "~> 3.6"
+  spec.add_dependency "refinements", "~> 12.0"
+  spec.add_dependency "runcom", "~> 11.0"
+  spec.add_dependency "sanitize", "~> 6.1"
+  spec.add_dependency "sod", "~> 0.4"
+  spec.add_dependency "spek", "~> 3.0"
+  spec.add_dependency "versionaire", "~> 13.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.bindir = "exe"