simple_chat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3fa5a120911616d3139fa0da969eef52af9f61bb44d30509c261be204ea4d97
+  data.tar.gz: d22d02acf74b58304075280710421b5912125f9395e5725305436ae793b5e5d9
+SHA512:
+  metadata.gz: 831c8b3dc9b0da1e60e0a6fb3897552642ea52a38be3fadb1062b62ed1a713a7919cb9036e950891e3c12aed0f624f7a6a7cedd29655e005a3ff5b53fab93c9e
+  data.tar.gz: e076aa779fc16a29002822713e949368edced4fcb9a0271090d3df1d83e76dc4f506da6b6cc8a3ef781ce1bef5b72252ae09a815169108c92b4a905a5043c503

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright YiSheng, Lee
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,178 @@
+# SimpleChat
+
+SimpleChat is a Rails engine that allows you to easily add a chat system to your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "simple_chat"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install simple_chat
+```
+
+## Usage
+
+### 1. Run the generator
+
+Run the install generator to create the configuration file:
+
+```bash
+rails generate simple_chat:install
+```
+
+This will create `config/initializers/simple_chat.rb`. You can configure your user model and the method to fetch the current user there.
+
+```ruby
+SimpleChat.configure do |config|
+  # Set the user model (defaults to 'User')
+  config.chat_user_model = 'User'
+
+  # Set the method to get the current user in the controller (defaults to :current_user)
+  # This is compatible with Devise.
+  config.current_user_method = :current_user
+end
+```
+
+### 2. Run migrations
+
+Copy and run the migrations:
+
+```bash
+rails simple_chat:install:migrations
+rails db:migrate
+```
+
+### 3. Mount the engine
+
+Add the following to your `config/routes.rb` file:
+
+```ruby
+mount SimpleChat::Engine => "/chat"
+```
+
+Now you can access the chat system at `/chat`.
+
+### 4. Membership
+
+By default, `SimpleChat` requires users to be members of a chat room before they can post messages.
+- **Visibility**: On the chat rooms index page, users only see rooms that they are members of.
+- **Joining**: When a user creates a new chat room, they are automatically added as a member. For other rooms, users must be added as members (e.g., via console or custom logic) to see them in their list and to access them. Users who are not members will be redirected if they try to access a chat room's page directly.
+- **Membership Management**: Membership is managed via the `simple_chat_chat_members` table.
+
+### 5. Setup Test Users (Optional)
+
+For testing purposes, you can quickly set up a `User` model and table with some seed data.
+
+If you are running this within the **gem's development environment** (e.g., in the dummy app), run:
+
+```bash
+bin/rails app:simple_chat:setup_test_user
+```
+
+If you are running this in a **host Rails application** that has the gem installed, run:
+
+```bash
+rails simple_chat:setup_test_user
+```
+
+This will:
+- Create a migration for the `users` table with a `name` column (if it doesn't exist).
+- Run the migration.
+- Create a `User` model in `app/models/user.rb` (if it doesn't exist).
+- Seed 5 test user records.
+
+### 6. Programmatic Usage
+
+You can create a chat room between multiple users directly from your Rails app:
+
+```ruby
+user1 = User.find(1)
+user2 = User.find(2)
+user3 = User.find(3)
+
+# Create a chat with multiple users as arguments
+chat_room = SimpleChat.create_chat(user1, user2, user3)
+
+# Or pass them as an array
+chat_room = SimpleChat.create_chat([user1, user2])
+
+# Or specify a custom title
+chat_room = SimpleChat.create_chat(user1, user2, title: "Support Chat")
+```
+
+### 7. Real-Time Messaging Setup
+
+To enable real-time messaging, `SimpleChat` uses **Turbo Streams** and **ActionCable** with **Solid Cable** as the backend adapter.
+
+#### ActionCable & Solid Cable Configuration
+In your host application, configure `config/cable.yml` to use the `solid_cable` adapter for the environments where you want real-time features enabled:
+
+```yaml
+development:
+  adapter: solid_cable
+
+production:
+  adapter: solid_cable
+```
+
+Ensure you have run the migrations to create the `solid_cable_messages` table:
+
+```bash
+rails db:migrate
+```
+
+#### Frontend Setup (Importmaps)
+The real-time updates require **Turbo** and **ActionCable** to be active in the browser. If you are using Importmaps, ensure the following are pinned in `config/importmap.rb`:
+
+```ruby
+pin "@hotwired/turbo-rails", to: "turbo.min.js"
+pin "@rails/actioncable", to: "actioncable.esm.js"
+```
+
+And imported in your `app/javascript/application.js`:
+
+```javascript
+import "@hotwired/turbo-rails"
+import "@rails/actioncable"
+```
+
+Your main layout (`app/views/layouts/application.html.erb`) must also include the necessary tags in the `<head>`:
+
+```erb
+<%= csrf_meta_tags %>
+<%= csp_meta_tag %>
+<%= javascript_importmap_tags %>
+```
+
+#### Background Job Processing
+The gem uses `broadcast_append_later_to` to prevent UI lag. This enqueues an `ActiveJob` to handle the broadcast. Ensure you have a queue adapter configured (like `async` for development or `solid_queue` for production) and that a worker process is running to handle these jobs.
+
+### 8. CSS & Styling
+
+SimpleChat comes with its own pre-compiled Tailwind CSS. This means **you do not need to install or configure Tailwind CSS in your host application** to use SimpleChat.
+
+The engine's layout automatically includes the necessary styles. If you are not using the engine's layout and want to include the styles in your own views, you can add:
+
+```erb
+<%= stylesheet_link_tag "simple_chat/application" %>
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"