turbo_chat 0.1.0

data/app/views/chat_gem/chats/show.html.erb

@@ -0,0 +1,95 @@
+<section class="chat-shell <%= "chat-shell--closed" if @chat.closed? %>"
+         data-chat-emit-chat-lifecycle-events="<%= chat_emit_chat_lifecycle_events? %>"
+         data-chat-lifecycle-event="<%= json_escape(@chat_lifecycle_event.to_json) if @chat_lifecycle_event.present? %>">
+  <% current_participant = current_chat_participant %>
+  <% current_participant_type = current_participant.class.base_class.name %>
+  <% current_participant_id = current_participant.id %>
+  <% self_mention_tokens = chat_self_mention_tokens(chat: @chat, participant: current_participant) %>
+  <% self_role_mention_token = chat_self_role_mention_token(chat: @chat, participant: current_participant) %>
+  <% mention_container_style = chat_mentions_container_inline_style %>
+  <header class="chat-header">
+    <div class="chat-header-copy">
+      <p class="chat-header-kicker"><%= @chat.closed? ? "Conversation closed" : "Conversation active" %></p>
+      <div class="chat-header-title-row">
+        <h1><%= @chat.title %></h1>
+        <span class="chat-status <%= @chat.closed? ? "chat-status--closed" : "chat-status--open" %>">
+          <%= @chat.closed? ? "Closed" : "Open" %>
+        </span>
+      </div>
+    </div>
+    <div class="chat-header-actions">
+      <% if @chat.opened? && @can_close_chat %>
+        <%= button_to "Close",
+                      close_chat_path(@chat),
+                      method: :patch,
+                      form_class: "chat-inline-form",
+                      class: "chat-btn chat-btn--danger",
+                      data: { turbo_confirm: "Close this chat?" } %>
+      <% elsif @chat.closed? && @can_reopen_chat %>
+        <%= button_to "Reopen",
+                      reopen_chat_path(@chat),
+                      method: :patch,
+                      form_class: "chat-inline-form",
+                      class: "chat-btn chat-btn--success" %>
+      <% end %>
+
+      <%= button_to "Leave",
+                    leave_chat_path(@chat),
+                    method: :patch,
+                    form_class: "chat-inline-form",
+                    class: "chat-btn chat-btn--danger",
+                    data: { turbo_confirm: "Leave this chat?" } %>
+      <%= link_to "Back", chats_path, class: "chat-btn chat-btn--ghost" %>
+    </div>
+  </header>
+
+  <% if @can_invite_member %>
+    <div class="chat-invite">
+      <% if @invitable_participants.present? %>
+        <%= form_with url: chat_chat_memberships_path(@chat), scope: :chat_membership, class: "chat-form chat-form--invite" do |f| %>
+          <%= f.hidden_field :participant_type, value: @invite_participant_type %>
+          <%= f.select :participant_id,
+                       options_for_select(@invitable_participants.map { |participant| ["#{chat_participant_name(participant)} (##{participant.id})", participant.id] }),
+                       { prompt: "Invite participant" },
+                       required: true %>
+          <%= f.submit "Invite", class: "chat-btn" %>
+        <% end %>
+      <% else %>
+        <p class="chat-hint">No eligible participants to invite.</p>
+      <% end %>
+    </div>
+  <% end %>
+
+  <%= turbo_stream_from @chat, :messages %>
+
+  <section class="chat-window">
+    <div id="<%= dom_id(@chat, :messages) %>"
+         class="chat-messages"
+         data-chat-id="<%= @chat.id %>"
+         data-chat-self-participant-type="<%= current_participant_type %>"
+         data-chat-self-participant-id="<%= current_participant_id %>"
+         data-chat-self-mention-tokens="<%= json_escape(self_mention_tokens.to_json) %>"
+         data-chat-self-role-mention-token="<%= self_role_mention_token %>"
+         data-chat-mention-filter-exclude-self="<%= chat_mention_filter_exclude_self? %>"
+         data-chat-mention-filter-hide-roles="<%= chat_mention_filter_hide_roles? %>"
+         data-chat-emit-mention-events="<%= chat_emit_mention_events? %>"
+         data-chat-can-edit-own-messages="<%= @can_edit_own_messages %>"
+         <%= %(style="#{mention_container_style}") if mention_container_style.present? %>>
+      <%= render @chat_messages %>
+    </div>
+
+    <div id="<%= dom_id(@chat, :signals) %>"
+         class="chat-signals"
+         data-chat-show-self-signals="<%= ChatGem.configuration.show_self_signals %>"
+         data-chat-self-participant-type="<%= current_participant_type %>"
+         data-chat-self-participant-id="<%= current_participant_id %>">
+      <%= render "chat_gem/chat_messages/signals", chat: @chat %>
+    </div>
+  </section>
+
+  <% if @can_post_message %>
+    <%= render "chat_gem/chat_messages/form", chat: @chat, chat_message: @chat_message, chat_permission: @chat_permission %>
+  <% elsif @chat.closed? %>
+    <p class="chat-banner chat-banner--muted">This chat is closed.</p>
+  <% end %>
+</section>

