Merge pull request #62 from solidusio/ml/existing_card_id_deprecation

New cop to warn about `existing_card_id` usage
solidusio · Nov 3, 2023 · ea03a4b · ea03a4b
2 parents 63ad950 + 50a2e02
commit ea03a4b
Show file tree

Hide file tree

Showing 11 changed files with 134 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 ## 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

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-solidus (0.1.4)
+    rubocop-solidus (0.2.0)
       rubocop
 
 GEM

diff --git a/config/default.yml b/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'
diff --git a/docs/cops.md b/docs/cops.md
@@ -6,6 +6,7 @@ In the following section you find all available cops:
 #### 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)

diff --git a/docs/cops_solidus.md b/docs/cops_solidus.md
@@ -4,7 +4,7 @@
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | No | 0.1.0 | - | -
+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.
@@ -32,11 +32,39 @@ end
 
 * [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.0 | - | 2.11
+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.
@@ -66,7 +94,7 @@ reimbursement_failed_hooks.any?
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | No | 0.1.0 | - | -
+Enabled | Yes | No | 0.1 | - | -
 
 This cop finds Spree::Calculator::FreeShipping calls.
 This cop is needed as they have been deprecated in future version.
@@ -88,7 +116,7 @@ Spree::Calculator::FreeShipping
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | Yes  | 0.1.0 | - | -
+Enabled | Yes | Yes  | 0.1 | - | -
 
 This cop finds Spree::Calculator::PercentPerItem calls.
 This cop is needed as they have been deprecated in future version.
@@ -111,7 +139,7 @@ Spree::Calculator::PercentOnLineItem
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | No | 0.1.0 | - | -
+Enabled | Yes | No | 0.1 | - | -
 
 This cop finds Spree::Calculator::PriceSack calls.
 This cop is needed as they have been deprecated in future version.
@@ -133,7 +161,7 @@ Spree::Calculator::PriceSack
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | Yes  | 0.1.0 | - | 2.2
+Enabled | Yes | Yes  | 0.1 | - | 2.2
 
 This cop finds user.default_credit_card suggest using user.wallet.default_wallet_payment_source.
 
@@ -155,7 +183,7 @@ user.wallet.default_wallet_payment_source
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | Yes  | 0.1.0 | - | 2.1
+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.
@@ -182,7 +210,7 @@ Spree::PaymentMethod::BogusCreditCard.create!
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | Yes  | 0.1.0 | - | 2.3
+Enabled | Yes | Yes  | 0.1 | - | 2.3
 
 This cop finds icon helper calls and suggest using solidus_icon.
 
@@ -204,7 +232,7 @@ helper.solidus_icon('example')
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | No | 0.1.0 | - | 2.11
+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.
@@ -227,7 +255,7 @@ Spree::Refund.create(your: attributes, perform_after_create: false).perform!
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
 --- | --- | --- | --- | --- | ---
-Enabled | Yes | Yes  | 0.1.0 | - | -
+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.

diff --git a/lib/rubocop/cop/mixin/target_solidus_version.rb b/lib/rubocop/cop/mixin/target_solidus_version.rb
@@ -36,7 +36,7 @@ def required_minimum_solidus_version
       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)

diff --git a/lib/rubocop/cop/solidus/existing_card_id_deprecated.rb b/lib/rubocop/cop/solidus/existing_card_id_deprecated.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds existing_card_id occurrences and suggest using wallet_payment_source_id instead.
+      #
+      # @example
+      #
+      #   # 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
+      #   }
+      #
+      class ExistingCardIdDeprecated < Base
+        include TargetSolidusVersion
+        minimum_solidus_version 2.2
+
+        MSG = 'Use `wallet_payment_source_id` instead of `existing_card_id`.'
+
+        def_node_matcher :existing_card_id?, <<~PATTERN
+          (send ... :existing_card_id)
+        PATTERN
+
+        def on_send(node)
+          return unless existing_card_id?(node)
+
+          add_offense(node, severity: :warning)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/rubocop/cop/solidus_cops.rb b/lib/rubocop/cop/solidus_cops.rb
@@ -3,6 +3,7 @@
 require_relative 'mixin/target_solidus_version'
 
 require_relative 'solidus/class_eval_decorator'
+require_relative 'solidus/existing_card_id_deprecated'
 require_relative 'solidus/reimbursement_hook_deprecated'
 require_relative 'solidus/spree_calculator_free_shipping_deprecated'
 require_relative 'solidus/spree_calculator_percent_per_item_deprecated'

diff --git a/lib/rubocop/solidus/version.rb b/lib/rubocop/solidus/version.rb
@@ -2,6 +2,6 @@
 
 module RuboCop
   module Solidus
-    VERSION = '0.1.4'
+    VERSION = '0.2.0'
   end
 end
diff --git a/relnotes/v0.2.0.md b/relnotes/v0.2.0.md
@@ -0,0 +1,9 @@
+### 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][])
+
+[@MassimilianoLattanzio]: https://github.com/MassimilianoLattanzio
diff --git a/spec/rubocop/cop/solidus/existing_card_id_deprecated_spec.rb b/spec/rubocop/cop/solidus/existing_card_id_deprecated_spec.rb
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Solidus::ExistingCardIdDeprecated, :config do
+  it 'registers an offense when using `existing_card_id`' do
+    expect_offense(<<~RUBY, severity: :warning)
+      existing_card_id
+      ^^^^^^^^^^^^^^^^ Use `wallet_payment_source_id` instead of `existing_card_id`.
+    RUBY
+  end
+
+  it 'does not register an offense when using `wallet_payment_source_id`' do
+    expect_no_offenses(<<~RUBY)
+      wallet_payment_source_id
+    RUBY
+  end
+end