uuid_attribute 0.2.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a31aeee55a99380975bf4cf4fbcfe7c506618bace27420afcb31d31ae06ec2
-  data.tar.gz: 304c13913329ea077e252deb3fb3f3bd0c4001c335db877650ac2d467b696e77
+  metadata.gz: e716f18577f556aa807d4ad19aa1f6cd62900f7ea5faab4ea3f88fb4cc8e3d5a
+  data.tar.gz: 22161c78f0e24c4117306db0c6d70b27665f911385ade24748d09619acefc657
 SHA512:
-  metadata.gz: eb6fd591641a8adef2c268d319bbd678c6bc930258ed12ec751d3d3be5101b4cf35baf63801ddfe2d39a532dd2db8582d8f10b664dc982bcfe24519893985f99
-  data.tar.gz: 92036ff31a27d90e635bc6d3fae13a153145531fefe391f43cb0e6e4eab19d54990cc69fb6b1d133017aa3a7e1050edc26103e3c4c7a0c8635297019c3eeb9a7
+  metadata.gz: 90698cabeeb889fc28c07ab0001e53575db198b611707dc0fb640348b32c2d9712f3c861ccfdbcfa3aceb56d8f85cb6255c3cae6a591697792b135140824ee7c
+  data.tar.gz: ef6d0daa754d19d805367b00646789b1813ea9db391bad35129ca9e06d67a165c3779047d1e227110b857a808b8a2499e767081316c381e92ff7e6e6befc5ce0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## 0.9.0 - 2022-08-23
+
+* Improved tests, now testing all ruby and supported rails versions
+* Added support for PostgreSQL and SQLite
+
 ## 0.2.0 - 2022-08-20
 
 * Added tests

data/README.md

@@ -1,28 +1,35 @@
-# UUID::Attribute
+# UUidAttribute
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add activerecord-uuid-attribute
+    $ bundle add uuid_attribute
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install activerecord-uuid-attribute
+    $ gem install uuid_attribute
 
 ## Usage
 
-TODO: Write usage instructions here
-
 ```
 class YourModel < ApplicationRecord
-  # Need to put attribute manually
-  attribute :id, :uuid, default: -> { SecureRandom.uuid }
 end
 
+model = YourModel.create( ... )
+YourModel:0x00007f85774135a8  
+ id: "5iLEaLFZUeD6Dg8nnfSiCZ",
+... > 
+
+Or if you want to disable auto detect of UUIDs
+
 UuidAttribute.setup do |config|
   # Configure generators to use UUID as primary key (defaults to true)
-  config.default_primary_id = true
+  config.auto_detect_binary_ids = false
+end
+
+class YourModel < ApplicationRecord
+  attribute :id, :uuid, default: -> { SecureRandom.uuid }
 end
 ```
 
@@ -36,12 +43,6 @@ release a new version, update the version number in `version.rb`, and then run
 git commits and the created tag, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
-## TODO
-
-Write tests for each supported rails versions. See examples at:
-https://github.com/rails/rails/tree/main/activerecord
-https://github.com/heartcombo/simple_form/tree/main/gemfiles
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/lib/uuid_attribute/railtie.rb

@@ -9,38 +9,21 @@ module UuidAttribute
     config.eager_load_namespaces << ::UuidAttribute
 
     class << self
-      def binary16_structure?(field_info)
-        field_info.type == :binary && field_info.limit == 16
+      def binary_structure?(field_info)
+        field_info.type == :binary
       end
 
-      def binary16?(klass, field)
+      def binary?(klass, field)
         field_info = klass.attribute_types[field]
-        binary16_structure?(field_info) && klass.method_defined?("#{field}?")
+        binary_structure?(field_info)
+        # && klass.method_defined?("#{field}?")
       end
 
       def valid_default_rails_ids?(att)
         att.eql?("id") || att.end_with?("_id")
       end
-    end
-
-=begin
-all_models = ObjectSpace.each_object(Class).select { |c| c < ApplicationRecord}.select(&:name)
-all_models.each do |model|
-  puts model
-  model.attribute_names.each do |att|
-    next unless valid_default_rails_ids?(att) && binary16?(att)
-
-    default = nil
-    default = -> { SecureRandom.uuid } if att.eql? "id"
-    self.class.define_attribute att, ::UuidAttribute::UUID.new, default: default
-  end
-end
-=end
-
-    config.after_initialize do
-      ActiveRecord::Type.register(:uuid, ::UuidAttribute::UUID)
 
-      if UuidAttribute.auto_detect_binary_ids
+      def list_models
         models = []
         Dir["#{Rails.root}/app/models/*"].each do |file|
           model = File.basename(file, ".*").classify
@@ -49,23 +32,42 @@ end
 
         models -= %w[ActiveRecord Concern]
 
-        models.each do |model|
-          model = model.constantize
+        models.each(&:constantize)
+        all_active_record_classes
+      end
+
+      def all_active_record_classes
+        ObjectSpace.each_object(Class).select { |c| c < ActiveRecord::Base }.select(&:name)
+      end
+
+      def configure_binary_ids
+        list_models.each do |model|
           model.attribute_names.each do |att|
-            next unless valid_default_rails_ids?(att) && binary16?(model, att)
+            next unless valid_default_rails_ids?(att) && binary?(model, att)
 
             default = nil
             default = -> { SecureRandom.uuid } if att.eql? "id"
-            model.define_attribute att, ::UuidAttribute::UUID.new, default: default
+            model.attribute att, ::UuidAttribute::UUID.new, default: default
           end
         end
+      rescue ActiveRecord::NoDatabaseError
+        puts "NO DATABASE"
+        false
+      else
+        puts "CONFIGURE BINARY"
+        true
       end
+    end
+
+    config.after_initialize do
+      puts "REGISTERING UUID"
+      ActiveRecord::Type.register(:uuid, ::UuidAttribute::UUID)
 
-      # ActiveRecord::Base.include ::UuidAttribute::ActiveModel if defined? ActiveRecord::Base
+      configure_binary_ids if UuidAttribute.auto_detect_binary_ids
 
       if UuidAttribute.default_primary_id
         # Configure UUID as Default Primary Key
-        Rails.application.config.generators do |g|
+        Rails&.application&.config&.generators do |g|
           g.orm :active_record, primary_key_type: "binary, limit: 16"
         end
       end

data/lib/uuid_attribute/utils.rb

@@ -5,7 +5,7 @@ module UuidAttribute
   class Utils
     class << self
       def normalize(uuid_string)
-        uuid_string.gsub("-", "").upcase
+        uuid_string&.gsub("-", "")&.upcase
       end
 
       def hex_from_binary(bytes)
@@ -23,6 +23,8 @@ module UuidAttribute
         case str.length
         when 32
           format_uuid(str)
+        when 34
+          format_uuid(str)
         when 16
           format_uuid(hex_from_binary(str))
         when 22

data/lib/uuid_attribute/version.rb

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

data/lib/uuid_attribute.rb

@@ -2,9 +2,9 @@
 
 require "active_model"
 require "active_model/type"
+require "rails"
 require_relative "uuid_attribute/version"
 require_relative "uuid_attribute/uuid"
-require_relative "uuid_attribute/active_model"
 require_relative "uuid_attribute/utils"
 
 # UUID::Attribute is a module that provides a UUID attribute for ActiveRecord

data/test/config/config.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "pathname"
+# require "active_support/configuration_file"
+
+module ARTest
+  class << self
+    def config
+      @config ||= YAML.safe_load(File.read(config_file))
+      # ActiveSupport::ConfigurationFile.parse(config_file)
+    end
+
+    private
+
+    def config_file
+      Pathname.new(ENV["ARCONFIG"] || "#{TEST_ROOT}/config/config.yml")
+    end
+  end
+end

data/test/config/schema.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define do
+  create_table "samples", id: :binary, limit: 16, force: :cascade do |t|
+    t.string "name"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "examples", id: :binary, limit: 16, force: :cascade do |t|
+    t.string "name"
+    t.references :sample, null: false, foreign_key: false, type: :binary, limit: 16
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+end

data/test/test_helper.rb

@@ -8,5 +8,30 @@ SimpleCov.start "rails" do
   add_filter "lib/uuid_attribute/version"
 end
 
+require "rails"
+require "active_record"
 require "minitest/autorun"
+
+TEST_ROOT = __dir__
+require "config/config"
+puts "Testing with adapter #{ENV["TEST_ADAPTER"]} - Rails Version: #{Rails.version}"
+
+# ActiveRecord.async_query_executor = :global_thread_pool if ActiveRecord.respond_to?(:async_query_executor)
+ActiveRecord::Base.configurations = ARTest.config["connections"]
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+DATABASE_CONFIG = ActiveRecord::DatabaseConfigurations::HashConfig.new(
+  "test",
+  "test",
+  ARTest.config["connections"][ENV["TEST_ADAPTER"]]
+) if Rails::VERSION::MAJOR >= 7 || (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR > 0)
+DATABASE_CONFIG = ARTest.config["connections"][ENV["TEST_ADAPTER"]] if Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR == 0
+ActiveRecord::Tasks::DatabaseTasks.purge(DATABASE_CONFIG) unless ENV["TEST_ADAPTER"] != "sqlite"
+ActiveRecord::Tasks::DatabaseTasks.load_schema(
+  DATABASE_CONFIG,
+  :ruby,
+  "#{TEST_ROOT}/config/schema.rb"
+)
+ActiveRecord::Base.establish_connection DATABASE_CONFIG
+# load_schema(db_config, format = ActiveRecord.schema_format, file = nil) # :no
+
 require "uuid_attribute"

