rubocop-obsession 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a398487386fc743232d90d035d69d17ef394bd87f5c6b31062333c2f6f16dce7
+  data.tar.gz: cff18d09624eee51d93b07f88c1cfa5c056a538d2b56c3871be11d0f581646c3
+SHA512:
+  metadata.gz: 6ffb7392aeb75c93dc6e74cbbe7071b6cc8b5b2144b51260f5438a2a9a3661b6f5f841c01ef219782993b935c05fe61c7bac9c824b7c81bd9969806a4a044b22
+  data.tar.gz: 4e6546861db7b072a29db94ab7f9dc6fb8fc731015e439ed4402ae56d1b36fd87bf144c464c77d5897268edc0025c3ff04ce78406bebf308c9cc8c81c9ea7927

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jerome Dalbert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# Rubocop Obsession
+
+A [RuboCop](https://github.com/rubocop/rubocop) extension that enforces a bunch
+of best practices I have been obsessed with, such as making code read from
+[top to bottom](lib/rubocop/cop/obsession/method_order.rb), or only unit
+testing [public methods](lib/rubocop/cop/obsession/rspec/describe_public_method.rb).
+
+## Installation
+
+Install the gem:
+
+```
+gem install rubocop-obsession
+```
+
+Or add this line to your Gemfile:
+
+```ruby
+gem 'rubocop-obsession'
+```
+
+and run `bundle install`.
+
+## Usage
+
+You need to tell Rubocop to load the Obsession extension. There are three ways
+to do this:
+
+### Rubocop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-obsession
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-obsession
+```
+
+Now you can run `rubocop` and it will automatically load the Rubocop Obsession
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-obsession
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-obsession'
+end
+```
+
+## The cops
+
+All cops are located under
+[`lib/rubocop/cop/obsession`](lib/rubocop/cop/obsession), and contain examples
+and documentation.
+
+These cops are opinionated and can often feel like too much, that is why some
+of them are disabled by default. They should not be treated as gospel, so do
+not hesitate to enable or disable them!
+
+I wrote them to scratch an itch I had at one point or another. Tastes change
+with time, and I personally do not use some of them.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jeromedalbert/rubocop-obsession. 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/jeromedalbert/rubocop-obsession/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::Obsession project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jeromedalbert/rubocop-obsession/blob/main/CODE_OF_CONDUCT.md).

data/config/default.yml

@@ -0,0 +1,163 @@
+Obsession/MethodOrder:
+  Enabled: true
+Obsession/NoBreakOrNext:
+  Enabled: false
+  Exclude:
+    - 'script/db/**/*'
+Obsession/NoParagraphs:
+  Enabled: false
+  Exclude:
+    - 'db/migrate/*'
+    - 'spec/**/*'
+Obsession/NoTodos:
+  Enabled: false
+Obsession/TooManyParagraphs:
+  Enabled: false
+  Exclude:
+    - 'db/migrate/*'
+    - 'script/db/**/*'
+    - 'spec/**/*'
+
+Obsession/Graphql/MutationName:
+  Enabled: true
+  Include:
+    - 'app/graphql/mutations/**/*'
+
+Obsession/Rspec/DescribePublicMethod:
+  Enabled: true
+  Include:
+    - 'spec/**/*_spec.rb'
+# Uncommenting this would mean adding rubocop-rspec as a gem dependency. Feels like too much for now.
+# Obsession/Rspec/EmptyLineAfterFinalLet:
+#   Enabled: true
+#   Include:
+#     - 'spec/**/*'
+
+Obsession/Rails/CallbackOneMethod:
+  Enabled: true
+  Include:
+    - 'app/models/**/*'
+    - 'app/controllers/**/*'
+Obsession/Rails/FullyDefinedJsonField:
+  Enabled: true
+  Include:
+    - 'db/migrate/*'
+Obsession/Rails/MigrationBelongsTo:
+  Enabled: true
+  Include:
+    - 'db/migrate/*'
+Obsession/Rails/NoCallbackConditions:
+  Enabled: true
+  Include:
+    - 'app/models/**/*'
+Obsession/Rails/PrivateCallback:
+  Enabled: true
+  Include:
+    - 'app/models/**/*'
+    - 'app/controllers/**/*'
+Obsession/Rails/SafetyAssuredComment:
+  Enabled: false
+  Include:
+    - 'db/migrate/*'
+Obsession/Rails/ServiceName:
+  Enabled: true
+  Include:
+    - 'app/services/**/*'
+    - 'app/jobs/**/*'
+  Exclude:
+    - 'app/jobs/application_job.rb'
+    - 'app/jobs/scheduled/scheduled_job.rb'
+    - '**/*events/**'
+Obsession/Rails/ServicePerformMethod:
+  Enabled: true
+  Include:
+    - 'app/services/**/*'
+Obsession/Rails/ShortAfterCommit:
+  Enabled: true
+  Include:
+    - 'app/models/**/*'
+Obsession/Rails/ShortValidate:
+  Enabled: true
+  Include:
+    - 'app/models/**/*'
+Obsession/Rails/ValidateOneField:
+  Enabled: true
+  Include:
+    - 'app/models/**/*'
+Obsession/Rails/ValidationMethodName:
+  Enabled: true
+  Include:
+    - 'app/models/**/*'
+
+Layout/ClassStructure:
+  Enabled: true
+  AutoCorrect: false
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+    attributes:
+      - attribute
+      - attr_reader
+      - attr_writer
+      - attr_accessor
+      - alias_attribute
+      - delegate
+      - enum
+    associations:
+      - belongs_to
+      - has_one
+      - has_many
+      - has_and_belongs_to_many
+    validations:
+      - validates
+      - validate
+      - validates_with
+    callbacks:
+      - before_validation
+      - before_save
+      - before_create
+      - before_destroy
+      - after_initialize
+      - after_create
+      - after_save
+      - after_destroy
+      - after_commit
+      - after_create_commit
+      - after_update_commit
+      - after_destroy_commit
+      - around_create
+    other_macros:
+      - devise
+      - acts_as_paranoid
+      - serialize
+      - has_paper_trail
+      - audited
+    scopes:
+      - default_scope
+      - scope
+    controller_actions:
+      - before_action
+      - skip_before_action
+    controller_rescue:
+      - rescue_from
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - attributes
+    - enums
+    - associations
+    - validations
+    - callbacks
+    - other_macros
+    - scopes
+    - controller_macros
+    - controller_actions
+    - controller_action_caching
+    - controller_rescue
+    - class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods