kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Use a single term instead of all terms used to describe path and URL helpers together

Browse source
This commit is contained in:
Sharang Dashputre 2019-05-12 01:58:57 +05:30
parent 41bc4c6207
commit 18504eb78f
5 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
actionpack/test/dispatch/prefix_generation_test.rb
View file

@ -304,7 +304,7 @@ module TestGenerationPrefix
assert_equal "/omg/blog/posts/1", path assert_equal "/omg/blog/posts/1", path
end end
test "[OBJECT] generating engine's route with named helpers" do test "[OBJECT] generating engine's route with named route helpers" do
path = engine_object.posts_path path = engine_object.posts_path
assert_equal "/awesome/blog/posts", path assert_equal "/awesome/blog/posts", path

2
guides/source/action_controller_overview.md
View file

@ -34,7 +34,7 @@ Controller Naming Convention
The naming convention of controllers in Rails favors pluralization of the last word in the controller's name, although it is not strictly required (e.g. `ApplicationController`). For example, `ClientsController` is preferable to `ClientController`, `SiteAdminsController` is preferable to `SiteAdminController` or `SitesAdminsController`, and so on. The naming convention of controllers in Rails favors pluralization of the last word in the controller's name, although it is not strictly required (e.g. `ApplicationController`). For example, `ClientsController` is preferable to `ClientController`, `SiteAdminsController` is preferable to `SiteAdminController` or `SitesAdminsController`, and so on.
Following this convention will allow you to use the default route generators (e.g. `resources`, etc) without needing to qualify each `:path` or `:controller`, and will keep URL and path helpers' usage consistent throughout your application. See [Layouts & Rendering Guide](layouts_and_rendering.html) for more details. Following this convention will allow you to use the default route generators (e.g. `resources`, etc) without needing to qualify each `:path` or `:controller`, and will keep named route helpers' usage consistent throughout your application. See [Layouts & Rendering Guide](layouts_and_rendering.html) for more details.
NOTE: The controller naming convention differs from the naming convention of models, which are expected to be named in singular form. NOTE: The controller naming convention differs from the naming convention of models, which are expected to be named in singular form.

2
guides/source/command_line.md
View file

@ -368,7 +368,7 @@ irb(main):001:0>
Inside the `rails console` you have access to the `app` and `helper` instances. Inside the `rails console` you have access to the `app` and `helper` instances.
With the `app` method you can access URL and path helpers, as well as do requests. With the `app` method you can access named route helpers, as well as do requests.
```bash ```bash
>> app.root_path >> app.root_path

2
guides/source/engines.md
View file

@ -264,7 +264,7 @@ contains a file called `application_helper.rb`. This file will provide any
common functionality for the helpers of the engine. The `blorgh` directory common functionality for the helpers of the engine. The `blorgh` directory
is where the other helpers for the engine will go. By placing them within is where the other helpers for the engine will go. By placing them within
this namespaced directory, you prevent them from possibly clashing with this namespaced directory, you prevent them from possibly clashing with
identically-named helpers within other engines or even within the identically-named route helpers within other engines or even within the
application. application.
Within the `app/jobs` directory there is a `blorgh` directory that Within the `app/jobs` directory there is a `blorgh` directory that

20
guides/source/routing.md
View file

@ -210,7 +210,7 @@ end
This will create a number of routes for each of the `articles` and `comments` controller. For `Admin::ArticlesController`, Rails will create: This will create a number of routes for each of the `articles` and `comments` controller. For `Admin::ArticlesController`, Rails will create:
| HTTP Verb | Path | Controller#Action | Named Helper | | HTTP Verb | Path | Controller#Action | Named Route Helper |
| --------- | ------------------------ | ---------------------- | ---------------------------- | | --------- | ------------------------ | ---------------------- | ---------------------------- |
| GET | /admin/articles | admin/articles#index | admin_articles_path | | GET | /admin/articles | admin/articles#index | admin_articles_path |
| GET | /admin/articles/new | admin/articles#new | new_admin_article_path | | GET | /admin/articles/new | admin/articles#new | new_admin_article_path |
@ -250,7 +250,7 @@ resources :articles, path: '/admin/articles'
In each of these cases, the named routes remain the same as if you did not use `scope`. In the last case, the following paths map to `ArticlesController`: In each of these cases, the named routes remain the same as if you did not use `scope`. In the last case, the following paths map to `ArticlesController`:
| HTTP Verb | Path | Controller#Action | Named Helper | | HTTP Verb | Path | Controller#Action | Named Route Helper |
| --------- | ------------------------ | -------------------- | ---------------------- | | --------- | ------------------------ | -------------------- | ---------------------- |
| GET | /admin/articles | articles#index | articles_path | | GET | /admin/articles | articles#index | articles_path |
| GET | /admin/articles/new | articles#new | new_article_path | | GET | /admin/articles/new | articles#new | new_article_path |
@ -373,7 +373,7 @@ end
The comments resource here will have the following routes generated for it: The comments resource here will have the following routes generated for it:
| HTTP Verb | Path | Controller#Action | Named Helper | | HTTP Verb | Path | Controller#Action | Named Route Helper |
| --------- | -------------------------------------------- | ----------------- | ------------------------ | | --------- | -------------------------------------------- | ----------------- | ------------------------ |
| GET | /articles/:article_id/comments(.:format) | comments#index | article_comments_path | | GET | /articles/:article_id/comments(.:format) | comments#index | article_comments_path |
| POST | /articles/:article_id/comments(.:format) | comments#create | article_comments_path | | POST | /articles/:article_id/comments(.:format) | comments#create | article_comments_path |
@ -383,7 +383,7 @@ The comments resource here will have the following routes generated for it:
| PATCH/PUT | /sekret/comments/:id(.:format) | comments#update | comment_path | | PATCH/PUT | /sekret/comments/:id(.:format) | comments#update | comment_path |
| DELETE | /sekret/comments/:id(.:format) | comments#destroy | comment_path | | DELETE | /sekret/comments/:id(.:format) | comments#destroy | comment_path |
The `:shallow_prefix` option adds the specified parameter to the named helpers: The `:shallow_prefix` option adds the specified parameter to the named route helpers:
```ruby ```ruby
scope shallow_prefix: "sekret" do scope shallow_prefix: "sekret" do
@ -395,7 +395,7 @@ end
The comments resource here will have the following routes generated for it: The comments resource here will have the following routes generated for it:
| HTTP Verb | Path | Controller#Action | Named Helper | | HTTP Verb | Path | Controller#Action | Named Route Helper |
| --------- | -------------------------------------------- | ----------------- | --------------------------- | | --------- | -------------------------------------------- | ----------------- | --------------------------- |
| GET | /articles/:article_id/comments(.:format) | comments#index | article_comments_path | | GET | /articles/:article_id/comments(.:format) | comments#index | article_comments_path |
| POST | /articles/:article_id/comments(.:format) | comments#create | article_comments_path | | POST | /articles/:article_id/comments(.:format) | comments#create | article_comments_path |
@ -638,7 +638,7 @@ You can specify a name for any route using the `:as` option:
get 'exit', to: 'sessions#destroy', as: :logout get 'exit', to: 'sessions#destroy', as: :logout
``` ```
This will create `logout_path` and `logout_url` as named helpers in your application. Calling `logout_path` will return `/exit` This will create `logout_path` and `logout_url` as named route helpers in your application. Calling `logout_path` will return `/exit`
You can also use this to override routing methods defined by resources, like this: You can also use this to override routing methods defined by resources, like this:
@ -934,7 +934,7 @@ resources :photos, controller: 'images'
will recognize incoming paths beginning with `/photos` but route to the `Images` controller: will recognize incoming paths beginning with `/photos` but route to the `Images` controller:
| HTTP Verb | Path | Controller#Action | Named Helper | | HTTP Verb | Path | Controller#Action | Named Route Helper |
| --------- | ---------------- | ----------------- | -------------------- | | --------- | ---------------- | ----------------- | -------------------- |
| GET | /photos | images#index | photos_path | | GET | /photos | images#index | photos_path |
| GET | /photos/new | images#new | new_photo_path | | GET | /photos/new | images#new | new_photo_path |
@ -982,7 +982,7 @@ NOTE: Of course, you can use the more advanced constraints available in non-reso
TIP: By default the `:id` parameter doesn't accept dots - this is because the dot is used as a separator for formatted routes. If you need to use a dot within an `:id` add a constraint which overrides this - for example `id: /[^\/]+/` allows anything except a slash. TIP: By default the `:id` parameter doesn't accept dots - this is because the dot is used as a separator for formatted routes. If you need to use a dot within an `:id` add a constraint which overrides this - for example `id: /[^\/]+/` allows anything except a slash.
### Overriding the Named Helpers ### Overriding the Named Route Helpers
The `:as` option lets you override the normal naming for the named route helpers. For example: The `:as` option lets you override the normal naming for the named route helpers. For example:
@ -992,7 +992,7 @@ resources :photos, as: 'images'
will recognize incoming paths beginning with `/photos` and route the requests to `PhotosController`, but use the value of the `:as` option to name the helpers. will recognize incoming paths beginning with `/photos` and route the requests to `PhotosController`, but use the value of the `:as` option to name the helpers.
| HTTP Verb | Path | Controller#Action | Named Helper | | HTTP Verb | Path | Controller#Action | Named Route Helper |
| --------- | ---------------- | ----------------- | -------------------- | | --------- | ---------------- | ----------------- | -------------------- |
| GET | /photos | photos#index | images_path | | GET | /photos | photos#index | images_path |
| GET | /photos/new | photos#new | new_image_path | | GET | /photos/new | photos#new | new_image_path |
@ -1097,7 +1097,7 @@ end
Rails now creates routes to the `CategoriesController`. Rails now creates routes to the `CategoriesController`.
| HTTP Verb | Path | Controller#Action | Named Helper | | HTTP Verb | Path | Controller#Action | Named Route Helper |
| --------- | -------------------------- | ------------------ | ----------------------- | | --------- | -------------------------- | ------------------ | ----------------------- |
| GET | /kategorien | categories#index | categories_path | | GET | /kategorien | categories#index | categories_path |
| GET | /kategorien/neu | categories#new | new_category_path | | GET | /kategorien/neu | categories#new | new_category_path |