activeid 0.6.1

data/spec/support/fabricators.rb

@@ -0,0 +1,15 @@
+uuid_fab_prefixes = %i[binary string native]
+uuid_fab_suffixes = [nil, :with_namespace, :with_natural_key]
+
+fab_names = uuid_fab_prefixes.product(uuid_fab_suffixes).map do |p, s|
+  [p, "uuid_article", s].compact.join("_").to_sym
+end
+
+fab_names.push(:article)
+
+fab_names.each do |fab_name|
+  Fabricator(fab_name) do
+    title { Forgery::LoremIpsum.word }
+    body { Forgery::LoremIpsum.sentence }
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,41 @@
+class Article < ActiveRecord::Base
+end
+
+# Defines classes:
+#
+# - BinaryUuidArticle
+# - BinaryUuidArticleWithNaturalKey
+# - BinaryUuidArticleWithNamespace
+# - StringUuidArticle
+# - StringUuidArticleWithNaturalKey
+# - StringUuidArticleWithNamespace
+# - NativeUuidArticle
+# - NativeUuidArticleWithNaturalKey
+# - NativeUuidArticleWithNamespace
+%w[binary string native].each do |table_prefix|
+  table_name = "#{table_prefix}_uuid_articles"
+  attribute_type_name = table_prefix == "binary" ? "BinaryUUID" : "StringUUID"
+  attribute_type = ActiveID::Type.const_get(attribute_type_name)
+
+  regular_class = Class.new(ActiveRecord::Base) do
+    include ActiveID::Model
+    self.table_name = table_name
+    attribute :id, attribute_type.new
+    attribute :another_uuid, attribute_type.new
+  end
+
+  natural_key_class = Class.new(regular_class) do
+    natural_key :title
+  end
+
+  key_with_namescape_class = Class.new(natural_key_class) do
+    uuid_namespace "45e676ea-8a43-4ffe-98ca-c142b0062a83" # a random UUID
+  end
+
+  regular_class_name = "#{table_prefix.camelize}UuidArticle"
+  Object.const_set regular_class_name, regular_class
+  natural_key_class_name = "#{regular_class_name}WithNaturalKey"
+  Object.const_set natural_key_class_name, natural_key_class
+  key_with_namescape_class_name = "#{regular_class_name}WithNamespace"
+  Object.const_set key_with_namescape_class_name, key_with_namescape_class
+end

data/spec/support/schema.rb

@@ -0,0 +1,38 @@
+ActiveRecord::Schema.define do
+  create_table :articles, force: true do |t|
+    t.string :title
+    t.text :body
+    t.column :some_array, :integer, array: true
+
+    t.timestamps
+  end
+
+  create_table :binary_uuid_articles, id: false, force: true do |t|
+    t.binary :id, limit: 16, primary_key: true
+    t.string :title
+    t.text :body
+    t.binary :another_uuid, limit: 16
+
+    t.timestamps
+  end
+
+  create_table :string_uuid_articles, id: false, force: true do |t|
+    t.string :id, limit: 36, primary_key: true
+    t.string :title
+    t.text :body
+    t.string :another_uuid, limit: 36
+
+    t.timestamps
+  end
+
+  if ENV["DB"] == "postgresql"
+    create_table :native_uuid_articles, id: false, force: true do |t|
+      t.uuid :id, primary_key: true
+      t.string :title
+      t.text :body
+      t.uuid :another_uuid
+
+      t.timestamps
+    end
+  end
+end

data/spec/unit/attribute_type_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+# Type assertions are necessary because you can't tell UUID and String apart
+# with regular ==.
+RSpec.describe ActiveID::Type do
+  let(:uuid) { UUIDTools::UUID.parse(hex_with_dashes) }
+  let(:hex_with_dashes) { "472b22d4-9fa3-45c4-86cd-2f2cdf77d485" }
+  let(:hex_without_dashes) { hex_with_dashes.delete("-").upcase }
+  let(:binary_string) { uuid.raw }
+
+  describe ActiveID::Type::BinaryUUID do
+    let(:instance) { described_class.new }
+
+    describe "#cast" do
+      subject { instance.method(:cast) }
+      example { expect(subject.(uuid)).to be_respective_uuid }
+      example { expect(subject.(hex_with_dashes)).to be_respective_uuid }
+      example { expect(subject.(hex_without_dashes)).to be_respective_uuid }
+      example { expect(subject.(nil)).to be(nil) }
+    end
+
+    describe "#serialize" do
+      subject { instance.method(:serialize) }
+      example { expect(subject.(uuid)).to be_respective_binary }
+      example { expect(subject.(nil)).to be(nil) }
+    end
+
+    describe "#deserialize" do
+      subject { instance.method(:deserialize) }
+      example { expect(subject.(binary_string)).to be_respective_uuid }
+      example { expect(subject.(nil)).to be(nil) }
+    end
+  end
+
+  describe ActiveID::Type::StringUUID do
+    let(:instance) { described_class.new }
+
+    describe "#cast" do
+      subject { instance.method(:cast) }
+      example { expect(subject.(uuid)).to be_respective_uuid }
+      example { expect(subject.(hex_with_dashes)).to be_respective_uuid }
+      example { expect(subject.(hex_without_dashes)).to be_respective_uuid }
+      example { expect(subject.(nil)).to be(nil) }
+    end
+
+    describe "#serialize" do
+      subject { instance.method(:serialize) }
+      example { expect(subject.(uuid)).to be_respective_uuid_string }
+      example { expect(subject.(nil)).to be(nil) }
+    end
+
+    describe "#deserialize" do
+      subject { instance.method(:deserialize) }
+      example { expect(subject.(binary_string)).to be_respective_uuid }
+      example { expect(subject.(nil)).to be(nil) }
+    end
+  end
+
+  def be_respective_uuid
+    eq(uuid) & be_instance_of(UUIDTools::UUID)
+  end
+
+  def be_respective_binary
+    eq(binary_string) & be_instance_of(::ActiveRecord::Type::Binary::Data)
+  end
+
+  def be_respective_uuid_string
+    eq(hex_with_dashes) & be_instance_of(String)
+  end
+end

