stimulus_reflex 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01c487c8dcbf81861bfb4a53e745ba41c5f5e9f33903b287b1a4dad85677fbcb
-  data.tar.gz: 1192b6eb87371604649f4f63589664fbd954fbef93b1bd9114e4b717d6b0b57c
+  metadata.gz: 938d4a641bd8ab544990da39e9f5ac03d9c624d6cd88d2d0a0855654d00d2009
+  data.tar.gz: 398a90e77696a6477d49c8e338493a59db1a52cb678a3a0bd6bb9f6f1ca24266
 SHA512:
-  metadata.gz: 3bd7af4f182254375a353839f561afa54927876065d3469bde34d3138c97ab14ebb50dc0587aaf1bc8db236df5e2c98ef71c6107e7def5a6582e13c84af0d6b8
-  data.tar.gz: 1cfd21e9a2268c2a799ff1a77dc34dd46464b13feef9857fe76fd3bab64c05b4e5b26c993b6aed6959329b44e167d01d334ab368d8688194c89a4c2d522ca633
+  metadata.gz: 1e8f45b49f0635ad52d04550885e6485f324fc197b92a1664d5fae70fed0876788d79c74cd3f9b9189aa32e1b98c3ce720e40e387938b502b596d0edcbafdd97
+  data.tar.gz: ecc35de7b132a1b7e46b084b252b70fb73e24a5a0be783f4997b07fa9ebc4d483aeb162a0f426aac3d181718bf8f8d5b943436da096376f7c632f9ab8f82b522

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in stimulus_reflex.gemspec
 gemspec

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (1.0.0)
-      actioncable (>= 5.2.1)
-      actionpack (>= 5.2.1)
-      cable_ready (>= 4.0.0)
+    stimulus_reflex (1.0.1)
+      actioncable (>= 5.2.3)
+      actionpack (>= 5.2.3)
+      cable_ready (>= 4.0.1)
       nokogiri
       rack
 
@@ -35,14 +35,14 @@ GEM
       tzinfo (~> 1.1)
     ast (2.4.0)
     builder (3.2.3)
-    cable_ready (4.0.0)
+    cable_ready (4.0.1)
       activesupport (>= 5.0.0)
     concurrent-ruby (1.1.5)
     crass (1.0.4)
     erubi (1.8.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
+    jaro_winkler (1.5.3)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -54,7 +54,6 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    psych (3.1.0)
     rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -64,24 +63,26 @@ GEM
     rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rubocop (0.67.2)
+    rake (12.3.3)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.0)
-    standard (0.0.39)
-      rubocop (~> 0.67.1)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    standard (0.1.2)
+      rubocop (~> 0.72.0)
+      rubocop-performance (~> 1.4.0)
     standardrb (1.0.0)
       standard
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.6.0)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)

data/README.md

@@ -1,23 +1,28 @@
-[![Lines of Code](http://img.shields.io/badge/lines_of_code-120-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-171-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2b24fdbd1ae37a24bedb/maintainability)](https://codeclimate.com/github/hopsoft/stimulus_reflex/maintainability)
-[![Ruby Dependency Graph](https://img.shields.io/badge/deps-ruby-informational.svg?style=flat)](https://github.com/hopsoft/stimulus_reflex/blob/master/gem_graph.svg)
 
 # StimulusReflex
 
-#### Build rich interactive UIs with standard Rails... no need for a complex frontend framework
+### Reactive user interfaces with Rails and Stimulus
 
-This library provides functionality similar to [Phoenix LiveView](https://youtu.be/Z2DU0qLfPIY?t=670) for Rails applications.
+#### No need for a complex frontend framework
 
-Add the benefits of single page apps (SPA) to server rendered Rails/Stimulus projects with a minimal investment of time, resources, and complexity.
-_The goal is to provide 80% of the benefits of SPAs with 20% of the typical effort._
+This project aims to support the building of [Single Page Applications (SPAs)](https://en.wikipedia.org/wiki/Single-page_application)
+with standard Rails tooling. Think server rendered HTML, Stimulus, Turbolinks, etc...
 
-1. Use [ActionCable](https://edgeguides.rubyonrails.org/action_cable_overview.html) to invoke a method on the server.
-1. Watch the page automatically render updates via fast [DOM diffing](https://github.com/patrick-steele-idem/morphdom).
+Inspired by [Phoenix LiveView](https://youtu.be/Z2DU0qLfPIY?t=670). 🙌
+
+## How it Works
+
+1. Use [ActionCable](https://edgeguides.rubyonrails.org/action_cable_overview.html) to invoke a method on the server
+1. Watch the page automatically render updates via fast [DOM diffing](https://github.com/patrick-steele-idem/morphdom)
 1. That's it...
 
-  - Yes, it really is that simple. Just write your HTML page.
-  - If you hit refresh, that works, too.
-  - There's no hidden gotcha.
+__Yes, it really is that simple.__
+Just create a server rendered HTML page and send RPC calls to the server via web socket.
+There are no hidden gotchas.
+
+![How it Works](https://raw.githubusercontent.com/hopsoft/stimulus_reflex/master/docs/diagram.png)
 
 ## Setup
 
@@ -33,7 +38,7 @@ yarn add stimulus_reflex
 gem "stimulus_reflex"
 ```
 
-## Usage
+## Basic Usage
 
 ### app/views/pages/example.html.erb
 
@@ -77,15 +82,39 @@ end
 
 The following happens after the `StimulusReflex::Reflex` method call finishes.
 
-1. The page that triggered the reflex is re-rerendered. _Note that instance variables created in the reflex are available to both the controller and view templates._
+1. The page that triggered the reflex is re-rerendered. _Instance variables created in the reflex are available to both the controller and view templates._
 2. The re-rendered HTML is sent to the client over the ActionCable socket.
 3. The page is updated via fast DOM diffing courtesy of morphdom. _While future versions of StimulusReflex might support more granular updates, today the entire body is re-rendered and sent over the socket._
 
+## Advanced Usage
+
 ### ActionCable
 
-StimulusReflex will use the Rails' ActionCable defaults `window.App` and `App.cable` if they exist.
-If these defaults do not exist, StimulusReflex will attempt to establish a new socket connection.
+StimulusReflex will use the ActionCable defaults of `window.App` and `App.cable` if they exist.
+If these defaults do not exist, StimulusReflex will establish a new socket connection.
+
+### ActionCable Rooms
+
+You may find the need to restrict notifications to a specific room.
+This can be accomplished by setting the `data-room` attribute on the StimulusController element.
+
+```
+<a href="#" data-controller="example" data-action="click->example#increment" data-room="12345">
+```
+
+### Render Delay
+
+An attempt is made to reduce repaint/reflow jitter when users trigger lots of updates.
+
+You can control how long to wait _(think debounce)_ prior to updating the page.
+Simply set the `renderDelay` _(milliseconds)_ option when registering the controller.
 
-## JavaScript Development
+```javascript
+export default class extends Controller {
+  connect() {
+    StimulusReflex.register(this, {renderDelay: 200});
+  }
+}
+```
 
-The JavaScript library is hosted at: https://github.com/hopsoft/stimulus_reflex_client
+The default value is `25`.

data/lib/stimulus_reflex/channel.rb

@@ -9,10 +9,12 @@ class StimulusReflex::Channel < ActionCable::Channel::Base
   include CableReady::Broadcaster
 
   def stream_name
-    ids = connection.identifiers.map { |identifier|
-      send(identifier).try(:id)
-    }
-    "#{channel_name}#{ids.join ":"}"
+    ids = connection.identifiers.map { |identifier| send(identifier).try(:id) }
+    [
+      params[:channel],
+      params[:room],
+      ids.select(&:present?).join(";"),
+    ].select(&:present?).join(":")
   end
 
   def subscribed

data/lib/stimulus_reflex/version.rb

@@ -1,3 +1,3 @@
 module StimulusReflex
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nathan Hopkins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -45,42 +45,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: cable_ready
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,6 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/deps
 - bin/setup
 - bin/standardize
 - lib/stimulus_reflex.rb

data/bin/deps

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-bundle viz --version --format svg --without development test