Fix dialyzer #2
Fix dialyzer #2
Conversation
|
Oh! and attempting to call |
| @type query :: Ecto.Query | Ecto.Schema | ||
| @type filter_params :: Keyword.t | map | ||
| @type queryable :: module | Ecto.Query.t() |
There was a problem hiding this comment.
Some of the issues were around using Ecto.Schema or Ecto.Schema.t() when the spec needed was module (atom)
| @type aggregate_options :: :avg | :count | :max | :min | :sum | ||
| @type schema_list :: list(Ecto.Schema.t) | [] | ||
| @type schema_res :: {:ok, Ecto.Schema.t} | {:error, String.t} | ||
| @type schema_res :: {:ok, Ecto.Schema.t()} | {:error, String.t()} |
There was a problem hiding this comment.
Sorry, my formatter is going buck wild on these brackets. Let me know if this is an issue and I will get it reverted.
| @spec all(queryable :: query) :: schema_list | ||
| @spec all(queryable) :: [Ecto.Schema.t()] |
There was a problem hiding this comment.
This was totally unnecessary on my part.
| def find_or_create(schema, params) do | ||
| with {:error, %{code: :not_found}} <- find(schema, params) do | ||
| def find_or_create(query, params) do | ||
| with {:error, _} <- find(query, params) do |
There was a problem hiding this comment.
Not sure if this was the right move here. It didn't want to pattern match according to dialyzer. Are there other error codes?
| @spec preload_changeset_assoc(Changeset.t, atom, list(integer)) :: Changeset.t | ||
| @spec preload_changeset_assoc(Changeset.t, atom, keyword) :: Changeset.t |
There was a problem hiding this comment.
I think this was a good catch :)
| is_nil(params_data) -> cast_assoc(changeset, key, opts) | ||
| Enum.empty?(params_data) -> |
There was a problem hiding this comment.
This is another good one. I believe this can only be a list and cannot be nil
| @spec query_schema(Ecto.Query.t) :: Ecto.Schema.t | ||
| @spec query_schema(Ecto.Query.t) :: module | ||
| @doc "Pulls the schema from a query" | ||
| def query_schema(%{from: %{source: {_, schema}}}), do: query_schema(schema) | ||
| def query_schema(%{from: %{query: %{from: {_, schema}}}}), do: schema |
There was a problem hiding this comment.
Returns a module name (atom) not a struct
| defmodule EctoShorts.Repo do | ||
| @moduledoc "This module is responsible for calling repo from config" | ||
| @type queryable :: module | Ecto.Query.t() | ||
| @type aggregates :: :avg | :count | :max | :min | :sum | ||
| @type structs_or_struct_or_nil :: [Ecto.Schema.t()] | Ecto.Schema.t() | nil | ||
|
|
||
| def call(func, args) do | ||
| @spec insert(Ecto.Changeset.t()) :: {:error, Ecto.Changeset.t()} | {:ok, Ecto.Schema.t()} | ||
| def insert(changeset), do: call(:insert, [changeset]) | ||
|
|
||
| @spec delete(Ecto.Schema.t()) :: {:error, Ecto.Changeset.t()} | {:ok, Ecto.Schema.t()} | ||
| def delete(struct), do: call(:delete, [struct]) | ||
|
|
||
| @spec update(Ecto.Changeset.t()) :: {:error, Ecto.Changeset.t()} | {:ok, Ecto.Schema.t()} | ||
| def update(changeset), do: call(:update, [changeset]) | ||
|
|
||
| @spec get(queryable, integer) :: nil | Ecto.Schema.t() | ||
| def get(module, id), do: call(:get, [module, id]) | ||
|
|
||
| @spec one(Ecto.Query.t()) :: nil | Ecto.Schema.t() | ||
| def one(query), do: call(:one, [query]) | ||
|
|
||
| @spec all(queryable) :: [Ecto.Schema.t()] | ||
| def all(query), do: call(:all, [query]) | ||
|
|
||
| @spec preload(structs_or_struct_or_nil, any, keyword) :: structs_or_struct_or_nil | ||
| def preload(structs_or_struct_or_nil, preloads, opts) do | ||
| call(:preload, [structs_or_struct_or_nil, preloads, opts]) | ||
| end | ||
|
|
||
| @spec aggregate(Ecto.Queryable.t(), aggregates, atom, keyword) :: any | nil | ||
| def aggregate(queryable, aggregate, field, opts), | ||
| do: call(:aggregate, [queryable, aggregate, field, opts]) | ||
|
|
||
| @spec stream(Ecto.Query.t()) :: Enum.t() | ||
| def stream(query), do: call(:stream, [query]) | ||
|
|
||
| defp call(func, args) do | ||
| apply(repo(), func, args) | ||
| end | ||
|
|
There was a problem hiding this comment.
I don't know whether this was really needed, I was having trouble tracing all the possibilities and I think that dialyzer just had too many possible inputs and outputs here. I separated them out and a lot of difficulties evaporated. There shouldn't be any actual change in your library's logic.
|
Closing for now, but would be willing to take another crack at this in the future 👍 |
Round 2!
I was having trouble integrating your library with my Dialyzer specs, and have some dialyzer fixes for you!
I use a lot of tooling, including a formatter, and did my best to hold it back from formatting your whole code base with mixed success. Let me know what I can revert!
Before:
After: