Class: Transpec::Syntax::MethodStub

Inherits:
Transpec::Syntax show all
Includes:
Transpec::Syntax::Mixin::MessagingHost, Transpec::Syntax::Mixin::MonkeyPatchAnyInstance, Util
Defined in:
lib/transpec/syntax/method_stub.rb

Defined Under Namespace

Classes: AllowRecord, DeprecatedMethodRecord, NoMessageAllowanceRecord

Constant Summary collapse

CLASSES_DEFINING_OWN_STUB_METHOD =

rubocop:disable LineLength

[
  'Typhoeus', # https://github.com/typhoeus/typhoeus/blob/6a59c62/lib/typhoeus.rb#L66-L85
  'Excon',    # https://github.com/geemus/excon/blob/6af4f9c/lib/excon.rb#L143-L178
  'Factory'   # https://github.com/thoughtbot/factory_girl/blob/v3.6.2/lib/factory_girl/syntax/vintage.rb#L112
]

Constants included from Util

Util::LITERAL_TYPES, Util::WHITESPACES

Instance Attribute Summary

Attributes inherited from Transpec::Syntax

#node, #report, #runtime_data, #source_rewriter

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Transpec::Syntax::Mixin::MonkeyPatchAnyInstance

#any_instance?

Methods included from Transpec::Syntax::Mixin::MonkeyPatch

#check_syntax_availability, #register_request_of_syntax_availability_inspection, #subject_node, #subject_range

Methods included from Transpec::Syntax::Mixin::Send

#arg_node, #arg_nodes, #arg_range, #args_range, #method_name, #parentheses_range, #range_after_arg, #range_in_between_receiver_and_selector, #range_in_between_selector_and_arg, #receiver_node, #receiver_range, #selector_range

Methods included from Transpec::Syntax::Mixin::NoMessageAllowance

#allow_no_message?, #any_number_of_times?, #at_least_zero?

Methods included from Transpec::Syntax::Mixin::UselessAndReturn

#and_return?, #and_return_node, #and_return_with_block?, #useless_and_return?

Methods included from Util

beginning_of_line_range, block_node_taken_by_method, const_name, contain_here_document?, each_backward_chained_node, each_forward_chained_node, expand_range_to_adjacent_whitespaces, find_consecutive_whitespace_position, first_block_arg_name, here_document?, in_explicit_parentheses?, indentation_of_line, literal?, proc_literal?

Methods inherited from Transpec::Syntax

#expression_range, #initialize, #parent_node, snake_case_name, standalone?, #static_context_inspector, target_node?

Methods included from Collection

#all_syntaxes, #inherited, #require_all, #standalone_syntaxes

Methods included from DynamicAnalysis

#register_request_for_dynamic_analysis

Constructor Details

This class inherits a constructor from Transpec::Syntax

Class Method Details

.conversion_target_node?(node, runtime_data = nil) ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/transpec/syntax/method_stub.rb', line 26

def self.conversion_target_node?(node, runtime_data = nil)
  return false unless check_target_node_statically(node)

  # Check if the method is RSpec's one or not.
  if source_location(node, runtime_data)
    # If we have a source location runtime data, check with it.
    check_target_node_dynamically(node, runtime_data)
  else
    # Otherwise check with a static whitelist.
    receiver_node = node.children.first
    const_name = Util.const_name(receiver_node)
    !CLASSES_DEFINING_OWN_STUB_METHOD.include?(const_name)
  end
end

.dynamic_analysis_target_node?(node) ⇒ Boolean

rubocop:enable LineLength

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/transpec/syntax/method_stub.rb', line 22

def self.dynamic_analysis_target_node?(node)
  target_node?(node)
end

.target_method?(receiver_node, method_name) ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/transpec/syntax/method_stub.rb', line 41

def self.target_method?(receiver_node, method_name)
  !receiver_node.nil? && [:stub, :stub!, :stub_chain, :unstub, :unstub!].include?(method_name)
end

Instance Method Details

#add_receiver_arg_to_any_instance_implementation_block! ⇒ Object 



96
97
98
 
# File 'lib/transpec/syntax/method_stub.rb', line 96

def add_receiver_arg_to_any_instance_implementation_block!
  super && register_record(:any_instance_block)
end

#allow_to_receive_available? ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/transpec/syntax/method_stub.rb', line 53

def allow_to_receive_available?
  check_syntax_availability(__method__)
end

#allowize!(rspec_version) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/transpec/syntax/method_stub.rb', line 61

def allowize!(rspec_version)
  # There's no way of unstubbing in #allow syntax.
  return unless [:stub, :stub!, :stub_chain].include?(method_name)
  return if method_name == :stub_chain && !rspec_version.receive_message_chain_available?

  unless allow_to_receive_available?
    fail ContextError.new(selector_range, "##{method_name}", '#allow')
  end

  source, type = replacement_source_and_conversion_type(rspec_version)
  return unless source

  replace(expression_range, source)

  register_record(type)
end

#convert_deprecated_method! ⇒ Object 



78
79
80
81
82
83
84
 
# File 'lib/transpec/syntax/method_stub.rb', line 78

def convert_deprecated_method!
  return unless replacement_method_for_deprecated_method

  replace(selector_range, replacement_method_for_deprecated_method)

  register_record(:deprecated)
end

#hash_arg? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/transpec/syntax/method_stub.rb', line 57

def hash_arg?
  arg_node.hash_type?
end

#remove_no_message_allowance! ⇒ Object 



86
87
88
89
90
 
# File 'lib/transpec/syntax/method_stub.rb', line 86

def remove_no_message_allowance!
  return unless allow_no_message?
  super
  register_record(:no_message_allowance)
end

#remove_useless_and_return! ⇒ Object 



92
93
94
 
# File 'lib/transpec/syntax/method_stub.rb', line 92

def remove_useless_and_return!
  super && register_record(:useless_and_return)
end