futurism 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc887b3a3173cce8feec82e572327f820cdb39793b5ee5fd5977b6e32c1edb78
-  data.tar.gz: e0f429c1861f30754e91c3dcce1121bf95894f558792f15f7f72958006b01dea
+  metadata.gz: e784a06ccd2401b46d5a8a0cffd44e194e3a69db8c10439a7bb1eb0a7cfcf3d8
+  data.tar.gz: 763001a24e053f55745e7560ce0fe446256328a01c758efaa4a3eb65424cd40e
 SHA512:
-  metadata.gz: 603a65c0d08974feeaceb867e076ab69daf99e51a139fd8f9c2634d7e3b885a7f662ae1c2c32e0e2c31ec6e2dd1b55ec2df8ad385441abfe25d66a7088d30a21
-  data.tar.gz: 11d930242efc8ff82a7b495197b4c5fceb9a0a7cc4e89fc48d9464e05e85e7eb307b7a25dac85628e2a5f7e66e1427e960150f544b325552142fc1ececb5e7db
+  metadata.gz: 1486c1e9d54f3e380c675f1fb5f79ec9dc4753446209dae14bbef9a15600f1635d81b0fd75415067019efd5c4b3df6110785da951ef4cc5076d5b9ae13febffc
+  data.tar.gz: d68ab7a3c7909206e92644b2d7b3e227ddf2e4d5d0c7d787bffbc9766dc48115bb785bd923aecf5dc64244a74dd419bc930148968ff72c827f3bf21d9c199031

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-12-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
 
@@ -20,10 +20,12 @@ Lazy-load Rails partials via CableReady
   - [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)
@@ -122,6 +124,22 @@ Collection rendering is also possible:
 <% end %>
 ```
 
+#### Specifying Controller to Render
+
+You can also pass in the controller that will be used to render the partial.
+
+```erb
+<%= futurize partial: "items/card", collection: @cards, controller: MyController, extends: :div do %>
+  <div class="spinner"></div>
+<% end %>
+```
+
+By default (i.e. not passing in a value), futurize will use `ApplicationController`, but you may override by setting the Futurism default controller in an initializer, for example `config/initializers/futurism.rb`.
+
+```ruby
+Futurism.default_controller = MyController
+```
+
 ### HTML Options
 
 You can pass a hash of attribute/value pairs which will be mixed into the HTML markup for the placeholder element. This is important for layouts that require elements to have dimensionality. For example, many scripts calculate size based on element height and width. This option ensures that your elements have integrity, even if they are gone before you see them.
@@ -140,6 +158,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.
@@ -199,6 +230,15 @@ 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
@@ -217,6 +257,39 @@ to your environments.
 
 ## Contributing
 
+### Get local environment setup
+
+Below are a set of instructions that may help you get a local development environment working
+
+```shell
+# Get the gem/npm package source locally
+git clone futurism
+cd futurism/javascript
+yarn install # install all of the npm package's dependencies
+yarn link # set the local machine's futurism npm package's lookup to this local path
+
+# Setup a sample project, use the information below directly or use your own project
+git clone https://github.com/leastbad/stimulus_reflex_harness.git
+cd stimulus_reflex_harness
+git checkout futurism
+# Edit Gemfile to point point to local gem (e.g. `gem "futurism", path: "../futurism"`)
+# yarn link @minthesize/futurism
+
+
+# Do your work, Submit PR, Profit!
+
+
+# To stop using your local version of futurism
+# change your Gemfile back to the published (e.g. `gem "futurism"`)
+cd path/to/futurism/javascript
+# Stop using the local npm package
+yarn unlink
+
+# Instruct your project to reinstall the published version of the npm package
+cd path/to/project
+yarn install --force
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
@@ -243,6 +316,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <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

@@ -2,6 +2,7 @@ require "rails"
 require "action_cable"
 require "cable_ready"
 require "futurism/engine"
+require "futurism/message_verifier"
 require "futurism/channel"
 require "futurism/helpers"
 
@@ -10,6 +11,8 @@ module Futurism
 
   autoload :Helpers, "futurism/helpers"
 
+  mattr_accessor :skip_in_test, :default_controller
+
   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

@@ -1,6 +1,7 @@
 module Futurism
   class Channel < ActionCable::Channel::Base
     include CableReady::Broadcaster
+    include Futurism::MessageVerifier
 
     def stream_name
       ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
@@ -15,17 +16,22 @@ module Futurism
     end
 
     def receive(data)
-      resources = data.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
+      resources = data.fetch_values("signed_params", "sgids", "signed_controllers") { |_key| Array.new(data["signed_params"].length, nil) }.transpose
 
-      new_env = connection.env.merge(ApplicationController.renderer.instance_variable_get(:@env))
-      ApplicationController.renderer.instance_variable_set(:@env, new_env)
-
-      resources.each do |signed_params, sgid|
+      resources.each do |signed_params, sgid, signed_controller|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
+
+        controller_lookup = ControllerLookup.from(signed_string: signed_controller)
+        controller_lookup.setup_env!(connection: connection)
+        controller = controller_lookup.controller
+
+        resource = lookup_resource(signed_params: signed_params, sgid: sgid)
+        html = controller.render(resource)
+
         cable_ready[stream_name].outer_html(
           selector: selector,
-          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
+          html: html
         )
       end
 
@@ -34,10 +40,48 @@ module Futurism
 
     private
 
-    def resource(signed_params:, sgid:)
+    def lookup_resource(signed_params:, sgid:)
       return GlobalID::Locator.locate_signed(sgid) if sgid.present?
 
-      Rails.application.message_verifier("futurism").verify(signed_params)
+      message_verifier
+        .verify(signed_params)
+        .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
+    end
+
+    class ControllerLookup
+      include Futurism::MessageVerifier
+
+      def self.from(signed_string:)
+        new(signed_string)
+      end
+
+      def initialize(signed_string)
+        @signed_string = signed_string
+      end
+
+      def controller
+        if signed_string.present?
+          message_verifier
+            .verify(signed_string)
+            .to_s
+            .safe_constantize
+        else
+          default_controller
+        end
+      end
+
+      def setup_env!(connection:)
+        new_env = connection.env.merge(controller.renderer.instance_variable_get(:@env))
+        controller.renderer.instance_variable_set(:@env, new_env)
+      end
+
+      private
+
+      attr_reader :signed_string
+
+      def default_controller
+        Futurism.default_controller || ::ApplicationController
+      end
     end
   end
 end

data/lib/futurism/channel.rb~

@@ -1,23 +1,37 @@
 module Futurism
   class Channel < ActionCable::Channel::Base
     include CableReady::Broadcaster
+    include Futurism::MessageVerifier
+
+    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.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
-
-      new_env = connection.env.merge(ApplicationController.renderer.instance_variable_get(:@env))
-      ApplicationController.renderer.instance_variable_set(:@env, new_env)
+      resources = data.fetch_values("signed_params", "sgids", "signed_controllers") { |_key| Array.new(data["signed_params"].length, nil) }.transpose
 
-      resources.each do |signed_params, sgid|
+      resources.each do |signed_params, sgid, signed_controller|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
-        cable_ready["Futurism::Channel"].outer_html(
+
+        controller_lookup = ControllerLookup.from(signed_string: signed_controller)
+        controller_lookup.setup(connection: connection)
+        controller = controller_lookup.controller
+
+        resource = lookup_resource(signed_params: signed_params, sgid: sgid)
+        html = controller.render(resource)
+
+        cable_ready[stream_name].outer_html(
           selector: selector,
-          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
+          html: html
         )
       end
 
@@ -26,10 +40,48 @@ module Futurism
 
     private
 
-    def resource(signed_params:, sgid:)
+    def lookup_resource(signed_params:, sgid:)
       return GlobalID::Locator.locate_signed(sgid) if sgid.present?
 
-      Rails.application.message_verifier("futurism").verify(signed_params)
+      message_verifier
+        .verify(signed_params)
+        .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
+    end
+
+    class ControllerLookup
+      include Futurism::MessageVerifier
+
+      def self.from(signed_string:)
+        new(signed_string)
+      end
+
+      def initialize(signed_string)
+        @signed_string = signed_string
+      end
+
+      def controller
+        if signed_string.present?
+          message_verifier
+            .verify(signed_string)
+            .to_s
+            .safe_constantize
+        else
+          default_controller
+        end
+      end
+
+      def setup(connection:)
+        new_env = connection.env.merge(controller.renderer.instance_variable_get(:@env))
+        controller.renderer.instance_variable_set(:@env, new_env)
+      end
+
+      private
+
+      attr_reader :signed_string
+
+      def default_controller
+        Futurism.default_controller || ::ApplicationController
+      end
     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)
@@ -35,12 +43,15 @@ module Futurism
     # wraps functionality for rendering a futurism element
     class Element
       include ActionView::Helpers
+      include Futurism::MessageVerifier
 
-      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :controller
 
       def initialize(extends:, placeholder:, options:)
         @extends = extends
         @placeholder = placeholder
+        @eager = options.delete(:eager)
+        @controller = options.delete(:controller)
         @html_options = options.delete(:html_options) || {}
         @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
         @model = options.delete(:model)
@@ -50,7 +61,9 @@ module Futurism
       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,
+          signed_controller: signed_controller
         })
       end
 
@@ -65,10 +78,24 @@ module Futurism
         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)
+        message_verifier.generate(transformed_options)
+      end
+
+      def signed_controller
+        return unless controller.present?
+
+        message_verifier.generate(controller.to_s)
       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/message_verifier.rb

@@ -0,0 +1,9 @@
+module Futurism
+  module MessageVerifier
+    private
+
+    def message_verifier
+      @message_verifier ||= Rails.application.message_verifier("futurism")
+    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.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2020-10-12 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
@@ -161,7 +175,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/futurism_manifest.js
 - config/routes.rb
 - lib/futurism.rb
 - lib/futurism.rb~
@@ -170,6 +183,8 @@ files:
 - lib/futurism/engine.rb
 - lib/futurism/helpers.rb
 - lib/futurism/helpers.rb~
+- lib/futurism/message_verifier.rb
+- lib/futurism/shims/deep_transform_values.rb
 - lib/futurism/version.rb
 - lib/tasks/futurism_tasks.rake
 - lib/tasks/futurism_tasks.rake~