chefstyle 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5381b1c87d477aa07cf1c2a9f82ad8f4c46f3732
-  data.tar.gz: b8cce9e6e91fa46824f9101a219e6a14402421de
+  metadata.gz: 493c05753128c7b60a843de5913d01dcf2cdee20
+  data.tar.gz: bc3f2ea30dcf8ce171feedcbb0292ec1caff88f9
 SHA512:
-  metadata.gz: 8a72c4b7756e89bd293acf7f3c126147d32f8c8ff158fbad5b41d1eecc6cc5b7e242e86ef8bf484626e5fdf53aea99c673df0a646625788276997d3e028cc27c
-  data.tar.gz: 8c90216a9a3d71ec0bafbe8286f5777296fa2025f113583e74c6e5b8a5e6a42dfe9b90fb98579d6392610b287cea7515065f8fea8c37360438e4b1ea526cd0c0
+  metadata.gz: b852bbe98d056656c9cd84e9e58b17d2ba2bcd120f6eeae6410674297d62d1b6bf2473c26da493c1d59ee269f59fe54253b6163cd92c1ee9eb3cad45a58af492
+  data.tar.gz: 0bd95d570bd3c428b3ef0b25ecb52618bdd978123d36341cc13dcc93c781702ddb6abf2c55800e9d218fd2c0f29f7b32351ed3d3f9b47c8fc3a1fd4a7f3b09a1

data/.travis.yml

@@ -1,4 +1,15 @@
 language: ruby
-rvm:
-  - 2.2.1
+cache: bundler
+
+sudo: false
+
+branches:
+  only:
+    - master
+    
 before_install: gem install bundler -v 1.10.6
+
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0

data/README.md

@@ -1,5 +1,7 @@
 # Chefstyle - Version Pinned rubocop and sane defaults for Ruby
 
