reviewkit 0.1.0

data/lib/reviewkit/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  class Configuration
+    DEFAULT_LAYOUT = "reviewkit/application"
+
+    class IntralineLimits
+      attr_accessor :enabled,
+                    :max_review_files,
+                    :max_changed_lines,
+                    :max_line_length
+
+      def initialize
+        @enabled = true
+        @max_review_files = 50
+        @max_changed_lines = 50
+        @max_line_length = 500
+      end
+    end
+
+    attr_accessor :authorize_action,
+                  :current_actor,
+                  :intraline_limits,
+                  :layout
+
+    def initialize
+      @authorize_action = ->(_controller, _action, _record = nil, **_context) { true }
+      @current_actor = ->(controller) { controller.respond_to?(:current_user, true) ? controller.send(:current_user) : nil }
+      @intraline_limits = IntralineLimits.new
+      @layout = DEFAULT_LAYOUT
+    end
+  end
+end

data/lib/reviewkit/engine.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  class Engine < ::Rails::Engine
+    isolate_namespace Reviewkit
+
+    class << self
+      def include_host_extension(base_class, extension_name)
+        extension = extension_name.safe_constantize
+        return unless extension
+        return if base_class < extension
+
+        base_class.include(extension)
+      end
+
+      def prepend_host_extension(base_class, extension_name)
+        extension = extension_name.safe_constantize
+        return unless extension
+        return if base_class < extension
+
+        base_class.prepend(extension)
+      end
+    end
+
+    initializer "reviewkit.importmap", before: "importmap" do |app|
+      next unless app.config.respond_to?(:importmap)
+
+      app.config.importmap.paths << root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+    end
+
+    initializer "reviewkit.assets" do |app|
+      app.config.assets.paths << root.join("app/assets/builds")
+      app.config.assets.precompile += %w[
+        reviewkit/application.css
+        reviewkit/application.js
+      ] if app.config.respond_to?(:assets)
+    end
+
+    initializer "reviewkit.turbo_stream" do
+      Mime::Type.register "text/vnd.turbo-stream.html", :turbo_stream unless Mime[:turbo_stream]
+    end
+
+    initializer "reviewkit.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper Reviewkit::ApplicationHelper
+      end
+    end
+
+    initializer "reviewkit.host_extensions" do
+      ActiveSupport::Reloader.to_prepare do
+        Engine.include_host_extension(Reviewkit::Review, "Reviewkit::ReviewExtension")
+        Engine.include_host_extension(Reviewkit::ReviewThread, "Reviewkit::ReviewThreadExtension")
+        Engine.include_host_extension(Reviewkit::Comment, "Reviewkit::CommentExtension")
+
+        Engine.prepend_host_extension(Reviewkit::ReviewsController, "Reviewkit::ReviewsControllerExtension")
+        Engine.prepend_host_extension(Reviewkit::ReviewThreadsController, "Reviewkit::ReviewThreadsControllerExtension")
+        Engine.prepend_host_extension(Reviewkit::CommentsController, "Reviewkit::CommentsControllerExtension")
+      end
+    end
+  end
+end

data/lib/reviewkit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Reviewkit
+  VERSION = "0.1.0"
+end

data/lib/reviewkit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "importmap-rails"
+require "turbo-rails"
+require "reviewkit/version"
+require "reviewkit/configuration"
+require "reviewkit/engine"
+
+module Reviewkit
+  class Error < StandardError; end
+  class AuthorizationError < Error; end
+
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def reset_configuration!
+      @config = Configuration.new
+    end
+  end
+end

data/lib/tasks/reviewkit_tasks.rake

@@ -0,0 +1,12 @@
+tailwind_input = "app/assets/tailwind/reviewkit/application.css"
+tailwind_output = "app/assets/builds/reviewkit/application.css"
+
+namespace :reviewkit do
+  desc "Build the engine's shipped TailwindCSS asset"
+  task :build_css do
+    sh "bundle exec tailwindcss -i #{tailwind_input} -o #{tailwind_output} --minify"
+  end
+
+  desc "Build the engine's shipped frontend assets"
+  task build_assets: :build_css
+end

data/sig/reviewkit.rbs

@@ -0,0 +1,129 @@
+module Reviewkit
+  VERSION: ::String
+
+  class Error < ::StandardError
+  end
+
+  class AuthorizationError < Error
+  end
+
+  type metadata = ::Hash[::String | ::Symbol, untyped]
+  type attributes = ::Hash[::String | ::Symbol, untyped]
+  type diff_row = ::Hash[::String, untyped]
+  type review_status = "draft" | "open" | "approved" | "rejected" | "closed"
+  type document_status = "added" | "removed" | "modified" | "unchanged"
+  type thread_status = "open" | "resolved" | "outdated"
+
+  def self.config: () -> Configuration
+  def self.configure: () { (Configuration config) -> untyped } -> void
+  def self.reset_configuration!: () -> Configuration
+
+  class Configuration
+    DEFAULT_LAYOUT: ::String
+
+    attr_accessor authorize_action: untyped
+    attr_accessor current_actor: untyped
+    attr_accessor intraline_limits: IntralineLimits
+    attr_accessor layout: ::String
+
+    def initialize: () -> void
+
+    class IntralineLimits
+      attr_accessor enabled: bool
+      attr_accessor max_review_files: ::Integer?
+      attr_accessor max_changed_lines: ::Integer?
+      attr_accessor max_line_length: ::Integer?
+
+      def initialize: () -> void
+    end
+  end
+
+  class Current
+    def self.actor: () -> untyped
+    def self.controller: () -> untyped
+    def self.source: () -> untyped
+    def self.set: (?actor: untyped, ?controller: untyped, ?source: untyped) { () -> untyped } -> untyped
+  end
+
+  class Review
+    attr_accessor title: ::String
+    attr_accessor description: ::String?
+    attr_accessor external_reference: ::String?
+    attr_accessor metadata: metadata?
+    attr_accessor status: review_status
+    attr_accessor creator: untyped
+    attr_accessor reviewable: untyped
+
+    def open_threads_count: () -> ::Integer
+    def resolved_threads_count: () -> ::Integer
+    def approve!: () -> bool
+    def reject!: () -> bool
+    def close!: () -> bool
+  end
+
+  class Document
+    attr_accessor intraline_review_document_count: ::Integer?
+    attr_accessor path: ::String
+    attr_accessor language: ::String
+    attr_accessor old_content: ::String?
+    attr_accessor new_content: ::String?
+    attr_accessor metadata: metadata?
+    attr_accessor position: ::Integer
+    attr_accessor status: document_status
+    attr_accessor diff_cache: ::Hash[::String, untyped]
+
+    def additions_count: () -> ::Integer
+    def deletions_count: () -> ::Integer
+    def diff_rows: () -> ::Array[diff_row]
+  end
+
+  class ReviewThread
+    attr_accessor line_code: ::String
+    attr_accessor side: "old" | "new"
+    attr_accessor old_line: ::Integer?
+    attr_accessor new_line: ::Integer?
+    attr_accessor metadata: metadata?
+    attr_accessor status: thread_status
+    attr_accessor resolved_by: untyped
+
+    def resolve!: () -> bool
+    def reopen!: () -> bool
+    def mark_outdated!: () -> bool
+  end
+
+  class Comment
+    attr_accessor body: ::String
+    attr_accessor metadata: metadata?
+    attr_accessor author: untyped
+  end
+
+  module Reviews
+    class Create
+      def self.call: (
+        title: ::String,
+        ?description: ::String?,
+        ?creator: untyped,
+        ?reviewable: untyped,
+        ?external_reference: ::String?,
+        ?metadata: metadata,
+        ?review_attributes: attributes,
+        ?status: review_status,
+        ?documents: ::Array[attributes]
+      ) -> Review
+
+      def initialize: (
+        title: ::String,
+        ?description: ::String?,
+        ?creator: untyped,
+        ?reviewable: untyped,
+        ?external_reference: ::String?,
+        ?metadata: metadata,
+        ?review_attributes: attributes,
+        ?status: review_status,
+        ?documents: ::Array[attributes]
+      ) -> void
+
+      def call: () -> Review
+    end
+  end
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: reviewkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhairya Gabhawala
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Reviewkit is a mountable Rails engine for rendering Git-like code diffs,
+  persisting threaded line comments, and embedding review workflows into host apps.
+email:
+- gabhawaladhairya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- SECURITY.md
+- app/assets/builds/reviewkit/application.css
+- app/assets/javascripts/reviewkit/application.js
+- app/assets/javascripts/reviewkit/controllers/file_nav_controller.js
+- app/assets/javascripts/reviewkit/controllers/review_index_controller.js
+- app/assets/tailwind/reviewkit/application.css
+- app/controllers/reviewkit/application_controller.rb
+- app/controllers/reviewkit/comments_controller.rb
+- app/controllers/reviewkit/review_threads_controller.rb
+- app/controllers/reviewkit/reviews_controller.rb
+- app/helpers/reviewkit/application_helper.rb
+- app/helpers/reviewkit/asset_helper.rb
+- app/helpers/reviewkit/diff_helper.rb
+- app/helpers/reviewkit/flash_helper.rb
+- app/helpers/reviewkit/frame_helper.rb
+- app/helpers/reviewkit/icon_helper.rb
+- app/helpers/reviewkit/review_thread_helper.rb
+- app/models/concerns/reviewkit/notifies_lifecycle_events.rb
+- app/models/reviewkit/application_record.rb
+- app/models/reviewkit/comment.rb
+- app/models/reviewkit/current.rb
+- app/models/reviewkit/document.rb
+- app/models/reviewkit/review.rb
+- app/models/reviewkit/review_thread.rb
+- app/services/reviewkit/diffs/intraline_budget.rb
+- app/services/reviewkit/diffs/intraline_diff.rb
+- app/services/reviewkit/diffs/split_diff.rb
+- app/services/reviewkit/reviews/create.rb
+- app/views/layouts/reviewkit/application.html.erb
+- app/views/reviewkit/comments/_comment.html.erb
+- app/views/reviewkit/comments/_edit_form.html.erb
+- app/views/reviewkit/comments/_form.html.erb
+- app/views/reviewkit/review_threads/_bucket.html.erb
+- app/views/reviewkit/review_threads/_bucket_frame.html.erb
+- app/views/reviewkit/review_threads/_bucket_row.html.erb
+- app/views/reviewkit/review_threads/_edit_form.html.erb
+- app/views/reviewkit/review_threads/_thread.html.erb
+- app/views/reviewkit/reviews/_document.html.erb
+- app/views/reviewkit/reviews/_document_split.html.erb
+- app/views/reviewkit/reviews/_document_unified.html.erb
+- app/views/reviewkit/reviews/_edit_form.html.erb
+- app/views/reviewkit/reviews/_index_content.html.erb
+- app/views/reviewkit/reviews/_review_sidebar.html.erb
+- app/views/reviewkit/reviews/_show_content.html.erb
+- app/views/reviewkit/reviews/index.html.erb
+- app/views/reviewkit/reviews/show.html.erb
+- app/views/reviewkit/shared/_flash.html.erb
+- bin/console
+- bin/lint
+- bin/rails
+- bin/setup
+- bin/test
+- config/importmap.rb
+- config/routes.rb
+- db/migrate/20260331181500_create_reviewkit_reviews.rb
+- db/migrate/20260331181600_create_reviewkit_documents.rb
+- db/migrate/20260331181700_create_reviewkit_review_threads.rb
+- db/migrate/20260331181800_create_reviewkit_comments.rb
+- db/migrate/20260401093000_add_description_to_reviewkit_reviews.rb
+- lib/generators/reviewkit/controllers/controllers_generator.rb
+- lib/generators/reviewkit/controllers/templates/comments_controller_extension.rb
+- lib/generators/reviewkit/controllers/templates/review_threads_controller_extension.rb
+- lib/generators/reviewkit/controllers/templates/reviews_controller_extension.rb
+- lib/generators/reviewkit/install/install_generator.rb
+- lib/generators/reviewkit/install/templates/importmap.rb
+- lib/generators/reviewkit/install/templates/reviewkit.rb
+- lib/generators/reviewkit/models/models_generator.rb
+- lib/generators/reviewkit/models/templates/comment_extension.rb
+- lib/generators/reviewkit/models/templates/review_extension.rb
+- lib/generators/reviewkit/models/templates/review_thread_extension.rb
+- lib/generators/reviewkit/views/views_generator.rb
+- lib/reviewkit.rb
+- lib/reviewkit/configuration.rb
+- lib/reviewkit/engine.rb
+- lib/reviewkit/version.rb
+- lib/tasks/reviewkit_tasks.rake
+- sig/reviewkit.rbs
+homepage: https://reviewkit.dhairyagabhawala.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://reviewkit.dhairyagabhawala.com
+  source_code_uri: https://github.com/dhairyagabha/reviewkit
+  bug_tracker_uri: https://github.com/dhairyagabha/reviewkit/issues
+  changelog_uri: https://github.com/dhairyagabha/reviewkit/blob/main/CHANGELOG.md
+  documentation_uri: https://reviewkit.dhairyagabhawala.com/docs/installation
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Git-style code review Rails engine with diff rendering and threaded line
+  comments.
+test_files: []