futurism 0.4.0 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba66b2cb1a12fb863e2e0fc34798411d7f95947a197496150e1a499582fc4e28
-  data.tar.gz: 3f7f290ef2b0b79f9c9e5100e7eaed2520dcb8e481e391bd537649d0023d379b
+  metadata.gz: 4e79c03c8d157585784ab3e4f48d2660100acad4e317aa378cdfa94a0c5a3fb9
+  data.tar.gz: 5036367ba790b660ef6230e6155192cfedd65973fa65e00fd7b53f071f8a6ae8
 SHA512:
-  metadata.gz: e772253cf0ed802d14c6836c0fb7285f7011f79f516fa88cc85e13191b7de0f29ebbc0edbd5c7996f4f858ec4efe4890613605587a2cbd6c17c4ecbad05b4985
-  data.tar.gz: cf4db9dd38a545a7fe43381dc22597a4c5e77a4023698b19017740fa996e6aa0433e1927c115a1187bb9028ad26e2b36aa3ecd9f66fb19000380a6b6467efffb
+  metadata.gz: cf2acd22c20fd40897b6caed2ad897eec3cc98f7ea1fbd9ab31ea19cf276cfa2f94f04ef87a16fe8c68ec03dab1e4e5832a1f4026fe269c58b8114dd1aecb54a
+  data.tar.gz: bda0591fb9174ebd6499839be5bfdb8512d8c7c110b9af837f6d8425eb6e9180384234fd493df1945fe51c021c2a0ab0e8ee5537238babd00617ca9bf4a16d8b

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-13-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 Lazy-load Rails partials via CableReady
 
