rentacop 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7603c018f4213b0937dd8e9d9f46fbc9f9a73d3909767117d49789f1b2053353
-  data.tar.gz: '028bca585e46bc7ff579a4bed08316f83b39dc3cd4fd220fbba1778de483b46d'
+  metadata.gz: fa8b8e38bc7ed952b8d9a77e6fc4b4f21fd84fd9024ea32a8f54d19b2af6fffb
+  data.tar.gz: 2b95fb2d85548358947a15d7f40513b489f763e7a77b963daa9215f6bd90bdbe
 SHA512:
-  metadata.gz: cb82fe2b71a4cfb346e098435c499fbab6c5f878e1015297975e9c5c4a313565e07f186611840451d70716515389101e29abc4e1132504a6f98c3652ed1dfb70
-  data.tar.gz: a36c5bff6a6bdc9045f5cd2178fa3b29e36c6372fa07a0064f3cd7115499ae0bba389860c62256921cc2e560a4b488bbf09a3c929830a85d24fa1d51f1e37cb2
+  metadata.gz: 0b9e62c0f52c79f3190f4ff63a13cce6fc55e855912433d302ce8126f20c1cf43a0fa81163a7439ffff64d194cad5cecec48e186e78d0e2739ce22481f01b53f
+  data.tar.gz: b6c1e1e3d95f118f03cd4d4007ea335662d2d7bd2473f008c6f0db4caac112bab6de22285cc1fbdeec3d9d772610bc7d8e678810e06f1c0f6cc1d044653b3e17

data/README.md

@@ -7,7 +7,7 @@ A more relaxed default set of RuboCop rules.
 Run:
 
 ```bash
-$ bundle add rentacop --group development,test
+$ gem install rentacop
 ```
 
 Or, add this line to your Gemfile:
@@ -34,17 +34,70 @@ $ bundle add rubocop --group development,test
 
 ## Usage
 
-Add the following to the top of your `.rubocop.yml`:
+This gem contains two rule sets:
+
+1. Global rubocop rules in [rentacop.yml](rentacop.yml)
+2. RSpec rubocop rules in [rspec.yml](rspec.yml)
+
+### Configuring `.rubocop.yml`
+
+If you are not using RSpec, add the following to the top of your `.rubocop.yml`:
+
 
 ```yaml
 inherit_gem:
   rentacop: rentacop.yml
 ```
 
-And run:
+If you are using [rubocop-rspec](https://github.com/rubocop/rubocop-rspec), and wish to include the RSpec rules from this repository, add this instead:
+
+```yaml
+require: rubocop-rspec
+
+inherit_gem:
+  rentatop:
+    - rentacop.yml
+    - rspec.yml
+```
+
+### Recommended Template
+
+This `.rubocop.yml` contains our full recommended configuration:
+
+
+```yaml
+# .rubocop.yml
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_gem:
+  rentacop:
+    - rentacop.yml
+    - rspec.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+
+AllCops:
+  TargetRubyVersion: 2.7
+```
+
+### Running `rubocop`
+
+After creating your `.rubocop.yml` file, run:
 
 ```bash
 $ rubocop
-# or, if your rubocop is not installed globally
+# or, if you do not have rubocop installed globally
 $ bundle exec rubocop
 ```
+
+To create a todo list, run:
+
+```bash
+$ rubocop --regenerate-todo
+```
+

data/lib/rentacop/version.rb

@@ -1,3 +1,3 @@
 module Rentacop
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/rentacop.yml

@@ -41,6 +41,10 @@ Layout/MultilineMethodCallIndentation:
 Lint/MissingSuper: 
   Enabled: false
 
+# `FileUtils` methods do not behave properly on Vagrant
+Lint/NonAtomicFileOperation:
+  Enabled: false
+
 
 # === Metrics ===
 
@@ -104,6 +108,10 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
+# Do not require comments for `eval`
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
 # Allow the use of `ENV['name']`
 Style/FetchEnvVar:
   Enabled: false

data/rspec.yml

@@ -0,0 +1,44 @@
+# Allow `before :all` and `after :all`
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+# Allow the first `describe` to be arbitrary
+RSpec/DescribeClass:
+  Enabled: false
+
+# Allow longer tests
+RSpec/ExampleLength:
+  Max: 8
+
+# Allow `expect` in `before` hook, it is used as a utility to trap output and
+# ensure state
+RSpec/ExpectInHook:
+  Enabled: false
+
+# Prefer `receive` over `have_received` spies
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Allow multiple expectations
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Allow more `let` statements per test
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
+# Allow unnamed subjects
+RSpec/NamedSubject:
+  Enabled: false
+
+# Allow deeper nested groups
+RSpec/NestedGroups:
+  Max: 5
+
+# Allow stubbing inner methods of `subject`
+RSpec/SubjectStub:
+  Enabled: false
+
+# Allow nameless `double`
+RSpec/VerifiedDoubles:
+  Enabled: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rentacop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies: []
 description: Collection of more relaxed rubocop rules
 email: db@dannyben.com
@@ -20,6 +20,7 @@ files:
 - README.md
 - lib/rentacop/version.rb
 - rentacop.yml
+- rspec.yml
 homepage: https://github.com/dannyben/rentacop
 licenses:
 - MIT