exid 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aab9d8df36bc997b6839fb83b61ddc6d39d8a10ff9a3b4d7c54277e942d067c
-  data.tar.gz: 369a55471d75be3be5f57c8ed5a7c4a29816323327fb82451ed100d61de6879f
+  metadata.gz: e0b51f276cf5b4bac2e662b192b8410ce19c76e04aa93e1b4b6daa58fba00ddb
+  data.tar.gz: 4bf5b946a071e7eec2ce02f7bda93089f514f18daa1a858a58585952eea7c153
 SHA512:
-  metadata.gz: ebc8666f8a20f549ae7b8abefb1d82d8fa4a0a87c1d7c6455966190d3e9517fc502966637fe8a3ccc1be68060fb91e85d9c17b02992594481bb211d98a5f7599
-  data.tar.gz: 63ba0300682c8c6682811bec56cc7ba40db7d1f4dcf3a61d465171dd126a6ca2d9c99292bbdf2a0a3be3464802f4848b199190452317c6767bef99ba63d8c014
+  metadata.gz: 472e3a02ace26c1dd4acbf0109a3033f7273312fde90370bcbbe560416293e8bc51178c6c3859d31d4c46ee1c580f41213137091803c3a5f8d82630733f430ec
+  data.tar.gz: e8cec05ea307a1c28479135758b5705b0b5fd993a2aa6ee51f937e1fb6ba79a947c5b810487b6027de9a8639dea5e05da9ad479222bfe2c62c890391f492d0dc

data/README.md

@@ -1,43 +1,84 @@
 # Exid
 
-TODO: Delete this and the text below, and describe your gem
+**!! Warning: Documentation is not complete yet. Work in progress**
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/exid`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem implements helper methods for implementing External, Prefixed
+identifiers for records.
 
-## Installation
+Core `Exid::Coder.encode` accepts a string prefix with an UUID and
+returns an "external ID", composed of this prefix and zero-padded
+Base62-encoded UUID.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+For example: `prg, 018977bb-02f0-729c-8c00-2f384eccb763` => `prg_02TOxMzOS0VaLzYiS3NPd9`
 
-Install the gem and add to the application's Gemfile by executing:
+See more:
+  - https://dev.to/stripe/designing-apis-for-humans-object-ids-3o5a
+  - https://danschultzer.com/posts/prefixed-base62-uuidv7-object-ids-with-ecto
+  - https://dev.to/drnic/friendly-ids-for-ruby-on-rails-1c8p
+  - https://github.com/excid3/prefixed_ids
+  - https://github.com/sprql/uuid7-ruby
+  - https://github.com/steventen/base62-rb
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Usage
+
+Add a UUID or (preferably) UUIDv7 to your model include a helper module. Pass a
+prefix (String) and a field name (Symbol) to the `Exid::Record.new` method.
+
+```ruby
+class User < ApplicationRecord
+  include Exid::Record.new("user", :uuid)
+
+  # Optional, but recommended. Use the Exid value as the primary object
+  # identier.
+
+  def to_param = prefix_eid_value
+end
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+That's all. This will add certain class and instance methods to your object.
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+user = User.create!(uuid: "018977bb-02f0-729c-8c00-2f384eccb763")
 ```
 
-## Usage
+Following methods are now available on the instance class.
+
+```ruby
+user.prefix_eid_value # => "user_02TOxMzOS0VaLzYiS3NPd9"
 
-TODO: Write usage instructions here
+user.prefix_eid_prefix_name # => "user"
 
-## Development
+user.prefix_eid_field # => :uuid
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The `prefix_eid_handle` instanec method simply returns last 10 characters of
+identifier. This might be useful for displaying in the UI as distinguishing
+identifier.  If the UUID7 is used as the identifier, the first few characters
+are not random. They come from the timestamp, so they will be the same for most
+objects created at the same time. Pass integer as the argument to get the last
+N characters.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+user.prefix_eid_handle # => "OBtqZqRhLm"
 
