fenetre 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d742e322e7ed6c94bc26878f732121911872fef3823dea593eb4141ee9c1280
+  data.tar.gz: a6e1d6633311adf8c02aacd849cbfa262e3d50e9d1810504a1ac8bbb649c5e72
+SHA512:
+  metadata.gz: 04e8007aae26b6c7d48d9071cd6faef061152e62c38907f346101538ff5581fa52104e20a41ccea712984b53682302f7f4e2c7ada1283253cde2aa6d7606ec36
+  data.tar.gz: d50582f711a81470a52739c95691a31e72529e9236dc68738489699cee5869284d4bbd81153c6be70498e772ef54e29fe7c7f52c5e3b70186994e30e8e8819a0

data/README.md

@@ -0,0 +1,83 @@
+# Fenetre
+
+[![CI Status](https://github.com/andrewfader/fenetre/workflows/CI/badge.svg)](https://github.com/andrewfader/fenetre/actions)
+[![Coverage Status](https://img.shields.io/badge/coverage-78.9%25-yellow.svg)](coverage/index.html)
+
+A Rails engine that adds WebRTC video chat to your app using ActionCable, Stimulus, and Turbo.
+
+## Setup
+
+Fenetre automatically handles most of the necessary setup when used with `importmap-rails`:
+
+- Mounting the Action Cable server at `/cable` (if not already mounted).
+- Making the Stimulus controllers available via the import map.
+- Making the view helper available.
+
+**Important:**
+- Your host application **must** use `importmap-rails`.
+- Your host application's `app/javascript/application.js` should load Stimulus controllers (e.g., contain `import "./controllers"`).
+
+Add the video chat container helper to any view where you want the chat interface:
+
+```erb
+<%# Assuming you have `room_id` and `current_user` available %>
+<%= fenetre_video_chat_container(room_id, current_user.id) %>
+```
+
+This renders a complete video chat UI. The necessary Stimulus controller (`fenetre--video-chat`) will be automatically loaded.
+
+### Room Options
+
+Customize the video chat experience using options:
+
+```erb
+<%= fenetre_video_chat_container(
+  room_id,
+  current_user.id,
+  theme: 'light',                   # 'dark' (default) or 'light'
+  # Add other options as needed based on helper definition
+) %>
+```
+
+### JavaScript Interaction (Optional)
+
+While Fenetre works out-of-the-box, you can interact with the Stimulus controller (`fenetre--video-chat`) for advanced customization:
+
+```javascript
+// In your application's JavaScript or another Stimulus controller
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  connect() {
+    const fenetreElement = this.element.querySelector('[data-controller="fenetre--video-chat"]');
+    if (fenetreElement) {
+      const fenetreController = this.application.getControllerForElementAndIdentifier(fenetreElement, 'fenetre--video-chat');
+      // Now you can interact with fenetreController if needed
+      console.log('Fenetre controller found:', fenetreController);
+
+      // Example: Listen for custom events (if implemented in the controller)
+      // fenetreElement.addEventListener('fenetre:user-joined', (event) => {
+      //   console.log(`User ${event.detail.userId} joined`);
+      // });
+    }
+  }
+}
+```
+
+## Styling
+
+The default styling is included automatically. You can override the CSS classes for custom themes:
+
+```css
+/* Example overrides */
+.fenetre-video-chat-container {
+  border: 2px solid blue;
+}
+
+.fenetre-theme-light .fenetre-chat-messages {
+  background-color: #f0f0f0;
+}
+```
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+# Add RuboCop task
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.options = ['--display-cop-names']
+  end
+rescue LoadError
+  desc 'Run RuboCop'
+  task :rubocop do
+    abort 'RuboCop is not available. Run `bundle install` to install it.'
+  end
+end
+
+# Add Coverage task
+desc 'Generate test coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].invoke
+end
+
+# Run tests with coverage by default
+task default: %i[rubocop coverage]

data/app/assets/javascripts/fenetre/application.js

@@ -0,0 +1,14 @@
+// This serves as an entry point for Fenetre JavaScript
+// It's meant to be pinned in the importmap for use by the host application
+
+// Re-export the main fenetre module
+import "./fenetre.js"
+
+// Load the controllers entrypoint using a relative path
+import "./controllers/index.js"
+
+// Export a basic API for the host application to use
+export const Fenetre = {
+  version: "1.0.0",
+  // Add more public API methods as needed
+}

data/app/assets/javascripts/fenetre/controllers/index.js

@@ -0,0 +1,19 @@
+// This file loads all Stimulus controllers in the fenetre engine
+// It's referenced by the importmap
+
+import { Application } from "../vendor/stimulus.umd.js"
+import VideoChatController from "./video_chat_controller.js"
+
+const application = Application.start();
+
+// Register controllers with Stimulus
+application.register("fenetre--video-chat", VideoChatController)
+
+// Expose the Stimulus application globally for testing and debugging
+// This allows tests to access controllers through window.Stimulus.application
+if (typeof window !== 'undefined') {
+  window.Stimulus = window.Stimulus || {};
+  window.Stimulus.application = application;
+}
+
+export { application };