kpn-style 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2068976516c42d4d0d5a96fff81db765f8be9870
-  data.tar.gz: 88b5ee98c9a510ab6356373ee40f8df69b3d4eeb
+SHA256:
+  metadata.gz: 5e4746a2cf1fa84304391b1e62983a08ce7ec7498cc119b2c19aa3c510c25d1e
+  data.tar.gz: dc1b13975fbdcf641e84a36476aee73c60540252f35680d72732e324e33aa34d
 SHA512:
-  metadata.gz: b6a318c439b180bda59f57dfa3b7bed9267ee434dd9e9478a8f72cbf7d18b69bc25fe182e6b1fa75719cebe1af2e18542036e3c836e92dcf297151e2f9ec5cdc
-  data.tar.gz: c90166505078e9ec5092c9bd91c4ecd6a7cc00f97f974c27753318c69613ef45cc3d3b8f6407db188d4ea6b9ca8e0f887ba7e4f5e7f712fda65e164fbfcd70c7
+  metadata.gz: 7166bcd7b85197ca2526ccf18785f5e74681b10f60fc2681f41d1ac90898fdd40eb416c6b154deec6392a79229d47d123843bfb4c98556e67bc640f827b840a1
+  data.tar.gz: '091f153d7ed59e59dcec29a39d79a764a696788f8a3a3a4b003dea9792c91db0305e3e72e4598c8be0b473423eb1ec98d10876801b64d473d3b6163e4216581e'

data/README.md

@@ -31,7 +31,7 @@ Create a `.rubocop.yml` with the following directives:
 ```yaml
 inherit_gem:
   kpn-style:
-    - default.yml
+    - ruby-2.1.yml
 ```
 
 Or for Ruby 2.4:
@@ -42,10 +42,65 @@ inherit_gem:
     - ruby-2.4.yml
 ```
 
+Or for Ruby 2.5:
+
+```yaml
+inherit_gem:
+  kpn-style:
+    - ruby-2.5.yml
+```
+
 Now, run:
 
 ```bash
 $ bundle exec rubocop
+
+or
+
+$ rake rubocop
 ```
 
 You do not need to include rubocop directly in your application's dependencies. kpn-style will include a specific version of `rubocop` and `rubocop-rspec` that is shared across all projects.
+
+## Style overrides
+
+Sometimes you need to override style rules. RuboCop have a nice inheritance hierachy so you can override the default settings.
+The hierachy is:
+
+```
+inherit_gem -> inherit_from -> local rules
+```
+
+For example:
+
+```yaml
+inherit_gem:
+  kpn-style:
+    - ruby-2.1.yml
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - exclude/file.rb
+```
+
+## Update gem
+
+1. Update the ruby-2.X.yml file
+2. Update the version parameter `spec.version` in the `kpn_style.gemspec`
+3. Tag the release: `git tag VERSION`
+4. Push changes: `git push --tags`
+5. Update the release notes on GitHub.com
+6. Build and publish:
+
+```bash
+gem build kpn_style.gemspec
+gem push kpn-style-x.x.x.gem
+```
+
+To push gems to rubygems.org you can use a `~/.gem/credentials` with the `rubygems_api_key`. You can find a small how to on the Profile edit page https://rubygems.org/profile/edit in the section `API ACCESS`.
+
+### Special thanks
+
+A special thanks to https://github.com/percy/percy-style/ for the idea and template of this Gem.

data/kpn_style.gemspec

@@ -3,11 +3,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'kpn-style'
-  spec.version       = '0.1.1'
+  spec.version       = '0.1.6'
   spec.authors       = ['kpn']
   spec.email         = ['noreply@kpn.com']
 
-  spec.summary       = 'KPN style guides and shared style configs.'
+  spec.summary       = 'kpn style guides and shared style configs.'
   spec.homepage      = 'https://github.com/kpn-puppet/gem-kpn-style'
   spec.license       = 'Apache-2.0'
 
@@ -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.89'
+  spec.add_dependency 'rubocop-rspec', '~> 1.43'
 end

data/lib/kpn/style/version.rb

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

data/{default.yml → ruby-2.1.yml}

@@ -72,7 +72,7 @@ Style/MethodCalledOnDoEndBlock:
 Style/StringMethods:
   Enabled: true
 Layout/EndOfLine:
-  Enabled: false
+  EnforcedStyle: lf
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:

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

@@ -4,7 +4,7 @@ AllCops:
   DisplayCopNames: true
   TargetRubyVersion: '2.4'
   Include:
-  - "./**/*.rb"
+  - "**/*.rb"
   Exclude:
   - bin/*
   - ".vendor/**/*"
@@ -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.
@@ -72,7 +74,7 @@ Style/MethodCalledOnDoEndBlock:
 Style/StringMethods:
   Enabled: true
 Layout/EndOfLine:
-  Enabled: false
+  EnforcedStyle: lf
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:

data/ruby-2.5.yml

@@ -0,0 +1,268 @@
+---
+require: rubocop-rspec
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: '2.5'
+  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/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
+yout/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/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/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/FloatComparison:
+  Description: Checks for the presence of precise comparison of floating point numbers.
+  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/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/UnreachableLoop:
+  Description: This cop checks for loops that will have at most one iteration.
+  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/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/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/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/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.1
+  version: 0.1.6
 platform: ruby
 authors:
 - kpn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2020-10-13 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.89'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.89'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.43'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.43'
 description: 
 email:
 - noreply@kpn.com
@@ -50,13 +50,14 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- RELEASING.md
 - Rakefile
-- default.yml
 - kpn_style.gemspec
 - 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
@@ -77,9 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: KPN style guides and shared style configs.
+summary: kpn style guides and shared style configs.
 test_files: []

data/RELEASING.md

@@ -1,16 +0,0 @@
-# Releasing
-
-1. Update version.rb file accordingly.
-1. Tag the release: `git tag VERSION`
-1. Push changes: `git push --tags`
-1. Update the release notes on GitHub.com
-1. Build and publish:
-
-```bash
-bundle exec rake build
-gem push pkg/kpn-style-X.XX.XX.gem
-```
-
-* Announce the new release,
-   making sure to say "thank you" to the contributors
-   who helped shape this version!