puppetlabs_spec_helper 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 560988fc4b9b6843571dd84cb9950ed4e7183b13
-  data.tar.gz: c0a9ecd1c637521bcbb2376e0db81805ed9c908c
+SHA256:
+  metadata.gz: 6821247effca57cc705aad0fd004ab5fda488ed7053734c996b1ee3249cea435
+  data.tar.gz: 7b762f7e6e5ab7986574e4d080c070a1ee010dfa56baeccb3a6e13c70b4cdee8
 SHA512:
-  metadata.gz: 12dd845bdcfafb01e7e81d6c4d603abc1b235d175711883cdc0e73fd59cb53f6901bfe45e9b52d65333e704f7bf47a29e4d729a881f4eb91ddd5115d7739f081
-  data.tar.gz: 23fa34f17299df694322d9f8402fa95e4f39d7b7eb10c513022431145f709e64167fb190287afd39f96f744dd67529c24db7afe3cd4fc5a4cf294ea0f6c3fe55
+  metadata.gz: 98520f9b6d4b1d7c3f4209991c6c11188b7637dea387de6322f6a2201e8af9203fbc20ab0e777c2cb19f38f05a2c106fd82f8827756a16463ef17c09b8ba8f9d
+  data.tar.gz: cc4718fd5b4424b55980117271b88bdeaf778d3a1c87b34a83d9d79425cde795bf4315c4a11fe05e672ac8f980b74fcc723d9ce238a8982b29c7eaa9d07a4a03

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--order rand

data/.rubocop.yml

@@ -1,504 +1,138 @@
 require: rubocop-rspec
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 1.9
-  Include:
-    - ./**/*.rb
-
-Lint/ConditionPosition:
-  Enabled: True
-
-Lint/ElseLayout:
-  Enabled: True
-
-Lint/UnreachableCode:
-  Enabled: True
-
-Lint/UselessComparison:
-  Enabled: True
-
-Lint/EnsureReturn:
-  Enabled: True
-
-Lint/HandleExceptions:
-  Enabled: True
-
-Lint/LiteralInCondition:
-  Enabled: True
-
-Lint/ShadowingOuterLocalVariable:
-  Enabled: True
-
-Lint/LiteralInInterpolation:
-  Enabled: True
-
-Style/HashSyntax:
-  Enabled: True
-
-Style/RedundantReturn:
-  Enabled: True
-
-Lint/AmbiguousOperator:
-  Enabled: True
-
-Lint/AssignmentInCondition:
-  Enabled: True
-
-Style/SpaceBeforeComment:
-  Enabled: True
-
-Style/AndOr:
-  Enabled: True
-
-Style/RedundantSelf:
-  Enabled: True
-
-# Method length is not necessarily an indicator of code quality
-Metrics/MethodLength:
+  Exclude:
+    # binstubs, and other utilities
+    - bin/**/*
+    - vendor/**/*
+    - vendor/**/.*
+    # Puppet util code follows Puppet's style, not pdk's
+    - lib/puppet/**/*
+    # package testing gems
+    - package-testing/vendor/**/*
+    - package-testing/vendor/**/.*
+
+Layout/IndentHeredoc:
+  Description: The `squiggly` style would be preferable, but is only available from ruby 2.3. We'll enable this when we can.
   Enabled: False
 
-# Module length is not necessarily an indicator of code quality
-Metrics/ModuleLength:
+# Metrics, excludes complexity and sizing metrics for now, as ruby's defaults are very strict
+Metrics/AbcSize:
   Enabled: False
 
-Style/WhileUntilModifier:
-  Enabled: True
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: True
-
-Lint/Eval:
-  Enabled: True
-
-Lint/BlockAlignment:
-  Enabled: True
-
-Lint/DefEndAlignment:
-  Enabled: True
-
-Lint/EndAlignment:
-  Enabled: True
-
-Lint/DeprecatedClassMethods:
-  Enabled: True
-
-Lint/Loop:
-  Enabled: True
-
-Lint/ParenthesesAsGroupedExpression:
-  Enabled: True
-
-Lint/RescueException:
-  Enabled: True
-
-Lint/StringConversionInInterpolation:
-  Enabled: True
-
-Lint/UnusedBlockArgument:
-  Enabled: True
-
-Lint/UnusedMethodArgument:
-  Enabled: True
-
-Lint/UselessAccessModifier:
-  Enabled: True
-
-Lint/UselessAssignment:
-  Enabled: True
-
-Lint/Void:
-  Enabled: True
-
-Style/AccessModifierIndentation:
-  Enabled: True
-
-Style/AccessorMethodName:
-  Enabled: True
-
-Style/Alias:
-  Enabled: True
-
-Style/AlignArray:
-  Enabled: True
-
-Style/AlignHash:
-  Enabled: True
-
-Style/AlignParameters:
-  Enabled: True
-
-Metrics/BlockNesting:
-  Enabled: True
-
-Style/AsciiComments:
-  Enabled: True
-
-Style/Attr:
-  Enabled: True
-
-Style/BracesAroundHashParameters:
-  Enabled: True
-
-Style/CaseEquality:
-  Enabled: True
-
-Style/CaseIndentation:
-  Enabled: True
-
-Style/CharacterLiteral:
-  Enabled: True
-
-Style/ClassAndModuleCamelCase:
-  Enabled: True
-
-Style/ClassAndModuleChildren:
+Metrics/BlockLength:
+  Description: rspec uses long describe blocks, so allow long blocks under spec/
   Enabled: False
+  Exclude:
+    - 'spec/**/*.rb'
 
-Style/ClassCheck:
-  Enabled: True
-
-# Class length is not necessarily an indicator of code quality
 Metrics/ClassLength:
   Enabled: False
 
-Style/ClassMethods:
-  Enabled: True
-
-Style/ClassVars:
-  Enabled: True
-
-Style/WhenThen:
-  Enabled: True
-
-Style/WordArray:
-  Enabled: True
-
-Style/UnneededPercentQ:
-  Enabled: True
-
-Style/Tab:
-  Enabled: True
-
-Style/SpaceBeforeSemicolon:
-  Enabled: True
-
-Style/TrailingBlankLines:
-  Enabled: True
-
-Style/SpaceInsideBlockBraces:
-  Enabled: True
-
-Style/SpaceInsideBrackets:
-  Enabled: True
-
-Style/SpaceInsideHashLiteralBraces:
-  Enabled: True
-
-Style/SpaceInsideParens:
-  Enabled: True
-
-Style/LeadingCommentSpace:
-  Enabled: True
-
-Style/SpaceBeforeFirstArg:
-  Enabled: True
-
-Style/SpaceAfterColon:
-  Enabled: True
-
-Style/SpaceAfterComma:
-  Enabled: True
-
-Style/SpaceAfterMethodName:
-  Enabled: True
-
-Style/SpaceAfterNot:
-  Enabled: True
-
-Style/SpaceAfterSemicolon:
-  Enabled: True
-
-Style/SpaceAroundEqualsInParameterDefault:
-  Enabled: True
-
-Style/SpaceAroundOperators:
-  Enabled: True
-
-Style/SpaceBeforeBlockBraces:
-  Enabled: True
-
-Style/SpaceBeforeComma:
-  Enabled: True
-
-Style/CollectionMethods:
-  Enabled: True
-
-Style/CommentIndentation:
-  Enabled: True
-
-Style/ColonMethodCall:
-  Enabled: True
-
-Style/CommentAnnotation:
-  Enabled: True
-
-# 'Complexity' is very relative
 Metrics/CyclomaticComplexity:
   Enabled: False
 
-Style/ConstantName:
-  Enabled: True
+Metrics/LineLength:
+  Description: People have wide screens, use them.
+  Max: 200
 
-Style/Documentation:
+Metrics/MethodLength:
   Enabled: False
 
