cubism 0.1.0.pre10 → 0.1.0.pre13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976cb8cfb5c2fe6edb6dd6e541c74361ae17dd12ce717bafadcb6ff6bdd1b9f1
-  data.tar.gz: a3e777efd1df0423ab4754ed30fe119b6497197ec2bc8ee564304385b907849d
+  metadata.gz: 4377fa1fd3645236a271528fa11475f4d13ab813c33bb7a4b1378581ca19f116
+  data.tar.gz: bb12db749b157287aa6898c234067b64bb30978ec221a67b64ea0c6f9db9c411
 SHA512:
-  metadata.gz: 163db944110832cefb97406ebc7c4c98b231fdf98d9cce25abe164469eb64d9930d5aa1689c53426605dd11e42cbb721e314430a7b1ec1b7acc37449a676f702
-  data.tar.gz: b1c4052e437c7ebe723615e4b3316f1ac5d538aa2008b87957aca8762cd04bf61aed0f930aac42256aa07340d1c05652611fdcd47cad2f4b2e9d870393999e18
+  metadata.gz: 6feee965fa20725ec7018af0371294707390d2649f554486fd8e91d9ee087cfb7a44e82ca653a660fb7fdb14e3a517aba3929ab11790686e54e89de00c92a67c
+  data.tar.gz: 7cc6318fb9cc6cdad4c1ce42d6a898b6819cc5184e11e3a0ed782976fcd33cacd9692c5e08ca64e7f7e25454065dba002be4d1a1118af1cfe47c6246df939d02

data/Appraisals

@@ -0,0 +1,16 @@
+if RUBY_VERSION >= "2.7"
+  appraise "rails-7-0" do
+    gem "rails", "7.0.1"
+    gem "sqlite3", "~> 1.4"
+  end
+end
+
+appraise "rails-6-1" do
+  gem "rails", "~> 6.1"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise "rails-6-0" do
+  gem "rails", "~> 6.0"
+  gem "sqlite3", "~> 1.4"
+end

data/Appraisals~

@@ -0,0 +1,16 @@
+if RUBY_VERSION >= "2.7"
+  appraise "rails-7-0" do
+    gem "rails", "7.0.0"
+    gem "sqlite3", "~> 1.4"
+  end
+end
+
+appraise "rails-6-1" do
+  gem "rails", "~> 6.1"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise "rails-6-0" do
+  gem "rails", "~> 6.0"
+  gem "sqlite3", "~> 1.4"
+end

data/CHANGELOG.md

