initial linting for rubocop setup

Author: sethherr

.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  Exclude:
+    - 'Guardfile'
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+    - 'db/schema.rb'
+    - 'db/migrate/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+ParameterLists:
+  CountKeywordArgs: false

Gemfile

@@ -24,16 +24,16 @@ gem 'puma'
 gem 'bootstrap-sass', '~> 3.3.1'
 gem 'devise'
 gem 'omniauth'
-gem "omniauth-bike-index"
+gem 'omniauth-bike-index'
 gem 'devise-bootstrap-views'
-gem "hashie-forbidden_attributes"
+gem 'hashie-forbidden_attributes'
 
 # Store configuration options
 gem 'dotenv-rails'
 
 
 # Authentication
-gem 'doorkeeper',   '~> 2.2.2'
+gem 'doorkeeper', '~> 2.2.2'
 gem 'wine_bouncer'
 
 # Things tied in with Grade and swagger
@@ -44,7 +44,7 @@ gem 'active_model_serializers'
 gem 'grape-active_model_serializers'
 gem 'grape-swagger'
 gem 'api-pagination'
-gem 'rack-cors', :require => 'rack/cors'
+gem 'rack-cors', require: 'rack/cors'
 
 # Temporarily remote branch because updates, for more info look at
 # https://github.com/d4be4st/swagger-ui_rails/pull/13
@@ -61,15 +61,16 @@ group :development, :test do
   gem 'pry'
   gem 'growl'
   gem 'guard'
+  gem 'guard-rubocop'
   gem 'guard-rspec', '4.2.8'
   gem 'guard-livereload'
 end
 
-group :development do 
+group :development do
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
 end
 
-group :test do 
+group :test do
   gem 'database_cleaner'
-end
+end

Gemfile.lock

@@ -46,6 +46,7 @@ GEM
       tzinfo (~> 1.1)
     api-pagination (4.1.1)
     arel (6.0.3)
+    ast (2.2.0)
     autoprefixer-rails (6.0.3)
       execjs
       json
@@ -144,6 +145,9 @@ GEM
     guard-rspec (4.2.8)
       guard (~> 2.1)
       rspec (>= 2.14, < 4.0)
+    guard-rubocop (1.2.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
     haml (4.0.7)
       tilt
     hashie (3.4.3)
@@ -201,7 +205,10 @@ GEM
       oauth2 (~> 1.0)
       omniauth (~> 1.2)
     orm_adapter (0.5.0)
+    parser (2.3.0.6)
+      ast (~> 2.2)
     pg (0.18.3)
+    powerpack (0.1.1)
     pry (0.10.2)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -239,6 +246,7 @@ GEM
       activesupport (= 4.2.5)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
     rake (10.5.0)
     rb-fsevent (0.9.6)
     rb-inotify (0.9.5)
@@ -268,6 +276,13 @@ GEM
       rspec-mocks (~> 3.3.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
     sass (3.4.18)
     sass-rails (5.0.4)
       railties (>= 4.0.0, < 5.0)
@@ -299,6 +314,7 @@ GEM
     uglifier (2.7.2)
       execjs (>= 0.3.0)
       json (>= 1.8.0)
+    unicode-display_width (0.3.1)
     vcr (2.9.3)
     virtus (1.0.5)
       axiom-types (~> 0.1)
@@ -333,6 +349,7 @@ DEPENDENCIES
   guard
   guard-livereload
   guard-rspec (= 4.2.8)
+  guard-rubocop
   haml
   hashie-forbidden_attributes
   jquery-rails (~> 4.0.4)

Guardfile

@@ -1,14 +1,21 @@
-guard :rspec, cmd: 'bundle exec rspec', failed_mode: :focus do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-  watch(%r{^app/controllers/api/v1/(.+)\.rb$})        { |m| "spec/api/v1/#{m[1]}_spec.rb"}
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec', failed_mode: :focus do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { "spec" }
+    watch(%r{^app/controllers/api/v1/(.+)\.rb$})        { |m| "spec/api/v1/#{m[1]}_spec.rb"}
 
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  # watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+    # Rails example
+    watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+    watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+    watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+    # watch('config/routes.rb')                           { "spec/routing" }
+    watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  end
+
+  guard :rubocop, all_on_start: false do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end

app/controllers/api/base.rb

@@ -3,7 +3,7 @@ class Dispatch < Grape::API
     mount API::V1::Root
     format :json
     route :any, '*path' do
-      Rack::Response.new({message: "Not found"}.to_json, 404).finish
+      Rack::Response.new({message: 'Not found'}.to_json, 404).finish
     end
   end
 

app/controllers/api/logger.rb

@@ -12,12 +12,12 @@ def call(env)
       x_organization: env['HTTP_X_ORGANIZATION']
     }
 
-    ActiveSupport::Notifications.instrument "grape.request", payload do
+    ActiveSupport::Notifications.instrument 'grape.request', payload do
       @app.call(env).tap do |response|
-        if env["api.endpoint"].params.present? 
-          payload[:params] = env["api.endpoint"].params.to_hash
-          payload[:params].delete("route_info")
-          payload[:params].delete("format")
+        if env['api.endpoint'].params.present? 
+          payload[:params] = env['api.endpoint'].params.to_hash
+          payload[:params].delete('route_info')
+          payload[:params].delete('format')
         end
         payload[:response_status] = response[0]
       end

app/controllers/api/v1/defaults.rb

@@ -2,9 +2,9 @@ module API
   module V1
     module Defaults
       extend ActiveSupport::Concern
-      included do 
+      included do
         formatter :json, Grape::Formatter::ActiveModelSerializers
-        
+
         before do
           header['Access-Control-Allow-Origin'] = '*'
           header['Access-Control-Request-Method'] = '*'
@@ -23,7 +23,6 @@ def current_scopes
             current_token.scopes
           end
         end
-      
       end
     end
   end

app/controllers/api/v1/me.rb

@@ -3,16 +3,16 @@ module V1
     class Me < API::V1::Root
       include API::V1::Defaults
 
-      resource :me, desc: "Operations about the current user" do
+      resource :me, desc: 'Operations about the current user' do
 
-        desc "Current user's information in access token's scope<span class='accstr'>*</span>", {
-          notes: <<-NOTE
+        desc "Current user's information in access token's scope<span class='accstr'>*</span>" do
+          detail <<-NOTE
             Current user is the owner of the `access_token` you use in the request.
           NOTE
-        }
+        end
         oauth2 # This endpoint requires authentication
         get '/' do
-          result = {
+          {
             id: current_user.id.to_s,
             user: {
               email: current_user.email,
@@ -38,7 +38,7 @@ class Me < API::V1::Root
           optional :email, type: String, desc: 'User email'
           optional :name, type: String, desc: 'User name'
           # Demo of value list, displays as select in swagger-ui
-          optional :demo_value, type: String, values: ['value 1', 'value 2', '3'], default: 'value 1', desc: "Special value list"
+          optional :demo_value, type: String, values: ['value 1', 'value 2', '3'], default: 'value 1', desc: 'Special value list'
         end
         oauth2 'write_user'
         put '/' do
@@ -48,7 +48,7 @@ class Me < API::V1::Root
           demo_value = declared_p.delete(:demo_value)
 
           current_user.update_attributes(declared_p)
-          result = {
+          {
             id: current_user.id.to_s,
             user: {
               value: demo_value,

app/controllers/api/v1/root.rb

@@ -32,19 +32,19 @@ class Root < Dispatch
       mount API::V1::Me
 
       add_swagger_documentation base_path: "/api",
-        api_version: 'v1',
-        hide_format: true, # don't show .json
-        hide_documentation_path: true,
-        mount_path: "/swagger_doc",
-        markdown: GrapeSwagger::Markdown::KramdownAdapter,
-        info: {
-            title: "Grape Swagger base app",
-            description: "This is the base api provided by the awesome sample app - https://github.com/sethherr/grape-doorkeeper",
-          }
+                                api_version: 'v1',
+                                hide_format: true, # don't show .json
+                                hide_documentation_path: true,
+                                mount_path: '/swagger_doc',
+                                markdown: GrapeSwagger::Markdown::KramdownAdapter,
+                                info: {
+                                    title: 'Grape Swagger base app',
+                                    description: 'This is the base api provided by the awesome sample app - https://github.com/sethherr/grape-doorkeeper',
+                                  }
 
       route :any, '*path' do
-        raise StandardError, "Unable to find endpoint"
+        raise StandardError, 'Unable to find endpoint'
       end
     end
   end
-end
+end

app/controllers/documentation_controller.rb

@@ -1,5 +1,4 @@
 class DocumentationController < ApplicationController
-
   def index
     @applications = Doorkeeper::Application.all
     render layout: false
@@ -14,6 +13,4 @@ def authorize
     @access_grant = Doorkeeper::AccessGrant.where(resource_owner_id: current_user.id, token: @access_code).last
     @application = @access_grant.application if @access_grant.present?
   end
-
-
 end