Add support for installing via rails mounted engines #162

fuentesjr · 2021-04-17T16:31:52Z

Overview

This addresses issue #111 and will potentially help in addressing hotwired/hotwire-rails#22 as well. This adds new tests that ensure the rake tasks are mounted/loaded in mounted engine applications and "typical" applications as well.

…rt rails engines

…down

…s on webpacker based apps)

fuentesjr

I added some small notes about my first approach here

fuentesjr · 2021-04-17T16:42:32Z

app/helpers/turbo/streams_helper.rb

-    attributes["channel"] = "Turbo::StreamsChannel"
-    attributes["signed-stream-name"] = Turbo::StreamsChannel.signed_stream_name(streamables)
+    attributes[:channel] = "Turbo::StreamsChannel"
+    attributes[:"signed-stream-name"] = Turbo::StreamsChannel.signed_stream_name(streamables)


I was seeing "TypeError: hash key "channel" is not a Symbol" failing/error tests on:

BroadcastsTest#test_Users::Profile_broadcasts_Turbo_Streams
BroadcastsTest#test_Message_broadcasts_Turbo_Streams
Turbo::StreamsHelperTest#test_with_streamable
Turbo::StreamsHelperTest#test_with_streamable_and_html_attributes

https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-tag suggests that these should be symbols, so after this change the tests were passing for me. I'm not sure why this wasn't failing before. If I missed something let me know and I can revert this change.

fuentesjr · 2021-04-17T16:43:34Z

Gemfile.lock

@@ -175,6 +183,7 @@ DEPENDENCIES
  sqlite3
  turbo-rails!
  webdrivers
+  webpacker


I added this dev dependency to test the app:turbo:webpacker:install task

fuentesjr · 2021-04-17T16:48:35Z

lib/tasks/turbo_tasks.rake


 namespace :turbo do
  desc "Install Turbo into the app"
-  task :install do
+  task :install do |task|
+    nspace = task.name.split(/turbo:install/).first


This is ultimately the approach that I took to determine whether the rake task invocations should include the app namespace. An alternative approach I was considering is something like:

nspace = nil nspace = "app:" if defined?(ENGINE_ROOT)

I came across ENGINE_ROOT from one of the rails source files, but I don't know enough of rails to be confident that will always work.

danlaffan · 2021-07-08T18:49:24Z

Hi @dhh and @fuentesjr ,

Any thoughts on this PR? Any update would be great as I am starting a large project using Rails engines and I need to know if Hotwire will run properly from inside an engine.

Thanks everyone.

dhh · 2021-08-30T12:08:02Z

@danlaffan Turbo works fine in an engine. This PR is just about setting up an install script. Everything this gem provides is automatically available everywhere.

danlaffan · 2021-08-30T13:19:31Z

@dhh That's correct, David. The installer script for turbo-rails doesn't work currently when installing in an engine. However, I have proven that if you perform the steps manually, you definitely CAN get turbo to work in an engine.

FYI, the same problem (install script not working inside an engine) also pertains to the Stimulus-rails gem. I intend to fix both of these in forthcoming pull requests, hopefully this week.

I noticed that the turbo gem (as I last saw it) doesn't create an importmap.js.erb file. I intend to remedy that as well in my forthcoming pull request.

Cheers,
Dan

romaingibs13 · 2022-01-25T09:54:35Z

Hello what is the current state of Hotwire on Rails Engine ? Because I am seeing issues as of now, here a screenshot:

We are using the latest Rails version (7)

danlaffan · 2022-01-25T10:33:46Z

Hi @romaingibs13,

I have modified 4 gems locally so they work in the context of a Rails 7 engine. I will create pull requests for them today. I have modified all of them in the same way, so if one gets approved, the others should too.

They are:

turbo-rails
stimulus-rails
hotwire-rails
importmap-rails

I will start with a PR for importmap-rails.

Cheers, Dan

romaingibs13 · 2022-01-25T13:16:24Z

@danlaffan Thanks a lot for your quickness of answer, happy to know it's already on the way :) We are looking forward to use this promising technology

danlaffan · 2022-01-25T23:08:22Z

Check this out - rails/importmap-rails#103 - all thoughts welcome.

WriterZephos · 2022-02-17T00:05:52Z

Not sure if this will solve the issue I am facing, but when creating a new plugin via rails plugin new the dummy app that gets created does not have hotwire installed and I get the following error when trying to call turbo_frame_request?

Error:
ControllerTest#test_turbo_router_handles_standard_requests_by_rendering_default_template:
NoMethodError: undefined method `turbo_frame_request?' for #<DefaultTestController:0x00000000002f08>

Please let me know if this is the same issue. I am new to the whole plugin/engine thing.

WriterZephos · 2022-02-21T19:42:15Z

@danlaffan can you outline the steps to get turbo-rails installed in a demo app for a plugin? This PR is taking a long time and would like to work around this problem for now.

danlaffan · 2022-02-21T22:16:38Z

Hi @WriterZephos,

I have created a pull request in importmap-rails that shows the basic steps I had to take to get the turbo-rails, stimulus-rails and hotwire-rails gems to work in the context of a Rails engine. I have PRs ready to go for those other three gems when/if the importmap-rails PR is accepted.

Could you kindly clarify for me – do you intend to install hotwire-rails into:

A plugin which is then included in a Rails app, OR
Directly into the parent Rails app, but use it in the code inside the plugin?

Best regards, Dan.

WriterZephos · 2022-02-21T22:22:22Z

Hi @WriterZephos,

I have created a pull request in importmap-rails that shows the basic steps I had to take to get the turbo-rails, stimulus-rails and hotwire-rails gems to work in the context of a Rails engine. I have PRs ready to go for those other three gems when/if the importmap-rails PR is accepted.

Could you kindly clarify for me – do you intend to install hotwire-rails into:

A plugin which is then included in a Rails app, OR

Directly into the parent Rails app, but use it in the code inside the plugin?

Best regards, Dan.

Hi @danlaffan

I will take a look at that other MR. Thank you.

I want to include turbo-rails directly into the rails app. The gem I am making basically adds helpers and render methods to make using turbo-rails easier (they will use turbo-rails from inside the plugin code). I just need to be able to install it in the demo app so I can write tests.

In theory I can build my app without it but testing would be difficult.

Thanks

danlaffan · 2022-02-21T22:35:44Z

Hi @WriterZephos,

If you wish to install turbo-rails direct into a Rails app, you should be able to directly add it to the gemfile of the Rails app. My pull requests are to help people who are trying to install the turbo-rails gem directly in the plugin/Rails Engine.

However, if your gem/plugin requires turbo-rails, it would then become dependent on the turbo-rails gem, so perhaps you should be considering adding turbo-rails as a dependency into your plugin/gem.

Am I understanding you correctly?

Best regards, Dan

WriterZephos · 2022-02-21T23:35:16Z

@danlaffan I think I get what you are saying, but the problem isn't the dependency, it's the inability to test my gem because it requires being able to call turbo-rails methods from the controller.

One of the things my gem provides is a mixin/concern/module that you can include in your controllers, and that code calls turbo-rails methods. Without having turbo-rails installed in the demo app that is generated, I can't properly test my plugin code against it.

I can do manually testing, sure, because that would use a standalone app that wasn't automatically generated without turbo-rails.

danlaffan · 2022-02-21T23:51:22Z

Hi @WriterZephos,

Have you tried installing turbo-rails in your test app?

In my current project (my first turbo project), I have a Rails Engine which has a folder called spec/dummy that contains a test Rails app. When I run bin/rails s it runs the app in that spec/dummy folder. You could add turbo into the gemfile for such an app, or you could make turbo a dependency of the plugin, and then your host app would need to / be required to load turbo.

How you actually trigger tests to call your turbo mini depends a lot on your code, and of course on which testing system you're using. I'm really only familiar with RSpec.

Would you like to transfer this discussion to a Stack Overflow question where we can look at code samples? If you would, paste in the link to your SO question here and I will pick this up tomorrow. It's the end of the day here in Ireland, so I'll pick this up again tomorrow.

Best regards, Dan

WriterZephos · 2022-02-22T00:12:37Z

Hey @danlaffan your comments got me thinking about it differently and I tried again. I was able to run rails turbo:install from the demo app root and it worked! Now I can test my gem with a turbo enabled demo app.

I really appreciate the conversation to help me unlock my brain.

One thing of note: I also had to install jsbundling-rails since turbo requires either node or importmaps to run, which was surprising but makes sense I suppose, since it comes with a JS library.

Thanks again. Cheers.

danlaffan · 2022-02-22T08:29:52Z

No problem! :)

fuentesjr · 2022-04-20T22:42:04Z

Hello @danlaffan 👋🏼

I think this PR is a bit outdated, so I'm thinking it would be best to close this one. Thoughts?

danlaffan · 2022-04-20T22:52:40Z

Hi @fuentesjr, I am happy to update it. I think it's still needed. Am I missing something?

fuentesjr · 2022-04-20T23:46:33Z

Hey @danlaffan Ok let's update it and then I'll remove the Draft status. It was just starting to look like this PR was becoming stale.

fuentesjr · 2022-05-25T23:35:43Z

@danlaffan Any update on this? Would you still like to keep this open?

danlaffan · 2022-05-27T10:15:33Z

Hi @fuentesjr , I'm sorry for the confusion I have caused here. Yes, go ahead and lose this PR. I have created another PR in the importmap-rails gem as a starting point in fixing this issue. This PR can be closed.

fuentesjr added 7 commits April 11, 2021 13:01

Add engine rake task specs

5237f84

Refactore/restructure rake task tests and update turbo tasks to suppo…

eaad948

…rt rails engines

Move file fixtures to files subdirectory

6ffef48

Refactor rake task tests to use a helper to dry up the setup and tear…

f631f3c

…down

Merge branch 'main' into support-engines

fd13592

Gemfile.lock update with webpacker dev dependency (testing turbo task…

68090f5

…s on webpacker based apps)

ActionView TagHelper expects options to be symbols

6743c58

fuentesjr commented Apr 17, 2021

View reviewed changes

fuentesjr added 2 commits July 26, 2021 22:35

Install paths differ on mounted engine apps ... use engine name in path

b8ad352

Update pr branch with latest upstream changes

fbda519

fuentesjr marked this pull request as draft August 13, 2021 01:12

danlaffan mentioned this pull request Jan 25, 2022

Enable engine support rails/importmap-rails#103

Open

fuentesjr closed this May 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for installing via rails mounted engines #162

Add support for installing via rails mounted engines #162

fuentesjr commented Apr 17, 2021

fuentesjr left a comment

fuentesjr Apr 17, 2021

fuentesjr Apr 17, 2021

fuentesjr Apr 17, 2021

danlaffan commented Jul 8, 2021

dhh commented Aug 30, 2021

danlaffan commented Aug 30, 2021

romaingibs13 commented Jan 25, 2022 •

edited

Loading

danlaffan commented Jan 25, 2022 •

edited

Loading

romaingibs13 commented Jan 25, 2022

danlaffan commented Jan 25, 2022

WriterZephos commented Feb 17, 2022

WriterZephos commented Feb 21, 2022

danlaffan commented Feb 21, 2022 •

edited

Loading

WriterZephos commented Feb 21, 2022

danlaffan commented Feb 21, 2022

WriterZephos commented Feb 21, 2022

danlaffan commented Feb 21, 2022

WriterZephos commented Feb 22, 2022

danlaffan commented Feb 22, 2022

fuentesjr commented Apr 20, 2022

danlaffan commented Apr 20, 2022

fuentesjr commented Apr 20, 2022

fuentesjr commented May 25, 2022

danlaffan commented May 27, 2022

Add support for installing via rails mounted engines #162

Add support for installing via rails mounted engines #162

Conversation

fuentesjr commented Apr 17, 2021

Overview

fuentesjr left a comment

Choose a reason for hiding this comment

fuentesjr Apr 17, 2021

Choose a reason for hiding this comment

fuentesjr Apr 17, 2021

Choose a reason for hiding this comment

fuentesjr Apr 17, 2021

Choose a reason for hiding this comment

danlaffan commented Jul 8, 2021

dhh commented Aug 30, 2021

danlaffan commented Aug 30, 2021

romaingibs13 commented Jan 25, 2022 • edited Loading

danlaffan commented Jan 25, 2022 • edited Loading

romaingibs13 commented Jan 25, 2022

danlaffan commented Jan 25, 2022

WriterZephos commented Feb 17, 2022

WriterZephos commented Feb 21, 2022

danlaffan commented Feb 21, 2022 • edited Loading

WriterZephos commented Feb 21, 2022

danlaffan commented Feb 21, 2022

WriterZephos commented Feb 21, 2022

danlaffan commented Feb 21, 2022

WriterZephos commented Feb 22, 2022

danlaffan commented Feb 22, 2022

fuentesjr commented Apr 20, 2022

danlaffan commented Apr 20, 2022

fuentesjr commented Apr 20, 2022

fuentesjr commented May 25, 2022

danlaffan commented May 27, 2022

romaingibs13 commented Jan 25, 2022 •

edited

Loading

danlaffan commented Jan 25, 2022 •

edited

Loading

danlaffan commented Feb 21, 2022 •

edited

Loading