{"id":16965001,"url":"https://github.com/propensive/inimitable","last_synced_at":"2025-03-21T17:27:37.634Z","repository":{"id":185396689,"uuid":"673485336","full_name":"propensive/inimitable","owner":"propensive","description":"UUIDs for Scala","archived":false,"fork":false,"pushed_at":"2025-01-26T12:14:31.000Z","size":1801,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-19T23:34:40.353Z","etag":null,"topics":["guid","scala","uuid-generator","uuids"],"latest_commit_sha":null,"homepage":"https://soundness.dev/inimitable/","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/propensive.png","metadata":{"files":{"readme":".github/readme.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"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":"2023-08-01T18:24:25.000Z","updated_at":"2025-01-26T12:14:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"de4462e7-d7ad-4f91-9b6b-c8701ab3c4cd","html_url":"https://github.com/propensive/inimitable","commit_stats":null,"previous_names":["propensive/inimitable"],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Finimitable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Finimitable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Finimitable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Finimitable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/inimitable/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244837061,"owners_count":20518559,"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":["guid","scala","uuid-generator","uuids"],"created_at":"2024-10-13T23:44:48.695Z","updated_at":"2025-03-21T17:27:37.611Z","avatar_url":"https://github.com/propensive.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg alt=\"GitHub Workflow\" src=\"https://img.shields.io/github/actions/workflow/status/propensive/inimitable/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/inimitable/actions)\n[\u003cimg src=\"https://img.shields.io/discord/633198088311537684?color=8899f7\u0026label=DISCORD\u0026style=for-the-badge\" height=\"24\"\u003e](https://discord.com/invite/MBUrkTgMnA)\n\u003cimg src=\"/doc/images/github.png\" valign=\"middle\"\u003e\n\n# Inimitable\n\n__UUIDs for Scala__\n\nUUIDs are a convenient and standardized way to assign IDs, with guarantees that\nthose IDs will be unique, not just within a local system, but globally across\nall systems. _Inimitable_ provides a few utilities for working with them.\n\n## Features\n\n- construct new UUIDs trivially\n- check hard-coded UUIDs at compiletime\n- parse UUIDs at runtime\n- XOR and invert UUIDs\n\n\n## Availability\n\n\n\n\n\n\n\n## Getting Started\n\nAll Inimitable terms and types are defined in the `inimitable` package:\n```scala\nimport inimitable.*\n```\n\n### Constructing a new UUID\n\nA UUID can be constructed with the `Uuid()` factory method. This will create a\nnew, and by definition, universally unique, identifier. The `Uuid` instance is\ncomposed of two 64-bit longs, `msb` (for \"most significant bits\") and `lsb`\n(\"least significant bits\"), implying (in theory) 128 bits of entropy.\n\n#### Specific UUIDs\n\nA particular UUID, for example `e6388c03-3dd2-4044-bb38-e58dbf8368fd`, may be\nconstructed using the `uuid\"\"` interpolator, like so,\n```scala\nval uuid = uuid\"e6388c03-3dd2-4044-bb38-e58dbf8368fd\"\n```\nwhich will parse (at compiletime) the UUID hex digits and their format\nensuring, in particular, that all are present to represent 128 bits of data.\n\nAdditionally, a `Uuid` can be created at runtime with,\n```scala\nval long1 = 234827342384709201L\nval long2 = 928160134367288378L\nval uuid2 = Uuid(long1, long2)\n```\nwhich will use the bits from `long1` and `long2`.\n\nAlternatively, a `Text` string containing a UUID can be parsed using\n[Spectacular](https://github.com/propensive/spectacular/)'s `decodeAs`\nextension method:\n```scala\nimport spectacular.decodeAs\nimport gossamer.t\nimport contingency.strategies.throwUnsafely\n\nval text = t\"e6388c03-3dd2-4044-bb38-e58dbf8368fd\"\nval uuid3 = text.decodeAs[Uuid]\n```\n\nThis will raise a `UuidError` if it is not in the correct format.\n\n### Methods on `Uuid`s\n\nTwo convenience methods are provided on `Uuid`s:\n- the unary `~` operator, which will construct a new `Uuid` by inverting its bits, and\n- the binary `^` operator, which will combine two `Uuid`s by XORing their bits\n\n\n## Status\n\nInimitable is classified as __maturescent__. For reference, Soundness projects are\ncategorized into one of the following five stability levels:\n\n- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity\n- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns\n- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement\n- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later\n- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipated\n\nProjects at any stability level, even _embryonic_ projects, can still be used,\nas long as caution is taken to avoid a mismatch between the project's stability\nlevel and the required stability and maintainability of your own project.\n\nInimitable is designed to be _small_. Its entire source code currently consists\nof 107 lines of code.\n\n## Building\n\nInimitable will ultimately be built by Fury, when it is published. In the\nmeantime, two possibilities are offered, however they are acknowledged to be\nfragile, inadequately tested, and unsuitable for anything more than\nexperimentation. They are provided only for the necessity of providing _some_\nanswer to the question, \"how can I try Inimitable?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Inimitable's build\n   structure, dependencies and source location; the file format should be short\n   and quite intuitive. Copy the sources into a source directory in your own\n   project, then repeat (recursively) for each of the dependencies.\n\n   The sources are compiled against the latest nightly release of Scala 3.\n   There should be no problem to compile the project together with all of its\n   dependencies in a single compilation.\n\n2. *Build with [Wrath](https://github.com/propensive/wrath/)*\n\n   Wrath is a bootstrapping script for building Inimitable and other projects in\n   the absence of a fully-featured build tool. It is designed to read the `fury`\n   file in the project directory, and produce a collection of JAR files which can\n   be added to a classpath, by compiling the project and all of its dependencies,\n   including the Scala compiler itself.\n   \n   Download the latest version of\n   [`wrath`](https://github.com/propensive/wrath/releases/latest), make it\n   executable, and add it to your path, for example by copying it to\n   `/usr/local/bin/`.\n\n   Clone this repository inside an empty directory, so that the build can\n   safely make clones of repositories it depends on as _peers_ of `inimitable`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Inimitable's dependencies.\n\n   If the build was successful, the compiled JAR files can be found in the\n   `.wrath/dist` directory.\n\n## Contributing\n\nContributors to Inimitable are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/inimitable/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Inimitable\neasier.\n\nPlease __do not__ contact project maintainers privately with questions unless\nthere is a good reason to keep them private. While it can be tempting to\nrepsond to such questions, private answers cannot be shared with a wider\naudience, and it can result in duplication of effort.\n\n## Author\n\nInimitable was designed and developed by Jon Pretty, and commercial support and\ntraining on all aspects of Scala 3 is available from [Propensive\nO\u0026Uuml;](https://propensive.com/).\n\n\n\n## Name\n\nThe name _Inimitable_ describes the core feature of UUIDs: that they are universally unique, and cannot be imitated.\n\nIn general, Soundness project names are always chosen with some rationale,\nhowever it is usually frivolous. Each name is chosen for more for its\n_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no\nbias towards names with positive or \"nice\" meanings—since many of the libraries\nperform some quite unpleasant tasks.\n\nNames should be English words, though many are obscure or archaic, and it\nshould be noted how willingly English adopts foreign words. Names are generally\nof Greek or Latin origin, and have often arrived in English via a romance\nlanguage.\n\n## Logo\n\nThe logo shows an arrangement of the 128 bits which form a UUID in a grid.\n\n## License\n\nInimitable is copyright \u0026copy; 2025 Jon Pretty \u0026 Propensive O\u0026Uuml;, and\nis made available under the [Apache 2.0 License](/license.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Finimitable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Finimitable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Finimitable/lists"}