kpn-style 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ddda7401805a90cdc67abd6c44fca3bef2c9b7a05fea8459c71cfa6c570f98
-  data.tar.gz: 0b16e758963051e536df4e50d65249eeb38086250a1b8ba93ab84d697cea5be3
+  metadata.gz: 652adc455105950df12befa7fe04a6dd079e6e52e746d919c3a659b8947fae8c
+  data.tar.gz: c025a4a56ba08b1d91faa31c496f2d43e150c835a99435e189f10cce1429418d
 SHA512:
-  metadata.gz: a7b0ba010f74971634f40ab14d2079d9adf34d50ebee65d209e235847d319eebd3304e44b2b26ffa74f3151545bb03e007797d5c28b9f34f3eb02f08fb7a92f2
-  data.tar.gz: 87181780ca1431e97ce08f4d9fdbb040cd99d8a70bea9c869d08d6e40d35e8dc28ed866d7866ed8e77d905753d691534f33c42c2a30f9358b007578c1971a53f
+  metadata.gz: e87250f9a5937d51afcb2d04e33310733e782d620ffe544abf6852d91bf5fd4a6ff16cdda43e911d7b9975981e1e6a72307e904023ae11709d1870c938c49bd7
+  data.tar.gz: 65f535cd264ca637781915c9f1c4a92f8e96c5b6a86bf5014e31aa9830d8877b09f3e6b65983b1b46e55e241bb5aeb6974732808167076848079f3339ac3caae

data/README.md

@@ -42,6 +42,14 @@ inherit_gem:
     - ruby-2.4.yml
 ```
 
+Or for Ruby 2.5:
+
+```yaml
+inherit_gem:
+  kpn-style:
+    - ruby-2.5.yml
+```
+
 Now, run:
 
 ```bash

data/kpn_style.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'kpn-style'
-  spec.version       = '0.1.3'
+  spec.version       = '0.1.8'
   spec.authors       = ['kpn']
   spec.email         = ['noreply@kpn.com']
 
@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 0.53'
-  spec.add_dependency 'rubocop-rspec', '~> 1.24'
+  spec.add_dependency 'rubocop', '~> 0.93.1'
+  spec.add_dependency 'rubocop-rspec', '~> 1.44.1'
 end

data/lib/kpn/style/version.rb

@@ -1,3 +1,3 @@
 module Kpn::Style
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.8'.freeze
 end

data/ruby-2.4-strict.yml

@@ -0,0 +1,107 @@
+---
+require: rubocop-rspec
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: '2.4'
+  Include:
+  - "**/*.rb"
+  Exclude:
+  - bin/*
+  - ".vendor/**/*"
+  - Gemfile
+  - Rakefile
+  - pkg/**/*
+  - spec/fixtures/**/*
+  - vendor/**/*
+Metrics/LineLength:
+  Description: People have wide screens, use them.
+  Max: 240
+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
+RSpec/HookArgument:
+  Description: Prefer explicit :each argument, matching existing module's style
+  EnforcedStyle: each
+Style/BlockDelimiters:
+  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
+    be consistent then.
+  EnforcedStyle: braces_for_chaining
+Style/ClassAndModuleChildren:
+  Description: Compact style reduces the required amount of indentation.
+  EnforcedStyle: compact
+Style/EmptyElse:
+  Description: Enforce against empty else clauses, but allow `nil` for clarity.
+  EnforcedStyle: empty
+Style/FormatString:
+  Description: Following the main puppet project's style, prefer the % format format.
+  EnforcedStyle: percent
+Style/FormatStringToken:
+  Description: Following the main puppet project's style, prefer the simpler template
+    tokens over annotated ones.
+  EnforcedStyle: template
+Style/Lambda:
+  Description: Prefer the keyword for easier discoverability.
+  EnforcedStyle: literal
+Style/RegexpLiteral:
+  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
+  EnforcedStyle: percent_r
+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/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes
+    diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  EnforcedStyle: brackets
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+Style/CollectionMethods:
+  Enabled: true
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/StringMethods:
+  Enabled: true
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MessageExpectation:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/SymbolProc:
+  Enabled: false

data/ruby-2.4.yml

@@ -24,6 +24,8 @@ RSpec/BeforeAfterAll:
 RSpec/HookArgument:
   Description: Prefer explicit :each argument, matching existing module's style
   EnforcedStyle: each
+RSpec/ImplicitSubject:
+  Enabled: false
 Style/BlockDelimiters:
   Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
     be consistent then.

data/ruby-2.5.yml

@@ -0,0 +1,320 @@
+---
+require: rubocop-rspec
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: '2.5'
+  Include:
+  - "**/*.rb"
+  Exclude:
+  - bin/*
+  - ".vendor/**/*"
+  - Gemfile
+  - Rakefile
+  - pkg/**/*
+  - spec/fixtures/**/*
+  - vendor/**/*
+Layout/BeginEndAlignment: # (new in 0.91)
+  Description: checks whether the end keyword of begin is aligned properly.
+  Enabled: true
+Layout/LineLength:
+  Description: People have wide screens, use them.
+  Max: 240
+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
+RSpec/EmptyExampleGroup:
+  Description: Checks if an example group does not include any tests.
+  Enabled: false
+RSpec/HookArgument:
+  Description: Prefer explicit :each argument, matching existing module's style
+  EnforcedStyle: each
+RSpec/RepeatedDescription:
+  Description: Check for repeated description strings in example groups.
+  Enabled: false
+Style/BlockDelimiters:
+  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
+    be consistent then.
+  EnforcedStyle: braces_for_chaining
+Style/ClassAndModuleChildren:
+  Description: Compact style reduces the required amount of indentation.
+  EnforcedStyle: compact
+Style/EmptyElse:
+  Description: Enforce against empty else clauses, but allow `nil` for clarity.
+  EnforcedStyle: empty
+Style/FormatString:
+  Description: Following the main puppet project's style, prefer the % format format.
+  EnforcedStyle: percent
+Style/FormatStringToken:
+  Description: Following the main puppet project's style, prefer the simpler template
+    tokens over annotated ones.
+  EnforcedStyle: template
+Style/Lambda:
+  Description: Prefer the keyword for easier discoverability.
+  EnforcedStyle: literal
+Style/RegexpLiteral:
+  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
+  EnforcedStyle: percent_r
+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/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes
+    diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  EnforcedStyle: brackets
+RSpec/MessageSpies:
+  Description: Checks that message expectations are set using spies.
+  EnforcedStyle: receive
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  Enabled: true
+Style/MethodCalledOnDoEndBlock:
+  Description: Avoid chaining a method call on a do...end block.
+  Enabled: true
+Style/StringMethods:
+  Description: Checks if configured preferred methods are used over non-preferred.
+  Enabled: true
+Layout/EndOfLine:
+  Description: Use Unix-style line endings.
+  EnforcedStyle: lf
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Enabled: false
+Metrics/BlockLength:
+  Description: Avoid long blocks with many lines.
+  Enabled: false
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: >-
+                 A complexity metric that is strongly correlated to the number
+                 of test cases needed to validate a method.
+  Enabled: false
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  Enabled: false
+Metrics/ModuleLength:
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Description: >-
+                 A complexity metric geared towards measuring complexity for a
+                 human reader.
+  Enabled: false
+RSpec/DescribeClass:
+  Description: Check that the first argument to the top-level describe is a constant.
+  Enabled: false
+RSpec/ExampleLength:
+  Description: Checks for long examples.
+  Enabled: false
+RSpec/MessageExpectation:
+  Description: Checks for consistent message expectation style.
+  Enabled: false
+RSpec/MultipleExpectations:
+  Description: Checks if examples contain too many `expect` calls.
+  Enabled: false
+RSpec/NestedGroups:
+  Description: Checks for nested example groups.
+  Enabled: false
+Style/AsciiComments:
+  Description: Use only ascii symbols in comments.
+  Enabled: false
+Style/IfUnlessModifier:
+  Description: Don't force trailing if/unless for single-line conditionals
+  Enabled: false
+Style/SymbolProc:
+  Description: Use symbols as procs instead of blocks when possible.
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Description: Keep blank lines around attribute accessors.
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Description: Checks method call operators to not have spaces around them.
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands:
+  Description: This cop checks for places where binary operator has identical operands.
+  Enabled: true
+Lint/ConstantDefinitionInBlock:
+  Description: Do not define constants within a block.
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Description: Don't use algorithm constants for `OpenSSL::Cipher` and `OpenSSL::Digest`.
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Description: Do not repeat conditions used in if `elsif`.
+  Enabled: true
+Lint/DuplicateRequire:
+  Description: Check for duplicate `require`s and `require_relative`s.
+  Enabled: true
+Lint/DuplicateRescueException:
+  Description: Checks that there are no repeated exceptions used in `rescue` expressions.
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Description: This cop checks for the presence of `if`, `elsif` and `unless` branches without a body.
+  Enabled: true
+Lint/EmptyFile:
+  Description: Enforces that Ruby source files are not empty.
+  Enabled: true
+Lint/FloatComparison:
+  Description: Checks for the presence of precise comparison of floating point numbers.
+  Enabled: true
+Lint/HashCompareByIdentity:
+  Description: Prefer using `Hash#compare_by_identity` than using `object_id` for keys.
+  Enabled: true
+Lint/IdentityComparison:
+  Description: Prefer `equal?` over `==` when comparing `object_id`.
+  Enabled: true
+Lint/MissingSuper:
+  Description: >-
+                  This cop checks for the presence of constructors and lifecycle callbacks
+                  without calls to `super`'.
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Description: Do not mix named captures and numbered captures in a Regexp literal.
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Description: Checks for out of range reference for Regexp because it always returns nil.
+  Enabled: true
+Lint/RaiseException:
+  Description: Checks for `raise` or `fail` statements which are raising `Exception` class.
+  Enabled: true
+Lint/RedundantSafeNavigation:
+  Description: Checks for redundant safe navigation calls.
+  Enabled: true
+Lint/SelfAssignment:
+  Description: Checks for self-assignments.
+  Enabled: true
+Lint/StructNewOverride:
+  Description: Disallow overriding the `Struct` built-in methods via `Struct.new`.
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Description: This cop detects top level return statements with argument.
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration:
+  Description: This cop checks for trailing commas in attribute declarations.
+  Enabled: true
+Lint/UnreachableLoop:
+  Description: This cop checks for loops that will have at most one iteration.
+  Enabled: true
+Lint/UselessMethodDefinition:
+  Description: Checks for useless method definitions.
+  Enabled: true
+Lint/UselessTimes:
+  Description: Checks for useless `Integer#times` calls.
+  Enabled: true
+RSpec/StubbedMock:
+  Description: Checks that message expectations do not have a configured response.
+  Enabled: true
+Style/AccessorGrouping:
+  Description: Checks for grouping of accessors in `class` and `module` bodies.
+  Enabled: true
+Style/ArrayCoercion:
+  Description: >-
+                  Use Array() instead of explicit Array check or [*var], when dealing
+                  with a variable you want to treat as an Array, but you're not certain it's an array.
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Description: >-
+                Checks for places where `attr_reader` and `attr_writer`
+                for the same method can be combined into single `attr_accessor`.
+  Enabled: true
+Style/CaseLikeIf:
+  Description: This cop identifies places where `if-elsif` constructions can be replaced with `case-when`.
+  Enabled: true
+Style/ClassEqualityComparison:
+  Description: Enforces the use of `Object#instance_of?` instead of class comparison for equality.
+  Enabled: true
+Style/CombinableLoops:
+  Description: >-
+                  Checks for places where multiple consecutive loops over the same data
+                  can be combined into a single loop.
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Description: >-
+                  Consider using explicit block argument to avoid writing block literal
+                  that just passes its arguments to another block.
+  Enabled: true
+Style/ExponentialNotation:
+  Description: When using exponential notation, favor a mantissa between 1 (inclusive) and 10 (exclusive).
+  Enabled: true
+Style/GlobalStdStream:
+  Description: Enforces the use of `$stdout/$stderr/$stdin` instead of `STDOUT/STDERR/STDIN`.
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Description: >-
+                 Checks for presence or absence of braces around hash literal as a last
+                 array item depending on configuration.
+  Enabled: true
+Style/HashEachMethods:
+  Description: Use Hash#each_key and Hash#each_value.
+  Enabled: true
+Style/HashLikeCase:
+  Description: >-
+                  Checks for places where `case-when` represents a simple 1:1
+                  mapping and can be replaced with a hash lookup.
+  Enabled: true
+Style/HashTransformKeys:
+  Description: Prefer `transform_keys` over `each_with_object`, `map`, or `to_h`.
+  Enabled: true
+Style/HashTransformValues:
+  Description: Prefer `transform_values` over `each_with_object`, `map`, or `to_h`.
+  Enabled: true
+Style/KeywordParametersOrder:
+  Description: Enforces that optional keyword parameters are placed at the end of the parameters list.
+  Enabled: true
+Style/OptionalBooleanParameter:
+  Description: Use keyword arguments when defining method with boolean argument.
+  Enabled: true
+Style/RedundantAssignment:
+  Description: Checks for redundant assignment before returning.
+  Enabled: true
+Style/RedundantFetchBlock:
+  Description: >-
+                  Use `fetch(key, value)` instead of `fetch(key) { value }`
+                  when value has Numeric, Rational, Complex, Symbol or String type, `false`, `true`, `nil` or is a constant.
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Description: >-
+                  Checks for the presence of superfluous `.rb` extension in
+                  the filename provided to `require` and `require_relative`.
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Description: Checks for unnecessary single-element Regexp character classes.
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Description: Checks for redundant escapes in Regexps.
+  Enabled: false
+Style/RedundantSelfAssignment:
+  Description: Checks for places where redundant assignments are made for in place modification methods.
+  Enabled: true
+Style/SingleArgumentDig:
+  Description: Avoid using single argument dig method.
+  Enabled: true
+Style/SlicingWithRange:
+  Description: Checks array slicing is done with endless ranges when suitable.
+  Enabled: true
+Style/SoleNestedConditional:
+  Description: >-
+                  Finds sole nested conditional nodes
+                  which can be merged into outer conditional node.
+  Enabled: true
+Style/StringConcatenation:
+  Description: Checks for places where string concatenation can be replaced with string interpolation.
+  Enabled: true
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kpn-style
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - kpn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: 0.93.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: 0.93.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: 1.44.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: 1.44.1
 description: 
 email:
 - noreply@kpn.com
@@ -55,7 +55,9 @@ files:
 - lib/kpn/style.rb
 - lib/kpn/style/version.rb
 - ruby-2.1.yml
+- ruby-2.4-strict.yml
 - ruby-2.4.yml
+- ruby-2.5.yml
 homepage: https://github.com/kpn-puppet/gem-kpn-style
 licenses:
 - Apache-2.0
@@ -76,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: kpn style guides and shared style configs.