RubyGems - futurism - Versions diffs - 0.7.2 → 1.1.0 - Mend

futurism 0.7.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +4 -4
data/README.md +73 -22
data/lib/futurism/channel.rb +5 -25
data/lib/futurism/channel.rb~ +2 -24
data/lib/futurism/helpers.rb +31 -15
data/lib/futurism/helpers.rb~ +31 -16
data/lib/futurism/resolver/controller/renderer.rb +20 -1
data/lib/futurism/resolver/resources.rb +101 -0
data/lib/futurism/resolver/resources.rb~ +97 -0
data/lib/futurism/version.rb +1 -1
data/lib/futurism/version.rb~ +3 -0
data/lib/futurism.rb +6 -2
data/lib/tasks/futurism_tasks.rake +2 -2
data/lib/tasks/futurism_tasks.rake~ +39 -4
metadata +6 -17

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010431b087816c5ad0289d895d9206e6fc88382fa1f291fc4deb36d2c2910b42
-  data.tar.gz: ea1d6fd1574cabc5e91dc0d81dba80d0f64d05e9efdaf928614a457f2cc4b1d5
+  metadata.gz: 591fcd6ac1487dba8088003e9890f285336699ca85e4c54a42d8cc870c75a094
+  data.tar.gz: 1acc85f2deb6f879104a8010581a42eeed05692154ef0fba7fc0f0858d88afcd
 SHA512:
-  metadata.gz: 399ad5f2f189e569eeb031b3976137d5f9d66ee1a46c0c70ec5dd1e421817c99d525755bb16dd73146d49c15392cd2e6ea75e9f2fe44f82878b7a56e996856f8
-  data.tar.gz: bcd8cf6da3d6ce6557dee1d1dcb429beb49642bfaa9753a24d122265e43350022cf5bdd48b259732b4a91a7bb18d266feaa9a2819c800f8709f84eae5c9b86f9
+  metadata.gz: f037cca43c70ba733a81fe366b6af3885e262318cf3333194e756a7593d9e7df729bc651e6b37071607fe954f2baf77fac2eb7c6f027cd94daa2a29dc5d99df8
+  data.tar.gz: cd1ae23d900d3e594cbb4f351afda32e96847eb3be9d263559f6540c1b306b24675315d87c4575cf17d60c4ed72675786a19e150ed5534ad18e98b29754c3b58

data/README.md CHANGED Viewed

@@ -1,11 +1,11 @@
 # 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-13-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 Lazy-load Rails partials via CableReady
-:rotating_light: *Futurism is still in pre-1.0 state. As much as I hope to keep the API backwards-compatible, I cannot guarantee it* :rotating_light:
+:rotating_light: *BREAKING CHANGE: With v1.0, futurism has been transferred to the [stimulusreflex](https://github.com/stimulusreflex) organization. Please update your npm package to `@stimulus_reflex/futurism` accordingly* :rotating_light:
 <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>
@@ -21,6 +21,8 @@ Lazy-load Rails partials via CableReady
   - [Explicit Partial](#explicit-partial)
   - [HTML Options](#html-options)
   - [Eager Loading](#eager-loading)
+  - [Broadcast Partials Individually](#broadcast-partials-individually)
+  - [Contextual Placeholder Arguments](#contextual-placeholder-arguments)
 - [Events](#events)
 - [Installation](#installation)
   - [Manual Installation](#manual-installation)
@@ -33,7 +35,7 @@ Lazy-load Rails partials via CableReady
 ## Facts
 - only one dependency: CableReady
-- bundle size (without CableReady) is around [~1.04kB](https://bundlephobia.com/result?p=@minthesize/futurism@0.1.3)
+- bundle size (without CableReady) is around [~2.46kB](https://bundlephobia.com/result?p=@stimulus_reflex/futurism@0.7.2)
 ### Browser Support
@@ -68,6 +70,8 @@ You can pass the placeholder as a block:
 ![aa601dec1930151f71dbf0d6b02b61c9](https://user-images.githubusercontent.com/4352208/87131629-f768a480-c294-11ea-89a9-ea0a76ee06ef.gif)
+You can also omit the placeholder, which falls back to [eager loading](#eager-loading).
 ## API
 Currently there are two ways to call `futurize`, designed to wrap `render`'s behavior:
@@ -171,6 +175,41 @@ Futurism makes that dead simple:
 <% end %>
 ```
+### Broadcast Partials Individually
+Futurism's default behavior is to `broadcast` partials as they are generated in batches:
+On the client side, `IntersectionObserver` events are triggered in a debounced fashion, so several `render`s are performed on the server for each of those events. By default, futurism will group those to a single `broadcast` call (to save server CPU time).
+For collections, however, you can opt into individual broadcasts by specifying `broadcast_each: true` in your helper usage:
+```erb
+<%= futurize @posts, broadcast_each: true, extends: :tr do %>
+  <div class="placeholder"</td>
+<% end %>
+```
+## Contextual Placeholder Arguments
+For individual models or arbitrary collections, you can pass `record` and `index` to the placeholder block as arguments:
+```erb
+<%= futurize @post, extends: :div do |post| %>
+  <div><%= post.title %></div>
+<% end %>
+```
+```erb
+<%= futurize @posts, extends: :tr do |post, index| %>
+  <td><%= index + 1 %></td><td><%= post.title %></td>
+<% end %>
+```
+```erb
+<%= futurize partial: "users/user", collection: users, extends: "tr" do |user, index| %>
+  <td><%= index + 1 %></td><td><%= user.name %></td>
+<% end >
+```
 ## Events
 Once your futurize element has been rendered, the `futurize:appeared` custom event will be called.
@@ -193,19 +232,19 @@ To copy over the javascript files to your application, run
 $ bin/rails futurism:install
 ```
-**! Note that the installer will run `yarn add @minthesize/futurism` for you !**
+**! Note that the installer will run `yarn add @stimulus_reflex/futurism` for you !**
 ### Manual Installation
 After `bundle`, install the Javascript library:
 ```bash
-$ bin/yarn add @minthesize/futurism
+$ bin/yarn add @stimulus_reflex/futurism
 ```
 In your `app/javascript/channels/index.js`, add the following
 ```js
-import * as Futurism from '@minthesize/futurism'
+import * as Futurism from '@stimulus_reflex/futurism'
 import consumer from './consumer'
@@ -273,7 +312,7 @@ 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
+# yarn link @stimulus_reflex/futurism
 # Do your work, Submit PR, Profit!
@@ -290,6 +329,14 @@ cd path/to/project
 yarn install --force
 ```
+### Release
+1. Update the version numbers in `javascript/package.json` and `lib/futurism/version.rb`
+2. `git commit -m "Bump version to x.x.x"`
+3. Run `bundle exec rake build`
+4. Run `bundle exec rake release`
+5. `cd javascript && npm publish --access public`
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -302,27 +349,31 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="http://www.julianrubisch.at"><img src="https://avatars0.githubusercontent.com/u/4352208?v=4" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=julianrubisch" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/darkrubyist"><img src="https://avatars2.githubusercontent.com/u/11207292?v=4" width="100px;" alt=""/><br /><sub><b>darkrubyist</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=darkrubyist" title="Code">💻</a> <a href="https://github.com/julianrubisch/futurism/commits?author=darkrubyist" title="Documentation">📖</a></td>
-    <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> <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>
+    <td align="center"><a href="http://www.julianrubisch.at"><img src="https://avatars0.githubusercontent.com/u/4352208?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/stimulusreflex/futurism/commits?author=julianrubisch" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/darkrubyist"><img src="https://avatars2.githubusercontent.com/u/11207292?v=4?s=100" width="100px;" alt=""/><br /><sub><b>darkrubyist</b></sub></a><br /><a href="https://github.com/stimulusreflex/futurism/commits?author=darkrubyist" title="Code">💻</a> <a href="https://github.com/stimulusreflex/futurism/commits?author=darkrubyist" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://ParamagicDev.github.io/portfolio"><img src="https://avatars2.githubusercontent.com/u/26425882?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Konnor Rogers</b></sub></a><br /><a href="https://github.com/stimulusreflex/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?s=100" 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?s=100" width="100px;" alt=""/><br /><sub><b>Chris Oliver</b></sub></a><br /><a href="https://github.com/stimulusreflex/futurism/commits?author=excid3" title="Code">💻</a> <a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>leastbad</b></sub></a><br /><a href="https://github.com/stimulusreflex/futurism/commits?author=leastbad" title="Code">💻</a> <a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>M. E. Patterson</b></sub></a><br /><a href="https://github.com/stimulusreflex/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>
-    <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>
+    <td align="center"><a href="http://fractaledmind.com"><img src="https://avatars3.githubusercontent.com/u/5077225?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stephen Margheim</b></sub></a><br /><a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>Hassanin Ahmed</b></sub></a><br /><a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>Marco Roth</b></sub></a><br /><a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>Viedit com</b></sub></a><br /><a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>Scott Barrow</b></sub></a><br /><a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>Dom Christie</b></sub></a><br /><a href="https://github.com/stimulusreflex/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?s=100" width="100px;" alt=""/><br /><sub><b>Ricky Chilcott</b></sub></a><br /><a href="https://github.com/stimulusreflex/futurism/pulls?q=is%3Apr+reviewed-by%3Arickychilcott" title="Reviewed Pull Requests">👀</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/mansakondo"><img src="https://avatars.githubusercontent.com/u/47113995?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mansakondo</b></sub></a><br /><a href="https://github.com/stimulusreflex/futurism/commits?author=mansakondo" title="Code">💻</a></td>
   </tr>
 </table>
-<!-- markdownlint-enable -->
+<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/lib/futurism/channel.rb CHANGED Viewed

@@ -1,7 +1,6 @@
 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) }
@@ -16,38 +15,19 @@ module Futurism
     end
     def receive(data)
-      resources = data.fetch_values("signed_params", "sgids", "signed_controllers", "urls") { |_key| Array.new(data["signed_params"].length, nil) }.transpose
-      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)
+      resources = data.fetch_values("signed_params", "sgids", "signed_controllers", "urls", "broadcast_each") { |_key| Array.new(data["signed_params"].length, nil) }.transpose
+      resolver = Resolver::Resources.new(resource_definitions: resources, connection: connection, params: @params)
+      resolver.resolve do |selector, html, broadcast_each|
         cable_ready[stream_name].outer_html(
           selector: selector,
           html: html
         )
+        cable_ready.broadcast if broadcast_each
       end
       cable_ready.broadcast
     end
-    private
-    def lookup_resource(signed_params:, sgid:)
-      return GlobalID::Locator.locate_signed(sgid) if sgid.present?
-      message_verifier
-        .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~ CHANGED Viewed

@@ -1,7 +1,6 @@
 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) }
@@ -18,19 +17,8 @@ module Futurism
     def receive(data)
       resources = data.fetch_values("signed_params", "sgids", "signed_controllers", "urls") { |_key| Array.new(data["signed_params"].length, nil) }.transpose
-      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)
+      resolver = Resolver::Resources.new(resource_definitions: resources, connection: connection, params: @params)
+      resolver.resolve do |selector, html|
         cable_ready[stream_name].outer_html(
           selector: selector,
           html: html
@@ -39,15 +27,5 @@ module Futurism
       cable_ready.broadcast
     end
-    private
-    def lookup_resource(signed_params:, sgid:)
-      return GlobalID::Locator.locate_signed(sgid) if sgid.present?
-      message_verifier
-        .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 CHANGED Viewed

@@ -9,48 +9,60 @@ module Futurism
         end
       end
-      placeholder = capture(&block)
+      options[:eager] = true unless block_given?
       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)
+        futurize_active_record(records_or_string, extends: extends, **options, &block)
       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)
+        futurize_with_options(extends: extends, partial: records_or_string, locals: options, html_options: html_options, &block)
       else
-        futurize_with_options(extends: extends, placeholder: placeholder, **options)
+        futurize_with_options(extends: extends, **options, &block)
       end
     end
-    def futurize_with_options(extends:, placeholder:, **options)
+    def futurize_with_options(extends:, **options, &block)
       collection = options.delete(:collection)
       if collection.nil?
-        Element.new(extends: extends, placeholder: placeholder, options: options).render
+        placeholder = capture(&block) if block_given?
+        WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options).render
       else
-        collection_class_name = collection.klass.name
-        as = options.delete(:as) || collection_class_name.downcase
+        collection_class_name = collection.try(:klass).try(:name) || collection.first.class.to_s
+        as = options.delete(:as) || collection_class_name.underscore
+        broadcast_each = options.delete(:broadcast_each) || false
         collection.each_with_index.map { |record, index|
-          Element.new(extends: extends, placeholder: placeholder, options: options.deep_merge(locals: {as.to_sym => record, "#{as}_counter".to_sym => index})).render
+          placeholder = capture(record, index, &block) if block_given?
+          WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options.deep_merge(
+            broadcast_each: broadcast_each,
+            locals: {as.to_sym => record, "#{as}_counter".to_sym => index}
+          )).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
+    def futurize_active_record(records, extends:, **options, &block)
+      Array(records).map.with_index { |record, index|
+        placeholder = capture(record, index, &block) if block_given?
+        WrappingFuturismElement.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
       }.join.html_safe
     end
     # wraps functionality for rendering a futurism element
-    class Element
+    class WrappingFuturismElement
       include ActionView::Helpers
       include Futurism::MessageVerifier
-      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :controller
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :broadcast_each, :controller
       def initialize(extends:, placeholder:, options:)
         @extends = extends
         @placeholder = placeholder
         @eager = options.delete(:eager)
+        @broadcast_each = options.delete(:broadcast_each)
         @controller = options.delete(:controller)
         @html_options = options.delete(:html_options) || {}
         @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
@@ -63,6 +75,7 @@ module Futurism
           signed_params: signed_params,
           sgid: model && model.to_sgid.to_s,
           eager: eager.presence,
+          broadcast_each: broadcast_each.presence,
           signed_controller: signed_controller
         })
       end
@@ -82,7 +95,10 @@ 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.new_record? ? value.to_global_id.to_s : value
+          next(value) unless value.respond_to?(:to_global_id)
+          next(value) if value.is_a?(ActiveRecord::Base) && value.new_record?
+          value.to_global_id.to_s
         end
       end

data/lib/futurism/helpers.rb~ CHANGED Viewed

@@ -9,48 +9,59 @@ module Futurism
         end
       end
-      placeholder = capture(&block)
+      options[:eager] = true unless block_given?
       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)
+        futurize_active_record(records_or_string, extends: extends, **options, &block)
       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)
+        futurize_with_options(extends: extends, partial: records_or_string, locals: options, html_options: html_options, &block)
       else
-        futurize_with_options(extends: extends, placeholder: placeholder, **options)
+        futurize_with_options(extends: extends, **options, &block)
       end
     end
-    def futurize_with_options(extends:, placeholder:, **options)
+    def futurize_with_options(extends:, **options, &block)
       collection = options.delete(:collection)
       if collection.nil?
-        Element.new(extends: extends, placeholder: placeholder, options: options).render
+        placeholder = capture(&block) if block_given?
+        WrappingFuturismElement.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
+        placeholder = capture(record, index, &block) if block_given?
+        collection_class_name = collection.try(:klass).try(:name) || collection.first.class.to_s
+        as = options.delete(:as) || collection_class_name.underscore
+        broadcast_each = options.delete(:broadcast_each) || false
+        collection.each_with_index.map { |record, index|
+          WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options.deep_merge(
+            broadcast_each: broadcast_each,
+            locals: {as.to_sym => record, "#{as}_counter".to_sym => index}
+          )).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
+    def futurize_active_record(records, extends:, **options, &block)
+      Array(records).map.with_index { |record, index|
+        placeholder = capture(record, index, &block) if block_given?
+        WrappingFuturismElement.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
       }.join.html_safe
     end
     # wraps functionality for rendering a futurism element
-    class Element
+    class WrappingFuturismElement
       include ActionView::Helpers
       include Futurism::MessageVerifier
-      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :controller
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :broadcast_each, :controller
       def initialize(extends:, placeholder:, options:)
         @extends = extends
         @placeholder = placeholder
         @eager = options.delete(:eager)
+        @broadcast_each = options.delete(:broadcast_each)
         @controller = options.delete(:controller)
         @html_options = options.delete(:html_options) || {}
         @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
@@ -63,6 +74,7 @@ module Futurism
           signed_params: signed_params,
           sgid: model && model.to_sgid.to_s,
           eager: eager.presence,
+          broadcast_each: broadcast_each.presence,
           signed_controller: signed_controller
         })
       end
@@ -82,7 +94,10 @@ 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.new_record? ? value.to_global_id.to_s : value
+          next(value) unless value.respond_to?(:to_global_id)
+          next(value) if value.is_a?(ActiveRecord::Base) && value.new_record?
+          value.to_global_id.to_s
         end
       end

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

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
 module Futurism
   module Resolver
     class Controller
       class Renderer
+        HTTP_METHODS = [:get, :post, :put, :patch, :delete]
         def self.for(controller:, connection:, url:, params:)
           new(controller: controller, connection: connection, url: url, params: params).renderer
         end
@@ -30,7 +34,7 @@ module Futurism
             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)
+            path_params = recognize_url(url) # use full url to be more likely to match a url with subdomain constraints
             self.renderer =
               renderer.new(
@@ -51,6 +55,21 @@ module Futurism
           new_env = connection.env.merge(renderer.instance_variable_get(:@env))
           renderer.instance_variable_set(:@env, new_env)
         end
+        def recognize_url(url)
+          HTTP_METHODS.each do |http_method|
+            path = Rails.application.routes.recognize_path(url, method: http_method)
+            return path if path
+          rescue ActionController::RoutingError
+            # Route not matched, try next
+          end
+          warn "We were unable to find a matching rails route for '#{url}'. " \
+               "This may be because there are proc-based routing constraints for this particular url, or " \
+               "it truly is an unrecognizable url."
+          {}
+        end
       end
     end
   end

data/lib/futurism/resolver/resources.rb ADDED Viewed

@@ -0,0 +1,101 @@
+module Futurism
+  module Resolver
+    class Resources
+      include Futurism::MessageVerifier
+      # resource definitions are an array of [signed_params, sgid, signed_controller, url, broadcast_each]
+      def initialize(resource_definitions:, connection:, params:)
+        @connection = connection
+        @params = params
+        @resources_with_sgids, @resources_without_sgids = resource_definitions
+          .partition { |signed_params, sgid, *| sgid.present? }
+          .map { |partition| partition.map { |definition| ResourceDefinition.new(definition) } }
+      end
+      def resolve
+        resolved_models.zip(@resources_with_sgids).each do |model, resource_definition|
+          html = renderer_for(resource_definition: resource_definition).render(model)
+          yield(resource_definition.selector, html, resource_definition.broadcast_each)
+        end
+        @resources_without_sgids.each do |resource_definition|
+          resource = lookup_resource(resource_definition)
+          renderer = renderer_for(resource_definition: resource_definition)
+          html =
+            begin
+              renderer.render(resource)
+            rescue => exception
+              error_renderer.render(exception)
+            end
+          yield(resource_definition.selector, html, resource_definition.broadcast_each)
+        end
+      end
+      private
+      def error_renderer
+        ErrorRenderer.new
+      end
+      class ResourceDefinition
+        attr_reader :signed_params, :sgid, :signed_controller, :url
+        def initialize(resource_definition)
+          @signed_params, @sgid, @signed_controller, @url, @broadcast_each = resource_definition
+        end
+        def selector
+          selector = "[data-signed-params='#{@signed_params}']"
+          selector << "[data-sgid='#{@sgid}']" if @sgid.present?
+          selector
+        end
+        def controller
+          Resolver::Controller.from(signed_string: @signed_controller)
+        end
+        def broadcast_each
+          @broadcast_each == "true"
+        end
+      end
+      class ErrorRenderer
+        include ActionView::Helpers::TagHelper
+        def render(exception)
+          return "" unless render?
+          Futurism.logger.error(exception.to_s)
+          Futurism.logger.error(exception.backtrace)
+          tag.div { tag.span(exception.to_s) + tag.div(exception.backtrace.join("\n"), style: "display: none;") }
+        end
+        def render?
+          Rails.env.development? || Rails.env.test?
+        end
+        attr_accessor :output_buffer
+      end
+      def renderer_for(resource_definition:)
+        Resolver::Controller::Renderer.for(controller: resource_definition.controller,
+                                           connection: @connection,
+                                           url: resource_definition.url,
+                                           params: @params)
+      end
+      def resolved_models
+        GlobalID::Locator.locate_many_signed @resources_with_sgids.map(&:sgid)
+      end
+      def lookup_resource(resource_definition)
+        message_verifier
+          .verify(resource_definition.signed_params)
+          .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
+      end
+    end
+  end
+end

data/lib/futurism/resolver/resources.rb~ ADDED Viewed

@@ -0,0 +1,97 @@
+module Futurism
+  module Resolver
+    class Resources
+      include Futurism::MessageVerifier
+      # resource definitions are an array of [signed_params, sgid, signed_controller, url]
+      def initialize(resource_definitions:, connection:, params:)
+        @connection = connection
+        @params = params
+        @resources_with_sgids, @resources_without_sgids = resource_definitions
+          .partition { |signed_params, sgid, *| sgid.present? }
+          .map { |partition| partition.map { |definition| ResourceDefinition.new(definition) } }
+      end
+      def resolve
+        resolved_models.zip(@resources_with_sgids).each do |model, resource_definition|
+          html = renderer_for(resource_definition: resource_definition).render(model)
+          yield(resource_definition.selector, html)
+        end
+        @resources_without_sgids.each do |resource_definition|
+          resource = lookup_resource(resource_definition)
+          renderer = renderer_for(resource_definition: resource_definition)
+          html =
+            begin
+              renderer.render(resource)
+            rescue => exception
+              error_renderer.render(exception)
+            end
+          yield(resource_definition.selector, html)
+        end
+      end
+      private
+      def error_renderer
+        ErrorRenderer.new
+      end
+      class ResourceDefinition
+        attr_reader :signed_params, :sgid, :signed_controller, :url
+        def initialize(resource_definition)
+          @signed_params, @sgid, @signed_controller, @url = resource_definition
+        end
+        def selector
+          selector = "[data-signed-params='#{@signed_params}']"
+          selector << "[data-sgid='#{@sgid}']" if @sgid.present?
+          selector
+        end
+        def controller
+          Resolver::Controller.from(signed_string: @signed_controller)
+        end
+      end
+      class ErrorRenderer
+        include ActionView::Helpers::TagHelper
+        def render(exception)
+          return "" unless render?
+          Futurism.logger.error(exception.to_s)
+          Futurism.logger.error(exception.backtrace)
+          tag.div { tag.span(exception.to_s) + tag.div(exception.backtrace.join("\n"), style: "display: none;") }
+        end
+        def render?
+          Rails.env.development? || Rails.env.test?
+        end
+        attr_accessor :output_buffer
+      end
+      def renderer_for(resource_definition:)
+        Resolver::Controller::Renderer.for(controller: resource_definition.controller,
+                                           connection: @connection,
+                                           url: resource_definition.url,
+                                           params: @params)
+      end
+      def resolved_models
+        GlobalID::Locator.locate_many_signed @resources_with_sgids.map(&:sgid)
+      end
+      def lookup_resource(resource_definition)
+        message_verifier
+          .verify(resource_definition.signed_params)
+          .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
+      end
+    end
+  end
+end

data/lib/futurism/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "0.7.2"
+  VERSION = "1.1.0"
 end

data/lib/futurism/version.rb~ ADDED Viewed

@@ -0,0 +1,3 @@
+module Futurism
+  VERSION = "1.0.0"
+end

data/lib/futurism.rb CHANGED Viewed

@@ -3,6 +3,7 @@ require "action_cable"
 require "cable_ready"
 require "futurism/engine"
 require "futurism/message_verifier"
+require "futurism/resolver/resources"
 require "futurism/resolver/controller"
 require "futurism/resolver/controller/renderer"
 require "futurism/channel"
@@ -20,7 +21,10 @@ module Futurism
     (@@default_controller || "::ApplicationController").to_s.constantize
   end
-  ActiveSupport.on_load(:action_view) {
+  ActiveSupport.on_load(:action_view) do
     include Futurism::Helpers
-  }
+  end
+  mattr_accessor :logger
+  self.logger ||= Rails.logger ? Rails.logger.new : Logger.new($stdout)
 end

data/lib/tasks/futurism_tasks.rake CHANGED Viewed

@@ -3,7 +3,7 @@ require "fileutils"
 namespace :futurism do
   desc "Let's look into a brighter future with futurism and CableReady"
   task install: :environment do
-    system "yarn add @minthesize/futurism"
+    system "yarn add @stimulus_reflex/futurism"
     filepath = %w[
       app/javascript/channels/index.js
@@ -20,7 +20,7 @@ namespace :futurism do
     unless lines.find { |line| line.start_with?("import * as Futurism") }
       matches = lines.select { |line| line =~ /\A(require|import)/ }
-      lines.insert lines.index(matches.last).to_i + 1, "import * as Futurism from '@minthesize/futurism'\n"
+      lines.insert lines.index(matches.last).to_i + 1, "import * as Futurism from '@stimulus_reflex/futurism'\n"
     end
     unless lines.find { |line| line.start_with?("import consumer") }

data/lib/tasks/futurism_tasks.rake~ CHANGED Viewed

@@ -1,4 +1,39 @@
-# desc "Explaining what the task does"
-# task :futurism do
-#   # Task goes here
-# end
+require "fileutils"
+namespace :futurism do
+  desc "Let's look into a brighter future with futurism and CableReady"
+  task install: :environment do
+    system "yarn add @minthesize/futurism"
+    filepath = %w[
+      app/javascript/channels/index.js
+      app/javascript/channels/index.ts
+      app/javascript/packs/application.js
+      app/javascript/packs/application.ts
+    ]
+      .select { |path| File.exist?(path) }
+      .map { |path| Rails.root.join(path) }
+      .first
+    puts "Updating #{filepath}"
+    lines = File.open(filepath, "r") { |f| f.readlines }
+    unless lines.find { |line| line.start_with?("import * as Futurism") }
+      matches = lines.select { |line| line =~ /\A(require|import)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "import * as Futurism from '@minthesize/futurism'\n"
+    end
+    unless lines.find { |line| line.start_with?("import consumer") }
+      matches = lines.select { |line| line =~ /\A(require|import)/ }
+      lines.insert lines.index(matches.last).to_i + 1, "import consumer from '../channels/consumer'\n"
+    end
+    initialize_line = lines.find { |line| line.start_with?("Futurism.initializeElements") }
+    lines << "Futurism.initializeElements()\n" unless initialize_line
+    subscribe_line = lines.find { |line| line.start_with?("Futurism.createSubscription") }
+    lines << "Futurism.createSubscription(consumer)\n" unless subscribe_line
+    File.open(filepath, "w") { |f| f.write lines.join }
+  end
+end

metadata CHANGED Viewed

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-09-14 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
@@ -174,11 +160,14 @@ files:
 - lib/futurism/resolver/controller.rb~
 - lib/futurism/resolver/controller/renderer.rb
 - lib/futurism/resolver/controller/renderer.rb~
+- lib/futurism/resolver/resources.rb
+- lib/futurism/resolver/resources.rb~
 - lib/futurism/shims/deep_transform_values.rb
 - lib/futurism/version.rb
+- lib/futurism/version.rb~
 - lib/tasks/futurism_tasks.rake
 - lib/tasks/futurism_tasks.rake~
-homepage: https://github.com/julianrubisch/futurism
+homepage: https://github.com/stimulusreflex/futurism
 licenses:
 - MIT
 metadata: {}