based_uuid 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b33dff554590869533e56e76997cf63cd436acd9bd0d95a86c574ea1419d63
-  data.tar.gz: 2b98906ea6459f21d32c9ec0170cd443333a2529570f6cf8d9731d117792d529
+  metadata.gz: 44d2023b06834d9043fc245f4df1a8963a360337dfdde32f8bb99b579f4ab317
+  data.tar.gz: 7a5c34de026288973f1a41bb7a49f176ec2bdb77b6ed2d3ff68096311b3f1715
 SHA512:
-  metadata.gz: 1592b674765c4230b53adac6071197d812cef83ea8237523e713db4e64dbc2c1d0e9f383d20c2f132bd3c64f702b4b0ad112977b44e87e8501c7c5d92febdce0
-  data.tar.gz: a9b2f1c4d393c7c8c84b21b76f1d3b54c2df4582b237738dd9f6ecfc0339339ddf1333739d5b4ce399da01b8306411c870f4b1c9c7a6217de5777a46c9d76546
+  metadata.gz: 3369d39151be720015bbdc9a330631405b5d90e9021755500d933cfd60dd9b432eda9d25de220e612d4393a4bcb71d057ba82c31cc5da83054828d7c34648283
+  data.tar.gz: 982f29d49439441ede750b3fa1c6cb06a09aec805a4745ac8ae0b2ef3f9f2cd5cdf96a4a8c3394c4617333e536dbaff2e01810d77dd8a6b00bd34e2fe2b89a5e

data/README.md

@@ -1,4 +1,4 @@
-# BasedUUID: double-clickable, URL-friendly UUIDs for your Rails models
+# 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)
 
@@ -6,13 +6,13 @@
 Generate “double-clickable”, URL-friendly UUIDs with (optional) prefixes:
 
 ```
-user_4yoiald3wfbvpeu2sbsk7cssdi
-acc_ejwqg7b3gvaphiylb25xq545tm
+user_763j02ryxh8dbs56mgcjqrmmgt #=> e61c802c-7bb1-4357-929a-9064af8a521a
+bpo_12dm1qresn83st62reqdw7f7cv  #=> 226d037c-3b35-40f3-a30b-0ebb78779d9b
 ```
 
