coplan-engine 0.4.0 → 1.0.0

data/app/models/coplan/plan.rb

@@ -10,6 +10,7 @@ module CoPlan
     has_many :comment_threads, dependent: :destroy
     has_many :edit_sessions, dependent: :destroy
     has_one :edit_lease, dependent: :destroy
+    has_many :plan_viewers, dependent: :destroy
 
     after_initialize { self.tags ||= [] }
     after_initialize { self.metadata ||= {} }

data/app/models/coplan/plan_viewer.rb

@@ -0,0 +1,26 @@
+module CoPlan
+  class PlanViewer < ApplicationRecord
+    STALE_THRESHOLD = 45.seconds
+
+    belongs_to :plan
+    belongs_to :user, class_name: "CoPlan::User"
+
+    scope :active, -> { where(last_seen_at: STALE_THRESHOLD.ago..) }
+
+    def self.track(plan:, user:)
+      record = find_or_initialize_by(plan: plan, user: user)
+      record.update!(last_seen_at: Time.current)
+      record
+    rescue ActiveRecord::RecordNotUnique
+      retry
+    end
+
+    def self.expire(plan:, user:)
+      where(plan: plan, user: user).update_all(last_seen_at: STALE_THRESHOLD.ago - 1.second)
+    end
+
+    def self.active_viewers_for(plan)
+      active.where(plan: plan).joins(:user).includes(:user).order("coplan_users.name").map(&:user)
+    end
+  end
+end

data/app/services/coplan/plans/markdown_text_extractor.rb

@@ -0,0 +1,142 @@
+module CoPlan
+  module Plans
+    # Extracts plain text from markdown using the Commonmarker AST, returning
+    # [stripped_string, position_map] where position_map[i] is the character
+    # index in the raw content of stripped_string[i].
+    #
+    # This handles all markdown constructs: inline formatting (`**`, `*`, `` ` ``,
+    # `~~`), tables, links, images, lists, blockquotes, headings, etc.
+    #
+    # Usage:
+    #   stripped, pos_map = MarkdownTextExtractor.call("Hello **world**")
+    #   # stripped  => "Hello world"
+    #   # pos_map   => [0, 1, 2, 3, 4, 5, 8, 9, 10, 11, 12]
+    class MarkdownTextExtractor
+      def self.call(content)
+        new(content).call
+      end
+
+      def initialize(content)
+        @content = content
+      end
+
+      def call
+        doc = Commonmarker.parse(@content)
+        byte_to_char = build_byte_to_char_map
+        line_byte_offsets = build_line_byte_offsets
+        stripped = +""
+        pos_map = []
+
+        extract_text_nodes(doc, line_byte_offsets, byte_to_char, stripped, pos_map)
+
+        [stripped, pos_map]
+      end
+
+      private
+
+      # Builds a map from byte offset to character index. Commonmarker reports
+      # source positions using byte-based columns, but Ruby string indexing
+      # uses character positions.
+      def build_byte_to_char_map
+        map = {}
+        byte_offset = 0
+        @content.each_char.with_index do |char, char_idx|
+          map[byte_offset] = char_idx
+          byte_offset += char.bytesize
+        end
+        map
+      end
+
+      # Builds an array mapping 1-based line numbers to byte offsets.
+      # line_byte_offsets[line_number] = byte offset of the first byte on that line.
+      def build_line_byte_offsets
+        offsets = [nil, 0] # index 0 unused; line 1 starts at byte 0
+        byte_offset = 0
+        @content.each_char do |char|
+          byte_offset += char.bytesize
+          offsets << byte_offset if char == "\n"
+        end
+        offsets
+      end
+
+      # Block-level node types that should be separated by newlines.
+      BLOCK_TYPES = %i[paragraph heading table table_row item block_quote list code_block].to_set.freeze
+
+      # Recursively walks the AST, appending text content to `stripped` and
+      # character-index mappings to `pos_map`. Inserts whitespace between
+      # block elements and table cells to match browser DOM text behavior.
+      def extract_text_nodes(node, line_byte_offsets, byte_to_char, stripped, pos_map)
+        prev_was_block = false
+
+        node.each do |child|
+          # Insert a space between adjacent table cells, and a newline
+          # between block-level siblings (paragraphs, rows, items, etc.).
+          if child.type == :table_cell
+            append_separator(stripped, pos_map, " ") if prev_was_block
+            prev_was_block = true
+          elsif BLOCK_TYPES.include?(child.type)
+            append_separator(stripped, pos_map, "\n") if prev_was_block
+            prev_was_block = true
+          end
+
+          case child.type
+          when :text
+            pos = child.source_position
+            start_byte = line_byte_offsets[pos[:start_line]] + pos[:start_column] - 1
+            char_idx = byte_to_char[start_byte]
+            child.string_content.each_char.with_index do |char, i|
+              stripped << char
+              pos_map << (char_idx + i)
+            end
+          when :code
+            # source_position includes backtick delimiters; find the inner
+            # content start by scanning past them in the raw string.
+            pos = child.source_position
+            start_byte = line_byte_offsets[pos[:start_line]] + pos[:start_column] - 1
+            node_char_start = byte_to_char[start_byte]
+            end_byte = line_byte_offsets[pos[:end_line]] + pos[:end_column] - 1
+            node_char_end = byte_to_char[end_byte]
+            text = child.string_content
+            node_char_len = node_char_end - node_char_start + 1
+            tick_len = (node_char_len - text.length) / 2
+            content_char_start = node_char_start + tick_len
+            text.each_char.with_index do |char, i|
+              stripped << char
+              pos_map << (content_char_start + i)
+            end
+          when :code_block
+            # Fenced code blocks: source_position spans from the opening
+            # fence to the closing fence. The string_content is the inner
+            # text (excluding fences). Content starts on the line after
+            # the opening fence.
+            pos = child.source_position
+            text = child.string_content
+            content_line = pos[:start_line] + 1
+            if content_line <= line_byte_offsets.length - 1
+              content_byte = line_byte_offsets[content_line]
+              char_idx = byte_to_char[content_byte]
+              text.each_char.with_index do |char, i|
+                stripped << char
+                pos_map << (char_idx + i)
+              end
+            end
+          when :softbreak, :linebreak
+            pos = child.source_position
+            start_byte = line_byte_offsets[pos[:start_line]] + pos[:start_column] - 1
+            stripped << "\n"
+            pos_map << byte_to_char[start_byte]
+          else
+            extract_text_nodes(child, line_byte_offsets, byte_to_char, stripped, pos_map)
+          end
+        end
+      end
+
+      # Appends a synthetic separator character to the stripped text.
+      # Maps it to -1 since it doesn't correspond to any raw source position.
+      def append_separator(stripped, pos_map, char)
+        stripped << char
+        pos_map << -1
+      end
+    end
+  end
+end

