Update Lint Errors and Update to Ruby 2.2.1

* Fixed jsdoc issues
* Upgraded gems to current and Ruby to current 2.2.1
* Added brakeman rakefile

Author: justin808

Diff for: .ruby-version

@@ -1 +1 @@
-2.1.5
+2.2.1

Diff for: Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
-ruby "2.1.5"
+ruby "2.2.1"
 
 #
 # Bundle edge Rails instead: gem "rails", github: "rails/rails"
@@ -68,6 +68,8 @@ group :development, :test do
   gem "brakeman", require: false
 
   gem "bundler-audit", require: false
+
+  gem "rainbow"
 end
 
 gem "spring-commands-rspec", group: :development

Diff for: Gemfile.lock

@@ -36,12 +36,12 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.3.7)
+    addressable (2.3.8)
     arel (6.0.0)
     ast (2.0.0)
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
-    autoprefixer-rails (5.1.8)
+    autoprefixer-rails (5.1.11)
       execjs
       json
     binding_of_caller (0.7.2)
@@ -63,33 +63,33 @@ GEM
     bundler-audit (0.3.1)
       bundler (~> 1.2)
       thor (~> 0.18)
-    byebug (4.0.3)
+    byebug (5.0.0)
       columnize (= 0.9.0)
     capybara (2.4.4)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
-    capybara-screenshot (1.0.7)
+    capybara-screenshot (1.0.9)
       capybara (>= 1.0, < 3)
       launchy
-    capybara-webkit (1.4.1)
+    capybara-webkit (1.5.1)
       capybara (>= 2.3.0, < 2.5.0)
       json
     coffee-rails (4.1.0)
       coffee-script (>= 2.2.0)
       railties (>= 4.0.0, < 5.0)
-    coffee-script (2.3.0)
+    coffee-script (2.4.1)
       coffee-script-source
       execjs
-    coffee-script-source (1.9.1)
+    coffee-script-source (1.9.1.1)
     columnize (0.9.0)
     database_cleaner (1.4.1)
     debug_inspector (0.0.2)
     diff-lcs (1.2.5)
     erubis (2.7.0)
-    execjs (2.4.0)
+    execjs (2.5.2)
     factory_girl (4.5.0)
       activesupport (>= 3.0.0)
     factory_girl_rails (4.5.0)
@@ -98,14 +98,13 @@ GEM
     fastercsv (1.5.5)
     foreman (0.78.0)
       thor (~> 0.19.1)
-    globalid (0.3.3)
+    globalid (0.3.5)
       activesupport (>= 4.1.0)
     haml (4.0.6)
       tilt
     highline (1.6.21)
-    hike (1.2.3)
     i18n (0.7.0)
-    jbuilder (2.2.12)
+    jbuilder (2.2.16)
       activesupport (>= 3.0.0, < 5)
       multi_json (~> 1.2)
     jquery-rails (4.0.3)
@@ -116,21 +115,21 @@ GEM
     kgio (2.9.3)
     launchy (2.4.3)
       addressable (~> 2.3)
-    loofah (2.0.1)
+    loofah (2.0.2)
       nokogiri (>= 1.5.9)
     mail (2.6.3)
       mime-types (>= 1.16, < 3)
-    mime-types (2.4.3)
+    mime-types (2.5)
     mini_portile (0.6.2)
-    minitest (5.5.1)
+    minitest (5.6.1)
     multi_json (1.11.0)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
-    parser (2.2.0.3)
+    parser (2.2.2.3)
       ast (>= 1.1, < 3.0)
-    pg (0.18.1)
-    powerpack (0.1.0)
-    rack (1.6.0)
+    pg (0.18.2)
+    powerpack (0.1.1)
+    rack (1.6.1)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails (4.2.1)
@@ -167,9 +166,9 @@ GEM
     rake (10.4.2)
     rdoc (4.2.0)
       json (~> 1.4)
-    rspec-core (3.2.2)
+    rspec-core (3.2.3)
       rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    rspec-expectations (3.2.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-mocks (3.2.1)
@@ -184,14 +183,14 @@ GEM
       rspec-mocks (~> 3.2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
-    rubocop (0.29.1)
+    rubocop (0.31.0)
       astrolabe (~> 1.3)
-      parser (>= 2.2.0.1, < 3.0)
+      parser (>= 2.2.2.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
-    ruby-lint (2.0.3)
-      parser (~> 2.1, >= 2.1.1)
+    ruby-lint (2.0.4)
+      parser (~> 2.2)
       slop (~> 3.4, >= 3.4.7)
     ruby-progressbar (1.7.5)
     ruby2ruby (2.1.4)
@@ -200,29 +199,26 @@ GEM
     ruby_parser (3.6.6)
       sexp_processor (~> 4.1)
     sass (3.4.13)
-    sass-rails (5.0.1)
+    sass-rails (5.0.3)
       railties (>= 4.0.0, < 5.0)
       sass (~> 3.1)
       sprockets (>= 2.8, < 4.0)
       sprockets-rails (>= 2.0, < 4.0)
       tilt (~> 1.1)
-    scss-lint (0.37.0)
+    scss-lint (0.38.0)
       rainbow (~> 2.0)
       sass (~> 3.4.1)
     sdoc (0.4.1)
       json (~> 1.7, >= 1.7.7)
       rdoc (~> 4.0)
     sexp_processor (4.5.1)
     slop (3.6.0)
-    spring (1.3.3)
+    spring (1.3.6)
     spring-commands-rspec (1.0.4)
       spring (>= 0.9.1)
-    sprockets (2.12.3)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
+    sprockets (3.1.0)
       rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.2.4)
+    sprockets-rails (2.3.1)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
@@ -238,7 +234,7 @@ GEM
     uglifier (2.7.1)
       execjs (>= 0.3.0)
       json (>= 1.8.0)
-    unicorn (4.8.3)
+    unicorn (4.9.0)
       kgio (~> 2.6)
       rack
       raindrops (~> 0.7)
@@ -273,6 +269,7 @@ DEPENDENCIES
   rails (~> 4.2)
   rails-html-sanitizer
   rails_12factor
+  rainbow
   rspec-rails
   rubocop
   ruby-lint

Diff for: client/assets/javascripts/FluxAlt.js

@@ -1,4 +1,7 @@
 import Alt from 'alt';
 const alt = new Alt();
 
+/**
+ * See https://github.com/goatslacker/alt
+ */
 export default alt;

Diff for: client/assets/javascripts/actions/CommentActions.js

@@ -5,22 +5,22 @@ class CommentActions {
   /**
    * Fetch comments from server.
    *
-   * @param {String} url
-   * @param {Boolean} displaySpinner
-   * @returns {undefined}
+   * @param {String} url - Url used for remote request.
+   * @param {Boolean} displaySpinner - Flag whether to show wait spinner
+   * @return {void}
    */
   fetchComments(url, displaySpinner) {
     this.dispatch(displaySpinner);
     CommentsManager.fetchComments(url)
       .then((comments) => this.actions.updateComments(comments),
-            (errorMessage) => this.actions.updateCommentsError(errorMessage));
+      (errorMessage) => this.actions.updateCommentsError(errorMessage));
   }
 
   /**
    * A new list of comments is available, refresh the store.
    *
-   * @param {Array} comments
-   *  @returns {undefined}
+   * @param {Array} comments - New comments to replace those in the store
+   * @return {void}
    */
   updateComments(comments) {
     this.dispatch(comments);
@@ -29,8 +29,8 @@ class CommentActions {
   /**
    * An error occurred while fetching comments, dispatch error message.
    *
-   * @param {String} errorMessage
-   *  @returns {undefined}
+   * @param {String} errorMessage - Error message received from server.
+   * @return {void}
    */
   updateCommentsError(errorMessage) {
     this.dispatch(errorMessage);
@@ -39,13 +39,12 @@ class CommentActions {
   /**
    * A new comment has been submitted to the server, dispatch it.
    *
-   * @param {Array} comment
-   *  @returns {undefined}
+   * @param {String} comment - New comment from UI.
+   * @return {void}
    */
   addComment(comment) {
     this.dispatch(comment);
   }
-
 }
 
 export default alt.createActions(CommentActions);

Diff for: client/assets/javascripts/actions/FormActions.js

@@ -6,8 +6,8 @@ class FormActions {
   /**
    * Text is being entered in the comment form, update the state.
    *
-   * @param {String} comment
-   *  @returns {undefined}
+   * @param {String} comment - Comment to update from form input.
+   * @return {void}
    */
   updateComment(comment) {
     this.dispatch(comment);
@@ -16,8 +16,9 @@ class FormActions {
   /**
    * Submit a new comment to the server.
    *
-   * @param {String} comment
-   *  @returns {undefined}
+   * @param {String} url - Url used for remote request to sumbmit the comment.
+   * @param {String} comment - New comment from UI to send to the server.
+   * @return {void}
    */
   submitComment(url, comment) {
     this.dispatch();

Diff for: client/assets/javascripts/utils/CommentsManager.js

@@ -4,8 +4,8 @@ const CommentsManager = {
   /**
    * Retrieve comments from server using AJAX call.
    *
-   * @param {String} url
-   *  @returns {Object}
+   * @param {String} url - Url of server to retrieve comments.
+   * @returns {Deferred} - jqXHR result of ajax call.
    */
   fetchComments(url) {
     return $.ajax({
@@ -17,9 +17,9 @@ const CommentsManager = {
   /**
    * Submit new comment to server using AJAX call.
    *
-   * @param {String} url
-   * @param {Object} comment
-   *  @returns {Object}
+   * @param {String} url - Url of where to post comment.
+   * @param {Object} comment - Comment body to post.
+   * @returns {Deferred} - jqXHR result of ajax call.
    */
   submitComment(url, comment) {
     return $.ajax({

Diff for: config/unicorn.rb

@@ -9,7 +9,7 @@
     Process.kill "QUIT", Process.pid
   end
 
-  defined?(ActiveRecord::Base) &&  ActiveRecord::Base.connection.disconnect!
+  defined?(ActiveRecord::Base) && ActiveRecord::Base.connection.disconnect!
 end
 
 # noinspection RubyUnusedLocalVariable

Diff for: lib/tasks/brakeman.rake

@@ -0,0 +1,17 @@
+namespace :brakeman do
+
+  desc "Run Brakeman"
+  task :run, :output_files do |t, args|
+    require 'brakeman'
+
+    files = args[:output_files].split(' ') if args[:output_files]
+    Brakeman.run :app_path => ".", :output_files => files, :print_report => true
+  end
+
+  desc "Check your code with Brakeman"
+  task :check do
+    require 'brakeman'
+    result = Brakeman.run app_path: '.', print_report: true
+    exit Brakeman::Warnings_Found_Exit_Code unless result.filtered_warnings.empty?
+  end
+end

Diff for: lib/tasks/ci.rake

@@ -2,24 +2,24 @@ if Rails.env.development?
   # See tasks/linters.rake
 
   task :bundle_audit do
-    puts "Running security audit on gems (bundle_audit)".green
+    puts Rainbow("Running security audit on gems (bundle_audit)").green
     Rake::Task["bundle_audit"].invoke
   end
 
   task :security_audit do
-    puts "Running security audit on code (brakeman)".green
+    puts Rainbow("Running security audit on code (brakeman)").green
     Rake::Task["brakeman:run"].invoke("tmp/brakeman-report.html")
   end
 
   namespace :ci do
     desc "Run all audits and tests"
     task all: [:environment, :lint, :spec, :bundle_audit, :security_audit] do
       begin
-        puts "PASSED".green
+        puts Rainbow("PASSED").green
         puts ""
       rescue Exception => e
         puts "#{e}"
-        puts "FAILED".red
+        puts Rainbow("FAILED").red
         puts ""
         raise(e)
       end