+[![Gem Version](https://badge.fury.io/rb/chefstyle.svg)](https://badge.fury.io/rb/chefstyle) [![Build Status](https://travis-ci.org/chef/chefstyle.svg?branch=master)](https://travis-ci.org/chef/chefstyle)
+
 This is an internal style guide for chef ruby projects (chef-client,
 ohai, mixlib-shellout, mixlib-config, etc).
 
@@ -7,6 +9,11 @@ It is not meant for consumption by cookbooks or for any general
 purpose uses.  It is not intended for any audience outside of chef
 core ruby development.
 
+It will conflict with rubocop defaults, cookstyle, finstyle and other
+ruby style guides entirely by design.  The point is that the core
+chef authors vehemently disagree with them on points of style and this
+point is generally not up for debate.
+
 It will have many rules that are disabled simply because fixing a
 project as large as chef-client would be tedious and have little
 value.  It will have other rules that are disabled because chef

data/Rakefile

@@ -26,3 +26,5 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new(:style) do |task|
   task.options << "--display-cop-names"
 end
+
+task default: [:build, :install]

data/chefstyle.gemspec

@@ -12,14 +12,14 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Rubocop configuration for Chef's ruby projects}
   spec.homepage      = "https://github.com/chef/chefstyle"
   spec.license       = "Apache-2.0"
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.2"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables    = %w[chefstyle]
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec"
   spec.add_dependency("rubocop", Chefstyle::RUBOCOP_VERSION)
 end

data/config/chefstyle.yml

@@ -1,3 +1,10 @@
+#
+# Bundler
+#
+
+Bundler/DuplicatedGem:
+  Enabled: true
+
 #
 # Lint
 #
@@ -14,6 +21,8 @@ Lint/Debugger:
   Enabled: true
 Lint/DefEndAlignment:
   Enabled: true
+Lint/DuplicateCaseCondition:
+  Enabled: true
 Lint/DuplicateMethods:
   Enabled: true
 Lint/DuplicatedKey:
@@ -24,6 +33,8 @@ Lint/ElseLayout:
   Enabled: true
 Lint/EmptyEnsure:
   Enabled: true
+Lint/EmptyExpression:
+  Enabled: true
 Lint/EmptyInterpolation:
   Enabled: true
 Lint/EndAlignment:
@@ -38,6 +49,8 @@ Lint/FormatParameterMismatch:
   Enabled: true
 Lint/ImplicitStringConcatenation:
   Enabled: true
+Lint/InheritException:
+  Enabled: true
 Lint/InvalidCharacterLiteral:
   Enabled: true
 Lint/LiteralInCondition:
@@ -46,20 +59,30 @@ Lint/LiteralInInterpolation:
   Enabled: true
 Lint/Loop:
   Enabled: true
+Lint/MultipleCompare:
+  Enabled: true
 Lint/NestedMethodDefinition:
   Enabled: true
 Lint/NextWithoutAccumulator:
   Enabled: true
 Lint/NonLocalExitFromIterator:
   Enabled: true
+Lint/PercentSymbolArray:
+  Eanbled: true
 Lint/RandOne:
   Enabled: true
 Lint/RequireParentheses:
   Enabled: true
+Lint/SafeNavigationChain:
+  Enabled: true
 Lint/StringConversionInInterpolation:
   Enabled: true
 Lint/UnderscorePrefixedVariableName:
   Enabled: true
+Lint/UnifiedInteger:
+  Enabled: true
+Lint/UnneededDisable:
+  Enabled: true
 Lint/UnreachableCode:
   Enabled: true
 Lint/UselessAccessModifier:
@@ -91,7 +114,7 @@ Lint/RescueException:
   Enabled: false
 
 # we have lots of not-insecure uses of eval
-Lint/Eval:
+Security/Eval:
   Enabled: false
 
 # disabling this will make it easier to stage chefstyle rollouts
@@ -106,6 +129,8 @@ Performance/Casecmp:
   Enabled: true
 Performance/CaseWhenSplat:
   Enabled: true
+Performance/CompareWithBlock:
+  Enabled: true
 Performance/Count:
   Enabled: true
 Performance/Detect:
@@ -132,12 +157,16 @@ Performance/RedundantMerge:
   Enabled: true
 Performance/RedundantSortBy:
   Enabled: true
+Performance/RegexpMatch:
+  Enabled: true
 Performance/ReverseEach:
   Enabled: true
 Performance/Sample:
   Enabled: true
 Performance/Size:
   Enabled: true
+Performance/SortWithBlock:
+  Enabled: true
 Performance/StartWith:
   Enabled: true
 Performance/StringReplacement:
@@ -184,6 +213,8 @@ Metrics/AbcSize:
   Enabled: false
 Metrics/BlockNesting:
   Enabled: false
+Metrics/BlockLength:
+  Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
@@ -230,6 +261,10 @@ Style/CommandLiteral:
   Enabled: true
 Style/ConstantName:
   Enabled: true
+Style/DefWithParentheses:
+  Enabled: true
+Style/EachForSimpleLoop:
+  Enabled: true
 Style/ElseAlignment:
   Enabled: true
 Style/EmptyLineBetweenDefs:
@@ -274,8 +309,12 @@ Style/MethodDefParentheses:
   Enabled: true
 Style/MultilineBlockLayout:
   Enabled: true
+Style/MultilineIfModifier:
+  Enabled: true
 Style/MultilineIfThen:
   Enabled: true
+Style/MultilineMemoization:
+  Enabled: true
 Style/MultilineMethodDefinitionBraceLayout:
   Enabled: true
 Style/MultilineOperationIndentation:
@@ -289,6 +328,14 @@ Style/NestedModifier:
   Enabled: true
 Style/NestedTernaryOperator:
   Enabled: true
+Style/NilComparison:
+  Enabled: true
+Style/NonNilCheck:
+  Enabled: true
+# `foo.zero?` is slower and substantially more annoying to read than `foo == 0`
+Style/NumericPredicate:
+  Enabled: true
+  EnforcedStyle: comparison
 Style/OneLineConditional:
   Enabled: true
 Style/OpMethod:
@@ -307,6 +354,7 @@ Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     '%':  '{}'
     '%i': '{}'
+    '%I': '{}'
     '%q': '{}'
     '%Q': '{}'
     '%r': '{}'
@@ -322,6 +370,13 @@ Style/RedundantFreeze:
   Enabled: true
 Style/RescueEnsureAlignment:
   Enabled: true
+Style/SafeNavigation:
+  Enabled: true
+Style/SelfAssignment:
+  Enabled: true
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+  Enabled: true
 # we only 'raise' and do not 'fail'
 Style/SignalException:
   EnforcedStyle: only_raise
@@ -344,18 +399,22 @@ Style/SpaceBeforeBlockBraces:
   Enabled: true
 Style/SpaceBeforeComment:
   Enabled: true
-Style/SpaceBeforeFirstArg:
-  Enabled: true
 Style/SpaceBeforeSemicolon:
   Enabled: true
 Style/SpaceAroundKeyword:
   Enabled: true
+Style/SpaceInLambdaLiteral:
+  Enabled: true
+Style/SpaceInsideArrayPercentLiteral:
+  Enabled: true
 Style/SpaceInsideBlockBraces:
   Enabled: true
 Style/SpaceInsideHashLiteralBraces:
   Enabled: true
 Style/SpaceInsideRangeLiteral:
   Enabled: true
+Style/SpaceInsideStringInterpolation:
+  Enabled: true
 Style/StabbyLambdaParentheses:
   Enabled: true
 # core chef community prefers double quotes over single quotes
@@ -388,6 +447,8 @@ Style/UnneededCapitalW:
 #  Enabled: true
 Style/VariableName:
   Enabled: true
+Style/VariableInterpolation:
+  Enabled: true
 Style/WhenThen:
   Enabled: true
 Style/WhileUntilDo:
@@ -405,6 +466,8 @@ Style/WordArray:
 # This is a cop that we /should/ have enabled, but tactically we can't really enable.
 Style/Documentation:
   Enabled: false
+Style/DocumentationMethod:
+  Enabled: false
 
 # this makes whitespace formatting of DSL code impossible
 Style/SpaceBeforeFirstArg:
@@ -415,6 +478,8 @@ Style/SpaceInsideBrackets:
   Enabled: false
 Style/SpaceInsideParens:
   Enabled: false
+Style/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
 
 # more whitespace cops that we allow since they can enhance readability
 Style/EmptyLinesAroundBlockBody:
@@ -462,3 +527,25 @@ Style/AsciiComments:
 # Parens around ternaries often make them more readable and reduces cognitive load over operator precidence
 Style/TernaryParentheses:
   Enabled: false
+
+# Underscores in numbers are super ugly for port numbers, freebsd versions, etc.
+# If we could mandate that this gets turned on only for numbers >= 1e9 which require three _'s then maybe.
+Style/NumericLiterals:
+  Enabled: false
+
+# I tend to find this more readable than long elsif chains
+Style/EmptyCaseCondition:
+  Enabled: false
+
+# This didn't quite do what we need
+Style/MultilineArrayBraceLayout:
+  Enabled: false
+
+# This rule isn't smart enough to figure out accessors vs. things that set stuff on the system (e.g. set_member method in group providers)
+Style/AccessorMethodName:
+  Enabled: false
+
+# Perl backrefs are just fine and the alternative is a lot of typing.
+Style/PerlBackrefs:
+  Enabled: false
+

data/config/disable_all.yml

@@ -1,4 +1,8 @@
 ---
+Bundler/DuplicatedGem:
+  Enabled: false
+Bundler/OrderedGems:
+  Enabled: false
 Lint/AmbiguousOperator:
   Enabled: false
 Lint/AmbiguousRegexpLiteral:
@@ -17,6 +21,8 @@ Lint/DefEndAlignment:
   Enabled: false
 Lint/DeprecatedClassMethods:
   Enabled: false
+Lint/DuplicateCaseCondition:
+  Enabled: false
 Lint/DuplicateMethods:
   Enabled: false
 Lint/DuplicatedKey:
@@ -27,16 +33,18 @@ Lint/ElseLayout:
   Enabled: false
 Lint/EmptyEnsure:
   Enabled: false
+Lint/EmptyExpression:
+  Enabled: false
 Lint/EmptyInterpolation:
   Enabled: false
+Lint/EmptyWhen:
+  Enabled: false
 Lint/EndAlignment:
   Enabled: false
 Lint/EndInMethod:
   Enabled: false
 Lint/EnsureReturn:
   Enabled: false
-Lint/Eval:
-  Enabled: false
 Lint/FloatOutOfRange:
   Enabled: false
 Lint/FormatParameterMismatch:
@@ -57,6 +65,8 @@ Lint/LiteralInInterpolation:
   Enabled: false
 Lint/Loop:
   Enabled: false
+Lint/MultipleCompare:
+  Enabled: false
 Lint/NestedMethodDefinition:
   Enabled: false
 Lint/NextWithoutAccumulator:
@@ -75,6 +85,8 @@ Lint/RequireParentheses:
   Enabled: false
 Lint/RescueException:
   Enabled: false
+Lint/SafeNavigationChain:
+  Enabled: false
 Lint/ShadowedException:
   Enabled: false
 Lint/ShadowingOuterLocalVariable:
@@ -83,8 +95,12 @@ Lint/StringConversionInInterpolation:
   Enabled: false
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
+Lint/UnifiedInteger:
+  Enabled: false
 Lint/UnneededDisable:
   Enabled: false
+Lint/UnneededSplatExpansion:
+  Enabled: false
 Lint/UnreachableCode:
   Enabled: false
 Lint/UnusedBlockArgument:
@@ -93,8 +109,6 @@ Lint/UnusedMethodArgument:
   Enabled: false
 Lint/UselessAccessModifier:
   Enabled: false
-Lint/UselessArraySplat:
-  Enabled: false
 Lint/UselessAssignment:
   Enabled: false
 Lint/UselessComparison:
@@ -109,6 +123,8 @@ Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
+Metrics/BlockLength:
+  Enabled: false
 Metrics/BlockNesting:
   Enabled: false
 Metrics/ClassLength:
@@ -143,8 +159,6 @@ Performance/HashEachMethods:
   Enabled: false
 Performance/LstripRstrip:
   Enabled: false
-Performance/PushSplat:
-  Enabled: false
 Performance/RangeInclude:
   Enabled: false
 Performance/RedundantBlockCall:
@@ -155,12 +169,16 @@ Performance/RedundantMerge:
   Enabled: false
 Performance/RedundantSortBy:
   Enabled: false
+Performance/RegexpMatch:
+  Enabled: false
 Performance/ReverseEach:
   Enabled: false
 Performance/Sample:
   Enabled: false
 Performance/Size:
   Enabled: false
+Performance/CompareWithBlock:
+  Enabled: false
 Performance/StartWith:
   Enabled: false
 Performance/StringReplacement:
@@ -241,6 +259,8 @@ Style/DefWithParentheses:
   Enabled: false
 Style/PreferredHashMethods:
   Enabled: false
+Style/DocumentationMethod:
+  Enabled: false
 Style/Documentation:
   Enabled: false
 Style/DotPosition:
@@ -273,6 +293,8 @@ Style/EmptyLinesAroundModuleBody:
   Enabled: false
 Style/EmptyLiteral:
   Enabled: false
+Style/EmptyMethod:
+  Enabled: false
 Style/Encoding:
   Enabled: false
 Style/EndBlock:
@@ -345,7 +367,9 @@ Style/LeadingCommentSpace:
   Enabled: false
 Style/LineEndConcatenation:
   Enabled: false
-Style/MethodCallParentheses:
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+Style/MethodCallWithArgsParentheses:
   Enabled: false
 Style/MethodCalledOnDoEndBlock:
   Enabled: false
@@ -371,6 +395,10 @@ Style/MultilineHashBraceLayout:
   Enabled: false
 Style/MultilineIfThen:
   Enabled: false
+Style/MultilineIfModifier:
+  Enabled: false
+Style/MultilineMemoization:
+  Enabled: false
 Style/MultilineMethodCallBraceLayout:
   Enabled: false
 Style/MultilineMethodCallIndentation:
@@ -449,6 +477,8 @@ Style/RescueEnsureAlignment:
   Enabled: false
 Style/RescueModifier:
   Enabled: false
+Style/SafeNavigation:
+  Enabled: false
 Style/SelfAssignment:
   Enabled: false
 Style/Semicolon:
@@ -489,6 +519,8 @@ Style/SpaceBeforeFirstArg:
   Enabled: false
 Style/SpaceBeforeSemicolon:
   Enabled: false
+Style/SpaceInLambdaLiteral:
+  Enabled: false
 Style/SpaceInsideArrayPercentLiteral:
   Enabled: false
 Style/SpaceInsideBlockBraces:
@@ -551,6 +583,8 @@ Style/VariableInterpolation:
   Enabled: false
 Style/VariableName:
   Enabled: false
+Style/VariableNumber:
+  Enabled: false
 Style/WhenThen:
   Enabled: false
 Style/WhileUntilDo:
@@ -565,16 +599,28 @@ Rails/ActionFilter:
   Enabled: false
 Rails/Date:
   Enabled: false
+Rails/DynamicFindBy:
+  Enabled: false
 Rails/Delegate:
   Enabled: false
+Rails/DelegateAllowBlank:
+  Enabled: false
+Rails/EnumUniqueness:
+  Enabled: false
 Rails/Exit:
   Enabled: false
+Rails/FilePath:
+  Enabled: false
 Rails/FindBy:
   Enabled: false
 Rails/FindEach:
   Enabled: false
 Rails/HasAndBelongsToMany:
   Enabled: false
+Rails/HttpPositionalArguments:
+  Enabled: false
+Rails/NotNullColumn:
+  Enabled: false
 Rails/OutputSafety:
   Enabled: false
 Rails/Output:
@@ -585,13 +631,27 @@ Rails/ReadWriteAttribute:
   Enabled: false
 Rails/RequestReferer:
   Enabled: false
+Rails/ReversibleMigration:
+  Enabled: false
+Rails/SafeNavigation:
+  Enabled: false
 Rails/SaveBang:
   Enabled: false
 Rails/ScopeArgs:
   Enabled: false
+Rails/SkipsModelValidations:
+  Enabled: false
 Rails/TimeZone:
   Enabled: false
 Rails/UniqBeforePluck:
   Enabled: false
 Rails/Validation:
   Enabled: false
+Security/Eval:
+  Enabled: false
+Security/JSONLoad:
+  Enabled: false
+Security/MarshalLoad:
+  Enabled: false
+Security/YAMLLoad:
+  Enabled: false