Fix installation method as a gem executable #162

waiting-for-dev · 2021-06-11T09:10:37Z

This is a WIP that depends on changes that need to be integrated on solidus_support. In order to try it:

Check out this branch or your local repository.
Make sure you don't have other installation of solidus_starter_frontend: gem uninstall solidus_starter_frontend
Install the gem from this branch:
- gem build solidus_starter_frontend.gemspec
- gem install solidus_starter_frontend-0.1.0.gem
Create a rails app: rails new store --skip-javascript && cd store
Add solidus gems: bundle add solidus_core solidus_backend solidus_api solidus_sample
IMPORTANT: Add gem 'solidus_support', github: 'waiting-for-dev/solidus_support', branch: 'waiting-for-dev/change_engine_detection' to the Gemfile
Run bundle
Run bin/rails g solidus:install
Say y to the prompt suggesting solidus_auth_devise
Run solidus_starter_frontend
Run rails server bin/rails server
Go to http://localhost:3000 and check that the devise routes are working. E.g., http://localhost:3000/login.

Description

To support solidus_auth_devise, it needs to rely on a new version of
solidus_support that changes how it detects if a Solidus frontend is
available and the moment it adds the extensions' controller & view
directories to the Rails known paths.

Motivation and Context

The previous solidus_support version added the extensions' paths on
the engine's (in this case, solidus_auth_devise's engine) load time
and only when SolidusSupport#frontend_available? returned true.
Engines are loaded before the application code, so at that time, the
monkey patching of #frontend_available? that we were generating was
not at hand. The solution is two-fold: we add the paths on an
initializer on one side. However, at that moment, the application code
is neither available, so on the other side, we change
#frontend_available? to look for a
Rails.configuration.x.solidius.frontend_available setting that we add
to application.rb using the generator code. To understand the whole
picture, keep in mind that Rails.configuration is available on an
initializer, but it's not on an engine's load time.
On top of that, we need to update a couple of things on the generated code:

We need to reference Rails.root instead of Engine.root, as
SolidusStarterFrontend::Engine is unavailable on this installation
method.
We need to copy to application.rb the custom code on
SolidusStarterFrontend::Engine for the same reason as above.

How Has This Been Tested?

Tested the installation method locally.

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.

References #153 & #161

kennyadsl · 2021-06-11T11:59:59Z

app/controllers/concerns/solidus_starter_frontend/auth_views.rb

@@ -10,7 +10,8 @@ module AuthViews
    protected

    def configure_views
-      prepend_view_path Engine.root.join('lib', 'views', 'auth')
+      root = defined?(SolidusStarterFrontend::Engine) ? SolidusStarterFrontend::Engine.root : Rails.root
+      prepend_view_path root.join('lib', 'views', 'auth')


I think we can avoid this if we change

- directory 'lib/views', 'lib/views' + directory 'lib/views', 'app/views'

This way all the views will be copied in the app directory, which is where people expect to find them.

Good point!! I just updated it. I also had to add the exclude_pattern option in:

directory 'app', 'app', exclude_pattern: /auth_views/

kennyadsl · 2021-06-15T08:38:33Z

lib/generators/solidus_starter_frontend/solidus_starter_frontend_generator.rb

@@ -5,26 +5,39 @@ class SolidusStarterFrontendGenerator < Rails::Generators::Base

  def install
    # Copy directories
-    directory 'app', 'app'
-    directory 'lib/views', 'lib/views'
+    directory 'app', 'app', exclude_pattern: /auth_views/


I don't understand why we need this part: exclude_pattern: /auth_views/. There is no auth_views folder in the app directory, isn't it?

It's because of this file:

https://github.com/nebulab/solidus_starter_frontend/blob/waiting-for-dev/fix_executable_installation/app/controllers/concerns/solidus_starter_frontend/auth_views.rb

We don't need it, thanks to your suggestion to add the views directly into the application. However, it crashes because of Engine not being within the namespace if we copy it.

kennyadsl · 2021-06-15T08:40:29Z

lib/solidus_starter_frontend/engine.rb

@@ -9,6 +9,10 @@ class Engine < Rails::Engine

    engine_name 'solidus_starter_frontend'

+    initializer 'solidus_starter_frontend', before: 'solidus_support_frontend_paths' do


Do we need to add solidus_support_frontend_paths here?

Yes, for now, it's added on my fork https://github.com/waiting-for-dev/solidus_support/blob/bcda06b7ff436018b5a3eb2588ca55a7128a7d5a/lib/solidus_support/engine_extensions.rb#L85. For now, you need to manually add it to the Gemfile if you want to test this branch.

To support `solidus_auth_devise`, it needs to rely on a new version of `solidus_support` that changes how it detects if a Solidus frontend is available and the moment it adds the extensions' controller & view directories to the Rails known paths. The previous `solidus_support` version added the extensions' paths on the engine's (in this case, `solidus_auth_devise`'s engine) load time and only when `SolidusSupport#frontend_available?` returned `true`. Engines are loaded before the application code, so at that time, the monkey patching of `#frontend_available?` that we were generating was not at hand. The solution is two-fold: we add the paths on an `initializer` on one side. However, at that moment, the application code is neither available, so on the other side, we change `#frontend_available?` to look for a `Rails.configuration.x.solidius.frontend_available` setting that we add to `application.rb` using the generator code. To understand the whole picture, keep in mind that `Rails.configuration` is available on an initializer, but it's not on an engine's load time. On top of that, we need to update a couple of things on the generated code: - We need to reference `Rails.root` instead of `Engine.root`, as `SolidusStarterFrontend::Engine` is unavailable on this installation method. - We need to copy to `application.rb` the custom code on `SolidusStarterFrontend::Engine` for the same reason as above.

waiting-for-dev · 2021-09-15T11:06:10Z

@gsmendoza I think we can close this PR as you took another direction, right?

gsmendoza · 2021-09-15T21:57:42Z

@waiting-for-dev Yes. Thanks for the work here! It helped me figure out how to move forward with the project :)

waiting-for-dev mentioned this pull request Jun 11, 2021

Auth issue when getting started #161

Open

kennyadsl reviewed Jun 11, 2021

View reviewed changes

waiting-for-dev force-pushed the waiting-for-dev/fix_executable_installation branch 3 times, most recently from 9e7bfd6 to c455a2d Compare June 15, 2021 06:38

kennyadsl reviewed Jun 15, 2021

View reviewed changes

waiting-for-dev force-pushed the waiting-for-dev/fix_executable_installation branch from c455a2d to d3c1689 Compare June 15, 2021 10:14

This was referenced Jun 15, 2021

Fix dependency on the engines load order when adding paths solidusio/solidus_support#65

Merged

Allow detecting Solidus components through a Rails setting solidusio/solidus_support#66

Closed

This was referenced Jul 15, 2021

Fix sandbox script #166

Closed

Discourage SolidusStarterFrontend from being run as an engine #167

Closed

This was referenced Jul 22, 2021

Create alternate sandbox script which copies Starter FE into app #171

Merged

Copy routes/controllers/views/tests from auth_devise #172

Merged

gsmendoza closed this Sep 15, 2021

waiting-for-dev deleted the waiting-for-dev/fix_executable_installation branch September 16, 2021 02:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix installation method as a gem executable #162

Fix installation method as a gem executable #162

waiting-for-dev commented Jun 11, 2021 •

edited

Loading

kennyadsl Jun 11, 2021

waiting-for-dev Jun 15, 2021

kennyadsl Jun 15, 2021

waiting-for-dev Jun 15, 2021

kennyadsl Jun 15, 2021

waiting-for-dev Jun 15, 2021 •

edited

Loading

waiting-for-dev commented Sep 15, 2021 •

edited

Loading

gsmendoza commented Sep 15, 2021

		@@ -9,6 +9,10 @@ class Engine < Rails::Engine

		engine_name 'solidus_starter_frontend'

		initializer 'solidus_starter_frontend', before: 'solidus_support_frontend_paths' do

Fix installation method as a gem executable #162

Fix installation method as a gem executable #162

Conversation

waiting-for-dev commented Jun 11, 2021 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

kennyadsl Jun 11, 2021

Choose a reason for hiding this comment

waiting-for-dev Jun 15, 2021

Choose a reason for hiding this comment

kennyadsl Jun 15, 2021

Choose a reason for hiding this comment

waiting-for-dev Jun 15, 2021

Choose a reason for hiding this comment

kennyadsl Jun 15, 2021

Choose a reason for hiding this comment

waiting-for-dev Jun 15, 2021 • edited Loading

Choose a reason for hiding this comment

waiting-for-dev commented Sep 15, 2021 • edited Loading

gsmendoza commented Sep 15, 2021

waiting-for-dev commented Jun 11, 2021 •

edited

Loading

waiting-for-dev Jun 15, 2021 •

edited

Loading

waiting-for-dev commented Sep 15, 2021 •

edited

Loading