Add Style enforcer (via Rubocop)

.rubocop.yml

@@ -0,0 +1,49 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - config/initializers/forbidden_yaml.rb
+    - !ruby/regexp /(vendor|bundle|bin|db|tmp)\/.*/
+  RunRailsCops: true
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Lint/NestedMethodDefinition:
+  Enabled: false
+  Exclude:
+    - test/action_controller/serialization_test.rb
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Metrics/AbcSize:
+  Max: 35 # TODO: Lower to 15
+
+Metrics/ClassLength:
+  Max: 261 # TODO: Lower to 100
+  Exclude:
+    - test/**/*.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 7 # TODO: Lower to 6
+
+Metrics/LineLength:
+  Max: 251 # TODO: Lower to 80
+
+Metrics/MethodLength:
+  Max: 106 # TODO: Lower to 10
+
+Metrics/PerceivedComplexity:
+  Max: 9 # TODO: Lower to 7
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented

.rubocop_todo.yml

@@ -0,0 +1,315 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-31 04:23:33 -0500 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
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+
+# Offense count: 1
+Lint/EmptyEnsure:
+  Exclude:
+    - 'test/serializers/adapter_for_test.rb'
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json_api/fragment_cache.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/active_model/serializer/adapter.rb'
+    - 'lib/active_model/serializer/adapter/null.rb'
+    - 'lib/active_model/serializer/pass_through_serializer.rb'
+    - 'test/fixtures/poro.rb'
+    - 'test/lint_test.rb'
+
+# Offense count: 1
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/active_model/serializable_resource.rb'
+
+# Offense count: 3
+Lint/UselessAssignment:
+  Exclude:
+    - 'bench/perf.rb'
+    - 'lib/active_model/serializer/adapter/json_api/fragment_cache.rb'
+    - 'test/test_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Rails/Date:
+  Exclude:
+    - 'test/fixtures/poro.rb'
+
+# Offense count: 8
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Rails/TimeZone:
+  Exclude:
+    - 'test/action_controller/serialization_test.rb'
+    - 'test/fixtures/poro.rb'
+    - 'test/serializers/cache_test.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+Style/AlignHash:
+  Exclude:
+    - 'test/action_controller/json_api/pagination_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Exclude:
+    - 'lib/active_model/serializer/lint.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 46
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'test/action_controller/adapter_selector_test.rb'
+    - 'test/action_controller/json_api/pagination_test.rb'
+    - 'test/action_controller/serialization_test.rb'
+    - 'test/adapter/json_api/linked_test.rb'
+    - 'test/adapter/json_api/pagination_links_test.rb'
+    - 'test/adapter/null_test.rb'
+    - 'test/adapter_test.rb'
+    - 'test/array_serializer_test.rb'
+    - 'test/serializable_resource_test.rb'
+    - 'test/serializers/associations_test.rb'
+    - 'test/serializers/attribute_test.rb'
+    - 'test/serializers/attributes_test.rb'
+    - 'test/serializers/fieldset_test.rb'
+    - 'test/serializers/root_test.rb'
+    - 'test/serializers/urls_test.rb'
+
+# Offense count: 167
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Style/CommentIndentation:
+  Exclude:
+    - 'active_model_serializers.gemspec'
+
+# Offense count: 1
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/active_model/serializable_resource.rb'
+
+# Offense count: 1
+Style/EachWithObject:
+  Exclude:
+    - 'lib/active_model/serializer/fieldset.rb'
+
+# Offense count: 3
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+    - 'test/capture_warnings.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+Style/IndentArray:
+  Exclude:
+    - 'test/adapter/json/has_many_test.rb'
+    - 'test/adapter/json_api/json_api_test.rb'
+    - 'test/adapter/json_api/pagination_links_test.rb'
+    - 'test/adapter/json_test.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentHash:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentationConsistency:
+  Exclude:
+    - 'test/action_controller/serialization_scope_name_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Width.
+Style/IndentationWidth:
+  Exclude:
+    - 'lib/active_model/serializable_resource.rb'
+    - 'lib/active_model/serializer/fieldset.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Lambda:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/MethodCallParentheses:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json.rb'
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/NegatedIf:
+  Exclude:
+    - 'lib/action_controller/serialization.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+Style/Next:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/NumericLiterals:
+  MinDigits: 7
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'active_model_serializers.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'test/fixtures/poro.rb'
+    - 'test/serializers/associations_test.rb'
+
+# Offense count: 6
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Exclude:
+    - 'lib/active_model/serializer/adapter.rb'
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+    - 'lib/active_model/serializer/associations.rb'
+    - 'test/action_controller/json_api/linked_test.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+    - 'lib/active_model/serializer/associations.rb'
+    - 'test/fixtures/poro.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'lib/active_model/serializer/fieldset.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+    - 'lib/active_model/serializer/adapter.rb'
+    - 'lib/active_model/serializer/fieldset.rb'
+    - 'lib/active_model/serializer/pass_through_serializer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowIfMethodIsEmpty.
+Style/SingleLineMethods:
+  Exclude:
+    - 'test/serializers/serializer_for_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# Offense count: 1
+Style/StructInheritance:
+  Exclude:
+    - 'bench/perf.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoredMethods.
+Style/SymbolProc:
+  Exclude:
+    - 'lib/generators/serializer/serializer_generator.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/TrailingBlankLines:
+  Exclude:
+    - 'lib/active_model/serializer/pass_through_serializer.rb'
+    - 'lib/generators/serializer/serializer_generator.rb'
+    - 'test/adapter/fragment_cache_test.rb'
+    - 'test/adapter/json_api/json_api_test.rb'
+    - 'test/adapter/null_test.rb'
+    - 'test/serializers/cache_test.rb'
+    - 'test/serializers/fieldset_test.rb'
+    - 'test/support/stream_capture.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingComma:
+  Exclude:
+    - 'test/action_controller/adapter_selector_test.rb'
+    - 'test/action_controller/serialization_test.rb'
+    - 'test/adapter/json_api/belongs_to_test.rb'
+    - 'test/adapter/json_api/linked_test.rb'
+
+# Offense count: 1
+Style/UnlessElse:
+  Exclude:
+    - 'lib/active_model/serializer.rb'

.travis.yml

@@ -2,6 +2,9 @@ language: ruby
 
 sudo: false
 
+cache:
+  bundler: true
+
 rvm:
   - 1.9.3
   - 2.0.0
@@ -14,6 +17,10 @@ rvm:
 install:
   - bundle install --retry=3
 
+script:
+  - bundle exec rake
+  - bundle exec rake rubocop
+
 env:
   - "RAILS_VERSION=4.0"
   - "RAILS_VERSION=4.1"
@@ -24,3 +31,4 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - env: "RAILS_VERSION=master"
+  fast_finish: true

Gemfile

@@ -33,3 +33,7 @@ end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+group :development, :test do
+  gem 'rubocop', '~> 0.33.0', require: false
+end