Make the install generator idempotent #2472
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jhawthorn
suggested changes
Dec 22, 2017
| @@ -4,6 +4,8 @@ | |||
|
|
|||
| module Spree | |||
| class InstallGenerator < Rails::Generators::Base | |||
| SPREE_MOUNT_ROUTE = "mount Spree::Core::Engine" | |||
There was a problem hiding this comment.
This is already namespaced within Spree::, so I'm not sure that's descriptive. It could be MOUNT_ROUTE or ENGINE_MOUNT_ROUTE or CORE_MOUNT_ROUTE
| insert_into_file File.join('config', 'routes.rb'), after: "Rails.application.routes.draw do\n" do | ||
| <<-ROUTES | ||
| routes_file_path = File.join('config', 'routes.rb') | ||
| unless File.read(routes_file_path).match Regexp.new(SPREE_MOUNT_ROUTE) |
There was a problem hiding this comment.
Treating SPREE_MOUNT_ROUTE as a regex is going to work fine because it doesn't have any regex characters (*, (, ., etc), but it feels like the wrong thing to do.
This should probably be
File.read(routes_file_path).include?(SPREE_MOUNT_ROUTE)
Currently if you run the install generator a second time the
mount Spree::Core::Engine
route gets injected a second time.
Thor's insert_into_file should be an reversible operation but
I guess because we inject multiple lines into the routes file
it doesn't work as expected.
c88077f
to
7ed23ee
Compare
|
@jhawthorn thanks. Addressed your concerns. |
jhawthorn
approved these changes
Dec 22, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently if you run the install generator a second time the
route gets injected a second time.
Thor's insert_into_file should be an reversible operation but
I guess because we inject multiple lines into the routes file
it doesn't work as expected.