puppetlabs_spec_helper 2.6.2 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 847f2b3b3a676bafcb358cc257baf0cbc9a8600d
-  data.tar.gz: fa55fb32bbf5445d851105f54c933e18c2a514ae
+SHA256:
+  metadata.gz: 0f07249eb1b0543bd0a6072bf0658b88024c85c2f10a65bbc93f435866453338
+  data.tar.gz: 3fb65221a13f49fe034e5704132ca06e0adfe29f99c66bda0b9b018564937baa
 SHA512:
-  metadata.gz: 8b76ba47b2d7f7fd28d2e0b673effb951778475c6653c89c1c67b96c53caf0e076a69baadb0743f945d0f190a14eb77883d52039ae088d7ae04c304bc8b0643f
-  data.tar.gz: 8b0e09f08ef5febe92178185eb3b24a611f3bf8f8b319df6555a221bb2f0ad828e2f75e4caf94fa31af8bcb6922d1ce95c2575ed8af636cf7e8aae5b28c2e711
+  metadata.gz: 80a02ec1ff937f9000cc97c184af53a0844323127d11ab86ec336abbc946b58d5058fe91d11cf23480991a0bf541fd7281980df7f845a80083f81002d1ffcf2c
+  data.tar.gz: 1425436924772050a6834fa3072ce749d185a9feb894fa6488b777b1c2cd82aef25890f06fba3c0df207838094be76f40caa018feda05ecb36e9280255d0b8a8

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rubocop
+    versions:
+    - "> 0.49, < 1"
+  - dependency-name: rubocop
+    versions:
+    - ">= 1.a, < 2"

data/.rspec

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

data/.rubocop.yml

@@ -1,504 +1,155 @@
 require: rubocop-rspec
-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
+inherit_from: .rubocop_todo.yml
 
-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:
-  Enabled: False
-
-# Module length is not necessarily an indicator of code quality
-Metrics/ModuleLength:
+AllCops:
+  TargetRubyVersion: 2.4
+  # let dependabot find the rough spots for us
+  NewCops: enable
+  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/**/.*
+
+# 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
+RSpec/MessageSpies:
+  EnforcedStyle: receive
 
-Style/LineEndConcatenation:
-  Enabled: True
-
-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
-
-# Example length is not necessarily an indicator of code quality
-RSpec/ExampleLength:
-  Enabled: False
-
-RSpec/NamedSubject:
-  Enabled: False
+Style/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: Prefer always trailing comma on multiline literals. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: Prefer always trailing comma on multiline literals. This makes diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Enforce LF line endings, even when on Windows
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+RSpec/ContextWording:
+  Prefixes:
+  - and
+  - but
+  - when
+  - with
+  - without