-## Contributing
+user.prefix_eid_handle(6) # => "ZqRhLm"
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/exid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/exid/blob/main/CODE_OF_CONDUCT.md).
+The `Exid::Record` also offers couple of instance methods designed load
+records. This is another way to mimic Rails `GlobalID`. Warning: Steer
+away from using this as default way to load records using user supplied
+identifiers. User might replace the identifier with other record which might
+lead to unexpected results and security issues.
 
-## License
+The `fetch` class method will return the record or nil if not found. The
+`fetch!` variant will use Rails 7.1+ `sole` under the hood and raise an
+exception if the record is not found (or if more than one record is found).
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+Exid::Record.fetch!("pref_02WoeojY8dqVYcAhs321rm")
+Exid::Record.fetch("pref_02WoeojY8dqVYcAhs321rm")
+```
 
-## Code of Conduct
+## License
 
-Everyone interacting in the Exid project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/exid/blob/main/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/exid/base62.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Exid
+  class Base62
+    CHARS = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    BASE = CHARS.length
+    CHARS_HASH = CHARS.each_char.zip(0...BASE).to_h
+    MAX_LENGTH = 22
+
+    def self.encode(num)
+      result =
+        (1..).reduce("") do |acc, _|
+          break acc unless num.positive?
+
+          num, remainder = num.divmod(BASE)
+          CHARS[remainder] + acc
+        end
+
+      result.rjust(MAX_LENGTH, "0")
+    end
+
+    def self.decode(str)
+      max = str.length - 1
+      str.each_char.zip(0..max).reduce(0) do |acc, (char, index)|
+        acc + (CHARS_HASH[char] * (BASE**(max - index)))
+      end
+    end
+  end
+end

data/lib/exid/coder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# This class gets a string prefix and an UUID and returns an "external ID",
+# composed of this prefix and zero-padded Base62-encoded UUID. For example:
+# prg, 018977bb-02f0-729c-8c00-2f384eccb763 => prg_02TOxMzOS0VaLzYiS3NPd9
+
+# FIXME: 2025-05-20 - This is not very efficient, as the performance was
+# not a concern when this was written. There is lots of string operations
+# while encoding/decoding, which could be replaced by number operations.
+# At this point it is not worth the effort, as the performance is not
+# critical. It can encode around 100k/s and decode 50k/s on my laptop.
+
+# This could be a value objet, which could return various representations,
+# including the timestamp, the UUID, the prefix, or the object itself. For now
+# this is just a quick experiment to see where we go from here.
+#
+# See more:
+#   - https://dev.to/stripe/designing-apis-for-humans-object-ids-3o5a
+#   - https://danschultzer.com/posts/prefixed-base62-uuidv7-object-ids-with-ecto
+#   - https://dev.to/drnic/friendly-ids-for-ruby-on-rails-1c8p
+#   - https://github.com/excid3/prefixed_ids
+#   - https://github.com/sprql/uuid7-ruby
+#   - https://github.com/steventen/base62-rb
+
+module Exid
+  class DecodeError < StandardError; end
+
+  Result = Data.define(:prefix, :uuid) do
+    def deconstruct = [prefix, uuid]
+  end
+
+  module Coder
+    def self.encode(prefix, uuid)
+      [
+        prefix.to_s,
+        Base62.encode(uuid.delete("-").hex),
+      ].join("_")
+    end
+
+    def self.decode(eid)
+      prefix, base62 = eid.to_s.split("_", 2)
+
+      if prefix.nil? || base62.nil?
+        raise DecodeError, "Invalid EID #{eid.inspect}"
+      end
+
+      hex = Base62.decode(base62).to_s(16).rjust(32, "0")
+
+      Result.new(
+        prefix,
+        [hex[0..7], hex[8..11], hex[12..15], hex[16..19], hex[20..31]].join("-"),
+      )
+    end
+  end
+end

data/lib/exid/record.rb

@@ -0,0 +1,119 @@
+module Exid
+  class Record < Module
+    MUTEX = Mutex.new
+
+    Entry =
+      Data.define(:prefix, :field, :klass) do
+        def ==(other) = prefix == other.prefix
+        def hash = prefix.hash
+
+        alias_method :eql?, :==
+      end
+
+    @registered_modules = Set.new
+
+    def included(base)
+      base.send(:include, @module_value)
+      base.send(:include, @module_shared)
+      base.send(:extend, @module_shared)
+      base.send(:extend, @module_static)
+
+      self.class.register_module(
+        Entry.new(
+          prefix: base.prefix_eid_prefix_name,
+          field: base.prefix_eid_field,
+          klass: base,
+        ),
+      )
+    end
+
+    def initialize(prefix, field)
+      raise Error, "Prefix cannot be longer than 4 characters" if prefix.length > 4
+
+      @module_static = build_module_static(prefix, field)
+      @module_value = build_module_value(prefix, field)
+      @module_shared = build_module_shared(prefix, field)
+
+      super()
+    end
+
+    # When app is eager loaded in production, all models are loaded and
+    # registered. This logic with delte and readd is for development purpose,
+    # to make sure we can make changes to the app and have this logic working
+    # at the same time. We only use prefix as identify for the set elements.
+
+    def self.register_module(entry)
+      MUTEX.synchronize do
+        @registered_modules.delete(entry)
+        @registered_modules.add(entry)
+      end
+    end
+
+    def self.unload
+      MUTEX.synchronize do
+        @registered_modules = Set.new
+      end
+    end
+
+    def self.registered_modules
+      MUTEX.synchronize do
+        @registered_modules.dup
+      end
+    end
+
+    def self.find_module(prefix)
+      registered_modules.detect { it.prefix == prefix } or
+        raise Error, "Model for \"#{prefix}\" not found"
+    end
+
+    def self.finder(eid)
+      Coder.decode(eid) => prefix, value
+
+      mod = find_module(prefix)
+      mod.klass.where(mod.field => value)
+    end
+
+    def self.fetch(eid) = finder(eid).first
+    def self.fetch!(eid) = finder(eid).sole
+
+    private
+
+    def build_module_value(prefix, field)
+      Module.new do
+        define_method :prefix_eid_value do
+          Coder.encode(prefix, send(field))
+        end
+
+        # This is used to visually distingquish records on index pages. First
+        # bits of UUID7 are date, so they are shared among many records. Using
+        # last bytes of encoded of UUID7 is more likely to be unique. This for
+        # display only, do not use this to fetch records, etc.
+
+        define_method :prefix_eid_handle do |amount = 10|
+          prefix_eid_value.split("_").last[-amount..-1]
+        end
+      end
+    end
+
+    def build_module_shared(prefix, field)
+      Module.new do
+        define_method :prefix_eid_prefix_name do
+          prefix
+        end
+
+        define_method :prefix_eid_field do
+          field
+        end
+      end
+    end
+
+    def build_module_static(prefix, field)
+      Module.new do
+        define_method :prefix_eid_loader do |eid|
+          Coder.decode(eid) => ^prefix, value
+          find_sole_by(field => value)
+        end
+      end
+    end
+  end
+end

data/lib/exid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Exid
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/exid.rb

@@ -5,3 +5,10 @@ require_relative "exid/version"
 module Exid
   class Error < StandardError; end
 end
+
+require "forwardable"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+loader.eager_load

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: exid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - John Doe
 bindir: exe
 cert_chain: []
-date: 2025-04-04 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: This is a gem for managing external identifiers in Ruby programs.
 email:
 - test@example.com
@@ -17,11 +31,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/exid.rb
+- lib/exid/base62.rb
+- lib/exid/coder.rb
+- lib/exid/record.rb
 - lib/exid/version.rb
 - sig/exid.rbs
 homepage: https://github.com/marzdrel/exid
@@ -43,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Easy External identifier management for models
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations