cubism 0.1.0.pre12 → 0.1.0.pre13

data/rollup.config.js

@@ -0,0 +1,77 @@
+import resolve from '@rollup/plugin-node-resolve'
+import commonjs from '@rollup/plugin-commonjs'
+import json from '@rollup/plugin-json'
+import { terser } from 'rollup-plugin-terser'
+
+const pretty = () => {
+  return terser({
+    mangle: false,
+    compress: false,
+    format: {
+      beautify: true,
+      indent_level: 2
+    }
+  })
+}
+
+const minify = () => {
+  return terser({
+    mangle: true,
+    compress: true
+  })
+}
+
+const esConfig = {
+  format: 'es',
+  inlineDynamicImports: true
+}
+
+const umdConfig = {
+  name: 'Cubism',
+  format: 'umd',
+  exports: 'named',
+  globals: {
+    cable_ready: 'CableReady'
+  }
+}
+
+const distFolders = ['dist/', 'app/assets/javascripts/']
+
+const output = distFolders
+  .map(distFolder => [
+    {
+      ...esConfig,
+      file: `${distFolder}/cubism.js`,
+      plugins: [pretty()]
+    },
+    {
+      ...esConfig,
+      file: `${distFolder}/cubism.min.js`,
+      sourcemap: true,
+      plugins: [minify()]
+    },
+    {
+      ...umdConfig,
+      file: `${distFolder}/cubism.umd.js`,
+      plugins: [pretty()]
+    },
+    {
+      ...umdConfig,
+      file: `${distFolder}/cubism.umd.min.js`,
+      sourcemap: true,
+      plugins: [minify()]
+    }
+  ])
+  .flat()
+
+export default [
+  {
+    external: ['cable_ready'],
+    input: 'javascript/index.js',
+    output,
+    plugins: [commonjs(), resolve(), json()],
+    watch: {
+      include: 'javascript/**'
+    }
+  }
+]

data/test/block_container_test.rb

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

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

data/test/broadcaster_test.rb

@@ -0,0 +1,66 @@
+require "test_helper"
+
+class BroadcasterTest < ActionView::TestCase
+  include CableReady::StreamIdentifier
+
+  setup do
+    @post = posts(:one)
+    @post.stubs(:cubicle_element_ids).returns(%w[foo bar])
+    @post.stubs(:present_users_for_element_id_and_scope).with("foo", "").returns([users(:one)])
+    @post.stubs(:present_users_for_element_id_and_scope).with("bar", "").returns([users(:two)])
+
+    @post_2 = posts(:two)
+    @post_2.stubs(:cubicle_element_ids).returns(%w[baz])
+    @post_2.stubs(:present_users_for_element_id_and_scope).with("baz", :edit).returns([users(:one)])
+    @post_2.stubs(:present_users_for_element_id_and_scope).with("baz", :show).returns([])
+
+    block_source_foo = Cubism::BlockSource.new(location: "test:1", variable_name: "users", source: "<div><%= users.map(&:username).to_sentence %></div>", view_context: self)
+    block_source_bar = Cubism::BlockSource.new(location: "test:1", variable_name: "present_users", source: "<div><%= present_users.map(&:username).to_sentence %></div>", view_context: self)
+
+    Cubism.stubs(:block_store).returns({
+      "foo" => Cubism::BlockContainer.new(block_location: "test:1", block_source: block_source_foo, user_gid: users(:one).to_gid.to_s, resource_gid: posts(:one).to_gid.to_s),
+      "bar" => Cubism::BlockContainer.new(block_location: "test:1", block_source: block_source_bar, user_gid: users(:two).to_gid.to_s, resource_gid: posts(:one).to_gid.to_s),
+      "baz" => Cubism::BlockContainer.new(block_location: "test:1", block_source: block_source_foo, user_gid: users(:one).to_gid.to_s, resource_gid: posts(:two).to_gid.to_s, scope: :edit)
+    })
+  end
+
+  test "it broadcasts to all registered element ids with default scopes" do
+    with_mocked_cable_ready({"foo" => {"" => users(:one)}, "bar" => {"" => users(:two)}}, @post) do |cable_ready_mock|
+      @broadcaster = Cubism::Broadcaster.new(resource: @post)
+
+      @broadcaster.expects(:cable_ready).returns(cable_ready_mock).times(3)
+
+      @broadcaster.broadcast
+    end
+  end
+
+  test "it broadcasts to all registered element ids and respects scopes" do
+    with_mocked_cable_ready({"baz" => {"edit" => users(:one)}}, @post_2) do |cable_ready_mock|
+      @broadcaster = Cubism::Broadcaster.new(resource: @post_2)
+
+      @broadcaster.expects(:cable_ready).returns(cable_ready_mock).twice
+
+      @broadcaster.broadcast
+    end
+  end
+end
+
+def with_mocked_cable_ready(elements_with_users_and_scopes, resource)
+  cable_ready_mock = mock
+  cable_ready_mock.expects(:broadcast).once
+
+  elements_with_users_and_scopes.each do |element_id, scoped_users|
+    cable_ready_channel = mock
+    scoped_users.each do |scope, user|
+      cable_ready_channel
+        .expects(:inner_html)
+        .with({
+          selector: "cubicle-element#cubicle-#{element_id}[identifier='#{signed_stream_identifier(resource.to_global_id.to_s)}']",
+          html: "<div>#{user.username}</div>"
+        })
+    end
+    cable_ready_mock.expects(:[]).with(element_id).returns(cable_ready_channel)
+  end
+
+  yield cable_ready_mock
+end

