jacebrowning /
yorm
| Conditions | 28 |
| Total Lines | 142 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 4 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Complex classes like describe_mapper() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
| 1 | # pylint: disable=missing-docstring,redefined-outer-name,unused-variable,expression-not-assigned |
||
| 52 | def describe_mapper(): |
||
| 53 | |||
| 54 | def describe_create(): |
||
| 55 | |||
| 56 | def it_creates_the_file(mapper_real): |
||
| 57 | mapper_real.create() |
||
| 58 | |||
| 59 | expect(mapper_real.path).exists() |
||
| 60 | expect(mapper_real.exists).is_true() |
||
| 61 | expect(mapper_real.deleted).is_false() |
||
| 62 | |||
| 63 | def it_pretends_when_fake(mapper_fake): |
||
| 64 | mapper_fake.create() |
||
| 65 | |||
| 66 | expect(mapper_fake.path).missing() |
||
| 67 | expect(mapper_fake.exists).is_true() |
||
| 68 | expect(mapper_fake.deleted).is_false() |
||
| 69 | |||
| 70 | def it_can_be_called_twice(mapper_real): |
||
| 71 | mapper_real.create() |
||
| 72 | mapper_real.create() # should be ignored |
||
| 73 | |||
| 74 | expect(mapper_real.path).exists() |
||
| 75 | |||
| 76 | def describe_delete(): |
||
| 77 | |||
| 78 | def it_deletes_the_file(mapper): |
||
| 79 | mapper.create() |
||
| 80 | mapper.delete() |
||
| 81 | |||
| 82 | expect(mapper.path).missing() |
||
| 83 | expect(mapper.exists).is_false() |
||
| 84 | expect(mapper.deleted).is_true() |
||
| 85 | |||
| 86 | def it_can_be_called_twice(mapper): |
||
| 87 | mapper.delete() |
||
| 88 | mapper.delete() # should be ignored |
||
| 89 | |||
| 90 | expect(mapper.path).missing() |
||
| 91 | |||
| 92 | def describe_load(): |
||
| 93 | |||
| 94 | def it_adds_missing_attributes(obj, mapper): |
||
| 95 | mapper.create() |
||
| 96 | mapper.load() |
||
| 97 | |||
| 98 | expect(obj.var1) == 1 |
||
| 99 | expect(obj.var2) == 0 |
||
| 100 | expect(obj.var3) == 0 |
||
| 101 | |||
| 102 | def it_ignores_new_attributes(obj, mapper): |
||
| 103 | mapper.create() |
||
| 104 | mapper.text = "var4: foo" |
||
| 105 | |||
| 106 | mapper.load() |
||
| 107 | with expect.raises(AttributeError): |
||
| 108 | print(obj.var4) |
||
| 109 | |||
| 110 | def it_infers_types_on_new_attributes_with_auto_track(obj, mapper): |
||
| 111 | mapper.auto_track = True |
||
| 112 | mapper.create() |
||
| 113 | mapper.text = "var4: foo" |
||
| 114 | |||
| 115 | mapper.load() |
||
| 116 | expect(obj.var4) == "foo" |
||
| 117 | |||
| 118 | obj.var4 = 42 |
||
| 119 | mapper.save() |
||
| 120 | |||
| 121 | mapper.load() |
||
| 122 | expect(obj.var4) == "42" |
||
| 123 | |||
| 124 | def it_raises_an_exception_after_delete(mapper): |
||
| 125 | mapper.delete() |
||
| 126 | |||
| 127 | with expect.raises(exceptions.DeletedFileError): |
||
| 128 | mapper.load() |
||
| 129 | |||
| 130 | def describe_modified(): |
||
| 131 | |||
| 132 | def is_true_initially(mapper): |
||
| 133 | expect(mapper.modified).is_true() |
||
| 134 | |||
| 135 | def is_true_after_create(mapper): |
||
| 136 | mapper.create() |
||
| 137 | |||
| 138 | expect(mapper.modified).is_true() |
||
| 139 | |||
| 140 | def is_true_after_delete(mapper): |
||
| 141 | mapper.delete() |
||
| 142 | |||
| 143 | expect(mapper.modified).is_true() |
||
| 144 | |||
| 145 | def is_false_after_load(mapper): |
||
| 146 | mapper.create() |
||
| 147 | mapper.load() |
||
| 148 | |||
| 149 | expect(mapper.modified).is_false() |
||
| 150 | |||
| 151 | def can_be_set_false(mapper): |
||
| 152 | mapper.create() |
||
| 153 | mapper.modified = False |
||
| 154 | |||
| 155 | expect(mapper.modified).is_false() |
||
| 156 | |||
| 157 | def can_be_set_true(mapper): |
||
| 158 | mapper.create() |
||
| 159 | mapper.modified = True |
||
| 160 | |||
| 161 | expect(mapper.modified).is_true() |
||
| 162 | |||
| 163 | def describe_text(): |
||
| 164 | |||
| 165 | def can_get_the_file_contents(obj, mapper): |
||
| 166 | mapper.create() |
||
| 167 | obj.var3 = 42 |
||
| 168 | mapper.save() |
||
| 169 | |||
| 170 | expect(mapper.text) == "var2: 0\nvar3: 42\n" |
||
| 171 | |||
| 172 | def can_set_the_file_contents(obj, mapper): |
||
| 173 | mapper.create() |
||
| 174 | mapper.text = "var2: 42\n" |
||
| 175 | mapper.load() |
||
| 176 | |||
| 177 | expect(obj.var2) == 42 |
||
| 178 | |||
| 179 | def describe_data(): |
||
| 180 | |||
| 181 | def can_get_the_file_values(obj, mapper): |
||
| 182 | mapper.create() |
||
| 183 | obj.var3 = 42 |
||
| 184 | mapper.save() |
||
| 185 | |||
| 186 | expect(mapper.data) == {'var2': 0, 'var3': 42} |
||
| 187 | |||
| 188 | def can_set_the_file_values(obj, mapper): |
||
| 189 | mapper.create() |
||
| 190 | mapper.data = {'var2': 42} |
||
| 191 | mapper.load() |
||
| 192 | |||
| 193 | expect(obj.var2) == 42 |
||
| 194 |
