|
| 1 | +--- |
| 2 | +layout: report |
| 3 | +url: RohanVB |
| 4 | +student: Rohan Bhambhoria |
| 5 | +organisation: coala |
| 6 | +organisation_link : https://coala.io |
| 7 | +project: Cohesive Editor Support |
| 8 | +project_link: https://summerofcode.withgoogle.com/projects/#5763185452253184 |
| 9 | +tarball: https://github.com/RohanVB/GSoCReport/files/3531180/rohanvb.tar.gz |
| 10 | +sha256sum: ee04b3d8de6271c5092c7a90ed48778ba2f789b19c826c233c0f83e16d852d6f |
| 11 | +mentors: > |
| 12 | + [John Vandenberg](https://github.com/jayvdb) |
| 13 | +phase: |
| 14 | + - Bonding : https://gitlab.com/coala/GSoC/gsoc-2019/issues?label_name=BONDING&milestone_title=Cohesive+Editor+Support&state=all |
| 15 | + - Phase 1 : https://gitlab.com/coala/GSoC/gsoc-2019/issues?label_name=Phase+1&milestone_title=Cohesive+Editor+Support&state=all |
| 16 | + - Phase 2 : https://gitlab.com/coala/GSoC/gsoc-2019/issues?label_name=Phase+2&milestone_title=Cohesive+Editor+Support&state=all |
| 17 | + - Phase 3 : https://gitlab.com/coala/GSoC/gsoc-2019/issues?label_name=Phase+3&milestone_title=Cohesive+Editor+Support&state=all |
| 18 | +bio: > |
| 19 | + I'm a graduating student from the Master's program in Computer Engineering at Queen's University. I will be starting my PhD in September, 2019. I started contributing code to `coala` several years ago and have made contributions such as bug fixes, writing tests and feature implementation. I have also served as a google code-in mentor for coala. My most recent contribution includes participating in the Google Summer of Code with coala under the project of Cohesive Editor Support. |
| 20 | +social: |
| 21 | + - GitHub: |
| 22 | + - username: RohanVB |
| 23 | + - link: https://github.com/rohanvb |
| 24 | + - GitLab: |
| 25 | + - username: RohanVB |
| 26 | + - link: https://gitlab.com/rohanvb |
| 27 | +email: rohan.vbh@gmail.com |
| 28 | +blog: https://rohanvb.com/ |
| 29 | +activity: |
| 30 | + - 0: |
| 31 | + - repo: coala-spyder |
| 32 | + - link: https://github.com/RohanVB/coala-spyder/commit/4f8c756c8e00df3a3edff6f0e501b44cb1d23de4 |
| 33 | + - details: > |
| 34 | + Adds initial file structure |
| 35 | +
|
| 36 | + - 1: |
| 37 | + - repo: coala-spyder |
| 38 | + - link: https://github.com/RohanVB/coala-spyder/commit/2b8f3aa10faa6e4c55974b1758a4e360394dcf39 |
| 39 | + - details: > |
| 40 | + Adds other initially required files |
| 41 | +
|
| 42 | + - 2: |
| 43 | + - repo: coala-spyder |
| 44 | + - link: https://github.com/RohanVB/coala-spyder/commit/333605320acbd3dbe605ef3dc84e335717d12bbd |
| 45 | + - details: > |
| 46 | + Adds required libraries to coalagui (widget) |
| 47 | +
|
| 48 | + - 3: |
| 49 | + - repo: coala-spyder |
| 50 | + - link: https://github.com/RohanVB/coala-spyder/commit/6a58e83712a377d62e7d7a34a7ea9f071a30f2e9 |
| 51 | + - details: > |
| 52 | + Adds version check |
| 53 | +
|
| 54 | + - 4: |
| 55 | + - repo: coala-spyder |
| 56 | + - link: https://github.com/RohanVB/coala-spyder/commit/80233a51281d9aecd6e82c32ea6aa51ed736fe29 |
| 57 | + - details: > |
| 58 | + Adds specific file coala and .coafile |
| 59 | +
|
| 60 | + - 5: |
| 61 | + - repo: coala-spyder |
| 62 | + - link: https://github.com/RohanVB/coala-spyder/commit/04f288ebe7e94aa9d06208d92a84f77730bc2e08 |
| 63 | + - details: > |
| 64 | + Desired result output in working state |
| 65 | +
|
| 66 | + - 6: |
| 67 | + - repo: coala-spyder |
| 68 | + - link: https://github.com/RohanVB/coala-spyder/commit/0c8dbbe95dc82ecc37d4538fe07689a03b6c9dd4 |
| 69 | + - details: > |
| 70 | + coala.results: Saves result in pickled format |
| 71 | +
|
| 72 | + - 7: |
| 73 | + - repo: coala-spyder |
| 74 | + - link: https://github.com/RohanVB/coala-spyder/commit/bd00e61b42aaea75d84dc4861812167f76367d7b |
| 75 | + - details: > |
| 76 | + run_coala.py: Modified to obtain required output |
| 77 | +
|
| 78 | + - 8: |
| 79 | + - repo: coala-spyder |
| 80 | + - link: https://github.com/RohanVB/coala-spyder/commit/c7064854c0af22809f56b9ac729b02f44e9418f4 |
| 81 | + - details: > |
| 82 | + Widget: Displays output |
| 83 | +
|
| 84 | + - 9: |
| 85 | + - repo: coala-spyder |
| 86 | + - link: https://github.com/RohanVB/coala-spyder/commit/f47433862685c9a1d69a70a248c756ecfc307932 |
| 87 | + - details: > |
| 88 | + run_coala: code cleanup |
| 89 | +
|
| 90 | + - 10: |
| 91 | + - repo: coala-spyder |
| 92 | + - link: https://github.com/RohanVB/coala-spyder/commit/3ebaf995013792ed0723c9fe8d8939db650fc951 |
| 93 | + - details: > |
| 94 | + Registers coalaspyder as third-party plugin |
| 95 | +
|
| 96 | + - 11: |
| 97 | + - repo: coala-spyder |
| 98 | + - link: https://github.com/RohanVB/coala-spyder/commit/e5f75b31ebcac1080d6cec77cd3485dbc79984c2 |
| 99 | + - details: > |
| 100 | + Output is displayed in ResultsTree |
| 101 | +
|
| 102 | + - 12: |
| 103 | + - repo: coala-spyder |
| 104 | + - link: https://github.com/RohanVB/coala-spyder/commit/b1d51d9947edbd9c5dca4d1ab086277c41ed553d |
| 105 | + - details: > |
| 106 | + Fixes output of results |
| 107 | +
|
| 108 | + - 13: |
| 109 | + - repo: coala-spyder |
| 110 | + - link: https://github.com/RohanVB/coala-spyder/commit/31b315e0a0c744f0c606ceb41f469300df231254 |
| 111 | + - details: > |
| 112 | + Removes unused code |
| 113 | +
|
| 114 | + - 14: |
| 115 | + - repo: coala-spyder |
| 116 | + - link: https://github.com/RohanVB/coala-spyder/commit/325d7f6311b2824739b989d819bb64ea354488af |
| 117 | + - details: > |
| 118 | + Adds Travis CI (Builds passing) |
| 119 | +
|
| 120 | + - 15: |
| 121 | + - repo: coala-spyder |
| 122 | + - link: https://github.com/RohanVB/coala-spyder/commit/87e0269bd21ef6791f3ee765471cb4053dd4ee14 |
| 123 | + - details: > |
| 124 | + Uses relative import for single file coala |
| 125 | +
|
| 126 | +
|
| 127 | + - 16: |
| 128 | + - repo: spyder-coala |
| 129 | + - link: https://github.com/RohanVB/spyder-coala/commit/30e22666cdfd6fcac212b2082394eb1131ac2026 |
| 130 | + - details: > |
| 131 | + reformat of `coala-spyder` into structure in consistent format with other third-party spyder plugins. |
| 132 | +
|
| 133 | + - 17: |
| 134 | + - repo: spyder-coala |
| 135 | + - link: https://github.com/RohanVB/spyder-coala/commit/9807bc839426db9802db83aa1da492408c5d76b5 |
| 136 | + - details: > |
| 137 | + adds documentation/installation instructions |
| 138 | +
|
| 139 | + - 18: |
| 140 | + - repo: SublimeLinter-coala |
| 141 | + - link: https://github.com/RohanVB/SublimeLinter-coala/commit/f528d5f3aa4ddb298b27eff266b8f20ad0fa75df |
| 142 | + - details: > |
| 143 | + Initializes SublimeLinter-coala without proper regex |
| 144 | +
|
| 145 | + - 19: |
| 146 | + - repo: SublimeLinter-coala |
| 147 | + - link: https://github.com/RohanVB/SublimeLinter-coala/commit/8a2b9d531c7344df32287eb36419e71671c423c3 |
| 148 | + - details: > |
| 149 | + Fixes regex and brings SublimeLinter-coala to working state |
| 150 | +
|
| 151 | + - 20: |
| 152 | + - repo: coala-syntastic |
| 153 | + - link: https://github.com/RohanVB/coala-syntastic/commit/15c7e00b52ffed4e3e9f59ede29d883981ed8549 |
| 154 | + - details: > |
| 155 | + Fixes version parsing |
| 156 | +
|
| 157 | + - 21: |
| 158 | + - repo: coala-syntastic |
| 159 | + - link: https://github.com/RohanVB/coala-syntastic/commit/adca116e30fdd9464ce79a17c2d5842f0fff1484 |
| 160 | + - details: > |
| 161 | + Removes unrequired checkers |
| 162 | +
|
| 163 | + - 22: |
| 164 | + - repo: coala-syntastic |
| 165 | + - link: https://github.com/RohanVB/coala-syntastic/commit/a03b2253695df6dc11e9b187bca0a746b4d4a13a |
| 166 | + - details: > |
| 167 | + Fixes regex issue |
| 168 | +
|
| 169 | + - 23: |
| 170 | + - repo: coala-syntastic |
| 171 | + - link: https://github.com/RohanVB/coala-syntastic/commit/de8a9e9556c69a0c833489908073889d2a8ea8df |
| 172 | + - details: > |
| 173 | + Fixes error format |
| 174 | +
|
| 175 | + - 24: |
| 176 | + - repo: coala-syntastic |
| 177 | + - link: https://github.com/RohanVB/coala-syntastic/commit/b6922bdf15ea9d2ac61d2aee183b0cd152d2761f |
| 178 | + - details: > |
| 179 | + Fixes format for some bears |
| 180 | +
|
| 181 | + - 25: |
| 182 | + - repo: coala-syntastic |
| 183 | + - link: https://github.com/RohanVB/coala-syntastic/commit/d927715f602c43061dd4fb21948e09fc06049192 |
| 184 | + - details: > |
| 185 | + Fixes error format |
| 186 | +
|
| 187 | + - 26: |
| 188 | + - repo: coala-syntastic |
| 189 | + - link: https://github.com/RohanVB/coala-syntastic/commit/d927715f602c43061dd4fb21948e09fc06049192 |
| 190 | + - details: > |
| 191 | + Fixes error format |
| 192 | +
|
| 193 | + - 27: |
| 194 | + - repo: syntastic-coala |
| 195 | + - link: https://github.com/RohanVB/syntastic-coala/commit/b0e9adcad6a13b41f0d2a2c31c1c8caf51ac49d1 |
| 196 | + - details: > |
| 197 | + Restructures repository and adds installation instructions |
| 198 | +
|
| 199 | +
|
| 200 | + - 28: |
| 201 | + - repo: dependency_management |
| 202 | + - link: https://gitlab.com/coala/package_manager/commit/918d24b32408ffea7d70b71796bf14c846870177 |
| 203 | + - details: > |
| 204 | + Adds AtomRequirement |
| 205 | +
|
| 206 | + - 29: |
| 207 | + - repo: dependency_management |
| 208 | + - link: https://gitlab.com/coala/package_manager/commit/b4e7c06a6d78caef78ee2cf20bec11fbddb72a0f |
| 209 | + - details: > |
| 210 | + Adds tests for AtomRequirement |
| 211 | +--- |
| 212 | + |
| 213 | +### Cohesive Editor Support |
| 214 | + |
| 215 | + |
| 216 | +#### Work Done |
| 217 | + |
| 218 | +[coala spyder](https://gitlab.com/coala/editors/coala-spyder) is now a functional coala plugin and can be launched from the spyder editor. The repository has unittests and continuous integration set up with TravisCI. |
| 219 | +It can also be tested as a stand-alone widget. |
| 220 | + |
| 221 | +<br> |
| 222 | + |
| 223 | +[coala sublime](https://gitlab.com/coala/editors/coala-sublime) is now a functional plugin for `Sublime Text 3` with all of the bells and whistles of SublimeLinter. |
| 224 | +[coala vim](https://gitlab.com/coala/editors/coala-vim) is now a functional plugin for `vim` and `neovim` powered by the functionality of `syntastic`. |
| 225 | + |
| 226 | +<br> |
| 227 | + |
| 228 | +The three above projects have been added to the main `coala` organisation on Gitlab which involved rewriting the commit history to remove the fixups, |
| 229 | +and meeting the requirements of a maintainable organisational project. |
| 230 | + |
| 231 | + |
| 232 | +#### Challenges |
| 233 | + |
| 234 | +The main challenge was time management and allocation of sufficient time towards the Cohesive Editor Support project as I was also working on a university project at the time. The quick replies of my mentor, [John](https://github.com/jayvdb) and setting me on the right path helped me get more out of myself than I would've been able to without him. |
| 235 | + |
| 236 | +<br> |
| 237 | + |
| 238 | +Another challenge was diving into undocumented territory when working with integrating the `spyder-coala` widget with the `spyder` IDE. |
| 239 | + |
| 240 | +#### Work to be done |
| 241 | + |
| 242 | +For the first plugin - `coala spyder`, there are two main bugs that need to be fixed: |
| 243 | + |
| 244 | +1) [Obtaining the current file for run_coala](https://gitlab.com/coala/editors/coala-spyder/issues/1) |
| 245 | + |
| 246 | +2) [Widget crashing when unpacking from button](https://gitlab.com/coala/editors/coala-spyder/issues/2) |
| 247 | + |
| 248 | +Also, unittests currently do not have full coverage. |
| 249 | + |
| 250 | +<br> |
| 251 | + |
| 252 | +For the second plugin - `coala sublime`, there is one main bug that needs to be fixed: |
| 253 | + |
| 254 | +[Fix pileup of linter flags](https://gitlab.com/coala/editors/coala-sublime/issues/1) |
| 255 | + |
| 256 | +Also, unittests and CI has not been set up for this repository. |
| 257 | + |
| 258 | +<br> |
| 259 | + |
| 260 | +For the third plugin - `coala vim`, unittests and CI needs to be set up. |
| 261 | + |
| 262 | +<br> |
| 263 | + |
| 264 | +For `AtomRequirement` in the `dependency_management` repo, all functions are not yet added to check for `apm` installed packages. |
0 commit comments