mysql-binuuid-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8236b24424eb481ae0a04a19a4fc8801868d05b
+  data.tar.gz: 56fe9da411b6fb733ce53fd70ef9b1ecfeca8853
+SHA512:
+  metadata.gz: c96352beab858b8e93ee4c4a872402387781750312388d02b3644f80cc1a6fb12f461fbaf54c0d55582b54efba22bce677b40a6ffb16ba28ee3ea7a8d9bb2ffb
+  data.tar.gz: b7e9554728d7bd7302bcdf292cc11f7f344951d60cf32c4753e1e0d51a8c2558b4f66b1cbd19e23577293990580209023b2532494971ebc648e4701294cf2065

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle
+/.DS_Store
+/tmp
+/*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+env:
+  matrix:
+    - RAILS_VERSION=5.0.4
+    - RAILS_VERSION=5.1.0
+    - RAILS_VERSION=5.1.1
+    - RAILS_VERSION=5.1.2
+before_install:
+  - gem update bundler
+  - bundle update rails

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in the gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,125 @@
+PATH
+  remote: .
+  specs:
+    mysql-binuuid-rails (0.1.0)
+      rails (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.2)
+      actionpack (= 5.1.2)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.2)
+      actionpack (= 5.1.2)
+      actionview (= 5.1.2)
+      activejob (= 5.1.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.2)
+      actionview (= 5.1.2)
+      activesupport (= 5.1.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.2)
+      activesupport (= 5.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.2)
+      activesupport (= 5.1.2)
+      globalid (>= 0.3.6)
+    activemodel (5.1.2)
+      activesupport (= 5.1.2)
+    activerecord (5.1.2)
+      activemodel (= 5.1.2)
+      activesupport (= 5.1.2)
+      arel (~> 8.0)
+    activesupport (5.1.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    erubi (1.6.1)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    minitest-hooks (1.4.0)
+    minitest-spec-context (0.0.3)
+    mysql2 (0.4.8)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.2)
+      actioncable (= 5.1.2)
+      actionmailer (= 5.1.2)
+      actionpack (= 5.1.2)
+      actionview (= 5.1.2)
+      activejob (= 5.1.2)
+      activemodel (= 5.1.2)
+      activerecord (= 5.1.2)
+      activesupport (= 5.1.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.1.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.2)
+      actionpack (= 5.1.2)
+      activesupport (= 5.1.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  minitest-hooks
+  minitest-spec-context
+  mysql-binuuid-rails!
+  mysql2
+  rake
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Mark Oude Veldhuis
+
+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,92 @@
+[![Build Status](https://travis-ci.org/nedap/mysql-binuuid-rails.svg?branch=master)](https://travis-ci.org/nedap/mysql-binuuid-rails)
+[![Code Climate](https://codeclimate.com/github/nedap/mysql-binuuid-rails/badges/gpa.svg)](https://codeclimate.com/github/nedap/mysql-binuuid-rails)
+
+# mysql-binuuid-rails
+
+`mysql-binuuid-rails` leverages the Attributes API of Rails 5 and lets you
+define attributes of type UUID on your models. By doing so, you can store your
+UUIDs as binary values in your database, and still be able to query using
+the string representations since the database will take care of the
+type conversion.
+
+As the name suggests, it only supports MySQL. If you're on PostgreSQL, you
+can use UUIDs the proper way already.
+
+If you were to store a UUID of 32 characters (without the dashes) as text in
+your database, it would cost you at least 32 bytes. And that only counts if
+every character only requires 1 byte. But that completely depends on your
+encoding. If every character requires 2 bytes, storing it would already cost
+you 64 bytes. And that's a lot, if you think about the fact that a UUID is
+only 128 bits.
+
+Being 128 bits, a UUID fits precisely in a column of 16 bytes. Though it won't
+be really readable it sure saves up a lot of space and it's only 4x bigger
+than a 32-bit integer, or 2x bigger than a 64-bit integer.
+
+Not to mention the space you'll be saving when you create an index on the
+column holding your UUID.
+
+# Installation
+You know the drill, add this line to your gemfile:
+
+```
+gem 'mysql-binuuid-rails'
+```
+
+# Usage
+Using binary columns for UUIDs is very easy. There's only two steps you need to
+perform which are described here.
+
+## Adding the column to store your UUID
+Suppose you have a model called `Book` to which you want to add a unique
+identifier in the form of a UUID. First, make sure your database is able to
+hold this attribute. So let's create a migration.
+
+```
+$ rails g migration AddUuidColumnToBooks
+```
+
+Open up the migration file and change it as you'd like:
+
+```ruby
+class AddUuidColumnToBooks < ActiveRecord::Migration[5.1]
+  def change
+    # 'uuid' is the column name, and 'binary' is the column type. You have to
+    # specify it as a binary column yourself. And because we know that a UUID
+    # takes up 16 bytes, we set can specify its limit.
+    add_column :books, :uuid, :binary, limit: 16
+  end
+end
+```
+
+Perform the migration:
+
+```
+rails db:migrate
+```
+
+## Tell your model how to handle the binary UUID column
+All you have to do now, is specify in your `Book` model how Rails should handle
+the `uuid` column. Open up `app/models/book.rb` and simply add the following
+single line:
+
+```ruby
+class Book < ApplicationRecord
+  attribute :uuid, MySQLBinUUID::Type.new
+end
+```
+
+# Contributing
+
+To start coding on `mysql-binuuid-rails`, fork the project, clone it locally
+and then run `bin/setup` to get up and running. If you want to fool around in
+a console with the changes you made, run `bin/console`.
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/nedap/mysql-binuuid-rails
+
+
+# License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/all"
+require "mysql-binuuid-rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mysql-binuuid-rails.rb

@@ -0,0 +1,6 @@
+require 'mysql-binuuid/type'
+
+ActiveModel::Type.register(:uuid, MySQLBinUUID::Type)
+
+module MySQLBinUUID
+end

data/lib/mysql-binuuid/type.rb

@@ -0,0 +1,77 @@
+module MySQLBinUUID
+  class Type < ActiveModel::Type::Binary
+
+    def type
+      :uuid
+    end
+
+    # Invoked when a value that is returned from the database needs to be
+    # displayed into something readable again.
+    def cast(value)
+      if value.is_a?(MySQLBinUUID::Type::Data)
+        # It could be a Data object, in which case we should add dashes to the
+        # string value from there.
+        add_dashes(value.to_s)
+      elsif value.is_a?(String) && value.encoding == Encoding::ASCII_8BIT
+        # We cannot unpack something that looks like a UUID, with or without
+        # dashes. Not entirely sure why ActiveRecord does a weird combination of
+        # cast and serialize before anything needs to be saved..
+        undashed_uuid = value.unpack("H*")[0]
+        add_dashes(undashed_uuid.to_s)
+      else
+        super
+      end
+    end
+
+    # Invoked when the provided value needs to be serialized before storing
+    # it to the database.
+    def serialize(value)
+      return if value.nil?
+      Data.new(strip_dashes(value))
+    end
+
+    # We're inheriting from the Binary type since ActiveRecord in that case
+    # will get the hex value. All we need to do to provide the hex value of the
+    # UUID, is to return the UUID without dashes. And because this inherits
+    # from Binary::Data, ActiveRecord will quote the hex value as required by
+    # the database to store it.
+    class Data < ActiveModel::Type::Binary::Data
+      def initialize(value)
+        @value = value
+      end
+
+      def hex
+        @value
+      end
+    end
+
+  private
+
+    # A UUID consists of 5 groups of characters.
+    #   8 chars - 4 chars - 4 chars - 4 chars - 12 characters
+    #
+    # This function re-introduces the dashes since we removed them during
+    # serialization, so:
+    #
+    #   add_dashes("2b4a233152694c6e9d1e098804ab812b")
+    #     => "2b4a2331-5269-4c6e-9d1e-098804ab812b"
+    #
+    def add_dashes(uuid)
+      return uuid if uuid =~ /\-/
+      [uuid[0..7], uuid[8..11], uuid[12..15], uuid[16..19], uuid[20..-1]].join("-")
+    end
+
+    # A UUID has 4 dashes is displayed with 4 dashes at the same place all
+    # the time. So they don't add anything semantically. We can safely remove
+    # them before storing to the database, and re-add them whenever we
+    # retrieved a value from the database.
+    #
+    #   strip_dashes("2b4a2331-5269-4c6e-9d1e-098804ab812b")
+    #     => "2b4a233152694c6e9d1e098804ab812b"
+    #
+    def strip_dashes(uuid)
+      uuid.delete("-")
+    end
+
+  end
+end

data/lib/mysql-binuuid/version.rb

@@ -0,0 +1,3 @@
+module MySQLBinUUID
+  VERSION = "1.0.0"
+end

data/mysql-binuuid-rails.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "mysql-binuuid/version"
+
+Gem::Specification.new do |spec|
+  spec.name     = "mysql-binuuid-rails"
+  spec.version  = MySQLBinUUID::VERSION
+  spec.authors  = ["Mark Oude Veldhuis"]
+  spec.email    = ["mark.oudeveldhuis@nedap.com"]
+
+  spec.summary  = "Let ActiveRecord serialize and cast your UUIDs to and from binary columns in your database."
+  spec.homepage = "https://github.com/nedap/mysql-binuuid-rails"
+  spec.license  = "MIT"
+
+  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = ">= 2.2"
+
+  spec.add_runtime_dependency "rails", ENV["RAILS_VERSION"] || ">= 5"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-spec-context"
+  spec.add_development_dependency "minitest-hooks"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: mysql-binuuid-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Oude Veldhuis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: minitest
+  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: minitest-spec-context
+  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: minitest-hooks
+  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'
+description: 
+email:
+- mark.oudeveldhuis@nedap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mysql-binuuid-rails.rb
+- lib/mysql-binuuid/type.rb
+- lib/mysql-binuuid/version.rb
+- mysql-binuuid-rails.gemspec
+homepage: https://github.com/nedap/mysql-binuuid-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Let ActiveRecord serialize and cast your UUIDs to and from binary columns
+  in your database.
+test_files: []