-Style/DefWithParentheses:
-  Enabled: True
-
-Style/PreferredHashMethods:
-  Enabled: True
-
-Style/DotPosition:
-  EnforcedStyle: trailing
-
-Style/DoubleNegation:
-  Enabled: True
-
-Style/EachWithObject:
-  Enabled: True
-
-Style/EmptyLineBetweenDefs:
-  Enabled: True
-
-Style/IndentArray:
-  Enabled: True
+Metrics/ModuleLength:
+  Enabled: False
 
-Style/IndentHash:
-  Enabled: True
+Metrics/ParameterLists:
+  Enabled: False
 
-Style/IndentationConsistency:
-  Enabled: True
+Metrics/PerceivedComplexity:
+  Enabled: False
 
-Style/IndentationWidth:
-  Enabled: True
+# RSpec cops
+RSpec/BeforeAfterAll:
+  Description: Beware of using after(:all) as it may cause state to leak between tests. A necessary evil in acceptance testing.
+  Exclude:
+    - 'spec/acceptance/**/*.rb'
+    - 'package-testing/spec/package/**/*.rb'
 
-Style/EmptyLines:
-  Enabled: True
+RSpec/DescribeClass:
+  Description: This cop does not account for rspec-puppet, and beaker-rspec usage.
+  Enabled: False
 
-Style/EmptyLinesAroundAccessModifier:
-  Enabled: True
+RSpec/HookArgument:
+  Description: Prefer explicit :each argument, matching existing module's style
+  EnforcedStyle: each
 
-Style/EmptyLiteral:
-  Enabled: True
+RSpec/NestedGroups:
+  Description: Nested groups can lead to cleaner tests with less duplication
+  Max: 10
 
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
+RSpec/ExampleLength:
+  Description: Forcing short examples leads to the creation of one-time use let() helpers
   Enabled: False
 
-Style/MethodCallParentheses:
-  Enabled: True
-
-Style/MethodDefParentheses:
-  Enabled: True
-
-Style/LineEndConcatenation:
-  Enabled: True
+RSpec/MessageSpies:
+  EnforcedStyle: receive
 
-Style/TrailingWhitespace:
-  Enabled: True
+# Style Cops
+Style/AsciiComments:
+  Description: Names, non-english speaking communities.
+  Enabled: False
 
-Style/StringLiterals:
-  Enabled: True
+Style/BlockDelimiters:
+  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to be consistent then.
+  EnforcedStyle: braces_for_chaining
 
-Style/TrailingCommaInArguments:
-  Enabled: True
+Style/ClassAndModuleChildren:
+  Description: Compact style reduces the required amount of indentation.
+  EnforcedStyle: compact
 
-Style/TrailingCommaInLiteral:
-  Enabled: True
+Style/EmptyElse:
+  Description: Enforce against empty else clauses, but allow `nil` for clarity.
+  EnforcedStyle: empty
 
-Style/GlobalVars:
-  Enabled: True
+Style/FormatString:
+  Description: Following the main puppet project's style, prefer the % format format.
+  EnforcedStyle: percent
 
-Style/GuardClause:
-  Enabled: True
+Style/FormatStringToken:
+  Description: Following the main puppet project's style, prefer the simpler template tokens over annotated ones.
+  EnforcedStyle: template
 
 Style/IfUnlessModifier:
-  Enabled: True
-
-Style/MultilineIfThen:
-  Enabled: True
-
-Style/NegatedIf:
-  Enabled: True
-
-Style/NegatedWhile:
-  Enabled: True
-
-Style/Next:
-  Enabled: True
-
-Style/SingleLineBlockParams:
-  Enabled: True
-
-Style/SingleLineMethods:
-  Enabled: True
-
-Style/SpecialGlobalVars:
-  Enabled: True
-
-Style/TrivialAccessors:
-  Enabled: True
-
-Style/UnlessElse:
-  Enabled: True
-
-Style/VariableInterpolation:
-  Enabled: True
-
-Style/VariableName:
-  Enabled: True
-
-Style/WhileUntilDo:
-  Enabled: True
-
-Style/EvenOdd:
-  Enabled: True
-
-Style/FileName:
-  Enabled: True
-
-Style/For:
-  Enabled: True
+  Description: Post-fix `if` modifiers are hard to parse for newcomers. We don't want to encourage them. Post-fix `unless` modifiers could be nice in some cases, but the Cop doesn't differentiate.
+  Enabled: false
 
 Style/Lambda:
