rubocop-solidus 0.1.3 → 0.2.0

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/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,52 @@
 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
+        include IgnoredNode
         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
@@ -50,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.3'
+    VERSION = '0.2.0'
   end
 end

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/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,7 +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'
+  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/cops_documentation.rake

@@ -0,0 +1,322 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'rubocop'
+require 'rubocop-solidus'
+
+YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
+  task.files = ['lib/rubocop/cop/**/*.rb']
+  task.options = ['--no-output']
+end
+
+desc('Generate docs of all cops departments')
+task generate_cops_documentation: :yard_for_generate_documentation do
+  def cops_of_department(cops, department)
+    cops.with_department(department).sort!
+  end
+
+  def cops_body(config, cop, description, examples_objects, pars)
+    content = h2(cop.cop_name)
+    content << required_ruby_version(cop)
+    content << properties(config, cop)
+    content << "#{description}\n"
+    content << examples(examples_objects) if examples_objects.count.positive?
+    content << configurations(pars)
+    content << references(config, cop)
+    content
+  end
+
+  def examples(examples_object)
+    examples_object.each_with_object(h3('Examples').dup) do |example, content|
+      content << h4(example.name) unless example.name == ''
+      content << code_example(example)
+    end
+  end
+
+  def required_ruby_version(cop)
+    return '' unless cop.respond_to?(:required_minimum_ruby_version)
+
+    <<~NOTE
+      !!! Note
+
+          Required Ruby version: #{cop.required_minimum_ruby_version}
+
+    NOTE
+  end
+
+  def properties(config, cop)
+    header = [
+      'Enabled by default', 'Safe', 'Supports autocorrection', 'VersionAdded',
+      'VersionChanged', 'Required Solidus Version'
+    ]
+    config = config.for_cop(cop)
+    safe_auto_correct = config.fetch('SafeAutoCorrect', true)
+    autocorrect = if cop.support_autocorrect?
+                    "Yes #{'(Unsafe)' unless safe_auto_correct}"
+                  else
+                    'No'
+                  end
+    minimum_solidus_version = if cop.respond_to?(:required_minimum_solidus_version)
+                                cop.required_minimum_solidus_version
+                              else
+                                '-'
+                              end
+    content = [[
+      config.fetch('Enabled') ? 'Enabled' : 'Disabled',
+      config.fetch('Safe', true) ? 'Yes' : 'No',
+      autocorrect,
+      config.fetch('VersionAdded', '-'),
+      config.fetch('VersionChanged', '-'),
+      minimum_solidus_version
+    ]]
+    "#{to_table(header, content)}\n"
+  end
+
+  def h2(title)
+    content = +"\n"
+    content << "## #{title}\n"
+    content << "\n"
+    content
+  end
+
+  def h3(title)
+    content = +"\n"
+    content << "### #{title}\n"
+    content << "\n"
+    content
+  end
+
+  def h4(title)
+    content = +"#### #{title}\n"
+    content << "\n"
+    content
+  end
+
+  def code_example(ruby_code)
+    content = +"```ruby\n"
+    content << ruby_code.text
+                        .gsub('@good', '# good').gsub('@bad', '# bad').strip
+    content << "\n```\n"
+    content
+  end
+
+  def configurations(pars)
+    return '' if pars.empty?
+
+    header = ['Name', 'Default value', 'Configurable values']
+    configs = pars.each_key.reject { |key| key.start_with?('Supported') }
+    content = configs.map do |name|
+      configurable = configurable_values(pars, name)
+      default = format_table_value(pars[name])
+      [name, default, configurable]
+    end
+
+    h3('Configurable attributes') + to_table(header, content)
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def configurable_values(pars, name)
+    case name
+    when /^Enforced/
+      supported_style_name = RuboCop::Cop::Util.to_supported_styles(name)
+      format_table_value(pars[supported_style_name])
+    when 'IndentationWidth'
+      'Integer'
+    when 'Database'
+      format_table_value(pars['SupportedDatabases'])
+    else
+      case pars[name]
+      when String
+        'String'
+      when Integer
+        'Integer'
+      when Float
+        'Float'
+      when true, false
+        'Boolean'
+      when Array
+        'Array'
+      else
+        ''
+      end
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+
+  def to_table(header, content)
+    table = [
+      header.join(' | '),
+      Array.new(header.size, '---').join(' | ')
+    ]
+    table.concat(content.map { |c| c.join(' | ') })
+    "#{table.join("\n")}\n"
+  end
+
+  def format_table_value(val)
+    value =
+      case val
+      when Array
+        if val.empty?
+          '`[]`'
+        else
+          val.map { |config| format_table_value(config) }.join(', ')
+        end
+      else
+        "`#{val.nil? ? '<none>' : val}`"
+      end
+    value.gsub("#{Dir.pwd}/", '').rstrip
+  end
+
+  def references(config, cop)
+    cop_config = config.for_cop(cop)
+    urls = RuboCop::Cop::MessageAnnotator.new(
+      config, cop.name, cop_config, {}
+    ).urls
+    return '' if urls.empty?
+
+    content = h3('References')
+    content << urls.map { |url| "* [#{url}](#{url})" }.join("\n")
+    content << "\n"
+    content
+  end
+
+  def print_cops_of_department(cops, department, config)
+    selected_cops = cops_of_department(cops, department).select do |cop|
+      cop.to_s.start_with?('RuboCop::Cop::Solidus')
+    end
+    return if selected_cops.empty?
+
+    content = +"# #{department}\n"
+    selected_cops.each do |cop|
+      content << print_cop_with_doc(cop, config)
+    end
+    file_name = "#{Dir.pwd}/docs/cops_#{department.downcase}.md"
+    File.open(file_name, 'w') do |file|
+      puts "* generated #{file_name}"
+      file.write("#{content.strip}\n")
+    end
+  end
+
+  def print_cop_with_doc(cop, config)
+    t = config.for_cop(cop)
+    non_display_keys = %w[Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
+                          VersionChanged]
+    pars = t.reject { |k| non_display_keys.include?(k) }
+    description = 'No documentation'
+    examples_object = []
+    YARD::Registry.all(:class).detect do |code_object|
+      next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
+
+      description = code_object.docstring unless code_object.docstring.blank?
+      examples_object = code_object.tags('example')
+    end
+    cops_body(config, cop, description, examples_object, pars)
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  def table_of_content_for_department(cops, department)
+    selected_cops = cops_of_department(cops, department.to_sym).select do |cop|
+      cop.to_s.start_with?('RuboCop::Cop::Solidus')
+    end
+    return if selected_cops.empty?
+
+    type_title = department[0].upcase + department[1..]
+    filename = "cops_#{department.downcase}.md"
+    content = +"#### Department [#{type_title}](#{filename})\n\n"
+    selected_cops.each do |cop|
+      anchor = cop.cop_name.sub('/', '').downcase
+      content << "* [#{cop.cop_name}](#{filename}##{anchor})\n"
+    end
+
+    content
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  def print_table_of_contents(cops)
+    path = "#{Dir.pwd}/docs/cops.md"
+    original = File.read(path)
+    content = +"<!-- START_COP_LIST -->\n"
+
+    content << table_contents(cops)
+
+    content << "\n<!-- END_COP_LIST -->"
+
+    unless original.empty?
+      content = original.sub(
+        /<!-- START_COP_LIST -->.+<!-- END_COP_LIST -->/m, content
+      )
+    end
+    File.write(path, content)
+  end
+
+  def table_contents(cops)
+    cops
+      .departments
+      .map(&:to_s)
+      .sort
+      .map { |department| table_of_content_for_department(cops, department) }
+      .compact
+      .join("\n")
+  end
+
+  def assert_docs_synchronized
+    # Do not print diff and yield whether exit code was zero
+    sh('git diff --quiet docs') do |outcome, _|
+      return if outcome
+
+      # Output diff before raising error
+      sh('GIT_PAGER=cat git diff docs')
+
+      warn('The docs directory is out of sync. ' \
+           'Run `rake generate_cops_documentation` and commit the results.')
+      exit!
+    end
+  end
+
+  def main
+    cops   = RuboCop::Cop::Cop.registry
+    config = RuboCop::ConfigLoader.load_file('config/default.yml')
+
+    YARD::Registry.load!
+    cops.departments.sort!.each do |department|
+      print_cops_of_department(cops, department, config)
+    end
+
+    print_table_of_contents(cops)
+
+    assert_docs_synchronized if ENV['CI'] == 'true'
+  ensure
+    RuboCop::ConfigLoader.default_configuration = nil
+  end
+
+  main
+end
+
+desc('Syntax check for the documentation comments')
+task documentation_syntax_check: :yard_for_generate_documentation do
+  require 'parser/ruby27'
+
+  ok = true
+  YARD::Registry.load!
+  cops = RuboCop::Cop::Cop.registry
+  cops.each do |cop|
+    examples = YARD::Registry.all(:class).find do |code_object|
+      next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
+
+      break code_object.tags('example')
+    end
+
+    examples.to_a.each do |example|
+      buffer = Parser::Source::Buffer.new('<code>', 1)
+      buffer.source = example.text
+      parser = Parser::Ruby27.new(RuboCop::AST::Builder.new)
+      parser.diagnostics.all_errors_are_fatal = true
+      parser.parse(buffer)
+    rescue Parser::SyntaxError => e
+      path = example.object.file
+      puts "#{path}: Syntax Error in an example. #{e}"
+      ok = false
+    end
+  end
+  abort unless ok
+end