coplan-engine 0.1.0

data/db/migrate/20260226200000_create_coplan_schema.rb

@@ -0,0 +1,173 @@
+class CreateCoplanSchema < ActiveRecord::Migration[8.1]
+  def change
+    create_table :coplan_users, id: { type: :string, limit: 36 } do |t|
+      t.string :external_id, null: false
+      t.string :email
+      t.string :name, null: false
+      t.boolean :admin, default: false, null: false
+      t.json :metadata
+      t.timestamps
+    end
+
+    add_index :coplan_users, :external_id, unique: true
+    add_index :coplan_users, :email, unique: true
+
+    create_table :coplan_plans, id: { type: :string, limit: 36 } do |t|
+      t.string :title, null: false
+      t.string :status, default: "brainstorm", null: false
+      t.integer :current_revision, default: 0, null: false
+      t.string :created_by_user_id, limit: 36, null: false
+      t.string :current_plan_version_id, limit: 36
+      t.json :tags
+      t.json :metadata
+      t.timestamps
+    end
+
+    add_index :coplan_plans, :status
+    add_index :coplan_plans, :updated_at
+    add_index :coplan_plans, :created_by_user_id
+    add_foreign_key :coplan_plans, :coplan_users, column: :created_by_user_id
+
+    create_table :coplan_plan_versions, id: { type: :string, limit: 36 } do |t|
+      t.string :plan_id, limit: 36, null: false
+      t.integer :revision, null: false
+      t.text :content_markdown, null: false
+      t.string :content_sha256, null: false
+      t.text :diff_unified
+      t.text :change_summary
+      t.text :reason
+      t.text :prompt_excerpt
+      t.json :operations_json
+      t.integer :base_revision
+      t.string :actor_id, limit: 36
+      t.string :actor_type, null: false
+      t.string :ai_provider
+      t.string :ai_model
+      t.timestamp :created_at, null: false
+    end
+
+    add_index :coplan_plan_versions, :plan_id
+    add_index :coplan_plan_versions, [:plan_id, :revision], unique: true
+    add_index :coplan_plan_versions, [:plan_id, :created_at]
+    add_foreign_key :coplan_plan_versions, :coplan_plans, column: :plan_id
+
+    # Now that coplan_plan_versions exists, add the FK for current_plan_version_id
+    add_foreign_key :coplan_plans, :coplan_plan_versions, column: :current_plan_version_id
+
+    create_table :coplan_plan_collaborators, id: { type: :string, limit: 36 } do |t|
+      t.string :plan_id, limit: 36, null: false
+      t.string :user_id, limit: 36, null: false
+      t.string :added_by_user_id, limit: 36
+      t.string :role, null: false
+      t.timestamps
+    end
+
+    add_index :coplan_plan_collaborators, :plan_id
+    add_index :coplan_plan_collaborators, :user_id
+    add_index :coplan_plan_collaborators, :added_by_user_id
+    add_index :coplan_plan_collaborators, [:plan_id, :user_id], unique: true
+    add_foreign_key :coplan_plan_collaborators, :coplan_plans, column: :plan_id
+    add_foreign_key :coplan_plan_collaborators, :coplan_users, column: :user_id
+    add_foreign_key :coplan_plan_collaborators, :coplan_users, column: :added_by_user_id
+
+    create_table :coplan_comment_threads, id: { type: :string, limit: 36 } do |t|
+      t.string :plan_id, limit: 36, null: false
+      t.string :plan_version_id, limit: 36, null: false
+      t.string :created_by_user_id, limit: 36, null: false
+      t.string :resolved_by_user_id, limit: 36
+      t.string :addressed_in_plan_version_id, limit: 36
+      t.string :out_of_date_since_version_id, limit: 36
+      t.string :status, default: "open", null: false
+      t.boolean :out_of_date, default: false, null: false
+      t.text :anchor_text
+      t.text :anchor_context
+      t.integer :anchor_start
+      t.integer :anchor_end
+      t.integer :anchor_revision
+      t.integer :start_line
+      t.integer :end_line
+      t.timestamps
+    end
+
+    add_index :coplan_comment_threads, [:plan_id, :status]
+    add_index :coplan_comment_threads, [:plan_id, :out_of_date]
+    add_foreign_key :coplan_comment_threads, :coplan_plans, column: :plan_id
+    add_foreign_key :coplan_comment_threads, :coplan_plan_versions, column: :plan_version_id
+    add_foreign_key :coplan_comment_threads, :coplan_plan_versions, column: :addressed_in_plan_version_id
+    add_foreign_key :coplan_comment_threads, :coplan_plan_versions, column: :out_of_date_since_version_id
+    add_foreign_key :coplan_comment_threads, :coplan_users, column: :created_by_user_id
+    add_foreign_key :coplan_comment_threads, :coplan_users, column: :resolved_by_user_id
+
+    create_table :coplan_comments, id: { type: :string, limit: 36 } do |t|
+      t.string :comment_thread_id, limit: 36, null: false
+      t.string :author_id, limit: 36
+      t.string :author_type, null: false
+      t.string :agent_name
+      t.text :body_markdown, null: false
+      t.timestamps
+    end
+
+    add_index :coplan_comments, [:comment_thread_id, :created_at]
+    add_foreign_key :coplan_comments, :coplan_comment_threads, column: :comment_thread_id
+
+    create_table :coplan_edit_leases, id: { type: :string, limit: 36 } do |t|
+      t.string :plan_id, limit: 36, null: false
+      t.string :holder_id, limit: 36
+      t.string :holder_type, null: false
+      t.string :lease_token_digest, null: false
+      t.timestamp :expires_at, null: false
+      t.timestamp :last_heartbeat_at, null: false
+      t.timestamps
+    end
+
+    add_index :coplan_edit_leases, :plan_id, unique: true
+    add_foreign_key :coplan_edit_leases, :coplan_plans, column: :plan_id
+
+    create_table :coplan_edit_sessions, id: { type: :string, limit: 36 } do |t|
+      t.string :plan_id, limit: 36, null: false
+      t.string :plan_version_id, limit: 36
+      t.string :actor_id, limit: 36
+      t.string :actor_type, null: false
+      t.string :status, default: "open", null: false
+      t.integer :base_revision, null: false
+      t.text :draft_content, size: :long
+      t.text :change_summary
+      t.json :operations_json, null: false
+      t.timestamp :expires_at, null: false
+      t.timestamp :committed_at
+      t.timestamps
+    end
+
+    add_index :coplan_edit_sessions, [:plan_id, :status]
+    add_foreign_key :coplan_edit_sessions, :coplan_plans, column: :plan_id
+    add_foreign_key :coplan_edit_sessions, :coplan_plan_versions, column: :plan_version_id
+
+    create_table :coplan_api_tokens, id: { type: :string, limit: 36 } do |t|
+      t.string :user_id, limit: 36, null: false
+      t.string :name, null: false
+      t.string :token_digest, null: false
+      t.string :token_prefix, limit: 8
+      t.timestamp :expires_at
+      t.timestamp :revoked_at
+      t.timestamp :last_used_at
+      t.timestamps
+    end
+
+    add_index :coplan_api_tokens, :user_id
+    add_index :coplan_api_tokens, :token_digest, unique: true
+    add_foreign_key :coplan_api_tokens, :coplan_users, column: :user_id
+
+    create_table :coplan_automated_plan_reviewers, id: { type: :string, limit: 36 } do |t|
+      t.string :key, null: false
+      t.string :name, null: false
+      t.text :prompt_text, null: false
+      t.string :ai_provider, default: "openai", null: false
+      t.string :ai_model, null: false
+      t.json :trigger_statuses, null: false
+      t.boolean :enabled, default: true, null: false
+      t.timestamps
+    end
+
+    add_index :coplan_automated_plan_reviewers, :key, unique: true
+  end
+end

data/lib/coplan/configuration.rb

@@ -0,0 +1,17 @@
+module CoPlan
+  class Configuration
+    attr_accessor :authenticate, :api_authenticate, :sign_in_path
+    attr_accessor :ai_base_url, :ai_api_key, :ai_model
+    attr_accessor :error_reporter
+    attr_accessor :notification_handler
+
+    def initialize
+      @authenticate = nil
+      @ai_base_url = "https://api.openai.com/v1"
+      @ai_api_key = nil
+      @ai_model = "gpt-4o"
+      @error_reporter = ->(exception, context) { Rails.error.report(exception, context: context) }
+      @notification_handler = nil
+    end
+  end
+end

data/lib/coplan/engine.rb

@@ -0,0 +1,34 @@
+module CoPlan
+  class Engine < ::Rails::Engine
+    isolate_namespace CoPlan
+
+    initializer "coplan.autoloader", before: :set_autoload_paths do
+      Rails.autoloaders.each do |autoloader|
+        autoloader.inflector.inflect("coplan" => "CoPlan")
+      end
+    end
+
+    initializer "coplan.importmap", before: "importmap" do |app|
+      app.config.importmap.paths << Engine.root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << Engine.root.join("app/javascript")
+    end
+
+    initializer "coplan.assets" do |app|
+      app.config.assets.paths << Engine.root.join("app/assets/stylesheets")
+      app.config.assets.paths << Engine.root.join("app/javascript")
+    end
+
+    initializer "coplan.factories", after: "factory_bot.set_factory_paths" do
+      if defined?(FactoryBot)
+        FactoryBot.definition_file_paths << Engine.root.join("spec", "factories")
+      end
+    end
+
+  end
+
+  # Override table name prefix: isolate_namespace generates "co_plan_"
+  # from CoPlan.underscore, but our tables use "coplan_"
+  ActiveSupport.on_load(:active_record) do
+    CoPlan.singleton_class.redefine_method(:table_name_prefix) { "coplan_" }
+  end
+end

data/lib/coplan/version.rb

@@ -0,0 +1,3 @@
+module CoPlan
+  VERSION = "0.1.0"
+end

data/lib/coplan.rb

@@ -0,0 +1,15 @@
+require "commonmarker"
+require "coplan/configuration"
+require "coplan/engine"
+
+module CoPlan
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/tasks/coplan.rake

@@ -0,0 +1,4 @@
+# Automatically copy engine migrations before db:migrate so hosts
+# never silently fall behind on schema changes.
+# Rails derives the task name from CoPlan → co_plan.
+Rake::Task["db:migrate"].enhance(["co_plan:install:migrations"]) if Rake::Task.task_defined?("db:migrate")

data/prompts/reviewers/routing.md

@@ -0,0 +1,14 @@
+You are an architecture reviewer focused on system routing and API design.
+
+Review the following plan for routing and API design concerns. Focus on:
+
+- REST conventions and resource naming
+- URL structure and consistency
+- API versioning strategy
+- Request/response payload design
+- Error handling patterns
+- Middleware and filter chains
+
+Be specific. Reference the relevant sections of the plan. Suggest concrete improvements where possible.
+
+Respond in Markdown. Keep your review concise and actionable.

data/prompts/reviewers/scalability.md

@@ -0,0 +1,14 @@
+You are a scalability reviewer for technical plans and proposals.
+
+Review the following plan for scalability concerns. Focus on:
+
+- Database query patterns and indexing strategies
+- Caching opportunities and cache invalidation
+- Background job volume and queue contention
+- API rate limits and throughput bottlenecks
+- Data growth projections and storage implications
+- Horizontal vs vertical scaling considerations
+
+Be specific. Reference the relevant sections of the plan. Suggest concrete improvements where possible.
+
+Respond in Markdown. Keep your review concise and actionable.

data/prompts/reviewers/security.md

