rubocop-bitcrowd 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d9c285df0e1e065f4db4463a8045de98358363884cdfb1184c1dda44ce1660
-  data.tar.gz: bffd1004e0807c144e348e3ae4f4b113b0b6e9e09002f849a95eaed15b2f4dfd
+  metadata.gz: 2b0d564235084a7fde4c55f8af20c0a6cf6eec29a2801b219d44dc60decbc220
+  data.tar.gz: e64f7ea8be218c6da19eec860bafe82aaf627b43d6a25f23bb246d2c5e19b0b8
 SHA512:
-  metadata.gz: 68f77bcba7d8215c5b60e71145b44e66c1303a934136863569d3a05c79a85668deb3e1a7adb5232da4fcaeba8f8c87eb2ad6226e84ba4f4eaf757d2bfb6e16ed
-  data.tar.gz: 5134a06cf1c671bcbd4f4d39be666ece2f062508ffd4ab4d3cf651329dfefddfca15a1bd78facf7613f2d6a392b6cc670ba45cada610eb1d4f2b0d3e68993448
+  metadata.gz: 384c691163b3732a63b7bc761017121aa0a3676e52462b2d7fe645f47905899cb0f8e6746edf87bd09dcd5def7fc7a9174ba4e5157253c93a2eae63403d57c4f
+  data.tar.gz: 259b37f81b7253c3a85eea330017f7504acda2383eaf98e3ba4bb03c2a8b402a08ce5d5ab993fa5cba158761ea1b85d6354e302e307625e9488c0d54fb7b3169

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+<!--
+PR checklist:
+- Did you update the CHANGELOG.md?
+-->
+

data/.rubocop.yml

@@ -1,10 +1,13 @@
 AllCops:
+  # Additional exclude patterns for files that should not be analyzed.
+  # These extend the default RuboCop exclude patterns:
+  # https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml
   Exclude:
-    - 'node_modules/**/*'
-    - 'vendor/bundle/**/*'
     - 'script/**/*'
     - 'db/schema.rb'
-  DisplayCopNames: true
+    - 'tmp/**/*'
+    - 'storage/**/*'
+    - 'log/**/*'
   DisplayStyleGuide: true
 
 Documentation:

data/CHANGELOG.md

@@ -4,25 +4,60 @@ Presented in reverse chronological order.
 
 ## master
 
-https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.3.0...HEAD
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v2.0.0...HEAD
 
 *Put high-level summary here before releasing a new version*
 
 ### Deprecations:
 
-* Put deprecations here (in a brief bullet point)
+* *Put deprecations here (in a brief bullet point)*
 
 ### Potentially breaking changes:
 
-* Put potentially breaking changes here (in a brief bullet point)
+* *Put potentially breaking changes here (in a brief bullet point)*
 
 ### New features:
 
-* Put new features here (in a brief bullet point)
+* *Put new features here (in a brief bullet point)*
 
 ### Fixes:
 
-* Put fixes here (in a brief bullet point)
+* *Put fixes here (in a brief bullet point)*
+
+## 2.0.0
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.3.0...v2.0.0
+
+This release changes our approach on excluding certain file paths and directories from being inspected by the linter. Instead of fully overriding RuboCop's default `AllCops:Exclude` list (which used to be necessary up until `rubocop` v0.57.0), `rubocop-bitcrowd` now only provides some extra patterns as an extension to the default list.
+
+We in addition to the default directories, e.g. want to exclude `log`, `tmp` and `storage` in Rails projects.
+
+In order to keep excluding both, the bitcrowd patterns and the RuboCop's default ones, add this to your `.rubocop.yml` file:
+
+```yml
+inherit_mode:
+  merge:
+    - Exclude
+```
+
+### Potentially breaking changes:
+
+* require a rubocop version >= 0.57.0
+* remove directories rubocop already excludes by default from the `AllCops:Exclude` list
+  * keeping the existing list now requires to add an `inherit_mode` section into their `.rubocop.yml`:
+
+    ```yml
+    # This will merge the default exclude list with the one from rubocop-bitcrowd
+    inherit_mode:
+      merge:
+        - Exclude
+    ```
+
+### Fixes:
+
+* Also exclude the `tmp`, `log` and `storage` directories from being inspected.
+  Working on a Rails application, especially the `tmp` directory fills up over time and slows down linting the project enormously. Same goes for the `storage` directory: here rubocop also has to dig through deeply nested folder structures.  
+  Note: rubocop's "default" configuration also ignores the `tmp` directory.
 
 ## `1.3.0` (2018-10-22)
 

