Implemented Rubocop, a Ruby code static code analyzer.

Author: dblock

.rubocop.yml

@@ -0,0 +1,61 @@
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  # don't require classes to be documented
+  Enabled: false
+
+CollectionMethods:
+  # don't prefer map to collect, recuce to inject
+  Enabled: false
+
+Encoding:
+  # no need to always specify encoding
+  Enabled: false
+
+HashMethods:
+  # key? instead of has_key?
+  # value? instead of has_value?
+  Enabled: false
+
+StringLiterals:
+  # use single or double-quoted strings, as you please
+  Enabled: false
+
+Void:
+  # == operator used in void context in specs
+  Enabled: false
+
+SignalException:
+  # prefer raise to fail
+  EnforcedStyle: only_raise
+
+RaiseArgs:
+  # don't care for what kind of raise
+  Enabled: false
+
+PerlBackrefs:
+  # TODO: regular expression matching with $1, $2, etc.
+  Enabled: false
+
+BlockNesting:
+  # TODO: fix too much nesting
+  Max: 4
+
+Lambda:
+  # TODO: replace all lambda with -> or Proc
+  Enabled: false
+
+Blocks:
+  # allow multi-line blocks like expect { }
+  Enabled: false
+
+WordArray:
+  # %w vs. [ '', ... ]
+  Enabled: false

.travis.yml

@@ -1,5 +1,9 @@
+language: ruby
+cache: bundler
 rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode
   - rbx-19mode
+script:
+ - "bundle exec rubocop"

CHANGELOG.md

