rails g controller -e jbuilder caused errors.

[zw963]

Hi, I create some issue for here. rails/rails#26525

But, they told me those bugs maybe relative to jbuilder.

so, I copy that issue here.

Steps to reproduce

Following example: we expect create view like app/views/follow_keyword/index.json.jbuilder
Not app/views/follow_keywords/index.json.jbuilder

$: spring rails generate controller follow_keyword index follow unfollow -e jbuilder --skip-routes --skip
Running via Spring preloader in process 20698
      create  app/controllers/follow_keyword_controller.rb
      invoke  jbuilder
      create    app/views/follow_keywords/index.json.jbuilder
      create    app/views/follow_keywords/show.json.jbuilder
      create    app/views/follow_keywords/_follow_keyword.json.jbuilder
      invoke  test_unit
      create    test/controllers/follow_keyword_controller_test.rb
      invoke  helper
      create    app/helpers/follow_keyword_helper.rb
      invoke    test_unit
      invoke  assets
      invoke    coffee
      create      app/assets/javascripts/follow_keyword.coffee
      invoke    scss
      create      app/assets/stylesheets/follow_keyword.scss

Following example, exist similiar errors.

spring rails generate controller follow_keywords index follow unfollow -e jbuilder --skip-routes --skip
Running via Spring preloader in process 22314
      create  app/controllers/follow_keywords_controller.rb
      invoke  jbuilder
  [WARNING] The model name 'follow_keywords' was recognized as a plural, using the singular 'follow_keyword' instead. Override with --force-plural or setup custom inflection rules for this noun before running the generator.
      create    app/views/follow_keywords/index.json.jbuilder
      create    app/views/follow_keywords/show.json.jbuilder
      create    app/views/follow_keywords/_follow_keyword.json.jbuilder
      invoke  test_unit
      create    test/controllers/follow_keyword_controller_test.rb
      invoke  helper
      create    app/helpers/follow_keyword_helper.rb
      invoke    test_unit
      invoke  assets
      invoke    coffee
      create      app/assets/javascripts/follow_keyword.coffee
      invoke    scss
      create      app/assets/stylesheets/follow_keyword.scss

System configuration

Rails version:

5.0.0.1

Ruby version:
2.2.4

Steps to reproduce

spring rails generate controller api/v1/follow_keywords index follow unfollow -e jbuilder --skip-routes --force-plural --no-assets --skip
Running via Spring preloader in process 32640
      create  app/controllers/api/v1/follow_keywords_controller.rb
      invoke  jbuilder
      create    app/views/api/v1/follow_keywords
      create    app/views/api/v1/follow_keywords/index.json.jbuilder
      create    app/views/api/v1/follow_keywords/show.json.jbuilder
      create    app/views/api/v1/follow_keywords/_api_v1_follow_keyword.json.jbuilder
      invoke  test_unit
      create    test/controllers/api/v1/follow_keywords_controller_test.rb
      invoke  helper
      create    app/helpers/api/v1/follow_keywords_helper.rb
      invoke    test_unit

Expected behavior

Expect generate partial file is:
app/views/api/v1/follow_keywords/_follow_keyword.json.jbuilder

System configuration

Rails version:
5.0.0.1

Ruby version:
2.2.4

[oklas]

Seems this is right behaviour. Command line documentation show:

   bin/rails generate controller Greetings hello

     create  app/controllers/greetings_controller.rb
      route  get "greetings/hello"
     invoke  erb
     create    app/views/greetings
     create    app/views/greetings/hello.html.erb
     ...

The view folder is greetings - as follow_keywords is plural too.
Problem is wrong default paths to jbuilder view.
Most probably controller generator call was wrong.
This is example of wrong generator call (singular form of name):

    # this is wrong call - do not do it
    bin/rails generate controller Greeting hello

      create  app/controllers/greeting_controller.rb
       route  get 'greeting/hello'
      invoke  jbuilder
      create    app/views/greetings
      create    app/views/greetings/index.json.jbuilder
      ...

Controller generator requre plural form of controller name.
The cite from documetation above shows name Greetings but not Greeting.
The generated views path is always plural.
But controller path is exactly as specified in command line.
Default paths for views dependent from controller name.
Specify controller name in plural form as described in documentation:

bin/rails generate controller Greetings hello

and default paths for views will be plural as actual views path and all will be right.

[chengyus]

I ran into this issue recently; but, for the impatient, the tl;dr command-line snipplet that solved my own situation:

rails g controller YourModelName --no-helper --no-assets -e=jbuilder index

(be sure to replace YourModelName with the actual your model name, preferably for the model, singular)

Goal: This comment aims to help people getting around just generating a jbuilder (blah.json.jbuilder) view template by using a rails g controller command-line with proper arguments while having installed; the rails g controller -h actually gives correct syntax overview. My case for agreeing with the issue filed against the bug is of the following form:

rails g controller UserMeta --no-helper --no-assets -e=jbuilder --force-plural index

Although in this case, I didn't put my action before the bunch of options, it seemed to work.

A bit of the unique own case experience sharing, most of the time like these, I didn't seem to have used the generator when building from scratch. This is especially true when you have SPA or specific template language (hopefully your team super-positionly) adapts. (What I mean by super-positionly is allowing each individual team members to learn a more advanced template language at his/her own pace while allowing the degree of freedom for each developer (could be a contractor).

What's interesting is that although jbuilder gem is a default for JSON response most of the case, the rails g controller -h didn't seem to care explaining the default for the JSON mode response default template language in the help. (by the way, I usually don't use the --api option when newing my rails project; so please do not reply with API v1 v2 stuff ; don't need to go into that mode).

Now, personally, I don't like how the default automatic refactor of the singular model partial because I think jbuilder's Github explains the methods or constructs well (such as 'json.extract!' or 'json.array'). But the default generator refactors it so well that it assumes everyone uses certain (scafolding patterns) which is not true and a bit out of date for the freshest HOTwire or SPA or JS Framework stuff. (where your simple or complex controller action content/codes decides). But 'hey' it's just a generator, it does not know everything.