data/spec/unit/utils_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+RSpec.describe ActiveID::Utils do
+  let(:uuid) { UUIDTools::UUID.parse hex_with_dashes }
+  let(:hex_with_dashes) { "472b22d4-9fa3-45c4-86cd-2f2cdf77d485" }
+  let(:hex_without_dashes) { hex_with_dashes.delete("-").upcase }
+  let(:binary_string) { uuid.raw }
+
+  describe "#cast_to_uuid" do
+    subject { described_class.method(:cast_to_uuid) }
+
+    it "returns argument itself when UUID instance is given" do
+      expect(subject.(uuid)).to be(uuid)
+    end
+
+    it "returns argument itself when nil is given" do
+      expect(subject.(nil)).to be(nil)
+    end
+
+    it "returns respective UUID instance when 16 bytes long binary string is " +
+      "given" do
+      expect(binary_string.size).to eq(16)
+      expect(subject.(binary_string)).to eq(uuid)
+    end
+
+    it "returns respective UUID instance when string consisting of " +
+      "32 hexadecimal digits and 4 dashes is given" do
+      expect(hex_with_dashes.size).to eq(32 + 4)
+      expect(subject.(hex_with_dashes)).to eq(uuid)
+      expect(subject.(hex_with_dashes.swapcase)).to eq(uuid)
+    end
+
+    it "returns respective UUID instance when string consisting of " +
+      "32 hexadecimal digits without dashes is given" do
+      expect(hex_with_dashes.size).to eq(32 + 4)
+      expect(subject.(hex_without_dashes)).to eq(uuid)
+      expect(subject.(hex_without_dashes.swapcase)).to eq(uuid)
+    end
+
+    it "raises an ArgumentError when given sting is neither a 16 bytes long " +
+      "binary string nor representation of 32 digits long hexadecimal number" do
+
+      pending "UUIDTools::UUID is bit too liberal, and sometimes accepts " +
+        "malformed input."
+
+      malformed_uuid_strings = [
+        "",
+        binary_string[0..-2],
+        hex_with_dashes.tr("abcdef", "x"),
+        hex_with_dashes.tr("-", "="),
+        hex_with_dashes[0..-2],
+        hex_with_dashes + "a",
+        hex_without_dashes.tr("abcdef", "x"),
+        hex_without_dashes[0..-2],
+        hex_without_dashes + "a",
+      ]
+
+      malformed_uuid_strings.each do |s|
+        expect { subject.(s) }.to(
+          raise_error(ArgumentError, /16, 32, or 36/),
+          "tested string was: #{s.inspect}"
+        )
+      end
+    end
+
+    it "raises an ArgumentError when argument is neither UUID, nil, " +
+      "nor string" do
+      expect { subject.(3) }.to raise_error(ArgumentError)
+      expect { subject.([hex_with_dashes]) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#quote_as_binary" do
+    subject { described_class.method(:quote_as_binary) }
+
+    it "returns nil for nil" do
+      expect(subject.(nil)).to be(nil)
+    end
+
+    it "returns binary data for UUID instance" do
+      expect(subject.(uuid)).to be_a_binary_data_containing_uuid
+    end
+
+    it "returns binary data for UUID string" do
+      expect(subject.(hex_with_dashes)).to be_a_binary_data_containing_uuid
+      expect(subject.(hex_without_dashes)).to be_a_binary_data_containing_uuid
+    end
+
+    it "is also available (delegates) in ActiveID top-level module" do
+      expect(ActiveID).to respond_to(:quote_as_binary)
+    end
+
+    def be_a_binary_data_containing_uuid
+      be_a(::ActiveRecord::Type::Binary::Data) & eq(binary_string)
+    end
+  end
+end

metadata

@@ -0,0 +1,313 @@
+--- !ruby/object:Gem::Specification
+name: activeid
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: forgery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solid_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Support for binary UUIDs in ActiveRecord
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/macos.yml"
+- ".github/workflows/ubuntu.yml"
+- ".github/workflows/windows.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.md
+- README.adoc
+- Rakefile
+- activeid.gemspec
+- examples/name_based_uuids.rb
+- examples/registering_active_record_type.rb
+- examples/storing_uuids_as_binaries.rb
+- examples/storing_uuids_as_strings.rb
+- examples/storing_uuids_natively.rb
+- examples/time_based_uuids.rb
+- examples/using_migrations.rb
+- gemfiles/Rails-5_0.gemfile
+- gemfiles/Rails-5_1.gemfile
+- gemfiles/Rails-5_2.gemfile
+- gemfiles/Rails-head.gemfile
+- lib/active_id.rb
+- lib/active_id/all.rb
+- lib/active_id/connection_patches.rb
+- lib/active_id/model.rb
+- lib/active_id/railtie.rb
+- lib/active_id/type.rb
+- lib/active_id/utils.rb
+- lib/active_id/version.rb
+- log/.keep
+- spec/integration/examples_for_uuid_models.rb
+- spec/integration/examples_for_uuid_models_having_namespaces.rb
+- spec/integration/examples_for_uuid_models_having_natural_keys.rb
+- spec/integration/migrations_spec.rb
+- spec/integration/model_without_uuids_spec.rb
+- spec/integration/no_patches_spec.rb
+- spec/integration/storing_uuids_as_binaries_spec.rb
+- spec/integration/storing_uuids_as_strings_spec.rb
+- spec/spec_helper.rb
+- spec/support/0_logger.rb
+- spec/support/1_db_connection.rb
+- spec/support/2_db_cleaner.rb
+- spec/support/database.yml
+- spec/support/fabricators.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/unit/attribute_type_spec.rb
+- spec/unit/utils_spec.rb
+homepage: https://github.com/riboseinc/activeid
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Support for binary UUIDs in ActiveRecord
+test_files:
+- spec/integration/examples_for_uuid_models.rb
+- spec/integration/examples_for_uuid_models_having_namespaces.rb
+- spec/integration/examples_for_uuid_models_having_natural_keys.rb
+- spec/integration/migrations_spec.rb
+- spec/integration/model_without_uuids_spec.rb
+- spec/integration/no_patches_spec.rb
+- spec/integration/storing_uuids_as_binaries_spec.rb
+- spec/integration/storing_uuids_as_strings_spec.rb
+- spec/spec_helper.rb
+- spec/support/0_logger.rb
+- spec/support/1_db_connection.rb
+- spec/support/2_db_cleaner.rb
+- spec/support/database.yml
+- spec/support/fabricators.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/unit/attribute_type_spec.rb
+- spec/unit/utils_spec.rb