boxt_ruby_style_guide 4.4.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c671ecd597787c1ea952283575ed3a9ce2705a7b800e7ffc4b4a946456356f35
-  data.tar.gz: 49f6e15e7fa07e3859d7807b51f90c53c699e8f289d9a5a64d2978e0b4e1d6fe
+  metadata.gz: 8797108104ef257761910ad3146849508abc290b978efc25b26fa24033a5546f
+  data.tar.gz: f247c42dd4fb4d515c8f91848509977abedb467bf10d3017f29903b3f462c485
 SHA512:
-  metadata.gz: 0b84fac5f7e196274fa5d00c7963456cc2a43b0cedbb4781f3dfcb66c89e57331205ae42a472be8c2727d298a715499c179767e49ea4615c24383d94c9d537b4
-  data.tar.gz: 34d7cccc2995b0f89cec34d17da5f180bd80072c73d2b7acc9a4c3f2856136ee885e469ba891915a556c71830911e3f87ec43d35ac5d3fe63375eba9af72b955
+  metadata.gz: b3d25beabdc2dde7e40ecf50f356bb20214ebfe182eb1eebc838df67a9d683943523eb39c3b1610362e93e68539654ba9860e6bc0a44c4da813e50f18c570f7b
+  data.tar.gz: 5294d6ba55484a24faa576b8341635f146da2d86eb3511511394154b139870d69033259b0b6260226b10eea4d078a2dc6f7b1bc3dd7852bd9d0463dc68c0ea89

data/README.md

@@ -35,17 +35,36 @@ Rails apps should have access to the lint tasks by default.
 
 ## Usage
 
-### Rubocop Config
-
 Add a `.rubocop.yml` file to the root of your project with the following settings:
 
 ```yml
 inherit_gem:
-  boxt-ruby-style-guide:
-    - default.yml
+  boxt_ruby_style_guide:
+    - default.yml # use default cops
+    - pending.yml # use pending cops 
+    - rails.yml # use Rails cops - see Additional Extensions/Cops
+```
+
+### Additional Extensions/Cops
+
+The following Rubocop gems are also installed with this gem:
+
+* [rubocop-faker](https://github.com/koic/rubocop-faker)
+* [rubocop-rails](https://github.com/rubocop-hq/rubocop-rails)
+
+To enable add the following to your `.rubocop.yml` file.
+
+```yml
+inherit_gem:
+  boxt_ruby_style_guide:
+  # .... add cops 
+
+require:
+  - rubocop-faker # if your project is using the Faker gem then add this
+  - rubocop-rails # if your project is a Rails app/engine then add this, plus the - rails.yml setting above
 ```
 
-### Lint Tasks
+## Lint Tasks
 
 Lint tasks to run against files listed as changed by Git.
 
@@ -57,20 +76,20 @@ rake lint:rubocop
 
 If there are no changed files the commands will run against all files.
 
-### Editor Plugins
+## Editor Plugins
 
 There are also some useful Rubocop editor plugins to help with in-editor linting.
 
-#### Atom
+### Atom
 
 - [linter-rubocop](https://atom.io/packages/linter-rubocop)
 - [rubocop-auto-correct](https://atom.io/packages/rubocop-auto-correct)
 
-#### RubyMine
+### RubyMine
 
 - [rubocop](https://www.jetbrains.com/help/ruby/rubocop.html)
 
-#### VSCode
+### VSCode
 
 - [ruby-rubocop](https://marketplace.visualstudio.com/items?itemName=misogi.ruby-rubocop)
 

data/VERSION

@@ -1 +1 @@
-4.4.2
+6.1.0

data/default.yml

@@ -1,5 +1,11 @@
 AllCops:
-  TargetRubyVersion: 2.7.0
+  TargetRubyVersion: 2.7.1
+  Exclude:
+    - "**/*/schema.rb"
+    - "Gemfile.lock"
+    - "node_modules/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
 Layout/LineLength:
   Max: 120 # Increase line length to 120
   Exclude:
@@ -22,25 +28,3 @@ Style/Documentation:
   Enabled: false # Disable Style/Documentation because...
 Style/StringLiterals:
   EnforcedStyle: double_quotes # Use double quotes ALL THE TIME!!!
-# These cops are currently pending and will be enabled by default at some point, but adding for now to stop Rubocop
-# complaining...
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true

data/pending.yml

@@ -0,0 +1,30 @@
+# These cops are currently pending and will be enabled by default at some point, but adding for now to stop Rubocop
+# complaining...
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/rails.yml

@@ -0,0 +1,9 @@
+# Rails specific cops
+Rails/ApplicationController:
+  Exclude:
+    - "test/**/*"
+Rails/SkipsModelValidations:
+  Exclude:
+    - "db/migrate/**/*"
+    - "lib/tasks/**/*"
+    - "test/**/*"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: boxt_ruby_style_guide
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 6.1.0
 platform: ruby
 authors:
 - Boxt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: 0.86.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: 0.86.0
 - !ruby/object:Gem::Dependency
   name: rubocop-faker
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -152,11 +166,13 @@ files:
 - lib/boxt_ruby_style_guide.rb
 - lib/boxt_ruby_style_guide/railtie.rb
 - lib/boxt_ruby_style_guide/version.rb
+- pending.yml
+- rails.yml
 homepage: https://github.com/boxt/ruby-style-guide
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,8 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby styleguide info for the BOXT Ruby projects
 test_files: []