Merge branch 'master' into Ruby

Author: bendelonlee

README.md

@@ -13,6 +13,7 @@ We accept recommendations from all enthusiastic who care about the quality. The
 * [Java](/java/)
 * [PHP](/php/)
 * [Python](/python/)
+* [Ruby](/ruby/)
 * [VueJS](/vuejs/)
 
 ## Contributions

SUMMARY.md

@@ -49,4 +49,10 @@
   * [Package Naming](python/file-naming.md)
   * [Exception( Error ) Naming](python/exception-naming.md)
   * [Underscore](python/underscore.md)
-
+* [Ruby](ruby/README.md)
+  * [Class Naming](ruby/class-naming.md)
+  * [Constant Naming](ruby/constant-naming.md)
+  * [Module Naming](ruby/file-naming.md)
+  * [Method Naming](ruby/method-naming.md)
+  * [Package Naming](ruby/module-naming.md)
+  * [Variable Naming](ruby/variable-naming.md)

ruby/README.md

@@ -2,12 +2,12 @@
 
 List of covered sections:
 
-* [Class Naming](../Ruby/class-naming.md)
-* [Constant Naming](../Ruby/constant-naming.md)
-* [Module Naming](../Ruby/file-naming.md)
-* [Method Naming](../Ruby/method-naming.md)
-* [Package Naming](../Ruby/module-naming.md)
-* [Variable Naming](../Ruby/variable-naming.md)
+* [Class Naming](../ruby/class-naming.md)
+* [Constant Naming](../ruby/constant-naming.md)
+* [Module Naming](../ruby/file-naming.md)
+* [Method Naming](../ruby/method-naming.md)
+* [Package Naming](../ruby/module-naming.md)
+* [Variable Naming](../ruby/variable-naming.md)
 
 #### TL;DR
 

ruby/class-naming.md

@@ -1,38 +1,12 @@
-<<<<<<< Updated upstream
-# Python Naming Convention > Class Naming
-=======
 # Ruby Naming Convention > Class Naming
->>>>>>> Stashed changes
 
 ## PascalCase
 
 * Begin with an uppercase letter
 * Preferably a noun e.g. Car, Bird, MountainBike
 * Avoid acronyms and abbreviations
 
-<<<<<<< Updated upstream
-```python
-class Car:
-    ...
-```
-
-## Private Class
-
-Python does not support privacy directly. This naming convention is used as a weak internal use indicator.
-
-* Should follow the above naming conventions
-* Should use a leading underscore (_) to distinguish between "public" and "private" classes
-* For more read the [official python documentation](https://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references). 
-
-```
-class _Car: # private class
-```
-
-
-
-=======
 ```ruby
 class Car
     ...
 ```
->>>>>>> Stashed changes

ruby/constant-naming.md

@@ -1,26 +1,12 @@
-<<<<<<< Updated upstream
-# Python Naming Convention > Constant Naming
-=======
 # Ruby Naming Convention > Constant Naming
->>>>>>> Stashed changes
 
 ## SCREAMING_SNAKE_CASE
 
 * Should be all uppercase letters e.g. AGE, HEIGHT
 * If the name contains multiple words, it should be separated by underscores (_) such as DAYS_IN_MONTH
 * May contain digits but not as the first letter
 
-<<<<<<< Updated upstream
-```python
-class Product:
-    MAX_TEMPERATURE = 36;
-```
-
-
-
-=======
 ```ruby
 class Product
     MAX_TEMPERATURE = 36;
 ```
->>>>>>> Stashed changes

ruby/file-naming.md

@@ -1,28 +1,13 @@
-<<<<<<< Updated upstream
-# Python module Convention > Package Naming
-=======
 # Ruby module Convention > File Naming
->>>>>>> Stashed changes
 
 ## snake_case
 
 * Should be in lowercase.
 * If the name contains multiple words, an underscore (_) should separate it.E.g. expression_engine
 * The name should resonate with the class or methods inside the module
 
-<<<<<<< Updated upstream
-```python
-from math import factorial
-class Car:
-    ...
-```
-
-
-
-=======
 ```ruby
 require './application_record'
 class Car
     ...
 ```
->>>>>>> Stashed changes

ruby/method-naming.md

@@ -1,39 +1,10 @@
-<<<<<<< Updated upstream
-# Python Naming Convention > Method Naming
-=======
 # Ruby Naming Convention > Method Naming
->>>>>>> Stashed changes
 
 ## snake_case
 
 * Should be all in lowercase
 * Preferably a verb e.g. get_car(), purchase(), book()
 * If the name contains multiple words, it should be separated by underscores \(\_\) e.g. get\_json\(\)
-<<<<<<< Updated upstream
-
-```python
-class Person:
-    def get_height(self):
-        return self.height
-```
-
-## Private Method
-
-Python does not support privacy directly. This naming convention is used as a weak internal use indicator.
-
-* Should follow the above naming conventions
-* Should use a leading underscore (_) to distinguish between "public" and "private" functions in a module
-* For more read the [official python documentation](https://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references). 
-
-```
-class Person:
-    def _foot_to_centimeter(self): # private method
-        return self.height * 30.48
-```
-
-
-
-=======
 * Clear and descriptive method names without abbreviations are preferred.
 
 ```ruby
@@ -65,4 +36,3 @@ end
 ```
 
 Above, `get_height()` is public, `get_weight()` is private. You may use the `public` key word below `private`, but generally this is not done.
->>>>>>> Stashed changes

ruby/variable-naming.md

@@ -1,40 +1,11 @@
-<<<<<<< Updated upstream
-# Python Naming Convention > Variable Naming
-=======
 # Ruby Naming Convention > Variable Naming
->>>>>>> Stashed changes
 
 ## snake_case
 
 * Should be all in lowercase
 * Not begin with the special characters like e.g. & (ampersand), $ (dollar)
 * If the name contains multiple words, it should be separated by underscores (_) e.g. json_string
 * Avoid one-character variables e.g. a, b
-<<<<<<< Updated upstream
-
-```python
-class Student
-    age = None
-    ...
-```
-
-## Private Variable
-
-Python does not support privacy directly. This naming convention is used as a weak internal use indicator.
-
-* Should follow the above naming conventions
-* Should use a leading underscore (_) to distinguish between "public" and "private" variables
-* For more read the [official python documentation](https://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references). 
-
-```
-class Student:
-    age = None # public variable
-    _id = 0 # Private variable
-```
-
-
-
-=======
 * Clear and descriptive variable names without abbreviations are preferred.
 
 ```ruby
@@ -54,4 +25,3 @@ class Student
 ```
 
 Other prefixes include '$' for global variables, and '@@' for class variables. But when possible, instance and local variables are preferred. 
->>>>>>> Stashed changes