data/test/uuid/test_activerecord.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Sample < ActiveRecord::Base
+end
+
+class Example < ActiveRecord::Base
+  belongs_to :sample
+end
+
+module UUID
+  class TestActiveRecord < Minitest::Test
+    def setup
+      UuidAttribute::Railtie.config.after_initialize.each do |block|
+        next unless block && block[0]
+        next unless block[0].source_location[0].include? "uuid_attribute/railtie.rb"
+
+        block[0].call
+      end
+    end
+
+    def test_uuid_generation
+      result = Sample.new
+      refute_nil(result.id)
+    end
+
+    def test_new_and_finds
+      result = Sample.create(name: "A Name")
+      assert(result.name, "A Name")
+      refute_nil(result.id)
+      assert(Sample.find(result.id).name, "A Name")
+    end
+
+    def test_references
+      record_a = Sample.create(name: "Sample")
+      record_b = Example.create(name: "Example on Sample", sample: record_a)
+      assert(record_b.sample)
+      assert(record_b.sample.id, record_a.id)
+    end
+  end
+end

data/test/uuid/test_type.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 
 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
+    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_type
-      assert_equal(::UuidAttribute::UUID.new.type,:uuid)
+      assert_equal(::UuidAttribute::UUID.new.type, :uuid)
     end
 
     def test_deserialize
@@ -26,7 +27,6 @@ module UUID
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uuid_attribute
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Patrick Negri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-20 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -49,24 +49,26 @@ files:
 - LICENSE.md
 - README.md
 - lib/uuid_attribute.rb
-- lib/uuid_attribute/active_model.rb
 - lib/uuid_attribute/railtie.rb
 - lib/uuid_attribute/utils.rb
 - lib/uuid_attribute/uuid.rb
 - lib/uuid_attribute/version.rb
+- test/config/config.rb
+- test/config/schema.rb
 - test/test_helper.rb
+- test/uuid/test_activerecord.rb
 - test/uuid/test_configuration.rb
 - test/uuid/test_type.rb
 - test/uuid/test_utilities.rb
-homepage: https://github.com/iugu/activerecord-uuid-attribute
+homepage: https://github.com/iugu/uuid_attribute
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/iugu/activerecord-uuid-attribute
-  documentation_uri: https://rubydoc.info/github/iugu/simple_form/activerecord-uuid-attribute
-  changelog_uri: https://github.com/iugu/activerecord-uuid-attribute/blob/main/CHANGELOG.md
-  source_code_uri: https://github.com/iugu/activerecord-uuid-attribute
-  bug_tracker_uri: https://github.com/iugu/activerecord-uuid-attribute/issues
+  homepage_uri: https://github.com/iugu/uuid_attribute
+  documentation_uri: https://github.com/iugu/uuid_attribute
+  changelog_uri: https://github.com/iugu/uuid_attribute/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/iugu/uuid_attribute
+  bug_tracker_uri: https://github.com/iugu/uuid_attribute/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -75,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -87,7 +89,10 @@ signing_key:
 specification_version: 4
 summary: UUID attribute for ActiveRecord
 test_files:
+- test/config/config.rb
+- test/config/schema.rb
 - test/test_helper.rb
+- test/uuid/test_activerecord.rb
 - test/uuid/test_configuration.rb
 - test/uuid/test_type.rb
 - test/uuid/test_utilities.rb

data/lib/uuid_attribute/active_model.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module UuidAttribute
-  # ActiveModel modifications
-  module ActiveModel
-    extend ActiveSupport::Concern
-
-=begin
-    included do
-      alias_method :initialize_without_uuid, :initialize
-      alias_method :initialize, :uuid_initializer
-    end
-
-    def uuid_initializer(*args)
-      auto_detect_uuids
-      initialize_without_uuid(*args)
-    end
-
-    def binary16_structure?(field_info)
-      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}?")
-    end
-
-    def valid_default_rails_ids?(att)
-      att.eql?("id") || att.end_with?("_id")
-    end
-
-    def auto_detect_uuids
-      return unless UuidAttribute.auto_detect_binary_ids
-
-      self.class.attribute_names.each do |att|
-        next unless valid_default_rails_ids?(att) && binary16?(att)
-
-        default = nil
-        default = -> { SecureRandom.uuid } if att.eql? "id"
-        self.class.define_attribute att, ::UuidAttribute::UUID.new, default: default
-      end
-    end
-=end
-  end
-end