sqids / sqids-elixir Goto Github PK

Hi,

I'd like to contribute an Elixir implementation of sqids.

@4kimov

Like in Elixir’s hashids lib mentioned in the website. Params will rarely change, so this makes sense as a simpler alternative to generating code with use Sqids, when we wish to ease management of context.

In other words: support @sqids Sqids.new!(…) -like usage.

It's configured; all that's missing is enabling it in repo settings.

No need to break builds in Sqids dependents due to warnings that may show up in the future.

At the moment, I'm the sole owner: https://hex.pm/packages/sqids

Not ideal as far as the bus factor goes.

https://sqids.org/elixir

This is setup as a GHA workflow which is to run daily (schedule currently disabled) and invokes a shell script which runs the Elixir updater script itself, which automatically updates the dependency locks and the changelog upon there being any changes.

Upon that happening, a branch is pushed and a PR is opened.

All that's likely missing is setting up additional permissions in the repo settings.

It would be helpful to users who are familiar with the existing elixir hashid lib https://github.com/alco/hashids-elixir to know how you compare.

As of time of writing, this is not yet the case:
https://github.com/sqids/sqids-elixir/actions/runs/9194903873

Why decode!/2 does not have a public non-throwing counterpart?

I've just tried integrating this into an app as I like the ID format, but it crashes in production due to the assert you are using from ExUnit. It would be great to have something in the docs about this, although I'd argue you shouldn't be using it in non-test code

This was the error:

    ** (UndefinedFunctionError) function ExUnit.Assertions.__equal__?/2 is undefined (module ExUnit.Assertions is not available)
        ExUnit.Assertions.__equal__?(22, nil)
        (sqids 0.1.2) lib/sqids/alphabet.ex:113: Sqids.Alphabet.index_of!/2
        (sqids 0.1.2) lib/sqids.ex:426: Sqids.decode_valid_id/2
        (sqids 0.1.2) lib/sqids.ex:165: Sqids.decode!/2

I'm using the compile time config