futurism 1.0.1 → 1.2.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d03b4cdaed591ec0a7f0031ddc637ce51030b65e7394031c0f6621b46dbf50ef
-  data.tar.gz: fd47bcaefebc50d2e5c3fdafcbdd9908505a3fa8b6f5a3c5c96838290c814649
+  metadata.gz: 80e0ce6e5c458215afe4266493a6644a029b75f005bfbadcdc181b82325e0d43
+  data.tar.gz: 902744214a43cee7e28c57f1999e52191aaf2d2022860c53c4784ba9fda200fd
 SHA512:
-  metadata.gz: 3942643f2fcadb5be781030aaf2eebd806da1d672e034b799c5ca43b3ed3d3aed3708d97ec70d4400f843dc134d0499f236a2e8e41a3d201e7cb2ba05c6b7ec0
-  data.tar.gz: 71d2546809de6dc4355e57e4f54e7bf783098175f4cc221deb4c874b508b35b33796990ae7d633382b80a28c753b4e9f9d34dfb3661f3535e6f05655b0d10be9
+  metadata.gz: a8638ce1768afd2da09199dc9e033b32168b54c401fd5ab2b26e20e127b38e4c172b93d8846cca8cc0adb28078073fb0bcd2554d70a5d070e60f631d1d596e5b
+  data.tar.gz: cf8c0a7ecd8451b15f7d71f496bd0e49adb358e1bf9770449424e4d4780709b410ba197f8c459a71468f46c3d7961b4ae331bd9e61e4d0e1d959720b46a7dd88

data/README.md