data/app/views/coplan/comments/_comment.html.erb

@@ -1,6 +1,9 @@
 <div class="comment" id="<%= dom_id(comment) %>">
   <div class="comment__header text-sm text-muted">
     <strong><%= comment_author_name(comment) %></strong>
+    <% if comment.agent? %>
+      <span class="badge badge--agent">agent</span>
+    <% end %>
     · <%= time_ago_in_words(comment.created_at) %> ago
   </div>
   <div class="comment__body">

data/app/views/coplan/plans/_header.html.erb

@@ -6,6 +6,7 @@
     </div>
   </div>
   <div class="page-header__actions">
+    <%= render partial: "coplan/plans/viewers", locals: { viewers: CoPlan::PlanViewer.active_viewers_for(plan), current_user: current_user } %>
     <% if CoPlan::AutomatedPlanReviewer.enabled.any? %>
       <div class="dropdown" data-controller="coplan--dropdown">
         <button class="btn btn--secondary" data-action="coplan--dropdown#toggle">

data/app/views/coplan/plans/_viewers.html.erb

@@ -0,0 +1,16 @@
+<div id="plan-viewers" class="plan-viewers">
+  <% if viewers.any? %>
+    <div class="plan-viewers__avatars">
+      <% viewers.first(8).each do |viewer| %>
+        <% is_you = defined?(current_user) && current_user&.id == viewer.id %>
+        <span class="plan-viewers__avatar<%= ' plan-viewers__avatar--you' if is_you %>" data-tooltip="<%= is_you ? "#{viewer.name} (you)" : viewer.name %>">
+          <%= viewer.name.split.map { |w| w[0] }.first(2).join.upcase %>
+        </span>
+      <% end %>
+      <% if viewers.size > 8 %>
+        <span class="plan-viewers__overflow">+<%= viewers.size - 8 %></span>
+      <% end %>
+    </div>
+    <span class="plan-viewers__label"><%= viewers.size %> viewing</span>
+  <% end %>
+</div>

data/app/views/coplan/plans/show.html.erb

@@ -1,12 +1,34 @@
+<% content_for(:title, "#{@plan.title} — CoPlan") %>
+<% content_for(:head) do %>
+  <meta property="og:title" content="<%= @plan.title %>">
+  <meta property="og:description" content="<%= plan_og_description(@plan) %>">
+  <meta property="og:type" content="article">
+  <meta property="og:site_name" content="CoPlan">
+  <meta name="twitter:card" content="summary">
+  <meta name="twitter:title" content="<%= @plan.title %>">
+  <meta name="twitter:description" content="<%= plan_og_description(@plan) %>">
+<% end %>
+
 <%= turbo_stream_from @plan %>
 
-<%= render partial: "coplan/plans/header", locals: { plan: @plan } %>
+<div data-controller="coplan--presence" data-coplan--presence-plan-id-value="<%= @plan.id %>">
+  <%= render partial: "coplan/plans/header", locals: { plan: @plan } %>
+</div>
 
 <div class="plan-content card">
   <% if @plan.current_content.present? %>
-    <div class="plan-layout" data-controller="coplan--text-selection" data-coplan--text-selection-plan-id-value="<%= @plan.id %>">
+    <div class="plan-layout" data-controller="coplan--text-selection coplan--content-nav" data-coplan--text-selection-plan-id-value="<%= @plan.id %>" data-action="keydown.esc@document->coplan--text-selection#dismiss">
+      <nav class="content-nav" data-coplan--content-nav-target="sidebar" aria-label="Document outline">
+        <div class="content-nav__header">
+          <span class="content-nav__title">Contents</span>
+          <button type="button" class="content-nav__toggle" data-action="coplan--content-nav#toggle" data-coplan--content-nav-target="toggleBtn" aria-label="Hide table of contents" title="Toggle (])">✕</button>
+        </div>
+        <ul class="content-nav__list" data-coplan--content-nav-target="list"></ul>
+      </nav>
+      <button type="button" class="content-nav-show-btn" data-action="coplan--content-nav#toggle" data-coplan--content-nav-target="showBtn" title="Show table of contents (])">☰ <kbd>]</kbd></button>
+
       <div class="plan-layout__margin" data-coplan--text-selection-target="margin"></div>
-      <div class="plan-layout__content" data-coplan--text-selection-target="content">
+      <div class="plan-layout__content" data-coplan--text-selection-target="content" data-coplan--content-nav-target="content">
         <%= render_markdown(@plan.current_content) %>
 
         <div class="comment-popover" data-coplan--text-selection-target="popover" style="display: none;">

data/db/migrate/20260327000000_create_coplan_plan_viewers.rb

@@ -0,0 +1,15 @@
+class CreateCoplanPlanViewers < ActiveRecord::Migration[8.1]
+  def change
+    create_table :coplan_plan_viewers, id: { type: :string, limit: 36 } do |t|
+      t.string :plan_id, limit: 36, null: false
+      t.string :user_id, limit: 36, null: false
+      t.datetime :last_seen_at, null: false
+      t.timestamps
+    end
+
+    add_index :coplan_plan_viewers, [:plan_id, :user_id], unique: true
+    add_index :coplan_plan_viewers, :last_seen_at
+    add_foreign_key :coplan_plan_viewers, :coplan_plans, column: :plan_id
+    add_foreign_key :coplan_plan_viewers, :coplan_users, column: :user_id
+  end
+end

data/lib/coplan/version.rb

@@ -1,3 +1,3 @@
 module CoPlan
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coplan-engine
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Block
@@ -142,6 +142,7 @@ extra_rdoc_files: []
 files:
 - app/assets/images/coplan/coplan-logo-sm.png
 - app/assets/stylesheets/coplan/application.css
+- app/channels/coplan/plan_presence_channel.rb
 - app/controllers/coplan/api/v1/base_controller.rb
 - app/controllers/coplan/api/v1/comments_controller.rb
 - app/controllers/coplan/api/v1/leases_controller.rb
@@ -161,8 +162,10 @@ files:
 - app/helpers/coplan/markdown_helper.rb
 - app/javascript/controllers/coplan/comment_form_controller.js
 - app/javascript/controllers/coplan/comment_nav_controller.js
+- app/javascript/controllers/coplan/content_nav_controller.js
 - app/javascript/controllers/coplan/dropdown_controller.js
 - app/javascript/controllers/coplan/line_selection_controller.js
+- app/javascript/controllers/coplan/presence_controller.js
 - app/javascript/controllers/coplan/text_selection_controller.js
 - app/jobs/coplan/application_job.rb
 - app/jobs/coplan/automated_review_job.rb
@@ -179,6 +182,7 @@ files:
 - app/models/coplan/plan.rb
 - app/models/coplan/plan_collaborator.rb
 - app/models/coplan/plan_version.rb
+- app/models/coplan/plan_viewer.rb
 - app/models/coplan/user.rb
 - app/policies/coplan/application_policy.rb
 - app/policies/coplan/comment_thread_policy.rb
@@ -189,6 +193,7 @@ files:
 - app/services/coplan/plans/apply_operations.rb
 - app/services/coplan/plans/commit_session.rb
 - app/services/coplan/plans/create.rb
+- app/services/coplan/plans/markdown_text_extractor.rb
 - app/services/coplan/plans/operation_error.rb
 - app/services/coplan/plans/position_resolver.rb
 - app/services/coplan/plans/review_prompt_formatter.rb
@@ -204,6 +209,7 @@ files:
 - 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/_viewers.html.erb
 - app/views/coplan/plans/edit.html.erb
 - app/views/coplan/plans/index.html.erb
 - app/views/coplan/plans/show.html.erb
@@ -219,6 +225,7 @@ files:
 - db/migrate/20260226200000_create_coplan_schema.rb
 - db/migrate/20260313210000_expand_content_markdown_to_mediumtext.rb
 - db/migrate/20260320145453_migrate_comment_thread_statuses.rb
+- db/migrate/20260327000000_create_coplan_plan_viewers.rb
 - lib/coplan.rb
 - lib/coplan/configuration.rb
 - lib/coplan/engine.rb