Rubocop cleanup (#264)

james2m · LeFnord · commit 0930f60f0371 · 2017-04-05T11:21:29.000+02:00
* Ignore some project files.

* Add .rubocop.yml.

* Autofix some Rubocop errors.

* Autogenerate .rubocop_todo.yml.

* Add CHANGELOG entry for Rubocop.

* Updated gemspec to rubocop ~&gt; 0.48 and rubocop Target to 2.4.

* Frozen string literals.
diff --git a/.gitignore b/.gitignore
@@ -32,6 +32,9 @@ dist
 Gemfile.lock
 tmp
 coverage/
+.byebug_history
+.ruby-version
+.ruby-gemset
 
 ## Rubinius
 .rbx
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,6 +1,30 @@
 AllCops:
+  TargetRubyVersion: 2.4
+  Include:
+    - Dangerfile
+
   Exclude:
     - vendor/**/*
+    - bin/**/*
     - Guardfile
 
 inherit_from: .rubocop_todo.yml
+
+Style/FileName:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'grape-entity.gemspec'
+    - 'lib/grape-entity.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineIfModifier:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Lint/UnneededDisable:
+  Enabled: false
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,15 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-20 10:04:42 -0500 using RuboCop version 0.45.0.
+# on 2017-04-05 10:30:29 +0700 using RuboCop version 0.48.1.
 # 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/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/grape_entity/exposure/represent_exposure_spec.rb'
+
 # Offense count: 6
 Metrics/AbcSize:
   Max: 32
 
+# Offense count: 35
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 1499
+
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
@@ -19,27 +29,17 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 237
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
+# Offense count: 238
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 146
 
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 28
 
 # Offense count: 2
 Metrics/PerceivedComplexity:
   Max: 13
-
-# Offense count: 33
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
-Style/FileName:
-  Exclude:
-    - 'lib/grape-entity.rb'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 #### Features
 
+* [#264](https://github.com/ruby-grape/grape-entity/pull/264): Adds Rubocop config and todo list - [@james2m](https://github.com/james2m).
 * [#255](https://github.com/ruby-grape/grape-entity/pull/255): Adds code coverage w/ coveralls - [@LeFnord](https://github.com/LeFnord).
 
 * Your contribution here.
diff --git a/Dangerfile b/Dangerfile
@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'ruby-grape-danger')
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
diff --git a/Rakefile b/Rakefile
@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
@@ -17,4 +18,4 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]
diff --git a/bench/serializing.rb b/bench/serializing.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'grape-entity'
 require 'benchmark'
diff --git a/grape-entity.gemspec b/grape-entity.gemspec
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'grape_entity/version'
 
@@ -21,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rubocop', '~> 0.40'
+  s.add_development_dependency 'rubocop', '~> 0.48'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'maruku'
diff --git a/lib/grape-entity.rb b/lib/grape-entity.rb
@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'grape_entity'
diff --git a/lib/grape_entity.rb b/lib/grape_entity.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/version'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/reverse_merge'
diff --git a/lib/grape_entity/condition.rb b/lib/grape_entity/condition.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape_entity/condition/base'
 require 'grape_entity/condition/block_condition'
 require 'grape_entity/condition/hash_condition'
diff --git a/lib/grape_entity/condition/base.rb b/lib/grape_entity/condition/base.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition
diff --git a/lib/grape_entity/condition/block_condition.rb b/lib/grape_entity/condition/block_condition.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition
diff --git a/lib/grape_entity/condition/hash_condition.rb b/lib/grape_entity/condition/hash_condition.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition
diff --git a/lib/grape_entity/condition/symbol_condition.rb b/lib/grape_entity/condition/symbol_condition.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition
diff --git a/lib/grape_entity/delegator.rb b/lib/grape_entity/delegator.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape_entity/delegator/base'
 require 'grape_entity/delegator/hash_object'
 require 'grape_entity/delegator/openstruct_object'
diff --git a/lib/grape_entity/delegator/base.rb b/lib/grape_entity/delegator/base.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator
diff --git a/lib/grape_entity/delegator/fetchable_object.rb b/lib/grape_entity/delegator/fetchable_object.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator
diff --git a/lib/grape_entity/delegator/hash_object.rb b/lib/grape_entity/delegator/hash_object.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator
diff --git a/lib/grape_entity/delegator/openstruct_object.rb b/lib/grape_entity/delegator/openstruct_object.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator
diff --git a/lib/grape_entity/delegator/plain_object.rb b/lib/grape_entity/delegator/plain_object.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator
diff --git a/lib/grape_entity/entity.rb b/lib/grape_entity/entity.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'multi_json'
 require 'set'
 
@@ -506,8 +508,8 @@ def to_xml(options = {})
     end
 
     # All supported options.
-    OPTIONS = [
-      :rewrite, :as, :if, :unless, :using, :with, :proc, :documentation, :format_with, :safe, :attr_path, :if_extras, :unless_extras, :merge
+    OPTIONS = %i[
+      rewrite as if unless using with proc documentation format_with safe attr_path if_extras unless_extras merge
     ].to_set.freeze
 
     # Merges the given options with current block options.
@@ -517,7 +519,7 @@ def self.merge_options(options)
       opts = {}
 
       merge_logic = proc do |key, existing_val, new_val|
-        if [:if, :unless].include?(key)
+        if %i[if unless].include?(key)
           if existing_val.is_a?(Hash) && new_val.is_a?(Hash)
             existing_val.merge(new_val)
           elsif new_val.is_a?(Hash)
diff --git a/lib/grape_entity/exposure.rb b/lib/grape_entity/exposure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape_entity/exposure/base'
 require 'grape_entity/exposure/represent_exposure'
 require 'grape_entity/exposure/block_exposure'
diff --git a/lib/grape_entity/exposure/base.rb b/lib/grape_entity/exposure/base.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/exposure/block_exposure.rb b/lib/grape_entity/exposure/block_exposure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/exposure/delegator_exposure.rb b/lib/grape_entity/exposure/delegator_exposure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/exposure/formatter_block_exposure.rb b/lib/grape_entity/exposure/formatter_block_exposure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/exposure/formatter_exposure.rb b/lib/grape_entity/exposure/formatter_exposure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/exposure/nesting_exposure.rb b/lib/grape_entity/exposure/nesting_exposure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb b/lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
@@ -30,18 +32,18 @@ def clear
             @exposures.clear
           end
 
-          [
-            :each,
-            :to_ary, :to_a,
-            :all?,
-            :select,
-            :each_with_object,
-            :[],
-            :==,
-            :size,
-            :count,
-            :length,
-            :empty?
+          %i[
+            each
+            to_ary to_a
+            all?
+            select
+            each_with_object
+            \[\]
+            ==
+            size
+            count
+            length
+            empty?
           ].each do |name|
             class_eval <<-RUBY, __FILE__, __LINE__
               def #{name}(*args, &block)
diff --git a/lib/grape_entity/exposure/nesting_exposure/output_builder.rb b/lib/grape_entity/exposure/nesting_exposure/output_builder.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/exposure/represent_exposure.rb b/lib/grape_entity/exposure/represent_exposure.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
diff --git a/lib/grape_entity/options.rb b/lib/grape_entity/options.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     class Options
diff --git a/lib/grape_entity/version.rb b/lib/grape_entity/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeEntity
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.6.1'
 end
diff --git a/spec/grape_entity/entity_spec.rb b/spec/grape_entity/entity_spec.rb
diff --git a/spec/grape_entity/exposure/nesting_exposure/nested_exposures_spec.rb b/spec/grape_entity/exposure/nesting_exposure/nested_exposures_spec.rb
diff --git a/spec/grape_entity/exposure/represent_exposure_spec.rb b/spec/grape_entity/exposure/represent_exposure_spec.rb
diff --git a/spec/grape_entity/exposure_spec.rb b/spec/grape_entity/exposure_spec.rb
diff --git a/spec/grape_entity/hash_spec.rb b/spec/grape_entity/hash_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`danger.import_dangerfile(gem: 'ruby-grape-danger')`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`source 'http://rubygems.org'`
`2`	`4`
`3`	`5`	`gemspec`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))`
`2`	`4`	`require 'grape-entity'`
`3`	`5`	`require 'benchmark'`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'grape_entity'`