-  Enabled: True
-
-Style/MethodName:
-  Enabled: True
-
-Style/MultilineTernaryOperator:
-  Enabled: True
-
-Style/NestedTernaryOperator:
-  Enabled: True
-
-Style/NilComparison:
-  Enabled: True
-
-Style/FormatString:
-  Enabled: True
-
-Style/MultilineBlockChain:
-  Enabled: True
-
-Style/Semicolon:
-  Enabled: True
+  Description: Prefer the keyword for easier discoverability.
+  EnforcedStyle: literal
 
-Style/SignalException:
-  Enabled: True
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
 
-Style/NonNilCheck:
-  Enabled: True
-
-Style/Not:
-  Enabled: True
-
-Style/NumericLiterals:
-  Enabled: True
-
-Style/OneLineConditional:
-  Enabled: True
-
-Style/OpMethod:
-  Enabled: True
-
-Style/ParenthesesAroundCondition:
-  Enabled: True
-
-Style/PercentLiteralDelimiters:
-  Enabled: True
-
-Style/PerlBackrefs:
-  Enabled: True
-
-Style/PredicateName:
-  Enabled: True
-
-Style/RedundantException:
-  Enabled: True
-
-Style/SelfAssignment:
-  Enabled: True
-
-Style/Proc:
-  Enabled: True
-
-Style/RaiseArgs:
-  Enabled: True
-
-Style/RedundantBegin:
-  Enabled: True
-
-Style/RescueModifier:
-  Enabled: True
-
-# based on https://github.com/voxpupuli/modulesync_config/issues/168
 Style/RegexpLiteral:
+  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
   EnforcedStyle: percent_r
-  Enabled: True
-
-Lint/UnderscorePrefixedVariableName:
-  Enabled: True
-
-Metrics/ParameterLists:
-  Enabled: False
-
-Lint/RequireParentheses:
-  Enabled: True
-
-Style/SpaceBeforeFirstArg:
-  Enabled: True
-
-Style/ModuleFunction:
-  Enabled: True
 
-Lint/Debugger:
-  Enabled: True
+Style/SymbolProc:
+  Description: SymbolProc notation is not discoverable
+  Enabled: false
 
-Style/IfWithSemicolon:
-  Enabled: True
+Style/TernaryParentheses:
+  Description: Checks for use of parentheses around ternary conditions. Enforce parentheses on complex expressions for better readability, but seriously consider breaking it up.
+  EnforcedStyle: require_parentheses_when_complex
 
-Style/Encoding:
-  Enabled: True
-
-Style/BlockDelimiters:
-  Enabled: True
-
-Style/MultilineBlockLayout:
-  Enabled: True
-
-# 'Complexity' is very relative
-Metrics/AbcSize:
-  Enabled: False
-
-# 'Complexity' is very relative
-Metrics/PerceivedComplexity:
-  Enabled: False
-
-Lint/UselessAssignment:
-  Enabled: True
-
-Style/ClosingParenthesisIndentation:
-  Enabled: False
-
-# RSpec
-
-# We don't use rspec in this way
-RSpec/DescribeClass:
-  Enabled: False
+Style/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
 
-# Example length is not necessarily an indicator of code quality
-RSpec/ExampleLength:
-  Enabled: False
+Style/TrailingCommaInLiteral:
+  Description: Prefer always trailing comma on multiline literals. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
 
-RSpec/NamedSubject:
-  Enabled: False
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  Enabled: true
+  EnforcedStyle: brackets