futurism 0.1.4 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92467463ea6f80379a1dc26c85afe18564cd5cf2c6b92be207fe68d74f50b674
-  data.tar.gz: 7e5934d6194107a7d3b7ba39af4f38f0731ba8caa67fb706afeac5220ae46d85
+  metadata.gz: '09ba45b906e8c0f223e8da6793131f6eb96acad018116c32584d033392f1fe3b'
+  data.tar.gz: 178166e14d83fab48dcb6296d7dc9b412762ca228e201d5d97e7c70c08d1d1e1
 SHA512:
-  metadata.gz: a6514295bff471bc75f02186eb0446166a14d4dfdf1993b481ce6f0df737b863a90c33d4eef5ae09b0ad5007d66fb4dda9639debdedfc3a6ce6cc0613a9d0c29
-  data.tar.gz: 5aedb6c88925314d27a46d933b243113006be0b49d0f20fb91d4b767426deecbc73ce78d99e3148e09ca2a8219bf61a510f12dc57d0c6d846e6149a85301e852
+  metadata.gz: 29c7a409b86e1e29eac2feadc4e01d2042071e8daa196849bc676d400b2d59f4b4b7548fd4c3c76d45a262cb0f57b80adc0bde56812a2bcbc394eefd56f50c1c
+  data.tar.gz: f85ea36325a9a4aecb63a0c8a47636db1cf4e7573907e558cb46203bfbcd87b583d52efd78b2c6bffe20040a44e4cbad9cd4bf269741a7d011966d427518ec55

data/README.md

@@ -1,10 +1,15 @@
 # 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-5-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-10-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:
+
+<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>
+
 ## Facts
 - only one dependency: CableReady
 - bundle size (without CableReady) is around [~1.04kB](https://bundlephobia.com/result?p=@minthesize/futurism@0.1.3)
@@ -23,7 +28,9 @@ Lazy-load Rails partials via CableReady
 with a helper in your template
 
 ```erb
-<%= futurize @posts %>
+<%= futurize @posts, extends: :div do %>
+  <!-- placeholder -->
+<% end %>
 ```
 
 custom `<futurism-element>`s (in the form of a `<div>` or a `<tr is="futurism-table-row">` are rendered. Those custom elements have an `IntersectionObserver` attached that will send a signed global id to an ActionCable channel (`FuturismChannel`) which will then replace the placeholders with the actual resource partial.
@@ -40,7 +47,21 @@ You can pass the placeholder as a block:
 
 ![aa601dec1930151f71dbf0d6b02b61c9](https://user-images.githubusercontent.com/4352208/87131629-f768a480-c294-11ea-89a9-ea0a76ee06ef.gif)
 
-### Partial Path
+## API
+
+Currently there are two ways to call `futurize`, designed to wrap `render`'s behavior:
+
+### Resource
+
+You can pass a single `ActiveRecord` or an `ActiveRecord::Relation` to `futurize`, just as you would call `render`:
+
+```erb
+<%= futurize @posts, extends: :tr do %>
+  <td class="placeholder"></td>
+<% end %>
+```
+
+#### Partial Path
 
 Remember that you can override the partial path in you models, like so:
 
@@ -54,6 +75,56 @@ end
 
 That way you get maximal flexibility when just specifying a single resource.
 
+### Explicit Partial
+
+Call `futurize` with a `partial` keyword:
+
+```erb
+<%= futurize partial: "items/card", locals: {card: @card}, extends: :div do %>
+  <div class="spinner"></div>
+<% end %>
+```
+
+You can also use the shorthand syntax:
+
+```erb
+<%= futurize "items/card", card: @card, extends: :div do %>
+  <div class="spinner"></div>
+<% end %>
+```
+
+#### Collections
+
+Collection rendering is also possible:
+
+```erb
+<%= futurize partial: "items/card", collection: @cards, extends: :div do %>
+  <div class="spinner"></div>
+<% end %>
+```
+
+### 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.
+
+```erb
+<%= futurize @posts, extends: :tr, html_options: {style: "width: 50px; height: 50px;"} do %>
+  <td class="placeholder"></td>
+<% end %>
+```
+
+This will output the following:
+
+```html
+<tr style="width: 50px; height: 50px;">
+  <td class="placeholder"></td>
+</tr>
+```
+
+## Events
+
+Once your futurize element has been rendered, the `futurize:appeared` custom event will be called.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -72,19 +143,19 @@ To copy over the javascript files to your application, run
 $ bin/rails futurism:install
 ```
 
-** ! Note that the installer will run `yarn install @minthesize/futurism` for you ! **
+**! Note that the installer will run `yarn add @minthesize/futurism` for you !**
 
 ### Manual Installation
 After `bundle`, install the Javascript library:
 
 ```bash
-$ bin/yarn install @minthesize/futurism
+$ bin/yarn add @minthesize/futurism
 ```
 
 In your `app/javascript/channels/index.js`, add the following
 
 ```js
-import * as Futurism
+import * as Futurism from '@minthesize/futurism''
 
 import consumer from './consumer'
 
@@ -111,6 +182,13 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://ParamagicDev.github.io/portfolio"><img src="https://avatars2.githubusercontent.com/u/26425882?v=4" width="100px;" alt=""/><br /><sub><b>Konnor Rogers</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=ParamagicDev" title="Code">💻</a></td>
     <td align="center"><a href="https://www.andrewm.codes"><img src="https://avatars1.githubusercontent.com/u/18423853?v=4" width="100px;" alt=""/><br /><sub><b>Andrew Mason</b></sub></a><br /><a href="#maintenance-andrewmcodes" title="Maintenance">🚧</a></td>
     <td align="center"><a href="http://gorails.com"><img src="https://avatars1.githubusercontent.com/u/67093?v=4" width="100px;" alt=""/><br /><sub><b>Chris Oliver</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=excid3" title="Code">💻</a> <a href="https://github.com/julianrubisch/futurism/pulls?q=is%3Apr+reviewed-by%3Aexcid3" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/leastbad"><img src="https://avatars2.githubusercontent.com/u/38150464?v=4" width="100px;" alt=""/><br /><sub><b>leastbad</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=leastbad" title="Code">💻</a></td>
+    <td align="center"><a href="http://code.digimonkey.com"><img src="https://avatars0.githubusercontent.com/u/74207?v=4" width="100px;" alt=""/><br /><sub><b>M. E. Patterson</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/issues?q=author%3Amepatterson" title="Bug reports">🐛</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="http://fractaledmind.com"><img src="https://avatars3.githubusercontent.com/u/5077225?v=4" width="100px;" alt=""/><br /><sub><b>Stephen Margheim</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=fractaledmind" title="Code">💻</a></td>
+    <td align="center"><a href="http://hass.codes"><img src="https://avatars2.githubusercontent.com/u/1064205?v=4" width="100px;" alt=""/><br /><sub><b>Hassanin Ahmed</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=sas1ni69" title="Code">💻</a></td>
+    <td align="center"><a href="https://marcoroth.dev"><img src="https://avatars2.githubusercontent.com/u/6411752?v=4" width="100px;" alt=""/><br /><sub><b>Marco Roth</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=marcoroth" title="Code">💻</a></td>
   </tr>
 </table>
 

data/lib/futurism.rb

@@ -6,6 +6,10 @@ require "futurism/channel"
 require "futurism/helpers"
 
 module Futurism
+  extend ActiveSupport::Autoload
+
+  autoload :Helpers, "futurism/helpers"
+
   ActiveSupport.on_load(:action_view) {
     include Futurism::Helpers
   }

data/lib/futurism/channel.rb

@@ -7,13 +7,16 @@ module Futurism
     end
 
     def receive(data)
-      resources = data["sgids"].map { |sgid|
-        [sgid, GlobalID::Locator.locate_signed(sgid)]
+      resources = data["signed_params"].map { |signed_params|
+        [signed_params, Rails.application.message_verifier("futurism").verify(signed_params)]
       }
 
-      resources.each do |sgid, resource|
+      new_env = connection.env.merge(ApplicationController.renderer.instance_variable_get(:@env))
+      ApplicationController.renderer.instance_variable_set(:@env, new_env)
+
+      resources.each do |signed_params, resource|
         cable_ready["Futurism::Channel"].outer_html(
-          selector: "[data-sgid='#{sgid}']",
+          selector: "[data-signed-params='#{signed_params}']",
           html: ApplicationController.render(resource)
         )
       end

data/lib/futurism/channel.rb~

@@ -1,22 +1,26 @@
-class FuturismChannel < ApplicationCable::Channel
-  include CableReady::Broadcaster
+module Futurism
+  class Channel < ActionCable::Channel::Base
+    include CableReady::Broadcaster
 
-  def subscribed
-    stream_from "FuturismChannel"
-  end
+    def subscribed
+      stream_from "Futurism::Channel"
+    end
 
-  def receive(data)
-    resources = data["sgids"].map { |sgid|
-      [sgid, GlobalID::Locator.locate_signed(sgid)]
-    }
+    def receive(data)
+      resources = data["signed_params"].map { |signed_params|
+        [signed_params, Rails.application.message_verifier("futurism").verify(signed_params)]
+      }
 
-    resources.each do |sgid, resource|
-      cable_ready["FuturismChannel"].outer_html(
-        selector: "[data-sgid='#{sgid}']",
-        html: ApplicationController.render(resource)
-      )
-    end
+      ApplicationController.renderer.instance_variable_set(:@env, connection.env)
 
-    cable_ready.broadcast
+      resources.each do |signed_params, resource|
+        cable_ready["Futurism::Channel"].outer_html(
+          selector: "[data-signed-params='#{signed_params}']",
+          html: ApplicationController.render(resource)
+        )
+      end
+
+      cable_ready.broadcast
+    end
   end
 end

data/lib/futurism/helpers.rb

@@ -1,15 +1,51 @@
 module Futurism
   module Helpers
-    def futurize(records, extends:, &block)
+    def futurize(records_or_string = nil, extends:, **options, &block)
       placeholder = capture(&block)
+
+      if records_or_string.is_a?(ActiveRecord::Base) || records_or_string.is_a?(ActiveRecord::Relation)
+        futurize_active_record(records_or_string, extends: extends, placeholder: placeholder, **options)
+      elsif records_or_string.is_a?(String)
+        futurize_with_options(extends: extends, partial: records_or_string, locals: options, placeholder: placeholder)
+      else
+        futurize_with_options(extends: extends, placeholder: placeholder, **options)
+      end
+    end
+
+    def futurize_with_options(extends:, placeholder:, **options)
+      collection = options.delete(:collection)
+      if collection.nil?
+        render_element(extends: extends, placeholder: placeholder, options: options)
+      else
+        collection_class_name = collection.klass.name
+        as = options.delete(:as) || collection_class_name.downcase
+        collection.map { |record|
+          render_element(extends: extends, placeholder: placeholder, options: options.deep_merge(locals: {as.to_sym => record}))
+        }.join.html_safe
+      end
+    end
+
+    def futurize_active_record(records, extends:, placeholder:, **options)
       Array(records).map { |record|
-        case extends
-        when :tr
-          content_tag :tr, placeholder, data: {sgid: record.to_sgid.to_s}, is: "futurism-table-row"
-        else
-          content_tag :"futurism-element", placeholder, data: {sgid: record.to_sgid.to_s}
-        end
+        render_element(extends: extends, placeholder: placeholder, options: options.merge(model: record))
       }.join.html_safe
     end
+
+    def render_element(extends:, options:, placeholder:)
+      html_options = options.delete(:html_options) || {}
+      model_or_options = options.delete(:model) || options
+      case extends
+      when :li
+        content_tag :li, placeholder, {data: {signed_params: futurism_signed_params(model_or_options)}, is: "futurism-li"}.merge(html_options)
+      when :tr
+        content_tag :tr, placeholder, {data: {signed_params: futurism_signed_params(model_or_options)}, is: "futurism-table-row"}.merge(html_options)
+      else
+        content_tag :"futurism-element", placeholder, {data: {signed_params: futurism_signed_params(model_or_options)}}.merge(html_options)
+      end
+    end
+
+    def futurism_signed_params(params)
+      Rails.application.message_verifier("futurism").generate(params)
+    end
   end
 end

data/lib/futurism/version.rb

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "0.1.4"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.3
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: standardrb
   requirement: !ruby/object:Gem::Requirement