Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(369)

Side by Side Diff: tools/telemetry/third_party/rope/ropetest/refactor/extracttest.py

Issue 1132103009: Example of refactoring using rope library. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 try:
2 import unittest2 as unittest
3 except ImportError:
4 import unittest
5
6 import rope.base.codeanalyze
7 import rope.base.exceptions
8 from rope.refactor import extract
9 from ropetest import testutils
10
11
12 class ExtractMethodTest(unittest.TestCase):
13
14 def setUp(self):
15 super(ExtractMethodTest, self).setUp()
16 self.project = testutils.sample_project()
17 self.pycore = self.project.pycore
18
19 def tearDown(self):
20 testutils.remove_project(self.project)
21 super(ExtractMethodTest, self).tearDown()
22
23 def do_extract_method(self, source_code, start, end, extracted, **kwds):
24 testmod = testutils.create_module(self.project, 'testmod')
25 testmod.write(source_code)
26 extractor = extract.ExtractMethod(
27 self.project, testmod, start, end)
28 self.project.do(extractor.get_changes(extracted, **kwds))
29 return testmod.read()
30
31 def do_extract_variable(self, source_code, start, end, extracted, **kwds):
32 testmod = testutils.create_module(self.project, 'testmod')
33 testmod.write(source_code)
34 extractor = extract.ExtractVariable(self.project, testmod, start, end)
35 self.project.do(extractor.get_changes(extracted, **kwds))
36 return testmod.read()
37
38 def _convert_line_range_to_offset(self, code, start, end):
39 lines = rope.base.codeanalyze.SourceLinesAdapter(code)
40 return lines.get_line_start(start), lines.get_line_end(end)
41
42 def test_simple_extract_function(self):
43 code = "def a_func():\n print('one')\n print('two')\n"
44 start, end = self._convert_line_range_to_offset(code, 2, 2)
45 refactored = self.do_extract_method(code, start, end, 'extracted')
46 expected = "def a_func():\n extracted()\n print('two')\n\n" \
47 "def extracted():\n print('one')\n"
48 self.assertEquals(expected, refactored)
49
50 def test_extract_function_at_the_end_of_file(self):
51 code = "def a_func():\n print('one')"
52 start, end = self._convert_line_range_to_offset(code, 2, 2)
53 refactored = self.do_extract_method(code, start, end, 'extracted')
54 expected = "def a_func():\n extracted()\n" \
55 "def extracted():\n print('one')\n"
56 self.assertEquals(expected, refactored)
57
58 def test_extract_function_after_scope(self):
59 code = "def a_func():\n print('one')\n print('two')" \
60 "\n\nprint('hey')\n"
61 start, end = self._convert_line_range_to_offset(code, 2, 2)
62 refactored = self.do_extract_method(code, start, end, 'extracted')
63 expected = "def a_func():\n extracted()\n print('two')\n\n" \
64 "def extracted():\n print('one')\n\nprint('hey')\n"
65 self.assertEquals(expected, refactored)
66
67 def test_simple_extract_function_with_parameter(self):
68 code = "def a_func():\n a_var = 10\n print(a_var)\n"
69 start, end = self._convert_line_range_to_offset(code, 3, 3)
70 refactored = self.do_extract_method(code, start, end, 'new_func')
71 expected = "def a_func():\n a_var = 10\n new_func(a_var)\n\n" \
72 "def new_func(a_var):\n print(a_var)\n"
73 self.assertEquals(expected, refactored)
74
75 def test_not_unread_variables_as_parameter(self):
76 code = "def a_func():\n a_var = 10\n print('hey')\n"
77 start, end = self._convert_line_range_to_offset(code, 3, 3)
78 refactored = self.do_extract_method(code, start, end, 'new_func')
79 expected = "def a_func():\n a_var = 10\n new_func()\n\n" \
80 "def new_func():\n print('hey')\n"
81 self.assertEquals(expected, refactored)
82
83 def test_simple_extract_function_with_two_parameter(self):
84 code = 'def a_func():\n a_var = 10\n another_var = 20\n' \
85 ' third_var = a_var + another_var\n'
86 start, end = self._convert_line_range_to_offset(code, 4, 4)
87 refactored = self.do_extract_method(code, start, end, 'new_func')
88 expected = 'def a_func():\n a_var = 10\n another_var = 20\n' \
89 ' new_func(a_var, another_var)\n\n' \
90 'def new_func(a_var, another_var):\n' \
91 ' third_var = a_var + another_var\n'
92 self.assertEquals(expected, refactored)
93
94 def test_simple_extract_function_with_return_value(self):
95 code = 'def a_func():\n a_var = 10\n print(a_var)\n'
96 start, end = self._convert_line_range_to_offset(code, 2, 2)
97 refactored = self.do_extract_method(code, start, end, 'new_func')
98 expected = 'def a_func():\n a_var = new_func()' \
99 '\n print(a_var)\n\n' \
100 'def new_func():\n a_var = 10\n return a_var\n'
101 self.assertEquals(expected, refactored)
102
103 def test_extract_function_with_multiple_return_values(self):
104 code = 'def a_func():\n a_var = 10\n another_var = 20\n' \
105 ' third_var = a_var + another_var\n'
106 start, end = self._convert_line_range_to_offset(code, 2, 3)
107 refactored = self.do_extract_method(code, start, end, 'new_func')
108 expected = 'def a_func():\n a_var, another_var = new_func()\n' \
109 ' third_var = a_var + another_var\n\n' \
110 'def new_func():\n a_var = 10\n another_var = 20\n' \
111 ' return a_var, another_var\n'
112 self.assertEquals(expected, refactored)
113
114 def test_simple_extract_method(self):
115 code = 'class AClass(object):\n\n' \
116 ' def a_func(self):\n print(1)\n print(2)\n'
117 start, end = self._convert_line_range_to_offset(code, 4, 4)
118 refactored = self.do_extract_method(code, start, end, 'new_func')
119 expected = 'class AClass(object):\n\n' \
120 ' def a_func(self):\n' \
121 ' self.new_func()\n' \
122 ' print(2)\n\n' \
123 ' def new_func(self):\n print(1)\n'
124 self.assertEquals(expected, refactored)
125
126 def test_extract_method_with_args_and_returns(self):
127 code = 'class AClass(object):\n' \
128 ' def a_func(self):\n' \
129 ' a_var = 10\n' \
130 ' another_var = a_var * 3\n' \
131 ' third_var = a_var + another_var\n'
132 start, end = self._convert_line_range_to_offset(code, 4, 4)
133 refactored = self.do_extract_method(code, start, end, 'new_func')
134 expected = 'class AClass(object):\n' \
135 ' def a_func(self):\n' \
136 ' a_var = 10\n' \
137 ' another_var = self.new_func(a_var)\n' \
138 ' third_var = a_var + another_var\n\n' \
139 ' def new_func(self, a_var):\n' \
140 ' another_var = a_var * 3\n' \
141 ' return another_var\n'
142 self.assertEquals(expected, refactored)
143
144 def test_extract_method_with_self_as_argument(self):
145 code = 'class AClass(object):\n' \
146 ' def a_func(self):\n' \
147 ' print(self)\n'
148 start, end = self._convert_line_range_to_offset(code, 3, 3)
149 refactored = self.do_extract_method(code, start, end, 'new_func')
150 expected = 'class AClass(object):\n' \
151 ' def a_func(self):\n' \
152 ' self.new_func()\n\n' \
153 ' def new_func(self):\n' \
154 ' print(self)\n'
155 self.assertEquals(expected, refactored)
156
157 def test_extract_method_with_no_self_as_argument(self):
158 code = 'class AClass(object):\n' \
159 ' def a_func():\n' \
160 ' print(1)\n'
161 start, end = self._convert_line_range_to_offset(code, 3, 3)
162 with self.assertRaises(rope.base.exceptions.RefactoringError):
163 self.do_extract_method(code, start, end, 'new_func')
164
165 def test_extract_method_with_multiple_methods(self):
166 code = 'class AClass(object):\n' \
167 ' def a_func(self):\n' \
168 ' print(self)\n\n' \
169 ' def another_func(self):\n' \
170 ' pass\n'
171 start, end = self._convert_line_range_to_offset(code, 3, 3)
172 refactored = self.do_extract_method(code, start, end, 'new_func')
173 expected = 'class AClass(object):\n' \
174 ' def a_func(self):\n' \
175 ' self.new_func()\n\n' \
176 ' def new_func(self):\n' \
177 ' print(self)\n\n' \
178 ' def another_func(self):\n' \
179 ' pass\n'
180 self.assertEquals(expected, refactored)
181
182 def test_extract_function_with_function_returns(self):
183 code = 'def a_func():\n def inner_func():\n pass\n' \
184 ' inner_func()\n'
185 start, end = self._convert_line_range_to_offset(code, 2, 3)
186 refactored = self.do_extract_method(code, start, end, 'new_func')
187 expected = 'def a_func():\n' \
188 ' inner_func = new_func()\n inner_func()\n\n' \
189 'def new_func():\n' \
190 ' def inner_func():\n pass\n' \
191 ' return inner_func\n'
192 self.assertEquals(expected, refactored)
193
194 def test_simple_extract_global_function(self):
195 code = "print('one')\nprint('two')\nprint('three')\n"
196 start, end = self._convert_line_range_to_offset(code, 2, 2)
197 refactored = self.do_extract_method(code, start, end, 'new_func')
198 expected = "print('one')\n\ndef new_func():\n print('two')\n" \
199 "\nnew_func()\nprint('three')\n"
200 self.assertEquals(expected, refactored)
201
202 def test_extract_global_function_inside_ifs(self):
203 code = 'if True:\n a = 10\n'
204 start, end = self._convert_line_range_to_offset(code, 2, 2)
205 refactored = self.do_extract_method(code, start, end, 'new_func')
206 expected = '\ndef new_func():\n a = 10\n\nif True:\n' \
207 ' new_func()\n'
208 self.assertEquals(expected, refactored)
209
210 def test_extract_function_while_inner_function_reads(self):
211 code = 'def a_func():\n a_var = 10\n' \
212 ' def inner_func():\n print(a_var)\n' \
213 ' return inner_func\n'
214 start, end = self._convert_line_range_to_offset(code, 3, 4)
215 refactored = self.do_extract_method(code, start, end, 'new_func')
216 expected = 'def a_func():\n a_var = 10\n' \
217 ' inner_func = new_func(a_var)' \
218 '\n return inner_func\n\n' \
219 'def new_func(a_var):\n' \
220 ' def inner_func():\n print(a_var)\n' \
221 ' return inner_func\n'
222 self.assertEquals(expected, refactored)
223
224 def test_extract_method_bad_range(self):
225 code = "def a_func():\n pass\na_var = 10\n"
226 start, end = self._convert_line_range_to_offset(code, 2, 3)
227 with self.assertRaises(rope.base.exceptions.RefactoringError):
228 self.do_extract_method(code, start, end, 'new_func')
229
230 def test_extract_method_bad_range2(self):
231 code = "class AClass(object):\n pass\n"
232 start, end = self._convert_line_range_to_offset(code, 1, 1)
233 with self.assertRaises(rope.base.exceptions.RefactoringError):
234 self.do_extract_method(code, start, end, 'new_func')
235
236 def test_extract_method_containing_return(self):
237 code = 'def a_func(arg):\n if arg:\n return arg * 2' \
238 '\n return 1'
239 start, end = self._convert_line_range_to_offset(code, 2, 4)
240 with self.assertRaises(rope.base.exceptions.RefactoringError):
241 self.do_extract_method(code, start, end, 'new_func')
242
243 def test_extract_method_containing_yield(self):
244 code = "def a_func(arg):\n yield arg * 2\n"
245 start, end = self._convert_line_range_to_offset(code, 2, 2)
246 with self.assertRaises(rope.base.exceptions.RefactoringError):
247 self.do_extract_method(code, start, end, 'new_func')
248
249 def test_extract_method_containing_uncomplete_lines(self):
250 code = 'a_var = 20\nanother_var = 30\n'
251 start = code.index('20')
252 end = code.index('30') + 2
253 with self.assertRaises(rope.base.exceptions.RefactoringError):
254 self.do_extract_method(code, start, end, 'new_func')
255
256 def test_extract_method_containing_uncomplete_lines2(self):
257 code = 'a_var = 20\nanother_var = 30\n'
258 start = code.index('20')
259 end = code.index('another') + 5
260 with self.assertRaises(rope.base.exceptions.RefactoringError):
261 self.do_extract_method(code, start, end, 'new_func')
262
263 def test_extract_function_and_argument_as_paramenter(self):
264 code = 'def a_func(arg):\n print(arg)\n'
265 start, end = self._convert_line_range_to_offset(code, 2, 2)
266 refactored = self.do_extract_method(code, start, end, 'new_func')
267 expected = 'def a_func(arg):\n new_func(arg)\n\n' \
268 'def new_func(arg):\n print(arg)\n'
269 self.assertEquals(expected, refactored)
270
271 def test_extract_function_and_end_as_the_start_of_a_line(self):
272 code = 'print("hey")\nif True:\n pass\n'
273 start = 0
274 end = code.index('\n') + 1
275 refactored = self.do_extract_method(code, start, end, 'new_func')
276 expected = '\ndef new_func():\n print("hey")\n\n' \
277 'new_func()\nif True:\n pass\n'
278 self.assertEquals(expected, refactored)
279
280 def test_extract_function_and_indented_blocks(self):
281 code = 'def a_func(arg):\n if True:\n' \
282 ' if True:\n print(arg)\n'
283 start, end = self._convert_line_range_to_offset(code, 3, 4)
284 refactored = self.do_extract_method(code, start, end, 'new_func')
285 expected = 'def a_func(arg):\n ' \
286 'if True:\n new_func(arg)\n\n' \
287 'def new_func(arg):\n if True:\n print(arg)\n'
288 self.assertEquals(expected, refactored)
289
290 def test_extract_method_and_multi_line_headers(self):
291 code = 'def a_func(\n arg):\n print(arg)\n'
292 start, end = self._convert_line_range_to_offset(code, 3, 3)
293 refactored = self.do_extract_method(code, start, end, 'new_func')
294 expected = 'def a_func(\n arg):\n new_func(arg)\n\n' \
295 'def new_func(arg):\n print(arg)\n'
296 self.assertEquals(expected, refactored)
297
298 def test_single_line_extract_function(self):
299 code = 'a_var = 10 + 20\n'
300 start = code.index('10')
301 end = code.index('20') + 2
302 refactored = self.do_extract_method(code, start, end, 'new_func')
303 expected = "\ndef new_func():\n " \
304 "return 10 + 20\n\na_var = new_func()\n"
305 self.assertEquals(expected, refactored)
306
307 def test_single_line_extract_function2(self):
308 code = 'def a_func():\n a = 10\n b = a * 20\n'
309 start = code.rindex('a')
310 end = code.index('20') + 2
311 refactored = self.do_extract_method(code, start, end, 'new_func')
312 expected = 'def a_func():\n a = 10\n b = new_func(a)\n' \
313 '\ndef new_func(a):\n return a * 20\n'
314 self.assertEquals(expected, refactored)
315
316 def test_single_line_extract_method_and_logical_lines(self):
317 code = 'a_var = 10 +\\\n 20\n'
318 start = code.index('10')
319 end = code.index('20') + 2
320 refactored = self.do_extract_method(code, start, end, 'new_func')
321 expected = '\ndef new_func():\n ' \
322 'return 10 + 20\n\na_var = new_func()\n'
323 self.assertEquals(expected, refactored)
324
325 def test_single_line_extract_method_and_logical_lines2(self):
326 code = 'a_var = (10,\\\n 20)\n'
327 start = code.index('10') - 1
328 end = code.index('20') + 3
329 refactored = self.do_extract_method(code, start, end, 'new_func')
330 expected = '\ndef new_func():\n' \
331 ' return (10, 20)\n\na_var = new_func()\n'
332 self.assertEquals(expected, refactored)
333
334 def test_single_line_extract_method(self):
335 code = "class AClass(object):\n\n" \
336 " def a_func(self):\n a = 10\n b = a * a\n"
337 start = code.rindex('=') + 2
338 end = code.rindex('a') + 1
339 refactored = self.do_extract_method(code, start, end, 'new_func')
340 expected = 'class AClass(object):\n\n' \
341 ' def a_func(self):\n' \
342 ' a = 10\n b = self.new_func(a)\n\n' \
343 ' def new_func(self, a):\n return a * a\n'
344 self.assertEquals(expected, refactored)
345
346 def test_single_line_extract_function_if_condition(self):
347 code = 'if True:\n pass\n'
348 start = code.index('True')
349 end = code.index('True') + 4
350 refactored = self.do_extract_method(code, start, end, 'new_func')
351 expected = "\ndef new_func():\n return True\n\nif new_func():" \
352 "\n pass\n"
353 self.assertEquals(expected, refactored)
354
355 def test_unneeded_params(self):
356 code = 'class A(object):\n ' \
357 'def a_func(self):\n a_var = 10\n a_var += 2\n'
358 start = code.rindex('2')
359 end = code.rindex('2') + 1
360 refactored = self.do_extract_method(code, start, end, 'new_func')
361 expected = 'class A(object):\n' \
362 ' def a_func(self):\n a_var = 10\n' \
363 ' a_var += self.new_func()\n\n' \
364 ' def new_func(self):\n return 2\n'
365 self.assertEquals(expected, refactored)
366
367 def test_breaks_and_continues_inside_loops(self):
368 code = 'def a_func():\n for i in range(10):\n continue\n'
369 start = code.index('for')
370 end = len(code) - 1
371 refactored = self.do_extract_method(code, start, end, 'new_func')
372 expected = 'def a_func():\n new_func()\n\n' \
373 'def new_func():\n' \
374 ' for i in range(10):\n continue\n'
375 self.assertEquals(expected, refactored)
376
377 def test_breaks_and_continues_outside_loops(self):
378 code = 'def a_func():\n' \
379 ' for i in range(10):\n a = i\n continue\n'
380 start = code.index('a = i')
381 end = len(code) - 1
382 with self.assertRaises(rope.base.exceptions.RefactoringError):
383 self.do_extract_method(code, start, end, 'new_func')
384
385 def test_variable_writes_followed_by_variable_reads_after_extraction(self):
386 code = 'def a_func():\n a = 1\n a = 2\n b = a\n'
387 start = code.index('a = 1')
388 end = code.index('a = 2') - 1
389 refactored = self.do_extract_method(code, start, end, 'new_func')
390 expected = 'def a_func():\n new_func()\n a = 2\n b = a\n\n' \
391 'def new_func():\n a = 1\n'
392 self.assertEquals(expected, refactored)
393
394 def test_var_writes_followed_by_var_reads_inside_extraction(self):
395 code = 'def a_func():\n a = 1\n a = 2\n b = a\n'
396 start = code.index('a = 2')
397 end = len(code) - 1
398 refactored = self.do_extract_method(code, start, end, 'new_func')
399 expected = 'def a_func():\n a = 1\n new_func()\n\n' \
400 'def new_func():\n a = 2\n b = a\n'
401 self.assertEquals(expected, refactored)
402
403 def test_extract_variable(self):
404 code = 'a_var = 10 + 20\n'
405 start = code.index('10')
406 end = code.index('20') + 2
407 refactored = self.do_extract_variable(code, start, end, 'new_var')
408 expected = 'new_var = 10 + 20\na_var = new_var\n'
409 self.assertEquals(expected, refactored)
410
411 def test_extract_variable_multiple_lines(self):
412 code = 'a = 1\nb = 2\n'
413 start = code.index('1')
414 end = code.index('1') + 1
415 refactored = self.do_extract_variable(code, start, end, 'c')
416 expected = 'c = 1\na = c\nb = 2\n'
417 self.assertEquals(expected, refactored)
418
419 def test_extract_variable_in_the_middle_of_statements(self):
420 code = 'a = 1 + 2\n'
421 start = code.index('1')
422 end = code.index('1') + 1
423 refactored = self.do_extract_variable(code, start, end, 'c')
424 expected = 'c = 1\na = c + 2\n'
425 self.assertEquals(expected, refactored)
426
427 def test_extract_variable_for_a_tuple(self):
428 code = 'a = 1, 2\n'
429 start = code.index('1')
430 end = code.index('2') + 1
431 refactored = self.do_extract_variable(code, start, end, 'c')
432 expected = 'c = 1, 2\na = c\n'
433 self.assertEquals(expected, refactored)
434
435 def test_extract_variable_for_a_string(self):
436 code = 'def a_func():\n a = "hey!"\n'
437 start = code.index('"')
438 end = code.rindex('"') + 1
439 refactored = self.do_extract_variable(code, start, end, 'c')
440 expected = 'def a_func():\n c = "hey!"\n a = c\n'
441 self.assertEquals(expected, refactored)
442
443 def test_extract_variable_inside_ifs(self):
444 code = 'if True:\n a = 1 + 2\n'
445 start = code.index('1')
446 end = code.rindex('2') + 1
447 refactored = self.do_extract_variable(code, start, end, 'b')
448 expected = 'if True:\n b = 1 + 2\n a = b\n'
449 self.assertEquals(expected, refactored)
450
451 def test_extract_variable_inside_ifs_and_logical_lines(self):
452 code = 'if True:\n a = (3 + \n(1 + 2))\n'
453 start = code.index('1')
454 end = code.index('2') + 1
455 refactored = self.do_extract_variable(code, start, end, 'b')
456 expected = 'if True:\n b = 1 + 2\n a = (3 + \n(b))\n'
457 self.assertEquals(expected, refactored)
458
459 # TODO: Handle when extracting a subexpression
460 def xxx_test_extract_variable_for_a_subexpression(self):
461 code = 'a = 3 + 1 + 2\n'
462 start = code.index('1')
463 end = code.index('2') + 1
464 refactored = self.do_extract_variable(code, start, end, 'b')
465 expected = 'b = 1 + 2\na = 3 + b\n'
466 self.assertEquals(expected, refactored)
467
468 def test_extract_variable_starting_from_the_start_of_the_line(self):
469 code = 'a_dict = {1: 1}\na_dict.values().count(1)\n'
470 start = code.rindex('a_dict')
471 end = code.index('count') - 1
472 refactored = self.do_extract_variable(code, start, end, 'values')
473 expected = 'a_dict = {1: 1}\n' \
474 'values = a_dict.values()\nvalues.count(1)\n'
475 self.assertEquals(expected, refactored)
476
477 def test_extract_variable_on_the_last_line_of_a_function(self):
478 code = 'def f():\n a_var = {}\n a_var.keys()\n'
479 start = code.rindex('a_var')
480 end = code.index('.keys')
481 refactored = self.do_extract_variable(code, start, end, 'new_var')
482 expected = 'def f():\n a_var = {}\n ' \
483 'new_var = a_var\n new_var.keys()\n'
484 self.assertEquals(expected, refactored)
485
486 def test_extract_variable_on_the_indented_function_statement(self):
487 code = 'def f():\n if True:\n a_var = 1 + 2\n'
488 start = code.index('1')
489 end = code.index('2') + 1
490 refactored = self.do_extract_variable(code, start, end, 'new_var')
491 expected = 'def f():\n if True:\n' \
492 ' new_var = 1 + 2\n a_var = new_var\n'
493 self.assertEquals(expected, refactored)
494
495 def test_extract_method_on_the_last_line_of_a_function(self):
496 code = 'def f():\n a_var = {}\n a_var.keys()\n'
497 start = code.rindex('a_var')
498 end = code.index('.keys')
499 refactored = self.do_extract_method(code, start, end, 'new_f')
500 expected = 'def f():\n a_var = {}\n new_f(a_var).keys()\n\n' \
501 'def new_f(a_var):\n return a_var\n'
502 self.assertEquals(expected, refactored)
503
504 def test_raising_exception_when_on_incomplete_variables(self):
505 code = 'a_var = 10 + 20\n'
506 start = code.index('10') + 1
507 end = code.index('20') + 2
508 with self.assertRaises(rope.base.exceptions.RefactoringError):
509 self.do_extract_method(code, start, end, 'new_func')
510
511 def test_raising_exception_when_on_incomplete_variables_on_end(self):
512 code = 'a_var = 10 + 20\n'
513 start = code.index('10')
514 end = code.index('20') + 1
515 with self.assertRaises(rope.base.exceptions.RefactoringError):
516 self.do_extract_method(code, start, end, 'new_func')
517
518 def test_raising_exception_on_bad_parens(self):
519 code = 'a_var = (10 + 20) + 30\n'
520 start = code.index('20')
521 end = code.index('30') + 2
522 with self.assertRaises(rope.base.exceptions.RefactoringError):
523 self.do_extract_method(code, start, end, 'new_func')
524
525 def test_raising_exception_on_bad_operators(self):
526 code = 'a_var = 10 + 20 + 30\n'
527 start = code.index('10')
528 end = code.rindex('+') + 1
529 with self.assertRaises(rope.base.exceptions.RefactoringError):
530 self.do_extract_method(code, start, end, 'new_func')
531
532 # FIXME: Extract method should be more intelligent about bad ranges
533 def xxx_test_raising_exception_on_function_parens(self):
534 code = 'a = range(10)'
535 start = code.index('(')
536 end = code.rindex(')') + 1
537 with self.assertRaises(rope.base.exceptions.RefactoringError):
538 self.do_extract_method(code, start, end, 'new_func')
539
540 def test_extract_method_and_extra_blank_lines(self):
541 code = '\nprint(1)\n'
542 refactored = self.do_extract_method(code, 0, len(code), 'new_f')
543 expected = '\n\ndef new_f():\n print(1)\n\nnew_f()\n'
544 self.assertEquals(expected, refactored)
545
546 def test_variable_writes_in_the_same_line_as_variable_read(self):
547 code = 'a = 1\na = 1 + a\n'
548 start = code.index('\n') + 1
549 end = len(code)
550 refactored = self.do_extract_method(code, start, end, 'new_f',
551 global_=True)
552 expected = 'a = 1\n\ndef new_f(a):\n a = 1 + a\n\nnew_f(a)\n'
553 self.assertEquals(expected, refactored)
554
555 def test_variable_writes_in_the_same_line_as_variable_read2(self):
556 code = 'a = 1\na += 1\n'
557 start = code.index('\n') + 1
558 end = len(code)
559 refactored = self.do_extract_method(code, start, end, 'new_f',
560 global_=True)
561 expected = 'a = 1\n\ndef new_f():\n a += 1\n\nnew_f()\n'
562 self.assertEquals(expected, refactored)
563
564 def test_variable_and_similar_expressions(self):
565 code = 'a = 1\nb = 1\n'
566 start = code.index('1')
567 end = start + 1
568 refactored = self.do_extract_variable(code, start, end,
569 'one', similar=True)
570 expected = 'one = 1\na = one\nb = one\n'
571 self.assertEquals(expected, refactored)
572
573 def test_definition_should_appear_before_the_first_use(self):
574 code = 'a = 1\nb = 1\n'
575 start = code.rindex('1')
576 end = start + 1
577 refactored = self.do_extract_variable(code, start, end,
578 'one', similar=True)
579 expected = 'one = 1\na = one\nb = one\n'
580 self.assertEquals(expected, refactored)
581
582 def test_extract_method_and_similar_expressions(self):
583 code = 'a = 1\nb = 1\n'
584 start = code.index('1')
585 end = start + 1
586 refactored = self.do_extract_method(code, start, end,
587 'one', similar=True)
588 expected = '\ndef one():\n return 1\n\na = one()\nb = one()\n'
589 self.assertEquals(expected, refactored)
590
591 def test_simple_extract_method_and_similar_statements(self):
592 code = 'class AClass(object):\n\n' \
593 ' def func1(self):\n a = 1 + 2\n b = a\n' \
594 ' def func2(self):\n a = 1 + 2\n b = a\n'
595 start, end = self._convert_line_range_to_offset(code, 4, 4)
596 refactored = self.do_extract_method(code, start, end,
597 'new_func', similar=True)
598 expected = 'class AClass(object):\n\n' \
599 ' def func1(self):\n' \
600 ' a = self.new_func()\n b = a\n\n' \
601 ' def new_func(self):\n' \
602 ' a = 1 + 2\n return a\n' \
603 ' def func2(self):\n' \
604 ' a = self.new_func()\n b = a\n'
605 self.assertEquals(expected, refactored)
606
607 def test_extract_method_and_similar_statements2(self):
608 code = 'class AClass(object):\n\n' \
609 ' def func1(self, p1):\n a = p1 + 2\n' \
610 ' def func2(self, p2):\n a = p2 + 2\n'
611 start = code.rindex('p1')
612 end = code.index('2\n') + 1
613 refactored = self.do_extract_method(code, start, end,
614 'new_func', similar=True)
615 expected = 'class AClass(object):\n\n' \
616 ' def func1(self, p1):\n ' \
617 'a = self.new_func(p1)\n\n' \
618 ' def new_func(self, p1):\n return p1 + 2\n' \
619 ' def func2(self, p2):\n a = self.new_func(p2)\n'
620 self.assertEquals(expected, refactored)
621
622 def test_extract_method_and_similar_sttemnts_return_is_different(self):
623 code = 'class AClass(object):\n\n' \
624 ' def func1(self, p1):\n a = p1 + 2\n' \
625 ' def func2(self, p2):\n self.attr = p2 + 2\n'
626 start = code.rindex('p1')
627 end = code.index('2\n') + 1
628 refactored = self.do_extract_method(code, start, end,
629 'new_func', similar=True)
630 expected = 'class AClass(object):\n\n' \
631 ' def func1(self, p1):' \
632 '\n a = self.new_func(p1)\n\n' \
633 ' def new_func(self, p1):\n return p1 + 2\n' \
634 ' def func2(self, p2):\n' \
635 ' self.attr = self.new_func(p2)\n'
636 self.assertEquals(expected, refactored)
637
638 def test_definition_should_appear_where_it_is_visible(self):
639 code = 'if True:\n a = 1\nelse:\n b = 1\n'
640 start = code.rindex('1')
641 end = start + 1
642 refactored = self.do_extract_variable(code, start, end,
643 'one', similar=True)
644 expected = 'one = 1\nif True:\n a = one\nelse:\n b = one\n'
645 self.assertEquals(expected, refactored)
646
647 def test_extract_variable_and_similar_statements_in_classes(self):
648 code = 'class AClass(object):\n\n' \
649 ' def func1(self):\n a = 1\n' \
650 ' def func2(self):\n b = 1\n'
651 start = code.index(' 1') + 1
652 refactored = self.do_extract_variable(code, start, start + 1,
653 'one', similar=True)
654 expected = 'class AClass(object):\n\n' \
655 ' def func1(self):\n one = 1\n a = one\n' \
656 ' def func2(self):\n b = 1\n'
657 self.assertEquals(expected, refactored)
658
659 def test_extract_method_in_staticmethods(self):
660 code = 'class AClass(object):\n\n' \
661 ' @staticmethod\n def func2():\n b = 1\n'
662 start = code.index(' 1') + 1
663 refactored = self.do_extract_method(code, start, start + 1,
664 'one', similar=True)
665 expected = 'class AClass(object):\n\n' \
666 ' @staticmethod\n def func2():\n' \
667 ' b = AClass.one()\n\n' \
668 ' @staticmethod\n def one():\n' \
669 ' return 1\n'
670 self.assertEquals(expected, refactored)
671
672 def test_extract_normal_method_with_staticmethods(self):
673 code = 'class AClass(object):\n\n' \
674 ' @staticmethod\n def func1():\n b = 1\n' \
675 ' def func2(self):\n b = 1\n'
676 start = code.rindex(' 1') + 1
677 refactored = self.do_extract_method(code, start, start + 1,
678 'one', similar=True)
679 expected = 'class AClass(object):\n\n' \
680 ' @staticmethod\n def func1():\n b = 1\n' \
681 ' def func2(self):\n b = self.one()\n\n' \
682 ' def one(self):\n return 1\n'
683 self.assertEquals(expected, refactored)
684
685 def test_extract_variable_with_no_new_lines_at_the_end(self):
686 code = 'a_var = 10'
687 start = code.index('10')
688 end = start + 2
689 refactored = self.do_extract_variable(code, start, end, 'new_var')
690 expected = 'new_var = 10\na_var = new_var'
691 self.assertEquals(expected, refactored)
692
693 def test_extract_method_containing_return_in_functions(self):
694 code = 'def f(arg):\n return arg\nprint(f(1))\n'
695 start, end = self._convert_line_range_to_offset(code, 1, 3)
696 refactored = self.do_extract_method(code, start, end, 'a_func')
697 expected = '\ndef a_func():\n def f(arg):\n return arg\n' \
698 ' print(f(1))\n\na_func()\n'
699 self.assertEquals(expected, refactored)
700
701 def test_extract_method_and_varying_first_parameter(self):
702 code = 'class C(object):\n' \
703 ' def f1(self):\n print(str(self))\n' \
704 ' def f2(self):\n print(str(1))\n'
705 start = code.index('print(') + 6
706 end = code.index('))\n') + 1
707 refactored = self.do_extract_method(code, start, end,
708 'to_str', similar=True)
709 expected = 'class C(object):\n' \
710 ' def f1(self):\n print(self.to_str())\n\n' \
711 ' def to_str(self):\n return str(self)\n' \
712 ' def f2(self):\n print(str(1))\n'
713 self.assertEquals(expected, refactored)
714
715 def test_extract_method_when_an_attribute_exists_in_function_scope(self):
716 code = 'class A(object):\n def func(self):\n pass\n' \
717 'a = A()\n' \
718 'def f():\n' \
719 ' func = a.func()\n' \
720 ' print func\n'
721
722 start, end = self._convert_line_range_to_offset(code, 6, 6)
723 refactored = self.do_extract_method(code, start, end, 'g')
724 refactored = refactored[refactored.index('A()') + 4:]
725 expected = 'def f():\n func = g()\n print func\n\n' \
726 'def g():\n func = a.func()\n return func\n'
727 self.assertEquals(expected, refactored)
728
729 def test_global_option_for_extract_method(self):
730 code = 'def a_func():\n print(1)\n'
731 start, end = self._convert_line_range_to_offset(code, 2, 2)
732 refactored = self.do_extract_method(code, start, end,
733 'extracted', global_=True)
734 expected = 'def a_func():\n extracted()\n\n' \
735 'def extracted():\n print(1)\n'
736 self.assertEquals(expected, refactored)
737
738 def test_global_extract_method(self):
739 code = 'class AClass(object):\n\n' \
740 ' def a_func(self):\n print(1)\n'
741 start, end = self._convert_line_range_to_offset(code, 4, 4)
742 refactored = self.do_extract_method(code, start, end,
743 'new_func', global_=True)
744 expected = 'class AClass(object):\n\n' \
745 ' def a_func(self):\n new_func()\n\n' \
746 'def new_func():\n print(1)\n'
747 self.assertEquals(expected, refactored)
748
749 def test_extract_method_with_multiple_methods(self): # noqa
750 code = 'class AClass(object):\n' \
751 ' def a_func(self):\n' \
752 ' print(1)\n\n' \
753 ' def another_func(self):\n' \
754 ' pass\n'
755 start, end = self._convert_line_range_to_offset(code, 3, 3)
756 refactored = self.do_extract_method(code, start, end,
757 'new_func', global_=True)
758 expected = 'class AClass(object):\n' \
759 ' def a_func(self):\n' \
760 ' new_func()\n\n' \
761 ' def another_func(self):\n' \
762 ' pass\n\n' \
763 'def new_func():\n' \
764 ' print(1)\n'
765 self.assertEquals(expected, refactored)
766
767 def test_where_to_seach_when_extracting_global_names(self):
768 code = 'def a():\n return 1\ndef b():\n return 1\nb = 1\n'
769 start = code.index('1')
770 end = start + 1
771 refactored = self.do_extract_variable(code, start, end, 'one',
772 similar=True, global_=True)
773 expected = 'def a():\n return one\none = 1\n' \
774 'def b():\n return one\nb = one\n'
775 self.assertEquals(expected, refactored)
776
777 def test_extracting_pieces_with_distinct_temp_names(self):
778 code = 'a = 1\nprint a\nb = 1\nprint b\n'
779 start = code.index('a')
780 end = code.index('\nb')
781 refactored = self.do_extract_method(code, start, end, 'f',
782 similar=True, global_=True)
783 expected = '\ndef f():\n a = 1\n print a\n\nf()\nf()\n'
784 self.assertEquals(expected, refactored)
785
786 def test_extract_methods_in_glob_funcs_should_be_glob(self):
787 code = 'def f():\n a = 1\ndef g():\n b = 1\n'
788 start = code.rindex('1')
789 refactored = self.do_extract_method(code, start, start + 1, 'one',
790 similar=True, global_=False)
791 expected = 'def f():\n a = one()\ndef g():\n b = one()\n\n' \
792 'def one():\n return 1\n'
793 self.assertEquals(expected, refactored)
794
795 def test_extract_methods_in_glob_funcs_should_be_glob_2(self):
796 code = 'if 1:\n var = 2\n'
797 start = code.rindex('2')
798 refactored = self.do_extract_method(code, start, start + 1, 'two',
799 similar=True, global_=False)
800 expected = '\ndef two():\n return 2\n\nif 1:\n var = two()\n'
801 self.assertEquals(expected, refactored)
802
803 def test_extract_method_and_try_blocks(self):
804 code = 'def f():\n try:\n pass\n' \
805 ' except Exception:\n pass\n'
806 start, end = self._convert_line_range_to_offset(code, 2, 5)
807 refactored = self.do_extract_method(code, start, end, 'g')
808 expected = 'def f():\n g()\n\ndef g():\n try:\n pass\n' \
809 ' except Exception:\n pass\n'
810 self.assertEquals(expected, refactored)
811
812 def test_extract_and_not_passing_global_functions(self):
813 code = 'def next(p):\n return p + 1\nvar = next(1)\n'
814 start = code.rindex('next')
815 refactored = self.do_extract_method(code, start, len(code) - 1, 'two')
816 expected = 'def next(p):\n return p + 1\n' \
817 '\ndef two():\n return next(1)\n\nvar = two()\n'
818 self.assertEquals(expected, refactored)
819
820 def test_extracting_with_only_one_return(self):
821 code = 'def f():\n var = 1\n return var\n'
822 start, end = self._convert_line_range_to_offset(code, 2, 3)
823 refactored = self.do_extract_method(code, start, end, 'g')
824 expected = 'def f():\n return g()\n\n' \
825 'def g():\n var = 1\n return var\n'
826 self.assertEquals(expected, refactored)
827
828 def test_extracting_variable_and_implicit_continuations(self):
829 code = 's = ("1"\n "2")\n'
830 start = code.index('"')
831 end = code.rindex('"') + 1
832 refactored = self.do_extract_variable(code, start, end, 's2')
833 expected = 's2 = "1" "2"\ns = (s2)\n'
834 self.assertEquals(expected, refactored)
835
836 def test_extracting_method_and_implicit_continuations(self):
837 code = 's = ("1"\n "2")\n'
838 start = code.index('"')
839 end = code.rindex('"') + 1
840 refactored = self.do_extract_method(code, start, end, 'f')
841 expected = '\ndef f():\n return "1" "2"\n\ns = (f())\n'
842 self.assertEquals(expected, refactored)
843
844 def test_passing_conditional_updated_vars_in_extracted(self):
845 code = 'def f(a):\n' \
846 ' if 0:\n' \
847 ' a = 1\n' \
848 ' print(a)\n'
849 start, end = self._convert_line_range_to_offset(code, 2, 4)
850 refactored = self.do_extract_method(code, start, end, 'g')
851 expected = 'def f(a):\n' \
852 ' g(a)\n\n' \
853 'def g(a):\n' \
854 ' if 0:\n' \
855 ' a = 1\n' \
856 ' print(a)\n'
857 self.assertEquals(expected, refactored)
858
859 def test_returning_conditional_updated_vars_in_extracted(self):
860 code = 'def f(a):\n' \
861 ' if 0:\n' \
862 ' a = 1\n' \
863 ' print(a)\n'
864 start, end = self._convert_line_range_to_offset(code, 2, 3)
865 refactored = self.do_extract_method(code, start, end, 'g')
866 expected = 'def f(a):\n' \
867 ' a = g(a)\n' \
868 ' print(a)\n\n' \
869 'def g(a):\n' \
870 ' if 0:\n' \
871 ' a = 1\n' \
872 ' return a\n'
873 self.assertEquals(expected, refactored)
874
875 def test_extract_method_with_variables_possibly_written_to(self):
876 code = "def a_func(b):\n" \
877 " if b > 0:\n" \
878 " a = 2\n" \
879 " print a\n"
880 start, end = self._convert_line_range_to_offset(code, 2, 3)
881 refactored = self.do_extract_method(code, start, end, 'extracted')
882 expected = "def a_func(b):\n" \
883 " a = extracted(b)\n" \
884 " print a\n\n" \
885 "def extracted(b):\n" \
886 " if b > 0:\n" \
887 " a = 2\n" \
888 " return a\n"
889 self.assertEquals(expected, refactored)
890
891 def test_extract_method_with_list_comprehension(self):
892 code = "def foo():\n" \
893 " x = [e for e in []]\n" \
894 " f = 23\n" \
895 "\n" \
896 " for e, f in []:\n" \
897 " def bar():\n" \
898 " e[42] = 1\n"
899 start, end = self._convert_line_range_to_offset(code, 4, 7)
900 refactored = self.do_extract_method(code, start, end, 'baz')
901 expected = "def foo():\n" \
902 " x = [e for e in []]\n" \
903 " f = 23\n" \
904 "\n" \
905 " baz()\n" \
906 "\n" \
907 "def baz():\n" \
908 " for e, f in []:\n" \
909 " def bar():\n" \
910 " e[42] = 1\n"
911 self.assertEquals(expected, refactored)
912
913 def test_extract_method_with_list_comprehension_and_iter(self):
914 code = "def foo():\n" \
915 " x = [e for e in []]\n" \
916 " f = 23\n" \
917 "\n" \
918 " for x, f in x:\n" \
919 " def bar():\n" \
920 " x[42] = 1\n"
921 start, end = self._convert_line_range_to_offset(code, 4, 7)
922 refactored = self.do_extract_method(code, start, end, 'baz')
923 expected = "def foo():\n" \
924 " x = [e for e in []]\n" \
925 " f = 23\n" \
926 "\n" \
927 " baz(x)\n" \
928 "\n" \
929 "def baz(x):\n" \
930 " for x, f in x:\n" \
931 " def bar():\n" \
932 " x[42] = 1\n"
933 self.assertEquals(expected, refactored)
934
935 def test_extract_method_with_list_comprehension_and_orelse(self):
936 code = "def foo():\n" \
937 " x = [e for e in []]\n" \
938 " f = 23\n" \
939 "\n" \
940 " for e, f in []:\n" \
941 " def bar():\n" \
942 " e[42] = 1\n"
943 start, end = self._convert_line_range_to_offset(code, 4, 7)
944 refactored = self.do_extract_method(code, start, end, 'baz')
945 expected = "def foo():\n" \
946 " x = [e for e in []]\n" \
947 " f = 23\n" \
948 "\n" \
949 " baz()\n" \
950 "\n" \
951 "def baz():\n" \
952 " for e, f in []:\n" \
953 " def bar():\n" \
954 " e[42] = 1\n"
955 self.assertEquals(expected, refactored)
956
957 if __name__ == '__main__':
958 unittest.main()
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698