futurism 1.2.0.pre4 → 1.2.0.pre8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6957dab754ba0fa363c7636d060efee6cd1c0bf55d0e4ba71d6af6e5a4dd70
-  data.tar.gz: 59fd73ff311a606a26e307eab3185882c89bf3c27ac23ee7940dd32b1565ade2
+  metadata.gz: c1bffa6e39b44603caf5ef679a8785e0df31e1019d57e2aef49208751a4fd7ba
+  data.tar.gz: f725d03372fa6919fb633801b884395cfefb88f95944adc22b08889bee97827c
 SHA512:
-  metadata.gz: 8333bc75d032dfeec4c3776c71df44a56f0c6a057ddfb2f09b026e27550e07289c425b9253c4bbb7d04ccd22497c5b67edf40828dd06b42b8b5315abd5451c32
-  data.tar.gz: 91c0f41783e97e8be0645a0a2814dbb29466c0d7bcda3a69d81fdc4267d21d72db98e4161f326c5792cab320cf711bb060fe348b7fe8fe9e27c7c1802b207517
+  metadata.gz: 55a981065cef8d8a62f169b0bb360418b642deaee1fc590ef2460c1e2723a60791df0f11e482c14985bfd40daaa9ff8e4a5d223fd26d204e68e31c7eb1675d2d
+  data.tar.gz: 2cdf24b379ca0d654a08981b130b500d2399243d8deeecd59164bc40ff1296f03c64c44606418ff29012dc72b8f546631e79df1af9fca90287340218af2e5a36

data/README.md

@@ -21,6 +21,7 @@ Lazy-load Rails partials via CableReady
   - [Explicit Partial](#explicit-partial)
   - [HTML Options](#html-options)
   - [Eager Loading](#eager-loading)
+  - [Bypassing](#bypassing)
   - [Broadcast Partials Individually](#broadcast-partials-individually)
   - [Contextual Placeholder Arguments](#contextual-placeholder-arguments)
 - [Events](#events)
@@ -175,6 +176,19 @@ Futurism makes that dead simple:
 <% end %>
 ```
 
+### Bypassing
+
+In some rare cases, e.g. when combined with CableReady's async `updates_for` mechanism, you'll want to bypass futurism entirely and fall back to native `rendering`. You can do this by passing an `unless` option:
+
+```erb
+<%= futurize 'some_tab', unless: bypass_futurism?, extends: :tr do %>
+  <div class="placeholder"</td>
+<% end %>
+```
+
+Internally, this works the same as [bypassing futurism in tests](#testing)
+
+
 ### Broadcast Partials Individually
 Futurism's default behavior is to `broadcast` partials as they are generated in batches: 
 
@@ -188,7 +202,7 @@ For collections, however, you can opt into individual broadcasts by specifying `
 <% end %>
 ```
 
-## Contextual Placeholder Arguments
+### Contextual Placeholder Arguments
 
 For individual models or arbitrary collections, you can pass `record` and `index` to the placeholder block as arguments:
 

data/lib/futurism/helpers.rb

@@ -1,7 +1,7 @@
 module Futurism
   module Helpers
     def futurize(records_or_string = nil, extends:, **options, &block)
-      if Rails.env.test? && Futurism.skip_in_test
+      if (Rails.env.test? && Futurism.skip_in_test) || options[:unless]
         if records_or_string.nil?
           return render(**options)
         else
@@ -11,6 +11,9 @@ module Futurism
 
       options[:eager] = true unless block_given?
 
+      # cannot serialize a proc
+      options.delete(:cached) if options[:cached].is_a?(Proc)
+
       if records_or_string.is_a?(ActiveRecord::Base) || records_or_string.is_a?(ActiveRecord::Relation)
         futurize_active_record(records_or_string, extends: extends, **options, &block)
       elsif records_or_string.is_a?(String)
@@ -55,6 +58,7 @@ module Futurism
     class WrappingFuturismElement
       include ActionView::Helpers
       include Futurism::MessageVerifier
+      include Futurism::OptionsTransformer
 
       attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :broadcast_each, :controller
 
@@ -92,14 +96,7 @@ module Futurism
       end
 
       def transformed_options
-        require_relative "shims/deep_transform_values" unless options.respond_to? :deep_transform_values
-
-        options.deep_transform_values do |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
+        dump_options(options)
       end
 
       private

data/lib/futurism/helpers.rb~

@@ -55,6 +55,7 @@ module Futurism
     class WrappingFuturismElement
       include ActionView::Helpers
       include Futurism::MessageVerifier
+      include Futurism::OptionsTransformer
 
       attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :broadcast_each, :controller
 
@@ -92,14 +93,7 @@ module Futurism
       end
 
       def transformed_options
-        require_relative "shims/deep_transform_values" unless options.respond_to? :deep_transform_values
-
-        options.deep_transform_values do |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
+        dump_options(options)
       end
 
       private

data/lib/futurism/options_transformer.rb

@@ -0,0 +1,20 @@
+module Futurism
+  module OptionsTransformer
+    def dump_options(options)
+      require_relative "shims/deep_transform_values" unless options.respond_to? :deep_transform_values
+
+      options.deep_transform_values do |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
+
+    def load_options(options)
+      require_relative "shims/deep_transform_values" unless options.respond_to? :deep_transform_values
+
+      options.deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
+    end
+  end
+end

data/lib/futurism/resolver/resources.rb

@@ -2,6 +2,7 @@ module Futurism
   module Resolver
     class Resources
       include Futurism::MessageVerifier
+      include Futurism::OptionsTransformer
 
       # resource definitions are an array of [signed_params, sgid, signed_controller, url, broadcast_each]
       def initialize(resource_definitions:, connection:, params:)
@@ -20,11 +21,11 @@ module Futurism
         end
 
         @resources_without_sgids.each do |resource_definition|
-          resource = lookup_resource(resource_definition)
+          options = options_from_resource(resource_definition)
           renderer = renderer_for(resource_definition: resource_definition)
           html =
             begin
-              renderer.render(resource)
+              renderer.render(options)
             rescue => exception
               error_renderer.render(exception)
             end
@@ -91,10 +92,9 @@ module Futurism
         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 }
+      def options_from_resource(resource_definition)
+        load_options(message_verifier
+          .verify(resource_definition.signed_params))
       end
     end
   end

data/lib/futurism/version.rb

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "1.2.0.pre4"
+  VERSION = "1.2.0.pre8"
 end

data/lib/futurism/version.rb~

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "1.2.0.pre3"
+  VERSION = "1.2.0.pre7"
 end

data/lib/futurism.rb

@@ -3,6 +3,7 @@ require "action_cable"
 require "cable_ready"
 require "futurism/engine"
 require "futurism/message_verifier"
+require "futurism/options_transformer"
 require "futurism/resolver/resources"
 require "futurism/resolver/controller"
 require "futurism/resolver/controller/renderer"

data/lib/futurism.rb~

@@ -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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 1.2.0.pre4
+  version: 1.2.0.pre8
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre5
+        version: 5.0.0.pre7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre5
+        version: 5.0.0.pre7
 description: Uses custom html elements with attached IntersectionObserver to automatically
   lazy load partials via websockets
 email:
@@ -156,6 +156,8 @@ files:
 - lib/futurism/helpers.rb
 - lib/futurism/helpers.rb~
 - lib/futurism/message_verifier.rb
+- lib/futurism/options_transformer.rb
+- lib/futurism/options_transformer.rb~
 - lib/futurism/resolver/controller.rb
 - lib/futurism/resolver/controller.rb~
 - lib/futurism/resolver/controller/renderer.rb