rubocop-solidus 0.1.2 → 0.1.4

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

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

@@ -5,6 +5,23 @@ module RuboCop
     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.
+      #
+      # @example
+      #
+      #   # bad
+      #   reimbursement_success_hooks.each { |h| h.call self }
+      #   reimbursement_failed_hooks.each { |h| h.call self }
+      #
+      #   # good
+      #
+      # @example
+      #
+      #   # bad
+      #   reimbursement_success_hooks.any?
+      #   reimbursement_failed_hooks.any?
+      #
+      #   # good
+      #
       class ReimbursementHookDeprecated < Base
         include TargetSolidusVersion
         minimum_solidus_version 2.11

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

@@ -6,6 +6,13 @@ module RuboCop
       # This cop finds Spree::Calculator::FreeShipping calls.
       # This cop is needed as they have been deprecated in future version.
       #
+      # @example
+      #
+      #   # bad
+      #   Spree::Calculator::FreeShipping
+      #
+      #   # good
+      #
       class SpreeCalculatorFreeShippingDeprecated < Base
         MSG = 'Spree::Calculator::FreeShipping is deprecated.'
 

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

@@ -6,10 +6,18 @@ module RuboCop
       # This cop finds Spree::Calculator::PercentPerItem calls.
       # This cop is needed as they have been deprecated in future version.
       #
+      # @example
+      #
+      #   # bad
+      #   Spree::Calculator::PercentPerItem
+      #
+      #   # good
+      #   Spree::Calculator::PercentOnLineItem
+      #
       class SpreeCalculatorPercentPerItemDeprecated < Base
         extend AutoCorrector
 
-        MSG = 'Spree::Calculator::PercentPerItem is deprecated.'
+        MSG = 'Spree::Calculator::PercentPerItem is deprecated. Use Spree::Calculator::PercentOnLineItem instead.'
 
         def_node_matcher :percent_per_item?, <<~PATTERN
           (send (... (... :Calculator) :PercentPerItem) $_)

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

@@ -6,6 +6,13 @@ module RuboCop
       # This cop finds Spree::Calculator::PriceSack calls.
       # This cop is needed as they have been deprecated in future version.
       #
+      # @example
+      #
+      #   # bad
+      #   Spree::Calculator::PriceSack
+      #
+      #   # good
+      #
       class SpreeCalculatorPriceSackDeprecated < Base
         MSG = 'Spree::Calculator::PriceSack is deprecated.'
 

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

@@ -3,16 +3,16 @@
 module RuboCop
   module Cop
     module Solidus
-      # This cop finds user.default_credit_card suggest using user.wallet.default_wallet_payment_source
+      # This cop finds user.default_credit_card suggest using user.wallet.default_wallet_payment_source.
+      #
+      # @example
       #
-      # @example EnforcedStyle:
       #   # bad
       #   user.default_credit_card
       #
       #   # good
       #   user.wallet.default_wallet_payment_source
       #
-      #
       class SpreeDefaultCreditCardDeprecated < Base
         extend AutoCorrector
         include TargetSolidusVersion
@@ -20,7 +20,6 @@ module RuboCop
 
         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

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

@@ -3,29 +3,20 @@
 module RuboCop
   module Cop
     module Solidus
-      # This cop finds Spree::Gateway::Bogus calls and replaces them with the Spree::PaymentMethod::BogusCreditCard call
+      # 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.
       #
-      # @example EnforcedStyle:
+      # @example
       #   # 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.new
+      #   Spree::PaymentMethod::BogusCreditCard.create
       #   Spree::PaymentMethod::BogusCreditCard.create!
       #
-      #
       class SpreeGatewayBogusDeprecated < Base
         extend AutoCorrector
         include TargetSolidusVersion
@@ -33,7 +24,6 @@ module RuboCop
 
         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

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

@@ -3,16 +3,16 @@
 module RuboCop
   module Cop
     module Solidus
-      # This cop finds icon helper calls and suggest using solidus_icon
+      # This cop finds icon helper calls and suggest using solidus_icon.
+      #
+      # @example
       #
-      # @example EnforcedStyle:
       #   # bad
       #   helper.icon('example')
       #
       #   # good
       #   helper.solidus_icon('example')
       #
-      #
       class SpreeIconDeprecated < Base
         extend AutoCorrector
         include TargetSolidusVersion

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

@@ -4,7 +4,15 @@ 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
+      # replaces them with the Spree::Refund.create(your: attributes, perform_after_create: false).perform! call.
+      #
+      # @example
+      #
+      #   # bad
+      #   Spree::Refund.create(your: attributes)
+      #
+      #   # good
+      #   Spree::Refund.create(your: attributes, perform_after_create: false).perform!
       #
       class SpreeRefundCallPerform < Base
         include TargetSolidusVersion
@@ -16,7 +24,6 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[create].freeze
 
-        # @!method bad_method?(node)
         def_node_matcher :create_refund?, <<~PATTERN
           (send (const (const nil? :Spree) :Refund) :create ...)
         PATTERN

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

@@ -3,43 +3,51 @@
 module RuboCop
   module Cop
     module Solidus
-      # This cop finds Spree.t method calls and replaces them with the I18n,t method call
+      # 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
+      #   # Without any parameters
       #
-      # @example EnforcedStyle: bar (default)
       #   # bad
       #   Spree.t(:bar)
       #
       #   # good
       #   I18n.t(:bar, scope: :spree)
       #
+      # @example
+      #   # With the scope parameter
+      #
       #   # bad
       #   Spree.t(:bar, scope: [:city])
       #
       #   # good
       #   I18n.t(:bar, scope: [:spree, :city])
       #
+      # @example
+      #   # With the scope and other parameters
+      #
       #   # bad
       #   Spree.t(:bar, scope: [:city], email: email)
       #
       #   # good
       #   I18n.t(:bar, scope: [:spree, :city], email: email)
       #
+      # @example
+      #   # With the scope parameter as a string
+      #
       #   # 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

data/lib/rubocop/solidus/version.rb

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

data/relnotes/v0.1.2.md

@@ -1,5 +1,5 @@
 ### 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][])
 
 [@MassimilianoLattanzio]: https://github.com/MassimilianoLattanzio

data/relnotes/v0.1.3.md

@@ -0,0 +1,9 @@
+### 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][])
+
+[@MassimilianoLattanzio]: https://github.com/MassimilianoLattanzio

data/relnotes/v0.1.4.md

@@ -0,0 +1,5 @@
+### New features
+
+* [#51](https://github.com/solidusio/rubocop-solidus/pull/51): Create automatic documentation based on the cop's descriptions. ([@MassimilianoLattanzio][])
+
+[@MassimilianoLattanzio]: https://github.com/MassimilianoLattanzio

data/rubocop-solidus.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop/solidus/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rubocop-solidus'
+  spec.version = RuboCop::Solidus::VERSION
+  spec.authors = ['piyushswain']
+  spec.email = ['piyush.swain3@gmail.com']
+
+  spec.summary = 'Automatic Solidus code style checking tool.'
+  spec.description = <<~DESCRIPTION
+    Automatic Solidus code style checking tool.
+    A RuboCop extension focused on enforcing Solidus best practices and coding conventions.
+  DESCRIPTION
+  spec.homepage = 'https://www.github.com/solidusio/rubocop-solidus'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  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'
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_runtime_dependency 'rubocop'
+end

data/tasks/changelog.rb

@@ -9,7 +9,7 @@ class Changelog
   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'
+  REF_URL = 'https://github.com/solidusio/rubocop-solidus'
   MAX_LENGTH = 40
   CONTRIBUTOR = '[@%<user>s]: https://github.com/%<user>s'
   SIGNATURE = Regexp.new(format(Regexp.escape('[@%<user>s][]'), user: '([\w-]+)'))
@@ -64,8 +64,8 @@ class Changelog
     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 = `git config --global user.username`.chomp
+      warn 'Set your username with `git config --global user.username "myusernamehere"`' if user.empty?
 
       user
     end