uuid_v7 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94567f6de44869cfa3bd066891e55473aa7f00fa12034eb312d846d848da15b2
-  data.tar.gz: afe1f2896353a13a33f35fcd4435e0b1473ea5dcf2aad514fbdd6e7b1442b0cb
+  metadata.gz: c908c8d88e22891fb147c5663b41cafdc6af30bcac9fa1fbcfabc30b255968c0
+  data.tar.gz: 2c5b7a5d99ae22350e9456b07b51b33a2dab4ac72308cac434264b935c15387b
 SHA512:
-  metadata.gz: 5cae446d157e8da70b4c477f3cb608cdace0503a7bd5888400bc262d3735d6ebc269c0f98fb1cb9f04390cf26d3454bc225d558c8802eea8366bd6f82ba9a490
-  data.tar.gz: '0299d71e9c3148a04eda0b2d5cefa4bb1676e945f3db84862a4a7ce3f2c1d891ac4f70f3557caf6603f386b00e71cc1bf4d81d3e85e7eac283033dd798a452a7'
+  metadata.gz: 3377eca301f991088bb5efa01b36f242544dc0a61ac81065461aedf3748d4fde80d1798b19bd10c0e37c188b5387558ac4b215dc624e994ef773f06613533e43
+  data.tar.gz: 77b5f0fbd47744296b8a51ad46c75f0ec999538a58f8765e4cdfa35c6206e8a5b12b0689260e862b7b5359be101dc9754ee8fead17bc8750e6e35ee80ee154a5

data/.rubocop_todo.yml

@@ -1,15 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-12-06 07:57:17 UTC using RuboCop version 1.57.2.
+# on 2024-02-09 11:25:12 UTC using RuboCop version 1.59.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 64
+  Max: 38
 
 # Offense count: 2
 # Configuration parameters: IgnoredMetadata.
@@ -32,17 +32,17 @@ RSpec/ExampleLength:
 RSpec/MultipleExpectations:
   Max: 2
 
-# Offense count: 2
+# Offense count: 6
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
-  Max: 5
+  Max: 6
 
 # Offense count: 2
 RSpec/SubjectStub:
   Exclude:
     - 'spec/integrations/migrations/mysql/fx_migration_spec.rb'
 
-# Offense count: 3
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 ## [Unreleased]
 
+## [0.1.2] - 2024-02-09
+
+Configure The Behaviours When UUID Is Invalid
+
+```ruby
+UuidV7.configure do |config|
+  config.throw_invalid_uuid = false
+end
+```
+
+```ruby
+record_class.find_by(uuid: "invalid")
+=> nil
+```
+
+```ruby
+UuidV7.configure do |config|
+  config.throw_invalid_uuid = true
+end
+```
+
+```ruby
+record_class.find_by(uuid: "invalid")
+raise_error(UuidV7::Types::InvalidUUID, "invalid is not a valid UUID")
+```
+
 ## [0.1.1] - 2023-12-11
 
 Fix wrong default field name. Change from :uuid to :id

data/README.md

@@ -99,6 +99,30 @@ end
 
 **Recommendation:** It's advised to use `:id` as the primary key with Rails for compatibility and convention.
 
+### Behaviours with Invalid UUIDs
+
+```ruby
+UuidV7.configure do |config|
+  config.throw_invalid_uuid = false
+end
+```
+
+```ruby
+record_class.find_by(uuid: "invalid")
+=> nil
+```
+
+```ruby
+UuidV7.configure do |config|
+  config.throw_invalid_uuid = true
+end
+```
+
+```ruby
+record_class.find_by(uuid: "invalid")
+raise_error(UuidV7::Types::InvalidUUID, "invalid is not a valid UUID")
+```
+
 ### Migrations
 
 #### Helper for Mysql

data/lib/generators/uuid_v7/install/templates/uuid_v7.rb.tt

@@ -5,4 +5,5 @@ require "uuid_v7"
 UuidV7.configure do |config|
   # config.field_name = :id # default :id
   # config.implicit_inclusion_strategy = true # default true
+  # config.throw_invalid_uuid = false # default false
 end

data/lib/uuid_v7/configuration.rb

@@ -2,11 +2,12 @@
 
 module UuidV7
   class Configuration
-    attr_accessor :field_name, :implicit_inclusion_strategy
+    attr_accessor :field_name, :implicit_inclusion_strategy, :throw_invalid_uuid
 
     def initialize
       self.field_name = :id
       self.implicit_inclusion_strategy = true
+      self.throw_invalid_uuid = true
     end
   end
 end

data/lib/uuid_v7/patches/mysql/fk_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Alliantist
+  module Migrations
+    module UuidFkHelper
+      # update_fk_uuid_between_table(parent_table_name: :engines, child_table_name: :pistons)
+      def update_fk_uuid_between_table(parent_table_name:, child_table_name:)
+        table_name_parent = parent_table_name.to_s.to_sym # :engines
+        table_name_child  = child_table_name.to_s.to_sym  # :pistons
+        foreign_key_id    = :"#{table_name_parent.to_s.singularize}_id"   # :engine_id
+        foreign_key_uuid  = :"#{table_name_parent.to_s.singularize}_uuid" # :engine_uuid
+
+        add_column table_name_child, foreign_key_uuid, :binary, limit: 16, null: true # :pistons, :engine_uuid
+
+        # Update the foreign_key in child table
+        connection.execute <<-SQL.squish
+          UPDATE #{table_name_child} child
+          JOIN #{table_name_parent} parent ON child.#{foreign_key_id} = parent.id
+          SET child.#{foreign_key_uuid} = parent.uuid;
+        SQL
+
+        # change_column_null :pistons, :engine_uuid, false
+        change_column_null table_name_child, foreign_key_uuid, false
+
+        # add_index :pistons, :engine_uuid
+        add_index table_name_child, foreign_key_uuid
+
+        # add_foreign_key :pistons, :engines, column: :engine_uuid, primary_key: :uuid, type: :binary
+        add_foreign_key table_name_child, table_name_parent, column: foreign_key_uuid, primary_key: :uuid, type: :binary
+
+        # remove_column table_name_child, foreign_key_id
+        # rename_column table_name_child, foreign_key_uuid, foreign_key_id
+      end
+    end
+  end
+end

data/lib/uuid_v7/patches/mysql/fx_migration.rb

@@ -15,7 +15,7 @@ module UuidV7
           SQL
 
           connection.exec_query <<~SQL.squish
-            CREATE FUNCTION uuid_v7 ()
+            CREATE FUNCTION uuid_v7 (time_of_creation DATETIME)
             RETURNS BINARY(16)
             LANGUAGE SQL
             NOT DETERMINISTIC
@@ -27,7 +27,7 @@ module UuidV7
               DECLARE currentTime   BIGINT;
               DECLARE buuid         BINARY(16);
 
-              SET currentTime = UNIX_TIMESTAMP() * 1000 + FLOOR(MICROSECOND(NOW(6)) / 1000);
+              SET currentTime = UNIX_TIMESTAMP(time_of_creation) * 1000 + FLOOR(MICROSECOND(NOW(6)) / 1000);
 
               SET uuid = LOWER(
                 CONCAT(
@@ -46,7 +46,7 @@ module UuidV7
           SQL
 
           connection.execute <<~SQL
-            UPDATE #{table_name} SET #{column_name} = uuid_v7() WHERE #{column_name} IS NULL;
+            UPDATE #{table_name} SET #{column_name} = uuid_v7(created_at) WHERE #{column_name} IS NULL;
           SQL
 
           connection.execute <<~SQL

data/lib/uuid_v7/types/base.rb

@@ -37,7 +37,11 @@ module UuidV7
         # To avoid SQL injection, verify that it looks like a UUID. ActiveRecord
         # does not explicity escape the Binary data type. escaping is implicit as
         # the Binary data type always converts its value to a hex string.
-        raise InvalidUUID, "#{value} is not a valid UUID" unless value.match?(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
+        unless value.match?(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
+          raise InvalidUUID, "#{value} is not a valid UUID" if UuidV7.configuration.throw_invalid_uuid
+
+          return nil
+        end
 
         return value if value.is_a?(Data)
 

data/lib/uuid_v7/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UuidV7
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uuid_v7
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Joel Azemar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -104,6 +104,7 @@ files:
 - lib/uuid_v7/base.rb
 - lib/uuid_v7/configuration.rb
 - lib/uuid_v7/configure.rb
+- lib/uuid_v7/patches/mysql/fk_helper.rb
 - lib/uuid_v7/patches/mysql/fx_migration.rb
 - lib/uuid_v7/railtie.rb
 - lib/uuid_v7/types/base.rb
@@ -132,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Provides UUID V7 support for Ruby on Rails applications using Mysql and Sqlite.