Class: RrToRspecConverter::TextTransformer

Inherits:
Object
  • Object
show all
Defined in:
lib/rr_to_rspec_converter/text_transformer.rb

Instance Method Summary collapse

Constructor Details

#initialize(content, options = RrToRspecConverter::TextTransformerOptions.new) ⇒ TextTransformer

Returns a new instance of TextTransformer.



7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/rr_to_rspec_converter/text_transformer.rb', line 7

def initialize(content, options = RrToRspecConverter::TextTransformerOptions.new)
  @options = options
  @content = content

  @source_buffer = Parser::Source::Buffer.new('(string)')
  @source_buffer.source = @content

  ast_builder = Astrolabe::Builder.new
  @parser = Parser::CurrentRuby.new(ast_builder)

  @source_rewriter = Parser::Source::TreeRewriter.new(@source_buffer)
end

Instance Method Details

#transform ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/rr_to_rspec_converter/text_transformer.rb', line 20

def transform
  root_node = @parser.parse(@source_buffer)
  unless root_node
    log "Parser saw some unparsable content, skipping...\n\n"
    return @source_rewriter.process
  end

  root_node.each_node(:send) do |node|
    target, verb, action, *args = node.children

    if verb == :with_any_args
      @source_rewriter.replace(node.loc.selector, 'with(any_args)')
    elsif verb == :any_times
      @source_rewriter.replace(node.loc.selector, 'at_least(:once)') if node.parent.children[1] != :times
    elsif verb == :returns
      @source_rewriter.replace(node.loc.selector, 'and_return')
    elsif verb == :times
      if action&.int_type?
        times = action.children[0]
        if times == 1
          @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), '.once')
        elsif times == 2
          @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), '.twice')
        end
      elsif action&.send_type? && action&.children[1] == :any_times
        @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), '.at_least(:once)')
      end
    elsif verb == :at_least && action.int_type?
      times = action.children[0]
      if times == 1
        @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), '.at_least(:once)')
      elsif times == 2
        @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), '.at_least(:twice)')
      else
        @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), ".at_least(#{times}).times")
      end
    elsif verb == :at_most && action.int_type?
      times = action.children[0]
      if times == 1
        @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), '.at_most(:once)')
      elsif times == 2
        @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), '.at_most(:twice)')
      else
        @source_rewriter.replace(range(target.loc.expression.end_pos, node.loc.expression.end_pos), ".at_most(#{times}).times")
      end
    elsif verb == :is_a
      @source_rewriter.replace(node.loc.selector, 'kind_of')
    elsif verb == :numeric
      @source_rewriter.replace(node.loc.selector, 'kind_of(Numeric)')

    # RR::WildcardMatchers::HashIncluding => hash_including
    elsif verb == :new && target.const_type? && target.children.last == :HashIncluding
      range = range(target.loc.expression.begin_pos, node.loc.selector.end_pos)
      @source_rewriter.replace(range, 'hash_including')

    # RR::WildcardMatchers::Satisfy => rr_satsify
    elsif verb == :new && target.const_type? && target.children.last == :Satisfy
      range = range(target.loc.expression.begin_pos, node.loc.selector.end_pos)
      @source_rewriter.replace(range, 'rr_satisfy')

    # rr_satisfy => satisfy
    elsif verb == :rr_satisfy
      @source_rewriter.replace(node.loc.selector, 'satisfy')

    # RR.reset => removed
    elsif verb == :reset && target.const_type? && target.children.last == :RR
      sibling = node.root? ? nil : node.parent.children[node.sibling_index + 1]
      end_pos = sibling ? sibling.loc.expression.begin_pos : node.loc.expression.end_pos
      @source_rewriter.remove(range(node.loc.expression.begin_pos, end_pos))

    # any_instance_of(klass, method: return) => allow_any_instance_of
    # any_instance_of(klass) { block } => allow_any_instance_of / expect_any_instance_of
    elsif verb == :any_instance_of
      class_name = action.loc.expression.source
      if !args.empty?
        stubs = []
        indent = line_indent(node)
        node.each_node(:pair) do |pair|
          method_name = pair.children.first.loc.expression.source.sub(/^:/,'')
          method_result = pair.children.last.loc.expression.source
          stubs << "allow_any_instance_of(#{class_name}).to receive(:#{method_name}).and_return(#{method_result})"
        end

        @source_rewriter.replace(node.loc.expression, stubs.join("\n#{indent}"))
      else # parent is a block type
        begin_node = node.parent.children.last
        begin_node.each_node(:send) do |send_node|
          stub_method = send_node.children[1]
          receive_method = send_node.parent.children[1]
          has_args = !send_node.parent.children[2].nil?
          next unless [:stub, :mock].include?(stub_method)

          expectation = remove_never_node(send_node) ? 'not_to' : 'to'
          expect_method = stub_method == :stub ? 'allow' : 'expect'
          @source_rewriter.replace(range(send_node.parent.loc.expression.begin_pos, send_node.parent.loc.selector.end_pos), "#{expect_method}_any_instance_of(#{class_name}).#{expectation} receive(:#{receive_method})#{has_args ? '.with' : ''}")
        end
        # Remove the any_instance_of
        # If it's a begin block, we have to go a level deeper
        first_statement = begin_node.begin_type? ? begin_node.children.first : begin_node
        last_statement = begin_node.begin_type? ? begin_node.children.last : begin_node
        @source_rewriter.remove(range(node.loc.expression.begin_pos, first_statement.loc.expression.begin_pos)) # start of block
        @source_rewriter.remove(range(last_statement.loc.expression.end_pos, node.parent.loc.expression.end_pos)) # end of block
      end

    # mock => expect().to receive
    elsif verb == :mock
      next if node.each_ancestor(:block).find { |n| n.children[0].children[1] == :any_instance_of }
      if action.nil?
        @source_rewriter.replace(node.loc.selector, 'double')
      else
        expectation = remove_never_node(node) ? 'not_to' : 'to'

        @source_rewriter.replace(node.loc.selector, 'expect')
        method_name = node.parent.loc.selector.source
        has_args = !node.parent.children[2].nil?
        @source_rewriter.replace(node.parent.loc.selector, "#{expectation} receive(:#{method_name})#{has_args ? '.with' : ''}")
      end

    # stub => allow().to receive and double
    elsif verb == :stub
      next if node.each_ancestor(:block).find { |n| n.children[0].children[1] == :any_instance_of }
      if action.nil?
        @source_rewriter.replace(node.loc.selector, 'double')
      else
        @source_rewriter.replace(node.loc.selector, 'allow')
        if node.parent.send_type?
          method_name = node.parent.loc.selector.source
          has_args = !node.parent.children[2].nil?
          @source_rewriter.replace(node.parent.loc.selector, "to receive(:#{method_name})#{has_args ? '.with' : ''}")
        else
          # Stubbing a method on Kernel
          method_name = node.children[2].children[1]
          @source_rewriter.replace(node.loc.expression, "allow(Kernel).to receive(:#{method_name})")
        end
      end

    # dont_allow => expect().not_to receive
    elsif verb == :dont_allow
      @source_rewriter.replace(node.loc.selector, 'expect')
      if args.empty?
        method_name = node.parent.loc.selector.source
        has_args = !node.parent.children[2].nil?
        @source_rewriter.replace(node.parent.loc.selector, "not_to receive(:#{method_name})#{has_args ? '.with' : ''}")
      else
        # dont_allow(object, :method) syntax
        method_name = args.first.children[0]
        @source_rewriter.replace(range(action.loc.expression.end_pos, node.loc.expression.end_pos), ").not_to receive(:#{method_name})")
      end
    end
  end

  @source_rewriter.process
end