activerecord-mysql-uuid-column 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93bbb70dfec9743994eaf1b9d2b68fd1ce501c2a
+  data.tar.gz: 88e2fb91ddbc60279652e4dc118f392eda0c0af7
+SHA512:
+  metadata.gz: e134578e531e9e134cbe9c61e402bf4421cc640a8d1a2858205cf1683b6bc962a74682e3911bea230c8d97afb72c108fa4fc888c7d858e6b962529c05caf319e
+  data.tar.gz: 0a849700022f5a288b2cdd1b837221f5a50dd864b04881212832510b4c543efbcd713ca246e5cf2cc0d3b04e5361699e10d574c56cea2e83c88cd81e62ad64f6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.2.6
+  - 2.3.3
+before_install: gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mathieu@justbudget.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-mysql-uuid-column.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mathieu Jobin
+
+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,68 @@
+# ActiveRecord::Mysql::UuidColumn
+
+Adds a :uuid column to ActiveRecord MySQL Adapter
+it is stored in a 16 bytes binary column. which is exactly the space it needs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-mysql-uuid-column'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-mysql-uuid-column
+
+## Usage
+
+# Regular MySQL ActiveRecord config
+```
+test:
+  adapter: mysql2
+  username: root
+  host: localhost
+  reconnect: true
+  database: uuid_test
+```
+
+Adds column type `uuid`
+
+```
+ActiveRecord::Schema.define(version: 20161122225732) do
+  create_table "test_uuids", force: true do |t|
+    t.uuid     "uuid"
+  end
+end
+```
+
+Define it in your model
+
+```
+class Worker < ActiveRecord::Base
+  attribute :job_uuid, :uuid
+end
+```
+
+Then use as regular string column, except that it will be stored in a 16 bytes binary column.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mathieujobin/activerecord-mysql-uuid-column. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-mysql-uuid-column.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record-mysql-uuid_column/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-mysql-uuid-column"
+  spec.version       = ActiveRecord::Mysql::UuidColumn::VERSION
+  spec.authors       = ["Mathieu Jobin"]
+  spec.email         = ["mathieu@justbudget.com"]
+
+  spec.summary       = %q{This gem add support for a real uuid column for MySQL adapter.}
+  spec.description   = %q{Most people use varchar(36) for storing uuids, which is very wrong for storing a 128 bit integer.}
+  spec.homepage      = "https://github.com/mathieujobin/activerecord-mysql-uuid-column"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", '~> 0'
+  spec.add_development_dependency "looksee", '~> 0'
+  spec.add_dependency "activerecord", ">= 5", "< 6"
+  spec.add_dependency "mysql2", "~> 0.4.4"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record-mysql-uuid_column"
+
+# 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

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/active_record-mysql-uuid_column.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'active_record-mysql-uuid_column/version'
+require 'active_record-mysql-uuid_column/migration_column.rb'
+require 'active_record-mysql-uuid_column/type_class.rb'
+require 'active_record-mysql-uuid_column/mysql2_adapter_monkey_patch.rb'
+
+ActiveRecord::Type.register(:uuid, ActiveRecord::Type::Uuid, adapter: :mysql2)

data/lib/active_record-mysql-uuid_column/migration_column.rb

@@ -0,0 +1,13 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module MySQL
+      module ColumnMethods
+        def uuid(*args, **options)
+          # http://dba.stackexchange.com/questions/904/mysql-data-type-for-128-bit-integers
+          # http://dev.mysql.com/doc/refman/5.7/en/binary-varbinary.html
+          args.each { |name| column(name, :binary, options.merge(limit: 16)) }
+        end
+      end
+    end
+  end
+end

data/lib/active_record-mysql-uuid_column/mysql2_adapter_monkey_patch.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class Mysql2Adapter
+      private
+
+      def _quote(value)
+        if value.is_a?(Type::Uuid::Data) or value.is_a?(Type::Binary::Data)
+          "x'#{value.hex}'"
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_record-mysql-uuid_column/type_class.rb

@@ -0,0 +1,78 @@
+module ActiveRecord
+  module Type
+    class Uuid < ActiveRecord::Type::Binary
+      def type
+        :uuid
+      end
+
+      # from database binary(16) to string
+      def deserialize(value)
+        return nil if value.nil?
+        Data.from_database(value)
+      end
+
+      # from user input (string) to database
+      def cast(value)
+        if value.is_a?(Data)
+          value
+        elsif value.is_a?(ActiveSupport::ToJsonWithActiveSupportEncoder) or value.is_a?(String)
+          Data.from_uuid_string(super)
+        else
+          raise ArgumentError,
+            "Unsupported input data of class type #{value.class}"
+        end
+      end
+
+      def serialize(value)
+        value
+      end
+
+      def assert_valid_value(value)
+        case value.class
+        when String, ActiveSupport::ToJsonWithActiveSupportEncoder
+          if value.downcase.gsub(/[^a-f0-9]/, '').size == 32
+            value
+          else
+            raise SerializationTypeMismatch,
+              "Invalid String uuid #{value}."
+          end
+        else
+          raise SerializationTypeMismatch,
+            "Unsupported value object of type #{value.class}."
+        end
+      end
+
+      class Data
+        def initialize(display_format, storage_format)
+          @display_format, @storage_format = display_format, storage_format
+        end
+
+        def self.from_uuid_string(uuid)
+          new(uuid, uuid.downcase.gsub(/[^a-f0-9]/, ''))
+        end
+
+        def self.from_database(value)
+          storage_format = value.unpack('H*').first.rjust(32, '0')
+          new(
+            storage_format.gsub(/^(.{8})(.{4})(.{4})(.{4})(.{12})$/, '\1-\2-\3-\4-\5'),
+            storage_format
+          )
+        end
+
+        def to_s
+          @display_format
+        end
+        alias_method :to_str, :to_s
+
+        def hex
+          @storage_format
+        end
+
+        def ==(other)
+          other == to_s || super
+        end
+      end
+
+    end
+  end
+end

data/lib/active_record-mysql-uuid_column/version.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module Mysql
+    module UuidColumn
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-mysql-uuid-column
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mathieu Jobin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: looksee
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+description: Most people use varchar(36) for storing uuids, which is very wrong for
+  storing a 128 bit integer.
+email:
+- mathieu@justbudget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-mysql-uuid-column.gemspec
+- bin/console
+- bin/setup
+- lib/active_record-mysql-uuid_column.rb
+- lib/active_record-mysql-uuid_column/migration_column.rb
+- lib/active_record-mysql-uuid_column/mysql2_adapter_monkey_patch.rb
+- lib/active_record-mysql-uuid_column/type_class.rb
+- lib/active_record-mysql-uuid_column/version.rb
+homepage: https://github.com/mathieujobin/activerecord-mysql-uuid-column
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: This gem add support for a real uuid column for MySQL adapter.
+test_files: []