futurism 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e79c03c8d157585784ab3e4f48d2660100acad4e317aa378cdfa94a0c5a3fb9
-  data.tar.gz: 5036367ba790b660ef6230e6155192cfedd65973fa65e00fd7b53f071f8a6ae8
+  metadata.gz: e784a06ccd2401b46d5a8a0cffd44e194e3a69db8c10439a7bb1eb0a7cfcf3d8
+  data.tar.gz: 763001a24e053f55745e7560ce0fe446256328a01c758efaa4a3eb65424cd40e
 SHA512:
-  metadata.gz: cf2acd22c20fd40897b6caed2ad897eec3cc98f7ea1fbd9ab31ea19cf276cfa2f94f04ef87a16fe8c68ec03dab1e4e5832a1f4026fe269c58b8114dd1aecb54a
-  data.tar.gz: bda0591fb9174ebd6499839be5bfdb8512d8c7c110b9af837f6d8425eb6e9180384234fd493df1945fe51c021c2a0ab0e8ee5537238babd00617ca9bf4a16d8b
+  metadata.gz: 1486c1e9d54f3e380c675f1fb5f79ec9dc4753446209dae14bbef9a15600f1635d81b0fd75415067019efd5c4b3df6110785da951ef4cc5076d5b9ae13febffc
+  data.tar.gz: d68ab7a3c7909206e92644b2d7b3e227ddf2e4d5d0c7d787bffbc9766dc48115bb785bd923aecf5dc64244a74dd419bc930148968ff72c827f3bf21d9c199031

data/README.md

@@ -124,6 +124,22 @@ Collection rendering is also possible:
 <% end %>
 ```
 
+#### Specifying Controller to Render
+
+You can also pass in the controller that will be used to render the partial.
+
+```erb
+<%= futurize partial: "items/card", collection: @cards, controller: MyController, extends: :div do %>
+  <div class="spinner"></div>
+<% end %>
+```
+
+By default (i.e. not passing in a value), futurize will use `ApplicationController`, but you may override by setting the Futurism default controller in an initializer, for example `config/initializers/futurism.rb`.
+
+```ruby
+Futurism.default_controller = MyController
+```
+
 ### 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.
@@ -241,6 +257,39 @@ to your environments.
 
 ## Contributing
 
+### Get local environment setup
+
+Below are a set of instructions that may help you get a local development environment working
+
+```shell
+# Get the gem/npm package source locally
+git clone futurism
+cd futurism/javascript
+yarn install # install all of the npm package's dependencies
+yarn link # set the local machine's futurism npm package's lookup to this local path
+
+# Setup a sample project, use the information below directly or use your own project
+git clone https://github.com/leastbad/stimulus_reflex_harness.git
+cd stimulus_reflex_harness
+git checkout futurism
+# Edit Gemfile to point point to local gem (e.g. `gem "futurism", path: "../futurism"`)
+# yarn link @minthesize/futurism
+
+
+# Do your work, Submit PR, Profit!
+
+
+# To stop using your local version of futurism
+# change your Gemfile back to the published (e.g. `gem "futurism"`)
+cd path/to/futurism/javascript
+# Stop using the local npm package
+yarn unlink
+
+# Instruct your project to reinstall the published version of the npm package
+cd path/to/project
+yarn install --force
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/lib/futurism.rb

@@ -2,6 +2,7 @@ require "rails"
 require "action_cable"
 require "cable_ready"
 require "futurism/engine"
+require "futurism/message_verifier"
 require "futurism/channel"
 require "futurism/helpers"
 
@@ -10,7 +11,7 @@ module Futurism
 
   autoload :Helpers, "futurism/helpers"
 
-  mattr_accessor :skip_in_test
+  mattr_accessor :skip_in_test, :default_controller
 
   ActiveSupport.on_load(:action_view) {
     include Futurism::Helpers

data/lib/futurism/channel.rb

@@ -1,6 +1,7 @@
 module Futurism
   class Channel < ActionCable::Channel::Base
     include CableReady::Broadcaster
+    include Futurism::MessageVerifier
 
     def stream_name
       ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
@@ -15,17 +16,22 @@ module Futurism
     end
 
     def receive(data)
-      resources = data.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
+      resources = data.fetch_values("signed_params", "sgids", "signed_controllers") { |_key| Array.new(data["signed_params"].length, 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, sgid|
+      resources.each do |signed_params, sgid, signed_controller|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
+
+        controller_lookup = ControllerLookup.from(signed_string: signed_controller)
+        controller_lookup.setup_env!(connection: connection)
+        controller = controller_lookup.controller
+
+        resource = lookup_resource(signed_params: signed_params, sgid: sgid)
+        html = controller.render(resource)
+
         cable_ready[stream_name].outer_html(
           selector: selector,
-          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
+          html: html
         )
       end
 
@@ -34,14 +40,48 @@ module Futurism
 
     private
 
-    def resource(signed_params:, sgid:)
+    def lookup_resource(signed_params:, sgid:)
       return GlobalID::Locator.locate_signed(sgid) if sgid.present?
 
-      Rails
-        .application
-        .message_verifier("futurism")
+      message_verifier
         .verify(signed_params)
         .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
     end
+
+    class ControllerLookup
+      include Futurism::MessageVerifier
+
+      def self.from(signed_string:)
+        new(signed_string)
+      end
+
+      def initialize(signed_string)
+        @signed_string = signed_string
+      end
+
+      def controller
+        if signed_string.present?
+          message_verifier
+            .verify(signed_string)
+            .to_s
+            .safe_constantize
+        else
+          default_controller
+        end
+      end
+
+      def setup_env!(connection:)
+        new_env = connection.env.merge(controller.renderer.instance_variable_get(:@env))
+        controller.renderer.instance_variable_set(:@env, new_env)
+      end
+
+      private
+
+      attr_reader :signed_string
+
+      def default_controller
+        Futurism.default_controller || ::ApplicationController
+      end
+    end
   end
 end

data/lib/futurism/channel.rb~

@@ -1,6 +1,7 @@
 module Futurism
   class Channel < ActionCable::Channel::Base
     include CableReady::Broadcaster
+    include Futurism::MessageVerifier
 
     def stream_name
       ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
@@ -15,17 +16,22 @@ module Futurism
     end
 
     def receive(data)
-      resources = data.fetch_values("signed_params", "sgids") { |key| [nil] }.transpose
+      resources = data.fetch_values("signed_params", "sgids", "signed_controllers") { |_key| Array.new(data["signed_params"].length, 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, sgid|
+      resources.each do |signed_params, sgid, signed_controller|
         selector = "[data-signed-params='#{signed_params}']"
         selector << "[data-sgid='#{sgid}']" if sgid.present?
+
+        controller_lookup = ControllerLookup.from(signed_string: signed_controller)
+        controller_lookup.setup(connection: connection)
+        controller = controller_lookup.controller
+
+        resource = lookup_resource(signed_params: signed_params, sgid: sgid)
+        html = controller.render(resource)
+
         cable_ready[stream_name].outer_html(
           selector: selector,
-          html: ApplicationController.render(resource(signed_params: signed_params, sgid: sgid))
+          html: html
         )
       end
 
@@ -34,14 +40,48 @@ module Futurism
 
     private
 
-    def resource(signed_params:, sgid:)
+    def lookup_resource(signed_params:, sgid:)
       return GlobalID::Locator.locate_signed(sgid) if sgid.present?
 
-      Rails
-        .application
-        .message_verifier("futurism")
+      message_verifier
         .verify(signed_params)
         .deep_transform_values { |value| value.is_a?(String) && value.start_with?("gid://") ? GlobalID::Locator.locate(value) : value }
     end
+
+    class ControllerLookup
+      include Futurism::MessageVerifier
+
+      def self.from(signed_string:)
+        new(signed_string)
+      end
+
+      def initialize(signed_string)
+        @signed_string = signed_string
+      end
+
+      def controller
+        if signed_string.present?
+          message_verifier
+            .verify(signed_string)
+            .to_s
+            .safe_constantize
+        else
+          default_controller
+        end
+      end
+
+      def setup(connection:)
+        new_env = connection.env.merge(controller.renderer.instance_variable_get(:@env))
+        controller.renderer.instance_variable_set(:@env, new_env)
+      end
+
+      private
+
+      attr_reader :signed_string
+
+      def default_controller
+        Futurism.default_controller || ::ApplicationController
+      end
+    end
   end
 end

data/lib/futurism/helpers.rb

@@ -3,9 +3,9 @@ module Futurism
     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
+          return render(**options)
         else
-          return render records_or_string, **options
+          return render(records_or_string, **options)
         end
       end
 
@@ -43,13 +43,15 @@ module Futurism
     # wraps functionality for rendering a futurism element
     class Element
       include ActionView::Helpers
+      include Futurism::MessageVerifier
 
-      attr_reader :extends, :placeholder, :html_options, :data_attributes, :model, :options, :eager
+      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)
@@ -60,7 +62,8 @@ module Futurism
         data_attributes.merge({
           signed_params: signed_params,
           sgid: model && model.to_sgid.to_s,
-          eager: eager.presence
+          eager: eager.presence,
+          signed_controller: signed_controller
         })
       end
 
@@ -86,7 +89,13 @@ module Futurism
       private
 
       def signed_params
-        Rails.application.message_verifier("futurism").generate(transformed_options)
+        message_verifier.generate(transformed_options)
+      end
+
+      def signed_controller
+        return unless controller.present?
+
+        message_verifier.generate(controller.to_s)
       end
     end
   end

data/lib/futurism/message_verifier.rb

@@ -0,0 +1,9 @@
+module Futurism
+  module MessageVerifier
+    private
+
+    def message_verifier
+      @message_verifier ||= Rails.application.message_verifier("futurism")
+    end
+  end
+end

data/lib/futurism/version.rb

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "0.5.4"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -175,7 +175,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/futurism_manifest.js
 - config/routes.rb
 - lib/futurism.rb
 - lib/futurism.rb~
@@ -184,6 +183,7 @@ files:
 - lib/futurism/engine.rb
 - lib/futurism/helpers.rb
 - lib/futurism/helpers.rb~
+- lib/futurism/message_verifier.rb
 - lib/futurism/shims/deep_transform_values.rb
 - lib/futurism/version.rb
 - lib/tasks/futurism_tasks.rake