Class: RuboCop::Cop::RSpecRails::HttpStatus

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/rspec_rails/http_status.rb

Overview

Enforces use of symbolic or numeric value to describe HTTP status.

This cop inspects only ‘have_http_status` calls. So, this cop does not check if a method starting with `be_*` is used when setting for `EnforcedStyle: symbolic` or `EnforcedStyle: numeric`. This cop is also capable of detecting unknown HTTP status codes.

Examples:

‘EnforcedStyle: symbolic` (default)

# bad
it { is_expected.to have_http_status 200 }
it { is_expected.to have_http_status 404 }
it { is_expected.to have_http_status "403" }

# good
it { is_expected.to have_http_status :ok }
it { is_expected.to have_http_status :not_found }
it { is_expected.to have_http_status :forbidden }
it { is_expected.to have_http_status :success }
it { is_expected.to have_http_status :error }

‘EnforcedStyle: numeric`

# bad
it { is_expected.to have_http_status :ok }
it { is_expected.to have_http_status :not_found }
it { is_expected.to have_http_status "forbidden" }

# good
it { is_expected.to have_http_status 200 }
it { is_expected.to have_http_status 404 }
it { is_expected.to have_http_status 403 }
it { is_expected.to have_http_status :success }
it { is_expected.to have_http_status :error }

‘EnforcedStyle: be_status`

# bad
it { is_expected.to have_http_status :ok }
it { is_expected.to have_http_status :not_found }
it { is_expected.to have_http_status "forbidden" }
it { is_expected.to have_http_status 200 }
it { is_expected.to have_http_status 404 }
it { is_expected.to have_http_status "403" }

# good
it { is_expected.to be_ok }
it { is_expected.to be_not_found }
it { is_expected.to have_http_status :success }
it { is_expected.to have_http_status :error }

# bad
it { is_expected.to have_http_status :oki_doki }

# good
it { is_expected.to have_http_status :ok }

Defined Under Namespace

Classes: BeStatusStyleChecker, NumericStyleChecker, StyleCheckerBase, SymbolicStyleChecker

Constant Summary collapse

RESTRICT_ON_SEND = 
i[have_http_status].freeze

Instance Method Summary collapse

Instance Method Details

#http_status(node) ⇒ Object 


73
74
75
 
# File 'lib/rubocop/cop/rspec_rails/http_status.rb', line 73

def_node_matcher :http_status, "(send nil? :have_http_status ${int sym str})\n"

#on_send(node) ⇒ Object

rubocop:disable Metrics/MethodLength


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/rubocop/cop/rspec_rails/http_status.rb', line 77

def on_send(node) # rubocop:disable Metrics/MethodLength
  return unless defined?(::Rack::Utils::SYMBOL_TO_STATUS_CODE)

  http_status(node) do |arg|
    return if arg.str_type? && arg.heredoc?

    checker = checker_class.new(arg)
    return unless checker.offensive?

    add_offense(checker.offense_range,
                message: checker.message) do |corrector|
      next unless checker.autocorrectable?

      corrector.replace(checker.offense_range, checker.prefer)
    end
  end
end