rubocop-solidus 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33aae99e206ba5b410d4c12c6befd22441508a9140a53ea5d5c4752edc35769a
-  data.tar.gz: b73a52d9815ebaf8dcf05fc272b8916dc36af31c03069c6607bea6d807346a83
+  metadata.gz: df0c66e0a5dddaec3401e5cfd7d4f2704d0d920d9883172e7d8551aee6663641
+  data.tar.gz: 929b18aba23c67ae33c3582d94e3758a6682668cfe8595e49107e72387672050
 SHA512:
-  metadata.gz: 4e80063bb7c4ff0bdfddfac2fa558808b253966c6863557cc1ec09a1b53ce38ca829d8391e8dd5e2572d4e8d9523a456e5f773c418caf6f9d837f69eb96df3a6
-  data.tar.gz: e182664bc616504eeeb646fc5f0c0a150240cd57823fb672b9c8a9d3f25e69c58b4a5e9584bf438c40d4c9399d27e1f7e52dac24df0865071dc848007e027da7
+  metadata.gz: de6813fbc0de1c6e24bc686622112ba91d71580a5d116f4eb33747ffeceef4c74fc437dc31c5b98a209f592b4bd5fb970be8495b7a04e98515fc262fd7497edf
+  data.tar.gz: 619bf635aa925403cdce3fcf65f9be39b45d5d301348eb2c6666f5b48e9f45b16cc9d22c7b641f5906f19991ca4ffe2a721b6643677cac458288af02c440fd18

data/.rubocop.yml

@@ -1,6 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.4
+  SuggestExtensions: false
 
 Naming/FileName:
  Exclude:
@@ -13,11 +15,13 @@ Metrics/BlockLength:
     - 'spec/**/*.rb'
     - '*.gemspec'
 
+Metrics/MethodLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+
 Metrics/ClassLength:
   Exclude:
     - 'tasks/**/*.rb'
-
-# Prevents Ruby 3.1 incompatibility error. You can enable this cop when Ruby 2.4 support is dropped.
-# See https://github.com/rubocop/rubocop/issues/10258
-Layout/BlockAlignment:
-  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-07-21 15:08:23 UTC using RuboCop version 1.54.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'rubocop-solidus.gemspec'

data/CHANGELOG.md

@@ -1,10 +1,26 @@
 ## master (unreleased)
 
+## 0.1.4 (2023-08-04)
+
+### New features
+
+* [#51](https://github.com/solidusio/rubocop-solidus/pull/51): Create automatic documentation based on the cop's descriptions. ([@MassimilianoLattanzio][])
+
+## 0.1.3 (2023-07-28)
+
+### New features
+
+* [#47](https://github.com/solidusio/rubocop-solidus/pull/47): Remove support for old versions of ruby. ([@MassimilianoLattanzio][])
+
+### Bug fixes
+
+* [#48](https://github.com/solidusio/rubocop-solidus/pull/48): Fix typos in README and add instructions on how to use the changelog rake task. ([@MassimilianoLattanzio][])
+
 ## 0.1.2 (2023-07-14)
 
 ### New features
 
-* [#45](https://github.com/nebulab/rubocop-solidus/pull/45): Fix gem version comparison. ([@MassimilianoLattanzio][])
+* [#45](https://github.com/solidusio/rubocop-solidus/pull/45): Fix gem version comparison. ([@MassimilianoLattanzio][])
 
 ## 0.1.0 (2023-07-10)
 

data/Gemfile

@@ -10,3 +10,4 @@ gem 'pry'
 gem 'rake'
 gem 'rspec'
 gem 'rubocop'
+gem 'yard'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-solidus (0.1.2)
+    rubocop-solidus (0.1.4)
       rubocop
 
 GEM
@@ -11,15 +11,17 @@ GEM
     bump (0.10.0)
     coderay (1.1.3)
     diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    parallel (1.20.1)
+    parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.5.2)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
@@ -37,19 +39,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.12.1)
+    rubocop (1.54.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
   -darwin-22
@@ -65,6 +70,7 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-solidus!
+  yard
 
 BUNDLED WITH
    2.3.26

data/README.md

@@ -3,12 +3,14 @@
 Automatic Solidus code style checking tool.
 A RuboCop extension focused on enforcing Solidus best practices and coding conventions.
 
-## Installation
+## Getting started
+
+### Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rubocop-solidus', github: 'nebulab/rubocop-solidus', require: false
+gem 'rubocop-solidus', require: false
 ```
 
 And then execute:
@@ -19,7 +21,7 @@ Or install it yourself as:
 
     $ gem install rubocop-solidus
 
-## Usage
+### Usage
 
 To Start using this extension in your application add the following lines to your `.rubocop.yml` file
 
@@ -30,22 +32,60 @@ require:
 
 After this simply use the `rubocop` command to start linting.
 
-## Creating new cops
+## Documentation
+
+You can read about each cop supplied by RuboCop Solidus in [the docs](docs/cops.md).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio/rubocop-solidus.
+
+To contribute a new cop, please see the sections below.
+
+### Creating new cops
 
 To create a new cop, run the following command:
 
 ```bash
-$ bundle exec rake new_cop[Solidus/NameOfTheCop]
+$ bundle exec rake 'new_cop[Solidus/NameOfTheCop]'
 ```
 
 and then follow the instructions on the screen.
 
-## Release a new version
+### Creating changelog entries
+
+Changelog entries are just files under the `changelog/` folder that will be merged
+into `CHANGELOG.md` at release time. You can create new changelog entries like this:
+
+```console
+$ bundle exec rake changelog:new|fix|change
+```
+
+The type of the changelog correspond to "new feature", "bug-fix" and "changed" entries in the changelog.
+
+#### Changelog entry format
+
+Here are a few examples:
+
+```markdown
+* [#46](https://github.com/solidusio/rubocop-solidus/issues/46): **(Breaking)** Remove support for old Ruby versions. ([@MassimilianoLattanzio][])
+* [#4](https://github.com/solidusio/rubocop-solidus/pull/4): Update CHANGELOG. ([@piyushswain][])
+```
+
+* Create one file `changelog/{type}_{some_description}.md`, where `type` is `new` (New feature), `fix` or `change`, and `some_description` is unique to avoid conflicts. Task `changelog:fix` (or `:new` or `:change`) can help you.
+* Mark it up in [Markdown syntax][1].
+* The entry should be a single line, starting with `* ` (an asterisk and a space).
+* If the change has a related GitHub issue (e.g. a bug fix for a reported issue), put a link to the issue as `[#123](https://github.com/solidusio/rubocop-solidus/issues/123): `.
+* Describe the brief of the change. The sentence should end with a punctuation.
+* If this is a breaking change, mark it with `**(Breaking)**`.
+* At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
+
+### Release a new version
 
 To release a new version, run the following command:
 
 ```bash
-$ bundle exec rake cut_release:[major|minor|patch]
+$ bundle exec rake cut_release:major|minor|patch
 ```
 
 and then follow the instructions on the screen.
@@ -61,10 +101,8 @@ To deploy the new version to RubyGems, run the following command:
 $ bundle exec rake release
 ```
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/nebulab/rubocop-solidus.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[1]: https://www.markdownguide.org/basic-syntax/

data/Rakefile

@@ -6,7 +6,12 @@ require 'rspec/core/rake_task'
 
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-task default: %i[spec rubocop]
+task default: %i[
+  spec
+  rubocop
+  generate_cops_documentation
+  documentation_syntax_check
+]
 
 RuboCop::RakeTask.new
 

data/config/default.yml

@@ -12,58 +12,58 @@ Solidus/ClassEvalDecorator:
   Description: 'Checks if Class.class_eval is being used in the code'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/21'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/21'
 
 Solidus/ReimbursementHookDeprecated:
   Description: 'Checks if reimbursement_success_hooks and reimbursement_failed_hooks is being used'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/27'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/27'
 
 Solidus/SpreeCalculatorFreeShippingDeprecated:
   Description: 'Checks if Spree::Calculator::FreeShipping is being used and add deprecation message'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/29'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/29'
 
 Solidus/SpreeCalculatorPercentPerItemDeprecated:
   Description: 'Checks if Spree::Calculator::PercentPerItem is being used and add deprecation message'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/29'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/29'
 
 Solidus/SpreeCalculatorPriceSackDeprecated:
   Description: 'Checks if Spree::Calculator::PriceSack is being used and add deprecation message'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/29'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/29'
 
 Solidus/SpreeDefaultCreditCardDeprecated:
   Description: 'Checks if user.default_credit_card is used and suggest using user.wallet.default_wallet_payment_source'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/33'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/33'
 
 Solidus/SpreeGatewayBogusDeprecated:
   Description: 'Checks if SpreeGatewayBogus is being used and replaces it with Spree::PaymentMethod::BogusCreditCard'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/26'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/26'
 
 Solidus/SpreeIconDeprecated:
   Description: 'Checks if icon helper is being used and suggest `solidus_icon`'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/32'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/32'
 
 Solidus/SpreeRefundCallPerform:
   Description: 'Checks if Spree::Refund.create is being used and require calling .perform!'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/28'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/28'
 
 Solidus/SpreeTDeprecated:
   Description: 'Checks if Spree.t is being used and replaces it with I18n.t.'
   Enabled: true
   VersionAdded: '0.1.0'
-  Reference: 'https://github.com/nebulab/rubocop-solidus/issues/22'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/22'

data/docs/cops.md

@@ -0,0 +1,19 @@
+## Available cops
+
+In the following section you find all available cops:
+
+<!-- START_COP_LIST -->
+#### Department [Solidus](cops_solidus.md)
+
+* [Solidus/ClassEvalDecorator](cops_solidus.md#solidusclassevaldecorator)
+* [Solidus/ReimbursementHookDeprecated](cops_solidus.md#solidusreimbursementhookdeprecated)
+* [Solidus/SpreeCalculatorFreeShippingDeprecated](cops_solidus.md#solidusspreecalculatorfreeshippingdeprecated)
+* [Solidus/SpreeCalculatorPercentPerItemDeprecated](cops_solidus.md#solidusspreecalculatorpercentperitemdeprecated)
+* [Solidus/SpreeCalculatorPriceSackDeprecated](cops_solidus.md#solidusspreecalculatorpricesackdeprecated)
+* [Solidus/SpreeDefaultCreditCardDeprecated](cops_solidus.md#solidusspreedefaultcreditcarddeprecated)
+* [Solidus/SpreeGatewayBogusDeprecated](cops_solidus.md#solidusspreegatewaybogusdeprecated)
+* [Solidus/SpreeIconDeprecated](cops_solidus.md#solidusspreeicondeprecated)
+* [Solidus/SpreeRefundCallPerform](cops_solidus.md#solidusspreerefundcallperform)
+* [Solidus/SpreeTDeprecated](cops_solidus.md#solidusspreetdeprecated)
+
+<!-- END_COP_LIST -->

data/docs/cops_solidus.md

@@ -0,0 +1,276 @@
+# Solidus
+
+## Solidus/ClassEvalDecorator
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.1.0 | - | -
+
+Solidus suggests a decorator module instead of `class_eval` when overriding some features.
+This cop finds any `class_eval` and asks to use a decorator module instead.
+More info: https://guides.solidus.io/customization/customizing-the-core.
+
+### Examples
+
+```ruby
+# bad
+SpreeClass.class_eval do
+  # your code here
+end
+
+# good
+module Spree
+  module SpreeClassDecorator
+    # your code here
+  end
+
+  Spree::SpreeClass.prepend self
+end
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/21](https://github.com/solidusio/rubocop-solidus/issues/21)
+
+## Solidus/ReimbursementHookDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.1.0 | - | 2.11
+
+This cop finds reimbursement_success_hooks and reimbursement_failed_hooks calls and
+asks to remove them and subscribe to reimbursement_reimbursed event instead.
+
+### Examples
+
+```ruby
+# bad
+reimbursement_success_hooks.each { |h| h.call self }
+reimbursement_failed_hooks.each { |h| h.call self }
+
+# good
+```
+```ruby
+# bad
+reimbursement_success_hooks.any?
+reimbursement_failed_hooks.any?
+
+# good
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/27](https://github.com/solidusio/rubocop-solidus/issues/27)
+
+## Solidus/SpreeCalculatorFreeShippingDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.1.0 | - | -
+
+This cop finds Spree::Calculator::FreeShipping calls.
+This cop is needed as they have been deprecated in future version.
+
+### Examples
+
+```ruby
+# bad
+Spree::Calculator::FreeShipping
+
+# good
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/29](https://github.com/solidusio/rubocop-solidus/issues/29)
+
+## Solidus/SpreeCalculatorPercentPerItemDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.1.0 | - | -
+
+This cop finds Spree::Calculator::PercentPerItem calls.
+This cop is needed as they have been deprecated in future version.
+
+### Examples
+
+```ruby
+# bad
+Spree::Calculator::PercentPerItem
+
+# good
+Spree::Calculator::PercentOnLineItem
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/29](https://github.com/solidusio/rubocop-solidus/issues/29)
+
+## Solidus/SpreeCalculatorPriceSackDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.1.0 | - | -
+
+This cop finds Spree::Calculator::PriceSack calls.
+This cop is needed as they have been deprecated in future version.
+
+### Examples
+
+```ruby
+# bad
+Spree::Calculator::PriceSack
+
+# good
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/29](https://github.com/solidusio/rubocop-solidus/issues/29)
+
+## Solidus/SpreeDefaultCreditCardDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.1.0 | - | 2.2
+
+This cop finds user.default_credit_card suggest using user.wallet.default_wallet_payment_source.
+
+### Examples
+
+```ruby
+# bad
+user.default_credit_card
+
+# good
+user.wallet.default_wallet_payment_source
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/33](https://github.com/solidusio/rubocop-solidus/issues/33)
+
+## Solidus/SpreeGatewayBogusDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.1.0 | - | 2.1
+
+This cop finds Spree::Gateway::Bogus calls and replaces them with the Spree::PaymentMethod::BogusCreditCard.
+This cop is needed as the Spree::Gateway::Bogus has been deprecated in future version.
+
+### Examples
+
+```ruby
+# bad
+Spree::Gateway::Bogus.new
+Spree::Gateway::Bogus.create
+Spree::Gateway::Bogus.create!
+
+# good
+Spree::PaymentMethod::BogusCreditCard.new
+Spree::PaymentMethod::BogusCreditCard.create
+Spree::PaymentMethod::BogusCreditCard.create!
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/26](https://github.com/solidusio/rubocop-solidus/issues/26)
+
+## Solidus/SpreeIconDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.1.0 | - | 2.3
+
+This cop finds icon helper calls and suggest using solidus_icon.
+
+### Examples
+
+```ruby
+# bad
+helper.icon('example')
+
+# good
+helper.solidus_icon('example')
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/32](https://github.com/solidusio/rubocop-solidus/issues/32)
+
+## Solidus/SpreeRefundCallPerform
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.1.0 | - | 2.11
+
+This cop finds Spree::Refund.create(your: attributes) calls and
+replaces them with the Spree::Refund.create(your: attributes, perform_after_create: false).perform! call.
+
+### Examples
+
+```ruby
+# bad
+Spree::Refund.create(your: attributes)
+
+# good
+Spree::Refund.create(your: attributes, perform_after_create: false).perform!
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/28](https://github.com/solidusio/rubocop-solidus/issues/28)
+
+## Solidus/SpreeTDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.1.0 | - | -
+
+This cop finds Spree.t method calls and replaces them with the I18n,t method call.
+This cop is needed as the Spree.t version has been deprecated in future version.
+
+### Examples
+
+```ruby
+# Without any parameters
+
+# bad
+Spree.t(:bar)
+
+# good
+I18n.t(:bar, scope: :spree)
+```
+```ruby
+# With the scope parameter
+
+# bad
+Spree.t(:bar, scope: [:city])
+
+# good
+I18n.t(:bar, scope: [:spree, :city])
+```
+```ruby
+# With the scope and other parameters
+
+# bad
+Spree.t(:bar, scope: [:city], email: email)
+
+# good
+I18n.t(:bar, scope: [:spree, :city], email: email)
+```
+```ruby
+# With the scope parameter as a string
+
+# bad
+Spree.t('bar', scope: 'admin.city')
+
+# good
+I18n.t('bar', scope: 'spree.admin.city')
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/22](https://github.com/solidusio/rubocop-solidus/issues/22)

data/lib/rubocop/cop/mixin/target_solidus_version.rb

@@ -24,6 +24,10 @@ module RuboCop
         def targeted_solidus_version?(version)
           Gem::Version.new(@minimum_solidus_version) <= Gem::Version.new(version)
         end
+
+        def required_minimum_solidus_version
+          @minimum_solidus_version
+        end
       end
 
       # This method overrides the one in RuboCop::Cop::Base.