@@ -0,0 +1,14 @@
+You are a security reviewer for technical plans and proposals.
+
+Review the following plan for security concerns. Focus on:
+
+- Authentication and authorization gaps
+- Data exposure or leakage risks
+- Input validation and injection vulnerabilities
+- Secrets management issues
+- Network and infrastructure security
+- Compliance considerations
+
+Be specific. Reference the relevant sections of the plan. Suggest concrete improvements where possible.
+
+Respond in Markdown. Keep your review concise and actionable.

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: coplan-engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Block
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails Engine for collaborative plan review with AI-powered feedback.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/stylesheets/coplan/application.css
+- app/controllers/coplan/api/v1/base_controller.rb
+- app/controllers/coplan/api/v1/comments_controller.rb
+- app/controllers/coplan/api/v1/leases_controller.rb
+- app/controllers/coplan/api/v1/operations_controller.rb
+- app/controllers/coplan/api/v1/plans_controller.rb
+- app/controllers/coplan/api/v1/sessions_controller.rb
+- app/controllers/coplan/application_controller.rb
+- app/controllers/coplan/automated_reviews_controller.rb
+- app/controllers/coplan/comment_threads_controller.rb
+- app/controllers/coplan/comments_controller.rb
+- app/controllers/coplan/dashboard_controller.rb
+- app/controllers/coplan/plan_versions_controller.rb
+- app/controllers/coplan/plans_controller.rb
+- app/controllers/coplan/settings/tokens_controller.rb
+- app/helpers/coplan/application_helper.rb
+- app/helpers/coplan/comments_helper.rb
+- app/helpers/coplan/markdown_helper.rb
+- app/javascript/controllers/coplan/dropdown_controller.js
+- app/javascript/controllers/coplan/line_selection_controller.js
+- app/javascript/controllers/coplan/tabs_controller.js
+- app/javascript/controllers/coplan/text_selection_controller.js
+- app/jobs/coplan/application_job.rb
+- app/jobs/coplan/automated_review_job.rb
+- app/jobs/coplan/commit_expired_session_job.rb
+- app/jobs/coplan/notification_job.rb
+- app/models/coplan/api_token.rb
+- app/models/coplan/application_record.rb
+- app/models/coplan/automated_plan_reviewer.rb
+- app/models/coplan/comment.rb
+- app/models/coplan/comment_thread.rb
+- app/models/coplan/current.rb
+- app/models/coplan/edit_lease.rb
+- app/models/coplan/edit_session.rb
+- app/models/coplan/plan.rb
+- app/models/coplan/plan_collaborator.rb
+- app/models/coplan/plan_version.rb
+- app/models/coplan/user.rb
+- app/policies/coplan/application_policy.rb
+- app/policies/coplan/comment_thread_policy.rb
+- app/policies/coplan/plan_policy.rb
+- app/services/coplan/ai_providers/anthropic.rb
+- app/services/coplan/ai_providers/open_ai.rb
+- app/services/coplan/broadcaster.rb
+- app/services/coplan/plans/apply_operations.rb
+- app/services/coplan/plans/commit_session.rb
+- app/services/coplan/plans/create.rb
+- app/services/coplan/plans/operation_error.rb
+- app/services/coplan/plans/position_resolver.rb
+- app/services/coplan/plans/review_prompt_formatter.rb
+- app/services/coplan/plans/review_response_parser.rb
+- app/services/coplan/plans/transform_range.rb
+- app/services/coplan/plans/trigger_automated_reviews.rb
+- app/views/coplan/comment_threads/_new_comment_form.html.erb
+- app/views/coplan/comment_threads/_reply_form.html.erb
+- app/views/coplan/comment_threads/_thread.html.erb
+- app/views/coplan/comments/_comment.html.erb
+- app/views/coplan/dashboard/show.html.erb
+- app/views/coplan/plan_versions/index.html.erb
+- app/views/coplan/plan_versions/show.html.erb
+- app/views/coplan/plans/_header.html.erb
+- app/views/coplan/plans/edit.html.erb
+- app/views/coplan/plans/index.html.erb
+- app/views/coplan/plans/show.html.erb
+- app/views/coplan/settings/tokens/_form.html.erb
+- app/views/coplan/settings/tokens/_token_reveal.html.erb
+- app/views/coplan/settings/tokens/_token_row.html.erb
+- app/views/coplan/settings/tokens/create.turbo_stream.erb
+- app/views/coplan/settings/tokens/destroy.turbo_stream.erb
+- app/views/coplan/settings/tokens/index.html.erb
+- app/views/layouts/coplan/application.html.erb
+- config/importmap.rb
+- config/routes.rb
+- db/migrate/20260226200000_create_coplan_schema.rb
+- lib/coplan.rb
+- lib/coplan/configuration.rb
+- lib/coplan/engine.rb
+- lib/coplan/version.rb
+- lib/tasks/coplan.rake
+- prompts/reviewers/routing.md
+- prompts/reviewers/scalability.md
+- prompts/reviewers/security.md
+licenses:
+- Apache-2.0
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: CoPlan — AI-assisted engineering design doc review
+test_files: []