optimism 0.2.13 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a935699b3be00235a60d3b448b7775e08030da7abe09670355aec835af702c5
-  data.tar.gz: 50e405ae5b908b30f60142b5221db85e605f56ae82d031df36a9883b7f6bd922
+  metadata.gz: 2e971263a8aba08305a366ceaee0a6d33c3c8bdaab38e084581311ac13542cf5
+  data.tar.gz: e69c4fe7cb8b2cd277e021e9427f8500eca8298b0c0519b1e1dabacfa19ae828
 SHA512:
-  metadata.gz: 4776e29d1d7130b60d4329f5355e56d18493e3c247fa38c0ec07ceaeece56b1a7d97e53dd8f46241eb55a1b27b1a8166d73cde19187276b2bec97f5cafab7023
-  data.tar.gz: b0ae31af7e811160209be5af0a7c88c459abd6f8302201fe9fc52fff0fd39ad3702286ea533b216bb65053030eb0ea6c56b3dd757e6ab70d2498216bc1ae0007
+  metadata.gz: f83d1e769f160ad7042a39277d0ba31fd970dcba7ec9dd68ffe57dcb29a744f59df9690337096d6d5342f333edc655969737b631958a6251e4c0766546bc1af5
+  data.tar.gz: 8c95685178155f836c43b546e3e6fd34e37d18412ee61c187f2f0f58f4dfea28047e139739c52a3eaa0431d9ee90a6ca04e0c0202d64e4dec440491cdebdf16c

data/README.md

@@ -1,6 +1,6 @@
 # Optimism
 
-[![GitHub stars](https://img.shields.io/github/stars/leastbad/optimism?style=social)](https://github.com/leastbad/optimism) [![GitHub forks](https://img.shields.io/github/forks/leastbad/optimism?style=social)](https://github.com/leastbad/optimism) [![Twitter follow](https://img.shields.io/twitter/follow/theleastbad?style=social)](https://twitter.com/theleastbad)
+[![GitHub stars](https://img.shields.io/github/stars/leastbad/optimism?style=social)](https://github.com/leastbad/optimism) [![GitHub forks](https://img.shields.io/github/forks/leastbad/optimism?style=social)](https://github.com/leastbad/optimism) [![Twitter follow](https://img.shields.io/twitter/follow/theleastbad?style=social)](https://twitter.com/theleastbad) [Discord.![](https://img.shields.io/discord/681373845323513862)](https://discord.gg/GnweR3)
 
 The missing drop-in solution for realtime remote form validation in Rails.
 
@@ -8,7 +8,7 @@ The missing drop-in solution for realtime remote form validation in Rails.
 
 [Optimism](https://github.com/leastbad/optimism) is an MIT-licensed [Ruby on Rails](https://rubyonrails.org/) gem that makes it easy to give your users instant constructive feedback if they enter invalid data into your application. Instead of dumping a list of errors at the top of your interface, Optimism provides specific instructions directly beside or below individual input elements.
 
-You can try a [live demo](https://optimism-demo.herokuapp.com) right now.
+You can try a 👉 [live demo](https://optimism-demo.herokuapp.com) 👈 right now.
 
 ![](.gitbook/assets/fill_forms.svg)
 

data/SUMMARY.md

@@ -4,6 +4,7 @@
 * [Setup](setup.md)
 * [Quick Start](quick-start.md)
 * [Typical Usage](typical-usage.md)
+* [Authentication](authentication.md)
 * [Reference](reference.md)
 * [Advanced Usage](advanced-usage.md)
 

data/authentication.md

@@ -0,0 +1,149 @@
+---
+description: Practice safe optimism
+---
+
+# Authentication
+
+If you're just trying to bootstrap a proof-of-concept application on your local workstation, you don't technically have to worry about giving ActionCable the ability to distinguish between multiple concurrent users. However, **the moment you deploy to a host with more than one person accessing your app, you'll find that you're sharing a session and seeing other people's updates**. That isn't what most developers have in mind.
+
+## Encrypted Session Cookies
+
+You can use your default Rails encrypted cookie-based sessions to isolate your users into their own sessions. This works great even if your application doesn't have a login system.
+
+{% code title="app/controllers/application\_controller.rb" %}
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :set_action_cable_identifier
+
+  private
+
+  def set_action_cable_identifier
+    cookies.encrypted[:session_id] = session.id.to_s
+  end
+end
+```
+{% endcode %}
+
+{% code title="app/channels/application\_cable/connection.rb" %}
+```ruby
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :session_id
+
+    def connect
+      self.session_id = cookies.encrypted[:session_id]
+    end
+  end
+end
+```
+{% endcode %}
+
+We need to instruct ActionCable to stream updates on a per-session basis:
+
+{% code title="app/channels/optimism_channel.rb" %}
+```ruby
+class OptimismChannel < ApplicationCable::Channel
+  def subscribed
+    stream_for session_id
+  end
+end
+```
+{% endcode %}
+
+Finally, we need to give Optimism the ability to broadcast updates to the correct channel subscription. We will override Optimism's default "OptimismChannel" with a lambda that returns the subscription identifier. You might already have other values in your initializer, or it might not yet exist at all:
+
+{% code title="config/initializers/optimism.rb" %}
+```ruby
+Optimism.configure do |config|
+  config.channel = ->(context) { OptimismChannel.broadcasting_for(context.session.id) }
+end
+```
+{% endcode %}
+
+## User-based Authentication
+
+Many Rails apps use the current\_user convention or more recently, the [Current](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) object to provide a global user context. This gives access to the user scope from _almost_ all parts of your application.
+
+{% code title="app/controllers/application\_controller.rb  " %}
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :set_action_cable_identifier
+
+  private
+
+  def set_action_cable_identifier
+    cookies.encrypted[:user_id] = current_user&.id
+  end
+end
+```
+{% endcode %}
+
+{% code title="app/channels/application\_cable/connection.rb " %}
+```ruby
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      user_id = cookies.encrypted[:user_id]
+      return reject_unauthorized_connection if user_id.nil?
+      user = User.find_by(id: user_id)
+      return reject_unauthorized_connection if user.nil?
+      self.current_user = user
+    end
+  end
+end
+```
+{% endcode %}
+
+We need to instruct ActionCable to stream updates on a per-session basis:
+
+{% code title="app/channels/optimism_channel.rb" %}
+```ruby
+class OptimismChannel < ApplicationCable::Channel
+  def subscribed
+    stream_for current_user
+  end
+end
+```
+{% endcode %}
+
+Finally, we need to give Optimism the ability to broadcast updates to the correct channel subscription. We will override Optimism's default "OptimismChannel" with a lambda that returns the subscription identifier. You might already have other values in your initializer, or it might not yet exist at all:
+
+{% code title="config/initializers/optimism.rb" %}
+```ruby
+Optimism.configure do |config|
+  config.channel = ->(context) { OptimismChannel.broadcasting_for(context.current_user) }
+end
+```
+{% endcode %}
+
+## Devise-based Authentication
+
+If you're using the versatile [Devise](https://github.com/plataformatec/devise) authentication library, your configuration is *identical* to the User-Based Authentication above, **except** for how ActionCable looks up a user:
+
+{% code title="app/channels/application\_cable/connection.rb" %}
+```ruby
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      self.current_user = find_verified_user
+    end
+
+    protected
+
+    def find_verified_user
+      if current_user = env["warden"].user
+        current_user
+      else
+        reject_unauthorized_connection
+      end
+    end
+  end
+end
+```
+{% endcode %}
+
+

data/lib/optimism/version.rb

@@ -1,3 +1,3 @@
 module Optimism
-  VERSION = "0.2.13"
+  VERSION = "0.3.0"
 end

data/lib/optimism.rb

@@ -6,7 +6,7 @@ module Optimism
   include CableReady::Broadcaster
   class << self
     mattr_accessor :channel, :form_class, :error_class, :disable_submit, :suffix, :emit_events, :add_css, :inject_inline, :container_selector, :error_selector, :form_selector, :submit_selector
-    self.channel = "OptimismChannel"
+    self.channel = ->(context) { "OptimismChannel" }
     self.form_class = "invalid"
     self.error_class = "error"
     self.disable_submit = false
@@ -26,34 +26,35 @@ module Optimism
 
   def broadcast_errors(model, attributes)
     return unless model&.errors&.messages
-    resource = model.class.to_s.downcase
+    resource = model.class.to_s.underscore
     form_selector, submit_selector = Optimism.form_selector.sub("RESOURCE", resource), Optimism.submit_selector.sub("RESOURCE", resource)
     attributes = case attributes
     when ActionController::Parameters, Hash, ActiveSupport::HashWithIndifferentAccess
-      attributes.to_h.keys
+      attributes.to_h
     when String, Symbol
-      [attributes.to_s]
+      { attributes.to_s => nil }
     when Array
-      attributes.flatten.map &:to_s
+      attributes.flatten.each.with_object({}) { |attr, obj| obj[attr.to_s] = nil }
     else
       raise Exception.new "attributes must be a Hash (Parameters, Indifferent or standard), Array, Symbol or String"
     end
+    model.valid? if model.errors.empty?
     process_resource(model, attributes, [resource])
     if model.errors.any?
-      cable_ready[Optimism.channel].dispatch_event(name: "optimism:form:invalid", detail: {resource: resource}) if Optimism.emit_events
-      cable_ready[Optimism.channel].add_css_class(selector: form_selector, name: Optimism.form_class) if Optimism.form_class.present?
-      cable_ready[Optimism.channel].set_attribute(selector: submit_selector, name: "disabled") if Optimism.disable_submit
+      cable_ready[Optimism.channel[self]].dispatch_event(name: "optimism:form:invalid", detail: {resource: resource}) if Optimism.emit_events
+      cable_ready[Optimism.channel[self]].add_css_class(selector: form_selector, name: Optimism.form_class) if Optimism.form_class.present?
+      cable_ready[Optimism.channel[self]].set_attribute(selector: submit_selector, name: "disabled") if Optimism.disable_submit
     else
-      cable_ready[Optimism.channel].dispatch_event(name: "optimism:form:valid", detail: {resource: resource}) if Optimism.emit_events
-      cable_ready[Optimism.channel].remove_css_class(selector: form_selector, name: Optimism.form_class) if Optimism.form_class.present?
-      cable_ready[Optimism.channel].remove_attribute(selector: submit_selector, name: "disabled") if Optimism.disable_submit
+      cable_ready[Optimism.channel[self]].dispatch_event(name: "optimism:form:valid", detail: {resource: resource}) if Optimism.emit_events
+      cable_ready[Optimism.channel[self]].remove_css_class(selector: form_selector, name: Optimism.form_class) if Optimism.form_class.present?
+      cable_ready[Optimism.channel[self]].remove_attribute(selector: submit_selector, name: "disabled") if Optimism.disable_submit
     end
     cable_ready.broadcast
-    head :ok
+    head :ok if defined?(head)
   end
 
   def process_resource(model, attributes, ancestry)
-    attributes.each do |attribute|
+    attributes.keys.each do |attribute|
       if attribute.ends_with?("_attributes")
         resource = attribute[0..-12]
         nested_models = model.send(resource.to_sym)
@@ -70,15 +71,15 @@ module Optimism
     resource = ancestry.shift
     resource += "_#{ancestry.shift}_attributes_#{ancestry.shift}" until ancestry.empty?
     container_selector, error_selector = Optimism.container_selector.sub("RESOURCE", resource).sub("ATTRIBUTE", attribute), Optimism.error_selector.sub("RESOURCE", resource).sub("ATTRIBUTE", attribute)
-    if model.errors.messages.map(&:first).include?(attribute.to_sym)
+    if model.errors.any? && model.errors.messages.map(&:first).include?(attribute.to_sym)
       message = "#{model.errors.full_message(attribute.to_sym, model.errors.messages[attribute.to_sym].first)}#{Optimism.suffix}"
-      cable_ready[Optimism.channel].dispatch_event(name: "optimism:attribute:invalid", detail: {resource: resource, attribute: attribute, text: message}) if Optimism.emit_events
-      cable_ready[Optimism.channel].add_css_class(selector: container_selector, name: Optimism.error_class) if Optimism.add_css
-      cable_ready[Optimism.channel].text_content(selector: error_selector, text: message) if Optimism.inject_inline
+      cable_ready[Optimism.channel[self]].dispatch_event(name: "optimism:attribute:invalid", detail: {resource: resource, attribute: attribute, text: message}) if Optimism.emit_events
+      cable_ready[Optimism.channel[self]].add_css_class(selector: container_selector, name: Optimism.error_class) if Optimism.add_css
+      cable_ready[Optimism.channel[self]].text_content(selector: error_selector, text: message) if Optimism.inject_inline
     else
-      cable_ready[Optimism.channel].dispatch_event(name: "optimism:attribute:valid", detail: {resource: resource, attribute: attribute}) if Optimism.emit_events
-      cable_ready[Optimism.channel].remove_css_class(selector: container_selector, name: Optimism.error_class) if Optimism.add_css
-      cable_ready[Optimism.channel].text_content(selector: error_selector, text: "") if Optimism.inject_inline
+      cable_ready[Optimism.channel[self]].dispatch_event(name: "optimism:attribute:valid", detail: {resource: resource, attribute: attribute}) if Optimism.emit_events
+      cable_ready[Optimism.channel[self]].remove_css_class(selector: container_selector, name: Optimism.error_class) if Optimism.add_css
+      cable_ready[Optimism.channel[self]].text_content(selector: error_selector, text: "") if Optimism.inject_inline
     end
   end
 end
@@ -90,7 +91,7 @@ module ActionView::Helpers
     end
 
     def container_id_for(attribute)
-      Optimism.container_selector.sub("RESOURCE", object_name.delete("]").tr("[", "_")).sub("ATTRIBUTE", attribute.to_s)[1..-1]
+      Optimism.container_selector.sub("RESOURCE", object_name.to_s.delete("]").tr("[", "_")).sub("ATTRIBUTE", attribute.to_s)[1..-1]
     end
 
     def error_for(attribute, **options)
@@ -98,7 +99,7 @@ module ActionView::Helpers
     end
 
     def error_id_for(attribute)
-      Optimism.error_selector.sub("RESOURCE", object_name.delete("]").tr("[", "_")).sub("ATTRIBUTE", attribute.to_s)[1..-1]
+      Optimism.error_selector.sub("RESOURCE", object_name.to_s.delete("]").tr("[", "_")).sub("ATTRIBUTE", attribute.to_s)[1..-1]
     end
   end
 end

data/optimism.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", ">= 2.0"
-  spec.add_development_dependency "rake", ">= 13.0"
-  spec.add_development_dependency "pry", ">= 0.12.2"
-  spec.add_development_dependency "pry-nav", ">= 0.3.0"
-  spec.add_development_dependency "standardrb", ">= 1.0.0"
-  spec.add_dependency "rack", ">= 2.0"
-  spec.add_dependency "rails", ">= 5.2"
-  spec.add_dependency "cable_ready", ">= 4.1"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "pry-nav", "~> 0.3.0"
+  spec.add_development_dependency "standardrb", "~> 1.0.0"
+  spec.add_dependency "rack", "~> 2.0"
+  spec.add_dependency "rails", "~> 5.2"
+  spec.add_dependency "cable_ready", "~> 4.1"
 end

data/reference.md

@@ -93,7 +93,7 @@ Optimism is configurable via an optional initializer file. As with all initializ
 {% code title="config/initializers/optimism.rb" %}
 ```ruby
 Optimism.configure do |config|
-  config.channel = "OptimismChannel"
+  config.channel = ->(context) { "OptimismChannel" }
   config.form_class = "invalid"
   config.error_class = "error"
   config.disable_submit = false
@@ -109,7 +109,7 @@ end
 ```
 {% endcode %}
 
-**channel**: The ActionCable channel created by the `rake optimism:install` setup task. In most cases, you don't need to change this value. In fact, the only good reason to change this value is if you already have an OptimismChannel. If this describes you, congratulations on your optimism.
+**channel**: The ActionCable channel created by the `rake optimism:install` setup task. Good enough to get you up and running in development, you will need to pull your desired identifier from the context Optimism is running in and let the `broadcasting_for` method on `OptimismChannel` call the shots. Find out more on the [authentication](https://optimism.leastbad.com/authentication) page.
 
 **form\_class**: The CSS class that will be applied to the form if the id has been properly set eg. `posts_form` \(following the simple pattern **resources\_form**\). If form\_class is set to false or nil, no CSS class will be applied.
 

data/setup.md

@@ -18,7 +18,21 @@ The terminal commands above will ensure that Optimism is installed. It creates t
 
 ![](.gitbook/assets/setup.svg)
 
-### Logging
+# Authentication
+
+{% hint style="info" %}
+If you're just experimenting with Optimism or trying to bootstrap a proof-of-concept application on your local workstation, you can actually skip this section until you're planning to deploy.
+{% endhint %}
+
+Out of the box, ActionCable doesn't give Optimism the ability to distinguish between multiple concurrent users looking at the same page.
+
+**If you deploy to a host with more than one person accessing your app, you'll find that you're sharing a session and seeing other people's updates.** That isn't what most developers have in mind!
+
+When the time comes, it's easy to configure your application to support authenticating users by their Rails session or current_user scope. Just check out the Authentication page and choose your own adventure.
+
+{% page-ref page="authentication.md" %}
+
+# Logging
 
 In the default _debug_ log level, ActionCable emits particularly verbose log messages. You can optionally discard everything but exceptions by switching to the _warn_ log level, as is common in development environments:
 
@@ -29,7 +43,7 @@ config.log_level = :warn
 ```
 {% endcode %}
 
-### Troubleshooting
+# Troubleshooting
 
 {% hint style="info" %}
 If _something_ goes wrong, it's often because of the **spring** gem. You can test this by temporarily setting the `DISABLE_SPRING=1` environment variable and restarting your server.

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: optimism
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.3.0
 platform: ruby
 authors:
 - leastbad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: standardrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !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: cable_ready
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
 description: Realtime remote form input validations delivered via websockets
@@ -148,6 +148,7 @@ files:
 - Rakefile
 - SUMMARY.md
 - advanced-usage.md
+- authentication.md
 - bin/console
 - bin/loc
 - bin/setup