dwyl/phoenix-ecto-append-only-log-example

Questions on approach taken

Open

#8 opened on Oct 9, 2018

View on GitHub
 (8 comments) (1 reaction) (1 assignee)Elixir (5 forks)auto 404
help wantedquestiontechnical

Repository metrics

Stars
 (82 stars)
PR merge metrics
 (PR metrics pending)

Description

  • Why is everything done using macros? We could achieve the same result by making them regular functions which takes the relevant module as an argument. Is there any benefits of one approach vs the other?

  • Is the insert function just allowing the user to skip the step where they call the relevant changeset function? Is this a good idea?

    • When inserting into the database in this way will a user only ever need on changeset function? In a regular Phoenix application there may be multiple changesets depending on what needs to be inserted/updated in the database. If a user needs to change their password for example there could be a changeset that deals specifically with just this. (Just to be clear, I cannot actually think of a situation with this approach where a user might need more than one changeset function but thought it best to raise the point in case I have missed something)

  • The get and get_by functions seem to just call their Repo equivalents. Are they needed?

Contributor guide

Research direction
Review the macro definitions in the repository to understand the design choice between macros and functions. Examine the insert function and its relationship to changesets. Look at the Repo.get and Repo.get by calls to see if wrapper functions add value.
Tech stack
elixir
Domain
backenddatabase
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
ElixirPhoenixEcto
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70