futurism 0.3.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a13955e5c2902320a9eb601cd12058c16782a4002ec2c05ca1dff9eddd3190
-  data.tar.gz: 636b6c0b298bb686600026d5f065190e2c94edec85a25c0afa715891841c0b38
+  metadata.gz: 28d6dcb8e42dba12b2e5064b8734578bffbd9c2ec65418361147ebe381369eab
+  data.tar.gz: 4356920e35812c99ead70f5ac3729cd9cb3d7b9e711ab9ee1f0e4b98d6524289
 SHA512:
-  metadata.gz: ee386095ed1c02325e6eea34b0f8a85e67709a0a4b17d5705de035cf7bac667487687a99135654f15bc24f202b81af9d6320d70b61c296279e6c8bc437fc9d96
-  data.tar.gz: 8e73598941f69c36aac9e2b53536369e1cb689a50e76986692c37cc04fca2d253abe7dfb7b3416fa657f0bdbc29f7d34aac4920ec5b9ecff3ce44f4368e672c6
+  metadata.gz: 5b67fcc1166aed81f6f791ed1253d2cc506f2dbdab8f0267eac4fce2983d7923284781f272e29e175aff82214eb4874119d2b3a98900195e345aca8b828a0ad1
+  data.tar.gz: '009c498af95bef5c56c76e5b026b60979a58bb5edaece53005664f75020254108af0d523ffda646af05118bce1f2251aea0600abf6e554cbcc89245dcdca933c'

data/README.md

