futurism 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4522cbff1a5893e2a977bf7a32236b1ad9425983ed38521f188c5696dbbfec1
-  data.tar.gz: 37cb1278ae994766170290f172aca2f4db3b8e2a801edcb77c1ce4632352d56a
+  metadata.gz: dc887b3a3173cce8feec82e572327f820cdb39793b5ee5fd5977b6e32c1edb78
+  data.tar.gz: e0f429c1861f30754e91c3dcce1121bf95894f558792f15f7f72958006b01dea
 SHA512:
-  metadata.gz: 83742f96cb378d99ddc8d51bb95b8734fcdec0d9e22d0f3ac2b17122977dedf518942ed38664d715ec2b6890017269a301c31ebe3489d1e10d2176412970c13e
-  data.tar.gz: 42a03c5aa611bd415ecfc33b76b9242ce2c4d1e2c06cab8bf50ee06e6e7fe67fb14bad078f4c36bf9b0cd2e242eeefdd3f79581a5f50d47e2c89f5c184f12e40
+  metadata.gz: 603a65c0d08974feeaceb867e076ab69daf99e51a139fd8f9c2634d7e3b885a7f662ae1c2c32e0e2c31ec6e2dd1b55ec2df8ad385441abfe25d66a7088d30a21
+  data.tar.gz: 11d930242efc8ff82a7b495197b4c5fceb9a0a7cc4e89fc48d9464e05e85e7eb307b7a25dac85628e2a5f7e66e1427e960150f544b325552142fc1ececb5e7db

data/README.md

@@ -1,12 +1,34 @@
 # 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-12-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>
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Facts](#facts)
+  - [Browser Support](#browser-support)
+- [Usage](#usage)
+- [API](#api)
+  - [Resource](#resource)
+  - [Explicit Partial](#explicit-partial)
+  - [HTML Options](#html-options)
+- [Events](#events)
+- [Installation](#installation)
+  - [Manual Installation](#manual-installation)
+- [Authentication](#authentication)
+- [Gotchas](#gotchas)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contributors](#contributors)
+
 ## Facts
 - only one dependency: CableReady
 - bundle size (without CableReady) is around [~1.04kB](https://bundlephobia.com/result?p=@minthesize/futurism@0.1.3)
@@ -100,6 +122,28 @@ Collection rendering is also possible:
 <% 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:
 
@@ -130,7 +174,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'
 
@@ -138,6 +182,39 @@ Futurism.initializeElements()
 Futurism.createSubscription(consumer)
 ```
 
+## Authentication
+For authentication, you can rely on ActionCable identifiers, for example, if you use Devise:
+
+```ruby
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      self.current_user = env["warden"].user || reject_unauthorized_connection
+    end
+  end
+end
+```
+
+The [Stimulus Reflex Docs](https://docs.stimulusreflex.com/authentication) have an excellent section about all sorts of authentication.
+
+## Gotchas
+
+### ActiveStorage URLs aren't correct in development
+
+Out of the box, Rails will prefix generated urls with `http://example.org` rather than `http://localhost`, much like ActionMailer. To amend this, add
+
+```ruby
+  # config/environments/development.rb
+  config.action_controller.default_url_options = {host: "localhost", port: 3000}
+
+  # config/environments/production.rb
+  config.action_controller.default_url_options = {host: "mysite.com"}
+```
+
+to your environments.
+
 ## Contributing
 
 ## License
@@ -157,7 +234,15 @@ 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="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>
+  </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>
   </tr>
 </table>
 

data/lib/futurism/channel.rb

@@ -2,25 +2,42 @@ module Futurism
   class Channel < ActionCable::Channel::Base
     include CableReady::Broadcaster
 
+    def stream_name
+      ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
+      [
+        params[:channel],
+        ids.select(&:present?).join(";")
+      ].select(&:present?).join(":")
+    end
+
     def subscribed
-      stream_from "Futurism::Channel"
+      stream_from stream_name
     end
 
     def receive(data)
-      resources = data["signed_params"].map { |signed_params|
-        [signed_params, Rails.application.message_verifier("futurism").verify(signed_params)]
-      }
+      resources = data.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
 
-      ApplicationController.renderer.instance_variable_set(:@env, connection.env)
+      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-signed-params='#{signed_params}']",
-          html: ApplicationController.render(resource)
+      resources.each do |signed_params, sgid|
+        selector = "[data-signed-params='#{signed_params}']"
+        selector << "[data-sgid='#{sgid}']" if sgid.present?
+        cable_ready[stream_name].outer_html(
+          selector: selector,
+          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
         )
       end
 
       cable_ready.broadcast
     end
+
+    private
+
+    def resource(signed_params:, sgid:)
+      return GlobalID::Locator.locate_signed(sgid) if sgid.present?
+
+      Rails.application.message_verifier("futurism").verify(signed_params)
+    end
   end
 end

data/lib/futurism/channel.rb~

@@ -1,22 +1,35 @@
-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.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
+
+      new_env = connection.env.merge(ApplicationController.renderer.instance_variable_get(:@env))
+      ApplicationController.renderer.instance_variable_set(:@env, new_env)
 
-  def receive(data)
-    resources = data["sgids"].map { |sgid|
-      [sgid, GlobalID::Locator.locate_signed(sgid)]
-    }
+      resources.each do |signed_params, sgid|
+        selector = "[data-signed-params='#{signed_params}']"
+        selector << "[data-sgid='#{sgid}']" if sgid.present?
+        cable_ready["Futurism::Channel"].outer_html(
+          selector: selector,
+          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
+        )
+      end
 
-    resources.each do |sgid, resource|
-      cable_ready["FuturismChannel"].outer_html(
-        selector: "[data-sgid='#{sgid}']",
-        html: ApplicationController.render(resource)
-      )
+      cable_ready.broadcast
     end
 
-    cable_ready.broadcast
+    private
+
+    def resource(signed_params:, sgid:)
+      return GlobalID::Locator.locate_signed(sgid) if sgid.present?
+
+      Rails.application.message_verifier("futurism").verify(signed_params)
+    end
   end
 end

data/lib/futurism/helpers.rb

@@ -4,9 +4,10 @@ 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)
+        html_options = options.delete(:html_options)
+        futurize_with_options(extends: extends, placeholder: placeholder, partial: records_or_string, locals: options, html_options: html_options)
       else
         futurize_with_options(extends: extends, placeholder: placeholder, **options)
       end
@@ -15,32 +16,60 @@ module Futurism
     def futurize_with_options(extends:, placeholder:, **options)
       collection = options.delete(:collection)
       if collection.nil?
-        render_element(extends: extends, placeholder: placeholder, options: options)
+        Element.new(extends: extends, placeholder: placeholder, options: options).render
       else
-        collection_class_name = collection.first.class.name
+        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.merge(locals: {collection_class_name.downcase.to_sym => record}))
+          Element.new(extends: extends, placeholder: placeholder, options: options.deep_merge(locals: {as.to_sym => record})).render
         }.join.html_safe
       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)
+        Element.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
       }.join.html_safe
     end
 
-    def render_element(extends:, options:, placeholder:)
-      case extends
-      when :tr
-        content_tag :tr, placeholder, data: {signed_params: futurism_signed_params(options)}, is: "futurism-table-row"
-      else
-        content_tag :"futurism-element", placeholder, data: {signed_params: futurism_signed_params(options)}
+    # wraps functionality for rendering a futurism element
+    class Element
+      include ActionView::Helpers
+
+      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options
+
+      def initialize(extends:, placeholder:, options:)
+        @extends = extends
+        @placeholder = placeholder
+        @html_options = options.delete(:html_options) || {}
+        @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
+        @model = options.delete(:model)
+        @options = data_attributes.any? ? options.merge(data: data_attributes) : options
+      end
+
+      def dataset
+        data_attributes.merge({
+          signed_params: signed_params,
+          sgid: model && model.to_sgid.to_s
+        })
+      end
+
+      def render
+        case extends
+        when :li
+          content_tag :li, placeholder, html_options.deep_merge({data: dataset, is: "futurism-li"})
+        when :tr
+          content_tag :tr, placeholder, html_options.deep_merge({data: dataset, is: "futurism-table-row"})
+        else
+          content_tag :"futurism-element", placeholder, html_options.deep_merge({data: dataset})
+        end
       end
-    end
 
-    def futurism_signed_params(params)
-      Rails.application.message_verifier("futurism").generate(params)
+      private
+
+      def signed_params
+        Rails.application.message_verifier("futurism").generate(options)
+      end
     end
   end
 end

data/lib/futurism/helpers.rb~

@@ -1,13 +1,73 @@
-module FuturismHelper
-  def futurize(records, extends: :tr, &block)
-    placeholder = capture(&block)
-    Array(records).map { |record|
-      case extends
-      when :tr
-        content_tag :tr, placeholder, data: { sgid: record.to_sgid.to_s }, is: "futurism-table-row"
+module Futurism
+  module Helpers
+    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, placeholder: placeholder, partial: records_or_string, **options)
       else
-        content_tag :"futurism-element", placeholder, data: { sgid: record.to_sgid.to_s }
+        futurize_with_options(extends: extends, placeholder: placeholder, **options)
       end
-    }.join.html_safe
+    end
+
+    def futurize_with_options(extends:, placeholder:, **options)
+      collection = options.delete(:collection)
+      if collection.nil?
+        Element.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
+        }.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
+      }.join.html_safe
+    end
+
+    # wraps functionality for rendering a futurism element
+    class Element
+      include ActionView::Helpers
+
+      attr_reader :extends, :placeholder, :html_options, :model, :options
+
+      def initialize(extends:, placeholder:, options:)
+        @extends = extends
+        @placeholder = placeholder
+        @html_options = options.delete(:html_options) || {}
+        @model = options.delete(:model)
+        @options = options
+      end
+
+      def dataset
+        {
+          signed_params: signed_params,
+          sgid: model && model.to_sgid.to_s
+        }
+      end
+
+      def render
+        case extends
+        when :li
+          content_tag :li, placeholder, {data: dataset, is: "futurism-li"}.merge(html_options)
+        when :tr
+          content_tag :tr, placeholder, {data: dataset, is: "futurism-table-row"}.merge(html_options)
+        else
+          content_tag :"futurism-element", placeholder, {data: dataset}.merge(html_options)
+        end
+      end
+
+      private
+
+      def signed_params
+        Rails.application.message_verifier("futurism").generate(options)
+      end
+    end
   end
 end

data/lib/futurism/version.rb

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

metadata

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