Implemented RuboCop, ruby style linter.

dblock · dblock · commit 357140dbebf3 · 2015-08-19T12:25:21.000-04:00
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+inherit_from: .rubocop_todo.yml
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -0,0 +1,61 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-19 12:23:54 -0400 using RuboCop version 0.33.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'lib/tasks/swagger_ui.rake'
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'spec/dummy/bin/spring'
+
+# Offense count: 2
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/dummy/bin/rails'
+    - 'spec/dummy/bin/rake'
+
+# Offense count: 31
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 129
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 9
+Style/Documentation:
+  Exclude:
+    - 'app/controllers/grape_swagger_rails/application_controller.rb'
+    - 'lib/grape-swagger-rails.rb'
+    - 'lib/grape-swagger-rails/engine.rb'
+    - 'lib/grape-swagger-rails/version.rb'
+    - 'spec/dummy/app/api/api.rb'
+    - 'spec/dummy/app/controllers/application_controller.rb'
+    - 'spec/dummy/app/controllers/welcome_controller.rb'
+    - 'spec/dummy/config/application.rb'
+
+# Offense count: 2
+# Configuration parameters: Exclude.
+Style/FileName:
+  Exclude:
+    - 'lib/grape-swagger-rails.rb'
+    - 'spec/features/grape-swagger-rails_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/tasks/swagger_ui.rake'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 * [#6](https://github.com/ruby-grape/grape-swagger-rails/pull/6): Fix: support multiple predefined headers - [@Tyr0](https://github.com/tyr0).
 * Upgraded swagger-ui to v2.1.1 - [@dblock](https://github.com/dblock).
 * Grape-swagger 0.7.2 is no longer supported - [@dblock](https://github.com/dblock).
+* Implemented RuboCop, Ruby-style linter - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 ### 0.1.0 (February 5, 2015)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -46,6 +46,9 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
 
 Implement your feature or bug fix.
 
+Ruby style is enforced with [RuboCop](https://github.com/bbatsov/rubocop).
+Run `bundle exec rubocop` and fix any style issues highlighted.
+
 Make sure that `bundle exec rake` completes without errors.
 
 You might find it useful to iterate on code by running the test project from spec/dummy.
diff --git a/Rakefile b/Rakefile
@@ -5,7 +5,7 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
 
 load 'rails/tasks/engine.rake'
 Bundler::GemHelper.install_tasks
@@ -17,7 +17,10 @@ end
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-desc "Run all specs."
+desc 'Run all specs.'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]
diff --git a/config/routes.rb b/config/routes.rb
@@ -1,3 +1,3 @@
 GrapeSwaggerRails::Engine.routes.draw do
-  root :to => "application#index"
+  root to: 'application#index'
 end
diff --git a/grape-swagger-rails.gemspec b/grape-swagger-rails.gemspec
@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Swagger UI as Rails Engine for grape-swagger gem'
   spec.homepage      = 'https://github.com/ruby-grape/grape-swagger-rails'
   spec.license       = 'MIT'
-  spec.files         = `git ls-files`.split($/)
-  spec.test_files    = `git ls-files spec`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = `git ls-files spec`.split($INPUT_RECORD_SEPARATOR)
   spec.require_paths = %w(lib)
 
   spec.add_dependency 'railties', '>= 3.2.12'
@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'grape-swagger-ui'
   spec.add_development_dependency 'sprockets'
   spec.add_development_dependency 'rack-cors'
+  spec.add_development_dependency 'rubocop', '0.33.0'
 end
diff --git a/lib/grape-swagger-rails.rb b/lib/grape-swagger-rails.rb
@@ -1,12 +1,12 @@
-require "grape-swagger-rails/engine"
+require 'grape-swagger-rails/engine'
 
 module GrapeSwaggerRails
   class Options < OpenStruct
     def before_filter(&block)
       if block_given?
         self.before_filter_proc = block
       else
-        self.before_filter_proc
+        before_filter_proc
       end
     end
   end
@@ -27,5 +27,4 @@ def before_filter(&block)
 
     before_filter_proc:   nil # Proc used as a controller before filter
   )
-
 end
diff --git a/lib/grape-swagger-rails/version.rb b/lib/grape-swagger-rails/version.rb
@@ -1,3 +1,3 @@
 module GrapeSwaggerRails
-  VERSION = "0.1.1"
+  VERSION = '0.1.1'
 end
diff --git a/lib/tasks/swagger_ui.rake b/lib/tasks/swagger_ui.rake
@@ -2,7 +2,7 @@ require 'git'
 
 namespace :swagger_ui do
   namespace :dist do
-    desc "Update Swagger-UI from wordnik/swagger-ui."
+    desc 'Update Swagger-UI from wordnik/swagger-ui.'
     task :update do
       Dir.mktmpdir 'swagger-ui' do |dir|
         puts "Cloning into #{dir} ..."
@@ -13,80 +13,80 @@ namespace :swagger_ui do
         puts "Removing files from #{root} ..."
         repo = Git.open root
         # Javascripts
-        puts "Copying Javascripts ..."
+        puts 'Copying Javascripts ...'
         FileUtils.rm_r "#{root}/app/assets/javascripts/grape_swagger_rails"
         FileUtils.cp_r "#{dir}/swagger-ui/dist/lib", "#{root}/app/assets/javascripts"
         FileUtils.mv "#{root}/app/assets/javascripts/lib", "#{root}/app/assets/javascripts/grape_swagger_rails"
         FileUtils.cp_r Dir.glob("#{dir}/swagger-ui/dist/swagger-ui.min.js"), "#{root}/app/assets/javascripts/grape_swagger_rails"
         FileUtils.cp Dir.glob("#{root}/lib/javascripts/*.js"), "#{root}/app/assets/javascripts/grape_swagger_rails"
         # Generate application.js
         JAVASCRIPT_FILES = [
-            'jquery-1.8.0.min.js',
-            'jquery.slideto.min.js',
-            'jquery.wiggle.min.js',
-            'jquery.ba-bbq.min.js',
-            'handlebars-2.0.0.js',
-            'marked.js',
-            'underscore-min.js',
-            'backbone-min.js',
-            'swagger-ui.min.js',
-            'highlight.7.3.pack.js',
-            'swagger-oauth.js',
-            'base64.js'
+          'jquery-1.8.0.min.js',
+          'jquery.slideto.min.js',
+          'jquery.wiggle.min.js',
+          'jquery.ba-bbq.min.js',
+          'handlebars-2.0.0.js',
+          'marked.js',
+          'underscore-min.js',
+          'backbone-min.js',
+          'swagger-ui.min.js',
+          'highlight.7.3.pack.js',
+          'swagger-oauth.js',
+          'base64.js'
         ]
         javascript_files = Dir["#{root}/app/assets/javascripts/grape_swagger_rails/*.js"].map { |f|
-            f.split('/').last
+          f.split('/').last
         } - ['application.js']
         (javascript_files - JAVASCRIPT_FILES).each do |filename|
-            puts "WARNING: add #{filename} to swagger_ui.rake"
+          puts "WARNING: add #{filename} to swagger_ui.rake"
         end
         (JAVASCRIPT_FILES - javascript_files).each do |filename|
-            puts "WARNING: remove #{filename} from swagger_ui.rake"
+          puts "WARNING: remove #{filename} from swagger_ui.rake"
         end
-        File.open "#{root}/app/assets/javascripts/grape_swagger_rails/application.js", "w+" do |file|
-            JAVASCRIPT_FILES.each do |filename|
-                file.write "//= require ./#{File.basename(filename, '.*')}\n"
-            end
+        File.open "#{root}/app/assets/javascripts/grape_swagger_rails/application.js", 'w+' do |file|
+          JAVASCRIPT_FILES.each do |filename|
+            file.write "//= require ./#{File.basename(filename, '.*')}\n"
+          end
         end
         # Stylesheets
-        puts "Copying Stylesheets ..."
+        puts 'Copying Stylesheets ...'
         repo.remove 'app/assets/stylesheets/grape_swagger_rails', recursive: true
         FileUtils.mkdir_p "#{root}/app/assets/stylesheets/grape_swagger_rails"
         FileUtils.cp_r Dir.glob("#{dir}/swagger-ui/dist/css/**/*"), "#{root}/app/assets/stylesheets/grape_swagger_rails"
         repo.add 'app/assets/stylesheets/grape_swagger_rails'
         # Generate application.js
         CSS_FILES = [
-            'reset.css',
-            'screen.css'
+          'reset.css',
+          'screen.css'
         ]
         css_files = Dir["#{root}/app/assets/stylesheets/grape_swagger_rails/*.css"].map { |f|
-            f.split('/').last
+          f.split('/').last
         } - ['application.css']
         (css_files - CSS_FILES).each do |filename|
-            puts "WARNING: add #{filename} to swagger_ui.rake"
+          puts "WARNING: add #{filename} to swagger_ui.rake"
         end
         (CSS_FILES - css_files).each do |filename|
-            puts "WARNING: remove #{filename} from swagger_ui.rake"
+          puts "WARNING: remove #{filename} from swagger_ui.rake"
         end
         # rewrite screen.css into screen.css.erb with dynamic image paths
-        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css.erb", "w+" do |file|
-            contents = File.read "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
-            contents.gsub! /url\((\'*).*\/(?<filename>[\w\.]*)(\'*)\)/ do |match|
-                "url(<%= image_path('grape_swagger_rails/#{$~[:filename]}') %>)"
-            end
-            file.write contents
-            FileUtils.rm "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
+        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css.erb", 'w+' do |file|
+          contents = File.read "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
+          contents.gsub! /url\((\'*).*\/(?<filename>[\w\.]*)(\'*)\)/ do |_match|
+            "url(<%= image_path('grape_swagger_rails/#{$LAST_MATCH_INFO[:filename]}') %>)"
+          end
+          file.write contents
+          FileUtils.rm "#{root}/app/assets/stylesheets/grape_swagger_rails/screen.css"
         end
-        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/application.css", "w+" do |file|
-            file.write "/*\n"
-            CSS_FILES.each do |filename|
-                file.write "*= require ./#{File.basename(filename, '.*')}\n"
-            end
-            file.write "*= require_self\n"
-            file.write "*/\n"
+        File.open "#{root}/app/assets/stylesheets/grape_swagger_rails/application.css", 'w+' do |file|
+          file.write "/*\n"
+          CSS_FILES.each do |filename|
+            file.write "*= require ./#{File.basename(filename, '.*')}\n"
+          end
+          file.write "*= require_self\n"
+          file.write "*/\n"
         end
         # Images
-        puts "Copying Images ..."
+        puts 'Copying Images ...'
         repo.remove 'app/assets/images/grape_swagger_rails', recursive: true
         FileUtils.mkdir_p "#{root}/app/assets/images/grape_swagger_rails"
         FileUtils.cp_r Dir.glob("#{dir}/swagger-ui/dist/images/**/*"), "#{root}/app/assets/images/grape_swagger_rails"
diff --git a/spec/dummy/bin/rails b/spec/dummy/bin/rails
@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 begin
-  load File.expand_path("../spring", __FILE__)
+  load File.expand_path('../spring', __FILE__)
 rescue LoadError
 end
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'
diff --git a/spec/dummy/bin/rake b/spec/dummy/bin/rake
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 begin
-  load File.expand_path("../spring", __FILE__)
+  load File.expand_path('../spring', __FILE__)
 rescue LoadError
 end
 require_relative '../config/boot'
diff --git a/spec/dummy/bin/spring b/spec/dummy/bin/spring
@@ -4,15 +4,15 @@
 # It gets overwritten when you run the `spring binstub` command
 
 unless defined?(Spring)
-  require "rubygems"
-  require "bundler"
+  require 'rubygems'
+  require 'bundler'
 
   if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    spring \((.*?)\)$.*?^$/m)
-    ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
-    ENV["GEM_HOME"] = ""
+    ENV['GEM_PATH'] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
+    ENV['GEM_HOME'] = ''
     Gem.paths = ENV
 
-    gem "spring", match[1]
-    require "spring/binstub"
+    gem 'spring', match[1]
+    require 'spring/binstub'
   end
 end
diff --git a/spec/dummy/config.ru b/spec/dummy/config.ru
@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Dummy::Application
diff --git a/spec/dummy/config/application.rb b/spec/dummy/config/application.rb
@@ -16,7 +16,7 @@ class Application < Rails::Application
     config.middleware.use Rack::Cors do
       allow do
         origins '*'
-        resource '*', :headers => :any, :methods => [:get, :post, :options]
+        resource '*', headers: :any, methods: [:get, :post, :options]
       end
     end
   end
diff --git a/spec/dummy/config/environments/test.rb b/spec/dummy/config/environments/test.rb
@@ -13,7 +13,7 @@
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_files  = true
+  config.serve_static_files = true
   config.static_cache_control = 'public, max-age=3600'
 
   # Show full error reports and disable caching.
diff --git a/spec/features/grape-swagger-rails_spec.rb b/spec/features/grape-swagger-rails_spec.rb
@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe GrapeSwaggerRails do
-  context "#options" do
+  context '#options' do
     subject do
       GrapeSwaggerRails.options
     end
diff --git a/spec/features/swagger_spec.rb b/spec/features/swagger_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
