futurism 0.5.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28d6dcb8e42dba12b2e5064b8734578bffbd9c2ec65418361147ebe381369eab
-  data.tar.gz: 4356920e35812c99ead70f5ac3729cd9cb3d7b9e711ab9ee1f0e4b98d6524289
+  metadata.gz: 8bbd52daa2dfe15d3a6dc9c9e374d6be65299a42a7ee3975cee51838811f7783
+  data.tar.gz: 29bcba992840173fe09f1e67ecdfa387dfedc8b8574d1ef988a4f98b55142bd2
 SHA512:
-  metadata.gz: 5b67fcc1166aed81f6f791ed1253d2cc506f2dbdab8f0267eac4fce2983d7923284781f272e29e175aff82214eb4874119d2b3a98900195e345aca8b828a0ad1
-  data.tar.gz: '009c498af95bef5c56c76e5b026b60979a58bb5edaece53005664f75020254108af0d523ffda646af05118bce1f2251aea0600abf6e554cbcc89245dcdca933c'
+  metadata.gz: 6efdbccf19c4c0b9a16f92f8461cb9fb8153796b81f6cbdd981e7d16779cca93a907033fbff2dac3bd354a22335e22d014a46f14bda18d4ad973605447ef1f20
+  data.tar.gz: b642b4d646ae5b1047330a833f7d4c7eeb8c684f15337835afc1b56f5d1b51cf0fea9ac9234a693562152b92d09f5febea8eb415b0aa4a8c97a77c96ae2cd42f

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" # to avoid the controller from trying to autoload at boot, provide as a string
+```
+
 ### 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,9 @@ require "rails"
 require "action_cable"
 require "cable_ready"
 require "futurism/engine"
+require "futurism/message_verifier"
+require "futurism/resolver/controller"
+require "futurism/resolver/controller/renderer"
 require "futurism/channel"
 require "futurism/helpers"
 
@@ -10,6 +13,13 @@ module Futurism
 
   autoload :Helpers, "futurism/helpers"
 
+  mattr_accessor :skip_in_test, default: false
+
+  mattr_writer :default_controller
+  def self.default_controller
+    (@@default_controller || "::ApplicationController").to_s.constantize
+  end
+
   ActiveSupport.on_load(:action_view) {
     include Futurism::Helpers
   }

data/lib/futurism.rb~

@@ -1,5 +1,26 @@
+require "rails"
+require "action_cable"
+require "cable_ready"
 require "futurism/engine"
+require "futurism/message_verifier"
+require "futurism/resolver/controller"
+require "futurism/resolver/controller/renderer"
+require "futurism/channel"
+require "futurism/helpers"
 
 module Futurism
-  # Your code goes here...
+  extend ActiveSupport::Autoload
+
+  autoload :Helpers, "futurism/helpers"
+
+  mattr_accessor :skip_in_test, default: false
+
+  mattr_writer :default_controller
+  def self.default_controller
+    (@@default_controller || "::ApplicationController").to_s.constantize
+  end
+
+  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,24 @@ 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", "urls") { |_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, url|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
+
+        controller = Resolver::Controller.from(signed_string: signed_controller)
+        renderer = Resolver::Controller::Renderer.for(controller: controller,
+                                                      connection: connection,
+                                                      url: url,
+                                                      params: @params)
+
+        resource = lookup_resource(signed_params: signed_params, sgid: sgid)
+        html = renderer.render(resource)
+
         cable_ready[stream_name].outer_html(
           selector: selector,
-          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
+          html: html
         )
       end
 
@@ -34,12 +42,10 @@ 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")
+      message_verifier
         .verify(signed_params)
         .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
     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,24 @@ 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", "urls") { |_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, url|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
+
+        controller = Resolver::Controller.from(signed_string: signed_controller)
+        renderer = Resolver::Controller::Renderer.for(controller: controller,
+                                                      connection: connection,
+                                                      url: url,
+                                                      params: @params)
+
+        resource = lookup_resource(signed_params: signed_params, sgid: sgid)
+        html = renderer.render(resource)
+
         cable_ready[stream_name].outer_html(
           selector: selector,
-          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
+          html: html
         )
       end
 
@@ -34,12 +42,10 @@ 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")
+      message_verifier
         .verify(signed_params)
         .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
     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
 
@@ -76,7 +89,13 @@ module Futurism
       private
 
       def signed_params
-        Rails.application.message_verifier("futurism").generate(transformed_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,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
 
@@ -69,14 +82,20 @@ module Futurism
         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
+          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)
+        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/message_verifier.rb

@@ -0,0 +1,11 @@
+module Futurism
+  module MessageVerifier
+    def self.message_verifier
+      @message_verifier ||= Rails.application.message_verifier("futurism")
+    end
+
+    def message_verifier
+      @message_verifier ||= Rails.application.message_verifier("futurism")
+    end
+  end
+end

data/lib/futurism/resolver/controller.rb

@@ -0,0 +1,17 @@
+module Futurism
+  module Resolver
+    class Controller
+      def self.from(signed_string:)
+        if signed_string.present?
+          Futurism::MessageVerifier
+            .message_verifier
+            .verify(signed_string)
+            .to_s
+            .safe_constantize
+        else
+          Futurism.default_controller
+        end
+      end
+    end
+  end
+end

data/lib/futurism/resolver/controller.rb~

@@ -0,0 +1,17 @@
+module Futurism
+  module Resolver
+    class Controller
+      def self.from(signed_string:)
+        if signed_string.present?
+          Futurism::MessageVerifier
+            .message_verifier
+            .verify(signed_string)
+            .to_s
+            .safe_constantize
+        else
+          Futurism.default_controller
+        end
+      end
+    end
+  end
+end

data/lib/futurism/resolver/controller/renderer.rb

@@ -0,0 +1,57 @@
+module Futurism
+  module Resolver
+    class Controller
+      class Renderer
+        def self.for(controller:, connection:, url:, params:)
+          new(controller: controller, connection: connection, url: url, params: params).renderer
+        end
+
+        def initialize(controller:, connection:, url:, params:)
+          @controller = controller
+          @connection = connection
+          @url = url || ""
+          @params = params || {}
+
+          setup_env!
+        end
+
+        def renderer
+          @renderer ||= controller.renderer
+        end
+
+        private
+
+        attr_reader :controller, :connection, :url, :params
+        attr_writer :renderer
+
+        def setup_env!
+          if url.present?
+            uri = URI.parse(url)
+            path = ActionDispatch::Journey::Router::Utils.normalize_path(uri.path)
+            query_hash = Rack::Utils.parse_nested_query(uri.query)
+
+            path_params = Rails.application.routes.recognize_path(path)
+
+            self.renderer =
+              renderer.new(
+                "rack.request.query_hash" => query_hash,
+                "rack.request.query_string" => uri.query,
+                "ORIGINAL_SCRIPT_NAME" => "",
+                "ORIGINAL_FULLPATH" => path,
+                Rack::SCRIPT_NAME => "",
+                Rack::PATH_INFO => path,
+                Rack::REQUEST_PATH => path,
+                Rack::QUERY_STRING => uri.query,
+                ActionDispatch::Http::Parameters::PARAMETERS_KEY => params.symbolize_keys.merge(path_params).merge(query_hash)
+              )
+          end
+
+          # Copy connection env to renderer to fix some RACK related issues from gems like
+          # Warden or Devise
+          new_env = connection.env.merge(renderer.instance_variable_get(:@env))
+          renderer.instance_variable_set(:@env, new_env)
+        end
+      end
+    end
+  end
+end

data/lib/futurism/resolver/controller/renderer.rb~

@@ -0,0 +1,57 @@
+module Futurism
+  module Resolver
+    class Controller
+      class Renderer
+        def self.for(controller:, connection:, url:, params:)
+          new(controller: controller, connection: connection, url: url, params: params).renderer
+        end
+
+        def initialize(controller:, connection:, url:, params:)
+          @controller = controller
+          @connection = connection
+          @url = url || ""
+          @params = params || {}
+
+          setup_env!
+        end
+
+        def renderer
+          @renderer ||= controller.renderer
+        end
+
+        private
+
+        attr_reader :controller, :connection, :url, :params
+        attr_writer :renderer
+
+        def setup_env!
+          if url.present?
+            uri = URI.parse(url)
+            path = ActionDispatch::Journey::Router::Utils.normalize_path(uri.path)
+            query_hash = Rack::Utils.parse_nested_query(uri.query)
+
+            path_params = Rails.application.routes.recognize_path(path)
+
+            self.renderer =
+              renderer.new(
+                "rack.request.query_hash" => query_hash,
+                "rack.request.query_string" => uri.query,
+                "ORIGINAL_SCRIPT_NAME" => "",
+                "ORIGINAL_FULLPATH" => path,
+                Rack::SCRIPT_NAME => "",
+                Rack::PATH_INFO => path,
+                Rack::REQUEST_PATH => path,
+                Rack::QUERY_STRING => uri.query,
+                ActionDispatch::Http::Parameters::PARAMETERS_KEY => path_params.reverse_merge(path_params)
+              )
+          end
+
+          # Copy connection env to renderer to fix some RACK related issues from gems like
+          # Warden or Devise
+          new_env = connection.env.merge(renderer.instance_variable_get(:@env))
+          renderer.instance_variable_set(:@env, new_env)
+        end
+      end
+    end
+  end
+end

data/lib/futurism/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-27 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -108,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: spy
-  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: rack
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +161,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/futurism_manifest.js
 - config/routes.rb
 - lib/futurism.rb
 - lib/futurism.rb~
@@ -184,6 +169,11 @@ files:
 - lib/futurism/engine.rb
 - lib/futurism/helpers.rb
 - lib/futurism/helpers.rb~
+- lib/futurism/message_verifier.rb
+- lib/futurism/resolver/controller.rb
+- lib/futurism/resolver/controller.rb~
+- lib/futurism/resolver/controller/renderer.rb
+- lib/futurism/resolver/controller/renderer.rb~
 - lib/futurism/shims/deep_transform_values.rb
 - lib/futurism/version.rb
 - lib/tasks/futurism_tasks.rake