Beginner questions / clarifications in the guides

[hfjallemark]

I am just getting started with Lucky (and loving it!) and noted down some items that I have run into that could probably be added to the guides. I will just list them all here and we can see which ones makes sense to move into the guides or fix/change in the libraries and which ones doesn't make sense at all 😄

• [ ] Explain how to compile and run production version locally
• [ ] Where does lucky dev come from? And what is the difference between that and lucky watch
• [ ] How to run browser tests (yes, I actually struggled with this one!)
• [ ] Send grid requires SEND_GRID_KEY by default but the Heroku addon adds the following config vars: SENDGRID_PASSWORD and SENDGRID_USER which requires me to manually add a KEY too -- could this be simplified or is there a good reason for defaulting to an api key?
• [ ] What is APP_DOMAIN needed for?
• [ ] How to set relationships, seems to be a magic id field (e.g. user.customer_id = my_id and not user.customer = my_customner)?
• [ ] created_at / updated_at not automatically saved?
• [ ] Explain difference between has_one and belongs_to
• [ ] HTML tag attributes without values (e.g. script defer needs to be defer: "")

• [ ] Form needs, how to truly require something when using the on option.. e.g from the guide:

   needs author : User, on: :create # can also be :update, :save
  
   def prepare
       author.try do |user| # What if author is nil here but we are in create?
           authored_by_id.value = user.id
       end
   end

[paulcsmith]

To answer a few of these:

• [x] Where does lucky dev come from? And what is the difference between that and lucky watch

  It comes from Lucky CLI. Under the hood lucky dev finds a process manager like forego, foreman, overmind and then runs Procfile.dev. lucky watch is specific to a Lucky project and compiles and re-compiles a Lucky project when a change is detected. You'll see that lucky watch is in Procfile.dev along with another process for compiling assets.

• [x] Send grid requires SEND_GRID_KEY by default but the Heroku addon adds the following config vars: SENDGRID_PASSWORD and SENDGRID_USER which requires me to manually add a KEY too -- could this be simplified or is there a good reason for defaulting to an api key?

  Mostly that I typically don't use Heroku add-ons for this and what SendGrid gives you is a key. I suppose to could use a password and user instead. Could you add this as an issue on Carbon so it can be tracked separately?

• [x] What is APP_DOMAIN needed for?

  This should be better documented. It is for generating full URLs (for use in emails, webhooks). Lucky needs to know what domain to use for those.

• [x] How to set relationships, seems to be a magic id field (e.g. user.customer_id = my_id and not user.customer = my_customner)?

  Yes it is using the "magical field". I plan to make it so that you can do user.custom = my_customer. I just haven't gotten to it quite yet.

• [x] created_at / updated_at not automatically saved?

  It should be! If it is not, please open an issue on LuckyRecord

• [x] HTML tag attributes without values (e.g. script defer needs to be defer: "")

  script defer: "true". Browsers ignore the 'true' but Lucky needs something to put there. I've considered allowing a list of Strings or something, but I'm not sure it is worth it: script attrs: [:defer] or text_input f.email, attrs: [:autofocus], class: "my-class". Any thoughts on that?

• [x] Form needs, how to truly require something when using the on option.. e.g from the guide:

  This should be shown in the guides, but maybe it is not clear. You can declare needs without any on option and it should always be required. If it isn't, please open an issue on LuckyRecord because that is a bug in the macro :)

I hope that helps answer some of those questions! Let me know if you have any thoughts or if I should clarify further on any of these points

[hfjallemark]

Thanks for the answers,.

Mostly that I typically don't use Heroku add-ons for this and what SendGrid gives you is a key. I suppose to could use a password and user instead. Could you add this as an issue on Carbon so it can be tracked separately?

Added https://github.com/luckyframework/carbon/issues/13.

It should be! If it is not, please open an issue on LuckyRecord

Seems like it's not updating the updated_at. Added https://github.com/luckyframework/lucky_record/issues/241.

script defer: "true". Browsers ignore the 'true' but Lucky needs something to put there. I've considered allowing a list of Strings or something, but I'm not sure it is worth it: script attrs: [:defer] or text_input f.email, attrs: [:autofocus], class: "my-class". Any thoughts on that?

W3 validator complains about defer: "true" seems to be ok with just defer: "". I don't think it's worth spending any time on.

This should be shown in the guides, but maybe it is not clear. You can declare needs without any on option and it should always be required. If it isn't, please open an issue on LuckyRecord because that is a bug in the macro :)

Right, if I don't have any on the field can't be nil and I don't have to do author.try do |user|.... But when I add on: create it can be nil... even when the form is in "create mode" (which shouldn't be allowed). Is there any way to enforce that it cannot be nil in on: create and not even exist for the others? Not sure I am making sense here 😄