Configure RuboCop

Author: kasper

.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  RunRailsCops: true
+  Include:
+    - '**/config.ru'
+    - '**/Rakefile'
+  Exclude:
+    - 'db/**/*'
+    - 'ext/**/*'
+    - 'tmp/**/*'
+
+# Style
+
+Style/Documentation:
+  Enabled: false
+
+# Metrics
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

Contributing.md

@@ -10,6 +10,9 @@ It may take some time to run whole test suite, thus while developing one
 may find beneficial to run just single test cases or tests from one
 file.
 
+##### To run all code style validations
+`bundle exec rubocop`
+
 ##### To run all tests
 `rvmsudo rake spec`
 

Gemfile

@@ -43,4 +43,5 @@ group :development, :test do
   gem 'launchy'  # for capybara's save_and_open_page
   gem 'railroady' # for doc/diagrams
   gem 'simplecov'
+  gem 'rubocop', '~> 0.29.1', require: false
 end

Gemfile.lock

@@ -34,6 +34,9 @@ GEM
     addressable (2.3.6)
     andand (1.3.3)
     arel (5.0.1.20140414130214)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
     autoparse (0.3.3)
       addressable (>= 2.3.1)
       extlib (>= 0.9.15)
@@ -115,6 +118,8 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    parser (2.2.0.3)
+      ast (>= 1.1, < 3.0)
     pg (0.17.1)
     pghero (0.1.7)
       activerecord
@@ -124,6 +129,7 @@ GEM
       cliver (~> 0.3.1)
       multi_json (~> 1.0)
       websocket-driver (>= 0.2.0)
+    powerpack (0.1.0)
     rack (1.5.2)
     rack-cors (0.2.9)
     rack-protection (1.5.3)
@@ -146,6 +152,7 @@ GEM
       activesupport (= 4.1.8)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.0.0)
     rake (10.4.2)
     rdoc (4.2.0)
       json (~> 1.4)
@@ -177,7 +184,14 @@ GEM
       rspec-mocks (~> 3.1.0)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
+    rubocop (0.29.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
     ruby-prof (0.12.2)
+    ruby-progressbar (1.7.1)
     signet (0.6.0)
       addressable (~> 2.3)
       extlib (~> 0.9)
@@ -249,6 +263,7 @@ DEPENDENCIES
   rspec-activemodel-mocks (~> 1.0.0)
   rspec-core (~> 3.1.0)
   rspec-rails (~> 3.1.0)
+  rubocop (~> 0.29.1)
   ruby-prof (~> 0.12.2)
   simplecov
   sprockets-rails

Installation.md

@@ -22,7 +22,8 @@ The following programs should be installed first: `ruby` (and `bundler` gem), `P
 7. Go to `ext/tmc-sandbox/web` and install dependencies with `bundle install`. Compile extensions with `rake ext` and run tests with `rvmsudo rake test`.
 8. Compile the other stuff in `ext` by doing `rake compile`
 9. Install [tmc-check](https://github.com/testmycode/tmc-check) by running `rvmsudo make rubygems install clean` in `ext/tmc-sandbox/uml/output/tmc-check`.
-10. Run the test suite with `rvmsudo rake spec`.
+10. Verify code style with `bundle exec rubocop`.
+11. Run the test suite with `rvmsudo rake spec`.
 
 After you get the test suite to pass see [post-install instructions](#post-install-instructions).
 
@@ -187,6 +188,11 @@ $ cd tmc-sandbox/uml/output/tmc-check
 $ rvmsudo make rubygems install clean
 ```
 
+#### Verify code style
+```bash
+$ bundle exec rubocop
+```
+
 #### Run the test suite
 In the tmc-server root directory run
 ```bash