typeid_rails 0.1.0

data/sig/typeid_rails/model_options.rbs

@@ -0,0 +1,26 @@
+module TypeidRails
+  # See the note on _IdentifiableClass: this is the surface of the including class
+  # that the `class_methods` block body uses.
+  interface _ModelOptionsClass
+    def typeid_rails_options: () -> Hash[Symbol, bool]
+    def typeid_rails_options=: (Hash[Symbol, bool] options) -> Hash[Symbol, bool]
+  end
+
+  module ModelOptions : Module, _ModelOptionsClass
+    extend ActiveSupport::Concern
+
+    KEYS: Array[Symbol]
+
+    # Merges into the inherited options and returns the result.
+    def typeid_options: (**bool options) -> Hash[Symbol, bool]
+
+    private
+
+    def build_typeid_type: (String prefix, ?strict: bool?, ?fuzzy: bool?) -> Type
+
+    # Generated by ActiveSupport::Concern; extended into the including class.
+    module ClassMethods
+      def typeid_options: (**bool options) -> Hash[Symbol, bool]
+    end
+  end
+end

data/sig/typeid_rails/polymorphic_type.rbs

@@ -0,0 +1,12 @@
+module TypeidRails
+  class PolymorphicType < Type
+    def initialize: (?strict: bool, ?fuzzy: bool?) -> void
+
+    def deserialize: (untyped value) -> String?
+    def cast: (untyped value) -> String?
+    def serialize: (untyped value) -> String?
+
+    private
+    def parse_or_null: (String string) -> Value?
+  end
+end

data/sig/typeid_rails/railtie.rbs

@@ -0,0 +1,4 @@
+module TypeidRails
+  class Railtie < ::Rails::Railtie
+  end
+end

data/sig/typeid_rails/registry.rbs

@@ -0,0 +1,17 @@
+module TypeidRails
+  module Registry
+    type model = Module
+
+    self.@prefixes: Hash[String, model]
+    self.@models: Hash[model, String]
+
+    def self.register: (String prefix, model model) -> model
+    def self.all_prefixes: () -> Hash[String, model]
+    def self.model_for: (String prefix) -> model?
+    def self.prefix_for: (model model) -> String?
+    def self.reset!: () -> void
+
+    private
+    def self.name_of: (model model) -> String
+  end
+end

data/sig/typeid_rails/type.rbs

@@ -0,0 +1,23 @@
+module TypeidRails
+  class Type < ActiveRecord::Type::Value
+    attr_reader prefix: String
+
+    @strict: bool
+    @fuzzy: bool?
+
+    def initialize: (prefix: String, ?strict: bool, ?fuzzy: bool?) -> void
+
+    def strict?: () -> bool
+    def fuzzy?: () -> bool
+    def type: () -> Symbol
+    def deserialize: (untyped value) -> String?
+    def cast: (untyped value) -> String?
+    def serialize: (untyped value) -> untyped
+    def changed_in_place?: (untyped raw_old_value, untyped new_value) -> bool
+
+    private
+    def cast_string: (String string) -> String
+    def string_to_uuid: (String string) -> String
+    def parse_or_null: (String string) -> Value?
+  end
+end

data/sig/typeid_rails/value.rbs

@@ -0,0 +1,24 @@
+module TypeidRails
+  class Value
+    PREFIX_FORMAT: Regexp
+
+    attr_reader uuid: String
+    attr_reader prefix: String
+    attr_reader encoded: String
+
+    def initialize: (uuid: String, prefix: String, encoded: String) -> void
+
+    def self.valid_prefix?: (untyped prefix) -> bool
+    def self.validate_prefix!: (untyped prefix) -> void
+    def self.from_uuid: (String uuid, prefix: String) -> Value
+    def self.generate: (prefix: String, ?version: Integer) -> Value
+    def self.parse: (String? string, ?expected_prefix: String?, ?fuzzy: bool) -> Value?
+
+    def to_s: () -> String
+    def to_uuid: () -> String
+    def ==: (untyped other) -> bool
+    def eql?: (untyped other) -> bool
+    def hash: () -> Integer
+    def inspect: () -> String
+  end
+end

data/sig/typeid_rails.rbs

@@ -0,0 +1,9 @@
+module TypeidRails
+  VERSION: String
+
+  def self.encode: (String uuid, prefix: String) -> String
+  def self.generate: (prefix: String, ?version: Integer) -> String
+  def self.parse: (String? string, ?expected_prefix: String?, ?fuzzy: bool) -> Value?
+  def self.to_uuid: (String? prefixed_id, ?expected_prefix: String?, ?fuzzy: bool) -> String?
+  def self.derive_uuid: (*String parts) -> String
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: typeid_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorah Fukumori
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Renders a 128-bit UUID as a TypeID, a short type-tagged string such as
+  "user_2n1t201rmv87aae5j4csam8000", and parses it back. Includes an ActiveRecord
+  attribute type and an optional deterministic SHAKE128 derivation.
+email:
+- sorah@ivry.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typeid_rails.rb
+- lib/typeid_rails/active_record.rb
+- lib/typeid_rails/association_support.rb
+- lib/typeid_rails/base32.rb
+- lib/typeid_rails/configuration.rb
+- lib/typeid_rails/derivation.rb
+- lib/typeid_rails/encoder.rb
+- lib/typeid_rails/errors.rb
+- lib/typeid_rails/identifiable.rb
+- lib/typeid_rails/model_options.rb
+- lib/typeid_rails/polymorphic_type.rb
+- lib/typeid_rails/railtie.rb
+- lib/typeid_rails/registry.rb
+- lib/typeid_rails/type.rb
+- lib/typeid_rails/value.rb
+- lib/typeid_rails/version.rb
+- sig/typeid_rails.rbs
+- sig/typeid_rails/association_support.rbs
+- sig/typeid_rails/base32.rbs
+- sig/typeid_rails/configuration.rbs
+- sig/typeid_rails/derivation.rbs
+- sig/typeid_rails/encoder.rbs
+- sig/typeid_rails/errors.rbs
+- sig/typeid_rails/identifiable.rbs
+- sig/typeid_rails/model_options.rbs
+- sig/typeid_rails/polymorphic_type.rbs
+- sig/typeid_rails/railtie.rbs
+- sig/typeid_rails/registry.rbs
+- sig/typeid_rails/type.rbs
+- sig/typeid_rails/value.rbs
+homepage: https://github.com/sorah/typeid_rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sorah/typeid_rails
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: TypeID identifiers for UUID primary keys in Rails
+test_files: []