digital_cable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2860b456d0e0d57a5b066fc15b6ffd23310e4ee3fbcbc8a9c94c21d6567c3673
+  data.tar.gz: 16bc4d2fec09bd57fc298deff72948785c1bfff88097e161b86dfedf4defa600
+SHA512:
+  metadata.gz: f46bc4279f11985454bb3fca606f83a748b913258a1248c5966b180f7dcbfabf45a662d27cbbdf10fa5b666b17921426f8f412c9eeb6429fa6bc473ffcbd7a5d
+  data.tar.gz: c703a2eb080d606aec7b2fba699f10a036b7220a1597af424cdabb3c5a7d1b238487f4858d7923385eb1ffe95cdf97a20d43f250d543f348300a8a672eaa031c

data/Dockerfile

@@ -0,0 +1,30 @@
+FROM ruby:2.6.6-stretch
+
+RUN apt-get -q update -yqq && apt-get install -yqq --no-install-recommends && \
+    curl -sL https://deb.nodesource.com/setup_12.x | bash && \
+    apt-get install -yqq nodejs && \
+    rm -rf /var/lib/apt/lists/*
+RUN npm cache clean -f && npm install -g n && n 12.16.3
+RUN npm install --global yarn
+
+RUN useradd --create-home --shell /bin/bash --user-group dev && \
+  echo "dev ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
+
+RUN mkdir /digital_cable
+RUN chown dev:dev /digital_cable
+RUN mkdir -p /digital_cable/lib/digital_cable/
+
+USER dev
+SHELL ["/bin/bash", "-l", "-c"]
+WORKDIR /digital_cable
+
+COPY --chown=dev lib/digital_cable/version.rb /digital_cable/lib/digital_cable/
+COPY --chown=dev digital_cable.gemspec /digital_cable/
+COPY --chown=dev Gemfile* /digital_cable/
+RUN bundle install
+
+COPY --chown=dev package.json /digital_cable/
+# COPY --chown=dev yarn.lock /digital_cable/
+RUN yarn install --check-files
+
+COPY --chown=dev . /digital_cable/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cable_ready.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "github_changelog_generator/task"
+
+task default: [:test]
+
+task :test do
+  puts "Please write some tests..."
+end
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = "ccollins"
+  config.project = "digital_cable"
+end
+
+
+# bundle exec magic_frozen_string_literal
+# bundle exec standardrb --fix
+# cd ./javascript && yarn run prettier-standard cable_ready.js

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "digital_cable"
+require "pry"
+
+Pry.start

data/digital_cable.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path("../lib/digital_cable/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "digital_cable"
+  gem.license = "MIT"
+  gem.version = DigitalCable::VERSION
+  gem.authors = ["Chuck Collins"]
+  gem.email = ["chuck.collins@gmail.com"]
+  gem.homepage = "https://github.com/blackbox-engineering/digital-cable"
+  gem.summary = "Out-of-Band Server Triggered DOM Operations"
+
+  gem.files = Dir["lib/**/*.rb", "bin/*", "[A-Z]*"]
+  gem.test_files = Dir["spec/**/*.rb"]
+
+  gem.add_dependency "rails", ">= 5.2"
+
+  gem.add_development_dependency "github_changelog_generator"
+  gem.add_development_dependency "magic_frozen_string_literal"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "standardrb"
+  gem.add_development_dependency "rspec"
+end

data/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3'
+
+services:
+  gem:
+    build:
+      context: .
+    image: digital_cable/dev:latest
+    volumes:
+      - .:/digital_cable
+      - /digital_cable/node_modules

data/lib/digital_cable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+require "active_support/all"
+require "digital_cable/version"
+
+module DigitalCable
+  class Engine < Rails::Engine; end
+end

data/lib/digital_cable/broadcaster.rb

@@ -0,0 +1,56 @@
+module DigitalCable
+
+  class DigitalCableError < StandardError; end
+  module Broadcaster
+
+    OPERATIONS = [
+      :add_css_class,
+      :console_log,
+      :dispatch_event,
+      :inner_html,
+      :insert_adjacent_html,
+      :insert_adjacent_text,
+      :morph,
+      :notification,
+      :outer_html,
+      :push_state,
+      :remove,
+      :remove_attribute,
+      :remove_css_class,
+      :set_attribute,
+      :set_cookie,
+      :set_dataset_property,
+      :set_focus,
+      :set_property,
+      :set_style,
+      :set_styles,
+      :set_value,
+      :text_content
+    ]
+
+    def broadcast(identifier, method:, options:)
+      verify_method!(method)
+
+      ActionCable.server.broadcast identifier, {
+        "digitalCable" => true,
+        "operation" => { method: method.to_s.camelize(:lower), options: options }
+      }
+    end
+
+    def broadcast_to(identifier, model, method:, options:)
+      verify_method!(method)
+
+      identifier.broadcast_to model, {
+        "digitalCable" => true,
+        "operation" => { method: method.to_s.camelize(:lower), options: options }
+      }
+    end
+
+    private
+
+    def verify_method!(method)
+      raise DigitalCableError, "Undefined method" unless OPERATIONS.include?(method.to_sym)
+    end
+
+  end
+end

data/lib/digital_cable/reflex.rb

@@ -0,0 +1,29 @@
+require 'digital_cable'
+
+module DigitalCable
+  class Reflex < ApplicationCable::Channel
+    include DigitalCable::Broadcaster
+
+    delegate :render, to: :ApplicationController
+
+    attr_accessor :stream_name
+
+    def subscribed
+      stream_from generate_stream_name(params)
+    end
+
+    def process_reflex(data)
+      reflex(data)
+    end
+
+    def reflex(data); end
+
+    def response; end
+
+    private
+
+    def generate_stream_name(params)
+      self.stream_name = "reflex:#{params['identifier']}"
+    end
+  end
+end

data/lib/digital_cable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DigitalCable
+  VERSION = "0.0.1"
+end

data/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "digital_cable",
+  "version": "0.0.1",
+  "description": "DigitalCable helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.",
+  "keywords": [
+    "ruby",
+    "rails",
+    "websockets",
+    "actioncable",
+    "cable",
+    "ssr",
+    "stimulus_reflex",
+    "client-side",
+    "dom"
+  ],
+  "homepage": "https://github.com/ccollins/digital-cable",
+  "bugs": {
+    "url": "https://github.com/ccollins/digital-cable/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com:ccollins/digital_cable.git"
+  },
+  "license": "",
+  "author": "Chuck Collins <chuck.collins@gmail.com>",
+  "main": "./digital_cable.js",
+  "scripts": {
+    "prettier-standard-check": "yarn run prettier-standard --check ./digital_cable.js"
+  },
+  "dependencies": {
+    "morphdom": "^2.6.1"
+  },
+  "devDependencies": {
+    "prettier-standard": "^16.1.0"
+  }
+}

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: digital_cable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chuck Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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'
+- !ruby/object:Gem::Dependency
+  name: magic_frozen_string_literal
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- chuck.collins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Dockerfile
+- Gemfile
+- Rakefile
+- bin/console
+- digital_cable.gemspec
+- docker-compose.yml
+- lib/digital_cable.rb
+- lib/digital_cable/broadcaster.rb
+- lib/digital_cable/reflex.rb
+- lib/digital_cable/version.rb
+- package.json
+homepage: https://github.com/blackbox-engineering/digital-cable
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Out-of-Band Server Triggered DOM Operations
+test_files: []