data/README.md

@@ -22,6 +22,12 @@ To use the configuration in your project create a .rubocop.yml with:
 ```yml
 inherit_gem:
   rubocop-bitcrowd: .rubocop.yml
+
+# Note: skip this if you want to override the default AllCops:Include and AllCops:Exclude list
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
 ```
 
 # Using rubocop-rspec
@@ -36,6 +42,12 @@ inherit_gem:
   rubocop-bitcrowd:
     - .rubocop.yml
     - .rubocop-rspec.yml
+
+# Note: skip this if you want to override the default AllCops:Include and AllCops:Exclude list
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
 ```
 
 ## Autofixing issues
@@ -62,11 +74,8 @@ To release a new version, follow these steps:
 
 1. update the [CHANGELOG](./CHANGELOG.md) to reflect the new release and prepare a new [`master` section](./CHANGELOG.md#master)
 2. update the version in `rubocop-bitcrowd.gemspec` according to [semver](https://semver.org/)
-3. commit that change and tag it `git tag -as v1.2.3` (if releasing version 1.2.3). The tag-body should contain the corresponding CHANGELOG part of the current release.
-4. push the commit and tag to github: `git push --tags`
-5. build the gem and release it to rubygems:
-  * `gem build rubocop-bitcrowd.gemspec`
-  * `gem push rubocop-bitcrowd-1.2.3.gem`
+3. commit that change
+4. run `rake release`
 
 ## License
 

data/rubocop-bitcrowd.gemspec

@@ -1,14 +1,31 @@
 Gem::Specification.new do |spec|
-  spec.name          = 'rubocop-bitcrowd'
-  spec.version       = '1.3.0'
-  spec.authors       = ['bitcrowd']
-  spec.email         = ['info@bitcrowd.net']
+  spec.name                 = 'rubocop-bitcrowd'
+  spec.version              = '2.0.0'
+  spec.authors              = ['bitcrowd']
+  spec.email                = ['info@bitcrowd.net']
 
-  spec.summary       = 'The bitcrowd rubocop.yml as a gem.'
-  spec.description   = 'Use this as a quick start to get rubocop with the '\
-                       'settings we use at bitcrowd into your project'
-  spec.homepage      = 'https://github.com/bitcrowd/rubocop-bitcrowd'
-  spec.license       = 'MIT'
+  spec.summary              = 'The bitcrowd rubocop.yml as a gem.'
+  spec.description          = 'Use this as a quick start to get rubocop with the '\
+                              'settings we use at bitcrowd into your project'
+  spec.homepage             = 'https://github.com/bitcrowd/rubocop-bitcrowd'
+  spec.license              = 'MIT'
+  spec.post_install_message = <<~HEREDOC
+
+    This version of rubocop-bitcrowd no longer overrides RuboCop's AllCops:Exclude list.
+    It only adds extra patterns not included in the defaults.
+
+    Therefore if you want to keep excluding both, the bitcrowd patterns as well as the RuboCop default ones,
+    add this to your .rubocop.yml
+    inherit_mode:
+      merge:
+        - Exclude
+
+    For more details: https://rubocop.readthedocs.io/en/latest/configuration/#merging-arrays-using-inherit_mode
+
+    Cheers!
+    Your friends at bitcrowd
+
+  HEREDOC
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -16,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = 'rubocop-autofix'
 
-  spec.add_runtime_dependency 'rubocop', '~> 0.56'
+  spec.add_runtime_dependency 'rubocop', '~> 0.57.0'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-bitcrowd
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - bitcrowd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: 0.57.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: 0.57.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +61,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop-rspec.yml"
 - ".rubocop.yml"
@@ -75,7 +76,22 @@ homepage: https://github.com/bitcrowd/rubocop-bitcrowd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2+
+
+  This version of rubocop-bitcrowd no longer overrides RuboCop's AllCops:Exclude list.
+  It only adds extra patterns not included in the defaults.
+
+  Therefore if you want to keep excluding both, the bitcrowd patterns as well as the RuboCop default ones,
+  add this to your .rubocop.yml
+  inherit_mode:
+    merge:
+      - Exclude
+
+  For more details: https://rubocop.readthedocs.io/en/latest/configuration/#merging-arrays-using-inherit_mode
+
+  Cheers!
+  Your friends at bitcrowd
+
 rdoc_options: []
 require_paths:
 - lib