Refactoring codebase

[alaxalves]

Part of publiclab/spectral-workbench#506

[icarito]

I'm not an expert Ruby programmer so I'm not sure what the best practices are here.
A comment that I think the headers belong in every file, you've moved them to the controller from app.rb.
If ruby developers prefer this structure it will be up the the development team although I wrote this app initially.
I'm not sure I understand the logic for the split, perhaps a note in the header to explain would help to understand what is where. Thanks.

[alaxalves]

Here I'm just

I'm not an expert Ruby programmer so I'm not sure what the best practices are here.
A comment that I think the headers belong in every file, you've moved them to the controller from app.rb.
If ruby developers prefer this structure it will be up the the development team although I wrote this app initially.
I'm not sure I understand the logic for the split, perhaps a note in the header to explain would help to understand what is where. Thanks.

Here I'm just on phase one of use Sinatra's modular code styling. According to the Sinatra docs: “When a classic style application is run, all Sinatra::Application public class methods are exported
to the top-level.” Also, using the classical style prevents you from running more than
one Sinatra application per Ruby process – all calls to these top-level methods are handled by Sinatra::Application, functioning as a singleton. We can avoid these potentially-confusing scoping
problems by reorganizing our application into what Sinatra calls the “modular” style - which is what I'm starting to do here.

Besides mitigating scoping issues, we could reduce code duplication(by using lambdas) e some other advantages.

I have not done every changes needed to switch our app from classical to modular style, because this would be a huge PR. In this PR I made a few changes in a way that the code keeps running properly without the need to change anything. A couple more PRs will be required to fully modularize.

[jywarren]

Hi, if Sinatra makes the recommendation of this code organization then I'm in support, thank you! It largely matches the Ruby on Rails style of directory structure. I agree with @icarito that perhaps we should link to the Sinatra recommendation by way of explanation, perhaps also in the readme?

Thank you!

[jywarren]

I guess I'll go ahead and merge this and if you could drop in the link in the description at top that'd be great! Thanks!

[jywarren]

Hi @alaxalves just wanted to mention that in this repo, once the main branch is updated, the production container auto-reboots with the new code. 🎉