-This gem works by encoding UUIDs into 26-character lowercase strings using [Crockford’s base32](https://www.crockford.com/base32.html) encoding. The optional prefix helps you identify the model it represents.
+This gem encodes UUID primary keys into 26-character lowercase strings using [Crockford’s base32](https://www.crockford.com/base32.html) encoding. The optional prefix helps you identify the model it represents.
 
-BasedUUID doesn’t affect how your ActiveRecord primary key UUIDs are stored in the database. Prefix and base32 encoding are only used for presentation.
+BasedUUID assumes that you have a [UUID primary key](https://guides.rubyonrails.org/v5.0/active_record_postgresql.html#uuid) (`id`) in your ActiveRecord model. It doesn’t affect how your primary key UUIDs are stored in the database. Prefixes and base32-encoded strings are only used for presentation.
 
 ## Installation
 
@@ -24,7 +24,7 @@ gem "based_uuid"
 
 ## Usage
 
-BasedUUID assumes that you have a [UUID primary key](https://guides.rubyonrails.org/v5.0/active_record_postgresql.html#uuid) in your ActiveRecord model.
+Add the following line to your model class:
 
 ```ruby
 class BlogPost < ApplicationRecord
@@ -32,8 +32,8 @@ class BlogPost < ApplicationRecord
 end
 
 post = BlogPost.last
-post.based_uuid #=> bpo_3ah4veflijgy7de6bflk7k4ld4
-post.based_uuid(prefix: false) #=> 3ah4veflijgy7de6bflk7k4ld4
+post.based_uuid #=> bpo_12dm1qresn83st62reqdw7f7cv
+post.based_uuid(prefix: false) #=> 12dm1qresn83st62reqdw7f7cv
 ```
 
 ### Lookup
@@ -41,13 +41,13 @@ post.based_uuid(prefix: false) #=> 3ah4veflijgy7de6bflk7k4ld4
 BasedUUID includes a `find_by_based_uuid` model method to look up records:
 
 ```ruby
-BlogPost.find_by_based_uuid("bpo_3ah4veflijgy7de6bflk7k4ld4")
+BlogPost.find_by_based_uuid("bpo_12dm1qresn83st62reqdw7f7cv")
 
 # or without the prefix:
-BlogPost.find_by_based_uuid("3ah4veflijgy7de6bflk7k4ld4")
+BlogPost.find_by_based_uuid("12dm1qresn83st62reqdw7f7cv")
 
 # there’s also the bang version:
-BlogPost.find_by_based_uuid!("3ah4veflijgy7de6bflk7k4ld4")
+BlogPost.find_by_based_uuid!("12dm1qresn83st62reqdw7f7cv")
 ```
 
 ### Generic lookup
@@ -55,17 +55,17 @@ BlogPost.find_by_based_uuid!("3ah4veflijgy7de6bflk7k4ld4")
 The gem provides a generic lookup method to help you find the correct model for the UUID, based on prefix:
 
 ```ruby
-BasedUUID.find("bpo_3ah4veflijgy7de6bflk7k4ld4")
+BasedUUID.find("bpo_12dm1qresn83st62reqdw7f7cv")
 #=> #<BlogPost>
-BasedUUID.find("acc_ejwqg7b3gvaphiylb25xq545tm")
-#=> #<Account>
+BasedUUID.find("user_763j02ryxh8dbs56mgcjqrmmgt")
+#=> #<User>
 ```
 
 **⚠️ NOTE:** Rails lazy-loads models in the development environment, so this method won’t know about your models until you’ve referenced them at least once. If you’re using this method in a Rails console, you’ll need to run `BlogPost` (or any other model) before you can use it.
 
 ### BasedUUID as default URL identifiers
 
-BasedUUID aims to be unintrusive and it doesn’t affect how Rails URLs are generated, so if you want to use it as default URL param, add this to your model:
+BasedUUID aims to be non-intrusive and it doesn’t affect how Rails URLs are generated, so if you want to use it as default URL param, add this to your model:
 
 ```ruby
 def to_param
@@ -73,6 +73,15 @@ def to_param
 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", prefix: :bpo)
+BasedUUID.decode("bpo_12dm1qresn83st62reqdw7f7cv")
+```
+
 * * *
 
 ## Development
@@ -89,4 +98,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pch/ba
 
 This gem is heavily inspired by [Stripe IDs](https://stripe.com/docs/api) and the [prefixed_ids](https://github.com/excid3/prefixed_ids/tree/master) gem by Chris Oliver.
 
-Parts of the base32 encoding code are borrowed from the [ulid gem](https://github.com/rafaelsales/ulid) by Rafael Sales.
+Parts of the base32 encoding code are borrowed from the [ulid](https://github.com/rafaelsales/ulid) gem by Rafael Sales.

data/lib/based_uuid/has_based_uuid.rb

@@ -41,7 +41,7 @@ module BasedUUID
     def based_uuid(prefix: true)
       raise ArgumentError, "UUID is empty" if _primary_key_value.blank?
 
-      BasedUUID.based_uuid(uuid: _primary_key_value, prefix: prefix ? self.class._based_uuid_prefix : nil)
+      BasedUUID.encode(uuid: _primary_key_value, prefix: prefix ? self.class._based_uuid_prefix : nil)
     end
 
     private

data/lib/based_uuid/version.rb

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

data/lib/based_uuid.rb

@@ -30,11 +30,16 @@ module BasedUUID
       [prefix.presence, uuid_base32]
     end
 
-    def based_uuid(uuid:, prefix:)
+    def encode(uuid:, prefix:)
       uuid_base32 = Base32UUID.encode(uuid)
       return uuid_base32 unless prefix
 
       "#{prefix}#{delimiter}#{uuid_base32}"
     end
+
+    def decode(token)
+      _, uuid_base32 = split(token)
+      Base32UUID.decode(uuid_base32)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: based_uuid
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Chmolowski