futurism 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4522cbff1a5893e2a977bf7a32236b1ad9425983ed38521f188c5696dbbfec1
-  data.tar.gz: 37cb1278ae994766170290f172aca2f4db3b8e2a801edcb77c1ce4632352d56a
+  metadata.gz: d4790301758ddfdcf0a2e22b4f0f55977cdaf96f64fcef74ba85ccb4f6e7c71c
+  data.tar.gz: 07435fbcfbc75b1846015b319f8dc2056897f8cbb020ff29bf92c48366ea8a9a
 SHA512:
-  metadata.gz: 83742f96cb378d99ddc8d51bb95b8734fcdec0d9e22d0f3ac2b17122977dedf518942ed38664d715ec2b6890017269a301c31ebe3489d1e10d2176412970c13e
-  data.tar.gz: 42a03c5aa611bd415ecfc33b76b9242ce2c4d1e2c06cab8bf50ee06e6e7fe67fb14bad078f4c36bf9b0cd2e242eeefdd3f79581a5f50d47e2c89f5c184f12e40
+  metadata.gz: 88a0bb998ccc4192238f8936f80f77cf9b938bd70d141413be1d049265e59eb555d35ad77940ebae8d072b512aa97291a81d57ac1d397bf9c8fc37d54db4e55a
+  data.tar.gz: 6d5e8a2af44e58857f27fb54e6304f903c43901a05e8036f0ba1622e8ed0b8c29fbdbf1fc99e2fdfcbcaf841430ed3f3a7e5bd7d905d891797bbf294d803fe8b

data/README.md

@@ -1,12 +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-6-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-8-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)
@@ -90,6 +93,24 @@ You can also use the shorthand syntax:
 <% 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>
+```
+
 #### Collections
 
 Collection rendering is also possible:
@@ -100,6 +121,10 @@ Collection rendering is also possible:
 <% end %>
 ```
 
+## 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:
 
@@ -130,7 +155,7 @@ $ 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'
 
@@ -158,6 +183,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <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>
   </tr>
 </table>
 

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

@@ -4,7 +4,7 @@ module Futurism
       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)
+        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
@@ -24,18 +24,22 @@ module Futurism
       end
     end
 
-    def futurize_active_record(records, extends:, placeholder:)
+    def futurize_active_record(records, extends:, placeholder:, **options)
       Array(records).map { |record|
-        render_element(extends: extends, placeholder: placeholder, options: record)
+        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(options)}, is: "futurism-table-row"
+        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(options)}
+        content_tag :"futurism-element", placeholder, {data: {signed_params: futurism_signed_params(model_or_options)}}.merge(html_options)
       end
     end
 

data/lib/futurism/version.rb

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler