activeid 0.6.1

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+module TempFixForRakeLastComment
+  def last_comment
+    last_description
+  end
+end
+Rake::Application.send :include, TempFixForRakeLastComment
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :test
+
+task test: [:spec, :examples]
+
+task :examples do
+  Dir.glob("examples/**.rb").sort.each do |example|
+    example_name = File.basename(example, ".rb").tr("_", " ")
+    puts "-" * 40
+    puts "Testing example: #{example_name}"
+    system "ruby", example
+    puts "-" * 40
+  end
+end

data/activeid.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "active_id/version"
+
+Gem::Specification.new do |s|
+  s.name        = "activeid"
+  s.version     = ActiveID::VERSION
+  s.authors       = ["Ribose Inc."]
+  s.email         = ["open.source@ribose.com"]
+  s.homepage    = "https://github.com/riboseinc/activeid"
+  s.summary     = "Support for binary UUIDs in ActiveRecord"
+  s.description = "Support for binary UUIDs in ActiveRecord"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "fabrication"
+  s.add_development_dependency "forgery"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "rspec-its"
+  s.add_development_dependency "solid_assert", "~> 1.0"
+
+  if RUBY_ENGINE == "jruby"
+    s.add_development_dependency "activerecord-jdbcmysql-adapter"
+    s.add_development_dependency "activerecord-jdbcpostgresql-adapter"
+    s.add_development_dependency "activerecord-jdbcsqlite3-adapter"
+  else
+    s.add_development_dependency "mysql2"
+    s.add_development_dependency "pg"
+    s.add_development_dependency "sqlite3", "~> 1.3.6"
+  end
+
+  s.add_runtime_dependency "activerecord", ">= 5.0", "< 6.0"
+  s.add_runtime_dependency "uuidtools"
+end

data/examples/name_based_uuids.rb

@@ -0,0 +1,92 @@
+# Name-based UUIDs (version 5) are generated deterministically basing
+# on attribute values and namespace.
+
+ENV["DB"] ||= "sqlite3"
+
+require "bundler/setup"
+Bundler.require :development
+
+require "active_id"
+require_relative "../spec/support/0_logger"
+require_relative "../spec/support/1_db_connection"
+
+#### SCHEMA ####
+
+ActiveRecord::Schema.define do
+  create_table :works, id: false, force: true do |t|
+    t.string :id, limit: 36, primary_key: true
+    t.string :author_id, limit: 36, index: true
+    t.string :title
+    t.timestamps
+  end
+
+  create_table :authors, id: false, force: true do |t|
+    t.string :id, limit: 36, primary_key: true
+    t.string :name
+    t.timestamps
+  end
+end
+
+#### MODELS ####
+
+class Work < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::StringUUID.new
+  attribute :author_id, ActiveID::Type::StringUUID.new
+  belongs_to :author
+  natural_key :author_id, :title
+  uuid_namespace "a6908e1e-5493-4c55-a11d-cd8445654de6"
+end
+
+class Author < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::StringUUID.new
+  has_many :works
+  natural_key :name
+end
+
+#### PROOF ####
+
+SolidAssert.enable_assertions
+
+poe = Author.create! name: "Edgar Alan Poe"
+thu = Author.create! name: "Thucydides"
+
+Work.create! title: "The Raven", author: poe
+Work.create! title: "The Black Cat", author: poe
+Work.create! title: "History of the Peloponnesian War", author: thu
+
+assert Author.count == 2
+assert Work.count == 3
+
+assert Author.find_by(name: "Edgar Alan Poe").works.size == 2
+assert Author.find_by(name: "Thucydides").works.size == 1
+
+assert UUIDTools::UUID === Author.first.id
+assert UUIDTools::UUID === Work.first.id
+assert UUIDTools::UUID === Work.first.author_id
+
+# Natural keys (UUIDs version 5) are generated deterministically.  Hence,
+# following will succeed despite that id is hardcoded:
+assert Author.find_by(id: "cb23040c-7635-58f2-a703-434c962821c1") == poe
+
+# Above UUID has been generated basing on author's name:
+uuid_namespace = UUIDTools::UUID_OID_NAMESPACE
+poe_id = UUIDTools::UUID.sha1_create(uuid_namespace, "Edgar Alan Poe")
+assert Author.find_by(id: poe_id).name == "Edgar Alan Poe"
+
+# Natural keys can be generated from more than just one field.  Also,
+# a namespace can be set for given model:
+uuid_namespace = UUIDTools::UUID.parse("a6908e1e-5493-4c55-a11d-cd8445654de6")
+raven_id = UUIDTools::UUID.sha1_create(uuid_namespace, "#{poe_id}-The Raven")
+assert Work.find_by(id: raven_id).title == "The Raven"
+
+#### PROVE THAT ASSERTIONS WERE WORKING ####
+
+begin
+  assert 1 == 2
+rescue SolidAssert::AssertionFailedError
+  puts "All OK."
+else
+  raise "Assertions do not work!"
+end

data/examples/registering_active_record_type.rb

@@ -0,0 +1,74 @@
+# Active UUID types can be added to Active Record's type registry.  This is
+# convenient as you can reference them in your models with a symbol.
+#
+# See Rails API docs for more information about +ActiveRecord::Type.register+:
+# https://api.rubyonrails.org/classes/ActiveRecord/Type.html#method-c-register
+
+ENV["DB"] ||= "sqlite3"
+
+require "bundler/setup"
+Bundler.require :development
+
+require "active_id"
+require_relative "../spec/support/0_logger"
+require_relative "../spec/support/1_db_connection"
+
+#### SCHEMA ####
+
+ActiveRecord::Schema.define do
+  create_table :authors, id: false, force: true do |t|
+    if ENV["DB"] == "postgresql"
+      t.uuid :id, primary_key: true
+    else
+      t.binary :id, limit: 16, primary_key: true
+    end
+    t.string :name
+    t.timestamps
+  end
+end
+
+#### TYPE REGISTRATION ####
+
+ActiveRecord::Type.register(
+  :uuid,
+  ActiveID::Type::BinaryUUID,
+)
+
+# In PostgreSQL adapter, +:uuid+ is already registered, but it can be overriden.
+ActiveRecord::Type.register(
+  :uuid,
+  ActiveID::Type::StringUUID,
+  adapter: :postgresql,
+  override: true,
+)
+
+#### MODELS ####
+
+class Author < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, :uuid
+end
+
+#### PROOF ####
+
+SolidAssert.enable_assertions
+
+Author.create! name: "Edgar Alan Poe"
+
+assert Author.count == 1
+
+if ENV["DB"] == "postgresql"
+  assert ActiveID::Type::StringUUID === Author.first.type_for_attribute("id")
+else
+  assert ActiveID::Type::BinaryUUID === Author.first.type_for_attribute("id")
+end
+
+#### PROVE THAT ASSERTIONS WERE WORKING ####
+
+begin
+  assert 1 == 2
+rescue SolidAssert::AssertionFailedError
+  puts "All OK."
+else
+  raise "Assertions do not work!"
+end

data/examples/storing_uuids_as_binaries.rb

