Let users undo the `administrate:views` generator #424

c-lliope · 2016-01-20T21:00:29Z

Fixes #310

Problem:

Rails provides a way to undo the effects of generators,
by running the command rails destroy GENERATOR_NAME.

With the way that we had set up our hierarchy of generators,
Rails did not know how to undo the effects of sub-generators.

For example, with the administrate:views generator,
we were calling Rails::Generators.invoke("administrate:views:index").

Whether the generator was run with the generate or destroy command
did not make a difference -
the index generator would always be invoked
as if it were run with generate.

Solution:

Rails generators use the @behavior instance variable to keep track of
how the generator was run.
This variable can be either :invoke or :revoke.

Pass this variable as an option to the sub-generators
to ensure they have the same behavior as the parent.

Minor changes:

Extract Administrate::GeneratorHelpers to store common
generator-related methods.

gylaz · 2016-01-21T02:01:11Z

lib/administrate/generator_helpers.rb

+module Administrate
+  module GeneratorHelpers
+    def call_generator(generator, *args)
+      Rails::Generators.invoke(generator, args, behavior: behavior)


What do you think about passing behavior to call_generator? Otherwise, it seems like a mystery guest.

normally I'd agree, but that would defeat the purpose of extracting this method. I wanted to automatically include the parent's behavior, instead of passing it in explicitly.

gylaz · 2016-01-21T02:03:40Z

Left a few suggestions/questions. Looking good!

houndci-bot · 2016-01-22T06:49:33Z

spec/generators/views_generator_spec.rb

+      run_generator [resource], behavior: :revoke
+
+      expect(Rails::Generators).
+        to invoke_generator("administrate:views:index", [resource], behavior: :revoke)


Line is too long. [86/80]

Fixes #310 Problem: Rails provides a way to undo the effects of generators, by running the command `rails destroy GENERATOR_NAME`. With the way that we had set up our hierarchy of generators, Rails did not know how to undo the effects of sub-generators. For example, with the `administrate:views` generator, we were calling `Rails::Generators.invoke("administrate:views:index")`. Whether the generator was run with the `generate` or `destroy` command did not make a difference - the index generator would always be invoked as if it were run with `generate`. Solution: Rails generators use the `@behavior` instance variable to keep track of how the generator was run. This variable can be either `:invoke` or `:revoke`. Pass this variable as an option to the sub-generators to ensure they have the same behavior as the parent. Minor changes: Extract `Administrate::GeneratorHelpers` to store common generator-related methods.

Changes: ``` * [#269] [FEATURE] Add a generator for copying default layout files * [#328] [FEATURE] Add a generator for copying default sidebar partial * [#362] [FEATURE] Add a generator for only the dashboard manifest. Customizing this manifest before running the `administrate:install` generator will change which dashboards get generated. * [#295] [FEATURE] Add dashboard detection for ActiveRecord::Enum fields. * [#364] [FEATURE] Improve dashboard generator by explicitly listing out the generated `SHOW_PAGE_ATTRIBUTES` array elements. * [#416] [UI] Add an accessibility label to the search input * [#411] [UI] Use tabular figures in table cells * [#409] [UI] Use default system fonts * [#424] [BUGFIX] Fix a bug where running `rails destroy GENERATOR_NAME` would not work for several of the generators * [#390] [BUGFIX] Fix timestamp deprecation warnings * [#365] [COMPAT] Remove dependency on `inline_svg` * [#396] [I18n] Ukrainian * [#297] [I18n] Italian * [#307] [I18n] Fix German grammatical errors * [#363] [DOC] Move documentation into main repository, at the root URL * [#395] [DOC] Update inline documentation for collection partial * [#387] [DOC] Fix incorrect path for generators in the docs ```

c-lliope force-pushed the gw-destroy-generators branch from aaec23f to c78edcb Compare January 20, 2016 21:24

c-lliope mentioned this pull request Jan 20, 2016

Removes inline_svg dependency. #365

Closed

gylaz reviewed Jan 21, 2016
View reviewed changes

houndci-bot reviewed Jan 22, 2016
View reviewed changes

c-lliope force-pushed the gw-destroy-generators branch from 1b7a29f to 1146204 Compare January 22, 2016 06:53

c-lliope closed this Jan 22, 2016

c-lliope merged commit 1146204 into master Jan 22, 2016

c-lliope deleted the gw-destroy-generators branch January 22, 2016 06:55

c-lliope mentioned this pull request Jan 22, 2016

Release version 0.1.3 #428

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Let users undo the `administrate:views` generator #424

Let users undo the `administrate:views` generator #424

c-lliope commented Jan 20, 2016

gylaz Jan 21, 2016

c-lliope Jan 22, 2016

gylaz commented Jan 21, 2016

houndci-bot Jan 22, 2016

Let users undo the administrate:views generator #424

Let users undo the administrate:views generator #424

Conversation

c-lliope commented Jan 20, 2016

Problem:

Solution:

Minor changes:

gylaz Jan 21, 2016

Choose a reason for hiding this comment

c-lliope Jan 22, 2016

Choose a reason for hiding this comment

gylaz commented Jan 21, 2016

houndci-bot Jan 22, 2016

Choose a reason for hiding this comment

Let users undo the `administrate:views` generator #424

Let users undo the `administrate:views` generator #424