rubocop-solidus 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df0c66e0a5dddaec3401e5cfd7d4f2704d0d920d9883172e7d8551aee6663641
-  data.tar.gz: 929b18aba23c67ae33c3582d94e3758a6682668cfe8595e49107e72387672050
+  metadata.gz: 2bc1ae2b167634c137ee88d6bd7615fb3a0907955cc143f4aa5094934353f5ea
+  data.tar.gz: c161d8a998a63418dacfdec1c8a14c964bfe3e92e5e074d0d53df25fee64a520
 SHA512:
-  metadata.gz: de6813fbc0de1c6e24bc686622112ba91d71580a5d116f4eb33747ffeceef4c74fc437dc31c5b98a209f592b4bd5fb970be8495b7a04e98515fc262fd7497edf
-  data.tar.gz: 619bf635aa925403cdce3fcf65f9be39b45d5d301348eb2c6666f5b48e9f45b16cc9d22c7b641f5906f19991ca4ffe2a721b6643677cac458288af02c440fd18
+  metadata.gz: 16ebb4fa72cefa29901078c5d8027ab54eb406472de63c767739bdc306140efdf8a5ca5a49ccc038222e978b2124871b6cbd318c6d030ad7c954abf5eb69f5e4
+  data.tar.gz: 5ff42650f717fe597830d1ce410546abcf2e4c55f8b561e1a0cae8de99d206d5fdf6dded86249ef814bb9d0b5a6ef67c0962e2797f3cb5a0ea09e3c393ebda06

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## 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)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-solidus (0.1.4)
+    rubocop-solidus (0.2.0)
       rubocop
 
 GEM

data/README.md

@@ -30,7 +30,47 @@ require:
     - rubocop-solidus
 ```
 
-After this simply use the `rubocop` command to start linting.
+
+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
 

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

@@ -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)

data/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.

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

@@ -36,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/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

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

@@ -44,6 +44,7 @@ module RuboCop
       #
       class SpreeTDeprecated < Base
         extend AutoCorrector
+        include IgnoredNode
         MSG = 'Use I18n.t instead of Spree.t which has been deprecated in future versions.'
 
         RESTRICT_ON_SEND = %i[t].freeze
@@ -58,8 +59,11 @@ module RuboCop
           return unless spree_t?(node).include?(:Spree)
 
           add_offense(node) do |corrector|
+            next if part_of_ignored_node?(node)
+
             corrector.replace(node, corrected_statement(node))
           end
+          ignore_node(node)
         end
 
         # rubocop:disable Metrics/MethodLength

data/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'

data/lib/rubocop/solidus/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Solidus
-    VERSION = '0.1.4'
+    VERSION = '0.2.0'
   end
 end

data/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

data/rubocop-solidus.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://www.github.com/solidusio/rubocop-solidus'
-  spec.metadata['changelog_uri'] = 'https://www.github.com/solidusio/rubocop-solidus/blob/master/CHANGELOG.md'
-  spec.metadata['documentation_uri'] = 'https://www.github.com/solidusio/rubocop-solidus/blob/master/docs/cops.md'
+  spec.metadata['changelog_uri'] = 'https://www.github.com/solidusio/rubocop-solidus/blob/main/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://www.github.com/solidusio/rubocop-solidus/blob/main/docs/cops.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/tasks/changelog.rb

@@ -3,7 +3,7 @@
 # Changelog utility
 class Changelog
   ENTRIES_PATH = 'changelog/'
-  FIRST_HEADER = /#{Regexp.escape("## master (unreleased)\n")}/m.freeze
+  FIRST_HEADER = /#{Regexp.escape("## main (unreleased)\n")}/m.freeze
   ENTRIES_PATH_TEMPLATE = "#{ENTRIES_PATH}%<type>s_%<name>s.md"
   TYPE_REGEXP = /#{Regexp.escape(ENTRIES_PATH)}([a-z]+)_/.freeze
   TYPE_TO_HEADER = { new: 'New features', fix: 'Bug fixes', change: 'Changes' }.freeze

data/tasks/cut_release.rake

@@ -12,11 +12,11 @@ namespace :cut_release do
 
   def add_header_to_changelog(version)
     changelog = File.read('CHANGELOG.md')
-    head, tail = changelog.split("## master (unreleased)\n\n", 2)
+    head, tail = changelog.split("## main (unreleased)\n\n", 2)
 
     File.open('CHANGELOG.md', 'w') do |f|
       f << head
-      f << "## master (unreleased)\n\n"
+      f << "## main (unreleased)\n\n"
       f << "## #{version} (#{Time.now.strftime('%F')})\n\n"
       f << tail
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-solidus
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - piyushswain
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -48,6 +48,7 @@ files:
 - lib/rubocop-solidus.rb
 - lib/rubocop/cop/mixin/target_solidus_version.rb
 - lib/rubocop/cop/solidus/class_eval_decorator.rb
+- lib/rubocop/cop/solidus/existing_card_id_deprecated.rb
 - lib/rubocop/cop/solidus/reimbursement_hook_deprecated.rb
 - lib/rubocop/cop/solidus/spree_calculator_free_shipping_deprecated.rb
 - lib/rubocop/cop/solidus/spree_calculator_percent_per_item_deprecated.rb
@@ -64,6 +65,7 @@ files:
 - relnotes/v0.1.2.md
 - relnotes/v0.1.3.md
 - relnotes/v0.1.4.md
+- relnotes/v0.2.0.md
 - rubocop-solidus.gemspec
 - sig/rubocop/solidus.rbs
 - tasks/changelog.rake
@@ -76,8 +78,8 @@ licenses:
 metadata:
   homepage_uri: https://www.github.com/solidusio/rubocop-solidus
   source_code_uri: https://www.github.com/solidusio/rubocop-solidus
-  changelog_uri: https://www.github.com/solidusio/rubocop-solidus/blob/master/CHANGELOG.md
-  documentation_uri: https://www.github.com/solidusio/rubocop-solidus/blob/master/docs/cops.md
+  changelog_uri: https://www.github.com/solidusio/rubocop-solidus/blob/main/CHANGELOG.md
+  documentation_uri: https://www.github.com/solidusio/rubocop-solidus/blob/main/docs/cops.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.21
 signing_key: 
 specification_version: 4
 summary: Automatic Solidus code style checking tool.