cubism 0.1.0.pre9 → 0.1.0.pre10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 579dec94521951d33b64eb0c211a210fe86cc89f927a79489cd05258593e3634
-  data.tar.gz: 21d48a1e4c42ad33e27e11c1128930d22c2103120307a8bd0351d5321d520f9a
+  metadata.gz: 976cb8cfb5c2fe6edb6dd6e541c74361ae17dd12ce717bafadcb6ff6bdd1b9f1
+  data.tar.gz: a3e777efd1df0423ab4754ed30fe119b6497197ec2bc8ee564304385b907849d
 SHA512:
-  metadata.gz: 57c779b3efd7deae25de93339ab19d4a673e2bfae83e3f0d02e62741780b8320d4f1e1dd1c2a4c07bfec3a42c417eb5c59e5fbdfddd43a586c28ed9f945e546a
-  data.tar.gz: 999b2cae4e2d0c506fd08a02dad104c7e66f50f863fd9f5a58fa600e4fa2d0409ad81d88819905541423b68fccb9d80589a03dafc75c6c6a510aed2966f164fb
+  metadata.gz: 163db944110832cefb97406ebc7c4c98b231fdf98d9cce25abe164469eb64d9930d5aa1689c53426605dd11e42cbb721e314430a7b1ec1b7acc37449a676f702
+  data.tar.gz: b1c4052e437c7ebe723615e4b3316f1ac5d538aa2008b87957aca8762cd04bf61aed0f930aac42256aa07340d1c05652611fdcd47cad2f4b2e9d870393999e18

data/README.md

@@ -4,7 +4,9 @@
 <!-- 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
+Lightweight Resource-Based Presence Solution with CableReady.
+
+`Cubism` provides real-time updates of who is viewing or interacting with whatever resources you need. Whether you want Slack's "X is typing..." indicator or an e-commerce "5 other customers are viewing this item" notice, `Cubism` gives you everything you need "under the hood" so that you can focus on what really matters—end-user functionality.
 
 ## Table of Contents
 
@@ -12,6 +14,7 @@ Lightweight Resource-Based Presence Solution with CableReady
 - [Usage](#usage)
 - [Installation](#installation)
 - [API](#api)
+- [Limitations](#limitations)
 - [Gotchas](#gotchas)
 - [Contributing](#contributing)
 - [License](#license)
@@ -54,6 +57,8 @@ Using the `cubicle_for` helper, you can set up a presence indicator. It will
 <% end %>
 ```
 
+**Important!** due to technical limitations the cubism block does _not_ act as a closure, i.e. it has _only_ access to the `users` variable passed to it - think of it more as a self-contained component.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -91,12 +96,17 @@ 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.
+- `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.
 - `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.
 
+## Limitations
+
+### Supported Template Handlers
+- ERB
+
 ## Gotchas
 
 ### Usage with ViewComponent

data/app/helpers/cubism_helper.rb

@@ -2,17 +2,34 @@ 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}"
-    digested_id = ActiveSupport::Digest.hexdigest(key)
+    filename, lineno = block.source_location
+    block_location = block.source_location.join(":")
+    resource_user_key = "#{resource.to_gid}:#{user.to_gid}"
+    digested_block_key = ActiveSupport::Digest.hexdigest("#{block_location}:#{resource_user_key}")
+
+    # the store item (identified by block location, resource, and user) might already be present
+    store_item = Cubism.store[digested_block_key] || Cubism::BlockStoreItem.new(
+      block_location: block_location,
+      resource_gid: resource.to_gid.to_s,
+      user_gid: user.to_gid.to_s
+    )
+
+    if Cubism.store[digested_block_key]&.block_source.blank? && !block_location.start_with?("inline template")
+      lines = File.readlines(filename)[lineno - 1..]
+
+      preprocessor = Cubism::Preprocessor.new(source: lines.join.squish, view_context: self)
+      store_item.block_source = preprocessor.process
+    end
+
+    Cubism.store[digested_block_key] = store_item
 
-    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": Array(appear_trigger).join(","),
       "disappear-trigger": disappear_trigger,
       "trigger-root": trigger_root,
-      id: "cubicle-#{digested_id}",
+      id: "cubicle-#{digested_block_key}",
       "exclude-current-user": exclude_current_user,
       **html_options
     )

data/app/helpers/cubism_helper.rb~

@@ -0,0 +1,34 @@
+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)
+    filename, lineno = block.source_location
+    block_location = block.source_location.join(":")
+    resource_user_key = "#{resource.to_gid}:#{user.to_gid}"
+    digested_block_key = ActiveSupport::Digest.hexdigest("#{block_location}:#{resource_user_key}")
+
+    Cubism.store[digested_block_key] = Cubism::BlockStoreItem.new(
+      block_location: block_location,
+      resource_gid: resource.to_gid.to_s,
+      user_gid: user.to_gid.to_s
+    )
+
+    if Cubism.store[block_location].blank? && !block_location.start_with?("inline template")
+      lines = File.readlines(filename)[lineno - 1..]
+
+      preprocessor = Cubism::Preprocessor.new(source: lines.join.squish, view_context: self)
+      Cubism.store[block_location] = preprocessor.process
+    end
+
+    tag.cubicle_element(
+      identifier: signed_stream_identifier(resource.to_gid.to_s),
+      user: user.to_sgid.to_s,
+      "appear-trigger": Array(appear_trigger).join(","),
+      "disappear-trigger": disappear_trigger,
+      "trigger-root": trigger_root,
+      id: "cubicle-#{digested_block_key}",
+      "exclude-current-user": exclude_current_user,
+      **html_options
+    )
+  end
+end

data/lib/cubism/broadcaster.rb

@@ -14,9 +14,11 @@ module Cubism
     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(resource.present_users_for_element_id(element_id), &block)
+        store_item = Cubism.store[block_key]
+
+        next if store_item.blank?
+
+        html = ApplicationController.render(inline: store_item.block_source, locals: {users: resource.present_users_for_element_id(element_id)})
 
         cable_ready[element_id].inner_html(
           selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",

data/lib/cubism/broadcaster.rb~

@@ -1,9 +1,11 @@
 require "cable_ready"
+require "parser/current"
 
 module Cubism
   class Broadcaster
     include CableReady::Broadcaster
     include CableReady::StreamIdentifier
+    include ActionView::Helpers
 
     attr_reader :resource
 
@@ -14,24 +16,35 @@ module Cubism
     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)
+        block_store_item = Cubism.store[block_key]
+
+        next if block_store_item.blank?
+
+        block_source = Cubism.store[block_store_item.block_location]
+        erubi = ActionView::Template::Handlers::ERB::Erubi.new(block_source)
+        ast = Parser::CurrentRuby.parse erubi.src
+
+        # html = ApplicationController.render(inline: block_source, locals: {current_user: block_store_item.user, "@project": block_store_item.resource, users: resource.present_users_for_element_id(element_id)})
+
+        # binding.pry
+
+        # context = ActionView::Base.with_view_paths(ActionController::Base.view_paths)
+        # erubi = ActionView::Template::Handlers::ERB::Erubi.new(File.read(filename), filename: filename)
+        # context = ApplicationController.new.view_context
+
+        # filename, lineno = block_store_item.block_location.split
+
+        # binding.pry
+
+        # block = Cubism.store[block_key].block
+        # view_context = Cubism.store[block_key].context
+        # html = view_context.capture(resource.present_users_for_element_id(element_id), &block)
 
         cable_ready[element_id].inner_html(
           selector: "cubicle-element##{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
-          html: html
+          html: "#{resource.present_users_for_element_id(element_id).map(&:id)}" 
         ).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/cubicle_block_store.rb

@@ -1,29 +1,32 @@
 module Cubism
   class CubicleBlockStore
-    include Singleton
-
     delegate_missing_to :@blocks
 
     def initialize
-      @blocks = {}
+      @blocks = Kredis.hash "cubism-blocks"
     end
 
     def [](key)
-      @blocks[key]
+      Marshal.load(@blocks[key]) if @blocks[key]
     end
 
     def []=(key, value)
       mutex.synchronize do
-        @blocks[key] = value
+        @blocks[key] = Marshal.dump value
       end
     end
 
     def clear
       mutex.synchronize do
-        @blocks.clear
+        # kredis #remove
+        @blocks.remove
       end
     end
 
+    def size
+      @blocks.to_h.size
+    end
+
     private
 
     def mutex
@@ -31,5 +34,23 @@ module Cubism
     end
   end
 
-  BlockStoreItem = Struct.new(:context, :block, keyword_init: true)
+  BlockStoreItem = Struct.new(:block_location, :block_source, :user_gid, :resource_gid, keyword_init: true) do
+    def user
+      GlobalID::Locator.locate self[:user_gid]
+    end
+
+    def resource
+      GlobalID::Locator.locate self[:resource_gid]
+    end
+
+    def marshal_dump
+      to_h
+    end
+
+    def marshal_load(serialized_item)
+      %i[block_location block_source user_gid resource_gid].each do |arg|
+        send("#{arg}=", serialized_item[arg])
+      end
+    end
+  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
@@ -23,5 +31,13 @@ module Cubism
     end
   end
 
-  BlockStoreItem = Struct.new(:context, :block, keyword_init: true)
+  BlockStoreItem = Struct.new(:block_location, :user_gid, :resource_gid, keyword_init: true) do
+    def user
+      GlobalID::Locator.locate self[:user_gid]
+    end
+
+    def resource
+      GlobalID::Locator.locate self[:resource_gid]
+    end
+  end
 end

data/lib/cubism/engine.rb

@@ -1,4 +1,7 @@
 module Cubism
   class Engine < ::Rails::Engine
+    initializer "cubism.store" do
+      Cubism.store = Cubism::CubicleBlockStore.new
+    end
   end
 end

data/lib/cubism/engine.rb~

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

data/lib/cubism/preprocessor.rb

@@ -0,0 +1,30 @@
+module Cubism
+  class Preprocessor
+    def initialize(source:, view_context:)
+      match_data = /<%=\s+cubicle_for.+\|.+\|\s+%>/.match(source)
+      start_pos = match_data&.end(0) || 0
+      @source = source[start_pos..]
+      @view_context = view_context
+    end
+
+    def process
+      begin
+        do_parse
+      rescue NameError
+        # we ignore any name errors from unset instance variables or local assigns here
+      end
+
+      @source
+    end
+
+    private
+
+    def do_parse
+      ActionView::Template::Handlers::ERB::Erubi.new(@source).evaluate(@view_context)
+    rescue SyntaxError
+      end_at_end = /(<%\s+end\s+%>)\z/.match(@source)
+      @source = end_at_end ? @source[..-(end_at_end[0].length + 1)] : @source[..-2]
+      do_parse
+    end
+  end
+end

data/lib/cubism/preprocessor.rb~

@@ -0,0 +1,26 @@
+module Cubism
+  class Preprocessor
+    def initialize(source:, view_context:)
+      start_pos = /<%= cubicle_for/ =~ source
+      @source = source[start_pos..]
+      @view_context = view_context
+    end
+
+    def process
+      begin
+        do_parse
+      rescue NameError
+        # we ignore any name errors from unset instance variables or local assigns here
+      end
+
+      @source
+    end
+
+    def do_parse
+      ActionView::Template::Handlers::ERB::Erubi.new(@source).evaluate(@view_context)
+    rescue SyntaxError
+      @source = @source[..-2]
+      do_parse
+    end
+  end
+end

data/lib/cubism/version.rb

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

data/lib/cubism/version.rb~

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

data/lib/cubism.rb

@@ -4,13 +4,15 @@ require "cubism/version"
 require "cubism/engine"
 require "cubism/broadcaster"
 require "cubism/cubicle_block_store"
+require "cubism/preprocessor"
 
 module Cubism
   extend ActiveSupport::Autoload
 
   autoload :Broadcaster, "cubism/broadcaster"
+  autoload :Preprocessor, "cubism/preprocessor"
 
   mattr_accessor :user_class, instance_writer: false, instance_reader: false
 
-  mattr_reader :store, instance_reader: false, default: Cubism::CubicleBlockStore.instance
+  mattr_accessor :store, instance_reader: false
 end

data/lib/cubism.rb~

@@ -4,11 +4,13 @@ require "cubism/version"
 require "cubism/engine"
 require "cubism/broadcaster"
 require "cubism/cubicle_block_store"
+require "cubism/preprocessor"
 
 module Cubism
   extend ActiveSupport::Autoload
 
   autoload :Broadcaster, "cubism/broadcaster"
+  autoload :Preprocessor, "cubism/preprocessor"
 
   mattr_accessor :user_class, instance_writer: false, instance_reader: false
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubism
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre9
+  version: 0.1.0.pre10
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -135,6 +135,7 @@ files:
 - 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/presence.rb
 - app/models/concerns/cubism/presence.rb~
 - app/models/concerns/cubism/user.rb
@@ -147,6 +148,10 @@ files:
 - lib/cubism/cubicle_block_store.rb
 - lib/cubism/cubicle_block_store.rb~
 - lib/cubism/engine.rb
+- lib/cubism/engine.rb~
+- lib/cubism/parser.rb~
+- lib/cubism/preprocessor.rb
+- lib/cubism/preprocessor.rb~
 - lib/cubism/version.rb
 - lib/cubism/version.rb~
 - lib/tasks/cubism_tasks.rake