luckyframework / lucky_record Goto Github PK

View Code? Open in Web Editor NEW

48.0 48.0 21.0 497 KB

Renamed to Avram ->> https://github.com/luckyframework/avram

License: MIT License

Crystal 99.53% Shell 0.21% HTML 0.26%

lucky_record's People

Contributors

Stargazers

Watchers

Forkers

russ nicohvi edwardloveall coderhs ianagne actsasflinn volodymyr-nt shimbaco oneiros jsteiner mikeeus calebuharrison werner osfx tzar hibachrach ajwann m-o-e perezperret kyledayton repomaa

lucky_record's Issues

Query associations

Ideas for how it would look: https://gist.github.com/paulcsmith/0a511ab3db994e7b43ad48b8e3dba4a2

Blocked by: #128

Add validations

Start with

validate_required
validate_acceptance_of
validate_confirmation_of

Make `AllowedField` and `PrivateField` instead of using a `_` before field names

If you have a table with no fields it should still be able to compile

Right now this fails

table :whatever do
end

It should compile or at least give a more helpful error when it fails

Add advanced criteria

Make it so types can specify which criteria to use

Add change tracker to changesets so only changes are sent for update/insert

Add pluralization/singularization handling in associations and table names

Add `to_param` to be used in LuckyWeb

Use field value if param is empty

That way when you load a edit form it will use the values from the record instead of nil

Add task for generating a migration from the model

lucky db.extract_migration User

It should inspect the database and the model schema and generate a migration for it. If it's not sure what to do, it can leave commented out code so the user can decide how to act on it

def change
  # The title field is no longer on `User`. You can remove it or rename it
  # remove_column :users, :title
  # rename_column :users, :title, to: :fill_in_new_column_name
  add_column :users, :body, type: String
end

Preload associations

An idea:

posts = PostQuery.new
  # Posts belonging to a specific author
  .author(current_user)
  # Preload comments, and their authors
  .preload_comments(&.preload_author)
  # Just preload the comments
  .preload_comments
  # If you want to do a custom comment query AND preload the authors
  # Works since preload_author is on the query
  .preload_comments(CommentQuery.new.newest_first.not_spam.preload_author)

I think you should be able to call association methods without preloading but in dev/test it will raise if you forget to preload. That way if an N+1 gets to production it won't blow up, but in dev/test you can catch it.

I imagine that in prod you'd want to be able to hook it up to Honeybadger or whatever so that it logs an error though, that way you know an N+1 is happening and needs to be fixed.

I think this is a good balance of catching N+1, not introducing runtime errors, and not having an overly complex method for preloading and getting at your associations.

Allow passing extra params to save and update

class CommentForm < Comment::BaseForm
  allow body
  # Needs assoc will set the association automatically
  needs_assoc author, only: :save # Don't need to pass the author or project on updates
  needs_assoc project, only: :save
  needs something_else : String # sets up an argument on save/update and creates a `private getter` for it
end

CommentForm.save params, author: author, project: project, something_else: "HELLO"
CommentForm.update comment, something_else: "Hey-o!"

Add non-model/virtual forms

class SignInForm < LuckyRecord::VirtualForm
  allow_virtual email : String
  allow_virtual password : String

  def submit
    if valid_credentials?
      yield self, user_from_email
    else
      yield self, nil
    end
  end

  private def valid_credentials?
    if user_from_email && !passwords_match?
      password.add_error "is incorrect"
    elsif user_from_email.nil?
      email.add_error "was not found"
    end
  end

  private def user_from_email
    UserQuery.new.email(email.value).first?
  end

  private def passwords_match?; end # check the password
end

# in an action
SignInForm.new(params).submit do |form, user|
  if user
    session[:current_user_id] = user.id.to_s
    redirect to: Dashboard::Show
  else
    render SignInPage, form: form
  end
end

Add .update with block

Support custom data types in schemas

Consider adding a `citext` type

https://www.postgresql.org/docs/9.1/static/citext.html

Add Form#errors

So you can loop through all the errors

Filter preloads

ArticleQuery.new.preload_comments(&.newest_first.preload_author)

Add form callbacks

validate
success
before_save
etc.

Add ability to order queries

Save inside of a transaction

crystal-lang/crystal-db#27

generate form_name based on the parent class

Right now if you have this:

class RegistrationForm < User::BaseForm
  allow email
end

The form name for email is user::base_form:email. It should be registration:email

Add `find` to Query objects

Add helper methods for TimeCritera

UserQuery.new.created_at.before(3.days.ago)
UserQuery.new.created_at.after(3.days.ago)
UserQuery.new.created_at.at_or_before(3.days.ago)
UserQuery.new.created_at.at_or_after(3.days.ago)

These are basically just aliases for lt, lte, gt, gte

These should go in the Time criteria: https://github.com/luckyframework/record/blob/master/src/lucky_record/charms/time_extensions.cr#L24

Mixin enumerable to easily work with queries

Allow bypassing default save method

So if you want to make associations required you could.

class CommentForm < Comment::BaseForm
  create_default_save_method false

  def self.save(params, article : Article)
    new(params).article_id(article.id).save
  end
end

Extract where logic to objects

This will make it a LOT easier to add new operators and fun stuff like "lower"

Support casting in changesets

Add database cleaning strategies - start with truncate

Helpful for use in tests. Do transactions later. They're faster

Add Time Type criteria

Add `blank?` method for `Bool`

Add class for handling updates with string params

Add objects for more advanced queries

, <, >=, <=, etc.

Add `#rows` to schema so you can access the rows object more easily

Default to Model::BaseRows unless ModelRows is defined

Add form_name to the field

That way it can be used to generate form fields in LuckyWeb

Add has_many

Use prepared statements

Better performance
Better protection against SQL injection

Add .save with block

Make inheritance of fields and callbacks a bit simpler

https://gitlab.com/Zatherz/magicjson/blob/master/src/magicjson/infect.cr#L3-29 Was really helpful for this

This will be done later once callbacks are changed to macros so that they can be easily included/inherited

Add class for handling single inserts with string params

Make a getter for @params in forms

Add way to use raw WHERE query

So that if there is something not implemented by LuckyRecord, user's can still do what they need to do when joining, using OR, etc.

Something like:

UserQuery.new.raw_where("users.name = #{PG::EscapeHelper.escape_literal("Paul")}")

This would likely be done by adding a @raw_where = [] of String to QueryBuilder that gets joined to the regular where clauses. Then adding a raw_where method to Queryable

Note

It will be helpful to add something to the guides that explains this AND explains how to generate a 100% custom query and parse with Lucky::Repo and DB.mapping. That's something that shouldn't require any code changes in LuckyRecord though.