cubism 0.1.0.pre11 → 0.1.0.pre12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf5d9eed6d97039688a2f51dd5ddab248619879ad47d50abbf37bab73d7f7d56
-  data.tar.gz: 8120474f22abf5ee4b9bc2497e91ef2e68f41aea79f59fde4ae1c9e577a75dd7
+  metadata.gz: 8cd7c7ee681cabc05fd5329e7e6c17fd030d037beb100440faf1ef190a614ddf
+  data.tar.gz: a772708b9dc6a32c5a37766d203ea6a4b119eac57368378121e6b4da9f2b50f6
 SHA512:
-  metadata.gz: fe7a0bca6d22807e0eb6b81e612ee8d435f67380a5aec20df253a86a92606642f907a67341b845159b2ae498dfcc0d7c56c1f49fb3425e1470789140adf4939e
-  data.tar.gz: dd6925f36a82fcfab2de5a888b1d974b151fb9a14a7c4cf76cab9f3ffde28b865790c09dd4b97b19a8284192cef644847a3c944b06e53dd2d690ef8da2a7245e
+  metadata.gz: b47525bcc5545b289624615b66215b68467c2a2ba35a7b5335c944bdfacc68d0c6d60c430c93ad1b18470db7e7d3a58313f232b35bc32a34b21847f4a28f086b
+  data.tar.gz: 4595ebf829643d556613ebc5ca03e19f35cc6601a8c435f0dfea3c4e9cc7c08966c94ae69996e87d0e8c572d1d0decc8e6bd1cfa9ee7840a7abad29909f3ab7f

data/README.md

@@ -96,9 +96,10 @@ CableReady.initialize({ consumer });
 
 The `cubicle_for` helper accepts the following options as keyword arguments:
 
+- `scope`: declare a scope in which presence indicators should appear. For example, if you want to divide between index and show views, do `scope: :index` and `scope: :show` respectively (default: `""`).
 - `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 (default: `true`).
-- `appear_trigger`: JavaScript event names (e.g. `["focus", "debounced:input]`) to use. (Can also be a singular string, which will be converted to an array). 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. (Can also be a singular string, which will be converted to an array). The default is `:disconnect`, i.e. remove a user form the present users list when the element disconnects from the DOM.
+- `appear_trigger`: JavaScript event names (e.g. `["focus", "debounced:input]`) to use. (Can also be a singular string, which will be converted to an array). The default is `:connect`, i.e. register a user as "appeared"/"present" when the element connects to the DOM. Another special value is `:intersect`, which fires when the `trigger_root` comes into the viewport.
+- `disappear_trigger`: a JavaScript event name (e.g. `:blur`) to use. (Can also be a singular string, which will be converted to an array). The default is `:disconnect`, i.e. remove a user form the present users list when the element disconnects from the DOM. Analoguous to above, `:intersect` means that `disappear` will fire when the `trigger_root` is scrolled out of the viewport.
 - `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.
 

data/app/channels/cubism/presence_channel.rb

@@ -3,7 +3,7 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
 
   def subscribed
     if resource.present?
-      stream_from params[:element_id]
+      stream_from element_id
       resource.cubicle_element_ids << element_id
       resource.excluded_user_id_for_element_id[element_id] = user.id if exclude_current_user?
     else
@@ -20,11 +20,11 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   end
 
   def appear
-    resource.present_users.add(user.id)
+    resource.set_present_users_for_scope(resource.present_users_for_scope(scope).add(user.id), scope) if scope
   end
 
   def disappear
-    resource.present_users.remove(user.id)
+    resource.set_present_users_for_scope(resource.present_users_for_scope(scope).delete(user.id), scope) if scope
   end
 
   private
@@ -35,7 +35,15 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   end
 
   def user
-    GlobalID::Locator.locate_signed(params[:user])
+    block_container&.user
+  end
+
+  def scope
+    block_container&.scope
+  end
+
+  def block_container
+    Cubism.block_store[element_id]
   end
 
   def exclude_current_user?
@@ -43,7 +51,8 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   end
 
   def element_id
-    params[:element_id]
+    /cubicle-(?<element_id>.+)/ =~ params[:element_id]
+    element_id
   end
 
   def url

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

@@ -3,7 +3,7 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
 
   def subscribed
     if resource.present?
-      stream_from params[:element_id]
+      stream_from element_id
       resource.cubicle_element_ids << element_id
       resource.excluded_user_id_for_element_id[element_id] = user.id if exclude_current_user?
     else
@@ -20,11 +20,11 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   end
 
   def appear
-    resource.present_users.add(user.id)
+    resource.set_present_users_for_scope(resource.present_users_for_scope(scope).add(user.id), scope)
   end
 
   def disappear
-    resource.present_users.remove(user.id)
+    resource.set_present_users_for_scope(resource.present_users_for_scope(scope).delete(user.id), scope)
   end
 
   private
@@ -35,7 +35,15 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   end
 
   def user
-    GlobalID::Locator.locate_signed(params[:user])
+    block_container.user
+  end
+
+  def scope
+    block_container.scope
+  end
+
+  def block_container
+    Cubism.block_store[element_id]
   end
 
   def exclude_current_user?
@@ -43,7 +51,8 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   end
 
   def element_id
-    params[:element_id]
+    /cubicle-(?<element_id>.+)/ =~ params[:element_id]
+    element_id
   end
 
   def url

data/app/helpers/cubism_helper.rb

@@ -1,7 +1,7 @@
 module CubismHelper
   include CableReady::StreamIdentifier
 
-  def cubicle_for(resource, user, html_options: {}, appear_trigger: :connect, disappear_trigger: nil, trigger_root: nil, exclude_current_user: true, &block)
+  def cubicle_for(resource, user, scope: "", html_options: {}, appear_trigger: :connect, disappear_trigger: nil, trigger_root: nil, exclude_current_user: true, &block)
     block_location = block.source_location.join(":")
     block_source = Cubism::BlockSource.find_or_create(
       location: block_location,
@@ -14,7 +14,8 @@ module CubismHelper
       block_location: block_location,
       block_source: block_source,
       resource_gid: resource_gid,
-      user_gid: user.to_gid.to_s
+      user_gid: user.to_gid.to_s,
+      scope: scope
     )
 
     digested_block_key = block_container.digest
@@ -23,7 +24,6 @@ module CubismHelper
 
     tag.cubicle_element(
       identifier: signed_stream_identifier(resource_gid),
-      user: user.to_sgid.to_s,
       "appear-trigger": Array(appear_trigger).join(","),
       "disappear-trigger": disappear_trigger,
       "trigger-root": trigger_root,

data/app/helpers/cubism_helper.rb~

@@ -1,30 +1,33 @@
 module CubismHelper
   include CableReady::StreamIdentifier
 
-  def cubicle_for(resource, user, html_options: {}, appear_trigger: :connect, disappear_trigger: nil, trigger_root: nil, exclude_current_user: true, &block)
+  def cubicle_for(resource, user, scope: "", html_options: {}, appear_trigger: :connect, disappear_trigger: nil, trigger_root: nil, exclude_current_user: true, &block)
     block_location = block.source_location.join(":")
+    block_source = Cubism::BlockSource.find_or_create(
+      location: block_location,
+      view_context: self
+    )
 
     resource_gid = resource.to_gid.to_s
 
-    store_item = Cubism::BlockStoreItem.new(
+    block_container = Cubism::BlockContainer.new(
       block_location: block_location,
+      block_source: block_source,
       resource_gid: resource_gid,
       user_gid: user.to_gid.to_s,
-      view_context: self
+      scope: scope
     )
 
-    digested_block_key = store_item.digest
-
-    store_item.parse!
+    digested_block_key = block_container.digest
 
-    Cubism.block_store[digested_block_key] = store_item
+    Cubism.block_store.fetch(digested_block_key, block_container)
 
     tag.cubicle_element(
       identifier: signed_stream_identifier(resource_gid),
-      user: user.to_sgid.to_s,
       "appear-trigger": Array(appear_trigger).join(","),
       "disappear-trigger": disappear_trigger,
       "trigger-root": trigger_root,
+      scope: scope,
       id: "cubicle-#{digested_block_key}",
       "exclude-current-user": exclude_current_user,
       **html_options

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

@@ -2,7 +2,7 @@ module Cubism::Presence
   extend ActiveSupport::Concern
 
   included do
-    kredis_set :present_users, after_change: :stream_presence
+    kredis_hash :present_users, after_change: :stream_presence
     kredis_set :cubicle_element_ids
     kredis_hash :excluded_user_id_for_element_id
   end
@@ -11,8 +11,16 @@ module Cubism::Presence
     Cubism::Broadcaster.new(resource: self).broadcast
   end
 
-  def present_users_for_element_id(element_id)
-    users = Cubism.user_class.find(present_users.members)
+  def present_users_for_scope(scope = "")
+    present_users[scope].present? ? Marshal.load(present_users[scope]) : Set.new
+  end
+
+  def set_present_users_for_scope(user_ids, scope = "")
+    present_users[scope] = Marshal.dump(Set.new(user_ids))
+  end
+
+  def present_users_for_element_id_and_scope(element_id, scope = "")
+    users = Cubism.user_class.find(present_users_for_scope(scope).to_a)
     users.reject! { |user| user.id == excluded_user_id_for_element_id[element_id].to_i }
 
     users

data/lib/cubism/broadcaster.rb

@@ -13,20 +13,25 @@ module Cubism
 
     def broadcast
       resource.cubicle_element_ids.to_a.each do |element_id|
-        /cubicle-(?<block_key>.+)/ =~ element_id
-        block_container = Cubism.block_store[block_key]
+        block_container = Cubism.block_store[element_id]
 
         next if block_container.blank?
 
+        present_users = resource.present_users_for_element_id_and_scope(element_id, block_container.scope)
+
         block_source = block_container.block_source
 
-        html = ApplicationController.render(inline: block_source.source, locals: {"#{block_source.variable_name}": resource.present_users_for_element_id(element_id)})
+        html = ApplicationController.render(inline: block_source.source, locals: {"#{block_source.variable_name}": present_users})
+
+        selector = "cubicle-element#cubicle-#{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']"
 
         cable_ready[element_id].inner_html(
-          selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
+          selector: selector,
           html: html
-        ).broadcast
+        )
       end
+
+      cable_ready.broadcast
     end
   end
 end

data/lib/cubism/broadcaster.rb~

@@ -13,18 +13,25 @@ module Cubism
 
     def broadcast
       resource.cubicle_element_ids.to_a.each do |element_id|
-        /cubicle-(?<block_key>.+)/ =~ element_id
-        store_item = Cubism.block_store[block_key]
+        block_container = Cubism.block_store[element_id]
 
-        next if store_item.blank?
+        next if block_container.blank?
 
-        html = ApplicationController.render(inline: store_item.block_source, locals: {"#{store_item.block_variable_name}": resource.present_users_for_element_id(element_id)})
+        present_users = resource.present_users_for_element_id_and_scope(element_id, block_container.scope)
+
+        block_source = block_container.block_source
+
+        html = ApplicationController.render(inline: block_source.source, locals: {"#{block_source.variable_name}": present_users})
+
+        selector = "cubicle-element#cubicle-#{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}'][scope='#{block_container.scope}']"
 
         cable_ready[element_id].inner_html(
-          selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
+          selector: selector,
           html: html
-        ).broadcast
+        )
       end
+
+      cable_ready.broadcast
     end
   end
 end

data/lib/cubism/cubicle_store.rb

@@ -49,6 +49,7 @@ module Cubism
     :block_source,
     :user_gid,
     :resource_gid,
+    :scope,
     keyword_init: true
   ) do
     def initialize(*args)
@@ -65,8 +66,12 @@ module Cubism
       GlobalID::Locator.locate self[:resource_gid]
     end
 
+    def scope
+      self[:scope] || ""
+    end
+
     def digest
-      resource_user_key = [resource_gid, user_gid].join(":")
+      resource_user_key = [resource_gid, user_gid, scope].join(":")
 
       ActiveSupport::Digest.hexdigest("#{block_location}:#{File.read(@filename)}:#{resource_user_key}")
     end

data/lib/cubism/cubicle_store.rb~

@@ -44,11 +44,12 @@ module Cubism
   end
 
   # Container for cubicle blocks
-  BlockStoreItem = Struct.new(
+  BlockContainer = Struct.new(
     :block_location,
     :block_source,
     :user_gid,
     :resource_gid,
+    :scope,
     keyword_init: true
   ) do
     def initialize(*args)
@@ -65,6 +66,10 @@ module Cubism
       GlobalID::Locator.locate self[:resource_gid]
     end
 
+    def scope
+      self[:scope] || ""
+    end
+
     def digest
       resource_user_key = [resource_gid, user_gid].join(":")
 
@@ -72,7 +77,7 @@ module Cubism
     end
 
     def marshal_dump
-      to_h.reverse_merge(block_source: block_source.digest)
+      to_h.merge(block_source: block_source.digest)
     end
 
     def marshal_load(serialized_item)
@@ -80,7 +85,7 @@ module Cubism
         send("#{arg}=", serialized_item[arg])
       end
 
-      self.block_source = Cubism.source_store(serialized_item[:block_source])
+      self.block_source = Cubism.source_store[serialized_item[:block_source]]
     end
   end
 

data/lib/cubism/version.rb

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

data/lib/cubism/version.rb~

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubism
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre11
+  version: 0.1.0.pre12
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails