based_uuid 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44d2023b06834d9043fc245f4df1a8963a360337dfdde32f8bb99b579f4ab317
-  data.tar.gz: 7a5c34de026288973f1a41bb7a49f176ec2bdb77b6ed2d3ff68096311b3f1715
+  metadata.gz: 5499342189f8b46811d3d620d6074dbd6620bc3cbc8882f39261b428a5fbcc41
+  data.tar.gz: 4ed71b83bf2f7271466256c5a215f217ba4c300665aeb895e6fa2da2b1308ea9
 SHA512:
-  metadata.gz: 3369d39151be720015bbdc9a330631405b5d90e9021755500d933cfd60dd9b432eda9d25de220e612d4393a4bcb71d057ba82c31cc5da83054828d7c34648283
-  data.tar.gz: 982f29d49439441ede750b3fa1c6cb06a09aec805a4745ac8ae0b2ef3f9f2cd5cdf96a4a8c3394c4617333e536dbaff2e01810d77dd8a6b00bd34e2fe2b89a5e
+  metadata.gz: edaf5ab4385cb65dff10739d12801b98c0085fb9d54d9841c480783c014ff47d2359b16acaf03b426a7a17049968f0bea1d54e0cc5063d4679105bb5813a9655
+  data.tar.gz: c81d9c3aa7c122516c846cb0470b45d2352f2db8bcc051a22c6da6d5d7f9a33892dab095f719677512cfd9d29d8f891f971c1d084f212cbe4283ea76425a87c5

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

@@ -73,6 +73,26 @@ 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:

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.1".freeze
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: based_uuid
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 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