uuid_attribute 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96777961184916d3e999bd877f58959ffd45b7cd035a3dd8855d346836b55545
+  data.tar.gz: 21e62fa72b4cde23fbb4ca5e4e86500b4e5e1bc2d1ea2a79a8929a52ab762f3c
+SHA512:
+  metadata.gz: 5f2d0911425daadb52f2cbdf4411c84900508257f4d37ca6bd064f322e11eadc3242294f05a5e5725ed8c113723c449488c67b6a3a38c52a9f8102bda46ea9bd
+  data.tar.gz: f4d8b3adccf186c4f60cb23eb0b6d53e55badb7c9405a994fa883e3f8f430a837f513b1f70254238d9159971a6b051d9b7400bd2497be853e3d3d07d61696603

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Unreleased
+
+## 0.1.1 - 2022-08-19
+
+* First public release

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2022 Iugu IP SA.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# UUID::Attribute
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add activerecord-uuid-attribute
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install activerecord-uuid-attribute
+
+## Usage
+
+TODO: Write usage instructions here
+
+```
+class YourModel < ApplicationRecord
+  # Need to put attribute manually
+  attribute :id, :uuid, default: -> { SecureRandom.uuid }
+end
+
+UuidAttribute.setup do |config|
+  # Configure generators to use UUID as primary key (defaults to true)
+  config.default_primary_id = true
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+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 https://github.com/pnegri/activerecord-uuid-attribute.

data/lib/uuid_attribute/active_model.rb

@@ -0,0 +1,45 @@
+# 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

data/lib/uuid_attribute/railtie.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module UuidAttribute
+  # Rails Initializer
+  class Railtie < Rails::Railtie
+    railtie_name :uuid_attribute_railtie
+    config.eager_load_namespaces << ::UuidAttribute
+
+    class << self
+      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
+    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
+      # 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.default_primary_id
+        # Configure UUID as Default Primary Key
+        Rails.application.config.generators do |g|
+          g.orm :active_record, primary_key_type: "binary, limit: 16"
+        end
+      end
+    end
+  end
+end

data/lib/uuid_attribute/utils.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module UuidAttribute
+  # UUID Utils
+  class Utils
+    class << self
+      def normalize(uuid_string)
+        uuid_string.gsub("-", "").upcase
+      end
+
+      def hex_from_binary(bytes)
+        bytes.unpack1("H*")
+      end
+
+      def mysql_value(value)
+        "x'#{value}'"
+      end
+
+      def raw_bytes(uuid_string)
+        [uuid_string].pack("H*")
+      end
+
+      def parse(str)
+        return nil if str.length.zero?
+
+        case str.length
+        when 36
+          normalize(str)
+        when 16
+          normalize(hex_from_binary(str))
+        when 20, 21, 22
+          unshort(str)
+        end
+      end
+
+      DEFAULT_BASE62 = %w[
+        0 1 2 3 4 5 6 7 8 9
+        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
+        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 shorten(decimal, alphabet = DEFAULT_BASE62)
+        alphabet = alphabet.to_a
+        radix = alphabet.length
+        normalized_decimal = normalize(decimal).to_i(16)
+        i = normalized_decimal.to_i
+        out = []
+        return alphabet[0] if i.zero?
+
+        loop do
+          break if i.zero?
+
+          out.unshift(alphabet[i % radix])
+          i /= radix
+        end
+        out.join.rjust(22, "0")
+      end
+
+      def unshort(word, alphabet = DEFAULT_BASE62)
+        num = 0
+        radix = alphabet.length
+        word.chars.to_a.reverse.each_with_index do |char, index|
+          num += alphabet.index(char) * (radix**index)
+        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("-")
+      end
+    end
+  end
+end

data/lib/uuid_attribute/uuid.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module UuidAttribute
+  # UUID Attribute
+  class UUID < ActiveModel::Type::Binary
+    def type
+      :uuid
+    end
+
+    def serialize(value)
+      return if value.blank?
+
+      ActiveRecord::Type::Binary::Data.new(
+        Utils.raw_bytes(Utils.normalize(Utils.parse(value)))
+      )
+    end
+
+    def deserialize(value)
+      return nil if value.nil?
+
+      Utils.shorten(Utils.parse(value.to_s))
+    end
+
+    def cast(value)
+      return if value.nil?
+
+      Utils.shorten(Utils.parse(value.to_s))
+    end
+  end
+end

data/lib/uuid_attribute/version.rb

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

data/lib/uuid_attribute.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_model"
+require "active_model/type"
+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
+module UuidAttribute
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    UUID
+  end
+
+  class Error < StandardError; end
+
+  ## CONFIGURATION OPTIONS
+
+  mattr_accessor :auto_detect_binary_ids
+  self.auto_detect_binary_ids = true
+
+  mattr_accessor :default_primary_id
+  self.default_primary_id = true
+
+  def self.setup
+    yield self
+  end
+end
+
+require_relative "uuid_attribute/railtie" if defined?(Rails)

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "uuid/attribute"
+
+require "minitest/autorun"

data/test/uuid/test_attribute.rb

@@ -0,0 +1,15 @@
+# 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

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: uuid_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Patrick Negri
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: Another one
+email:
+- patrick@iugu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- 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/test_helper.rb
+- test/uuid/test_attribute.rb
+homepage: https://github.com/iugu/activerecord-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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files:
+- test/test_helper.rb
+- test/uuid/test_attribute.rb