rails_type_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b002a4e9136bfe9b886e13b8aaea8962f98b6ccf94e64dc875423c985fab6f8c
+  data.tar.gz: 7e245dcb3726845ddc8617cb91f2b6e79510baff72348d27124255855d79b3e6
+SHA512:
+  metadata.gz: eb7fb1c5a1953d4b6ce56aa3771b18001220bcb383413abf17157d4cd7644cc505ac6c8cefe30902d246cf15b297fffa631db674ef33a07852c9189d3a08ac19
+  data.tar.gz: d534f95fbbec9934890497da6b2c9b0a4e0d82189b66c8e176a57758d5c9353336147b6136343b1cd8ee18388be655b631d336452e9a0fd5528b8dd9100178df

data/.rubocop.yml

@@ -0,0 +1,25 @@
+plugins:
+  - rubocop-sorbet
+
+AllCops:
+  Enabled: true
+  NewCops: enable
+  TargetRubyVersion: 3.1
+  Exclude:
+    - 'vendor/**/*'
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Sorbet/HasSigil:
+  Enabled: true
+  MinimumStrictness: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.4.5

data/README.md

@@ -0,0 +1,46 @@
+# rails_type_id
+
+A gem that makes simple to use [TypeID](https://github.com/broothie/typeid-ruby) as the primary key for ActiveRecord models.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rails_type_id
+```
+
+## Usage
+
+### Declaring on models
+Add `RailsTypeId::Concern` to the model. This model's `id` field should have either a String or UUID database column type.
+
+```ruby
+# app/models/my_model.rb
+require "rails_type_id"
+
+class MyModel < ActiveRecord::Base
+    include RailsTypeId::Concern
+
+    # Prefix should be unique within your project
+    with_type_id_prefix("mm")
+end
+```
+
+### Using the `type_id` field
+
+Model instances will have a `type_id` field of type `TypeID`.
+
+```ruby
+my_model = MyModel.create!(..)
+my_model.id             #=> "019867fe-560f-7941-a7ed-8472639c7ace"
+my_model.type_id        #=> #<TypeID mm_01k1kzwngff50tfvc4e9hsrype>
+my_model.type_id.to_s   #=> mm_01k1kzwngff50tfvc4e9hsrype
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task :sorbet do
+  sh "bin/srb"
+end
+
+task default: %i[test rubocop sorbet]

data/lib/rails_type_id/concern.rb

@@ -0,0 +1,129 @@
+# typed: false # rubocop:disable Sorbet/HasSigil
+# frozen_string_literal: true
+
+require "active_model"
+require "active_support"
+require "sorbet-runtime"
+require "typeid"
+
+module RailsTypeId
+  # RailsTypeId::Concern is a Rails ActiveSupport::Concern that uses a Stripe-style "type ID"
+  # for its ID field.
+  module Concern
+    extend ::ActiveSupport::Concern
+    include ::ActiveModel::Validations::Callbacks
+
+    class InvalidTypeIdPrefix < StandardError; end
+
+    # Checks validity of the ActiveRecord model instances
+    class Validator < ActiveModel::Validator
+      def validate(record)
+        result = Helpers.validate_type_id_prefix(record.class.type_id_prefix)
+        record.errors.add(:type_id_prefix, result) if result
+      end
+    end
+
+    class_methods do
+      def with_type_id_prefix(prefix)
+        Helpers.validate_type_id_prefix!(prefix)
+
+        @_type_id_prefix = prefix
+      end
+
+      def type_id_prefix
+        @_type_id_prefix
+      end
+
+      def from_controller_id_param(type_id_str)
+        find(TypeID.from_string(type_id_str).uuid.to_s)
+      end
+    end
+
+    included do
+      attribute :id # Postgres UUID field
+
+      before_create :generate_uuid_v7
+      validates_with Validator
+
+      # Returns the TypeID for the model
+      # @return [TypeID]
+      define_method :type_id do
+        Helpers.validate_type_id_prefix!(self.class.type_id_prefix)
+        TypeID.from_uuid(self.class.type_id_prefix, id)
+      end
+
+      # If `id` is unset, generates a new UUID v7 and sets it
+      # @return [void]
+      define_method :generate_uuid_v7 do
+        case self.class.attribute_types["id"].type
+        when :uuid, :string
+          self.id ||= SecureRandom.uuid_v7
+        end
+      end
+
+      define_method :to_param do
+        type_id.to_s
+      end
+    end
+
+    # Internal helper methods
+    class Helpers
+      extend T::Sig
+
+      class << self
+        def validate_type_id_prefix(prefix)
+          return "type_id_prefix cannot be nil" if prefix.nil?
+
+          return nil if prefix.match(/\A[a-z]{1,10}\z/)
+
+          "type_id_prefix must be lowercase alphabetic (a-z) with length >= 1, <= 10"
+        end
+
+        def validate_type_id_prefix!(prefix)
+          result = validate_type_id_prefix(prefix)
+          raise InvalidTypeIdPrefix, result if result.present?
+        end
+
+        def lookup_type_id(type_id)
+          klasses = lookup_model(type_id)
+          return if klasses.nil?
+
+          id = type_id # TODO: parse out the uuid part
+          klasses.each do |klass|
+            result = klass.find_by(id: id)
+            return result unless result.nil?
+          end
+
+          nil
+        end
+
+        def lookup_model(type_id)
+          prefix = get_prefix(type_id)
+          return if prefix.nil?
+
+          prefix_map[prefix]
+        end
+
+        def get_prefix(id)
+          prefix, = parse_id(id)
+          prefix
+        end
+
+        private
+
+        def parse_id(id)
+          id.split("_")
+        end
+
+        def prefix_map
+          Rails.application.eager_load!
+          # This has to be group_by and not index_by because we can have multiple
+          # models that use the same prefix (like Settings)
+          @prefix_map ||= ActiveRecord::Base.descendants
+                                            .select { |klass| klass.respond_to?(:type_id_prefix) }
+                                            .group_by(&:type_id_prefix)
+        end
+      end
+    end
+  end
+end

data/lib/rails_type_id/require.rb

@@ -0,0 +1,6 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative "version"
+require_relative "concern"
+require_relative "test_helper"

data/lib/rails_type_id/test_helper.rb

@@ -0,0 +1,16 @@
+# typed: true
+# frozen_string_literal: true
+
+module RailsTypeId
+  # Static helpers for testing Rails models with type IDs
+  module TestHelper
+    def models_missing_type_id_prefix(base_class:, ignore_classes: [])
+      Rails.application.eager_load!
+      base_class.descendants.select do |klass|
+        next if ignore_classes.include?(klass)
+
+        !klass.respond_to?(:type_id_prefix)
+      end
+    end
+  end
+end

data/lib/rails_type_id/version.rb

@@ -0,0 +1,6 @@
+# typed: true
+# frozen_string_literal: true
+
+module RailsTypeId
+  VERSION = "0.1.0"
+end

data/lib/rails_type_id.rb

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative "rails_type_id/require"
+
+module RailsTypeId
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/tapioca/dsl/compilers/rails_type_id_compiler.rb

@@ -0,0 +1,49 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "tapioca"
+
+require_relative "../../../rails_type_id/concern"
+
+module Tapioca
+  module Dsl
+    module Compilers
+      # This Tapioca compiler generates RBI for Rails models that include RailsTypeId::Concern.
+      class RailsTypeIdCompiler < Tapioca::Dsl::Compiler
+        extend T::Sig
+
+        ConstantType = type_member { { fixed: T.class_of(RailsTypeId::Concern) } }
+
+        RBI_MODULE_NAME = "RailsTypeIdMethods"
+
+        class << self
+          extend T::Sig
+
+          sig { override.returns(T::Enumerable[Module]) }
+          def gather_constants
+            all_classes
+              .select { |c| c < RailsTypeId::Concern }
+          end
+        end
+
+        sig { override.void }
+        def decorate
+          root.create_path(constant) do |klass|
+            klass.create_module(RBI_MODULE_NAME) do |methods_mod|
+              methods_mod.create_method(
+                "type_id",
+                return_type: "TypeID"
+              )
+
+              methods_mod.create_method(
+                "to_param",
+                return_type: "String"
+              )
+            end
+            klass.create_include(RBI_MODULE_NAME)
+          end
+        end
+      end
+    end
+  end
+end

data/sig/rails_type_id.rbs

@@ -0,0 +1,4 @@
+module RailsTypeId
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore=vendor/
+

data/sorbet/rbi/annotations/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-vendored=true

data/sorbet/rbi/annotations/actionmailer.rbi

@@ -0,0 +1,10 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This file was pulled from a central RBI files repository.
+# Please run `bin/tapioca annotations` to update it.
+
+class ActionMailer::Base
+  sig { params(headers: T.untyped, block: T.nilable(T.proc.params(arg0: ActionMailer::Collector).void)).returns(Mail::Message) }
+  def mail(headers = nil, &block); end
+end