mysql-binuuid-rails 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f01fb21d7eef3732217c5bc02e7298dbcefd42a2b612196e39375681a9e292
-  data.tar.gz: a3a441eac4a15010fd11e28ab0ed667b4ecfa0d9a244e8219899b5fc0659a938
+  metadata.gz: 8ac0fe31f7165213913151accdd548a6e45df4f89e726984dd708e03bff87cbc
+  data.tar.gz: baf18f21d48269fc96ceda3a928b8978e9d6c49a87b2630d3a68b665cd196d33
 SHA512:
-  metadata.gz: 12c9dd93cb6e87b4f6e1f280ef1ccbce5e347aecc77e5cb596443664d750f59b8fa164bb162862be4ba3f0dec554f371118f0f69b4cedbbba3cafe6c353334f8
-  data.tar.gz: aec523ffd9fc6f47e206e6cda682450ec29784eae7179c0df29d6bd7667b4047f556a0f69c6ed43e797ebbeb07d3e4453b2622990c1b89184963e3110ca86464
+  metadata.gz: 67638457394097e0a518c3b6743751625b102e1ac4f3c12ed7fd093a8ab12050d7ee6b7c81a7d35e24ffe91a8712a6f67ba59291cdd37f396260cf84d366af1c
+  data.tar.gz: 5fb73f55ffbe2b859cafb42afa951863f51e89195d09c3de7d97269da901e459cce32e9d2a3696f1e4ac9e8314dbf0c98fca94067e32652e6ffe9d3801c8d9a6

data/CHANGELOG.md

@@ -1,32 +1,24 @@
-# 1.2.1
-
-  * Development: Now that we're running Semaphore, no need for Travis (#31)
-  * Reduce dependencies listed in gemspec (#30) (Dependency on Rails removed,
-    only need to depend on ActiveRecord)
+# 1.3.0
+* Up required Ruby version to 2.6.
 
+# 1.2.1
+* Development: Now that we're running Semaphore, no need for Travis (#31)
+* Reduce dependencies listed in gemspec (#30) (Dependency on Rails removed,
+  only need to depend on ActiveRecord)
 
 # 1.2.0
-
-  * Set minimum Ruby version from 2.3 to 2.4 (2.3 is EOL and no longer maintained)
-  * Fixed an issue where a UUID would be unpacked again while it's a perfectly
-    fine UUID already.
-    Thanks @sirwolfgang
-
+* Set minimum Ruby version from 2.3 to 2.4 (2.3 is EOL and no longer maintained)
+* Fixed an issue where a UUID would be unpacked again while it's a perfectly
+  fine UUID already. Thanks @sirwolfgang.
 
 # 1.1.1
-
-  * Fixes possible SQL injection for ActiveRecord columns typed with
-    MySQLBinUUID::Type.
-    Thank you @ejoubaud, @geoffevason and @viraptor.
-
+* Fixes possible SQL injection for ActiveRecord columns typed with
+  MySQLBinUUID::Type. Thank you @ejoubaud, @geoffevason and @viraptor.
 
 # 1.1.0
-
-  * Set minimum Ruby version from 2.2 to 2.3
-  * Set default Ruby version to 2.5.1
-  * Updated README shipped with the gem
-
+* Set minimum Ruby version from 2.2 to 2.3
+* Set default Ruby version to 2.5.1
+* Updated README shipped with the gem
 
 # 1.0.0
-
-  * Initial release.
+* Initial release.

data/Gemfile.lock

@@ -0,0 +1,155 @@
+PATH
+  remote: .
+  specs:
+    mysql-binuuid-rails (1.2.1)
+      activerecord (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    minitest-hooks (1.5.0)
+      minitest (> 5.3)
+    minitest-spec-context (0.0.4)
+    mysql2 (0.5.3)
+    nio4r (2.5.7)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  minitest-hooks
+  minitest-spec-context
+  mysql-binuuid-rails!
+  mysql2
+  rails (>= 5)
+  rake
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,13 +1,12 @@
-[![Build Status](https://semaphoreci.com/api/v1/nedap-healthcare/mysql-binuuid-rails/branches/master/badge.svg)](https://semaphoreci.com/nedap-healthcare/mysql-binuuid-rails)
-[![Code Climate](https://codeclimate.com/github/nedap/mysql-binuuid-rails/badges/gpa.svg)](https://codeclimate.com/github/nedap/mysql-binuuid-rails)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7bcb6538e7666bc37f9a/maintainability)](https://codeclimate.com/github/nedap/mysql-binuuid-rails/maintainability) [![Build Status](https://nedap.semaphoreci.com/badges/mysql-binuuid-rails/branches/master.svg?style=shields)](https://nedap.semaphoreci.com/projects/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.
+`mysql-binuuid-rails` lets you define attributes of a UUID type on your models
+by leveraging the Attributes API that has been available since Rails 5. 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.
@@ -152,6 +151,19 @@ 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
 
+## Testing
+
+Continuous integration / automated tests run [on Semaphore](https://nedap.semaphoreci.com/projects/mysql-binuuid-rails).
+Tests are run against the latest patch version of every minor ActiveRecord release
+since 5.0, as well as *every* patch version of the latest minor version.
+
+Run tests yourself to verify everything is still working:
+
+```
+$ bundle exec rake
+```
+
+
 ## Contributors
 
 See [CONTRIBUTORS.md](CONTRIBUTORS.md).

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "rails/all"
+require "active_record/railtie"
 require "mysql-binuuid-rails"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/lib/mysql-binuuid/version.rb

@@ -1,3 +1,3 @@
 module MySQLBinUUID
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/mysql-binuuid-rails.gemspec

@@ -15,18 +15,18 @@ Gem::Specification.new do |spec|
   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.files = Dir["**/*"].select { |f| File.file?(f) }
+                          .reject { |f| f.end_with?(".gem") }
 
-  spec.required_ruby_version = ">= 2.4"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.add_runtime_dependency "activerecord", ENV["RAILS_VERSION"] || ">= 5"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "mysql2", "< 0.5"
+  spec.add_development_dependency "mysql2"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-spec-context"
   spec.add_development_dependency "minitest-hooks"
+  spec.add_development_dependency "rails", ENV["RAILS_VERSION"] || ">= 5" # required for a console
 end

data/test/integration/mysql_integration_test.rb

@@ -0,0 +1,131 @@
+require_relative '../test_helper'
+
+class MyUuidModel < ActiveRecord::Base
+  attribute :the_uuid, MySQLBinUUID::Type.new
+end
+
+describe MyUuidModel do
+  include Minitest::Hooks
+
+  def connection
+    ActiveRecord::Base.connection
+  end
+
+  let(:db_config) do
+    { adapter:  'mysql2',
+      host:     'localhost',
+      username: 'root',
+      password: ENV['DATABASE_MYSQL_PASSWORD'] || '',
+      database: 'binuuid_rails_test' }
+  end
+
+  before(:all) do
+    db_config_without_db_name = db_config.dup
+    db_config_without_db_name.delete(:database)
+
+    # Create a connection without selecting a database first to create the db
+    ActiveRecord::Base.establish_connection(db_config_without_db_name)
+    connection.create_database(db_config[:database], charset: "utf8mb4")
+
+    # Then establish a new connection with the database name
+    ActiveRecord::Base.establish_connection(db_config)
+    connection.create_table("my_uuid_models")
+    connection.add_column("my_uuid_models", "the_uuid", :binary, limit: 16)
+
+    # Uncomment this line to get logging on stdout
+    # ActiveRecord::Base.logger = Logger.new(STDOUT)
+  end
+
+  after(:all) do
+    connection.drop_database(db_config[:database])
+  end
+
+  let(:sample_uuid) { SecureRandom.uuid }
+
+  context "without saving" do
+    it "does not change the uuid when retrieved without saving" do
+      my_model = MyUuidModel.new(the_uuid: sample_uuid)
+      assert_equal sample_uuid, my_model.the_uuid
+      assert_equal sample_uuid, my_model.attributes["the_uuid"]
+    end
+  end
+
+  context "before saving" do
+    describe "rails validation" do
+
+      class MyUuidModelWithValidations < MyUuidModel
+        validates :the_uuid, uniqueness: true
+      end
+
+      it "validates uniqueness" do
+        skip("Skipping uniqueness validation test, known issue on Rails/ActiveRecord 5.0") if ActiveRecord.version < Gem::Version.new("5.1.0")
+
+        uuid = sample_uuid
+        MyUuidModelWithValidations.create!(the_uuid: uuid)
+        duplicate = MyUuidModelWithValidations.new(the_uuid: uuid)
+
+        assert_equal false, duplicate.valid?
+        assert_equal :taken, duplicate.errors.details[:the_uuid].first[:error]
+      end
+
+    end
+  end
+
+  context "after persisting to the database" do
+    before do
+      @my_model = MyUuidModel.create!(the_uuid: sample_uuid)
+    end
+
+    after do
+      MyUuidModel.delete_all
+    end
+
+    it "stores a binary value in the database" do
+      raw_value = connection.execute("SELECT * FROM my_uuid_models").to_a.first[1]
+      assert_equal raw_value.encoding, Encoding::ASCII_8BIT
+    end
+
+    it "stores a binary value without dashes" do
+      raw_value = connection.execute("SELECT * FROM my_uuid_models").to_a.first[1]
+
+      # Create a version without dashes of the sample uuid
+      sample_uuid_no_dashes = sample_uuid.delete("-")
+
+      # Put it in an array so we can create the binary representation we
+      # also get from the database.
+      assert_equal [sample_uuid_no_dashes].pack("H*"), raw_value
+    end
+
+    it "can be found using .find_by" do
+      find_result = MyUuidModel.find_by(the_uuid: sample_uuid)
+      assert_equal find_result, @my_model
+      assert_equal find_result.the_uuid, sample_uuid
+    end
+
+    it "can be found using .where" do
+      results = MyUuidModel.where(the_uuid: sample_uuid)
+      assert_equal results.count, 1
+      assert_equal results.first, @my_model
+      assert_equal results.first.the_uuid, sample_uuid
+    end
+
+    it "can't be used to inject SQL using .where" do
+      assert_raises MySQLBinUUID::InvalidUUID do
+        MyUuidModel.where(the_uuid: "' OR ''='").first
+      end
+    end
+
+    it "can't be used to inject SQL using .find_by" do
+      assert_raises MySQLBinUUID::InvalidUUID do
+        MyUuidModel.find_by(the_uuid: "' OR ''='")
+      end
+    end
+
+    it "can't be used to inject SQL while creating" do
+      assert_raises MySQLBinUUID::InvalidUUID do
+        MyUuidModel.create!(the_uuid: "40' + x'40")
+      end
+    end
+  end
+
+end

data/test/mysql-binuuid/type_data_test.rb

@@ -0,0 +1,13 @@
+require_relative '../test_helper'
+
+describe MySQLBinUUID::Type::Data do
+
+  it "is of kind ActiveModel::Type::Binary::Data" do
+    assert_kind_of ActiveModel::Type::Binary::Data, MySQLBinUUID::Type::Data.new(nil)
+  end
+
+  it "returns the raw value as hex value" do
+    assert_equal "e7db0d1a", MySQLBinUUID::Type::Data.new("e7db0d1a").hex
+  end
+
+end

data/test/mysql-binuuid/type_test.rb

@@ -0,0 +1,55 @@
+require_relative '../test_helper'
+
+describe MySQLBinUUID::Type do
+
+  before do
+    @type = MySQLBinUUID::Type.new
+  end
+
+  describe '#type' do
+    it 'reports :uuid as its type' do
+      assert_equal :uuid, @type.type
+    end
+  end
+
+  describe '#cast' do
+    it 'returns a dashed uuid if provided with a MySQLBinUUID::Type::Data' do
+      uuid = "c5997c21-3355-4603-9e41-4fdc7194fe2d"
+      data = MySQLBinUUID::Type::Data.new(uuid)
+
+      assert_equal uuid, @type.cast(data)
+    end
+
+    it 'returns a dashed uuid if provided with a binary string' do
+      uuid = "6d7c7ff2-dca8-45eb-b3a0-3b9a24a5270e"
+      binstring = [uuid.delete("-")].pack("H*")
+      binstring.force_encoding("ASCII-8BIT")
+      assert_equal uuid, @type.cast(binstring)
+    end
+
+    it 'returns the value itself if provided with something else' do
+      assert_equal 42, @type.cast(42)
+    end
+
+    it 'returns a uuid if provided with a uuid' do
+      uuid = SecureRandom.uuid.encode(Encoding::ASCII_8BIT)
+      data = MySQLBinUUID::Type.new.cast(uuid)
+
+      assert_equal uuid, @type.cast(data)
+    end
+  end
+
+  describe '#serialize' do
+    it 'returns nil if provided with nil (touché)' do
+      assert_nil @type.serialize(nil)
+    end
+
+    it 'returns a MySQLBinUUID::Type::Data with stripped values if provided with a UUID' do
+      uuid = "3511f33f-3c93-4806-9846-52b4a7618298"
+
+      assert_instance_of MySQLBinUUID::Type::Data, @type.serialize(uuid)
+      assert_equal "3511f33f3c934806984652b4a7618298", @type.serialize(uuid).to_s
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest-spec-context'
+require 'minitest/hooks'
+
+require 'active_record'
+require 'securerandom'
+
+require_relative '../lib/mysql-binuuid-rails'
+require_relative '../lib/mysql-binuuid/type'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql-binuuid-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Mark Oude Veldhuis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -56,16 +56,16 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -108,18 +108,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description:
 email:
 - mark.oudeveldhuis@nedap.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTORS.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -129,11 +142,15 @@ files:
 - lib/mysql-binuuid/type.rb
 - lib/mysql-binuuid/version.rb
 - mysql-binuuid-rails.gemspec
+- test/integration/mysql_integration_test.rb
+- test/mysql-binuuid/type_data_test.rb
+- test/mysql-binuuid/type_test.rb
+- test/test_helper.rb
 homepage: https://github.com/nedap/mysql-binuuid-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,15 +158,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Let ActiveRecord serialize and cast your UUIDs to and from binary columns
   in your database.

data/.gitignore

@@ -1,5 +0,0 @@
-/.bundle
-/.DS_Store
-/tmp
-/*.gem
-Gemfile.lock

data/.ruby-version

@@ -1 +0,0 @@
-2.6.1