based_uuid 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44d2023b06834d9043fc245f4df1a8963a360337dfdde32f8bb99b579f4ab317
-  data.tar.gz: 7a5c34de026288973f1a41bb7a49f176ec2bdb77b6ed2d3ff68096311b3f1715
+  metadata.gz: 5efa8c1cc0d82b116e8e4bfd6a5170bb83fd01258f19eb35b32aa28a0bc39804
+  data.tar.gz: 15e4f3a03f286ec1bbc40f3fd1da6d19c2d5b0b17db9718762d4a632966484ac
 SHA512:
-  metadata.gz: 3369d39151be720015bbdc9a330631405b5d90e9021755500d933cfd60dd9b432eda9d25de220e612d4393a4bcb71d057ba82c31cc5da83054828d7c34648283
-  data.tar.gz: 982f29d49439441ede750b3fa1c6cb06a09aec805a4745ac8ae0b2ef3f9f2cd5cdf96a4a8c3394c4617333e536dbaff2e01810d77dd8a6b00bd34e2fe2b89a5e
+  metadata.gz: a94e6cf70c7cc5954f97c2720032885ad7bee008f30e41dd6af341c67ad04756940d4e5a8d865d33135abf737a0ed4c9170812d7135e711e848e68d23442b9ec
+  data.tar.gz: f7eba4f45b4deaadd65d4ac731411bc86a15b47197972bb9ee4c2f0f5ede773a99d79a6b3f50a3a30cc5b47c845f564cc89d628e18d9a28fce67b055b0d6b801

data/.rubocop.yml

@@ -23,3 +23,7 @@ Layout/LineLength:
 
 Naming/PredicateName:
   Enabled: false
+
+# https://github.com/rubocop/rubocop/issues/7298
+Lint/UselessAccessModifier:
+  Enabled: false

data/README.md

@@ -1,7 +1,6 @@
 # BasedUUID: URL-friendly UUIDs for Rails models
 
-[![Build Status](https://github.com/pch/based_uuid/workflows/Tests/badge.svg)](https://github.com/pch/based_uuid/actions) [![Gem Version](https://badge.fury.io/rb/based_uuid.svg)](https://badge.fury.io/rb/based_uuid)
-
+[![Build Status](https://github.com/pch/based_uuid/workflows/Tests/badge.svg)](https://github.com/pch/based_uuid/actions)
 
 Generate “double-clickable”, URL-friendly UUIDs with (optional) prefixes:
 
@@ -73,11 +72,32 @@ def to_param
 end
 ```
 
+### Custom UUID column name
+
+`BasedUUID` will respect the value of `Model.primary_key`, so it supports custom primary key names:
+
+```ruby
+class Transaction < ApplicationRecord
+  self.primary_key = "txid"
+
+  has_based_uuid prefix: :tx
+end
+```
+
+If you want to use a different column, other than the primary key, you can pass it as an option to `has_based_uuid`:
+
+```ruby
+class Session < ApplicationRecord
+  has_based_uuid prefix: :sid, uuid_column: :session_id
+end
+```
+
 ### Use outside ActiveRecord
 
 BasedUUID can be used outside ActiveRecord, too. You can encode any UUID with it:
 
 ```ruby
+BasedUUID.encode(uuid: "226d037c-3b35-40f3-a30b-0ebb78779d9b")
 BasedUUID.encode(uuid: "226d037c-3b35-40f3-a30b-0ebb78779d9b", prefix: :bpo)
 BasedUUID.decode("bpo_12dm1qresn83st62reqdw7f7cv")
 ```

data/lib/based_uuid/has_based_uuid.rb

@@ -2,7 +2,6 @@ require "active_support/lazy_load_hooks"
 require "active_support/concern"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/class/attribute"
-require "active_record"
 
 module BasedUUID
   module HasBasedUUID
@@ -10,13 +9,16 @@ module BasedUUID
 
     included do
       class_attribute :_based_uuid_prefix
+      class_attribute :_based_uuid_column
     end
 
     class_methods do
-      def has_based_uuid(prefix: nil)
+      def has_based_uuid(prefix: nil, uuid_column: primary_key)
         include ModelExtensions
 
         self._based_uuid_prefix = prefix
+        self._based_uuid_column = uuid_column
+
         BasedUUID.register_model_prefix(prefix, self) if prefix
       end
     end
@@ -27,27 +29,34 @@ module BasedUUID
 
     class_methods do
       def find_by_based_uuid(token)
-        prefix, uuid_base32 = BasedUUID.split(token)
-        raise ArgumentError, "Invalid prefix" if prefix && prefix.to_sym != _based_uuid_prefix
-
-        find_by(primary_key => Base32UUID.decode(uuid_base32))
+        decode_and_find_based_uuid(token:)
       end
 
       def find_by_based_uuid!(token)
-        find_by_based_uuid(token) or raise ActiveRecord::RecordNotFound
+        decode_and_find_based_uuid(token:, raise_error: true)
+      end
+
+      private
+
+      def decode_and_find_based_uuid(token:, raise_error: false)
+        prefix, uuid_base32 = BasedUUID.split(token)
+        raise ArgumentError, "Invalid prefix" if prefix && prefix.to_sym != _based_uuid_prefix
+
+        method_name = raise_error ? :find_by! : :find_by
+        send(method_name, _based_uuid_column => Base32UUID.decode(uuid_base32))
       end
     end
 
     def based_uuid(prefix: true)
-      raise ArgumentError, "UUID is empty" if _primary_key_value.blank?
+      raise ArgumentError, "UUID is empty" if _uuid_column_value.blank?
 
-      BasedUUID.encode(uuid: _primary_key_value, prefix: prefix ? self.class._based_uuid_prefix : nil)
+      BasedUUID.encode(uuid: _uuid_column_value, prefix: prefix ? self.class._based_uuid_prefix : nil)
     end
 
     private
 
-    def _primary_key_value
-      self[self.class.primary_key]
+    def _uuid_column_value
+      self[self.class._based_uuid_column]
     end
   end
 end

data/lib/based_uuid/version.rb

@@ -1,3 +1,3 @@
 module BasedUUID
-  VERSION = "0.6.0".freeze
+  VERSION = "0.6.2".freeze
 end

data/lib/based_uuid.rb

@@ -30,7 +30,7 @@ module BasedUUID
       [prefix.presence, uuid_base32]
     end
 
-    def encode(uuid:, prefix:)
+    def encode(uuid:, prefix: nil)
       uuid_base32 = Base32UUID.encode(uuid)
       return uuid_base32 unless prefix
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: based_uuid
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Piotr Chmolowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement