Auto-generated schema files don't work out-of-the-box

[iMacTia]

We might be doing something wrong here, but basically we have our schemas under a certain namespace (e.g. org.company.my_schemas).
This means that schema files need to go into a nested folder structure (e.g. org/company/my_schemas).

The auto-generated Ruby class gets placed alongside the schema file, but the only module in the file is module Schemas.
This breaks Rails auto-loading, which won't be able to find these classes. So we manually move them to a different location, but that means every time the rake deimos:generate_schema_classes is executed, it will re-create all the schemas that were previously moved.

The solution here would be to either include the schema namespace in the ruby file modules, or create the ruby file in the root (specified in the Deimos config).

[dorner]

I actually haven't used this feature much myself yet as it's relatively new and was contributed by a coworker. @DeeChau can you weigh in on this question?

[DeeChau]

Sure thing @dorner,

Hey @iMacTia, generated schema classes are generated under Deimos.config.schema.generated_class_path which defaults to the path app/lib/schema_classes, so the nested folder structure org/company/my_schemas are be created with that in mind.

The auto-generated Ruby class gets placed alongside the schema file, but the only module in the file is module Schemas.

Can you provide me with the config.schema.generated_class_path and config.schema.path to help me understand where these are located?

The solution here would be to either include the schema namespace in the ruby file modules, or create the ruby file in the root (specified in the Deimos config).

I considered including the schema namespace in the ruby file modifiers during development and it is possible. As for creating the ruby file in the root, do you mean at the config.schema.generated_class_path?

[dorner]

@iMacTia The schema-level setting is the general one for the application. The producer and consumer level are overrides. So you can set it to true for the application but false for specific producers, or vice versa.

[iMacTia]

aha! Thanks @dorner, so can I safely remove the use_schema_classes config from producers?

[dorner]

If you have it set at the app-level, yes!

[DeeChau]

Yeap @iMacTia! We probably need to be more clear in our documentation

[iMacTia]

Thank you both for helping out 🙌!