cubism 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe95381d8e51d520357a7fa08fe84d8107739b039b1f2f11846decb30b63afae
+  data.tar.gz: 2a4cfb19b44eb395be36c9fafd340c967d51b91690b4ebfbf11321f23a6162e8
+SHA512:
+  metadata.gz: 335f728fbe45554a741baee7cd4e717e5b4807cdc1ee7506fac3f9273e6f0f69f416192c7b7fe69ba6202a4de573be342b19b9d60a132372c58cdb33a8af75a6
+  data.tar.gz: b3e49b66ffa6f6348365436be31714953ef56f95187a5db49cc5afdc71ab4b8f6d28d08423a02fa9ee3e351d539d4f7b5a1420c170aafba20b507d403f0232b8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Julian Rubisch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# Cubism
+[![Twitter follow](https://img.shields.io/twitter/follow/julian_rubisch?style=social)](https://twitter.com/julian_rubisch)
+
+Lightweight Resource-Based Presence Solution with CableReady
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Installation](#installation)
+- [Manual Installation](#manual-installation)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contributors](#contributors)
+
+## Usage
+
+### Prepare your User Model
+In your app's `User` model, include `Cubism::User` and set up a safelist of exposed attributes:
+
+```rb
+class User < ApplicationRecord
+  include Cubism::User
+  self.cubicle_attributes = %i[email id]
+
+  # ...
+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. accept a "template" using the attributes safelisted above. Elements marked with `data-cubicle-attribute=` will have their `innerHTML` replaced by Cubism.
+
+```erb
+<%= cubicle_for @project do %>
+  <span class="avatar">
+    <span data-cubicle-attribute="email"></span>
+  </span>
+<% end %>
+```
+
+Note that this template will simply be repeated for every user that's in the `@project`s `present_users` set.
+
+## 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 });
+```
+
+
+## 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 cubism
+cd cubism/javascript
+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. `cd javascript && 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

data/Rakefile

@@ -0,0 +1,18 @@
+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"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

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

@@ -0,0 +1,18 @@
+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/channels/cubism/presence_channel.rb

@@ -0,0 +1,25 @@
+class Cubism::PresenceChannel < ActionCable::Channel::Base
+  include CableReady::StreamIdentifier
+
+  def subscribed
+    if resource.present?
+      stream_for resource
+      resource.present_users.add(current_user.id)
+    else
+      reject
+    end
+  end
+
+  def unsubscribed
+    return unless resource.present?
+
+    resource.present_users.remove(current_user.id)
+  end
+
+  private
+
+  def resource
+    locator = verified_stream_identifier(params[:identifier])
+    GlobalID::Locator.locate(locator)
+  end
+end

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

@@ -0,0 +1,25 @@
+class Cubism::PresenceChannel < ActionCable::Channel::Base
+  include CableReady::StreamIdentifier
+
+  def subscribed
+    if resource.present?
+      stream_for resource
+      resource.present_users.add(current_user.id)
+    else
+      reject
+    end
+  end
+
+  def unsubscribed
+    return unless resource.present?
+
+    resource.present_users.remove(current_user.id)
+  end
+
+  private
+
+  def resource
+    locator = verified_stream_identifier(params[:identifier])
+    GlobalID::Locator.locate(locator)
+  end
+end

data/app/helpers/cubism_helper.rb

@@ -0,0 +1,11 @@
+module CubismHelper
+  include CableReady::StreamIdentifier
+
+  def cubicle_for(resource, html_options: {}, &block)
+    template = capture(&block)
+
+    tag.cubicle_element({identifier: signed_stream_identifier(resource.to_global_id.to_s)}) do
+      content_tag(:template, template, {slot: "template"})
+    end
+  end
+end

data/app/helpers/cubism_helper.rb~

@@ -0,0 +1,8 @@
+module CubismHelper
+  include CableReady::Compoundable
+  include CableReady::StreamIdentifier
+
+  def cubicle_for(*keys, html_options: {})
+    tag.cubicle_element({identifier: signed_stream_identifier(compound(keys))})
+  end
+end

data/app/jobs/cubism/stream_presence_job.rb

@@ -0,0 +1,15 @@
+class Cubism::StreamPresenceJob < ApplicationJob
+  include CableReady::Broadcaster
+  include CableReady::StreamIdentifier
+  queue_as :default
+
+  def perform(resource:)
+    cable_ready[Cubism::PresenceChannel].dispatch_event(
+      name: "cubism:update",
+      selector: "cubicle-element[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
+      detail: {
+        users: Cubism.user_class.find(resource.present_users.members).map { |user| user.slice(user.cubicle_attributes) }.as_json
+      }
+    ).broadcast_to(resource)
+  end
+end

data/app/jobs/cubism/stream_presence_job.rb~

@@ -0,0 +1,11 @@
+class Cubism::StreamPresenceJob < ApplicationJob
+  include CableReady::Broadcaster
+  queue_as :default
+
+  def perform(resource:)
+    cable_ready[Cubism::PresenceChannel].outer_html(
+      selector: dom_id(resource, "cubicle").to_s,
+      html: ApplicationController.render(partial: "shared/presence_indicator", locals: {users: User.where(id: resource.present_users.members)})
+    ).broadcast
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+module Cubism::Presence
+  extend ActiveSupport::Concern
+
+  included do
+    kredis_set :present_users, after_change: :stream_presence_later
+  end
+
+  def stream_presence_later
+    Cubism::StreamPresenceJob.perform_later(resource: self)
+  end
+end

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

@@ -0,0 +1,11 @@
+module Cubism::Presence
+  extend ActiveSupport::Concern
+
+  included do
+    kredis_set :present_users, after_change: :stream_presence_later
+  end
+
+  def stream_presence_later
+    Cubism::StreamPresenceJob.perform_later(resource: self)
+  end
+end

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,13 @@
+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/app/models/cubism/base.rb~

@@ -0,0 +1,3 @@
+class Cubism::Base
+  include Cubism::Presence 
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/cubism/engine.rb

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

data/lib/cubism/engine.rb~

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

data/lib/cubism/railtie.rb~

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

data/lib/cubism/version.rb

@@ -0,0 +1,3 @@
+module Cubism
+  VERSION = "0.1.0.pre1"
+end

data/lib/cubism/version.rb~

@@ -0,0 +1,3 @@
+module Cubism
+  VERSION = "0.1.0"
+end

data/lib/cubism.rb

@@ -0,0 +1,6 @@
+require "cubism/version"
+require "cubism/engine"
+
+module Cubism
+  mattr_accessor :user_class, instance_writer: false, instance_reader: false
+end

data/lib/cubism.rb~

@@ -0,0 +1,6 @@
+require "cubism/version"
+require "cubism/engine"
+
+module Cubism
+  # Your code goes here...
+end

data/lib/tasks/cubism_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cubism do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: cubism
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- Julian Rubisch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-14 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: kredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: cable_ready
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0.pre6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0.pre6
+- !ruby/object:Gem::Dependency
+  name: standard
+  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'
+description: Lightweight Resource-Based Presence Solution with CableReady
+email:
+- julian@julianrubisch.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/jobs/cubism/stream_presence_job.rb
+- app/jobs/cubism/stream_presence_job.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~
+- config/routes.rb
+- lib/cubism.rb
+- lib/cubism.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
+homepage: https://github.com/julianrubisch/cubism
+licenses:
+- MIT
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Lightweight Resource-Based Presence Solution with CableReady
+test_files: []