data/test/channels/cubism/presence_channel_test.rb

@@ -0,0 +1,72 @@
+require "test_helper"
+
+class Cubism::PresenceChannelTest < ActionCable::Channel::TestCase
+  include CableReady::StreamIdentifier
+
+  setup do
+    @post = posts(:one)
+    @user = users(:one)
+
+    Post.any_instance.stubs(:cubicle_element_ids).returns([])
+    Post.any_instance.stubs(:excluded_user_id_for_element_id).returns({})
+    Post.any_instance.stubs(:present_users).returns({})
+
+    Cubism.stubs(:block_store).returns({
+      "foo" => Cubism::BlockContainer.new(block_location: "test:1", user_gid: @user.to_gid.to_s, resource_gid: @post.to_gid.to_s, scope: ""),
+      "bar" => Cubism::BlockContainer.new(block_location: "test:1", user_gid: @user.to_gid.to_s, resource_gid: @post.to_gid.to_s, scope: "edit")
+    })
+  end
+
+  test "rejects a subscription for invalid identifiers" do
+    subscribe identifier: "foo", element_id: "cubicle-bar"
+
+    assert subscription.rejected?
+  end
+
+  test "confirms a subscription for valid identifiers" do
+    subscribe identifier: signed_stream_identifier(@post.to_gid.to_s), element_id: "cubicle-bar"
+
+    assert subscription.confirmed?
+
+    assert_has_stream "bar"
+    assert_equal 1, @post.cubicle_element_ids.size
+  end
+
+  test "adds user_id to the excluded users hash if the exclude_current_user param is passed" do
+    subscribe identifier: signed_stream_identifier(@post.to_gid.to_s), element_id: "cubicle-bar", exclude_current_user: true
+
+    assert_equal({"bar" => @user.id}, @post.excluded_user_id_for_element_id)
+  end
+
+  test "adds a user to the present users list when appear is called" do
+    subscribe identifier: signed_stream_identifier(@post.to_gid.to_s), element_id: "cubicle-foo"
+    perform :appear
+
+    assert_equal [@user.id], @post.present_users_for_scope("").to_a
+  end
+
+  test "adds a user to a scope in the present users list when appear is called with a scope parameter" do
+    assert_equal [], @post.present_users_for_scope("edit").to_a
+    assert_equal [], @post.present_users_for_scope("show").to_a
+
+    subscribe identifier: signed_stream_identifier(@post.to_gid.to_s), element_id: "cubicle-bar", scope: "edit"
+    perform :appear
+
+    subscribe identifier: signed_stream_identifier(@post.to_gid.to_s), element_id: "bar", scope: "show"
+
+    assert_equal [@user.id], @post.present_users_for_scope("edit").to_a
+    assert_equal [], @post.present_users_for_scope("show").to_a
+  end
+
+  test "removes a user from the present users list when disappear is called" do
+    subscribe identifier: signed_stream_identifier(@post.to_gid.to_s), element_id: "cubicle-foo"
+
+    perform :appear
+
+    assert_equal [@user.id], @post.present_users_for_scope("").to_a
+
+    perform :disappear
+
+    assert_equal [], @post.present_users_for_scope("").to_a
+  end
+end

data/test/cubicle_store_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+class CubicleStoreTest < ActiveSupport::TestCase
+  setup do
+    @store = Cubism::CubicleStore.new("cubism-test")
+  end
+
+  test "empty value just retrieves the key" do
+    @store["foo"] = "bar"
+
+    value = @store.fetch("foo")
+
+    refute_nil @store["foo"]
+    assert_equal "bar", value
+  end
+
+  test "fetch assigns value to empty key" do
+    assert_nil @store["foo"]
+
+    value = @store.fetch("foo", "bar")
+
+    refute_nil @store["foo"]
+    assert_equal "bar", value
+  end
+
+  test "fetch retrieves value for existing key, and does not overwrite it" do
+    @store["foo"] = "baz"
+
+    value = @store.fetch("foo", "bar")
+
+    refute_nil @store["foo"]
+    assert_equal "baz", value
+  end
+end

data/test/cubism_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class CubismTest < ActiveSupport::TestCase
+  test "it has a version number" do
+    assert Cubism::VERSION
+  end
+end

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ApplicationRecord
+  include Cubism::Presence
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ApplicationRecord
+  include Cubism::User
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require "cubism"
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,76 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp", "caching-dev.txt").exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end