uuid_attribute 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b93f3aeb7c291e0f7769a8c22f30ffa03ae43af266b535004c6e2e65dff40981
-  data.tar.gz: a301839295c42abd36b29e96b514c40c05ca4a8f39317035fedd4c6dab9285f2
+  metadata.gz: a3a31aeee55a99380975bf4cf4fbcfe7c506618bace27420afcb31d31ae06ec2
+  data.tar.gz: 304c13913329ea077e252deb3fb3f3bd0c4001c335db877650ac2d467b696e77
 SHA512:
-  metadata.gz: 5f87cd2276f59c7ef15bfd0758b9870cf6ff73fbc8788191ff6afb953af49d673f3765dcfd52911d58535ff8b6b02ba90b69244ea33516f1c9a7db2008b03ad7
-  data.tar.gz: 8f6129b56a17c07986a7ae0f49a5b9c8303f494fd8f3b82974fa40a77d0d90d05996fdf634cc1eee877891505282c3ba8149ce80774aa4e31c46e5af45800a76
+  metadata.gz: eb6fd591641a8adef2c268d319bbd678c6bc930258ed12ec751d3d3be5101b4cf35baf63801ddfe2d39a532dd2db8582d8f10b664dc982bcfe24519893985f99
+  data.tar.gz: 92036ff31a27d90e635bc6d3fae13a153145531fefe391f43cb0e6e4eab19d54990cc69fb6b1d133017aa3a7e1050edc26103e3c4c7a0c8635297019c3eeb9a7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## 0.2.0 - 2022-08-20
+
+* Added tests
+* Fixed autodetecting of binary(16) as UUID
+
 ## 0.1.1 - 2022-08-19
 
 * First public release

data/lib/uuid_attribute/railtie.rb

@@ -13,9 +13,9 @@ module UuidAttribute
         field_info.type == :binary && field_info.limit == 16
       end
 
-      def binary16?(field)
-        field_info = self.class.attribute_types[field]
-        binary16_structure?(field_info) && respond_to?("#{field}?")
+      def binary16?(klass, field)
+        field_info = klass.attribute_types[field]
+        binary16_structure?(field_info) && klass.method_defined?("#{field}?")
       end
 
       def valid_default_rails_ids?(att)
@@ -38,14 +38,30 @@ end
 =end
 
     config.after_initialize do
-      # unless SimpleForm.configured?
-      #  warn '[Simple Form] Simple Form is not configured in the application and will use the default values.' +
-      #    ' Use `rails generate simple_form:install` to generate the Simple Form configuration.'
-      # end
-
       ActiveRecord::Type.register(:uuid, ::UuidAttribute::UUID)
 
-      ActiveRecord::Base.include ::UuidAttribute::ActiveModel if defined? ActiveRecord::Base
+      if UuidAttribute.auto_detect_binary_ids
+        models = []
+        Dir["#{Rails.root}/app/models/*"].each do |file|
+          model = File.basename(file, ".*").classify
+          models << model unless models.include?(model)
+        end
+
+        models -= %w[ActiveRecord Concern]
+
+        models.each do |model|
+          model = model.constantize
+          model.attribute_names.each do |att|
+            next unless valid_default_rails_ids?(att) && binary16?(model, att)
+
+            default = nil
+            default = -> { SecureRandom.uuid } if att.eql? "id"
+            model.define_attribute att, ::UuidAttribute::UUID.new, default: default
+          end
+        end
+      end
+
+      # ActiveRecord::Base.include ::UuidAttribute::ActiveModel if defined? ActiveRecord::Base
 
       if UuidAttribute.default_primary_id
         # Configure UUID as Default Primary Key

data/lib/uuid_attribute/utils.rb

@@ -9,11 +9,7 @@ module UuidAttribute
       end
 
       def hex_from_binary(bytes)
-        bytes.unpack1("H*")
-      end
-
-      def mysql_value(value)
-        "x'#{value}'"
+        normalize(bytes.unpack1("H*"))
       end
 
       def raw_bytes(uuid_string)
@@ -22,13 +18,14 @@ module UuidAttribute
 
       def parse(str)
         return nil if str.length.zero?
+        return str if str.length == 36
 
         case str.length
-        when 36
-          normalize(str)
+        when 32
+          format_uuid(str)
         when 16
-          normalize(hex_from_binary(str))
-        when 20, 21, 22
+          format_uuid(hex_from_binary(str))
+        when 22
           unshort(str)
         end
       end
@@ -39,11 +36,23 @@ module UuidAttribute
         a b c d e f g h i j k l m n o p q r s t u v w x y z
       ].freeze
 
+      def format_uuid(uuid)
+        # TODO: Maybe raise a exception?
+        return uuid if uuid.length != 32
+
+        uuid = uuid.downcase
+        [
+          uuid[0..7],
+          uuid[8..11],
+          uuid[12..15],
+          uuid[16..19],
+          uuid[20..31]
+        ].join("-")
+      end
+
       def shorten(decimal, alphabet = DEFAULT_BASE62)
-        alphabet = alphabet.to_a
         radix = alphabet.length
-        normalized_decimal = normalize(decimal).to_i(16)
-        i = normalized_decimal.to_i
+        i = normalize(decimal).to_i(16).to_i
         out = []
         return alphabet[0] if i.zero?
 
@@ -64,13 +73,7 @@ module UuidAttribute
         end
 
         uuid = num.to_s(16).rjust(32, "0")
-        [
-          uuid[0..7],
-          uuid[8..11],
-          uuid[12..15],
-          uuid[16..19],
-          uuid[20..31]
-        ].join("-")
+        format_uuid(uuid)
       end
     end
   end

data/lib/uuid_attribute/uuid.rb

@@ -22,9 +22,7 @@ module UuidAttribute
     end
 
     def cast(value)
-      return if value.nil?
-
-      Utils.shorten(Utils.parse(value.to_s))
+      deserialize(value)
     end
   end
 end

data/lib/uuid_attribute/version.rb

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

data/test/test_helper.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
+require "simplecov"
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "uuid/attribute"
+
+SimpleCov.start "rails" do
+  add_filter %r{^/test/}
+  add_filter "lib/uuid_attribute/version"
+end
 
 require "minitest/autorun"
+require "uuid_attribute"

data/test/uuid/test_configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module UUID
+  class TestConfiguration < Minitest::Test
+    def test_that_it_has_a_version_number
+      refute_nil ::UuidAttribute::VERSION
+    end
+
+    def test_auto_detect_binary_ids
+      ::UuidAttribute.setup do |config|
+        config.auto_detect_binary_ids = false
+      end
+      refute ::UuidAttribute.auto_detect_binary_ids
+
+      ::UuidAttribute.setup do |config|
+        config.auto_detect_binary_ids = true
+      end
+      assert ::UuidAttribute.auto_detect_binary_ids
+    end
+
+    def test_default_primary_id
+      ::UuidAttribute.setup do |config|
+        config.default_primary_id = false
+      end
+      refute ::UuidAttribute.default_primary_id
+
+      ::UuidAttribute.setup do |config|
+        config.default_primary_id = true
+      end
+      assert ::UuidAttribute.default_primary_id
+    end
+  end
+end

data/test/uuid/test_type.rb

@@ -0,0 +1,40 @@
+
+require "test_helper"
+require "active_record"
+
+module UUID
+  class TestType < Minitest::Test
+    UNORMALIZED_UUID = "a0b1c2d3-e4f5-a6b7-c8d9-e0f1a2b3c4d5".freeze
+    NORMALIZED_UUID = "A0B1C2D3E4F5A6B7C8D9E0F1A2B3C4D5".freeze
+    BINARY_UUID = "\xA0\xB1\xC2\xD3\xE4\xF5\xA6\xB7\xC8\xD9\xE0\xF1\xA2\xB3\xC4\xD5".freeze
+    SHORTEN_UUID = "4tE0ZuelqYsF4p2FEnW2qb".freeze
+
+    def test_type
+      assert_equal(::UuidAttribute::UUID.new.type,:uuid)
+    end
+
+    def test_deserialize
+      assert_nil(::UuidAttribute::UUID.new.deserialize(nil))
+      assert_equal(
+        ::UuidAttribute::UUID.new.deserialize(UNORMALIZED_UUID),
+        SHORTEN_UUID
+      )
+    end
+
+    def test_serialize
+      assert_nil(::UuidAttribute::UUID.new.serialize(nil))
+      result = ::UuidAttribute::UUID.new.serialize(UNORMALIZED_UUID)
+      assert_equal("ActiveModel::Type::Binary::Data", result.class.name)
+      assert_equal(BINARY_UUID.bytes, result.to_s.bytes)
+      assert_equal(BINARY_UUID.bytes, [result.hex].pack("H*").bytes)
+    end
+
+    def test_cast
+      assert_nil(::UuidAttribute::UUID.new.cast(nil))
+      assert_equal(
+        ::UuidAttribute::UUID.new.cast(UNORMALIZED_UUID),
+        SHORTEN_UUID
+      )
+    end
+  end
+end

