rubocop-bitcrowd 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ba9bc571dfc7758ceeac79e7b86091ab0be392e7f5087dd5b8d097a7bd7d7f
-  data.tar.gz: b2f3cfec1150e8bdc0067aa773832023ca5def41efd9df03365540261b3244b9
+  metadata.gz: 38d9c285df0e1e065f4db4463a8045de98358363884cdfb1184c1dda44ce1660
+  data.tar.gz: bffd1004e0807c144e348e3ae4f4b113b0b6e9e09002f849a95eaed15b2f4dfd
 SHA512:
-  metadata.gz: 8dda45b3dd3f4e2887a44cddd1519c096a08ab1b7a805fe07637fff882675114c8a0d9b2f0558e388fb60e0d4fac6dd7d12feddbab7a21fa66273e9a94d70b4d
-  data.tar.gz: c9dddf174a73072b00620b3871d6972b8f46e889702dc8c85fc57e2e35cdfa6d3a65ef8e13497dd9df47f8d5893334a571e9a17c62de7a278c8430a5bb23f625
+  metadata.gz: 68f77bcba7d8215c5b60e71145b44e66c1303a934136863569d3a05c79a85668deb3e1a7adb5232da4fcaeba8f8c87eb2ad6226e84ba4f4eaf757d2bfb6e16ed
+  data.tar.gz: 5134a06cf1c671bcbd4f4d39be666ece2f062508ffd4ab4d3cf651329dfefddfca15a1bd78facf7613f2d6a392b6cc670ba45cada610eb1d4f2b0d3e68993448

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem

data/.rubocop.yml

@@ -1,9 +1,4 @@
 AllCops:
-  Include:
-    - '**/Gemfile'
-    - '**/Rakefile'
-    - '**/config.ru'
-    - '**/Capfile'
   Exclude:
     - 'node_modules/**/*'
     - 'vendor/bundle/**/*'
@@ -64,6 +59,13 @@ Rails/SkipsModelValidations:
 Rails/TimeZone:
   Enabled: true
 
+Rails/UnknownEnv:
+  Environments:
+    - development
+    - test
+    - staging
+    - production
+
 Rails/Validation:
   Enabled: true
 
@@ -83,7 +85,7 @@ Style/MethodCalledOnDoEndBlock:
   Enabled: true
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  EnforcedStyle: always
 
 Style/MutableConstant:
   Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,89 @@
+# Rubocop-Bitcrowd Changelog
+
+Presented in reverse chronological order.
+
+## master
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.3.0...HEAD
+
+*Put high-level summary here before releasing a new version*
+
+### Deprecations:
+
+* Put deprecations here (in a brief bullet point)
+
+### Potentially breaking changes:
+
+* Put potentially breaking changes here (in a brief bullet point)
+
+### New features:
+
+* Put new features here (in a brief bullet point)
+
+### Fixes:
+
+* Put fixes here (in a brief bullet point)
+
+## `1.3.0` (2018-10-22)
+
+This release is a maintenance release. Most notably it let's us be compatile with rubocop versions >= 0.56 again. For a full list of changes, see the link or summary below.
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.2.1...v1.3.0
+
+### New features:
+
+* added `staging` to the list of known environments
+* enforce frozen_string_literal comment
+
+### Fixes:
+
+* between rubocop version 0.55 and 0.56 we stopped processing most files because we overwrote `AllCops/Include`.
+  This is fixed, but requires a rubocop version of 0.56 or higher.
+* we have a more detailed changelog which is conform with our changelog-style of other projects
+
+## `1.2.1` (2018-03-22)
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.2.0...v1.2.1
+
+### Potentially breaking changes:
+
+* exclude spec/features from the `RSpec/ExampleLength` cop
+
+### Fixes
+
+* ignore `node_modules` and `vendor/bundle` from being inspected
+
+## `1.2.0` (2018-02-07)
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.1.2...v1.2.0
+
+### Fixes:
+
+* The cop `Layout/SpaceInsideBrackets` was deprecated and split into two sub-cops:
+  * `Layout/SpaceInsideArrayLiteralBrackets`
+  * and `Layout/SpaceInsideReferenceBrackets`
+
+## `1.1.2` (2017-10-23)
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.1.1...v1.1.2
+
+### Potentially breaking changes:
+
+* Changed to nested module style see: https://github.com/bitcrowd/rubocop-bitcrowd/pull/4
+
+
+## `1.1.1` (2017-09-21)
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/v1.1.0...v1.1.1
+
+### Fixes:
+
+* exclude db/schema.rb from being evaluated
+* the cop `Style/SpaceInsideBrackets` was renamed to `Layout/SpaceInsideBrackets`
+
+## `1.1.0` (2017-09-21)
+
+https://github.com/bitcrowd/rubocop-bitcrowd/compare/695fb551bcd1e17a12f80e34c9bbcb842cee35ea...v1.1.1
+
+* First official release
+

data/README.md

@@ -39,8 +39,8 @@ inherit_gem:
 ```
 
 ## Autofixing issues
-At bitcrowd we discovered it to be a very good practice to put each automatically
-fixable Cop into a single commit when initially adding rubocop into a bigger project.
+
+At bitcrowd we discovered it to be a very good practice to put each automatically fixable Cop into a single commit when initially adding rubocop into a bigger project.
 
 This gem provides a simple script, that can help you with this task:
 
@@ -50,6 +50,23 @@ This gem provides a simple script, that can help you with this task:
 4. Run the script (may take a while, when you want to continue working on your project meanwhile run this in a separate checkout): `rubocop-autofix`
 5. Review all commits made by the script and run your tests. You can now drop certain commits of cops you don't want. Often it may make some sense to run the script again with changed settings, since rebasing 100+ commits is no fun.
 
+# Development
+
+Any contributions are welcome. If you attempt to change the behavior of this gem it might be wise to open an issue first to discuss the change. Otherwise feel free to open a PR.
+
+Every PR should have a change in the [CHANGELOG](./CHANGELOG.md) file (within the [`master` section](./CHANGELOG.md#master)) briefly outlining the attempted changes.
+
+## Release a new version
+
+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`
 
 ## License
 

data/rubocop-bitcrowd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'rubocop-bitcrowd'
-  spec.version       = '1.2.1'
+  spec.version       = '1.3.0'
   spec.authors       = ['bitcrowd']
   spec.email         = ['info@bitcrowd.net']
 
@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = 'rubocop-autofix'
 
+  spec.add_runtime_dependency 'rubocop', '~> 0.56'
+
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-bitcrowd
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - bitcrowd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
+        version: '0.56'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0.56'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 description: Use this as a quick start to get rubocop with the settings we use at
   bitcrowd into your project
 email:
@@ -64,7 +64,7 @@ files:
 - ".gitignore"
 - ".rubocop-rspec.yml"
 - ".rubocop.yml"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The bitcrowd rubocop.yml as a gem.

data/CHANGELOG

@@ -1,2 +0,0 @@
-1.1.2
-- Changed to nested module style see: https://github.com/bitcrowd/rubocop-bitcrowd/pull/4