futurism 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09ba45b906e8c0f223e8da6793131f6eb96acad018116c32584d033392f1fe3b'
-  data.tar.gz: 178166e14d83fab48dcb6296d7dc9b412762ca228e201d5d97e7c70c08d1d1e1
+  metadata.gz: ba66b2cb1a12fb863e2e0fc34798411d7f95947a197496150e1a499582fc4e28
+  data.tar.gz: 3f7f290ef2b0b79f9c9e5100e7eaed2520dcb8e481e391bd537649d0023d379b
 SHA512:
-  metadata.gz: 29c7a409b86e1e29eac2feadc4e01d2042071e8daa196849bc676d400b2d59f4b4b7548fd4c3c76d45a262cb0f57b80adc0bde56812a2bcbc394eefd56f50c1c
-  data.tar.gz: f85ea36325a9a4aecb63a0c8a47636db1cf4e7573907e558cb46203bfbcd87b583d52efd78b2c6bffe20040a44e4cbad9cd4bf269741a7d011966d427518ec55
+  metadata.gz: e772253cf0ed802d14c6836c0fb7285f7011f79f516fa88cc85e13191b7de0f29ebbc0edbd5c7996f4f858ec4efe4890613605587a2cbd6c17c4ecbad05b4985
+  data.tar.gz: cf4db9dd38a545a7fe43381dc22597a4c5e77a4023698b19017740fa996e6aa0433e1927c115a1187bb9028ad26e2b36aa3ecd9f66fb19000380a6b6467efffb

data/README.md

@@ -182,7 +182,7 @@ 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>

data/lib/futurism/channel.rb

@@ -7,21 +7,29 @@ module Futurism
     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
 
       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|
+      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: "[data-signed-params='#{signed_params}']",
-          html: ApplicationController.render(resource)
+          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~

@@ -7,20 +7,29 @@ module Futurism
     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|
+      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: "[data-signed-params='#{signed_params}']",
-          html: ApplicationController.render(resource)
+          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/helpers.rb

@@ -6,7 +6,8 @@ module Futurism
       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)
+        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,37 +16,59 @@ 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.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}))
+          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|
-        render_element(extends: extends, placeholder: placeholder, options: options.merge(model: record))
+        Element.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
       }.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)
+    # 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
-    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.3"
+  VERSION = "0.4.0"
 end

metadata

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