data/app/views/layouts/chat_gem/application.html.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>ChatGem</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= action_cable_meta_tag %>
+    <% if respond_to?(:turbo_include_tags) %>
+      <%= turbo_include_tags %>
+    <% end %>
+    <%= stylesheet_link_tag "chat_gem/application", "data-turbo-track": "reload" %>
+    <%= javascript_include_tag "chat_gem/shared", "data-turbo-track": "reload", defer: true %>
+    <%= javascript_include_tag "chat_gem/messages", "data-turbo-track": "reload", defer: true %>
+    <%= javascript_include_tag "chat_gem/realtime", "data-turbo-track": "reload", defer: true %>
+    <%= javascript_include_tag "chat_gem/lifecycle_events", "data-turbo-track": "reload", defer: true %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,16 @@
+ChatGem::Engine.routes.draw do
+  root to: "chats#index"
+
+  resources :chats, only: %i[index show new create] do
+    member do
+      patch :accept
+      patch :decline
+      patch :leave
+      patch :close
+      patch :reopen
+    end
+
+    resources :chat_memberships, only: :create
+    resources :chat_messages, only: %i[index create update]
+  end
+end

data/db/migrate/20260215000000_create_chat_gem_chats.rb

@@ -0,0 +1,8 @@
+class CreateChatGemChats < ActiveRecord::Migration[7.0]
+  def change
+    create_table :chat_gem_chats do |t|
+      t.string :title, null: false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20260215000001_create_chat_gem_chat_memberships.rb

@@ -0,0 +1,19 @@
+class CreateChatGemChatMemberships < ActiveRecord::Migration[7.0]
+  def change
+    create_table :chat_gem_chat_memberships do |t|
+      t.references :chat, null: false, foreign_key: { to_table: :chat_gem_chats }
+      t.references :participant, polymorphic: true, null: false
+      t.integer :role, null: false, default: 0
+      t.boolean :muted, null: false, default: false
+      t.datetime :timed_out_until
+      t.datetime :removed_at
+      t.timestamps
+    end
+
+    add_index :chat_gem_chat_memberships,
+              %i[chat_id participant_type participant_id],
+              unique: true,
+              where: "removed_at IS NULL",
+              name: "index_chat_gem_memberships_on_chat_participant_active"
+  end
+end

data/db/migrate/20260215000002_create_chat_gem_chat_messages.rb

@@ -0,0 +1,14 @@
+class CreateChatGemChatMessages < ActiveRecord::Migration[7.0]
+  def change
+    create_table :chat_gem_chat_messages do |t|
+      t.references :chat, null: false, foreign_key: { to_table: :chat_gem_chats }
+      t.references :participant, polymorphic: true, null: false
+      t.text :body
+      t.integer :kind, null: false, default: 0
+      t.integer :signal_type
+      t.timestamps
+    end
+
+    add_index :chat_gem_chat_messages, %i[chat_id created_at id], name: "index_chat_gem_messages_order"
+  end
+end

