Bugfix: Prevent generators from overwriting files #274

maxemitchell · 2024-11-14T23:00:43Z

This adds a create method that raises an error if the file already exists.

This allows the write method to still be used by specs and when we want to override (e.g. for editing the routes file).

Addresses #181

maxemitchell · 2024-11-14T23:16:24Z

spec/unit/hanami/cli/commands/app/generate/action_spec.rb

@@ -88,7 +151,7 @@ class #{inflector.camelize(action)} < #{inflector.camelize(app)}::View
        EXPECTED

        expect(fs.read("app/templates/#{controller}/#{action}.html.erb")).to eq(template_file)
-        expect(output).to include("Created app/views/#{controller}/#{action}.rb")
+        expect(output).to include("Created app/templates/#{controller}/#{action}.html.erb")


this was looking for the wrong file

Nice find indeed! How did this even pass before? 😅

maxemitchell · 2024-11-14T23:16:33Z

spec/unit/hanami/cli/commands/app/generate/action_spec.rb

@@ -305,47 +375,45 @@ class #{inflector.camelize(action)} < #{inflector.camelize(app)}::View
        EXPECTED

        expect(fs.read("app/templates/#{controller}/#{action}.html.erb")).to eq(template_file)
-        expect(output).to include("Created app/views/#{controller}/#{action}.rb")
+        expect(output).to include("Created app/templates/#{controller}/#{action}.html.erb")


same thing here with wrong file

maxemitchell · 2024-11-14T23:16:43Z

spec/unit/hanami/cli/commands/app/generate/action_spec.rb

+    context "with nested action name" do
+      let(:context) { Hanami::CLI::Generators::App::ActionContext.new(inflector, app, nil, %w[api users], "thing") }


added a context for this

maxemitchell · 2024-11-14T23:17:35Z

spec/unit/hanami/cli/commands/app/generate/action_spec.rb

        end
      end

-      context "deeply nested action" do


this deeply nested action context was duplicate

timriley

Thank you for taking care of this, @maxemitchell! Especially continuing the work on it even after RubyConf finished — truly heroic! 🤩

The changes here all look good to me 👍🏼

I'd be happy to merge this as is, because this PR alone is already a valuable improvement on what we're doing now.

Before I do that, I'd like to take this moment to get your thoughts on how this PR fits into the bigger picture.

With this PR in its current state, if a user ran a generator that encountered an existing file, the hanami CLI would crash with the new FileAlreadyExistsError and print out a stack trace. On the plus side, this prevents unwanted file overwriting, but the rest of the user experience here doesn't feel so good. The error and stacktrace will be overwhelming, and it may be hard for the user to identify the cause for the CLI command crashing.

I think a better experience here might be fore our generate command classes to catch this FileAlreadyExistsError and print a nicer error message before then cleanly exiting (with a non-zero exit code). This might be something we can put into a single base command class for all the generators, so that we don't have to implement it in every single command class.

What do you think about this? Any thoughts on how else this might be made nicer? And now the big question: is this something you'd also be interested in working on? 😇 I'd be very happy for it to be in a follow-up PR so that we can merge this one and stay focused on smaller, incremental changes. Let me know!

timriley · 2024-11-27T07:52:33Z

spec/unit/hanami/cli/commands/app/generate/action_spec.rb

@@ -88,7 +151,7 @@ class #{inflector.camelize(action)} < #{inflector.camelize(app)}::View
        EXPECTED

        expect(fs.read("app/templates/#{controller}/#{action}.html.erb")).to eq(template_file)
-        expect(output).to include("Created app/views/#{controller}/#{action}.rb")
+        expect(output).to include("Created app/templates/#{controller}/#{action}.html.erb")


Nice find indeed! How did this even pass before? 😅

stephannv · 2024-12-06T20:01:12Z

@timriley If you want, I can make a following PR adding a prompt confirmation:

Screen.Recording.2024-12-06.at.16.54.31.mov

timriley · 2024-12-06T23:26:03Z

@stephannv that would be amazing! How about I merge this PR today, and then you can build on top of main?

