cubism 0.1.0.pre5 → 0.1.0.pre9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4486331e2d59695363fc4e2019ffe4fe7498a1b8d13e5ced08864b4f8fe1613c
-  data.tar.gz: a80f6add8477c622884f0f985efcda533e5b7d3a13f50a2ebb39fd4fba1a3f69
+  metadata.gz: 579dec94521951d33b64eb0c211a210fe86cc89f927a79489cd05258593e3634
+  data.tar.gz: 21d48a1e4c42ad33e27e11c1128930d22c2103120307a8bd0351d5321d520f9a
 SHA512:
-  metadata.gz: c07214a8095195319734a15296c4a302c59cd9107bb20b8839e52e1994f8447f7cf1065737fe3446b7743c29d0ce15621033a7a8fe44aab3624a467724482e8e
-  data.tar.gz: e5c9bab8327f4ff0adb46cd6a3465fedb6729597e41eb8dafd5695b870806642a9c28f36b7c3e0e51a0c882c2b42eab6edc6971c2bee34e214b16cf34b17215d
+  metadata.gz: 57c779b3efd7deae25de93339ab19d4a673e2bfae83e3f0d02e62741780b8320d4f1e1dd1c2a4c07bfec3a42c417eb5c59e5fbdfddd43a586c28ed9f945e546a
+  data.tar.gz: 999b2cae4e2d0c506fd08a02dad104c7e66f50f863fd9f5a58fa600e4fa2d0409ad81d88819905541423b68fccb9d80589a03dafc75c6c6a510aed2966f164fb

data/README.md

@@ -92,8 +92,8 @@ CableReady.initialize({ consumer });
 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.
+- `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.
 - `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.
 
@@ -177,4 +177,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
-<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->

data/app/channels/cubism/presence_channel.rb

@@ -3,7 +3,7 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
 
   def subscribed
     if resource.present?
-      stream_for resource
+      stream_from params[:element_id]
       resource.cubicle_element_ids << element_id
       resource.excluded_user_id_for_element_id[element_id] = user.id if exclude_current_user?
     else

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

@@ -3,8 +3,9 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
 
   def subscribed
     if resource.present?
-      stream_for resource
-      resource.present_users.add(user.id)
+      stream_from params[:element_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,6 +14,16 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   def unsubscribed
     return unless resource.present?
 
+    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
 
@@ -26,4 +37,16 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   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/helpers/cubism_helper.rb

@@ -9,7 +9,7 @@ module CubismHelper
     tag.cubicle_element(
       identifier: signed_stream_identifier(resource.to_gid.to_s),
       user: user.to_sgid.to_s,
-      "appear-trigger": appear_trigger,
+      "appear-trigger": Array(appear_trigger).join(","),
       "disappear-trigger": disappear_trigger,
       "trigger-root": trigger_root,
       id: "cubicle-#{digested_id}",

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

@@ -10,4 +10,11 @@ module Cubism::Presence
   def stream_presence
     Cubism::Broadcaster.new(resource: self).broadcast
   end
+
+  def present_users_for_element_id(element_id)
+    users = Cubism.user_class.find(present_users.members)
+    users.reject! { |user| user.id == excluded_user_id_for_element_id[element_id].to_i }
+
+    users
+  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/lib/cubism/broadcaster.rb

@@ -16,22 +16,13 @@ module Cubism
         /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)
+        html = view_context.capture(resource.present_users_for_element_id(element_id), &block)
 
-        cable_ready[Cubism::PresenceChannel].inner_html(
+        cable_ready[element_id].inner_html(
           selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
           html: html
-        ).broadcast_to(resource)
+        ).broadcast
       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~

@@ -1,3 +1,5 @@
+require "cable_ready"
+
 module Cubism
   class Broadcaster
     include CableReady::Broadcaster
@@ -16,10 +18,10 @@ module Cubism
         view_context = Cubism.store[block_key].context
         html = view_context.capture(users_for(resource, element_id), &block)
 
-        cable_ready[Cubism::PresenceChannel].inner_html(
+        cable_ready[element_id].inner_html(
           selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
           html: html
-        ).broadcast_to(resource)
+        ).broadcast
       end
     end
 

data/lib/cubism/cubicle_block_store.rb

@@ -2,6 +2,8 @@ module Cubism
   class CubicleBlockStore
     include Singleton
 
+    delegate_missing_to :@blocks
+
     def initialize
       @blocks = {}
     end
@@ -16,6 +18,12 @@ module Cubism
       end
     end
 
+    def clear
+      mutex.synchronize do
+        @blocks.clear
+      end
+    end
+
     private
 
     def mutex

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.pre5"
+  VERSION = "0.1.0.pre9"
 end

data/lib/cubism/version.rb~

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

data/lib/cubism.rb~

@@ -2,7 +2,15 @@ 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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cubism
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre5
+  version: 0.1.0.pre9
 platform: ruby
 authors:
 - Julian Rubisch
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: kredis
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0.pre8
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: nokogiri
+  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: mocha
+  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: appraisal
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -90,20 +132,13 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/channels/cubism/presence.rb~
 - app/channels/cubism/presence_channel.rb
 - app/channels/cubism/presence_channel.rb~
 - app/helpers/cubism_helper.rb
-- app/helpers/cubism_helper.rb~
-- app/models/concerns/cubism/base.rb~
 - app/models/concerns/cubism/presence.rb
 - app/models/concerns/cubism/presence.rb~
 - app/models/concerns/cubism/user.rb
-- 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~
@@ -112,8 +147,6 @@ files:
 - lib/cubism/cubicle_block_store.rb
 - lib/cubism/cubicle_block_store.rb~
 - lib/cubism/engine.rb
-- lib/cubism/engine.rb~
-- lib/cubism/railtie.rb~
 - lib/cubism/version.rb
 - lib/cubism/version.rb~
 - lib/tasks/cubism_tasks.rake
@@ -123,7 +156,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/julianrubisch/cubism
   source_code_uri: https://github.com/julianrubisch/cubism.git
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Lightweight Resource-Based Presence Solution with CableReady
 test_files: []

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

@@ -1,18 +0,0 @@
-class Cubism::Presence < ActionCable::Channel::Base
-  def subscribed
-    resource = GlobalID::Locator.locate_signed params[:signed_resource]
-    if resource.present?
-      stream_for resource
-      resource.present_users.add(current_user.id)
-    else
-      reject
-    end
-  end
-
-  def unsubscribed
-    resource = GlobalID::Locator.locate_signed params[:signed_resource]
-    return unless resource.present?
-
-    resource.present_users.remove(current_user.id)
-  end
-end

data/app/helpers/cubism_helper.rb~

@@ -1,24 +0,0 @@
-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)
-    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/base.rb~

@@ -1,3 +0,0 @@
-module Cubism::Base
-  extend ActiveSupport::Concern
-end

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

@@ -1,11 +0,0 @@
-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,14 +0,0 @@
-class Cubism::Base
-  include ActiveModel::Model
-  include Kredis::Attributes
-  include Cubism::Presence
-  include GlobalID::Identification
-
-  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/base.rb~

@@ -1,13 +0,0 @@
-class Cubism::Base
-  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/lib/cubism/engine.rb~

@@ -1,5 +0,0 @@
-module Cubism
-  class Engine < ::Rails::Engine
-  end
-end
-

data/lib/cubism/railtie.rb~

@@ -1,4 +0,0 @@
-module Cubism
-  class Railtie < ::Rails::Railtie
-  end
-end