data/test/uuid/test_utilities.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module UUID
+  class TestUtilities < Minitest::Test
+    UNORMALIZED_UUID = "a0b1c2d3-e4f5-a6b7-c8d9-e0f1a2b3c4d5"
+    NORMALIZED_UUID = "A0B1C2D3E4F5A6B7C8D9E0F1A2B3C4D5"
+    BINARY_UUID = "\xA0\xB1\xC2\xD3\xE4\xF5\xA6\xB7\xC8\xD9\xE0\xF1\xA2\xB3\xC4\xD5"
+    SHORTEN_UUID = "4tE0ZuelqYsF4p2FEnW2qb"
+
+    def test_normalization
+      result = ::UuidAttribute::Utils.normalize(UNORMALIZED_UUID)
+      assert_equal(NORMALIZED_UUID, result)
+    end
+
+    def test_hex_from_binary
+      result = ::UuidAttribute::Utils.hex_from_binary(BINARY_UUID)
+      assert_equal(NORMALIZED_UUID, result)
+    end
+
+    def test_raw_bytes
+      result = ::UuidAttribute::Utils.raw_bytes(NORMALIZED_UUID)
+      assert_equal(BINARY_UUID.bytes, result.bytes)
+    end
+
+    def test_shorten
+      result = ::UuidAttribute::Utils.shorten(UNORMALIZED_UUID)
+      assert_equal(SHORTEN_UUID, result)
+    end
+
+    def test_unshorten
+      result = ::UuidAttribute::Utils.unshort(SHORTEN_UUID)
+      assert_equal(UNORMALIZED_UUID, result)
+    end
+
+    def test_short_and_unshort
+      random_uuid = SecureRandom.uuid
+      shorted_uuid = ::UuidAttribute::Utils.shorten(random_uuid)
+      unshorted_uuid = ::UuidAttribute::Utils.unshort(shorted_uuid)
+      assert_equal(random_uuid, unshorted_uuid)
+    end
+
+    def test_parser
+      result = ::UuidAttribute::Utils.parse(NORMALIZED_UUID)
+      assert_equal(UNORMALIZED_UUID, result)
+
+      result = ::UuidAttribute::Utils.parse(BINARY_UUID)
+      assert_equal(UNORMALIZED_UUID, result)
+
+      result = ::UuidAttribute::Utils.parse(SHORTEN_UUID)
+      assert_equal(UNORMALIZED_UUID, result)
+
+      result = ::UuidAttribute::Utils.parse(UNORMALIZED_UUID)
+      assert_equal(UNORMALIZED_UUID, result)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uuid_attribute
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Negri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
 description: UUID attribute for ActiveRecord
 email:
 - patrick@iugu.com
@@ -41,7 +55,9 @@ files:
 - lib/uuid_attribute/uuid.rb
 - lib/uuid_attribute/version.rb
 - test/test_helper.rb
-- test/uuid/test_attribute.rb
+- test/uuid/test_configuration.rb
+- test/uuid/test_type.rb
+- test/uuid/test_utilities.rb
 homepage: https://github.com/iugu/activerecord-uuid-attribute
 licenses:
 - MIT
@@ -72,4 +88,6 @@ specification_version: 4
 summary: UUID attribute for ActiveRecord
 test_files:
 - test/test_helper.rb
-- test/uuid/test_attribute.rb
+- test/uuid/test_configuration.rb
+- test/uuid/test_type.rb
+- test/uuid/test_utilities.rb

data/test/uuid/test_attribute.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-
-module UUID
-  class TestAttribute < Minitest::Test
-    def test_that_it_has_a_version_number
-      refute_nil ::UUID::Attribute::VERSION
-    end
-
-    def test_it_does_something_useful
-      assert false
-    end
-  end
-end