@@ -0,0 +1,88 @@
+# See README for comparison between string and binary storage.
+
+ENV["DB"] ||= "sqlite3"
+
+if ENV["DB"] == "postgresql"
+  puts <<~MESSAGE
+    Example irrelevant for selected database (#{ENV['DB']}).
+    Storing UUIDs as binaries is not compatible with PostgreSQL adapter.
+  MESSAGE
+  exit(0)
+end
+
+require "bundler/setup"
+Bundler.require :development
+
+require "active_id"
+require_relative "../spec/support/0_logger"
+require_relative "../spec/support/1_db_connection"
+
+#### SCHEMA ####
+
+ActiveRecord::Schema.define do
+  create_table :works, id: false, force: true do |t|
+    t.binary :id, limit: 16, primary_key: true
+    t.binary :author_id, limit: 16, index: true
+    t.string :title
+    t.timestamps
+  end
+
+  create_table :authors, id: false, force: true do |t|
+    t.binary :id, limit: 16, primary_key: true
+    t.string :name
+    t.timestamps
+  end
+end
+
+#### MODELS ####
+
+class Work < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::BinaryUUID.new
+  attribute :author_id, ActiveID::Type::BinaryUUID.new
+  belongs_to :author
+end
+
+class Author < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::BinaryUUID.new
+  has_many :works
+end
+
+#### PROOF ####
+
+SolidAssert.enable_assertions
+
+poe = Author.create! name: "Edgar Alan Poe"
+thu = Author.create! name: "Thucydides"
+
+Work.create! title: "The Raven", author: poe
+Work.create! title: "The Black Cat", author: poe
+Work.create! title: "History of the Peloponnesian War", author: thu
+
+assert Author.count == 2
+assert Work.count == 3
+
+assert Author.find_by(name: "Edgar Alan Poe").works.size == 2
+assert Author.find_by(name: "Thucydides").works.size == 1
+
+assert UUIDTools::UUID === Author.first.id
+assert UUIDTools::UUID === Work.first.id
+assert UUIDTools::UUID === Work.first.author_id
+
+# Version 4 means randomly generated UUID
+assert Author.first.id.version == 4
+
+# UUIDs are stored in database as 16 bytes long binaries
+raw_id = Author.first.attributes_before_type_cast["id"]
+assert raw_id.bytes.size == 16
+
+#### PROVE THAT ASSERTIONS WERE WORKING ####
+
+begin
+  assert 1 == 2
+rescue SolidAssert::AssertionFailedError
+  puts "All OK."
+else
+  raise "Assertions do not work!"
+end

data/examples/storing_uuids_as_strings.rb

@@ -0,0 +1,81 @@
+# See README for comparison between string and binary storage.
+
+ENV["DB"] ||= "sqlite3"
+
+require "bundler/setup"
+Bundler.require :development
+
+require "active_id"
+require_relative "../spec/support/0_logger"
+require_relative "../spec/support/1_db_connection"
+
+#### SCHEMA ####
+
+ActiveRecord::Schema.define do
+  create_table :works, id: false, force: true do |t|
+    t.string :id, limit: 36, primary_key: true
+    t.string :author_id, limit: 36, index: true
+    t.string :title
+    t.timestamps
+  end
+
+  create_table :authors, id: false, force: true do |t|
+    t.string :id, limit: 36, primary_key: true
+    t.string :name
+    t.timestamps
+  end
+end
+
+#### MODELS ####
+
+class Work < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::StringUUID.new
+  attribute :author_id, ActiveID::Type::StringUUID.new
+  belongs_to :author
+end
+
+class Author < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::StringUUID.new
+  has_many :works
+end
+
+#### PROOF ####
+
+SolidAssert.enable_assertions
+
+poe = Author.create! name: "Edgar Alan Poe"
+thu = Author.create! name: "Thucydides"
+
+Work.create! title: "The Raven", author: poe
+Work.create! title: "The Black Cat", author: poe
+Work.create! title: "History of the Peloponnesian War", author: thu
+
+assert Author.count == 2
+assert Work.count == 3
+
+assert Author.find_by(name: "Edgar Alan Poe").works.size == 2
+assert Author.find_by(name: "Thucydides").works.size == 1
+
+assert UUIDTools::UUID === Author.first.id
+assert UUIDTools::UUID === Work.first.id
+assert UUIDTools::UUID === Work.first.author_id
+
+# Version 4 means randomly generated UUID
+assert Author.first.id.version == 4
+
+# UUIDs are stored in database as 36 characters long strings
+raw_id = Author.first.attributes_before_type_cast["id"]
+assert raw_id.chars.size == 36
+assert /^[-a-f0-9]*$/ =~ raw_id
+
+#### PROVE THAT ASSERTIONS WERE WORKING ####
+
+begin
+  assert 1 == 2
+rescue SolidAssert::AssertionFailedError
+  puts "All OK."
+else
+  raise "Assertions do not work!"
+end

data/examples/storing_uuids_natively.rb

@@ -0,0 +1,93 @@
+# PostgreSQL natively features a UUID data type, which offerst great performance
+# without sacrificing human-readability.
+
+ENV["DB"] ||= "sqlite3"
+
+unless ENV["DB"] == "postgresql"
+  puts <<~MESSAGE
+    Example irrelevant for selected database (#{ENV['DB']}).
+    From supported databases, only PostgreSQL features
+    a UUID data type natively.
+  MESSAGE
+  exit(0)
+end
+
+require "bundler/setup"
+Bundler.require :development
+
+require "active_id"
+require_relative "../spec/support/0_logger"
+require_relative "../spec/support/1_db_connection"
+
+#### SCHEMA ####
+
+# PostgreSQL adapter adds #uuid column method to table definitions
+
+ActiveRecord::Schema.define do
+  create_table :works, id: false, force: true do |t|
+    t.uuid :id, primary_key: true
+    t.uuid :author_id, index: true
+    t.string :title
+    t.timestamps
+  end
+
+  create_table :authors, id: false, force: true do |t|
+    t.uuid :id, primary_key: true
+    t.string :name
+    t.timestamps
+  end
+end
+
+#### MODELS ####
+
+class Work < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::StringUUID.new
+  attribute :author_id, ActiveID::Type::StringUUID.new
+  belongs_to :author
+end
+
+class Author < ActiveRecord::Base
+  include ActiveID::Model
+  attribute :id, ActiveID::Type::StringUUID.new
+  has_many :works
+end
+
+#### PROOF ####
+
+SolidAssert.enable_assertions
+
+poe = Author.create! name: "Edgar Alan Poe"
+thu = Author.create! name: "Thucydides"
+
+Work.create! title: "The Raven", author: poe
+Work.create! title: "The Black Cat", author: poe
+Work.create! title: "History of the Peloponnesian War", author: thu
+
+assert Author.count == 2
+assert Work.count == 3
+
+assert Author.find_by(name: "Edgar Alan Poe").works.size == 2
+assert Author.find_by(name: "Thucydides").works.size == 1
+
+assert UUIDTools::UUID === Author.first.id
+assert UUIDTools::UUID === Work.first.id
+assert UUIDTools::UUID === Work.first.author_id
+
+# Version 4 means randomly generated UUID
+assert Author.first.id.version == 4
+
+# UUIDs are stored in database as 36 characters long strings
+raw_id = Author.first.attributes_before_type_cast["id"]
+assert raw_id.chars.size == 36
+assert /^[-a-f0-9]*$/ =~ raw_id
+
+#### PROVE THAT ASSERTIONS WERE WORKING ####
+
+begin
+  assert 1 == 2
+rescue SolidAssert::AssertionFailedError
+  puts "All OK."
+else
+  raise "Assertions do not work!"
+end