cubism 0.2.0 → 0.2.2

data/README.md~

@@ -71,10 +71,27 @@ And then execute:
 $ bundle
 ```
 
-After `bundle`, install the Javascript library:
+There are a few ways to install the Cubism JavaScript client, depending on your application setup.
 
-```bash
-$ bin/yarn add @minthesize/cubism
+#### ESBuild / Webpacker
+
+```sh
+yarn add @minthesize/cubism
+```
+
+#### Import maps:
+
+```ruby
+# config/importmap.rb
+# ...
+pin '@minthesize/cubism', to: 'cubism.min.js', preload: true
+```
+
+#### Rails Asset pipeline (Sprockets):
+
+```html+erb
+<!-- app/views/layouts/application.html.erb -->
+<%= javascript_include_tag "cubism.umd.min.js", "data-turbo-track": "reload" %>
 ```
 
 ### Kredis
@@ -146,7 +163,7 @@ yarn link # set the local machine's cubism npm package's lookup to this local pa
 
 # Setup a sample project and edit Gemfile to point to local gem
 # (e.g. `gem "cubism", path: "../cubism"`)
-# yarn link @stimulus_reflex/cubism
+# yarn link @minthesize/cubism
 
 
 # Do your work, Submit PR, Profit!
@@ -163,14 +180,17 @@ cd path/to/project
 yarn install --force
 ```
 
-### Release
-
-1. Update the version numbers in `javascript/package.json` and `lib/cubism/version.rb`
-2. `git commit -m "Bump version to x.x.x"`
-3. Run `bundle exec rake build`
-4. Run `bundle exec rake release`
-5. Run `npm publish --access public`
-
+### 📦 Releasing
+
+1. Make sure that you run `yarn` and `bundle` to pick up the latest.
+2. Bump version number at `lib/cubism/version.rb`. Pre-release versions use `.preN`
+3. Run `rake build` and `yarn build`
+4. Commit and push changes to github `git commit -m "Bump version to x.x.x"`
+5. Run `rake release`
+6. Run `yarn publish --no-git-tag-version`
+7. Yarn will prompt you for the new version. Pre-release versions use `-preN`
+8. Commit and push changes to GitHub
+9. Create a new release on GitHub ([here](https://github.com/julianrubisch/cubism/releases)) and generate the changelog for the stable release for it
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/Rakefile

@@ -3,8 +3,6 @@ require "bundler/setup"
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
-load "rails/tasks/statistics.rake"
-
 require "bundler/gem_tasks"
 
 require "rake/testtask"

data/app/channels/cubism/presence_channel.rb

@@ -2,6 +2,8 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   include CableReady::StreamIdentifier
 
   def subscribed
+    return if Cubism.skip_in_test? && Rails.env.test?
+
     if resource.present?
       stream_from element_id
       resource.cubicle_element_ids << element_id
@@ -12,6 +14,8 @@ class Cubism::PresenceChannel < ActionCable::Channel::Base
   end
 
   def unsubscribed
+    return if Cubism.skip_in_test? && Rails.env.test?
+
     return unless resource.present?
 
     resource.cubicle_element_ids.remove(element_id)

data/app/helpers/cubism_helper.rb

@@ -2,11 +2,22 @@ module CubismHelper
   include CableReady::StreamIdentifier
 
   def cubicle_for(resource, user, scope: "", html_options: {}, appear_trigger: :connect, disappear_trigger: nil, trigger_root: nil, exclude_current_user: true, &block)
+    return if Cubism.skip_in_test? && Rails.env.test?
+
     block_location = block.source_location.join(":")
     block_source = Cubism::BlockSource.find_or_create(
       location: block_location,
       view_context: self
     )
+    if block_source.variable_name.blank?
+      block_variable_name = block.parameters.find { |type, _| [:req, :opt, :rest].include?(type) }&.last
+      if block_variable_name.present?
+        block_source.variable_name = block_variable_name.to_s
+        # Never write back a sourceless block source: it would replace a good
+        # store entry with one the broadcaster cannot render.
+        Cubism.source_store[block_source.digest] = block_source if block_source.source.present?
+      end
+    end
 
     resource_gid = resource.to_gid.to_s
 

data/cubism.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Lightweight Resource-Based Presence Solution with CableReady"
   spec.description = "Lightweight Resource-Based Presence Solution with CableReady"
   spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/julianrubisch/cubism.git"
@@ -22,15 +23,14 @@ Gem::Specification.new do |spec|
     "[A-Z]*"
   ]
 
-  spec.test_files = Dir["test/**/*.rb"]
-
-  spec.add_dependency "rails", ">= 6.0"
+  spec.add_dependency "rails", ">= 7.2"
   spec.add_dependency "kredis", ">= 0.4"
   spec.add_dependency "cable_ready", ">= 5.0.0"
+  spec.add_dependency "observer"
 
-  spec.add_development_dependency "standard"
+  spec.add_development_dependency "standard", ">= 1.35.1"
   spec.add_development_dependency "nokogiri"
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sqlite3", ">= 2.1"
 end

data/lib/cubism/broadcaster.rb

@@ -21,6 +21,12 @@ module Cubism
 
         block_source = block_container.block_source
 
+        # Blocks declared inside an inline template are never parsed, and the
+        # source store can be evicted independently of the block store. Without
+        # a source there is nothing to render, and `inline: nil` would raise
+        # deep inside ActionView (`nil.to_s` is frozen).
+        next if block_source.nil? || block_source.source.blank?
+
         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)}']"

data/lib/cubism/cubicle_store.rb

@@ -99,9 +99,16 @@ module Cubism
   ) do
     def self.find_or_create(location:, view_context:)
       instance = new(location: location, view_context: view_context)
-
-      Cubism.source_store.fetch(instance.digest, instance) do |instance|
+      stored = Cubism.source_store[instance.digest]
+
+      # A stored entry without a source is unusable downstream (the broadcaster
+      # would hand `inline: nil` to ActionView), so treat it as a miss and reparse.
+      if stored&.source.present?
+        instance.source = stored.source
+        instance.variable_name = stored.variable_name
+      else
         instance.parse!
+        Cubism.source_store[instance.digest] = instance
       end
 
       instance

data/lib/cubism/preprocessor.rb

@@ -36,7 +36,10 @@ module Cubism
     def evaluate_view(erubi, view_context)
       view = Class.new(ActionView::Base) {
         include view_context._routes.url_helpers
-        class_eval("define_method(:_template) { |local_assigns, output_buffer| #{erubi.src} }", erubi.filename.nil? ? "(erubi)" : erubi.filename, 0)
+
+        # Deliberately not __FILE__/__LINE__: the eval'd source is the user's
+        # template, so backtraces have to point there and not at this file.
+        class_eval("define_method(:_template) { |local_assigns, output_buffer| #{erubi.src} }", erubi.filename.nil? ? "(erubi)" : erubi.filename, 0) # standard:disable Style/EvalWithLocation
       }.empty
       view._run(:_template, nil, {}, ActionView::OutputBuffer.new)
     end

data/lib/cubism/version.rb

@@ -1,3 +1,3 @@
 module Cubism
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/cubism.rb

@@ -16,4 +16,10 @@ module Cubism
 
   mattr_accessor :block_store, instance_reader: false
   mattr_accessor :source_store, instance_reader: false
+
+  mattr_accessor :skip_in_test, default: false
+
+  def self.skip_in_test?
+    skip_in_test.present?
+  end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minthesize/cubism",
-  "version": "0.1.1",
+  "version": "0.2.2",
   "description": "Lightweight Resource-Based Presence Solution with CableReady.",
   "main": "./dist/cubism.umd.min.js",
   "module": "./dist/cubism.min.js",

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cubism
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Julian Rubisch
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: kredis
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +52,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: observer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.35.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +127,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 description: Lightweight Resource-Based Presence Solution with CableReady
 email:
 - julian@julianrubisch.at
@@ -166,50 +179,6 @@ files:
 - package.json~
 - rollup.config.js
 - rollup.config.js~
-- test/block_container_test.rb
-- test/block_source_test.rb
-- test/broadcaster_test.rb
-- test/channels/cubism/presence_channel_test.rb
-- test/cubicle_store_test.rb
-- test/cubism_test.rb
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/post.rb
-- test/dummy/app/models/user.rb
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/permissions_policy.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20220102072929_create_posts.rb
-- test/dummy/db/migrate/20220102073003_create_users.rb
-- test/dummy/db/schema.rb
-- test/dummy/test/models/post_test.rb
-- test/dummy/test/models/user_test.rb
-- test/helpers/cubism_helper_test.rb
-- test/integration/navigation_test.rb
-- test/models/concerns/presence_test.rb
-- test/models/concerns/user_test.rb
-- test/rendering/preprocessor_test.rb
-- test/test_helper.rb
 - yarn.lock
 homepage: https://github.com/julianrubisch/cubism
 licenses:
@@ -217,7 +186,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/julianrubisch/cubism
   source_code_uri: https://github.com/julianrubisch/cubism.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,59 +193,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Lightweight Resource-Based Presence Solution with CableReady
-test_files:
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/post.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/test/models/post_test.rb
-- test/dummy/test/models/user_test.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/application.rb
-- test/dummy/config/puma.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/permissions_policy.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20220102072929_create_posts.rb
-- test/dummy/db/migrate/20220102073003_create_users.rb
-- test/integration/navigation_test.rb
-- test/broadcaster_test.rb
-- test/cubicle_store_test.rb
-- test/models/concerns/presence_test.rb
-- test/models/concerns/user_test.rb
-- test/block_container_test.rb
-- test/cubism_test.rb
-- test/rendering/preprocessor_test.rb
-- test/test_helper.rb
-- test/helpers/cubism_helper_test.rb
-- test/block_source_test.rb
-- test/channels/cubism/presence_channel_test.rb
+test_files: []

data/test/block_container_test.rb

@@ -1,105 +0,0 @@
-require "test_helper"
-
-class BlockContainerTest < ActiveSupport::TestCase
-  FIXTURES_DIR = File.expand_path("./fixtures", __dir__)
-
-  setup do
-    @cwd = Dir.pwd
-    @tmp_dir = Dir.mktmpdir
-
-    FileUtils.cp_r FIXTURES_DIR, @tmp_dir
-    Dir.chdir @tmp_dir
-
-    @post = posts(:one)
-    @user = users(:one)
-  end
-
-  teardown do
-    Dir.chdir @cwd
-    FileUtils.rm_r @tmp_dir
-  end
-
-  test "block container digest changes when file contents change" do
-    template = "fixtures/_cubicle_partial"
-
-    digest1 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:1",
-      resource_gid: @post.to_gid.to_s,
-      user_gid: @user.to_gid.to_s
-    ).digest
-
-    change_template(template)
-
-    digest2 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:1",
-      resource_gid: @post.to_gid.to_s,
-      user_gid: @user.to_gid.to_s
-    ).digest
-
-    refute_equal digest1, digest2
-  end
-
-  test "block container digest changes when user changes" do
-    template = "fixtures/_cubicle_partial"
-
-    digest1 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:1",
-      resource_gid: @post.to_gid.to_s,
-      user_gid: @user.to_gid.to_s
-    ).digest
-
-    digest2 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:1",
-      resource_gid: @post.to_gid.to_s,
-      user_gid: users(:two).to_gid.to_s
-    ).digest
-
-    refute_equal digest1, digest2
-  end
-
-  test "block container digest changes when resource changes" do
-    template = "fixtures/_cubicle_partial"
-
-    digest1 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:1",
-      resource_gid: @post.to_gid.to_s,
-      user_gid: @user.to_gid.to_s
-    ).digest
-
-    digest2 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:1",
-      resource_gid: posts(:two).to_gid.to_s,
-      user_gid: @user.to_gid.to_s
-    ).digest
-
-    refute_equal digest1, digest2
-  end
-
-  test "block container digest changes when block_location changes" do
-    template = "fixtures/_cubicle_partial"
-
-    digest1 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:1",
-      resource_gid: @post.to_gid.to_s,
-      user_gid: @user.to_gid.to_s
-    ).digest
-
-    digest2 = Cubism::BlockContainer.new(
-      block_location: "#{template_tmp_path(template)}.html.erb:2",
-      resource_gid: @post.to_gid.to_s,
-      user_gid: @user.to_gid.to_s
-    ).digest
-
-    refute_equal digest1, digest2
-  end
-
-  private
-
-  def template_tmp_path(template)
-    Pathname.new(@tmp_dir).join(template).to_path
-  end
-
-  def change_template(template)
-    File.write("#{template}.html.erb", "\nTHIS WAS CHANGED!")
-  end
-end

data/test/block_source_test.rb

@@ -1,102 +0,0 @@
-require "test_helper"
-
-class BlockSourceTest < ActionView::TestCase
-  FIXTURES_DIR = File.expand_path("./fixtures", __dir__)
-
-  setup do
-    @cwd = Dir.pwd
-    @tmp_dir = Dir.mktmpdir
-
-    FileUtils.cp_r FIXTURES_DIR, @tmp_dir
-    Dir.chdir @tmp_dir
-
-    @post = posts(:one)
-    @user = users(:one)
-  end
-
-  teardown do
-    Dir.chdir @cwd
-    FileUtils.rm_r @tmp_dir
-  end
-
-  test "block source digest changes when file contents change" do
-    template = "fixtures/_cubicle_partial"
-
-    digest1 = Cubism::BlockSource.new(
-      location: "#{template_tmp_path(template)}.html.erb:1",
-      view_context: self
-    ).digest
-
-    change_template(template)
-
-    digest2 = Cubism::BlockSource.new(
-      location: "#{template_tmp_path(template)}.html.erb:1",
-      view_context: self
-    ).digest
-
-    refute_equal digest1, digest2
-  end
-
-  test "block source digest changes when block_location changes" do
-    template = "fixtures/_cubicle_partial"
-
-    digest1 = Cubism::BlockSource.new(
-      location: "#{template_tmp_path(template)}.html.erb:1",
-      view_context: self
-    ).digest
-
-    digest2 = Cubism::BlockSource.new(
-      location: "#{template_tmp_path(template)}.html.erb:2",
-      view_context: self
-    ).digest
-
-    refute_equal digest1, digest2
-  end
-
-  test "can be created in the store by source location" do
-    template = "fixtures/_cubicle_partial"
-
-    assert_equal 0, Cubism.source_store.size
-
-    Cubism::BlockSource.any_instance.expects(:parse!).once
-
-    Cubism::BlockSource.find_or_create(
-      location: "#{template_tmp_path(template)}.html.erb:1",
-      view_context: self
-    )
-
-    assert_equal 1, Cubism.source_store.size
-  end
-
-  test "existing block source is returned and not parsed" do
-    template = "fixtures/_cubicle_partial"
-
-    instance = Cubism::BlockSource.new(
-      location: "#{template_tmp_path(template)}.html.erb:1",
-      view_context: self
-    )
-
-    Cubism.source_store[instance.digest] = instance
-
-    assert_equal 1, Cubism.source_store.size
-
-    Cubism::BlockSource.any_instance.expects(:parse!).never
-
-    Cubism::BlockSource.find_or_create(
-      location: "#{template_tmp_path(template)}.html.erb:1",
-      view_context: self
-    )
-
-    assert_equal 1, Cubism.source_store.size
-  end
-
-  private
-
-  def template_tmp_path(template)
-    Pathname.new(@tmp_dir).join(template).to_path
-  end
-
-  def change_template(template)
-    File.write("#{template}.html.erb", "\nTHIS WAS CHANGED!")
-  end
-end