@@ -22,6 +22,7 @@ Lazy-load Rails partials via CableReady
   - [HTML Options](#html-options)
   - [Eager Loading](#eager-loading)
   - [Broadcast Partials Individually](#broadcast-partials-individually)
+  - [Contextual Placeholder Arguments](#contextual-placeholder-arguments)
 - [Events](#events)
 - [Installation](#installation)
   - [Manual Installation](#manual-installation)
@@ -187,6 +188,28 @@ For collections, however, you can opt into individual broadcasts by specifying `
 <% end %>
 ```
 
+## Contextual Placeholder Arguments
+
+For individual models or arbitrary collections, you can pass `record` and `index` to the placeholder block as arguments:
+
+```erb
+<%= futurize @post, extends: :div do |post| %>
+  <div><%= post.title %></div>
+<% end %>
+```
+
+```erb
+<%= futurize @posts, extends: :tr do |post, index| %>
+  <td><%= index + 1 %></td><td><%= post.title %></td>
+<% end %>
+```
+
+```erb
+<%= futurize partial: "users/user", collection: users, extends: "tr" do |user, index| %>
+  <td><%= index + 1 %></td><td><%= user.name %></td>
+<% end >
+```
+
 ## Events
 
 Once your futurize element has been rendered, the `futurize:appeared` custom event will be called.

data/lib/futurism/helpers.rb

@@ -9,31 +9,32 @@ module Futurism
         end
       end
 
-      if block_given?
-        placeholder = capture(&block)
-      else
-        options[:eager] = true
-      end
+      options[:eager] = true unless block_given?
 
       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)
+        futurize_active_record(records_or_string, extends: extends, **options, &block)
       elsif records_or_string.is_a?(String)
         html_options = options.delete(:html_options)
-        futurize_with_options(extends: extends, placeholder: placeholder, partial: records_or_string, locals: options, html_options: html_options)
+        futurize_with_options(extends: extends, partial: records_or_string, locals: options, html_options: html_options, &block)
       else
-        futurize_with_options(extends: extends, placeholder: placeholder, **options)
+        futurize_with_options(extends: extends, **options, &block)
       end
     end
 
-    def futurize_with_options(extends:, placeholder:, **options)
+    def futurize_with_options(extends:, **options, &block)
       collection = options.delete(:collection)
       if collection.nil?
+        placeholder = capture(&block) if block_given?
+
         WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options).render
       else
         collection_class_name = collection.try(:klass).try(:name) || collection.first.class.to_s
         as = options.delete(:as) || collection_class_name.underscore
         broadcast_each = options.delete(:broadcast_each) || false
+
         collection.each_with_index.map { |record, index|
+          placeholder = capture(record, index, &block) if block_given?
+
           WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options.deep_merge(
             broadcast_each: broadcast_each,
             locals: {as.to_sym => record, "#{as}_counter".to_sym => index}
@@ -42,8 +43,10 @@ module Futurism
       end
     end
 
-    def futurize_active_record(records, extends:, placeholder:, **options)
-      Array(records).map { |record|
+    def futurize_active_record(records, extends:, **options, &block)
+      Array(records).map.with_index { |record, index|
+        placeholder = capture(record, index, &block) if block_given?
+
         WrappingFuturismElement.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
       }.join.html_safe
     end

data/lib/futurism/helpers.rb~

@@ -9,31 +9,32 @@ module Futurism
         end
       end
 
-      if block_given?
-        placeholder = capture(&block)
-      else
-        options[:eager] = true
-      end
+      options[:eager] = true unless block_given?
 
       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)
+        futurize_active_record(records_or_string, extends: extends, **options, &block)
       elsif records_or_string.is_a?(String)
         html_options = options.delete(:html_options)
-        futurize_with_options(extends: extends, placeholder: placeholder, partial: records_or_string, locals: options, html_options: html_options)
+        futurize_with_options(extends: extends, partial: records_or_string, locals: options, html_options: html_options, &block)
       else
-        futurize_with_options(extends: extends, placeholder: placeholder, **options)
+        futurize_with_options(extends: extends, **options, &block)
       end
     end
 
-    def futurize_with_options(extends:, placeholder:, **options)
+    def futurize_with_options(extends:, **options, &block)
       collection = options.delete(:collection)
       if collection.nil?
+        placeholder = capture(&block) if block_given?
+
         WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options).render
       else
         collection_class_name = collection.try(:klass).try(:name) || collection.first.class.to_s
         as = options.delete(:as) || collection_class_name.underscore
         broadcast_each = options.delete(:broadcast_each) || false
+
         collection.each_with_index.map { |record, index|
+          placeholder = capture(record, index, &block) if block_given?
+
           WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options.deep_merge(
             broadcast_each: broadcast_each,
             locals: {as.to_sym => record, "#{as}_counter".to_sym => index}
@@ -42,8 +43,10 @@ module Futurism
       end
     end
 
-    def futurize_active_record(records, extends:, placeholder:, **options)
-      Array(records).map { |record|
+    def futurize_active_record(records, extends:, **options, &block)
+      Array(records).map.with_index { |record, index|
+        placeholder = capture(record, index, &block) if block_given?
+
         WrappingFuturismElement.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
       }.join.html_safe
     end
@@ -53,12 +56,13 @@ module Futurism
       include ActionView::Helpers
       include Futurism::MessageVerifier
 
-      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :controller
+      attr_reader :placeholder, :html_options, :data_attributes, :model, :options, :eager, :broadcast_each, :controller
 
       def initialize(extends:, placeholder:, options:)
         @extends = extends
         @placeholder = placeholder
         @eager = options.delete(:eager)
+        @broadcast_each = options.delete(:broadcast_each)
         @controller = options.delete(:controller)
         @html_options = options.delete(:html_options) || {}
         @data_attributes = html_options.fetch(:data, {}).except(:sgid, :signed_params)
@@ -71,19 +75,13 @@ module Futurism
           signed_params: signed_params,
           sgid: model && model.to_sgid.to_s,
           eager: eager.presence,
+          broadcast_each: broadcast_each.presence,
           signed_controller: signed_controller
         })
       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
+        content_tag :"futurism-element", placeholder, html_options.deep_merge({data: dataset, extends: extends})
       end
 
       def transformed_options
@@ -108,6 +106,15 @@ module Futurism
 
         message_verifier.generate(controller.to_s)
       end
+
+      def extends
+        # TODO remove this in the next major version
+        case @extends
+        when :li then "list-item"
+        when :tr then "table-row"
+        else @extends
+        end
+      end
     end
   end
 end

data/lib/futurism/version.rb

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

data/lib/futurism/version.rb~

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "1.0.0"
+  VERSION = "1.2.0.pre2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0.pre3
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,16 +126,16 @@ dependencies:
   name: cable_ready
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 5.0.0.pre4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 5.0.0.pre4
 description: Uses custom html elements with attached IntersectionObserver to automatically
   lazy load partials via websockets
 email:
@@ -150,7 +150,6 @@ files:
 - config/routes.rb
 - lib/futurism.rb
 - lib/futurism.rb~
-- lib/futurism/#helpers.rb#
 - lib/futurism/channel.rb
 - lib/futurism/channel.rb~
 - lib/futurism/engine.rb
@@ -183,9 +182,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key:

data/lib/futurism/#helpers.rb#

@@ -1,105 +0,0 @@
-module Futurism
-  module Helpers
-    def futurize(records_or_string = nil, extends:, **options, &block)
-      if Rails.env.test? && Futurism.skip_in_test
-        if records_or_string.nil?
-          return render(**options)
-        else
-          return render(records_or_string, **options)
-        end
-      end
-
-      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)
-        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
-    end
-
-    def futurize_with_options(extends:, placeholder:, **options)
-      collection = options.delete(:collection)
-      if collection.nil?
-        WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options).render
-      else
-        collection_class_name = collection.try(:klass).try(:name) || collection.first.class.to_s
-        as = options.delete(:as) || collection_class_name.underscore
-        collection.each_with_index.map { |record, index|
-          WrappingFuturismElement.new(extends: extends, placeholder: placeholder, options: options.deep_merge(locals: {as.to_sym => record, "#{as}_counter".to_sym => index})).render
-        }.join.html_safe
-      end
-    end
-
-    def futurize_active_record(records, extends:, placeholder:, **options)
-      Array(records).map { |record|
-        WrappingFuturismElement.new(extends: extends, options: options.merge(model: record), placeholder: placeholder).render
-      }.join.html_safe
-    end
-
-    # wraps functionality for rendering a futurism element
-    class WrappingFuturismElement
-      include ActionView::Helpers
-      include Futurism::MessageVerifier
-
-      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager, :controller
-
-      def initialize(extends:, placeholder:, options:)
-        @extends = extends
-        @placeholder = placeholder
-        @eager = options.delete(:eager)
-        @controller = options.delete(:controller)
-        @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,
-          eager: eager.presence,
-          signed_controller: signed_controller
-        })
-      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
-
-      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
-      end
-
-      private
-
-      def signed_params
-        message_verifier.generate(transformed_options)
-      end
-
-      def signed_controller
-        return unless controller.present?
-
-        message_verifier.generate(controller.to_s)
-      end
-    end
-  end
-end