@@ -10,6 +10,27 @@ 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)
+  - [Eager Loading](#eager-loading)
+- [Events](#events)
+- [Installation](#installation)
+  - [Manual Installation](#manual-installation)
+- [Authentication](#authentication)
+- [Testing](#testing)
+- [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)
@@ -121,6 +142,19 @@ This will output the following:
 </tr>
 ```
 
+### Eager Loading
+It may sound surprising to support eager loading in a lazy loading library :joy:, but there's a quite simple use case:
+
+Suppose you have some hidden interactive portion of your page, like a tab or dropdown. You don't want its content to block the initial page load, but once that is done, you occasionally don't want to wait for the element to become visible and trigger the `IntersectionObserver`, you want to lazy load its contents right after it's added to the DOM.
+
+Futurism makes that dead simple:
+
+```erb
+<%= futurize 'some_tab', eager: true, extends: :tr do %>
+  <div class="placeholder"</td>
+<% end %>
+```
+
 ## Events
 
 Once your futurize element has been rendered, the `futurize:appeared` custom event will be called.
@@ -155,7 +189,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 +197,48 @@ 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.
+
+## Testing
+In Rails system tests there is a chance that flaky errors will occur due to Capybara not waiting for the placeholder elements to be replaced. To overcome this, add the flag
+
+```ruby
+Futurism.skip_in_test = true
+```
+
+to an initializer, for example `config/initializers/futurism.rb`.
+
+## 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
@@ -189,6 +265,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <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>
+    <td align="center"><a href="http://domchristie.co.uk"><img src="https://avatars0.githubusercontent.com/u/111734?v=4" width="100px;" alt=""/><br /><sub><b>Dom Christie</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/pulls?q=is%3Apr+reviewed-by%3Adomchristie" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="http://www.rickychilcott.com"><img src="https://avatars1.githubusercontent.com/u/445759?v=4" width="100px;" alt=""/><br /><sub><b>Ricky Chilcott</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/pulls?q=is%3Apr+reviewed-by%3Arickychilcott" title="Reviewed Pull Requests">👀</a></td>
   </tr>
 </table>
 

data/lib/futurism.rb

@@ -10,6 +10,8 @@ module Futurism
 
   autoload :Helpers, "futurism/helpers"
 
+  mattr_accessor :skip_in_test
+
   ActiveSupport.on_load(:action_view) {
     include Futurism::Helpers
   }

data/lib/futurism.rb~

@@ -1,5 +1,16 @@
+require "rails"
+require "action_cable"
+require "cable_ready"
 require "futurism/engine"
+require "futurism/channel"
+require "futurism/helpers"
 
 module Futurism
-  # Your code goes here...
+  extend ActiveSupport::Autoload
+
+  autoload :Helpers, "futurism/helpers"
+
+  ActiveSupport.on_load(:action_view) {
+    include Futurism::Helpers
+  }
 end

data/lib/futurism/channel.rb

@@ -2,8 +2,16 @@ 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)
@@ -15,7 +23,7 @@ module Futurism
       resources.each do |signed_params, sgid|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
-        cable_ready["Futurism::Channel"].outer_html(
+        cable_ready[stream_name].outer_html(
           selector: selector,
           html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
         )
@@ -29,7 +37,11 @@ module Futurism
     def resource(signed_params:, sgid:)
       return GlobalID::Locator.locate_signed(sgid) if sgid.present?
 
-      Rails.application.message_verifier("futurism").verify(signed_params)
+      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,8 +2,16 @@ 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)
@@ -15,7 +23,7 @@ module Futurism
       resources.each do |signed_params, sgid|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
-        cable_ready["Futurism::Channel"].outer_html(
+        cable_ready[stream_name].outer_html(
           selector: selector,
           html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
         )
@@ -29,7 +37,11 @@ module Futurism
     def resource(signed_params:, sgid:)
       return GlobalID::Locator.locate_signed(sgid) if sgid.present?
 
-      Rails.application.message_verifier("futurism").verify(signed_params)
+      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

@@ -1,6 +1,14 @@
 module Futurism
   module Helpers
     def futurize(records_or_string = nil, extends:, **options, &block)
+      if Rails.env.test? && Futurism.skip_in_test
+        if records_or_string.nil?
+          return render **options
+        else
+          return render records_or_string, **options
+        end
+      end
+
       placeholder = capture(&block)
 
       if records_or_string.is_a?(ActiveRecord::Base) || records_or_string.is_a?(ActiveRecord::Relation)
@@ -36,38 +44,49 @@ module Futurism
     class Element
       include ActionView::Helpers
 
-      attr_reader :extends, :placeholder, :html_options, :model, :options
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager
 
       def initialize(extends:, placeholder:, options:)
         @extends = extends
         @placeholder = placeholder
+        @eager = options.delete(:eager)
         @html_options = options.delete(:html_options) || {}
+        @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
         @model = options.delete(:model)
-        @options = options
+        @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
-        }
+          sgid: model && model.to_sgid.to_s,
+          eager: eager.presence
+        })
       end
 
       def render
         case extends
         when :li
-          content_tag :li, placeholder, {data: dataset, is: "futurism-li"}.merge(html_options)
+          content_tag :li, placeholder, html_options.deep_merge({data: dataset, is: "futurism-li"})
         when :tr
-          content_tag :tr, placeholder, {data: dataset, is: "futurism-table-row"}.merge(html_options)
+          content_tag :tr, placeholder, html_options.deep_merge({data: dataset, is: "futurism-table-row"})
         else
-          content_tag :"futurism-element", placeholder, {data: dataset}.merge(html_options)
+          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(options)
+        Rails.application.message_verifier("futurism").generate(transformed_options)
       end
     end
   end

data/lib/futurism/helpers.rb~

@@ -1,12 +1,22 @@
 module Futurism
   module Helpers
     def futurize(records_or_string = nil, extends:, **options, &block)
+      if Rails.env.test? && Futurism.skip_in_test
+        if records_or_string.nil?
+          render options
+        else
+          render records_or_string, options
+        end
+        return
+      end
+
       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)
-        futurize_with_options(extends: extends, placeholder: placeholder, partial: records_or_string, **options)
+        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
@@ -35,38 +45,49 @@ module Futurism
     class Element
       include ActionView::Helpers
 
-      attr_reader :extends, :placeholder, :html_options, :model, :options
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager
 
       def initialize(extends:, placeholder:, options:)
         @extends = extends
         @placeholder = placeholder
+        @eager = options.delete(:eager)
         @html_options = options.delete(:html_options) || {}
+        @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
         @model = options.delete(:model)
-        @options = options
+        @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
-        }
+          sgid: model && model.to_sgid.to_s,
+          eager: eager.presence
+        })
       end
 
       def render
         case extends
         when :li
-          content_tag :li, placeholder, {data: dataset, is: "futurism-li"}.merge(html_options)
+          content_tag :li, placeholder, html_options.deep_merge({data: dataset, is: "futurism-li"})
         when :tr
-          content_tag :tr, placeholder, {data: dataset, is: "futurism-table-row"}.merge(html_options)
+          content_tag :tr, placeholder, html_options.deep_merge({data: dataset, is: "futurism-table-row"})
         else
-          content_tag :"futurism-element", placeholder, {data: dataset}.merge(html_options)
+          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(options)
+        Rails.application.message_verifier("futurism").generate(transformed_options)
       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.4.0"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.4
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2020-10-09 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~