rubocop-solidus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f5300b213565a1a439d50b1e8a10f1fdb85559dd82c22590d583afaee88cd80
+  data.tar.gz: f449296bd8ce1235e5760eb0284ca29b33634ed6fc095230f4837bb60a72a28f
+SHA512:
+  metadata.gz: 3c2704f57083a3bfdb599b5e8fd684271703a541a1e636307955a798c8ddcb3db79fa61698840ecc76b90917e6063f24c0582fb45fda1403b605abb4f99c28be
+  data.tar.gz: 40fe450071e0b1bfcf88b989090d1fdd4cd6e2837eadab97cdc88bc618124453050c1fce6a9118978cf32683d73fcc6655bed0ddc4878d141004f8a8f80c4bc1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.4
+
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-solidus.rb
+
+Metrics/BlockLength:
+  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/CHANGELOG.md

@@ -0,0 +1,5 @@
+## master (unreleased)
+
+## 0.1.0 (2023-07-10)
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-solidus.gemspec
+gemspec
+
+gem 'bump'
+gem 'pry'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    rubocop-solidus (0.1.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bump (0.10.0)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    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)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.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)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  -darwin-22
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bump
+  pry
+  rake
+  rspec
+  rubocop
+  rubocop-solidus!
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 piyushswain
+
+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,70 @@
+# Rubocop::Solidus
+
+Automatic Solidus code style checking tool.
+A RuboCop extension focused on enforcing Solidus best practices and coding conventions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-solidus', github: 'nebulab/rubocop-solidus', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-solidus
+
+## Usage
+
+To Start using this extension in your application add the following lines to your `.rubocop.yml` file
+
+```yaml
+require:
+    - rubocop-solidus
+```
+
+After this simply use the `rubocop` command to start linting.
+
+## Creating new cops
+
+To create a new cop, run the following command:
+
+```bash
+$ bundle exec rake new_cop[Solidus/NameOfTheCop]
+```
+
+and then follow the instructions on the screen.
+
+## Release a new version
+
+To release a new version, run the following command:
+
+```bash
+$ bundle exec rake cut_release:[major|minor|patch]
+```
+
+and then follow the instructions on the screen.
+
+The type of the release is determined by:
+- `major` if there are breaking changes
+- `minor` if there are new cops or new features
+- `patch` if there are only bug fixes
+
+To deploy the new version to RubyGems, run the following command:
+
+```bash
+$ 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).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task default: %i[spec rubocop]
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/solidus_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -0,0 +1,69 @@
+AllCops:
+  # What version of Solidus is the inspected code using? If a value is specified
+  # for TargetSolidusVersion then it is used. Acceptable values are specified
+  # as a float (i.e. 3.1); the patch version of Solidus should not be included.
+  # If TargetSolidusVersion is not set, RuboCop will parse the Gemfile.lock or
+  # gems.locked file to find the version of Solidus that has been bound to the
+  # application.  If neither of those files exist, RuboCop will use Solidus 3.0
+  # as the default.
+  TargetSolidusVersion: ~
+
+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'
+
+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'
+
+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'
+
+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'
+
+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'
+
+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'
+
+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'
+
+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'
+
+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'
+
+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'

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This module provides a way to specify a minimum Solidus version for a cop.
+    # It also provides a way to check if the current Solidus version is affected.
+    # The minimum Solidus version can be specified in the cop itself in this way:
+    #   include TargetSolidusVersion
+    #   minimum_solidus_version 2.11
+    module TargetSolidusVersion
+      DEFAULT_SOLIDUS_VERSION = 3.0
+
+      def self.included(target)
+        target.extend(ClassMethods)
+      end
+
+      # These class methods are automatically added to the cop when the module
+      # is included. They are used to specify the minimum Solidus version for the cop.
+      module ClassMethods
+        def minimum_solidus_version(version)
+          @minimum_solidus_version = version
+        end
+
+        def targeted_solidus_version?(version)
+          @minimum_solidus_version <= version
+        end
+      end
+
+      # This method overrides the one in RuboCop::Cop::Base.
+      # Since this method is called for every offense, we can use it to check
+      # if the Solidus version is affected and skip the offense if it's not.
+      def add_offense(*args, **kwargs, &block)
+        return unless affected_solidus_version?
+
+        if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('3')
+          super(*args, **kwargs, &block)
+        else
+          super(*args, &block)
+        end
+      end
+
+      private
+
+      def affected_solidus_version?
+        self.class.targeted_solidus_version?(target_solidus_version)
+      end
+
+      def target_solidus_version
+        @target_solidus_version ||=
+          config.for_all_cops['TargetSolidusVersion']&.to_f || solidus_version_from_lock_file || DEFAULT_SOLIDUS_VERSION
+      end
+
+      def solidus_version_from_lock_file
+        @solidus_version_from_lock_file ||= read_solidus_version_from_lock_file
+      end
+
+      def read_solidus_version_from_lock_file
+        lock_file_path = config.bundler_lock_file_path
+        return nil unless lock_file_path
+
+        File.foreach(lock_file_path) do |line|
+          # If Solidus (or one of its frameworks) is in Gemfile.lock, there should be a line like:
+          #   solidus_core (X.X.X)
+          result = line.match(/^\s+solidus_core\s+\((\d+\.\d+)/)
+          return result.captures.first.to_f if result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+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.
+      #
+      #
+      # @example EnforcedStyle: SpreeClass
+      #   # Description of the `SpreeClass` style.
+      #
+      #   # bad
+      #   SpreeClass.class_eval do
+      #   .
+      #   .
+      #   end
+      #
+      #
+      #   # good
+      #   module SpreeClassDecorator
+      #   .
+      #   .
+      #   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'
+
+        # 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
+
+        def on_send(node)
+          return unless on_class_eval?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds reimbursement_success_hooks and reimbursement_failed_hooks calls and
+      # asks to remove them and subscribe to reimbursement_reimbursed event instead.
+      class ReimbursementHookDeprecated < Base
+        include TargetSolidusVersion
+        minimum_solidus_version 2.11
+
+        MSG = 'Please remove reimbursement_success_hooks and reimbursement_failed_hooks. ' \
+              'Subscribe to reimbursement_reimbursed event instead.'
+
+        def_node_matcher :success_hook?, <<~PATTERN
+          (send (send nil? :reimbursement_success_hooks) ...)
+        PATTERN
+
+        def_node_matcher :fail_hook?, <<~PATTERN
+          (send (send nil? :reimbursement_failed_hooks) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless success_hook?(node) || fail_hook?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds Spree::Calculator::FreeShipping calls.
+      # This cop is needed as they have been deprecated in future version.
+      #
+      class SpreeCalculatorFreeShippingDeprecated < Base
+        MSG = 'Spree::Calculator::FreeShipping is deprecated.'
+
+        def_node_matcher :free_shipping?, <<~PATTERN
+          (send (... (... :Calculator) :FreeShipping) $_)
+        PATTERN
+
+        def on_send(node)
+          return unless free_shipping?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds Spree::Calculator::PercentPerItem calls.
+      # This cop is needed as they have been deprecated in future version.
+      #
+      class SpreeCalculatorPercentPerItemDeprecated < Base
+        extend AutoCorrector
+
+        MSG = 'Spree::Calculator::PercentPerItem is deprecated.'
+
+        def_node_matcher :percent_per_item?, <<~PATTERN
+          (send (... (... :Calculator) :PercentPerItem) $_)
+        PATTERN
+
+        def on_send(node)
+          percent_per_item?(node) do |method_used|
+            add_offense(node, message: MSG) do |corrector|
+              corrector.replace(node, "Spree::Calculator::PercentOnLineItem.#{method_used}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds Spree::Calculator::PriceSack calls.
+      # This cop is needed as they have been deprecated in future version.
+      #
+      class SpreeCalculatorPriceSackDeprecated < Base
+        MSG = 'Spree::Calculator::PriceSack is deprecated.'
+
+        def_node_matcher :price_sack?, <<~PATTERN
+          (send (... (... :Calculator) :PriceSack) $_)
+        PATTERN
+
+        def on_send(node)
+          return unless price_sack?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds user.default_credit_card suggest using user.wallet.default_wallet_payment_source
+      #
+      # @example EnforcedStyle:
+      #   # bad
+      #   user.default_credit_card
+      #
+      #   # good
+      #   user.wallet.default_wallet_payment_source
+      #
+      #
+      class SpreeDefaultCreditCardDeprecated < Base
+        extend AutoCorrector
+        include TargetSolidusVersion
+        minimum_solidus_version 2.2
+
+        MSG = 'user.default_credit_card is deprecated. Please use user.wallet.default_wallet_payment_source instead.'
+
+        # @!method bad_method?(node)
+        def_node_matcher :default_credit_card?, <<~PATTERN
+          (send ... :default_credit_card)
+        PATTERN
+
+        def on_send(node)
+          return unless default_credit_card?(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, node.source.gsub('default_credit_card', 'wallet.default_wallet_payment_source'))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds Spree::Gateway::Bogus calls and replaces them with the Spree::PaymentMethod::BogusCreditCard call
+      # This cop is needed as the Spree::Gateway::Bogus has been deprecated in future version.
+      #
+      # @example EnforcedStyle:
+      #   # bad
+      #   Spree::Gateway::Bogus.new
+      #
+      #   # good
+      #   Spree::PaymentMethod::BogusCreditCard.new
+      #
+      #   # bad
+      #   Spree::Gateway::Bogus.create
+      #
+      #   # good
+      #   Spree::PaymentMethod::BogusCreditCard.create
+      #
+      #   # bad
+      #   Spree::Gateway::Bogus.create!
+      #
+      #   # good
+      #   Spree::PaymentMethod::BogusCreditCard.create!
+      #
+      #
+      class SpreeGatewayBogusDeprecated < Base
+        extend AutoCorrector
+        include TargetSolidusVersion
+        minimum_solidus_version 2.10
+
+        MSG = 'Spree::Gateway::Bogus is deprecated. Please use Spree::PaymentMethod::BogusCreditCard instead.'
+
+        # @!method bad_method?(node)
+        def_node_matcher :bad_class?, <<~PATTERN
+          (send (... (... :Gateway) :Bogus) $_)
+        PATTERN
+
+        def on_send(node)
+          bad_class?(node) do |method_used|
+            add_offense(node, message: MSG) do |corrector|
+              corrector.replace(node, "Spree::PaymentMethod::BogusCreditCard.#{method_used}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # This cop finds icon helper calls and suggest using solidus_icon
+      #
+      # @example EnforcedStyle:
+      #   # bad
+      #   helper.icon('example')
+      #
+      #   # good
+      #   helper.solidus_icon('example')
+      #
+      #
+      class SpreeIconDeprecated < Base
+        extend AutoCorrector
+        include TargetSolidusVersion
+        minimum_solidus_version 2.3
+
+        MSG = 'In Solidus 2.3, `icon` helper has been deprecated in favor of `solidus_icon`'
+
+        RESTRICT_ON_SEND = %i[icon].freeze
+
+        def_node_matcher :icon?, <<~PATTERN
+          (send (send nil? ...) :icon ...)
+        PATTERN
+
+        def on_send(node)
+          return unless icon?(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, node.source.gsub('icon', 'solidus_icon'))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # 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
+      #
+      class SpreeRefundCallPerform < Base
+        include TargetSolidusVersion
+        minimum_solidus_version 2.11
+
+        MSG = 'From Solidus v3.0 onwards, #perform! will need to be explicitly called when creating new refunds. ' \
+              'Please, change your code from `Spree::Refund.create(your: attributes)` ' \
+              'to `Spree::Refund.create(your: attributes, perform_after_create: false).perform!`'
+
+        RESTRICT_ON_SEND = %i[create].freeze
+
+        # @!method bad_method?(node)
+        def_node_matcher :create_refund?, <<~PATTERN
+          (send (const (const nil? :Spree) :Refund) :create ...)
+        PATTERN
+
+        def on_send(node)
+          return unless create_refund?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Solidus
+      # 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.
+      #
+      #
+      # @example EnforcedStyle: bar (default)
+      #   # bad
+      #   Spree.t(:bar)
+      #
+      #   # good
+      #   I18n.t(:bar, scope: :spree)
+      #
+      #   # bad
+      #   Spree.t(:bar, scope: [:city])
+      #
+      #   # good
+      #   I18n.t(:bar, scope: [:spree, :city])
+      #
+      #   # bad
+      #   Spree.t(:bar, scope: [:city], email: email)
+      #
+      #   # good
+      #   I18n.t(:bar, scope: [:spree, :city], email: email)
+      #
+      #   # bad
+      #   Spree.t('bar', scope: 'admin.city')
+      #
+      #   # good
+      #   I18n.t('bar', scope: 'spree.admin.city')
+      #
+      #
+      class SpreeTDeprecated < Base
+        extend AutoCorrector
+        MSG = 'Use I18n.t instead of Spree.t which has been deprecated in future versions.'
+
+        RESTRICT_ON_SEND = %i[t].freeze
+
+        # @!method spree_t?(node)
+        def_node_matcher :spree_t?, <<~PATTERN
+          (send ($...) :t ...)
+        PATTERN
+
+        def on_send(node)
+          return unless spree_t?(node)
+
+          return unless spree_t?(node).include?(:Spree)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, corrected_statement(node))
+          end
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def corrected_statement(node)
+          arguments = node.arguments
+
+          new_statement = 'I18n.t('
+          new_statement += arguments.first.source
+          new_statement += ', scope: :spree' if scope_missing?(arguments)
+
+          node.arguments.drop(1).each do |argument|
+            if argument.source.include? 'scope:'
+              new_argument = add_spree_scope(argument)
+              new_statement += ", #{new_argument}"
+            else
+              new_statement += ", #{argument.source}"
+            end
+          end
+          new_statement += ')'
+          new_statement
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def scope_missing?(arguments)
+          arguments.each do |argument|
+            return false if argument.source.include? 'scope:'
+          end
+          true
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def add_spree_scope(argument)
+          modified_argument = ''
+
+          argument.each_pair do |key, value|
+            if key.source == 'scope'
+              modified_argument = if value.type == :array
+                                    "#{key.source}: #{value.source.gsub('[', '[:spree, ')}"
+                                  else
+                                    "#{key.source}: 'spree.#{value.source.gsub("'", '')}'"
+                                  end
+            else
+              modified_argument += ", #{key.source}: #{value.source}"
+            end
+          end
+
+          modified_argument
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/rubocop/cop/solidus_cops.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'mixin/target_solidus_version'
+
+require_relative 'solidus/class_eval_decorator'
+require_relative 'solidus/reimbursement_hook_deprecated'
+require_relative 'solidus/spree_calculator_free_shipping_deprecated'
+require_relative 'solidus/spree_calculator_percent_per_item_deprecated'
+require_relative 'solidus/spree_calculator_price_sack_deprecated'
+require_relative 'solidus/spree_default_credit_card_deprecated'
+require_relative 'solidus/spree_gateway_bogus_deprecated'
+require_relative 'solidus/spree_icon_deprecated'
+require_relative 'solidus/spree_refund_call_perform'
+require_relative 'solidus/spree_t_deprecated'

data/lib/rubocop/solidus/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Solidus
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/solidus/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Solidus
+    VERSION = '0.1.0'
+  end
+end

data/lib/rubocop/solidus.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'solidus/version'
+
+module RuboCop
+  # RuboCop Solidus project namespace
+  module Solidus
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-solidus.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/solidus'
+require_relative 'rubocop/solidus/version'
+require_relative 'rubocop/solidus/inject'
+
+RuboCop::Solidus::Inject.defaults!
+
+require_relative 'rubocop/cop/solidus_cops'

data/sig/rubocop/solidus.rbs

@@ -0,0 +1,6 @@
+module Rubocop
+  module Solidus
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/tasks/changelog.rake

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+autoload :Changelog, "#{__dir__}/changelog"
+
+namespace :changelog do
+  %i[new fix change].each do |type|
+    desc "Create a Changelog entry (#{type})"
+    task type, [:id] do |_task, args|
+      ref_type = :pull if args[:id]
+      path = Changelog::Entry.new(type: type, ref_id: args[:id], ref_type: ref_type).write
+      cmd = "git add #{path}"
+      system cmd
+      puts "Entry '#{path}' created and added to git index"
+    end
+  end
+
+  desc 'Merge entries and delete them'
+  task :merge do
+    raise 'No entries!' unless Changelog.pending?
+
+    Changelog.new.merge!.and_delete!
+    cmd = "git commit -a -m 'Update Changelog'"
+    puts cmd
+    system cmd
+  end
+
+  task :check_clean do
+    next unless Changelog.pending?
+
+    puts '*** Pending changelog entries!'
+    puts 'Do `bundle exec rake changelog:merge`'
+    exit(1)
+  end
+end

data/tasks/changelog.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+# Changelog utility
+class Changelog
+  ENTRIES_PATH = 'changelog/'
+  FIRST_HEADER = /#{Regexp.escape("## master (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
+  HEADER = /### (.*)/.freeze
+  PATH = 'CHANGELOG.md'
+  REF_URL = 'https://github.com/nebulab/rubocop-solidus'
+  MAX_LENGTH = 40
+  CONTRIBUTOR = '[@%<user>s]: https://github.com/%<user>s'
+  SIGNATURE = Regexp.new(format(Regexp.escape('[@%<user>s][]'), user: '([\w-]+)'))
+  EOF = "\n"
+
+  # New entry
+  Entry = Struct.new(:type, :body, :ref_type, :ref_id, :user, keyword_init: true) do
+    def initialize(type:, body: last_commit_title, ref_type: nil, ref_id: nil, user: github_user)
+      id, body = extract_id(body)
+      ref_id ||= id || 'x'
+      ref_type ||= id ? :issues : :pull
+      super
+    end
+
+    def write
+      File.write(path, content)
+      path
+    end
+
+    def path
+      format(ENTRIES_PATH_TEMPLATE, type: type, name: str_to_filename(body))
+    end
+
+    def content
+      period = '.' unless body.end_with? '.'
+      "* #{ref}: #{body}#{period} ([@#{user}][])\n"
+    end
+
+    def ref
+      "[##{ref_id}](#{REF_URL}/#{ref_type}/#{ref_id})"
+    end
+
+    def last_commit_title
+      `git log -1 --pretty=%B`.lines.first.chomp
+    end
+
+    def extract_id(body)
+      /^\[Fix(?:es)? #(\d+)\] (.*)/.match(body)&.captures || [nil, body]
+    end
+
+    def str_to_filename(str)
+      str
+        .split
+        .reject(&:empty?)
+        .map { |s| prettify(s) }
+        .inject do |result, word|
+          s = "#{result}_#{word}"
+          return result if s.length > MAX_LENGTH
+
+          s
+        end
+    end
+
+    def github_user
+      user = `git config --global credential.username`.chomp
+      warn 'Set your username with `git config --global credential.username "myusernamehere"`' if user.empty?
+
+      user
+    end
+
+    private
+
+    def prettify(str)
+      str.gsub!(/\W/, '_')
+
+      # Separate word boundaries by `_`.
+      str.gsub!(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) do
+        (Regexp.last_match(1) || Regexp.last_match(2)) << '_'
+      end
+
+      str.gsub!(/\A_+|_+\z/, '')
+      str.downcase!
+      str
+    end
+  end
+
+  def self.pending?
+    entry_paths.any?
+  end
+
+  def self.entry_paths
+    Dir["#{ENTRIES_PATH}*"]
+  end
+
+  def self.read_entries
+    entry_paths.to_h { |path| [path, File.read(path)] }
+  end
+
+  attr_reader :header, :rest
+
+  def initialize(content: File.read(PATH), entries: Changelog.read_entries)
+    require 'strscan'
+
+    parse(content)
+    @entries = entries
+  end
+
+  def and_delete!
+    @entries.each_key { |path| File.delete(path) }
+  end
+
+  def merge!
+    File.write(PATH, merge_content)
+    self
+  end
+
+  def unreleased_content
+    entry_map = parse_entries(@entries)
+    merged_map = merge_entries(entry_map)
+    merged_map.flat_map { |header, things| ["### #{header}\n", *things, ''] }.join("\n")
+  end
+
+  def merge_content
+    merged_content = [@header, unreleased_content, @rest.chomp, *new_contributor_lines].join("\n")
+
+    merged_content << EOF
+  end
+
+  def new_contributor_lines
+    contributors
+      .map { |user| format(CONTRIBUTOR, user: user) }
+      .reject { |line| @rest.include?(line) }
+  end
+
+  def contributors
+    contributors = @entries.values.flat_map do |entry|
+      entry.match(/\. \((?<contributors>.+)\)\n/)[:contributors].split(',')
+    end
+
+    contributors.join.scan(SIGNATURE).flatten
+  end
+
+  private
+
+  def merge_entries(entry_map)
+    all = @unreleased.merge(entry_map) { |_k, v1, v2| v1.concat(v2) }
+    canonical = TYPE_TO_HEADER.values.to_h { |v| [v, nil] }
+    canonical.merge(all).compact
+  end
+
+  def parse(content)
+    ss = StringScanner.new(content)
+    @header = ss.scan_until(FIRST_HEADER)
+    @unreleased = parse_release(ss.scan_until(/\n(?=## )/m))
+    @rest = ss.rest
+  end
+
+  # @return [Hash<type, Array<String>]]
+  def parse_release(unreleased)
+    unreleased
+      .lines
+      .map(&:chomp)
+      .reject(&:empty?)
+      .slice_before(HEADER)
+      .to_h do |header, *entries|
+        [HEADER.match(header)[1], entries]
+      end
+  end
+
+  def parse_entries(path_content_map)
+    changes = Hash.new { |h, k| h[k] = [] }
+    path_content_map.each do |path, content|
+      header = TYPE_TO_HEADER.fetch(TYPE_REGEXP.match(path)[1].to_sym)
+      changes[header].concat(content.lines.map(&:chomp))
+    end
+    changes
+  end
+end

data/tasks/cut_release.rake

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'bump'
+
+namespace :cut_release do
+  %w[major minor patch pre].each do |release_type|
+    desc "Cut a new #{release_type} release and create release notes."
+    task release_type => 'changelog:check_clean' do
+      run(release_type)
+    end
+  end
+
+  def add_header_to_changelog(version)
+    changelog = File.read('CHANGELOG.md')
+    head, tail = changelog.split("## master (unreleased)\n\n", 2)
+
+    File.open('CHANGELOG.md', 'w') do |f|
+      f << head
+      f << "## master (unreleased)\n\n"
+      f << "## #{version} (#{Time.now.strftime('%F')})\n\n"
+      f << tail
+    end
+  end
+
+  def create_release_notes(version)
+    release_notes = new_version_changes.strip
+    contributor_links = user_links(release_notes)
+
+    File.open("relnotes/v#{version}.md", 'w') do |file|
+      file << release_notes
+      file << "\n\n"
+      file << contributor_links
+      file << "\n"
+    end
+  end
+
+  def version_sans_patch(version)
+    version.split('.').take(2).join('.')
+  end
+
+  # Replace `<<next>>` (and variations) with version being cut.
+  def update_cop_versions(_old_version, new_version)
+    update_file('config/default.yml') do |default|
+      default.gsub(/['"]?<<\s*next\s*>>['"]?/i, "'#{version_sans_patch(new_version)}'")
+    end
+  end
+
+  def new_version_changes
+    changelog = File.read('CHANGELOG.md')
+    _, _, new_changes, _older_changes = changelog.split(/^## .*$/, 4)
+    new_changes
+  end
+
+  def update_file(path)
+    content = File.read(path)
+    File.write(path, yield(content))
+  end
+
+  def user_links(text)
+    names = text.scan(/\[@(\S+)\]\[\]/).map(&:first).uniq
+    names.map { |name| "[@#{name}]: https://github.com/#{name}" }.join("\n")
+  end
+
+  def run(release_type)
+    old_version = Bump::Bump.current
+    Bump::Bump.run(release_type, commit: false, bundle: false, tag: false)
+    new_version = Bump::Bump.current
+
+    update_cop_versions(old_version, new_version)
+    add_header_to_changelog(new_version)
+    create_release_notes(new_version)
+
+    puts "Changed version from #{old_version} to #{new_version}."
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-solidus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- piyushswain
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Automatic Solidus code style checking tool.
+  A RuboCop extension focused on enforcing Solidus best practices and coding conventions.
+email:
+- danielepalombo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-solidus.rb
+- lib/rubocop/cop/mixin/target_solidus_version.rb
+- lib/rubocop/cop/solidus/class_eval_decorator.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
+- lib/rubocop/cop/solidus/spree_calculator_price_sack_deprecated.rb
+- lib/rubocop/cop/solidus/spree_default_credit_card_deprecated.rb
+- lib/rubocop/cop/solidus/spree_gateway_bogus_deprecated.rb
+- lib/rubocop/cop/solidus/spree_icon_deprecated.rb
+- lib/rubocop/cop/solidus/spree_refund_call_perform.rb
+- lib/rubocop/cop/solidus/spree_t_deprecated.rb
+- lib/rubocop/cop/solidus_cops.rb
+- lib/rubocop/solidus.rb
+- lib/rubocop/solidus/inject.rb
+- lib/rubocop/solidus/version.rb
+- sig/rubocop/solidus.rbs
+- tasks/changelog.rake
+- tasks/changelog.rb
+- tasks/cut_release.rake
+homepage: https://www.github.com/nebulab/rubocop-solidus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/nebulab/rubocop-solidus
+  source_code_uri: https://www.github.com/nebulab/rubocop-solidus
+  changelog_uri: https://www.github.com/nebulab/rubocop-solidus
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.17
+signing_key:
+specification_version: 4
+summary: Automatic Solidus code style checking tool.
+test_files: []