{"id":15063659,"url":"https://github.com/senconscious/ecto_juno","last_synced_at":"2025-04-10T11:25:24.619Z","repository":{"id":62738237,"uuid":"551909945","full_name":"senconscious/ecto_juno","owner":"senconscious","description":"A simple query sorting library","archived":false,"fork":false,"pushed_at":"2024-03-31T10:27:05.000Z","size":49,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T11:12:26.122Z","etag":null,"topics":["ecto","elixir","query","sorting"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/senconscious.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-15T11:21:04.000Z","updated_at":"2022-11-20T13:03:32.000Z","dependencies_parsed_at":"2024-09-25T00:05:36.326Z","dependency_job_id":"75aaaa78-e840-4e6d-99c3-3f8acd71c17f","html_url":"https://github.com/senconscious/ecto_juno","commit_stats":{"total_commits":14,"total_committers":2,"mean_commits":7.0,"dds":0.0714285714285714,"last_synced_commit":"373b1309fd8ff99ea3baf1fb62b56ce25b89c826"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senconscious%2Fecto_juno","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senconscious%2Fecto_juno/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senconscious%2Fecto_juno/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senconscious%2Fecto_juno/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/senconscious","download_url":"https://codeload.github.com/senconscious/ecto_juno/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208618,"owners_count":21065203,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecto","elixir","query","sorting"],"created_at":"2024-09-25T00:05:31.213Z","updated_at":"2025-04-10T11:25:24.595Z","avatar_url":"https://github.com/senconscious.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EctoJuno\n\nA simple query sorting library\n\n## Installation\n\nAdd `:ecto_juno` to the list of dependencies in `mix.exs`\n\n```elixir\ndef deps do\n  [\n    {:ecto_juno, \"~\u003e 0.3.0\"}\n  ]\nend\n```\n\n## Configuration\n\nYou can specify default sorting field and mode in your config.exs:\n\n```elixir\n  config :ecto_juno, sort_by: :id, sort_direction: :desc\n```\n\nThe default sorting is by `inserted_at` field with `asc` mode\n\n## General sorting\n\nLets assume you have Accounts context with User schema and Repo module.\nTo sort users pass your query, schema module and params into `EctoJuno.Query.Sorting.sort_query/3`\n\n```elixir\n  alias EctoJuno.Query.Sorting\n\n  def list_sorted_users(params) do\n    User\n    |\u003e Sorting.sort_query(User, params)\n    |\u003e Repo.all()\n  end\n```\n\nWhere `params` structure is\n\n```elixir\n  %{\"sort_by\" =\u003e \"id\", \"sort_direction\" =\u003e \"desc\"}\n```\n\nYou can also pass sorting parameters keys as atoms:\n\n```elixir\n  Sorting.sort_query(query, User, %{sort_by: \"id\", sort_direction: \"desc\"})\n```\n\nMoreover, instead of the `User` schema module, you can pass a list of which elements are atoms:\n\n```elixir\n  Sorting.sort_query(query, [:id, :age, :name, :inserted_at], %{sort_by: \"id\", sort_direction: \"desc\"})\n```\n\nIf you not specify any of sorting parameters, than the default ones will be used:\n\n```elixir\n  # The default sort_direction will be used\n  Sorting.sort_query(query, User, %{sort_by: \"id\"})\n\n  # The default sort_by will be used\n  Sorting.sort_query(query, User, %{sort_direction: \"desc\"})\n\n  # The default sorting which configurable will be used\n  Sorting.sort_query(query, User)\n```\n\nIf you'll pass invalid sorting parameters, than default sorting ones will be used for your query:\n\n```elixir\n  Sorting.sort_query(query, User, %{sort_by: \"invalid_field\", sort_direction: \"invalid_mode\"})\n```\n\nby default will sort query by `inserted_at` field with `asc` mode\n\n## Sorting by joint query\n\nTo apply sorting by joint query use `EctoJuno.Query.Sorting.sort_query/4` which accepts the same arguments as\n`EctoJuno.Query.Sorting.sort_query/3` except new fourth argument - joint query binding name.\n\nLet's assume that you also have a posts table that related to users table as many to one. And posts have `title` column. Than your sorting function will be something like:\n\n```elixir\n  alias EctoJuno.Query.Sorting\n\n  def sort_users_by_posts do\n    params = %{\"sort_by\" =\u003e \"title\", \"sort_direction\" =\u003e \"desc\"}\n\n    User\n    |\u003e join(:left, [u], p in assoc(u, :posts), as: :posts)\n    |\u003e Sorting.sort_query(Post, params, :posts)\n    |\u003e Repo.all()\n  end\n```\n\nIf you provide binding that query doesn't have than sorting by base query in default mode will be applied\n\n## Custom sorting\n\nDefine your custom sorting module\n\n```elixir\n      defmodule Sample.UserSorting do\n        use EctoJuno.Query.SortingTemplate\n\n          # Maybe valid sort_by key for posts query provided\n          def prepare_sorting_params(\"post_\" \u003c\u003e field) do\n            {Post, field, :posts}\n          end\n\n          # No sort_by key case\n          def prepare_sorting_params(nil) do\n            {User, \"inserted_at\"}\n          end\n\n          # Maybe valid sort_by key for base query provided\n          def prepare_sorting_params(field) do\n            {User, field}\n          end\n      end\n```\n\nThen you can use it like\n\n```elixir\n  alias Sample.UserSorting\n\n  query = join(User, :left, [u], p in assoc(u, :posts), as: :posts)\n\n  # Sort users by posts title in desc mode\n  query\n  |\u003e UserSorting.sort_query(%{sort_by: \"post_title\", sort_direction: \"desc\"})\n  |\u003e Repo.all()\n\n  # Sort users by users age\n  query\n  |\u003e UserSorting.sort_query(%{\"sort_by\" =\u003e \"age\", \"sort_direction\" =\u003e \"desc\"})\n  |\u003e Repo.all()\n```\n\nPassing parameters may be done with a map either with string either atom keys. But not mixed.\n\n## Be aware of\n\n- Sorting with modes different from asc and desc is not supported\n- If you pass sort_by and sort_direction values not as strings you'll get exception\n\n## Testing\n\nClone repo: `git clone https://github.com/senconscious/ecto_juno`\n\n1. Set `DATABASE_URL` environment variable before running tests locally\n2. Run `mix check`\n\nTo test with docker: `docker compose build`\n1. Run: `docker compose build`\n2. Run: `docker-compose run --rm ecto_juno mix check`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenconscious%2Fecto_juno","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsenconscious%2Fecto_juno","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenconscious%2Fecto_juno/lists"}