cubism 0.1.0.pre1 → 0.1.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe95381d8e51d520357a7fa08fe84d8107739b039b1f2f11846decb30b63afae
-  data.tar.gz: 2a4cfb19b44eb395be36c9fafd340c967d51b91690b4ebfbf11321f23a6162e8
+  metadata.gz: 4486331e2d59695363fc4e2019ffe4fe7498a1b8d13e5ced08864b4f8fe1613c
+  data.tar.gz: a80f6add8477c622884f0f985efcda533e5b7d3a13f50a2ebb39fd4fba1a3f69
 SHA512:
-  metadata.gz: 335f728fbe45554a741baee7cd4e717e5b4807cdc1ee7506fac3f9273e6f0f69f416192c7b7fe69ba6202a4de573be342b19b9d60a132372c58cdb33a8af75a6
-  data.tar.gz: b3e49b66ffa6f6348365436be31714953ef56f95187a5db49cc5afdc71ab4b8f6d28d08423a02fa9ee3e351d539d4f7b5a1420c170aafba20b507d403f0232b8
+  metadata.gz: c07214a8095195319734a15296c4a302c59cd9107bb20b8839e52e1994f8447f7cf1065737fe3446b7743c29d0ce15621033a7a8fe44aab3624a467724482e8e
+  data.tar.gz: e5c9bab8327f4ff0adb46cd6a3465fedb6729597e41eb8dafd5695b870806642a9c28f36b7c3e0e51a0c882c2b42eab6edc6971c2bee34e214b16cf34b17215d

data/README.md

@@ -1,4 +1,7 @@
 # Cubism
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 [![Twitter follow](https://img.shields.io/twitter/follow/julian_rubisch?style=social)](https://twitter.com/julian_rubisch)
 
 Lightweight Resource-Based Presence Solution with CableReady
@@ -8,7 +11,8 @@ Lightweight Resource-Based Presence Solution with CableReady
 - [Table of Contents](#table-of-contents)
 - [Usage](#usage)
 - [Installation](#installation)
-- [Manual Installation](#manual-installation)
+- [API](#api)
+- [Gotchas](#gotchas)
 - [Contributing](#contributing)
 - [License](#license)
 - [Contributors](#contributors)
@@ -16,12 +20,11 @@ Lightweight Resource-Based Presence Solution with CableReady
 ## Usage
 
 ### Prepare your User Model
-In your app's `User` model, include `Cubism::User` and set up a safelist of exposed attributes:
+In your app's `User` model, include `Cubism::User`:
 
 ```rb
 class User < ApplicationRecord
   include Cubism::User
-  self.cubicle_attributes = %i[email id]
 
   # ...
 end
@@ -33,6 +36,8 @@ In the models you'd like to track presence for, include the `Cubism::Presence` c
 ```rb
 class Project < ApplicationRecord
   include Cubism::Presence
+
+  # ...
 end
 ```
 
@@ -41,18 +46,14 @@ end
 Using the `cubicle_for` helper, you can set up a presence indicator. It will
 
 1. subscribe to the respective resource, and
-2. accept a "template" using the attributes safelisted above. Elements marked with `data-cubicle-attribute=` will have their `innerHTML` replaced by Cubism.
+2. render a block which is passed the list of present `users`:
 
 ```erb
-<%= cubicle_for @project do %>
-  <span class="avatar">
-    <span data-cubicle-attribute="email"></span>
-  </span>
+<%= cubicle_for @project, current_user do |users| %>
+  <%= users.map(&:username).join(", ")
 <% end %>
 ```
 
-Note that this template will simply be repeated for every user that's in the `@project`s `present_users` set.
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -86,6 +87,39 @@ import "@minthesize/cubism";
 CableReady.initialize({ consumer });
 ```
 
+## API
+
+The `cubicle_for` helper accepts the following options as keyword arguments:
+
+- `exclude_current_user (true|false)`: Whether or not to exclude the current user from the list of present users broadcasted to the view. Useful e.g. for "typing..." indicators.
+- `appear_trigger`: a JavaScript event name (e.g. `:focus`) to use. The default is `:connect`, i.e. register a user as "appeared"/"present" when the element connects to the DOM.
+- `disappear_trigger`: a JavaScript event name (e.g. `:blur`) to use. The default is `:disconnect`, i.e. remove a user form the present users list when the element disconnects from the DOM.
+- `trigger_root`: a CSS selector to attach the appear/disappear events to. Defaults to the `cubicle-element` itself.
+- `html_options` are passed to the TagBuilder.
+
+## Gotchas
+
+### Usage with ViewComponent
+
+Currently there's a bug in VC resulting in the `capture` helper not working correctly (https://github.com/github/view_component/pull/974). The current workaround is to assign a slot in your component and render the presence list from outside:
+
+```rb
+class MyComponent < ViewComponent::Base
+  renders_one :presence_list
+
+  # ...
+end
+```
+
+```erb
+<%= render MyComponent.new do |c| %>
+  <% c.presence_list do %>
+    <%= cubicle_for @project, current_user do |users| %>
+      ...
+    <% end %>
+  <% end %>
+<% end %>
+```
 
 ## Contributing
 
@@ -95,8 +129,7 @@ Below are a set of instructions that may help you get a local development enviro
 
 ```sh
 # Get the gem/npm package source locally
-git clone cubism
-cd cubism/javascript
+git clone https://github.com/julianrubisch/cubism
 yarn install # install all of the npm package's dependencies
 yarn link # set the local machine's cubism npm package's lookup to this local path
 
@@ -125,9 +158,23 @@ yarn install --force
 2. `git commit -m "Bump version to x.x.x"`
 3. Run `bundle exec rake build`
 4. Run `bundle exec rake release`
-5. `cd javascript && npm publish --access public`
+5. Run `npm publish --access public`
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="http://www.minthesize.com"><img src="https://avatars.githubusercontent.com/u/4352208?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/julianrubisch/cubism/commits?author=julianrubisch" title="Code">💻</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

data/app/channels/cubism/presence_channel.rb

@@ -4,7 +4,8 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   def subscribed
     if resource.present?
       stream_for resource
-      resource.present_users.add(current_user.id)
+      resource.cubicle_element_ids << element_id
+      resource.excluded_user_id_for_element_id[element_id] = user.id if exclude_current_user?
     else
       reject
     end
@@ -13,7 +14,17 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   def unsubscribed
     return unless resource.present?
 
-    resource.present_users.remove(current_user.id)
+    resource.cubicle_element_ids.remove(element_id)
+    resource.excluded_user_id_for_element_id.delete(element_id)
+    disappear
+  end
+
+  def appear
+    resource.present_users.add(user.id)
+  end
+
+  def disappear
+    resource.present_users.remove(user.id)
   end
 
   private
@@ -22,4 +33,20 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
     locator = verified_stream_identifier(params[:identifier])
     GlobalID::Locator.locate(locator)
   end
+
+  def user
+    GlobalID::Locator.locate_signed(params[:user])
+  end
+
+  def exclude_current_user?
+    params[:exclude_current_user]
+  end
+
+  def element_id
+    params[:element_id]
+  end
+
+  def url
+    params[:url]
+  end
 end

data/app/channels/cubism/presence_channel.rb~

@@ -4,7 +4,7 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   def subscribed
     if resource.present?
       stream_for resource
-      resource.present_users.add(current_user.id)
+      resource.present_users.add(user.id)
     else
       reject
     end
@@ -13,7 +13,7 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   def unsubscribed
     return unless resource.present?
 
-    resource.present_users.remove(current_user.id)
+    resource.present_users.remove(user.id)
   end
 
   private
@@ -22,4 +22,8 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
     locator = verified_stream_identifier(params[:identifier])
     GlobalID::Locator.locate(locator)
   end
+
+  def user
+    GlobalID::Locator.locate_signed(params[:user])
+  end
 end

data/app/helpers/cubism_helper.rb

@@ -1,11 +1,20 @@
 module CubismHelper
   include CableReady::StreamIdentifier
 
-  def cubicle_for(resource, html_options: {}, &block)
-    template = capture(&block)
+  def cubicle_for(resource, user, html_options: {}, appear_trigger: :connect, disappear_trigger: nil, trigger_root: nil, exclude_current_user: true, &block)
+    key = "#{block.source_location.join(":")}:#{resource.to_gid}:#{user.to_gid}"
+    digested_id = ActiveSupport::Digest.hexdigest(key)
 
-    tag.cubicle_element({identifier: signed_stream_identifier(resource.to_global_id.to_s)}) do
-      content_tag(:template, template, {slot: "template"})
-    end
+    Cubism.store[digested_id] = Cubism::BlockStoreItem.new(context: self, block: block.dup)
+    tag.cubicle_element(
+      identifier: signed_stream_identifier(resource.to_gid.to_s),
+      user: user.to_sgid.to_s,
+      "appear-trigger": appear_trigger,
+      "disappear-trigger": disappear_trigger,
+      "trigger-root": trigger_root,
+      id: "cubicle-#{digested_id}",
+      "exclude-current-user": exclude_current_user,
+      **html_options
+    )
   end
 end

data/app/helpers/cubism_helper.rb~

@@ -1,8 +1,24 @@
 module CubismHelper
-  include CableReady::Compoundable
   include CableReady::StreamIdentifier
 
-  def cubicle_for(*keys, html_options: {})
-    tag.cubicle_element({identifier: signed_stream_identifier(compound(keys))})
+  def cubicle_for(resource, user, html_options: {}, appear_trigger: :connect, disappear_trigger: nil, trigger_root: nil, exclude_current_user: true, &block)
+    key = "#{block.source_location.join(":")}:#{resource.to_gid}:#{user.to_gid}"
+    verifiable_id = CableReady.signed_stream_verifier.generate(key)
+
+    Cubism.store[verifiable_id] = Cubism::BlockStoreItem.new(context: self, block: block.dup)
+    template = capture(&block)
+
+    tag.cubicle_element(
+      identifier: signed_stream_identifier(resource.to_gid.to_s),
+      user: user.to_sgid.to_s,
+      "appear-trigger": appear_trigger,
+      "disappear-trigger": disappear_trigger,
+      "trigger-root": trigger_root,
+      id: "cubicle-#{verifiable_id}",
+      "exclude-current-user": exclude_current_user,
+      **html_options
+    ) do
+      content_tag(:template, template, {slot: "template"})
+    end
   end
 end

data/app/models/concerns/cubism/presence.rb

@@ -2,10 +2,12 @@ module Cubism::Presence
   extend ActiveSupport::Concern
 
   included do
-    kredis_set :present_users, after_change: :stream_presence_later
+    kredis_set :present_users, after_change: :stream_presence
+    kredis_set :cubicle_element_ids
+    kredis_hash :excluded_user_id_for_element_id
   end
 
-  def stream_presence_later
-    Cubism::StreamPresenceJob.perform_later(resource: self)
+  def stream_presence
+    Cubism::Broadcaster.new(resource: self).broadcast
   end
 end

data/app/models/concerns/cubism/user.rb

@@ -3,9 +3,5 @@ module Cubism::User
 
   included do
     Cubism.user_class = self
-
-    class_eval do
-      cattr_accessor :cubicle_attributes
-    end
   end
 end

data/app/models/concerns/cubism/user.rb~

@@ -0,0 +1,11 @@
+module Cubism::User
+  extend ActiveSupport::Concern
+
+  included do
+    Cubism.user_class = self
+
+    class_eval do
+      cattr_accessor :cubicle_attributes
+    end
+  end
+end

data/app/models/cubism/base.rb

@@ -1,7 +1,8 @@
 class Cubism::Base
   include ActiveModel::Model
+  include Kredis::Attributes
   include Cubism::Presence
-  include GlobalID::Identifiable
+  include GlobalID::Identification
 
   def self.find(id)
     new if id == "cubism-#{self.class.name.underscore}"

data/app/models/cubism/base.rb~

@@ -1,3 +1,13 @@
 class Cubism::Base
-  include Cubism::Presence 
+  include ActiveModel::Model
+  include Cubism::Presence
+  include GlobalID::Identifiable
+
+  def self.find(id)
+    new if id == "cubism-#{self.class.name.underscore}"
+  end
+
+  def id
+    "cubism-#{self.class.name.underscore}"
+  end
 end

data/app/models/cubism/current.rb

@@ -0,0 +1,5 @@
+module Cubism
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :user
+  end
+end

data/lib/cubism/broadcaster.rb

@@ -0,0 +1,37 @@
+require "cable_ready"
+
+module Cubism
+  class Broadcaster
+    include CableReady::Broadcaster
+    include CableReady::StreamIdentifier
+
+    attr_reader :resource
+
+    def initialize(resource:)
+      @resource = resource
+    end
+
+    def broadcast
+      resource.cubicle_element_ids.to_a.each do |element_id|
+        /cubicle-(?<block_key>.+)/ =~ element_id
+        block = Cubism.store[block_key].block
+        view_context = Cubism.store[block_key].context
+        html = view_context.capture(users_for(resource, element_id), &block)
+
+        cable_ready[Cubism::PresenceChannel].inner_html(
+          selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
+          html: html
+        ).broadcast_to(resource)
+      end
+    end
+
+    private
+
+    def users_for(resource, element_id)
+      users = Cubism.user_class.find(resource.present_users.members)
+      users.reject! { |user| user.id == resource.excluded_user_id_for_element_id[element_id].to_i }
+
+      users
+    end
+  end
+end

data/lib/cubism/broadcaster.rb~

@@ -0,0 +1,35 @@
+module Cubism
+  class Broadcaster
+    include CableReady::Broadcaster
+    include CableReady::StreamIdentifier
+
+    attr_reader :resource
+
+    def initialize(resource:)
+      @resource = resource
+    end
+
+    def broadcast
+      resource.cubicle_element_ids.to_a.each do |element_id|
+        /cubicle-(?<block_key>.+)/ =~ element_id
+        block = Cubism.store[block_key].block
+        view_context = Cubism.store[block_key].context
+        html = view_context.capture(users_for(resource, element_id), &block)
+
+        cable_ready[Cubism::PresenceChannel].inner_html(
+          selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
+          html: html
+        ).broadcast_to(resource)
+      end
+    end
+
+    private
+
+    def users_for(resource, element_id)
+      users = Cubism.user_class.find(resource.present_users.members)
+      users.reject! { |user| user.id == resource.excluded_user_id_for_element_id[element_id].to_i }
+
+      users
+    end
+  end
+end

data/lib/cubism/cubicle_block_store.rb

@@ -0,0 +1,27 @@
+module Cubism
+  class CubicleBlockStore
+    include Singleton
+
+    def initialize
+      @blocks = {}
+    end
+
+    def [](key)
+      @blocks[key]
+    end
+
+    def []=(key, value)
+      mutex.synchronize do
+        @blocks[key] = value
+      end
+    end
+
+    private
+
+    def mutex
+      @mutex ||= Mutex.new
+    end
+  end
+
+  BlockStoreItem = Struct.new(:context, :block, keyword_init: true)
+end

data/lib/cubism/version.rb

@@ -1,3 +1,3 @@
 module Cubism
-  VERSION = "0.1.0.pre1"
+  VERSION = "0.1.0.pre5"
 end

data/lib/cubism/version.rb~

@@ -1,3 +1,3 @@
 module Cubism
-  VERSION = "0.1.0"
+  VERSION = "0.1.0.pre4"
 end

data/lib/cubism.rb

@@ -1,6 +1,16 @@
+require "kredis"
+
 require "cubism/version"
 require "cubism/engine"
+require "cubism/broadcaster"
+require "cubism/cubicle_block_store"
 
 module Cubism
+  extend ActiveSupport::Autoload
+
+  autoload :Broadcaster, "cubism/broadcaster"
+
   mattr_accessor :user_class, instance_writer: false, instance_reader: false
+
+  mattr_reader :store, instance_reader: false, default: Cubism::CubicleBlockStore.instance
 end

data/lib/cubism.rb~

@@ -1,6 +1,8 @@
+require "kredis"
+
 require "cubism/version"
 require "cubism/engine"
 
 module Cubism
-  # Your code goes here...
+  mattr_accessor :user_class, instance_writer: false, instance_reader: false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubism
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.1.0.pre5
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre6
+        version: 5.0.0.pre8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre6
+        version: 5.0.0.pre8
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -81,8 +95,6 @@ files:
 - app/channels/cubism/presence_channel.rb~
 - app/helpers/cubism_helper.rb
 - app/helpers/cubism_helper.rb~
-- app/jobs/cubism/stream_presence_job.rb
-- app/jobs/cubism/stream_presence_job.rb~
 - app/models/concerns/cubism/base.rb~
 - app/models/concerns/cubism/presence.rb
 - app/models/concerns/cubism/presence.rb~
@@ -90,9 +102,15 @@ files:
 - app/models/concerns/cubism/user.rb~
 - app/models/cubism/base.rb
 - app/models/cubism/base.rb~
+- app/models/cubism/current.rb
+- app/models/cubism/current.rb~
 - config/routes.rb
 - lib/cubism.rb
 - lib/cubism.rb~
+- lib/cubism/broadcaster.rb
+- lib/cubism/broadcaster.rb~
+- lib/cubism/cubicle_block_store.rb
+- lib/cubism/cubicle_block_store.rb~
 - lib/cubism/engine.rb
 - lib/cubism/engine.rb~
 - lib/cubism/railtie.rb~

data/app/jobs/cubism/stream_presence_job.rb

@@ -1,15 +0,0 @@
-class Cubism::StreamPresenceJob < ApplicationJob
-  include CableReady::Broadcaster
-  include CableReady::StreamIdentifier
-  queue_as :default
-
-  def perform(resource:)
-    cable_ready[Cubism::PresenceChannel].dispatch_event(
-      name: "cubism:update",
-      selector: "cubicle-element[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
-      detail: {
-        users: Cubism.user_class.find(resource.present_users.members).map { |user| user.slice(user.cubicle_attributes) }.as_json
-      }
-    ).broadcast_to(resource)
-  end
-end

data/app/jobs/cubism/stream_presence_job.rb~

@@ -1,11 +0,0 @@
-class Cubism::StreamPresenceJob < ApplicationJob
-  include CableReady::Broadcaster
-  queue_as :default
-
-  def perform(resource:)
-    cable_ready[Cubism::PresenceChannel].outer_html(
-      selector: dom_id(resource, "cubicle").to_s,
-      html: ApplicationController.render(partial: "shared/presence_indicator", locals: {users: User.where(id: resource.present_users.members)})
-    ).broadcast
-  end
-end