stephannv · 2024-12-06T23:39:52Z

@stephannv that would be amazing! How about I merge this PR today, and then you can build on top of main?

Sure @timriley !

timriley · 2024-12-08T03:54:49Z

I resolved a merge conflict to lib/hanami/cli/generators/app/component.rb after the changes in #277.

Everything looks good now. I'll merge.

Thanks again @maxemitchell for your contribution! ❤️ Please reach out if you're interested in doing something like this again 😄

timriley · 2024-12-08T03:59:10Z

@stephannv This is merged, feel free to base any future work off the main branch :)

stephannv · 2024-12-08T20:26:16Z

@timriley while I was coding the prompt confirmation I figured out that asking the users if they want to overwrite the file may not be the best experience, this can lead to many successive questions (eg. generating an action with action, test, view, template files), and in the future we may want to add hanami g xyz -y to say yes to all questions, or add a option to skip (don't create the file and don't halt the generator).

So now I'm not sure if this feature (overwrite prompt) is worth it since Hanami generators are generating simple "blank" files and not generating complex setup.

But if we still want to overwrite existing files, maybe a --force option can be simple and useful, eg.

$ hanami g action books.index
Cannot overwrite existing file: `app/actions/books/index.rb`. Pass `--force` argument to force file overwriting.

$ hanami g action books.index --force
...
Updated app/actions/books/index.rb
...

maxemitchell added 3 commits November 14, 2024 17:11

wip: added overwrite prevention and action specs

9a99784

finish specs

edf81f4

fixes

3f32755

maxemitchell force-pushed the prevent_file_overwriting branch from 6c2d4ae to 3f32755 Compare November 14, 2024 23:11

maxemitchell added 3 commits November 14, 2024 17:12

cleanup

c7167d1

cleanup

b93ded9

cleanup

3fd02f2

maxemitchell commented Nov 14, 2024

View reviewed changes

remove version comment

3d68320

maxemitchell marked this pull request as ready for review November 14, 2024 23:18

timriley approved these changes Nov 27, 2024

View reviewed changes

Merge branch 'main' into prevent_file_overwriting

5eb81b9

timriley merged commit 04ec18a into hanami:main Dec 8, 2024
3 checks passed

timriley mentioned this pull request Dec 8, 2024

Prevent file overwriting #181

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bugfix: Prevent generators from overwriting files #274

Bugfix: Prevent generators from overwriting files #274

maxemitchell commented Nov 14, 2024

maxemitchell Nov 14, 2024

katafrakt Nov 18, 2024

timriley Nov 27, 2024

maxemitchell Nov 14, 2024

maxemitchell Nov 14, 2024

maxemitchell Nov 14, 2024

timriley left a comment

timriley Nov 27, 2024

stephannv commented Dec 6, 2024

timriley commented Dec 6, 2024

stephannv commented Dec 6, 2024

timriley commented Dec 8, 2024

timriley commented Dec 8, 2024

stephannv commented Dec 8, 2024

		context "with nested action name" do
		let(:context) { Hanami::CLI::Generators::App::ActionContext.new(inflector, app, nil, %w[api users], "thing") }

Bugfix: Prevent generators from overwriting files #274

Bugfix: Prevent generators from overwriting files #274

Conversation

maxemitchell commented Nov 14, 2024

maxemitchell Nov 14, 2024

Choose a reason for hiding this comment

katafrakt Nov 18, 2024

Choose a reason for hiding this comment

timriley Nov 27, 2024

Choose a reason for hiding this comment

maxemitchell Nov 14, 2024

Choose a reason for hiding this comment

maxemitchell Nov 14, 2024

Choose a reason for hiding this comment

maxemitchell Nov 14, 2024

Choose a reason for hiding this comment

timriley left a comment

Choose a reason for hiding this comment

timriley Nov 27, 2024

Choose a reason for hiding this comment

stephannv commented Dec 6, 2024

timriley commented Dec 6, 2024

stephannv commented Dec 6, 2024

timriley commented Dec 8, 2024

timriley commented Dec 8, 2024

stephannv commented Dec 8, 2024