reviewkit 0.1.0

data/app/views/reviewkit/reviews/_show_content.html.erb

@@ -0,0 +1,164 @@
+<main class="<%= reviewkit_frame_request? ? "reviewkit-page reviewkit-page--embedded" : "reviewkit-page" %>">
+  <% additions = review.documents.sum(&:additions_count) %>
+  <% deletions = review.documents.sum(&:deletions_count) %>
+  <% frame_id = reviewkit_review_frame_id(review) %>
+
+  <section class="reviewkit-review-layout" data-controller="reviewkit--file-nav">
+    <%= render "reviewkit/reviews/review_sidebar",
+      review: review,
+      selected_document: @selected_document,
+      view_mode: @view_mode,
+      frame_id: frame_id %>
+
+    <div class="reviewkit-review-main">
+      <% if reviewkit_frame_request? && (flash[:notice].present? || flash[:alert].present?) %>
+        <%= render "reviewkit/shared/flash" %>
+      <% end %>
+
+      <header class="reviewkit-review-header">
+        <div class="reviewkit-review-header__top">
+          <% if @editing_review %>
+            <%= render "reviewkit/reviews/edit_form",
+              review: review,
+              frame_id: frame_id,
+              selected_document: @selected_document,
+              view_mode: @view_mode %>
+          <% else %>
+            <div class="space-y-2">
+              <div class="flex flex-wrap items-center gap-2">
+                <h1 class="reviewkit-review-title"><%= review.title %></h1>
+                <span class="<%= reviewkit_status_pill_class(review) %>"><%= review.status %></span>
+              </div>
+
+              <% if review.description.present? %>
+                <p class="reviewkit-review-description"><%= review.description %></p>
+              <% end %>
+            </div>
+          <% end %>
+
+          <div class="reviewkit-review-actions">
+            <% unless @editing_review %>
+              <% approval_blocked = review.open_threads_count.positive? %>
+
+              <% unless review.approved? %>
+                <%= button_to "Approve",
+                  approve_review_path(review, document_id: @selected_document&.id, view: @view_mode),
+                  method: :patch,
+                  class: "reviewkit-button reviewkit-button--success",
+                  disabled: approval_blocked,
+                  title: ("Resolve or mark open threads outdated before approving." if approval_blocked),
+                  form: { data: { turbo_frame: frame_id } } %>
+              <% end %>
+
+              <% unless review.rejected? %>
+                <%= button_to "Reject",
+                  reject_review_path(review, document_id: @selected_document&.id, view: @view_mode),
+                  method: :patch,
+                  class: "reviewkit-button reviewkit-button--danger",
+                  form: { data: { turbo_frame: frame_id } } %>
+              <% end %>
+
+              <div class="reviewkit-inline-actions" aria-label="Review actions">
+                <%= link_to edit_review_path(review, document_id: @selected_document&.id, view: @view_mode),
+                  class: "reviewkit-inline-icon-button",
+                  data: { turbo_frame: frame_id },
+                  aria: { label: "Edit review" },
+                  title: "Edit review" do %>
+                  <%= reviewkit_pencil_icon %>
+                <% end %>
+
+                <%= link_to review_path(review),
+                  class: "reviewkit-inline-icon-button reviewkit-inline-icon-button--danger",
+                  data: {
+                    turbo_confirm: "Delete this review?",
+                    turbo_frame: "_top",
+                    turbo_method: :delete
+                  },
+                  aria: { label: "Delete review" },
+                  title: "Delete review" do %>
+                  <%= reviewkit_trash_icon %>
+                <% end %>
+              </div>
+            <% end %>
+          </div>
+        </div>
+
+        <div class="reviewkit-review-meta">
+          <% if review.external_reference.present? %>
+            <span class="reviewkit-review-meta-item">
+              <span class="font-semibold text-slate-700">Reference:</span> <%= review.external_reference %>
+            </span>
+          <% end %>
+          <% if review.creator.present? %>
+            <span class="reviewkit-review-meta-item">
+              <span class="font-semibold text-slate-700">Author:</span> <%= reviewkit_actor_label(review.creator) %>
+            </span>
+          <% end %>
+          <span class="reviewkit-review-meta-item"><%= pluralize(review.documents.size, "file") %> changed</span>
+          <span class="reviewkit-review-meta-item"><%= pluralize(review.open_threads_count, "open thread") %></span>
+          <span class="reviewkit-review-meta-item"><%= pluralize(review.resolved_threads_count, "resolved thread") %></span>
+          <span class="reviewkit-review-meta-item">Updated <%= time_ago_in_words(review.updated_at) %> ago</span>
+        </div>
+      </header>
+
+      <div class="reviewkit-review-mobile-summary xl:hidden">
+        <span><%= pluralize(review.documents.size, "file") %></span>
+        <span><%= pluralize(review.open_threads_count, "open thread") %></span>
+        <span><%= pluralize(review.resolved_threads_count, "resolved thread") %></span>
+        <% if review.external_reference.present? %>
+          <span><%= review.external_reference %></span>
+        <% end %>
+      </div>
+
+      <% if review.metadata.present? %>
+        <details class="reviewkit-sidebar-details xl:hidden">
+          <summary>Review metadata</summary>
+          <pre class="reviewkit-code-panel"><%= JSON.pretty_generate(review.metadata) %></pre>
+        </details>
+      <% end %>
+
+      <div class="reviewkit-files-header">
+        <div class="flex items-center gap-2">
+          <h2 class="reviewkit-files-title">Files changed</h2>
+          <span class="reviewkit-files-count"><%= review.documents.size %></span>
+        </div>
+
+        <div class="reviewkit-files-header__controls">
+          <div class="reviewkit-files-diffstat" aria-label="<%= "#{additions} additions and #{deletions} deletions" %>">
+            <span class="font-medium text-emerald-700">+<%= additions %></span>
+            <span class="font-medium text-rose-700">-<%= deletions %></span>
+          </div>
+
+          <div class="reviewkit-view-toggle" role="group" aria-label="Diff layout">
+            <%= link_to "Split",
+              review_path(review, document_id: @selected_document&.id, view: "split"),
+              class: [ "reviewkit-view-toggle__button", ("reviewkit-view-toggle__button--active" if @view_mode == "split") ].compact.join(" "),
+              data: { turbo_frame: frame_id } %>
+            <%= link_to "Unified",
+              review_path(review, document_id: @selected_document&.id, view: "unified"),
+              class: [ "reviewkit-view-toggle__button", ("reviewkit-view-toggle__button--active" if @view_mode == "unified") ].compact.join(" "),
+              data: { turbo_frame: frame_id } %>
+          </div>
+        </div>
+      </div>
+
+      <section class="reviewkit-files-list">
+        <% if @selected_document.present? %>
+          <%= render "reviewkit/reviews/document",
+            document: @selected_document,
+            frame_id: frame_id,
+            open_thread_line_code: @open_thread_line_code,
+            open_thread_side: @open_thread_side,
+            review: review,
+            view_mode: @view_mode,
+            thread_index: thread_index %>
+        <% else %>
+          <div class="reviewkit-panel reviewkit-empty-state">
+            <p class="reviewkit-kicker">No files available</p>
+            <h2 class="text-2xl font-semibold tracking-tight text-slate-950">This review does not have any documents yet.</h2>
+          </div>
+        <% end %>
+      </section>
+    </div>
+  </section>
+</main>

