messaged 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2607ebea948e9c5464a9fba7e3153def8d1e0093fccc7c72570b9aeced8b910f
-  data.tar.gz: 4ab6464c09f420b6f18e6761317e0638d60d6fa30f0263f9cb67d7e174a5753d
+  metadata.gz: fe41021cc17ab7a3f9b46a8c036345c738b54539eda08f6a176604d0cf75c85b
+  data.tar.gz: d16f56a11dc02c6117e4965e02ac845451b85ae353351fa22a16bba292999d05
 SHA512:
-  metadata.gz: 68b45ab5fa04546608da02a3aaf1cd945b497be9ea599ac9518ab4c0c076b8bf2f0885cbf2bb478ae0eb30e9f473bc455e3f9aa856be688477976bf92b39e42f
-  data.tar.gz: bcdcdebc54df17cfe5107e4926f57947c445b7ea14e217ed8bb006ccc741fec622fd51983ed15b06e870a9cf502340d3ddefd5e64c43ca775793cc92d4b110df
+  metadata.gz: 63a7e3bd9685a055e0f1f29b0d807036570f7114997d0fd7bde2e155f99b98fe1267f55843baf7d8319ca9e615306d7be92c45fb9ba6df4cbeac353a2fce9a75
+  data.tar.gz: ddee84cb919cd85685050f5aa550fab336486323b6e8645180e39b8b2b9d78d32f5c407cfc96089521c1ebdcada8c2d75d7dc86b07259c2908a399e15efc64b3

data/README.md

@@ -26,6 +26,15 @@ rails generate messaged:install
 rails messaged:install:migrations
 ```
 
+### Importmap
+
+If you do not yet have importmap-rails added to your application, be sure to add `config/importmap.rb`:
+```ruby
+# config/importmap.rb
+pin "application", preload: true
+pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
+```
+
 ## Usage
 Messages broadcast to the DOM element id `messages`
 ```html
@@ -36,6 +45,24 @@ To get started with a basic HTML structure, run in your terminal: `rails generat
 
 If you're using this engine or `turbo-rails` for the first time, it is recommended to generate the views to familiarize yourself with how turbo tags are used when turbo streaming.
 
+### Routes
+
+If you're starting a fresh application, ensure your application has a root path.
+```ruby
+# For example:
+root to: "home#index"
+```
+
+Next, set up your ActionCable routes if you haven't already.
+```ruby 
+mount ActionCable.server => '/cable'
+```
+
+Lastly, mount the Messaged engine's paths.
+```ruby
+mount Messaged::Engine => "/messaged"
+```
+
 ### Users
 Messaged assumes you have a user model. You may customize the user model name in the initializer. For example, if your user model is called Member:
 ```ruby
@@ -78,8 +105,11 @@ Messaged is intended to be named through the nomenclature used in [Noticed](http
 —Ian
 
 ## TODO
-* Add dynamic configurations for message broadcasting to tenants (like an organization chat room), rooms (like a Discord channel), or users (like direct messages in most direct-messaging apps such as Signal)
-* Figure out how to support permissioning/authorization (such as Pundit/Cancancan) without being opinionated
 * Complete adding rich_text support
-* Ensure I18n support for hard-coded English strings that are seen by the end-user
-* Create and finish the test suite
+* Complete multi-tenant support
+* Create and finish the test suite via TestKit
+
+### TODO on `bleeding` pre-merge
+* Add documentation about how to extend messages and rooms
+	*	If not for anyone else, do it for future you
+* Add to docs about how it is up to the dev to determine how messages/rooms are authorized

data/app/controllers/messaged/application_controller.rb

@@ -1,5 +1,5 @@
 module Messaged
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
     helper Messaged::Engine.helpers
     helper_method \
       :messaged_current_user,

data/app/controllers/messaged/messages_controller.rb

@@ -1,30 +1,31 @@
 module Messaged
   class MessagesController < ApplicationController
-    # TODO: How does the enginer user require authnetication without assuming Devise?
-    # before_action :authenticate_user!
+    # User should be authenticated by main.app
     before_action :set_message, only: [:destroy, :edit, :show, :update]
 
     def index
-      # TODO: How does the enginer user require authnetication without assuming Devise / ActsAsTenant?
-      # @messages = Message.where(account: current_account)
       @messages = Message.all
       @new_message = Message.new
-      @new_message = messaged_current_owner.messages.build if messaged_current_owner
+      return unless messaged_current_owner && messaged_current_owner.class != Messaged::NullUser
+      @new_message = messaged_current_owner.messages.build
     end
 
     def show; end
 
     def new
       @message = Message.new
-      @message = messaged_current_owner.messages.build if messaged_current_owner
+      return unless messaged_current_owner && messaged_current_owner.class != Messaged::NullUser
+      @message = messaged_current_owner.messages.build
     end
 
     def create
-      # TODO: How does the enginer user require authnetication without assuming Devise / ActsAsTenant?
-      # @message = Message.new(message_params.merge(account: current_account, user: current_user))
       @message = Message.new(message_params)
       if @message.save
-        @new_message = messaged_current_owner.messages.build if messaged_current_owner
+        if messaged_current_owner && messaged_current_owner.class != Messaged::NullUser
+          @new_message = messaged_current_owner.messages.build
+        else
+          @new_message = Message.new
+        end
         respond_to do |format|
           format.turbo_stream do
             render turbo_stream: turbo_stream.append(:messages, partial: "messaged/messages/message",
@@ -40,7 +41,6 @@ module Messaged
     def edit; end
 
     def update
-      # TODO: (Security risk) How to authenticate user agnostically?
     if @message.update(message_params)
       render @message
     else
@@ -49,7 +49,6 @@ module Messaged
     end
 
     def destroy
-      # TODO: (Security risk) How to authenticate user agnostically?
       @message.destroy
       respond_to do |format|
         format.turbo_stream { render turbo_stream: turbo_stream.remove(@message) }
@@ -60,7 +59,6 @@ module Messaged
     private
 
     def set_message
-      # TODO: (Security risk) How to authenticate user agnostically before declaring?
       @message = Message.find(params[:id])
     end
 

data/app/controllers/messaged/rooms_controller.rb

@@ -0,0 +1,62 @@
+module Messaged
+  class RoomsController < ApplicationController
+    # User should be authenticated by main.app
+    before_action :set_room, only: [:destroy, :edit, :show, :update]
+
+    def index
+      @rooms = Room.all
+    end
+
+    def show
+      @new_message = Message.new
+      return unless messaged_current_owner && messaged_current_owner.class != Messaged::NullUser
+      @new_message = messaged_current_owner.messages.build
+    end
+
+    def new
+      @room = Room.new
+      @recipient = Messaged.user_class.find(params[:recipient]) if params.dig(:recipient)
+      return unless messaged_current_owner && messaged_current_owner.class != Messaged::NullUser
+      @room = messaged_current_owner.rooms.build
+    end
+
+    def create
+      @room = Room.new(room_params)
+      if @room.save
+        respond_to do |format|
+          format.html { redirect_to @room }
+        end
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    def edit; end
+
+    def update
+      if @room.update(room_params)
+        render @room
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      @room.destroy
+      respond_to do |format|
+        format.turbo_stream { render turbo_stream: turbo_stream.remove(@room) }
+        format.html         { redirect_to rooms_url }
+      end
+    end
+
+    private
+
+    def set_room
+      @room = Room.find(params[:id])
+    end
+
+    def room_params
+      params.require(:room).permit(:title, :user_id, :tenant_id, :recipient_id)
+    end
+  end
+end

data/app/models/messaged/message.rb

@@ -14,12 +14,11 @@ module Messaged
         inverse_of: :messages,
         optional: true
     end
-    belongs_to :room, optional: true
+    belongs_to :messaged_room, optional: true, class_name: 'Messaged::Room'
 
     has_rich_text :content
     validates :content, presence: true
 
-    # TODO: This needs to be added to a generator
     after_create_commit -> { broadcast_append_later_to ["messages"], target: "messages", partial: "messaged/messages/message" }
     after_update_commit -> { broadcast_replace_later_to ["messages"], target: "#{dom_id(self)}", partial: "messaged/messages/message" }
     after_destroy_commit -> { broadcast_remove_to ["messages"] }
@@ -28,7 +27,7 @@ module Messaged
     # fallback to the chat room, and finally tenant if they exist.
     def owner
       return user if user
-      return room if room
+      return messaged_room if messaged_room
       return tenant if Messaged.tenant_class_name && tenant
       return nil # replace with user, tenant, or room
     end

data/app/models/messaged/room.rb

@@ -3,20 +3,25 @@ module Messaged
     # User association
     belongs_to :user,
       class_name: Messaged.user_class_name,
-      inverse_of: :messages,
+      inverse_of: :rooms,
+      optional: true
+    # Recipient user association
+    belongs_to :recipient,
+      class_name: Messaged.user_class_name,
+      inverse_of: :rooms,
       optional: true
     # Multi-tenant option
     if Messaged.tenant_class_name
       belongs_to :tenant,
         class_name: Messaged.tenant_class_name,
-        inverse_of: :messages,
+        inverse_of: :rooms,
         optional: true
     end
     validates :title, presence: true
 
-    has_many :messages, dependent: :destroy
+    has_many :messaged_messages, dependent: :destroy, class_name: 'Messaged::Message', foreign_key: 'messaged_room_id'
 
-    # Messages should default to the person sending them, otherwise
+    # Rooms should default to the person sending them, otherwise
     # fallback to the chat room, and finally tenant if they exist.
     def owner
       return user if user

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

@@ -5,7 +5,6 @@
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
-  <%= stylesheet_link_tag    "messaged/application", media: "all" %>
   <%= javascript_importmap_tags %>
 </head>
 <body>

data/config/locales/en.yml

@@ -7,3 +7,5 @@ en:
     delete: 'Delete'
     header: Messages
     null_user_name: 'Deleted User'
+    room_name: 'Room Name'
+    room_index: 'Rooms'

data/config/routes.rb

@@ -1,3 +1,4 @@
 Messaged::Engine.routes.draw do
   resources :messages
+  resources :rooms
 end

data/db/migrate/20221001034722_create_messaged.rb

@@ -1,31 +1,34 @@
 require 'messaged/base_migration'
 class CreateMessaged < Messaged::BaseMigration
   def change
-    create_table :messaged_messages do |t|
+    create_table :messaged_rooms do |t|
       t.references :tenant, type: user_id_type, index: false
-      t.index [:tenant_id], name: :index_messaged_messages_on_tenant_id
+      t.index [:tenant_id], name: :index_messaged_rooms_on_tenant_id
 
       t.references :user, type: tenant_id_type, index: false
-      t.index [:user_id], name: :index_messaged_messages_on_user_id
-
-      t.references :messaged_room, foreign_key: true
+      t.index [:user_id], name: :index_messaged_rooms_on_user_id
 
-      t.text :content
+      t.references :recipient, type: user_id_type, index: false
+      t.index [:recipient_id], name: :index_messaged_rooms_on_recipient_id
 
-      # Choose an association: room, user, tenant
-      t.string :delivery_target
+      t.string :title
 
       t.timestamps
     end
 
-    create_table :messaged_rooms do |t|
+    create_table :messaged_messages do |t|
       t.references :tenant, type: user_id_type, index: false
-      t.index [:tenant_id], name: :index_messaged_rooms_on_tenant_id
+      t.index [:tenant_id], name: :index_messaged_messages_on_tenant_id
 
       t.references :user, type: tenant_id_type, index: false
-      t.index [:user_id], name: :index_messaged_rooms_on_user_id
+      t.index [:user_id], name: :index_messaged_messages_on_user_id
 
-      t.string :title
+      t.belongs_to :messaged_room, index: true
+
+      t.text :content
+
+      # Choose an association: room, user, tenant
+      t.string :delivery_target
 
       t.timestamps
     end

data/lib/generators/messaged/views/templates/messages/_form.html.erb

@@ -1,8 +1,8 @@
 <%= form_with model: message, class: 'messaged-form' do |f| %>
   <%= f.label :content, t('messaged.send_a_message') %>
-  <%= f.hidden_field :user_id %>
+  <%= f.hidden_field :user_id, value: messaged_current_user.id if messaged_current_user %>
   <%= f.hidden_field :tenant_id %>
-  <%= f.hidden_field :messaged_room_id %>
+  <%= f.hidden_field :messaged_room_id, value: room.id if room %>
   <%= f.text_area :content %>
   <%= f.submit nil, class: 'messaged-button' %>
 <% end %>

data/lib/generators/messaged/views/templates/messages/index.html.erb

@@ -5,7 +5,7 @@
         <% if t('messaged.header').present? %>
           <h1 class="messaged-header"><%= t('messaged.header') %></h1>
         <% end %>
-        <% # TODO: How do we make current_user model agnostic? %>
+
         <%#= turbo_stream_from current_account, "messages" %>
         <%= turbo_stream_from "messages" %>
         <div class="messaged-messages" id="messages">

data/lib/generators/messaged/views/templates/rooms/_form.html.erb

@@ -0,0 +1,8 @@
+<%= form_with model: room, class: 'messaged-room-form' do |f| %>
+  <%= f.label :title, t('messaged.room_name') %>
+  <%= f.text_field :title, value: params[:title] %>
+  <%= f.hidden_field :user_id, value: messaged_current_user.id if messaged_current_user %>
+  <%= f.hidden_field :recipient_id, value: @recipient.id if @recipient %>
+  <%= f.hidden_field :tenant_id %>
+  <%= f.submit nil, class: 'messaged-button' %>
+<% end %>

data/lib/generators/messaged/views/templates/rooms/_room.html.erb

@@ -0,0 +1,28 @@
+<div class="messaged-room-container">
+  <div>
+    <div class="messaged-options">
+      <span><%= link_to t('messaged.edit'), messaged.edit_room_path(room), class: "messaged-edit-link", "data-turbo-action": "replace" %></span>
+      <%= button_to t('messaged.delete'), messaged.room_path(room), method: :delete, form: { data: { turbo_confirm: t('messaged.confirm') } }, class: "messaged-delete-link", "data-turbo-action": "delete" %>
+    </div>
+    <div class="messaged-index-container">
+      <div class="messaged-outer-wrapper">
+        <div class="messaged-inner-wrapper">
+          <div class="messaged-index">
+            <% if room.title.present? %>
+              <h1 class="messaged-header"><%= room.title %></h1>
+            <% end %>
+
+            <%= turbo_stream_from "messages" %>
+            <div class="messaged-messages" id="messages">
+              <%= render @room.messaged_messages %>
+            </div>
+
+            <%= turbo_frame_tag "new_message" do %>
+              <%= render "messaged/messages/form", message: @new_message, room: @room %>
+            <% end %>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/messaged/views/templates/rooms/create.turbostream.erb

@@ -0,0 +1,2 @@
+<%= turbo_stream.append "rooms", @room %>
+<%= turbo_stream.update "new_room", partial: "form", locals: { room: @new_room } %>

data/lib/generators/messaged/views/templates/rooms/edit.html.erb

@@ -0,0 +1 @@
+<%= render "form", room: @room %>

data/lib/generators/messaged/views/templates/rooms/index.html.erb

@@ -0,0 +1,14 @@
+<div class="messaged-index-container">
+  <div class="messaged-outer-wrapper">
+    <div class="messaged-inner-wrapper">
+      <div class="messaged-index">
+        <% if t('messaged.header').present? %>
+          <h1 class="messaged-header"><%= t('messaged.room_index') %></h1>
+        <% end %>
+        <div class="messaged-rooms" id="rooms">
+          <%= render @rooms %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/messaged/views/templates/rooms/new.html.erb

@@ -0,0 +1 @@
+<%= render "form", room: @room %>

data/lib/generators/messaged/views/templates/rooms/show.html.erb

@@ -0,0 +1 @@
+<%= render @room %>

data/lib/generators/messaged/views/views_generator.rb

@@ -8,7 +8,7 @@ module Messaged
         ]
       end
 
-      def copy_view_templates
+      def copy_message_view_templates
         copy_file \
           'messages/_form.html.erb',
           'app/views/messaged/messages/_form.html.erb'
@@ -37,6 +37,36 @@ module Messaged
         'messages/show.html.erb',
         'app/views/messaged/messages/show.html.erb'
       end
+
+      def copy_room_view_templates
+        copy_file \
+          'rooms/_form.html.erb',
+          'app/views/messaged/rooms/_form.html.erb'
+
+        copy_file \
+          'rooms/_room.html.erb',
+          'app/views/messaged/rooms/_room.html.erb'
+
+        copy_file \
+        'rooms/create.turbostream.erb',
+        'app/views/messaged/rooms/create.turbostream.erb'
+
+        copy_file \
+          'rooms/edit.html.erb',
+          'app/views/messaged/rooms/edit.html.erb'
+
+        copy_file \
+        'rooms/index.html.erb',
+        'app/views/messaged/rooms/index.html.erb'
+
+        copy_file \
+          'rooms/new.html.erb',
+          'app/views/messaged/rooms/new.html.erb'
+
+        copy_file \
+        'rooms/show.html.erb',
+        'app/views/messaged/rooms/show.html.erb'
+      end
     end
   end
 end

data/lib/messaged/engine.rb

@@ -7,9 +7,5 @@ module Messaged
     config.to_prepare do
       Messaged.user_class&.send(:include, Messaged::UserExtender)
     end
-
-    # initializer "messaged.assets.precompile" do |app|
-    #   app.config.assets.precompile += %w( messaged/application.css )
-    # end
   end
 end

data/lib/messaged/version.rb

@@ -1,3 +1,3 @@
 module Messaged
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messaged
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - cjilbert504, ianrandmckenzie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-29 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,30 +28,30 @@ dependencies:
   name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.2.0
 description: A quick and easy way to implement an instant-messaging module using Turbo
   Rails.
 email:
@@ -62,10 +62,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- app/assets/config/messaged_manifest.js
-- app/assets/stylesheets/messaged/application.css
 - app/controllers/messaged/application_controller.rb
 - app/controllers/messaged/messages_controller.rb
+- app/controllers/messaged/rooms_controller.rb
 - app/javascript/application.js
 - app/jobs/messaged/application_job.rb
 - app/models/messaged/application_record.rb
@@ -90,6 +89,13 @@ files:
 - lib/generators/messaged/views/templates/messages/index.html.erb
 - lib/generators/messaged/views/templates/messages/new.html.erb
 - lib/generators/messaged/views/templates/messages/show.html.erb
+- lib/generators/messaged/views/templates/rooms/_form.html.erb
+- lib/generators/messaged/views/templates/rooms/_room.html.erb
+- lib/generators/messaged/views/templates/rooms/create.turbostream.erb
+- lib/generators/messaged/views/templates/rooms/edit.html.erb
+- lib/generators/messaged/views/templates/rooms/index.html.erb
+- lib/generators/messaged/views/templates/rooms/new.html.erb
+- lib/generators/messaged/views/templates/rooms/show.html.erb
 - lib/generators/messaged/views/views_generator.rb
 - lib/messaged.rb
 - lib/messaged/base_migration.rb

data/app/assets/config/messaged_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/messaged .css

data/app/assets/stylesheets/messaged/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */