EfeAgare · October 18, 2019 12:41 · Feb 21, 2015 · Feb 20, 2015 · Feb 20, 2015 · Feb 20, 2015
diff --git a/gistfile1.md b/gistfile1.md
@@ -147,3 +147,8 @@ Examples:
  * `app/views/bigfoot_sightings/index.html.erb`
  * `app/views/bigfoot_sightings/show.html.erb`
  * `app/views/profile/show.html.erb`
+
+# More resources #
+
+* [ActiveRecord naming and schema conventions (including magic column names)](http://edgeguides.rubyonrails.org/active_record_basics.html#naming-conventions)
+* [Mind map of Rails conventions](https://teddicodes.files.wordpress.com/2015/02/railsnamingconventions.pdf)
diff --git a/gistfile1.md b/gistfile1.md
@@ -113,7 +113,6 @@ end
 
 ```ruby
 # app/controllers/profiles_controller.rb
-# This controller is singular
 ProfilesController < ApplicationController
   def show
     # ...
@@ -132,6 +131,8 @@ Example:
 
 ```ruby
 resources :bigfoot_sightings
+# Users can only see their own profiles, so we'll use `/profile` instead
+# of putting an id in the URL.
 resource :profile
 ```
 

diff --git a/gistfile1.md b/gistfile1.md
@@ -49,13 +49,13 @@ Model files go in `app/models/#{singular_model_name}.rb`.
 
 Example:
 
-```
+```ruby
 # app/models/bigfoot_sighting.rb
 class BigfootSighting < ActiveRecord::Base
   # This class will have these attributes: id, sighted_at, location
 end
 ```
-```
+```ruby
 # app/models/profile.rb
 class Profile < ActiveRecord::Base
   # Methods follow the same conventions as attributes
@@ -73,14 +73,14 @@ Rails expects foreign keys in the database to have an `_id` suffix, and will map
 
 Example:
 
-```
+```ruby
 # app/models/bigfoot_sighting.rb
 class BigfootSighting < ActiveRecord::Base
   # This knows to use the profile_id field in the database
   belongs_to :profile
 end
 ```
-```
+```ruby
 # app/models/profile.rb
 class Profile < ActiveRecord::Base
   # This knows to look at the BigfootSighting class and find the foreign key in that table
@@ -98,7 +98,7 @@ Controller files go in `app/controllers/#{resource_name}_controller.rb`.
 
 Example:
 
-```
+```ruby
 # app/controllers/bigfoot_sightings_controller.rb
 BigfootSightingsController < ApplicationController
   def index
@@ -111,7 +111,7 @@ BigfootSightingsController < ApplicationController
 end
 ```
 
-```
+```ruby
 # app/controllers/profiles_controller.rb
 # This controller is singular
 ProfilesController < ApplicationController
@@ -130,7 +130,7 @@ Route names are `snake_case`, and usually match the controller. Most of the time
 
 Example:
 
-```
+```ruby
 resources :bigfoot_sightings
 resource :profile
 ```

diff --git a/gistfile1.md b/gistfile1.md
@@ -45,7 +45,7 @@ Model *class names* use `CamelCase`. These are **singular**, and will map automa
 
 Model *attributes* and *methods* use `snake_case` and match the column names in the database.
 
-Model files go in `app/models/singular_model_name.rb`.
+Model files go in `app/models/#{singular_model_name}.rb`.
 
 Example:
 
@@ -94,7 +94,7 @@ Controller *class names* use `CamelCase` and have `Controller` as a suffix. The
 
 Controller *actions* use `snake_case` and usually match the standard route names Rails defines (`index`, `show`, `new`, `create`, `edit`, `update`, `delete`).
 
-Controller files go in `app/controllers/resource_name_controller.rb`.
+Controller files go in `app/controllers/#{resource_name}_controller.rb`.
 
 Example:
 
@@ -139,7 +139,7 @@ resource :profile
 
 View file names, by default, match the controller and action that they are tied to.
 
-Views go in `app/views/resource_name/action_name.html.erb`.
+Views go in `app/views/#{resource_name}/#{action_name}.html.erb`.
 
 Examples:
 

diff --git a/gistfile1.md b/gistfile1.md
@@ -83,6 +83,7 @@ end
 ```
 # app/models/profile.rb
 class Profile < ActiveRecord::Base
+  # This knows to look at the BigfootSighting class and find the foreign key in that table
   has_many :bigfoot_sightings
 end
 ```

diff --git a/gistfile1.md b/gistfile1.md
@@ -59,7 +59,7 @@ end
 # app/models/profile.rb
 class Profile < ActiveRecord::Base
   # Methods follow the same conventions as attributes
-  def veteran?
+  def veteran_hunter?
     years_of_experience > 2
   end
 end

diff --git a/gistfile1.md b/gistfile1.md
@@ -1,5 +1,17 @@
 # Rails naming conventions #
 
+## General Ruby conventions ##
+
+Class names are `CamelCase`.
+
+Methods and variables are `snake_case`.
+
+Methods with a `?` suffix will return a boolean.
+
+Methods with a `!` suffix mean one of two things: either the method operates destructively in some fashion, or it will raise and exception instead of failing (such as Rails models' `#save!` vs. `#save`).
+
+In documentation, `::method_name` denotes a *class method*, while `#method_name` denotes a *instance method*.
+
 ## Database ##
 
 *Database tables* use `snake_case`. Table names are **plural**.

diff --git a/gistfile1.md b/gistfile1.md
@@ -2,10 +2,31 @@
 
 ## Database ##
 
-*Database table names* use `snake_case`. Table names are **plural**.
+*Database tables* use `snake_case`. Table names are **plural**.
 
 *Column names* in the database use `snake_case`, but are generally **singular**.
 
+Example:
+
+```
++--------------------------+
+| bigfoot_sightings        |
++------------+-------------+
+| id         | ID          |
+| sighted_at | DATETIME    |
+| location   | STRING      |
+| profile_id | FOREIGN KEY |
++------------+-------------+
+
++------------------------------+
+| profiles                     |
++---------------------+--------+
+| id                  | ID     |
+| name                | STRING |
+| years_of_experience | INT    |
++---------------------+--------+
+```
+
 ## Model ##
 
 Model *class names* use `CamelCase`. These are **singular**, and will map automatically to the plural database table name.
@@ -14,22 +35,101 @@ Model *attributes* and *methods* use `snake_case` and match the column names in
 
 Model files go in `app/models/singular_model_name.rb`.
 
+Example:
+
+```
+# app/models/bigfoot_sighting.rb
+class BigfootSighting < ActiveRecord::Base
+  # This class will have these attributes: id, sighted_at, location
+end
+```
+```
+# app/models/profile.rb
+class Profile < ActiveRecord::Base
+  # Methods follow the same conventions as attributes
+  def veteran?
+    years_of_experience > 2
+  end
+end
+```
+
+### Relations in models ###
+
+Relations use `snake_case` and follow the type of relation, so `has_one` and `belongs_to` are **singular** while `has_many` is **plural**.
+
+Rails expects foreign keys in the database to have an `_id` suffix, and will map relations to those keys automatically if the names line up.
+
+Example:
+
+```
+# app/models/bigfoot_sighting.rb
+class BigfootSighting < ActiveRecord::Base
+  # This knows to use the profile_id field in the database
+  belongs_to :profile
+end
+```
+```
+# app/models/profile.rb
+class Profile < ActiveRecord::Base
+  has_many :bigfoot_sightings
+end
+```
+
 ## Controllers ##
 
-Controller *class names* use `CamelCase` and have `Controller` as a suffix. The name of the controller is usually **plural**, unless it deals with a singular resource[^1]. The `Controller` suffix is always singular.
+Controller *class names* use `CamelCase` and have `Controller` as a suffix. The `Controller` suffix is always singular. The name of the resource is usually **plural**.
 
-Controller *actions* use `snake_case` and usually match the standard route names Rails defines.
+Controller *actions* use `snake_case` and usually match the standard route names Rails defines (`index`, `show`, `new`, `create`, `edit`, `update`, `delete`).
 
 Controller files go in `app/controllers/resource_name_controller.rb`.
 
+Example:
+
+```
+# app/controllers/bigfoot_sightings_controller.rb
+BigfootSightingsController < ApplicationController
+  def index
+    # ...
+  end
+  def show
+    # ...
+  end
+  # etc
+end
+```
+
+```
+# app/controllers/profiles_controller.rb
+# This controller is singular
+ProfilesController < ApplicationController
+  def show
+    # ...
+  end
+  # etc
+end
+```
+
 ## Routes ##
 
-Route names are `snake_case`. They match the controller, so if the controller is plural then the route name will be plural and use the plural `resources`. If the controller is singular then the route name will be singular and will use the singular `resource`.
+Route names are `snake_case`, and usually match the controller. Most of the time routes are **plural** and use the plural `resources`.
+
+[Singular routes](http://edgeguides.rubyonrails.org/routing.html#singular-resources) are a special case. These use the singular `resource` and a singular resource name. However, they still map to a plural controller by default!
+
+Example:
+
+```
+resources :bigfoot_sightings
+resource :profile
+```
 
 ## Views ##
 
 View file names, by default, match the controller and action that they are tied to.
 
-Views go in `app/views/resource_name/action_name.erb.html`.
+Views go in `app/views/resource_name/action_name.html.erb`.
+
+Examples:
 
-[^1]: Singular resource controllers are used when there can logically be only one instance of a resource available. For example, we might use a singular `ProfileController` if users can only access their own profile.
+ * `app/views/bigfoot_sightings/index.html.erb`
+ * `app/views/bigfoot_sightings/show.html.erb`
+ * `app/views/profile/show.html.erb`
diff --git a/gistfile1.md b/gistfile1.md
@@ -0,0 +1,35 @@
+# Rails naming conventions #
+
+## Database ##
+
+*Database table names* use `snake_case`. Table names are **plural**.
+
+*Column names* in the database use `snake_case`, but are generally **singular**.
+
+## Model ##
+
+Model *class names* use `CamelCase`. These are **singular**, and will map automatically to the plural database table name.
+
+Model *attributes* and *methods* use `snake_case` and match the column names in the database.
+
+Model files go in `app/models/singular_model_name.rb`.
+
+## Controllers ##
+
+Controller *class names* use `CamelCase` and have `Controller` as a suffix. The name of the controller is usually **plural**, unless it deals with a singular resource[^1]. The `Controller` suffix is always singular.
+
+Controller *actions* use `snake_case` and usually match the standard route names Rails defines.
+
+Controller files go in `app/controllers/resource_name_controller.rb`.
+
+## Routes ##
+
+Route names are `snake_case`. They match the controller, so if the controller is plural then the route name will be plural and use the plural `resources`. If the controller is singular then the route name will be singular and will use the singular `resource`.
+
+## Views ##
+
+View file names, by default, match the controller and action that they are tied to.
+
+Views go in `app/views/resource_name/action_name.erb.html`.
+
+[^1]: Singular resource controllers are used when there can logically be only one instance of a resource available. For example, we might use a singular `ProfileController` if users can only access their own profile.