data/app/views/reviewkit/reviews/index.html.erb

@@ -0,0 +1,11 @@
+<% unless reviewkit_frame_request? %>
+  <% content_for :head do %>
+    <%= reviewkit_page_assets %>
+  <% end %>
+
+  <%= reviewkit_page_module_tag %>
+<% end %>
+
+<%= reviewkit_wrap_in_frame do %>
+  <%= render "reviewkit/reviews/index_content", reviews: @reviews %>
+<% end %>

data/app/views/reviewkit/reviews/show.html.erb

@@ -0,0 +1,11 @@
+<% unless reviewkit_frame_request? %>
+  <% content_for :head do %>
+    <%= reviewkit_page_assets %>
+  <% end %>
+
+  <%= reviewkit_page_module_tag %>
+<% end %>
+
+<%= turbo_frame_tag reviewkit_review_frame_id(@review) do %>
+  <%= render "reviewkit/reviews/show_content", review: @review, thread_index: @thread_index %>
+<% end %>

data/app/views/reviewkit/shared/_flash.html.erb

@@ -0,0 +1,10 @@
+<% flash.each do |type, message| %>
+  <% next if message.blank? %>
+
+  <div class="<%= reviewkit_flash_shell_class %>" data-reviewkit-flash-type="<%= type %>">
+    <div class="<%= reviewkit_flash_class(type) %>" role="<%= reviewkit_flash_role(type) %>">
+      <span class="reviewkit-flash__label"><%= reviewkit_flash_label(type) %></span>
+      <span><%= message %></span>
+    </div>
+  </div>
+<% end %>