@@ -12,6 +12,10 @@ Next Release
 * [#477](https://github.com/intridea/grape/pull/477): Fixed `default_error_formatter` which takes a format symbol - [@vad4msiu](https://github.com/vad4msiu).
 * Your contribution here.
 
+#### Development
+
+* Implemented Rubocop, a Ruby code static code analyzer - [@dblock](https://github.com/dblock).
+
 0.6.0 (9/16/2013)
 =================
 

Gemfile

@@ -16,4 +16,5 @@ group :development, :test do
   gem 'cookiejar'
   gem 'rack-contrib'
   gem 'redcarpet', :platforms => :ruby
+  gem 'rubocop', '~> 0.14.1'
 end

README.md

@@ -1015,7 +1015,7 @@ module API
       expose :user_name
       expose :text, documentation: { type: "string", desc: "Status update text." }
       expose :ip, if: { type: :full }
-      expose :user_type, user_id, if: lambda{ |status, options| status.user.public? }
+      expose :user_type, user_id, if: lambda { |status, options| status.user.public? }
       expose :digest { |status, options| Digest::MD5.hexdigest(status.txt) }
       expose :replies, using: API::Status, as: :replies
     end

lib/grape/api.rb

@@ -26,7 +26,7 @@ def reset!
       end
 
       def compile
-        @instance = self.new
+        @instance = new
       end
 
       def change!
@@ -81,12 +81,12 @@ def do_not_route_options!
       #     version 'v2'
       #
       #     get '/main' do
-      #       {:some => 'data'}
+      #       {some: 'data'}
       #     end
       #
       #     version 'v1' do
       #       get '/main' do
-      #         {:legacy => 'data'}
+      #         {legacy: 'data'}
       #       end
       #     end
       #   end
@@ -95,7 +95,7 @@ def version(*args, &block)
         if args.any?
           options = args.pop if args.last.is_a? Hash
           options ||= {}
-          options = {:using => :path}.merge!(options)
+          options = { using: :path }.merge(options)
 
           raise Grape::Exceptions::MissingVendorOption.new if options[:using] == :header && !options.has_key?(:vendor)
 
@@ -111,7 +111,7 @@ def version(*args, &block)
 
       # Add a description to the next namespace or function.
       def desc(description, options = {})
-        @last_description = options.merge(:description => description)
+        @last_description = options.merge(description: description)
       end
 
       # Specify the default format for the API's serializers.
@@ -209,9 +209,7 @@ def rescue_from(*args, &block)
         end
 
         options = args.last.is_a?(Hash) ? args.pop : {}
-        if options.has_key?(:with)
-          handler ||= proc { options[:with] }
-        end
+        handler ||= proc { options[:with] } if options.has_key?(:with)
 
         if handler
           args.each do |arg|
@@ -220,8 +218,12 @@ def rescue_from(*args, &block)
         end
 
         imbue(:rescue_options, options)
-        set(:rescue_all, true) and return if args.include?(:all)
-        imbue(:rescued_errors, args)
+
+        if args.include?(:all)
+          set(:rescue_all, true)
+        else
+          imbue(:rescued_errors, args)
+        end
       end
 
       # Allows you to specify a default representation entity for a
@@ -230,10 +232,10 @@ def rescue_from(*args, &block)
       #
       # @example
       #   class ExampleAPI < Grape::API
-      #     represent User, :with => Entity::User
+      #     represent User, with: Entity::User
       #
       #     get '/me' do
-      #       present current_user # :with => Entity::User is assumed
+      #       present current_user # with: Entity::User is assumed
       #     end
       #   end
       #
@@ -276,7 +278,7 @@ def helpers(new_mod = nil, &block)
               include new_mod
             end
           end
-          mod.class_eval &block if block_given?
+          mod.class_eval(&block) if block_given?
           set(:helpers, mod)
         else
           mod = Module.new
@@ -292,7 +294,7 @@ def helpers(new_mod = nil, &block)
       # only `:http_basic`, `:http_digest` and `:oauth2` are supported.
       def auth(type = nil, options = {}, &block)
         if type
-          set(:auth, {:type => type.to_sym, :proc => block}.merge(options))
+          set(:auth, { type: type.to_sym, proc: block }.merge(options))
         else
           settings[:auth]
         end
@@ -318,14 +320,14 @@ def mount(mounts)
         mounts.each_pair do |app, path|
           if app.respond_to?(:inherit_settings, true)
             app_settings = settings.clone
-            mount_path = Rack::Mount::Utils.normalize_path([ settings[:mount_path], path ].compact.join("/"))
+            mount_path = Rack::Mount::Utils.normalize_path([settings[:mount_path], path].compact.join("/"))
             app_settings.set :mount_path, mount_path
             app.inherit_settings(app_settings)
           end
           endpoints << Grape::Endpoint.new(settings.clone, {
-            :method => :any,
-            :path => path,
-            :app => app
+            method: :any,
+            path: path,
+            app: app
           })
         end
       end
@@ -339,14 +341,14 @@ def mount(mounts)
       # @example Defining a basic route.
       #   class MyAPI < Grape::API
       #     route(:any, '/hello') do
-      #       {:hello => 'world'}
+      #       {hello: 'world'}
       #     end
       #   end
       def route(methods, paths = ['/'], route_options = {}, &block)
         endpoint_options = {
-          :method => methods,
-          :path => paths,
-          :route_options => (@namespace_description || {}).deep_merge(@last_description || {}).deep_merge(route_options || {})
+          method: methods,
+          path: paths,
+          route_options: (@namespace_description || {}).deep_merge(@last_description || {}).deep_merge(route_options || {})
         }
         endpoints << Grape::Endpoint.new(settings.clone, endpoint_options, &block)
 
@@ -366,13 +368,33 @@ def after(&block)
         imbue(:afters, [block])
       end
 
-      def get(paths = ['/'], options = {}, &block); route('GET', paths, options, &block) end
-      def post(paths = ['/'], options = {}, &block); route('POST', paths, options, &block) end
-      def put(paths = ['/'], options = {}, &block); route('PUT', paths, options, &block) end
-      def head(paths = ['/'], options = {}, &block); route('HEAD', paths, options, &block) end
-      def delete(paths = ['/'], options = {}, &block); route('DELETE', paths, options, &block) end
-      def options(paths = ['/'], options = {}, &block); route('OPTIONS', paths, options, &block) end
-      def patch(paths = ['/'], options = {}, &block); route('PATCH', paths, options, &block) end
+      def get(paths = ['/'], options = {}, &block)
+        route('GET', paths, options, &block)
+      end
+
+      def post(paths = ['/'], options = {}, &block)
+        route('POST', paths, options, &block)
+      end
+
+      def put(paths = ['/'], options = {}, &block)
+        route('PUT', paths, options, &block)
+      end
+
+      def head(paths = ['/'], options = {}, &block)
+        route('HEAD', paths, options, &block)
+      end
+
+      def delete(paths = ['/'], options = {}, &block)
+        route('DELETE', paths, options, &block)
+      end
+
+      def options(paths = ['/'], options = {}, &block)
+        route('OPTIONS', paths, options, &block)
+      end
+
+      def patch(paths = ['/'], options = {}, &block)
+        route('PATCH', paths, options, &block)
+      end
 
       def namespace(space = nil, options = {},  &block)
         if space || block_given?
@@ -427,7 +449,10 @@ def use(middleware_class, *args, &block)
       # and arguments that are currently applied to the
       # application.
       def middleware
-        settings.stack.inject([]){|a,s| a += s[:middleware] if s[:middleware]; a}
+        settings.stack.inject([]) do |a, s|
+          a += s[:middleware] if s[:middleware]
+          a
+        end
       end
 
       # An array of API routes.
@@ -440,9 +465,11 @@ def versions
       end
 
       def cascade(value = nil)
-        value.nil? ?
-          (settings.has_key?(:cascade) ? !! settings[:cascade] : true) :
+        if value.nil?
+          settings.has_key?(:cascade) ? !!settings[:cascade] : true
+        else
           set(:cascade, value)
+        end
       end
 
       protected
@@ -459,15 +486,15 @@ def prepare_routes
       # block passed in. Allows for simple 'before' setups
       # of settings stack pushes.
       def nest(*blocks, &block)
-        blocks.reject!{|b| b.nil?}
+        blocks.reject! { |b| b.nil? }
         if blocks.any?
           settings.push  # create a new context to eval the follow
-          instance_eval &block if block_given?
-          blocks.each{|b| instance_eval &b}
-          settings.pop   # when finished, we pop the context
+          instance_eval(&block) if block_given?
+          blocks.each { |b| instance_eval(&b) }
+          settings.pop # when finished, we pop the context
           reset_validations!
         else
-          instance_eval &block
+          instance_eval(&block)
         end
       end
 
@@ -497,7 +524,7 @@ def initialize
     def call(env)
       status, headers, body = @route_set.call(env)
       headers.delete('X-Cascade') unless cascade?
-      [ status, headers, body ]
+      [status, headers, body]
     end
 
     # Some requests may return a HTTP 404 error if grape cannot find a matching
@@ -509,8 +536,8 @@ def call(env)
     # errors from reaching upstream. This is effectivelly done by unsetting
     # X-Cascade. Default :cascade is true.
     def cascade?
-      return !! self.class.settings[:cascade] if self.class.settings.has_key?(:cascade)
-      return !! self.class.settings[:version_options][:cascade] if self.class.settings[:version_options] && self.class.settings[:version_options].has_key?(:cascade)
+      return !!self.class.settings[:cascade] if self.class.settings.has_key?(:cascade)
+      return !!self.class.settings[:version_options][:cascade] if self.class.settings[:version_options] && self.class.settings[:version_options].has_key?(:cascade)
       true
     end
 
@@ -523,32 +550,34 @@ def cascade?
     # will return an HTTP 405 response for any HTTP method that the resource
     # cannot handle.
     def add_head_not_allowed_methods
-      allowed_methods = Hash.new{|h,k| h[k] = [] }
-      resources       = self.class.endpoints.map do |endpoint|
-        endpoint.options[:app] && endpoint.options[:app].respond_to?(:endpoints) ?
-          endpoint.options[:app].endpoints.map(&:routes) :
+      allowed_methods = Hash.new { |h, k| h[k] = [] }
+      resources = self.class.endpoints.map do |endpoint|
+        if endpoint.options[:app] && endpoint.options[:app].respond_to?(:endpoints)
+          endpoint.options[:app].endpoints.map(&:routes)
+        else
           endpoint.routes
+        end
       end
       resources.flatten.each do |route|
         allowed_methods[route.route_compiled] << route.route_method
       end
       allowed_methods.each do |path_info, methods|
-        if methods.include?('GET') && ! methods.include?("HEAD") && ! self.class.settings[:do_not_route_head]
-          methods = methods | [ 'HEAD' ]
+        if methods.include?('GET') && !methods.include?("HEAD") && !self.class.settings[:do_not_route_head]
+          methods = methods | ['HEAD']
         end
         allow_header = (["OPTIONS"] | methods).join(", ")
         unless methods.include?("OPTIONS") || self.class.settings[:do_not_route_options]
-          @route_set.add_route( proc { [204, { 'Allow' => allow_header }, []]}, {
-            :path_info      => path_info,
-            :request_method => "OPTIONS"
+          @route_set.add_route(proc { [204, { 'Allow' => allow_header }, []] }, {
+            path_info: path_info,
+            request_method: "OPTIONS"
           })
         end
         not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - methods
         not_allowed_methods << "OPTIONS" if self.class.settings[:do_not_route_options]
         not_allowed_methods.each do |bad_method|
-          @route_set.add_route( proc { [405, { 'Allow' => allow_header, 'Content-Type' => 'text/plain' }, []]}, {
-            :path_info      => path_info,
-            :request_method => bad_method
+          @route_set.add_route(proc { [405, { 'Allow' => allow_header, 'Content-Type' => 'text/plain' }, []] }, {
+            path_info: path_info,
+            request_method: bad_method
           })
         end
       end