data/db/migrate/20260218000011_add_closed_at_to_chat_gem_chats.rb

@@ -0,0 +1,6 @@
+class AddClosedAtToChatGemChats < ActiveRecord::Migration[7.0]
+  def change
+    add_column :chat_gem_chats, :closed_at, :datetime
+    add_index :chat_gem_chats, :closed_at
+  end
+end

data/db/migrate/20260218000012_add_custom_role_key_to_chat_memberships.rb

@@ -0,0 +1,6 @@
+class AddCustomRoleKeyToChatMemberships < ActiveRecord::Migration[7.0]
+  def change
+    add_column :chat_gem_chat_memberships, :custom_role_key, :string
+    add_index :chat_gem_chat_memberships, :custom_role_key
+  end
+end

data/db/migrate/20260218000013_add_invitation_accepted_to_chat_gem_chat_memberships.rb

@@ -0,0 +1,5 @@
+class AddInvitationAcceptedToChatGemChatMemberships < ActiveRecord::Migration[7.0]
+  def change
+    add_column :chat_gem_chat_memberships, :invitation_accepted, :boolean, null: false, default: true
+  end
+end

data/lib/chat_gem/configuration.rb

@@ -0,0 +1,242 @@
+module ChatGem
+  class Configuration
+    DEFAULT_ROLE_DEFINITIONS = {
+      "member" => {
+        name: "Member",
+        rank: 0,
+        permissions: %i[view_chat post_message mention_member]
+      },
+      "moderator" => {
+        name: "Moderator",
+        rank: 1,
+        permissions: %i[view_chat post_message mention_member mention_all mention_role invite_member mute_member timeout_member ban_member delete_message]
+      },
+      "admin" => {
+        name: "Admin",
+        rank: 2,
+        permissions: %i[view_chat post_message mention_member mention_all mention_role invite_member mute_member timeout_member ban_member delete_message close_chat reopen_chat]
+      }
+    }.freeze
+    DEFAULT_MESSAGE_HTML_TAGS = %w[a b br code em i li ol p pre strong ul].freeze
+    DEFAULT_MESSAGE_HTML_ATTRIBUTES = %w[href target rel class].freeze
+    DEFAULT_EMOJI_ALIASES = {
+      "smile" => "😄",
+      "grin" => "😁",
+      "laughing" => "😆",
+      "blush" => "😊",
+      "wink" => "😉",
+      "heart" => "❤️",
+      "thumbsup" => "👍",
+      "+1" => "👍",
+      "thumbsdown" => "👎",
+      "-1" => "👎",
+      "fire" => "🔥",
+      "rocket" => "🚀",
+      "thinking" => "🤔",
+      "tada" => "🎉",
+      "wave" => "👋",
+      "eyes" => "👀"
+    }.freeze
+    DEFAULT_BLOCKED_WORDS_SCRAMBLE_CHARS = %w[# * / ( = ) ! 8].freeze
+    DEFAULT_BLOCKED_WORDS_ACTION = "reject".freeze
+
+    attr_accessor :permission_adapter,
+                  :max_chat_participants,
+                  :max_message_length,
+                  :message_history_limit,
+                  :enable_mentions,
+                  :mention_filter_exclude_self,
+                  :mention_filter_hide_roles,
+                  :enable_emoji_aliases,
+                  :emoji_aliases,
+                  :blocked_words,
+                  :blocked_words_action,
+                  :blocked_words_scramble_chars,
+                  :mention_mark_hex_color,
+                  :mention_highlight_hex_color,
+                  :own_message_hex_color,
+                  :other_message_hex_color,
+                  :role_message_hex_colors,
+                  :show_timestamp,
+                  :show_role,
+                  :active_chat_window,
+                  :emit_typing_events,
+                  :emit_message_events,
+                  :emit_mention_events,
+                  :emit_invitation_events,
+                  :emit_chat_lifecycle_events,
+                  :emit_moderation_events,
+                  :emit_blocked_words_events,
+                  :show_self_signals,
+                  :replace_signals_on_message_submit,
+                  :message_css_class_resolver,
+                  :render_message_html,
+                  :message_html_tags,
+                  :message_html_attributes,
+                  :timestamp_formatter,
+                  :role_formatter
+
+    def initialize
+      @permission_adapter = ChatGem::Permission
+      @max_chat_participants = 10
+      @max_message_length = 1000
+      @message_history_limit = 200
+      @enable_mentions = true
+      @mention_filter_exclude_self = true
+      @mention_filter_hide_roles = true
+      @enable_emoji_aliases = true
+      @emoji_aliases = DEFAULT_EMOJI_ALIASES.dup
+      @blocked_words = []
+      @blocked_words_action = DEFAULT_BLOCKED_WORDS_ACTION
+      @blocked_words_scramble_chars = DEFAULT_BLOCKED_WORDS_SCRAMBLE_CHARS.dup
+      @mention_mark_hex_color = nil
+      @mention_highlight_hex_color = nil
+      @own_message_hex_color = nil
+      @other_message_hex_color = nil
+      @role_message_hex_colors = {}
+      @show_timestamp = true
+      @show_role = false
+      @active_chat_window = 5.minutes
+      @emit_typing_events = false
+      @emit_message_events = false
+      @emit_mention_events = false
+      @emit_invitation_events = false
+      @emit_chat_lifecycle_events = false
+      @emit_moderation_events = false
+      @emit_blocked_words_events = false
+      @show_self_signals = false
+      @replace_signals_on_message_submit = false
+      @message_css_class_resolver = nil
+      @render_message_html = false
+      @message_html_tags = DEFAULT_MESSAGE_HTML_TAGS.dup
+      @message_html_attributes = DEFAULT_MESSAGE_HTML_ATTRIBUTES.dup
+      @additional_roles = {}
+      @timestamp_formatter = lambda { |timestamp, _chat_message = nil|
+        I18n.l(timestamp.in_time_zone, format: :long)
+      }
+      @role_formatter = lambda { |role, _chat_message = nil|
+        role.to_s.humanize
+      }
+    end
+
+    def add_role(key, name:, permissions:, rank: 0)
+      normalized_key = normalize_role_key(key)
+      raise ArgumentError, "Role key cannot be blank" if normalized_key.blank?
+      raise ArgumentError, "Role #{normalized_key} is reserved" if DEFAULT_ROLE_DEFINITIONS.key?(normalized_key)
+
+      role_name = name.to_s.strip
+      raise ArgumentError, "Role name cannot be blank" if role_name.blank?
+
+      @additional_roles[normalized_key] = {
+        name: role_name,
+        rank: rank.to_i,
+        permissions: Array(permissions).map { |permission| permission.to_sym }.uniq
+      }
+    end
+
+    def remove_role(key)
+      @additional_roles.delete(normalize_role_key(key))
+    end
+
+    def clear_additional_roles!
+      @additional_roles = {}
+    end
+
+    def additional_roles
+      @additional_roles.dup
+    end
+
+    def role_definitions
+      DEFAULT_ROLE_DEFINITIONS.merge(@additional_roles)
+    end
+
+    def role_definition(key)
+      role_definitions[normalize_role_key(key)]
+    end
+
+    def add_emoji_alias(name, value)
+      key = normalize_emoji_alias_key(name)
+      raise ArgumentError, "Emoji alias cannot be blank" if key.blank?
+
+      normalized_value = value.to_s.strip
+      raise ArgumentError, "Emoji alias value cannot be blank" if normalized_value.blank?
+
+      @emoji_aliases = effective_emoji_aliases.merge(key => normalized_value)
+    end
+
+    def remove_emoji_alias(name)
+      key = normalize_emoji_alias_key(name)
+      return if key.blank?
+
+      @emoji_aliases = effective_emoji_aliases.except(key)
+    end
+
+    def clear_emoji_aliases!
+      @emoji_aliases = {}
+    end
+
+    def reset_emoji_aliases!
+      @emoji_aliases = DEFAULT_EMOJI_ALIASES.dup
+    end
+
+    def effective_emoji_aliases
+      source = emoji_aliases.is_a?(Hash) ? emoji_aliases : {}
+
+      source.each_with_object({}) do |(key, value), aliases|
+        normalized_key = normalize_emoji_alias_key(key)
+        normalized_value = value.to_s.strip
+        next if normalized_key.blank? || normalized_value.blank?
+
+        aliases[normalized_key] = normalized_value
+      end
+    end
+
+    def effective_blocked_words
+      source = blocked_words
+      return [] unless source.respond_to?(:each)
+
+      source.each_with_object([]) do |value, words|
+        normalized_word = normalize_blocked_word(value)
+        next if normalized_word.blank?
+        next if words.include?(normalized_word)
+
+        words << normalized_word
+      end
+    end
+
+    def effective_blocked_words_action
+      action = blocked_words_action.to_s.strip.downcase
+      return DEFAULT_BLOCKED_WORDS_ACTION if action.blank?
+
+      %w[reject scramble].include?(action) ? action : DEFAULT_BLOCKED_WORDS_ACTION
+    end
+
+    def effective_blocked_words_scramble_chars
+      source = blocked_words_scramble_chars
+      return DEFAULT_BLOCKED_WORDS_SCRAMBLE_CHARS.dup unless source.respond_to?(:each)
+
+      chars = source.each_with_object([]) do |value, result|
+        normalized_char = value.to_s
+        next if normalized_char.blank?
+
+        result << normalized_char
+      end
+
+      chars.presence || DEFAULT_BLOCKED_WORDS_SCRAMBLE_CHARS.dup
+    end
+
+    private
+
+    def normalize_role_key(key)
+      key.to_s.strip
+    end
+
+    def normalize_emoji_alias_key(key)
+      key.to_s.strip.downcase
+    end
+
+    def normalize_blocked_word(word)
+      word.to_s.strip.downcase
+    end
+  end
+end

data/lib/chat_gem/engine.rb

@@ -0,0 +1,29 @@
+module ChatGem
+  class Engine < ::Rails::Engine
+    isolate_namespace ChatGem
+
+    initializer "chat_gem.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper ChatGem::ApplicationHelper
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include ChatGem::ApplicationHelper
+      end
+    end
+
+    initializer "chat_gem.assets.precompile" do |app|
+      next unless app.config.respond_to?(:assets)
+      next unless app.config.assets.respond_to?(:precompile)
+
+      app.config.assets.precompile += %w[
+        chat_gem/application.css
+        chat_gem/application.js
+        chat_gem/shared.js
+        chat_gem/messages.js
+        chat_gem/realtime.js
+        chat_gem/lifecycle_events.js
+      ]
+    end
+  end
+end

data/lib/chat_gem/model_extensions/chat_participant.rb

@@ -0,0 +1,45 @@
+module ChatGem
+  module ModelExtensions
+    module ChatParticipant
+      module ClassMethods
+        def acts_as_chat_participant
+          return if reflect_on_association(:chat_memberships).present?
+
+          has_many :chat_memberships,
+                   -> { order(created_at: :asc, id: :asc) },
+                   as: :participant,
+                   class_name: "ChatGem::ChatMembership",
+                   dependent: :destroy
+
+          has_many :chat_messages,
+                   -> { order(created_at: :asc, id: :asc) },
+                   as: :participant,
+                   class_name: "ChatGem::ChatMessage",
+                   dependent: :destroy
+
+          has_many :chats,
+                   -> { distinct },
+                   through: :chat_memberships,
+                   source: :chat,
+                   class_name: "ChatGem::Chat"
+
+          include ChatGem::ModelExtensions::ChatParticipant::InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+        def active_chat_memberships
+          chat_memberships.active
+        end
+
+        def joined_chat?(chat)
+          active_chat_memberships.exists?(chat_id: chat.id)
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend ChatGem::ModelExtensions::ChatParticipant::ClassMethods
+end