@@ -0,0 +1,87 @@
+# Changelog
+
+## [v0.1.0.pre12](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre12) (2022-03-01)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre11...v0.1.0.pre12)
+
+**Closed issues:**
+
+- Scope leads to element not found errors [\#12](https://github.com/julianrubisch/cubism/issues/12)
+- Add IntersectionObserver as appear trigger [\#9](https://github.com/julianrubisch/cubism/issues/9)
+
+**Merged pull requests:**
+
+- Intersect appear trigger [\#14](https://github.com/julianrubisch/cubism/pull/14) ([julianrubisch](https://github.com/julianrubisch))
+- Fix scoping [\#13](https://github.com/julianrubisch/cubism/pull/13) ([julianrubisch](https://github.com/julianrubisch))
+- Scope elements [\#11](https://github.com/julianrubisch/cubism/pull/11) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v0.1.0.pre11](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre11) (2022-02-16)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre10...v0.1.0.pre11)
+
+**Closed issues:**
+
+- Async DOM mutations [\#7](https://github.com/julianrubisch/cubism/issues/7)
+
+**Merged pull requests:**
+
+- Async dom mutations [\#10](https://github.com/julianrubisch/cubism/pull/10) ([julianrubisch](https://github.com/julianrubisch))
+- Reuse block source [\#8](https://github.com/julianrubisch/cubism/pull/8) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v0.1.0.pre10](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre10) (2022-01-24)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre9...v0.1.0.pre10)
+
+**Merged pull requests:**
+
+- Multi worker setup [\#6](https://github.com/julianrubisch/cubism/pull/6) ([julianrubisch](https://github.com/julianrubisch))
+- Add value proposition to README [\#5](https://github.com/julianrubisch/cubism/pull/5) ([fractaledmind](https://github.com/fractaledmind))
+
+## [v0.1.0.pre9](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre9) (2022-01-09)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre8...v0.1.0.pre9)
+
+## [v0.1.0.pre8](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre8) (2021-12-22)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre7...v0.1.0.pre8)
+
+## [v0.1.0.pre7](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre7) (2021-12-22)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre6...v0.1.0.pre7)
+
+## [v0.1.0.pre6](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre6) (2021-12-20)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre5...v0.1.0.pre6)
+
+**Closed issues:**
+
+- Register a channel for every identifier instead of filtering operations on the client [\#4](https://github.com/julianrubisch/cubism/issues/4)
+
+## [v0.1.0.pre5](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre5) (2021-12-16)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre4...v0.1.0.pre5)
+
+## [v0.1.0.pre4](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre4) (2021-12-15)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre3...v0.1.0.pre4)
+
+**Merged pull requests:**
+
+- docs: add julianrubisch as a contributor for code [\#3](https://github.com/julianrubisch/cubism/pull/3) ([allcontributors[bot]](https://github.com/apps/allcontributors))
+- Block store [\#2](https://github.com/julianrubisch/cubism/pull/2) ([julianrubisch](https://github.com/julianrubisch))
+
+## [v0.1.0.pre3](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre3) (2021-10-15)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre2...v0.1.0.pre3)
+
+## [v0.1.0.pre2](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre2) (2021-10-15)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/v0.1.0.pre1...v0.1.0.pre2)
+
+## [v0.1.0.pre1](https://github.com/julianrubisch/cubism/tree/v0.1.0.pre1) (2021-10-14)
+
+[Full Changelog](https://github.com/julianrubisch/cubism/compare/8904f2c6d1eb5afe35e52bf773cbc9225d086e02...v0.1.0.pre1)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in cubism.gemspec.
+gemspec
+
+gem "pry", group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,220 @@
+PATH
+  remote: .
+  specs:
+    cubism (0.1.0.pre13)
+      cable_ready (= 5.0.0.pre9)
+      kredis (>= 0.4)
+      rails (>= 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activestorage (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    cable_ready (5.0.0.pre9)
+      actioncable (>= 5.2)
+      actionpack (>= 5.2)
+      actionview (>= 5.2)
+      activerecord (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      thread-local (>= 1.1.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    digest (3.1.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    kredis (1.1.0)
+      activesupport (>= 6.0.0)
+      redis (~> 4.2)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.7.1)
+    minitest (5.15.0)
+    mocha (1.13.0)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.0)
+      mini_portile2 (~> 2.7.0)
+      racc (~> 1.4)
+    nokogiri (1.13.0-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (7.0.2.3)
+      actioncable (= 7.0.2.3)
+      actionmailbox (= 7.0.2.3)
+      actionmailer (= 7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actiontext (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.2.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    redis (4.6.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.2)
+    standard (1.5.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+    strscan (3.0.1)
+    thor (1.2.1)
+    thread-local (1.1.0)
+    timeout (0.2.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+
+DEPENDENCIES
+  appraisal
+  cubism!
+  mocha
+  nokogiri
+  pry
+  sqlite3
+  standard
+
+BUNDLED WITH
+   2.3.3

data/Gemfile~

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in cubism.gemspec.
+gemspec
+
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+
+gem "pry", group: [:development, :test]

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
@@ -96,9 +113,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.
 
@@ -145,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!
@@ -162,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/README.md~

@@ -0,0 +1,191 @@
+# 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.
+
+`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
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Installation](#installation)
+- [API](#api)
+- [Limitations](#limitations)
+- [Gotchas](#gotchas)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contributors](#contributors)
+
+## Usage
+
+### Prepare your User Model
+In your app's `User` model, include `Cubism::User`:
+
+```rb
+class User < ApplicationRecord
+  include Cubism::User
+
+  # ...
+end
+```
+
+### Track Present Users in your Models
+In the models you'd like to track presence for, include the `Cubism::Presence` concern:
+
+```rb
+class Project < ApplicationRecord
+  include Cubism::Presence
+
+  # ...
+end
+```
+
+### Set Up the Cubicle Template
+
+Using the `cubicle_for` helper, you can set up a presence indicator. It will
+
+1. subscribe to the respective resource, and
+2. render a block which is passed the list of present `users`:
+
+```erb
+<%= cubicle_for @project, current_user do |users| %>
+  <%= users.map(&:username).join(", ")
+<% 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:
+
+```ruby
+gem 'cubism'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+After `bundle`, install the Javascript library:
+
+```bash
+$ bin/yarn add @minthesize/cubism
+```
+
+### Kredis
+
+This gem uses [kredis](https://github.com/rails/kredis) under the hood, so be sure to follow their [installation instructions](https://github.com/rails/kredis#installation). In other words, provide a Redis instance and configure it in `config/redis/shared.yml`.
+
+### Javascript
+
+In your app's Javascript entrypoint (e.g. `app/javascript/packs/application.js`) import and initialize `CableReady` (cubism will make use of the injected ActionCable consumer):
+
+```js
+import CableReady from "cable_ready";
+import "@minthesize/cubism";
+
+CableReady.initialize({ consumer });
+```
+
+## API
+
+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. 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.
+
+## Limitations
+
+### Supported Template Handlers
+- ERB
+
+## 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
+
+### Get local environment setup
+
+Below are a set of instructions that may help you get a local development environment working
+
+```sh
+# Get the gem/npm package source locally
+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
+
+# Setup a sample project and edit Gemfile to point to local gem
+# (e.g. `gem "cubism", path: "../cubism"`)
+# yarn link @stimulus_reflex/cubism
+
+
+# Do your work, Submit PR, Profit!
+
+
+# To stop using your local version of cubism
+# change your Gemfile back to the published (e.g. `gem "cubism"`)
+cd path/to/cubism/javascript
+# Stop using the local npm package
+yarn unlink
+
+# Instruct your project to reinstall the published version of the npm package
+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`
+
+## 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 -->