@@ -1,7 +1,7 @@
 # Futurism
 [![Twitter follow](https://img.shields.io/twitter/follow/julian_rubisch?style=social)](https://twitter.com/julian_rubisch)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 Lazy-load Rails partials via CableReady
 
@@ -10,6 +10,25 @@ Lazy-load Rails partials via CableReady
 <img src="https://user-images.githubusercontent.com/4352208/88374198-9e6f3500-cd99-11ea-804b-0216ed320eff.jpg" alt="birmingham-museums-trust-GrvC6MI-z4w-unsplash" width="50%" align="center"/>
 <span>Photo by <a href="https://unsplash.com/@birminghammuseumstrust?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Birmingham Museums Trust</a> on <a href="https://unsplash.com/s/photos/futurism?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></span>
 
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Facts](#facts)
+  - [Browser Support](#browser-support)
+- [Usage](#usage)
+- [API](#api)
+  - [Resource](#resource)
+  - [Explicit Partial](#explicit-partial)
+  - [HTML Options](#html-options)
+- [Events](#events)
+- [Installation](#installation)
+  - [Manual Installation](#manual-installation)
+- [Authentication](#authentication)
+- [Gotchas](#gotchas)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contributors](#contributors)
+
 ## Facts
 - only one dependency: CableReady
 - bundle size (without CableReady) is around [~1.04kB](https://bundlephobia.com/result?p=@minthesize/futurism@0.1.3)
@@ -155,7 +174,7 @@ $ bin/yarn add @minthesize/futurism
 In your `app/javascript/channels/index.js`, add the following
 
 ```js
-import * as Futurism from '@minthesize/futurism''
+import * as Futurism from '@minthesize/futurism'
 
 import consumer from './consumer'
 
@@ -163,6 +182,39 @@ Futurism.initializeElements()
 Futurism.createSubscription(consumer)
 ```
 
+## Authentication
+For authentication, you can rely on ActionCable identifiers, for example, if you use Devise:
+
+```ruby
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      self.current_user = env["warden"].user || reject_unauthorized_connection
+    end
+  end
+end
+```
+
+The [Stimulus Reflex Docs](https://docs.stimulusreflex.com/authentication) have an excellent section about all sorts of authentication.
+
+## Gotchas
+
+### ActiveStorage URLs aren't correct in development
+
+Out of the box, Rails will prefix generated urls with `http://example.org` rather than `http://localhost`, much like ActionMailer. To amend this, add
+
+```ruby
+  # config/environments/development.rb
+  config.action_controller.default_url_options = {host: "localhost", port: 3000}
+
+  # config/environments/production.rb
+  config.action_controller.default_url_options = {host: "mysite.com"}
+```
+
+to your environments.
+
 ## Contributing
 
 ## License
@@ -182,13 +234,15 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://ParamagicDev.github.io/portfolio"><img src="https://avatars2.githubusercontent.com/u/26425882?v=4" width="100px;" alt=""/><br /><sub><b>Konnor Rogers</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=ParamagicDev" title="Code">💻</a></td>
     <td align="center"><a href="https://www.andrewm.codes"><img src="https://avatars1.githubusercontent.com/u/18423853?v=4" width="100px;" alt=""/><br /><sub><b>Andrew Mason</b></sub></a><br /><a href="#maintenance-andrewmcodes" title="Maintenance">🚧</a></td>
     <td align="center"><a href="http://gorails.com"><img src="https://avatars1.githubusercontent.com/u/67093?v=4" width="100px;" alt=""/><br /><sub><b>Chris Oliver</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=excid3" title="Code">💻</a> <a href="https://github.com/julianrubisch/futurism/pulls?q=is%3Apr+reviewed-by%3Aexcid3" title="Reviewed Pull Requests">👀</a></td>
-    <td align="center"><a href="https://github.com/leastbad"><img src="https://avatars2.githubusercontent.com/u/38150464?v=4" width="100px;" alt=""/><br /><sub><b>leastbad</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=leastbad" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/leastbad"><img src="https://avatars2.githubusercontent.com/u/38150464?v=4" width="100px;" alt=""/><br /><sub><b>leastbad</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=leastbad" title="Code">💻</a> <a href="https://github.com/julianrubisch/futurism/pulls?q=is%3Apr+reviewed-by%3Aleastbad" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="http://code.digimonkey.com"><img src="https://avatars0.githubusercontent.com/u/74207?v=4" width="100px;" alt=""/><br /><sub><b>M. E. Patterson</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/issues?q=author%3Amepatterson" title="Bug reports">🐛</a></td>
   </tr>
   <tr>
     <td align="center"><a href="http://fractaledmind.com"><img src="https://avatars3.githubusercontent.com/u/5077225?v=4" width="100px;" alt=""/><br /><sub><b>Stephen Margheim</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=fractaledmind" title="Code">💻</a></td>
     <td align="center"><a href="http://hass.codes"><img src="https://avatars2.githubusercontent.com/u/1064205?v=4" width="100px;" alt=""/><br /><sub><b>Hassanin Ahmed</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=sas1ni69" title="Code">💻</a></td>
     <td align="center"><a href="https://marcoroth.dev"><img src="https://avatars2.githubusercontent.com/u/6411752?v=4" width="100px;" alt=""/><br /><sub><b>Marco Roth</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=marcoroth" title="Code">💻</a></td>
+    <td align="center"><a href="https://viedit.com"><img src="https://avatars1.githubusercontent.com/u/49990587?v=4" width="100px;" alt=""/><br /><sub><b>Viedit com</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=vieditcom" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://scottbarrow.ca"><img src="https://avatars2.githubusercontent.com/u/5571736?v=4" width="100px;" alt=""/><br /><sub><b>Scott Barrow</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=scottbarrow" title="Code">💻</a></td>
   </tr>
 </table>
 

data/lib/futurism/channel.rb

@@ -2,25 +2,46 @@ module Futurism
   class Channel < ActionCable::Channel::Base
     include CableReady::Broadcaster
 
+    def stream_name
+      ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
+      [
+        params[:channel],
+        ids.select(&:present?).join(";")
+      ].select(&:present?).join(":")
+    end
+
     def subscribed
-      stream_from "Futurism::Channel"
+      stream_from stream_name
     end
 
     def receive(data)
-      resources = data["signed_params"].map { |signed_params|
-        [signed_params, Rails.application.message_verifier("futurism").verify(signed_params)]
-      }
+      resources = data.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
 
-      ApplicationController.renderer.instance_variable_set(:@env, connection.env)
+      new_env = connection.env.merge(ApplicationController.renderer.instance_variable_get(:@env))
+      ApplicationController.renderer.instance_variable_set(:@env, new_env)
 
-      resources.each do |signed_params, resource|
-        cable_ready["Futurism::Channel"].outer_html(
-          selector: "[data-signed-params='#{signed_params}']",
-          html: ApplicationController.render(resource)
+      resources.each do |signed_params, sgid|
+        selector = "[data-signed-params='#{signed_params}']"
+        selector << "[data-sgid='#{sgid}']" if sgid.present?
+        cable_ready[stream_name].outer_html(
+          selector: selector,
+          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
         )
       end
 
       cable_ready.broadcast
     end
+
+    private
+
+    def resource(signed_params:, sgid:)
+      return GlobalID::Locator.locate_signed(sgid) if sgid.present?
+
+      Rails
+        .application
+        .message_verifier("futurism")
+        .verify(signed_params)
+        .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
+    end
   end
 end

data/lib/futurism/channel.rb~

@@ -2,25 +2,46 @@ module Futurism
   class Channel < ActionCable::Channel::Base
     include CableReady::Broadcaster
 
+    def stream_name
+      ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
+      [
+        params[:channel],
+        ids.select(&:present?).join(";")
+      ].select(&:present?).join(":")
+    end
+
     def subscribed
-      stream_from "Futurism::Channel"
+      stream_from stream_name
     end
 
     def receive(data)
-      resources = data["signed_params"].map { |signed_params|
-        [signed_params, Rails.application.message_verifier("futurism").verify(signed_params)]
-      }
+      resources = data.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
 
-      ApplicationController.renderer.instance_variable_set(:@env, connection.env)
+      new_env = connection.env.merge(ApplicationController.renderer.instance_variable_get(:@env))
+      ApplicationController.renderer.instance_variable_set(:@env, new_env)
 
-      resources.each do |signed_params, resource|
-        cable_ready["Futurism::Channel"].outer_html(
-          selector: "[data-signed-params='#{signed_params}']",
-          html: ApplicationController.render(resource)
+      resources.each do |signed_params, sgid|
+        selector = "[data-signed-params='#{signed_params}']"
+        selector << "[data-sgid='#{sgid}']" if sgid.present?
+        cable_ready[stream_name].outer_html(
+          selector: selector,
+          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
         )
       end
 
       cable_ready.broadcast
     end
+
+    private
+
+    def resource(signed_params:, sgid:)
+      return GlobalID::Locator.locate_signed(sgid) if sgid.present?
+
+      Rails
+        .application
+        .message_verifier("futurism")
+        .verify(signed_params)
+        .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
+    end
   end
 end

data/lib/futurism/helpers.rb

@@ -6,7 +6,8 @@ module Futurism
       if records_or_string.is_a?(ActiveRecord::Base) || records_or_string.is_a?(ActiveRecord::Relation)
         futurize_active_record(records_or_string, extends: extends, placeholder: placeholder, **options)
       elsif records_or_string.is_a?(String)
-        futurize_with_options(extends: extends, partial: records_or_string, locals: options, placeholder: placeholder)
+        html_options = options.delete(:html_options)
+        futurize_with_options(extends: extends, placeholder: placeholder, partial: records_or_string, locals: options, html_options: html_options)
       else
         futurize_with_options(extends: extends, placeholder: placeholder, **options)
       end
@@ -15,37 +16,68 @@ module Futurism
     def futurize_with_options(extends:, placeholder:, **options)
       collection = options.delete(:collection)
       if collection.nil?
-        render_element(extends: extends, placeholder: placeholder, options: options)
+        Element.new(extends: extends, placeholder: placeholder, options: options).render
       else
         collection_class_name = collection.klass.name
         as = options.delete(:as) || collection_class_name.downcase
         collection.map { |record|
-          render_element(extends: extends, placeholder: placeholder, options: options.deep_merge(locals: {as.to_sym => record}))
+          Element.new(extends: extends, placeholder: placeholder, options: options.deep_merge(locals: {as.to_sym => record})).render
         }.join.html_safe
       end
     end
 
     def futurize_active_record(records, extends:, placeholder:, **options)
       Array(records).map { |record|
-        render_element(extends: extends, placeholder: placeholder, options: options.merge(model: record))
+        Element.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
       }.join.html_safe
     end
 
-    def render_element(extends:, options:, placeholder:)
-      html_options = options.delete(:html_options) || {}
-      model_or_options = options.delete(:model) || options
-      case extends
-      when :li
-        content_tag :li, placeholder, {data: {signed_params: futurism_signed_params(model_or_options)}, is: "futurism-li"}.merge(html_options)
-      when :tr
-        content_tag :tr, placeholder, {data: {signed_params: futurism_signed_params(model_or_options)}, is: "futurism-table-row"}.merge(html_options)
-      else
-        content_tag :"futurism-element", placeholder, {data: {signed_params: futurism_signed_params(model_or_options)}}.merge(html_options)
+    # wraps functionality for rendering a futurism element
+    class Element
+      include ActionView::Helpers
+
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options
+
+      def initialize(extends:, placeholder:, options:)
+        @extends = extends
+        @placeholder = placeholder
+        @html_options = options.delete(:html_options) || {}
+        @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
+        @model = options.delete(:model)
+        @options = data_attributes.any? ? options.merge(data: data_attributes) : options
       end
-    end
 
-    def futurism_signed_params(params)
-      Rails.application.message_verifier("futurism").generate(params)
+      def dataset
+        data_attributes.merge({
+          signed_params: signed_params,
+          sgid: model && model.to_sgid.to_s
+        })
+      end
+
+      def render
+        case extends
+        when :li
+          content_tag :li, placeholder, html_options.deep_merge({data: dataset, is: "futurism-li"})
+        when :tr
+          content_tag :tr, placeholder, html_options.deep_merge({data: dataset, is: "futurism-table-row"})
+        else
+          content_tag :"futurism-element", placeholder, html_options.deep_merge({data: dataset})
+        end
+      end
+
+      def transformed_options
+        require_relative "shims/deep_transform_values" unless options.respond_to? :deep_transform_values
+
+        options.deep_transform_values do |value|
+          value.is_a?(ActiveRecord::Base) && !value.new_record? ? value.to_global_id.to_s : value
+        end
+      end
+
+      private
+
+      def signed_params
+        Rails.application.message_verifier("futurism").generate(transformed_options)
+      end
     end
   end
 end

data/lib/futurism/helpers.rb~

@@ -1,13 +1,83 @@
-module FuturismHelper
-  def futurize(records, extends: :tr, &block)
-    placeholder = capture(&block)
-    Array(records).map { |record|
-      case extends
-      when :tr
-        content_tag :tr, placeholder, data: { sgid: record.to_sgid.to_s }, is: "futurism-table-row"
+module Futurism
+  module Helpers
+    def futurize(records_or_string = nil, extends:, **options, &block)
+      placeholder = capture(&block)
+
+      if records_or_string.is_a?(ActiveRecord::Base) || records_or_string.is_a?(ActiveRecord::Relation)
+        futurize_active_record(records_or_string, extends: extends, placeholder: placeholder, **options)
+      elsif records_or_string.is_a?(String)
+        html_options = options.delete(:html_options)
+        futurize_with_options(extends: extends, placeholder: placeholder, partial: records_or_string, locals: options, html_options: html_options)
       else
-        content_tag :"futurism-element", placeholder, data: { sgid: record.to_sgid.to_s }
+        futurize_with_options(extends: extends, placeholder: placeholder, **options)
       end
-    }.join.html_safe
+    end
+
+    def futurize_with_options(extends:, placeholder:, **options)
+      collection = options.delete(:collection)
+      if collection.nil?
+        Element.new(extends: extends, placeholder: placeholder, options: options).render
+      else
+        collection_class_name = collection.klass.name
+        as = options.delete(:as) || collection_class_name.downcase
+        collection.map { |record|
+          Element.new(extends: extends, placeholder: placeholder, options: options.deep_merge(locals: {as.to_sym => record})).render
+        }.join.html_safe
+      end
+    end
+
+    def futurize_active_record(records, extends:, placeholder:, **options)
+      Array(records).map { |record|
+        Element.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
+      }.join.html_safe
+    end
+
+    # wraps functionality for rendering a futurism element
+    class Element
+      include ActionView::Helpers
+
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options
+
+      def initialize(extends:, placeholder:, options:)
+        @extends = extends
+        @placeholder = placeholder
+        @html_options = options.delete(:html_options) || {}
+        @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
+        @model = options.delete(:model)
+        @options = data_attributes.any? ? options.merge(data: data_attributes) : options
+      end
+
+      def dataset
+        data_attributes.merge({
+          signed_params: signed_params,
+          sgid: model && model.to_sgid.to_s
+        })
+      end
+
+      def render
+        case extends
+        when :li
+          content_tag :li, placeholder, html_options.deep_merge({data: dataset, is: "futurism-li"})
+        when :tr
+          content_tag :tr, placeholder, html_options.deep_merge({data: dataset, is: "futurism-table-row"})
+        else
+          content_tag :"futurism-element", placeholder, html_options.deep_merge({data: dataset})
+        end
+      end
+
+      def transformed_options
+        require_relative "shims/deep_transform_values" unless options.respond_to? :deep_transform_values
+
+        options.deep_transform_values do |value|
+          value.is_a?(ActiveRecord::Base) ? value.to_global_id.to_s : value
+        end
+      end
+
+      private
+
+      def signed_params
+        Rails.application.message_verifier("futurism").generate(transformed_options)
+      end
+    end
   end
 end

data/lib/futurism/shims/deep_transform_values.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class Hash
+  # Returns a new hash with all values converted by the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #  hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #  hash.deep_transform_values{ |value| value.to_s.upcase }
+  #  # => {person: {name: "ROB", age: "28"}}
+  def deep_transform_values(&block)
+    _deep_transform_values_in_object(self, &block)
+  end
+
+  # Destructively converts all values by using the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  def deep_transform_values!(&block)
+    _deep_transform_values_in_object!(self, &block)
+  end
+
+  private
+
+  # Support methods for deep transforming nested hashes and arrays.
+  def _deep_transform_values_in_object(object, &block)
+    case object
+    when Hash
+      object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
+    when Array
+      object.map { |e| _deep_transform_values_in_object(e, &block) }
+    else
+      yield(object)
+    end
+  end
+
+  def _deep_transform_values_in_object!(object, &block)
+    case object
+    when Hash
+      object.transform_values! { |value| _deep_transform_values_in_object!(value, &block) }
+    when Array
+      object.map! { |e| _deep_transform_values_in_object!(e, &block) }
+    else
+      yield(object)
+    end
+  end
+end

data/lib/futurism/version.rb

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "0.3.2"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: cable_ready
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +184,7 @@ files:
 - lib/futurism/engine.rb
 - lib/futurism/helpers.rb
 - lib/futurism/helpers.rb~
+- lib/futurism/shims/deep_transform_values.rb
 - lib/futurism/version.rb
 - lib/tasks/futurism_tasks.rake
 - lib/tasks/futurism_tasks.rake~