solidusio
fix admin component generator namespace
This PR is sponsored by :volcano: MagmaLabs
Summary
Admin component generator is failing on a clean solidus installation.
$ ./bin/rails g solidus_admin:component event
[WARNING Spree] Missing migrations.
[WARNING Spree] - add_reverse_charge_status_to_store
[WARNING Spree] - add_vat_id_email_and_reverse_charge_status_to_addresses
[WARNING Spree]
[WARNING Spree] Run `bin/rails railties:install:migrations` to get them.
[WARNING Spree] You can silence this warning by setting the `SOLIDUS_SKIP_MIGRATIONS_CHECK` environment variable.
create app/components/event/component.html.erb
/home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/railties-8.0.2/lib/rails/generators/base.rb:321:in `namespace_dirs': undefined method `name' for nil (NoMethodError)
@namespace_dirs ||= namespace.name.split("::").map(&:underscore)
^^^^^
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/railties-8.0.2/lib/rails/generators/base.rb:325:in `namespaced_path'
from /home/yoh/tmp/solidus/admin/lib/generators/solidus_admin/component/templates/component.rb.tt:3:in `template'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/erb-5.0.1/lib/erb.rb:427:in `eval'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/erb-5.0.1/lib/erb.rb:427:in `result'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/file_manipulation.rb:128:in `block in template'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/create_file.rb:54:in `render'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/create_file.rb:64:in `block (2 levels) in invoke!'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/create_file.rb:64:in `open'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/create_file.rb:64:in `block in invoke!'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/empty_directory.rb:117:in `invoke_with_conflict_check'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/create_file.rb:61:in `invoke!'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions.rb:93:in `action'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/create_file.rb:25:in `create_file'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/actions/file_manipulation.rb:124:in `template'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/railties-8.0.2/lib/rails/generators/named_base.rb:25:in `block in template'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/railties-8.0.2/lib/rails/generators/named_base.rb:45:in `inside_template'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/railties-8.0.2/lib/rails/generators/named_base.rb:24:in `template'
from /home/yoh/tmp/solidus/admin/lib/generators/solidus_admin/component/component_generator.rb:29:in `create_component_files'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/command.rb:28:in `run'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/invocation.rb:127:in `invoke_command'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/invocation.rb:134:in `block in invoke_all'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/invocation.rb:134:in `each'
from /home/yoh/.rvm/gems/ruby-3.3.7@commerze/gems/thor-1.3.2/lib/thor/invocation.rb:134:in `map'
Error comes from https://github.com/rails/rails/blob/3235827585d87661942c91bc81f64f56d710f0b2/railties/lib/rails/generators/base.rb#L321 due to namespace is returning nil.
This method was called from component.rb template
https://github.com/solidusio/solidus/blob/main/admin/lib/generators/solidus_admin/component/templates/component.rb.tt#L3
https://github.com/rails/rails/blob/3235827585d87661942c91bc81f64f56d710f0b2/railties/lib/rails/generators/base.rb#L324
So we need to define namespace into gem or host app to fix it. For now, I think would be easier to fix by adding into initializer template.
Let me know what you think?
Looking into specs found that are passing because we already seated namespace for generators specs https://github.com/solidusio/solidus/blob/main/admin/spec/spec_helper.rb#L115
Checklist
Check out our PR guidelines for more details.
The following are mandatory for all PRs:
- [X] I agree that my PR will be published under the same license as Solidus.
- [X] I have written a thorough PR description.
- [X] I have kept my commits small and atomic.
- [X] I have used clear, explanatory commit messages.
The following are not always needed:
- 📖 I have updated the README to account for my changes.
- 📑 I have documented new code with YARD.
- 🛣️ I have opened a PR to update the guides.
- ✅ I have added automated tests to cover my changes.
- 📸 I have attached screenshots to demo visual changes.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 89.22%. Comparing base (
b67dbb7) to head (c742a29). Report is 14 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #6237 +/- ##
==========================================
+ Coverage 87.99% 89.22% +1.22%
==========================================
Files 796 952 +156
Lines 16645 20060 +3415
==========================================
+ Hits 14647 17898 +3251
- Misses 1998 2162 +164
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
![codecov[bot] avatar](https://avatars.githubusercontent.com/in/254?v=4 "Published by a pub.dev verified publisher"){kind=small}
💚 All backports created successfully
| Status | Branch | Result |
|---|---|---|
| ✅ | v4.5 |  |
Questions ?
Please refer to the Backport tool documentation and see the Github Action logs for details
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
This breaks the sandbox for me locally:
➜ sandbox git:(customer-return-dependent) rails s
=> Booting Puma
=> Rails 8.0.2 application starting in development
=> Run `bin/rails server --help` for more startup options
Exiting
/home/anselm/code/solidus/sandbox/config/initializers/solidus_admin.rb:38:in `block in <top (required)>': uninitialized constant Rails::Generators (NameError)
::Rails::Generators.namespace = SolidusAdmin
^^^^^^^^^^^^
Did you mean? Enumerator
Also, conceptually, I don't think we should be setting the namespace accessor on Rails::Generator. Who knows what other Generators might be needing this accessor?
