simple_chat 0.1.0

data/lib/generators/simple_chat/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SimpleChat
+  class InstallGenerator < Rails::Generators::Base
+    def create_initializer
+      initializer "simple_chat.rb" do
+        <<~RUBY
+          # Initialize SimpleChat
+          SimpleChat.configure do |config|
+            # Set the user model that will be used for chat members and messages
+            # config.chat_user_model = 'User'
+
+            # Set the method to get the current user in the controller
+            # Defaults to :current_user (standard for Devise)
+            # config.current_user_method = :current_user
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/simple_chat/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Usage in Rails application config/initializers/simple_chat.rb)
+# SimpleChat.configure do |config|
+#   config.chat_user_model = 'User'
+# end
+module SimpleChat
+  class Configuration
+    attr_accessor :chat_user_model, :current_user_method
+
+    def initialize
+      @chat_user_model = "User"
+      @current_user_method = :current_user
+    end
+  end
+end

data/lib/simple_chat/engine.rb

@@ -0,0 +1,13 @@
+require "turbo-rails"
+require "solid_cable"
+require "tailwindcss-rails"
+
+module SimpleChat
+  class Engine < ::Rails::Engine
+    isolate_namespace SimpleChat
+
+    initializer "simple_chat.assets" do |app|
+      app.config.assets.precompile += %w( simple_chat/application.css )
+    end
+  end
+end

data/lib/simple_chat/version.rb

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

data/lib/simple_chat.rb

@@ -0,0 +1,42 @@
+require "simple_chat/version"
+require "simple_chat/engine"
+require 'simple_chat/configuration'
+
+module SimpleChat
+  class << self
+    attr_writer :configuration
+
+    # Access the configuration object
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # The block handler
+    def configure
+      yield(configuration)
+    end
+
+    def create_chat(*users, title: nil)
+      users = users.flatten.compact
+      if title.nil?
+        names = users.map { |u| u.respond_to?(:name) ? u.name : u.id }
+        if names.size > 2
+          title = "Chat between #{names[0...-1].join(", ")} and #{names.last}"
+        elsif names.size == 2
+          title = "Chat between #{names.first} and #{names.last}"
+        elsif names.size == 1
+          title = "Chat for #{names.first}"
+        else
+          title = "Empty Chat"
+        end
+      end
+
+      ChatRoom.transaction do
+        chat_room = ChatRoom.create!(title: title)
+        users.each { |user| chat_room.chat_members.create!(user: user) }
+
+        chat_room
+      end
+    end
+  end
+end

data/lib/tasks/simple_chat_tasks.rake

@@ -0,0 +1,40 @@
+namespace :simple_chat do
+  desc "Setup User table, model and seed data for testing"
+  task setup_test_user: :environment do
+    # 1. Create Migration
+    migration_name = "CreateUsers"
+    if !ActiveRecord::Base.connection.table_exists?(:users)
+      puts "Creating migration for users table..."
+      system("rails generate migration #{migration_name} name:string")
+      system("rails db:migrate")
+    else
+      puts "Users table already exists."
+    end
+
+    # 2. Create Model if not exists
+    model_path = Rails.root.join("app", "models", "user.rb")
+    if !File.exist?(model_path)
+      puts "Creating User model..."
+      File.open(model_path, "w") do |f|
+        f.write <<~RUBY
+          class User < ApplicationRecord
+          end
+        RUBY
+      end
+    else
+      puts "User model already exists."
+    end
+
+    # 3. Seed Users
+    puts "Seeding 5 users..."
+    user_class = "User".safe_constantize
+    if user_class
+      5.times do |i|
+        user_class.find_or_create_by!(name: "Test User #{i + 1}")
+      end
+      puts "Successfully seeded 5 users."
+    else
+      puts "Error: User class not found."
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: simple_chat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YiSheng, Lee
+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.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+- !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: solid_cable
+  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: tailwindcss-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'
+description: SimpleChat is a Rails engine that provides a ready-to-use chat system.
+  It supports chat rooms, members, and real-time messaging leveraging Turbo Streams
+  and Solid Cable for a modern, reactive experience.
+email:
+- yisheng.lee@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/simple_chat/application.css
+- app/assets/stylesheets/simple_chat/application.tailwind.css
+- app/controllers/simple_chat/application_controller.rb
+- app/controllers/simple_chat/chat_members_controller.rb
+- app/controllers/simple_chat/chat_rooms_controller.rb
+- app/controllers/simple_chat/messages_controller.rb
+- app/helpers/simple_chat/application_helper.rb
+- app/helpers/simple_chat/chat_rooms_helper.rb
+- app/helpers/simple_chat/messages_helper.rb
+- app/jobs/simple_chat/application_job.rb
+- app/mailers/simple_chat/application_mailer.rb
+- app/models/simple_chat/application_record.rb
+- app/models/simple_chat/chat_member.rb
+- app/models/simple_chat/chat_room.rb
+- app/models/simple_chat/message.rb
+- app/views/layouts/simple_chat/application.html.erb
+- app/views/simple_chat/chat_rooms/_chat_room.html.erb
+- app/views/simple_chat/chat_rooms/_form.html.erb
+- app/views/simple_chat/chat_rooms/edit.html.erb
+- app/views/simple_chat/chat_rooms/index.html.erb
+- app/views/simple_chat/chat_rooms/new.html.erb
+- app/views/simple_chat/chat_rooms/show.html.erb
+- app/views/simple_chat/messages/_form.html.erb
+- app/views/simple_chat/messages/_message.html.erb
+- app/views/simple_chat/messages/create.turbo_stream.erb
+- app/views/simple_chat/messages/edit.html.erb
+- app/views/simple_chat/messages/index.html.erb
+- app/views/simple_chat/messages/new.html.erb
+- app/views/simple_chat/messages/show.html.erb
+- config/routes.rb
+- config/tailwind.config.js
+- db/migrate/20260406070146_create_simple_chat_chat_rooms.rb
+- db/migrate/20260406080846_create_simple_chat_chat_members.rb
+- db/migrate/20260406081003_create_simple_chat_messages.rb
+- db/migrate/20260503095220_add_channel_hash_to_solid_cable_messages.rb
+- lib/generators/simple_chat/install_generator.rb
+- lib/simple_chat.rb
+- lib/simple_chat/configuration.rb
+- lib/simple_chat/engine.rb
+- lib/simple_chat/version.rb
+- lib/tasks/simple_chat_tasks.rake
+homepage: https://github.com/yisheng-lee/simple_chat
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/yisheng-lee/simple_chat
+  source_code_uri: https://github.com/yisheng-lee/simple_chat
+  changelog_uri: https://github.com/yisheng-lee/simple_chat
+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: 4.0.9
+specification_version: 4
+summary: A simple chat engine for Rails applications using Turbo and Solid Cable.
+test_files: []