giuse/data_modeler

First comments

Opened this issue · 0 comments

arbox commented

Dear Giuseppe,

you asked me to review the code in this library. It looks very good elaborated 👍

I started with some very general thoughts. Probably they could be useful for you.

  1. you implemented the default gem layout with the Bundler generator having not really useful file under bin . On the other hand bin is the default value for the executable folder for gems which in turn pushed you to define exe as a new executable folder in the Gemspec. This new exe is missing and actually not really required in your project for now.

  2. I'm not a big fan (but it's only my PoV) of development dependencies in the Gemspec. I don't think that it's a real use case to download a gem file, unpack it and continue the development. The right place for development dependencies is the Gemfile .

  3. Using Git is OK, but in my opinion not to define which files should be included in the the final gem package. A gem package should be the smallest possible version of your project, the project itself could be much larger including many internal information. So manual definition of the package files was always my way. (For the same reason I do not include test files and extension code into the gem. The gem should be compiled and tested for the target platform before the final release. Otherwise it's a bug. But it's not the case here.)

  4. I'd rather use the parens around method parameters. But it's your choice :)

I'll look further and try to implement real examples in my context. So stay tuned. And many thanks for your engagement in the community!