rubocop-solidus 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 745ca1ca12310bb9de934135f03aae227d87d616005ce5e82aafe58d6554a88d
-  data.tar.gz: 9723caf52452c8b1d4fa8bf88f644298bda3d01631af85df95a6aceb6b741462
+  metadata.gz: 2bc1ae2b167634c137ee88d6bd7615fb3a0907955cc143f4aa5094934353f5ea
+  data.tar.gz: c161d8a998a63418dacfdec1c8a14c964bfe3e92e5e074d0d53df25fee64a520
 SHA512:
-  metadata.gz: 8683bf3a98d2483a25e1d18a078ca9a44ad39eb138a069364b664dbdc989f0199a7bcb86c68ce750268a310ca0c0342cc4cd55a60448edc65d3ff9b3a28e56f8
-  data.tar.gz: 2c36b5f8362baf576f3eaecc05e63324d988f1fcf0a0d63ce27c606787437a8fd303e8ca1172269f7766de26378d6aaf2598831dcbf43eef5583551f2581177a
+  metadata.gz: 16ebb4fa72cefa29901078c5d8027ab54eb406472de63c767739bdc306140efdf8a5ca5a49ccc038222e978b2124871b6cbd318c6d030ad7c954abf5eb69f5e4
+  data.tar.gz: 5ff42650f717fe597830d1ce410546abcf2e4c55f8b561e1a0cae8de99d206d5fdf6dded86249ef814bb9d0b5a6ef67c0962e2797f3cb5a0ea09e3c393ebda06

data/.rubocop.yml

@@ -2,6 +2,7 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
 
 Naming/FileName:
  Exclude:
@@ -14,6 +15,13 @@ Metrics/BlockLength:
     - 'spec/**/*.rb'
     - '*.gemspec'
 
+Metrics/MethodLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+
 Metrics/ClassLength:
   Exclude:
     - 'tasks/**/*.rb'

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-## master (unreleased)
+## main (unreleased)
+
+## 0.2.0 (2023-11-02)
+
+### New features
+
+* [#60](https://github.com/solidusio/rubocop-solidus/issues/60): Create new cop to check existing_card_id. ([@MassimilianoLattanzio][])
+
+### Bug fixes
+
+* [#60](https://github.com/solidusio/rubocop-solidus/issues/60): Fix overridden add_offense method. ([@MassimilianoLattanzio][])
+
+## 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)
 

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.3)
+    rubocop-solidus (0.2.0)
       rubocop
 
 GEM
@@ -54,6 +54,7 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
   -darwin-22
@@ -69,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' 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
 
@@ -28,9 +30,59 @@ require:
     - rubocop-solidus
 ```
 
-After this simply use the `rubocop` command to start linting.
 
-## Creating new cops
+After this^, simply use the `rubocop` command to start linting your Ruby(`.rb`) files.
+
+### For linting `.erb` files
+
+We recommend to run rubocop solidus cops on ERB files. The simplest method to do this is via
+[erblint](https://github.com/Shopify/erb-lint)
+
+#### Add ERBlint to your Gemfile
+```ruby
+  gem 'erb_lint'
+```
+
+#### Add ERBlint config (`.erb-lint.yml`)
+This is the most basic ERBlint config that can be used to run all and only the Solidus cops in any project
+```yaml
+---
+EnableDefaultLinters: false
+linters:
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from:
+        - .rubocop.yml
+    only:
+      - Solidus
+```
+
+#### To run ERBlint for all ERB files
+```bash
+# From project directory
+bundle exec erblint .
+```
+
+#### To run autocorrect on ERB files
+Any cop that supports autocorrect for rubocop implicitly supports autocorrect
+for ERB files as well.
+```bash
+# From project directory
+bundle exec erblint -a .
+```
+
+## 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:
 
@@ -40,7 +92,7 @@ $ bundle exec rake 'new_cop[Solidus/NameOfTheCop]'
 
 and then follow the instructions on the screen.
 
-## Creating changelog entries
+### 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:
@@ -51,7 +103,7 @@ $ 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
+#### Changelog entry format
 
 Here are a few examples:
 
@@ -68,7 +120,7 @@ Here are a few examples:
 * 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
+### Release a new version
 
 To release a new version, run the following command:
 
@@ -89,10 +141,6 @@ 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/solidusio/rubocop-solidus.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -11,59 +11,65 @@ AllCops:
 Solidus/ClassEvalDecorator:
   Description: 'Checks if Class.class_eval is being used in the code'
   Enabled: true
-  VersionAdded: '0.1.0'
+  VersionAdded: '0.1'
   Reference: 'https://github.com/solidusio/rubocop-solidus/issues/21'
 
+Solidus/ExistingCardIdDeprecated:
+  Description: 'Checks if existing_card_id is being used and suggest using wallet_payment_source_id instead'
+  Enabled: true
+  VersionAdded: '0.2'
+  Reference: 'https://github.com/solidusio/rubocop-solidus/issues/60'
+
 Solidus/ReimbursementHookDeprecated:
   Description: 'Checks if reimbursement_success_hooks and reimbursement_failed_hooks is being used'
   Enabled: true
-  VersionAdded: '0.1.0'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   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'
+  VersionAdded: '0.1'
   Reference: 'https://github.com/solidusio/rubocop-solidus/issues/22'

data/docs/cops.md

@@ -0,0 +1,20 @@
+## 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/ExistingCardIdDeprecated](cops_solidus.md#solidusexistingcardiddeprecated)
+* [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,304 @@
+# Solidus
+
+## Solidus/ClassEvalDecorator
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.1 | - | -
+
+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/ExistingCardIdDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.2 | - | 2.2
+
+This cop finds existing_card_id occurrences and suggest using wallet_payment_source_id instead.
+
+### Examples
+
+```ruby
+# bad
+{
+  name: payment_method.name,
+  existing_card_id: payment_source.id
+}
+
+# good
+{
+  name: payment_method.name,
+  wallet_payment_source_id: payment_source.wallet.wallet_payment_sources.first.id
+}
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/60](https://github.com/solidusio/rubocop-solidus/issues/60)
+
+## Solidus/ReimbursementHookDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.1 | - | 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 | - | -
+
+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 | - | -
+
+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 | - | -
+
+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 | - | 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 | - | 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 | - | 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 | - | 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 | - | -
+
+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.
@@ -32,7 +36,7 @@ module RuboCop
       def add_offense(*args, **kwargs, &block)
         return unless affected_solidus_version?
 
-        if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('3')
+        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
           super(*args, **kwargs, &block)
         else
           super(*args, &block)

data/lib/rubocop/cop/solidus/class_eval_decorator.rb

@@ -3,35 +3,31 @@
 module RuboCop
   module Cop
     module Solidus
-      # TODO: Write cop description and example of bad / good code. For every
-      # `SupportedStyle` and unique configuration, there needs to be examples.
-      # Examples must have valid Ruby syntax. Do not use upticks.
+      # 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.
       #
-      #
-      # @example EnforcedStyle: SpreeClass
-      #   # Description of the `SpreeClass` style.
+      # @example
       #
       #   # bad
       #   SpreeClass.class_eval do
-      #   .
-      #   .
+      #     # your code here
       #   end
       #
-      #
       #   # good
-      #   module SpreeClassDecorator
-      #   .
-      #   .
+      #   module Spree
+      #     module SpreeClassDecorator
+      #       # your code here
+      #     end
+      #
+      #     Spree::SpreeClass.prepend self
       #   end
       #
       class ClassEvalDecorator < Base
-        MSG = 'Do not use `class_eval` flag. Use a decorator module instead. Check this link for an example https://guides.solidus.io/cookbook/redefining-checkout-steps'
+        MSG = 'Do not use `class_eval` flag. Use a decorator module instead. More info: https://guides.solidus.io/customization/customizing-the-core.'
 
-        # TODO: Don't call `on_send` unless the method name is in this list
-        # If you don't need `on_send` in the cop you created, remove it.
         RESTRICT_ON_SEND = %i[class_eval].freeze
 
-        # @!method on_class_eval?(node)
         def_node_matcher :on_class_eval?, <<~PATTERN
           (send  ($...) :class_eval)
         PATTERN