rubocop-replaypoker 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec4ebc7f57d16e94193dfa604bb9e93f5ef7c4aa632feb448b8def6e2537fa0
-  data.tar.gz: b6e558bd717e6d6d3070e0fbdcf3e41ef3ae4a08329229e99446044295ded07a
+  metadata.gz: afac3692c0d4d5b205e11211697d92e5c36f57a63d7f46ea05fcf5d7e85324c7
+  data.tar.gz: 787dbd0881766205efecd9852138c3148959d7ac2c3c12fa53683b26c1cd31a0
 SHA512:
-  metadata.gz: bbb6a3ceca322010c4cc7f7736992e407425c31fba80f614103a3d7ae12be23ff6aef7680c0f1315c5c5f7668404449e12fe24071692ff64ec4f48a363a157cc
-  data.tar.gz: a518108db18afe22b4663d9f5743ddf55b21007e7b5402e93e2f569354d58fabc707b735dc277657f735b0ea39fccd707172b42f988b6a7b8be60fb481017256
+  metadata.gz: 318609718216e8562318fb3cec2ed5e0eb98d443f9eb673cba65a1c794372de0df2f315f5075d55dfb70fdde7c478510965c6d9b8930f8e082c1473c8d890628
+  data.tar.gz: 06a41fb9281eaa1b822d9b435d6e52c9f06d58c07cb152d6e94d58068bf334f7e4901e078e0020fb339ee3c43feaa5df675713fda89f955e266c7827524a0f65

data/README.md

@@ -2,7 +2,8 @@
 
 # Rubocop::Replaypoker
 
-Common Ruby style settings.
+Common Ruby style settings. This gem takes all the settings and version controls
+still giving to the developer the ability to make per project adjustments.
 
 ## Installation
 
@@ -22,7 +23,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem assume that it will be used in the project with the linter settings
+inheritance would be something like this:
+
+0. Rubocop gem defaults, [link](https://github.com/rubocop/rubocop/blob/master/config/default.yml)
+1. The settings from this gem, [link](https://github.com/replaygaming/rubocop-replaypoker/blob/master/config/default.yml)
+2. The auto-gen-config (see in your project `.rubocop_todo.yml`)
+    * This file is auto generated by rubocop with the command `bundler exec rubocop --auto-gen-config` and stub all the warnings from rubocop.
+    * Keep this file empty in the `master` branch
+3. Project specific settings (see in your project `.rubocop_local_overrides.yml`)
+    * rubocop gem have the variety of extra addons which might be added and require some extra settings or the project might require some adjustments against the already defined settings. All of it should be in here.
+
+To apply this structure copy [link](https://github.com/rubocop/rubocop/blob/master/templates/.rubocop.yml)
+to your project root.
+
+### Notes && gotchas
+
+* Rubocop gem have an awesome auto-correction feature. There are 2 modes: safe & ricky. To run safe option use `bundle exec rubocop -a` and for ricky use `bundle exec rubocop -A`.
+* Some rubocop cops depend on the settings from another cops (`Layout/LineLength` cop is a great example), so if you added some code which break this cop and there is no way to auto-correct it and then executed `bundler exec rubocop auto-gen-config` it produce the new cop `Max` setting and it would be applied  all the dependencies. It might produce a lot of unwanted changes.
+* Because of the previous trait i recommend to `git commit` all your changes and run rubocop afterwards, and then apply the changes with something like `git add . && git commit --amend --no-edit`
 
 ## Development
 
@@ -34,7 +53,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/replaypoker/rubocop-replaypoker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/replaypoker/rubocop-replaypoker/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rubocop/replaypoker/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Replaypoker
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/rubocop-replaypoker.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'rubocop', '~> 1.15.0'
-  spec.add_runtime_dependency 'rubocop-rspec', '~> 2.3.0'
+  spec.add_runtime_dependency 'rubocop', '~> 1.22.0'
+  spec.add_runtime_dependency 'rubocop-rspec', '~> 2.6.0'
 end
 

data/templates/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+inherit_mode:
+  merge:
+    - Exclude
+    - IgnoredMethods
+
+inherit_gem:
+  rubocop-replaypoker:
+    - config/default.yml
+
+inherit_from:
+  - .rubocop_todo.yml
+  - .rubocop_local_overrides.yml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-replaypoker
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - kvokka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.22.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.6.0
 description: Replaypoker rubocop config.
 email:
 - kvokka@yahoo.com
@@ -63,6 +63,7 @@ files:
 - lib/rubocop/replaypoker/inject.rb
 - lib/rubocop/replaypoker/version.rb
 - rubocop-replaypoker.gemspec
+- templates/.rubocop.yml
 homepage: https://github.com/replaygaming/rubocop-replaypoker
 licenses:
 - MIT