Add Jennifer Recipe #20

faustinoaq · 2018-05-28T12:01:36Z

This PR tries to add a Jennifer Recipe to replace amberframework/amber#766

This will be easier to maintain, contribute, test and deploy because amber templates a becoming too complex, so recipes to rescue!!! 😉

This is an initial implementation, so, there are some issues to fix:

Recipes doesn't support migrations or auth yet (only app, controllers, models, and scaffold): see: https://github.com/amberframework/amber/blob/master/src/amber/cli/recipes/recipe.cr#L25
Jennifer (and some of its dependencies) has wrong tags: see v0.5.1 always fetches dependencies imdrasil/jennifer.cr#137 (this causes broken dependencies, see: Dependencies are satisfied rarely works crystal-lang/shards#183)
amber new doesn't allow other models, just granite and crecto, see: Parsing Error: The -m option must be one of granite, crecto. amber#827
Jennifer doesn't support SQLite yet, see: https://github.com/imdrasil/jennifer.cr#important-restrictions

Roadmap

Add jennifer_spec.cr and auto-deploy support using Travis
Add Jennifer recipe README
Add main app folder with Jennifer dependencies and sam.cr file
Add models using Jennifer and model specs
Complete scaffolding (views and controllers) using Jennifer and scaffolding specs WIP ⚠️
Add auth using Jennifer and auth specs
Fix formatting and other specs, see Fixes spec and formatting #15

imdrasil · 2018-05-28T20:27:30Z

@faustinoaq after merging master into this branch it is impossible to find what are the original changes. Would you mind if I reset last merge commit and do rebase instead of merge (maybe I will have to squash commits)? The opposite solution is to create separate PR with my original changes and add changes what are done here. What do you think?

faustinoaq · 2018-05-28T23:31:10Z

@imdrasil ~~Oh, my bad, I just messed up the code, I tried to fix it unsuccessfully, can you create another PR with Jennifer changes?~~ 😅

Edit: Fixed!!! 🎉

faustinoaq · 2018-05-28T23:34:26Z

@imdrasil ~~I'm just wondering why #4 didn't have this merging issue, @damianham WDYT?~~ 😅

Edit: Fixed!!! 🎉

faustinoaq · 2018-05-29T01:11:11Z

@imdrasil I just fixed merge issues, All Jennifer code has been synced with master successfully ✨ 🎉

imdrasil · 2018-05-30T21:57:24Z

jennifer/model/src/models/{{name}}.cr.lqd

@@ -0,0 +1,32 @@
+{% assign id_field_type = "Primary32" -%}


ATM Jennifer by default use Int32 field database type for a primary key.

imdrasil · 2018-05-30T21:57:43Z

jennifer/model/src/models/{{name}}.cr.lqd

+{%- for field in fields -%}
+{%- if field.name != "id" -%}
+{%- if field.type == "reference" %}
+    {{ field.name }}_id: { type: Int32? },


Same with foreign keys ^^^

imdrasil · 2018-05-30T21:59:45Z

jennifer/scaffold/controller/src/controllers/{{name}}_controller.cr.lqd

+  end
+
+  def {{ name }}_params
+    {{ class_name }}.build_params(


Here I need some advice: Jennifer has own built-in validation + she can't use Hash(String, String) as an argument for building objects. Should I use arguments validation anyway?

The validation in the controller is validation of the incoming parameters before it hits the ORM layer so I think you would leave that method as it is.

faustinoaq · 2018-05-31T00:26:51Z

Hi @imdrasil Thank you for your latest commits, very appreciated! 👍

Just a comment:

The {{" "}} code is required to preserve white space because liquid templates removes all blank spaces when {%- -%} is used.

Current specs are failing because formatting issues on generated code:

Error: formatting 'src/controllers/category_controller.cr' produced changes
Error: formatting 'src/controllers/product_controller.cr' produced changes
Error: formatting 'src/controllers/comment_controller.cr' produced changes
Error: formatting 'src/models/category.cr' produced changes
Error: formatting 'src/models/product.cr' produced changes
Error: formatting 'src/models/comment.cr' produced changes
Error: 'config/initializers/database.cr' has syntax errors
Error: formatting 'spec/controllers/category_controller_spec.cr' produced changes
Error: formatting 'spec/controllers/product_controller_spec.cr' produced changes
Error: formatting 'spec/controllers/comment_controller_spec.cr' produced changes
Error: formatting 'spec/models/category_spec.cr' produced changes
Error: formatting 'spec/models/product_spec.cr' produced changes
Error: formatting 'spec/models/comment_spec.cr' produced changes

^^ These don't include .ecr nor .slang generated templates, so those should be checked manually 😅

eliasjpr · 2018-09-12T20:08:07Z

Ping! @imdrasil @damianham

imdrasil · 2018-09-12T20:32:59Z

Hi. I had some stuff to do. Will return to this from Sunday.

eliasjpr · 2018-09-12T20:39:11Z

@imdrasil awesome I saw the new version of Jennifer and it would be great to have this recipe available for the next release

imdrasil · 2018-09-18T20:42:55Z

basic/crecto/app/config/environments/development.yml.lqd

@@ -7,8 +7,7 @@ logging:
  filter:
    - password
    - confirm_password
-  skip:
-    -
+  skip: []


such kind of change is made because the previous case created [nil] array.

imdrasil · 2018-09-18T20:44:55Z

@faustinoaq , @eliasjpr please take a look at my changes when have some free time

eliasjpr · 2018-09-19T18:58:57Z

This is awesome @imdrasil. Can you add a readme to the recipe on how to setup. I think it will come in handy.

imdrasil · 2018-09-24T16:49:13Z

@faustinoaq please take a look at the changes when have some free time

faustinoaq · 2018-09-25T14:02:54Z

@imdrasil Yeah, sorry for late reply, I'm organizing a lot of things first. I'll check this, Don't worry 😉

faustinoaq added kind:enhancement New feature or request pr:needs-review labels May 28, 2018

faustinoaq added this to To Do in Framework 2018 via automation May 28, 2018

faustinoaq requested review from drujensen, damianham, elorest, robacarp and eliasjpr May 28, 2018 12:02

faustinoaq added the pr:wip label May 28, 2018

This was referenced May 28, 2018

v0.5.1 always fetches dependencies imdrasil/jennifer.cr#137

Closed

Add Jennifer support amberframework/amber#766

Closed

Parsing Error: The -m option must be one of granite, crecto. amberframework/amber#827

Closed

faustinoaq added the status:on-hold on hold - do not merge label May 28, 2018

faustinoaq moved this from To Do to In progress in Framework 2018 May 28, 2018

faustinoaq removed the status:on-hold on hold - do not merge label May 29, 2018

imdrasil reviewed May 30, 2018

View reviewed changes

imdrasil force-pushed the fa/jennifer-recipe branch from 3c76d40 to 40ea5f4 Compare May 31, 2018 10:52

imdrasil force-pushed the fa/jennifer-recipe branch from 40ea5f4 to e2b0c89 Compare June 9, 2018 15:23

imdrasil force-pushed the fa/jennifer-recipe branch 2 times, most recently from aa4c432 to 915acdf Compare September 16, 2018 14:28

imdrasil force-pushed the fa/jennifer-recipe branch 17 times, most recently from 7700faa to 24b225f Compare September 18, 2018 19:40

Add Jennifer Recipe

33b02f9

imdrasil force-pushed the fa/jennifer-recipe branch from 24b225f to 33b02f9 Compare September 18, 2018 20:08

imdrasil reviewed Sep 18, 2018

View reviewed changes

Add Jennifer related notes

400ddcd

amberframework deleted a comment from imdrasil Sep 24, 2018

eliasjpr approved these changes Sep 24, 2018

View reviewed changes

imdrasil removed the pr:wip label Sep 24, 2018

robacarp closed this Jun 17, 2020

Framework 2018 automation moved this from In progress to Done Jun 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Jennifer Recipe #20

Add Jennifer Recipe #20

faustinoaq commented May 28, 2018 •

edited by imdrasil

imdrasil commented May 28, 2018

faustinoaq commented May 28, 2018 •

edited

faustinoaq commented May 28, 2018 •

edited

faustinoaq commented May 29, 2018 •

edited

imdrasil May 30, 2018

imdrasil May 30, 2018

imdrasil May 30, 2018

damianham May 31, 2018

faustinoaq commented May 31, 2018

eliasjpr commented Sep 12, 2018

imdrasil commented Sep 12, 2018

eliasjpr commented Sep 12, 2018

imdrasil Sep 18, 2018

imdrasil commented Sep 18, 2018

eliasjpr commented Sep 19, 2018

imdrasil commented Sep 24, 2018

faustinoaq commented Sep 25, 2018

Add Jennifer Recipe #20

Add Jennifer Recipe #20

Conversation

faustinoaq commented May 28, 2018 • edited by imdrasil

imdrasil commented May 28, 2018

faustinoaq commented May 28, 2018 • edited

faustinoaq commented May 28, 2018 • edited

faustinoaq commented May 29, 2018 • edited

imdrasil May 30, 2018

Choose a reason for hiding this comment

imdrasil May 30, 2018

Choose a reason for hiding this comment

imdrasil May 30, 2018

Choose a reason for hiding this comment

damianham May 31, 2018

Choose a reason for hiding this comment

faustinoaq commented May 31, 2018

eliasjpr commented Sep 12, 2018

imdrasil commented Sep 12, 2018

eliasjpr commented Sep 12, 2018

imdrasil Sep 18, 2018

Choose a reason for hiding this comment

imdrasil commented Sep 18, 2018

eliasjpr commented Sep 19, 2018

imdrasil commented Sep 24, 2018

faustinoaq commented Sep 25, 2018

faustinoaq commented May 28, 2018 •

edited by imdrasil

faustinoaq commented May 28, 2018 •

edited

faustinoaq commented May 28, 2018 •

edited

faustinoaq commented May 29, 2018 •

edited