data/bin/console

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+bundle exec rails console

data/bin/lint

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+bundle exec rubocop "$@"

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/reviewkit/engine", __dir__)
+APP_PATH = File.expand_path("../spec/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+bundle install
+bundle exec rake reviewkit:build_assets
+bundle exec bin/rails app:db:prepare
+
+echo
+echo "Reviewkit is ready."

data/bin/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+bundle exec rspec "$@"

data/config/importmap.rb

@@ -0,0 +1,6 @@
+pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
+pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
+
+pin "reviewkit/application", to: "reviewkit/application.js", preload: true
+pin "reviewkit/controllers/file_nav_controller", to: "reviewkit/controllers/file_nav_controller.js"
+pin "reviewkit/controllers/review_index_controller", to: "reviewkit/controllers/review_index_controller.js"

data/config/routes.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Reviewkit::Engine.routes.draw do
+  root to: "reviews#index"
+
+  resources :reviews, only: %i[index show edit update destroy] do
+    member do
+      patch :approve
+      patch :reject
+    end
+
+    resources :review_threads, only: :create, path: "threads"
+  end
+
+  resources :review_threads, only: %i[show edit update destroy] do
+    member do
+      patch :mark_outdated
+      patch :resolve
+      patch :reopen
+    end
+
+    resources :comments, only: %i[create show edit update destroy]
+  end
+end

data/db/migrate/20260331181500_create_reviewkit_reviews.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CreateReviewkitReviews < ActiveRecord::Migration[8.1]
+  def change
+    create_table :reviewkit_reviews do |t|
+      t.string :title, null: false
+      t.string :status, null: false, default: "draft"
+      t.references :reviewable, polymorphic: true, null: true
+      t.string :external_reference
+      t.references :creator, polymorphic: true, null: true
+      t.json :metadata, null: false, default: {}
+
+      t.timestamps
+    end
+
+    add_index :reviewkit_reviews, :status
+    add_index :reviewkit_reviews, :external_reference
+  end
+end

data/db/migrate/20260331181600_create_reviewkit_documents.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class CreateReviewkitDocuments < ActiveRecord::Migration[8.1]
+  def change
+    create_table :reviewkit_documents do |t|
+      t.references :review, null: false, foreign_key: { to_table: :reviewkit_reviews }
+      t.string :path, null: false
+      t.string :language, null: false, default: "plaintext"
+      t.string :status, null: false, default: "modified"
+      t.integer :position, null: false, default: 0
+      t.text :old_content
+      t.text :new_content
+      t.json :diff_cache, null: false, default: {}
+      t.json :metadata, null: false, default: {}
+
+      t.timestamps
+    end
+
+    add_index :reviewkit_documents, %i[review_id position]
+    add_index :reviewkit_documents, %i[review_id path], unique: true
+    add_index :reviewkit_documents, :status
+  end
+end

data/db/migrate/20260331181700_create_reviewkit_review_threads.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class CreateReviewkitReviewThreads < ActiveRecord::Migration[8.1]
+  def change
+    create_table :reviewkit_review_threads do |t|
+      t.references :review, null: false, foreign_key: { to_table: :reviewkit_reviews }
+      t.references :document, null: false, foreign_key: { to_table: :reviewkit_documents }
+      t.string :status, null: false, default: "open"
+      t.string :side, null: false, default: "new"
+      t.integer :old_line
+      t.integer :new_line
+      t.string :line_code, null: false
+      t.datetime :resolved_at
+      t.references :resolved_by, polymorphic: true, null: true
+      t.json :metadata, null: false, default: {}
+
+      t.timestamps
+    end
+
+    add_index :reviewkit_review_threads, %i[document_id line_code]
+    add_index :reviewkit_review_threads, :status
+  end
+end

data/db/migrate/20260331181800_create_reviewkit_comments.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateReviewkitComments < ActiveRecord::Migration[8.1]
+  def change
+    create_table :reviewkit_comments do |t|
+      t.references :review_thread, null: false, foreign_key: { to_table: :reviewkit_review_threads }
+      t.references :author, polymorphic: true, null: true
+      t.text :body, null: false
+      t.datetime :edited_at
+      t.json :metadata, null: false, default: {}
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20260401093000_add_description_to_reviewkit_reviews.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddDescriptionToReviewkitReviews < ActiveRecord::Migration[8.1]
+  def change
+    add_column :reviewkit_reviews, :description, :text
+  end
+end

data/lib/generators/reviewkit/controllers/controllers_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Reviewkit
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_controller_extensions
+        template "reviews_controller_extension.rb", "app/controllers/concerns/reviewkit/reviews_controller_extension.rb"
+        template "review_threads_controller_extension.rb", "app/controllers/concerns/reviewkit/review_threads_controller_extension.rb"
+        template "comments_controller_extension.rb", "app/controllers/concerns/reviewkit/comments_controller_extension.rb"
+      end
+
+      def print_instructions
+        say ""
+        say "Reviewkit controller extensions installed.", :green
+        say "The engine will automatically prepend these modules on reload."
+        say "Use them to extend permitted params, scopes, redirects, and review flow behavior."
+      end
+    end
+  end
+end

data/lib/generators/reviewkit/controllers/templates/comments_controller_extension.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  module CommentsControllerExtension
+    protected
+
+    def permitted_comment_attributes
+      super
+      # Example:
+      # super + %i[comment_type]
+    end
+  end
+end

data/lib/generators/reviewkit/controllers/templates/review_threads_controller_extension.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  module ReviewThreadsControllerExtension
+    protected
+
+    def permitted_review_thread_attributes
+      super
+      # Example:
+      # super + %i[source_revision_id]
+    end
+  end
+end

data/lib/generators/reviewkit/controllers/templates/reviews_controller_extension.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  module ReviewsControllerExtension
+    protected
+
+    def permitted_review_attributes
+      super
+      # Example:
+      # super + %i[review_type]
+    end
+
+    def review_transition_failure_message(review)
+      super
+      # Example:
+      # "#{super} Resolve content approval blockers before marking this review approved."
+    end
+  end
+end

data/lib/generators/reviewkit/install/install_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Reviewkit
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :mount,
+                   type: :boolean,
+                   default: true,
+                   desc: "Mount Reviewkit::Engine into the host app routes."
+      class_option :mount_path,
+                   type: :string,
+                   default: "/reviewkit",
+                   desc: "Mount path to use when inserting the engine route."
+
+      def copy_initializer
+        template "reviewkit.rb", "config/initializers/reviewkit.rb"
+      end
+
+      def ensure_importmap
+        return if File.exist?(File.join(destination_root, "config", "importmap.rb"))
+
+        template "importmap.rb", "config/importmap.rb"
+      end
+
+      def mount_engine
+        return unless options[:mount]
+
+        route %(mount Reviewkit::Engine => "#{options[:mount_path]}")
+      end
+
+      def install_migrations
+        rake "reviewkit:install:migrations"
+      end
+
+      def print_instructions
+        say ""
+        say "Reviewkit installed.", :green
+        say "Next steps:"
+        say "  1. Run bundle exec rails db:migrate"
+        say "  2. Visit #{options[:mount_path]} once you create review data"
+        say "  3. Keep javascript_importmap_tags in your layout or use reviewkit_assets for a custom Reviewkit layout"
+        say "  4. Optionally run rails g reviewkit:views to copy the shipped UI into the host app"
+        say "  5. Optionally run rails g reviewkit:models for host-side validations, scopes, and callbacks"
+        say "  6. Optionally run rails g reviewkit:controllers to extend permitted params and controller flow"
+      end
+    end
+  end
+end

data/lib/generators/reviewkit/install/templates/importmap.rb

@@ -0,0 +1,3 @@
+# Reviewkit relies on importmap-rails for its Rails-only Hotwire entrypoint.
+# Engine-owned pins are registered automatically; this file exists so Rails can
+# build the host application's import map.

data/lib/generators/reviewkit/install/templates/reviewkit.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+Reviewkit.configure do |config|
+  config.current_actor = lambda do |controller|
+    controller.respond_to?(:current_user, true) ? controller.send(:current_user) : nil
+  end
+
+  config.authorize_action = lambda do |_controller, _action, _record = nil, **_context|
+    true
+  end
+
+  config.layout = "reviewkit/application"
+
+  # Keep intraline highlighting conservative by default so large reviews
+  # fall back to line-level diffs before they become expensive.
+  config.intraline_limits.max_review_files = 50
+  config.intraline_limits.max_changed_lines = 50
+  config.intraline_limits.max_line_length = 500
+end

data/lib/generators/reviewkit/models/models_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Reviewkit
+  module Generators
+    class ModelsGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_model_extensions
+        template "review_extension.rb", "app/models/concerns/reviewkit/review_extension.rb"
+        template "review_thread_extension.rb", "app/models/concerns/reviewkit/review_thread_extension.rb"
+        template "comment_extension.rb", "app/models/concerns/reviewkit/comment_extension.rb"
+      end
+
+      def print_instructions
+        say ""
+        say "Reviewkit model extensions installed.", :green
+        say "The engine will automatically include these concerns on reload."
+        say "Use them to add validations, scopes, and standard Active Record callbacks."
+      end
+    end
+  end
+end

data/lib/generators/reviewkit/models/templates/comment_extension.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  module CommentExtension
+    extend ActiveSupport::Concern
+
+    included do
+      # Example:
+      #
+      # before_validation :normalize_comment_source
+      # after_update :track_comment_edits, if: :saved_change_to_body?
+    end
+
+    private
+
+    def normalize_comment_source
+      # Example:
+      # metadata["source"] ||= "host_app"
+    end
+  end
+end

data/lib/generators/reviewkit/models/templates/review_extension.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  module ReviewExtension
+    extend ActiveSupport::Concern
+
+    included do
+      # Example:
+      #
+      # validates :review_type, presence: true
+      #
+      # after_update :notify_host_workflow, if: :saved_change_to_status?
+    end
+
+    private
+
+    def notify_host_workflow
+      # Example:
+      # HostReviewSyncJob.perform_later(id) if approved?
+    end
+  end
+end

data/lib/generators/reviewkit/models/templates/review_thread_extension.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  module ReviewThreadExtension
+    extend ActiveSupport::Concern
+
+    included do
+      # Example:
+      #
+      # validate :ensure_thread_context_is_present
+      # after_update :notify_thread_status_change, if: :saved_change_to_status?
+    end
+
+    private
+
+    def ensure_thread_context_is_present
+      # Example:
+      # errors.add(:metadata, "must include a resource_id") if metadata["resource_id"].blank?
+    end
+  end
+end

data/lib/generators/reviewkit/views/views_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Reviewkit
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../", __dir__)
+
+      def copy_views
+        directory "app/views/reviewkit", "app/views/reviewkit"
+      end
+    end
+  end
+end