ulid-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d66abad8321b174f9037f061da19837f539c4d42d01d328f267710023a7fc1d
-  data.tar.gz: df85e60420b30edf90ad5790cf1c70c338950e8b062363c10c29309cff03ecfb
+  metadata.gz: 3c37eb5b4b0722d0858a1c08682e89a8285350ab1d151bc90bbb6aaf1c6cff5d
+  data.tar.gz: 9bd6b0bff5eb157b998f04b26b7eb75e3b53d90c4820e2dcbc9ede7c8a1246b8
 SHA512:
-  metadata.gz: ab2ffb0c44b887852eb56a6fe0b4b93f9881e06f6a8ce6fe6322f28debb90a1b922d7aaff15ecc4296171addd7e73f34c094d7eefde0d451d5554011e821e7e6
-  data.tar.gz: c32c054dd8f14849f8b96d8ed0b6f83eb6be4006bf2c4c87cf81da381ae902f2a9e36d638a1bb317630c29f853b2aa5ad355e77fdb78de3793a25ed80f12b6d7
+  metadata.gz: ab1f5cf9796884e8845a67bf13a3e6b69f2e3d48c2b21c23ff5d0f1836fdbd6da1850dcb9292be74cad38476f4df3f4cd46306d66d2bdc203c7da50c24861ce2
+  data.tar.gz: f8300abe5bd288884ae1d8a24a12f08e3b6c248c144cc68f564fe567ff7c7fa213ce9a3110a1b5125a9ec9a38220afa139938cb12ce0b779532b613c6390e9a4

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 # ulid-rails CHANGELOG
+
+## 0.3
+
+- Support PostgresQL
+
 ## 0.2
 
 ### Breaking Changes

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ### Migrations
 
-If you use MySQL, specify `id: false` to `create_table` and add `id` column as 16-byte binary type.
+Specify `id: false` to `create_table` and add `id` column as 16-byte binary type.
 
 ```ruby
   def change
@@ -33,16 +33,6 @@ If you use MySQL, specify `id: false` to `create_table` and add `id` column as 1
   end
 ```
 
-If you use PostgreSQL, just specify `id: :uuid` to `create_table`
-
-```ruby
-  def change
-    create_table :users, id: :uuid do |t|
-      # ...
-    end
-  end
-```
-
 
 ### Model Changes
 
@@ -103,8 +93,6 @@ class Model < ApplicationRecord
 end
 ```
 
-## FAQ
-
 ### Foreign Keys
 
 You need to specicfy `type` option
@@ -116,6 +104,16 @@ You need to specicfy `type` option
     end
 ```
 
+## Development
+
+### Run tests
+
+Just run the below command to test with all supported DB engines.
+
+```
+$ docker-compose run test
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/run_tests

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+test_with_db() {
+  echo "Testing with $1"
+  DB=$1 bundle exec rake
+}
+
+test_with_db "sqlite3"
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+# Most features should work with MySQL 5.6 but I couldn't properly set it up in test.
+# $DIR/wait-for-it.sh mysql56:3306
+# test_with_db "mysql56"
+
+$DIR/wait-for-it.sh mysql57:3306
+test_with_db "mysql57"
+
+$DIR/wait-for-it.sh mysql80:3306
+test_with_db "mysql80"
+
+$DIR/wait-for-it.sh pg12:5432
+test_with_db "pg12"

data/bin/wait-for-it.sh

@@ -0,0 +1,178 @@
+#!/usr/bin/env bash
+#   Use this script to test if a given TCP host/port are available
+
+WAITFORIT_cmdname=${0##*/}
+
+echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
+
+usage()
+{
+    cat << USAGE >&2
+Usage:
+    $WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
+    -h HOST | --host=HOST       Host or IP under test
+    -p PORT | --port=PORT       TCP port under test
+                                Alternatively, you specify the host and port as host:port
+    -s | --strict               Only execute subcommand if the test succeeds
+    -q | --quiet                Don't output any status messages
+    -t TIMEOUT | --timeout=TIMEOUT
+                                Timeout in seconds, zero for no timeout
+    -- COMMAND ARGS             Execute command with args after the test finishes
+USAGE
+    exit 1
+}
+
+wait_for()
+{
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    else
+        echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
+    fi
+    WAITFORIT_start_ts=$(date +%s)
+    while :
+    do
+        if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
+            nc -z $WAITFORIT_HOST $WAITFORIT_PORT
+            WAITFORIT_result=$?
+        else
+            (echo > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
+            WAITFORIT_result=$?
+        fi
+        if [[ $WAITFORIT_result -eq 0 ]]; then
+            WAITFORIT_end_ts=$(date +%s)
+            echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
+            break
+        fi
+        sleep 1
+    done
+    return $WAITFORIT_result
+}
+
+wait_for_wrapper()
+{
+    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
+    if [[ $WAITFORIT_QUIET -eq 1 ]]; then
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    else
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    fi
+    WAITFORIT_PID=$!
+    trap "kill -INT -$WAITFORIT_PID" INT
+    wait $WAITFORIT_PID
+    WAITFORIT_RESULT=$?
+    if [[ $WAITFORIT_RESULT -ne 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    fi
+    return $WAITFORIT_RESULT
+}
+
+# process arguments
+while [[ $# -gt 0 ]]
+do
+    case "$1" in
+        *:* )
+        WAITFORIT_hostport=(${1//:/ })
+        WAITFORIT_HOST=${WAITFORIT_hostport[0]}
+        WAITFORIT_PORT=${WAITFORIT_hostport[1]}
+        shift 1
+        ;;
+        --child)
+        WAITFORIT_CHILD=1
+        shift 1
+        ;;
+        -q | --quiet)
+        WAITFORIT_QUIET=1
+        shift 1
+        ;;
+        -s | --strict)
+        WAITFORIT_STRICT=1
+        shift 1
+        ;;
+        -h)
+        WAITFORIT_HOST="$2"
+        if [[ $WAITFORIT_HOST == "" ]]; then break; fi
+        shift 2
+        ;;
+        --host=*)
+        WAITFORIT_HOST="${1#*=}"
+        shift 1
+        ;;
+        -p)
+        WAITFORIT_PORT="$2"
+        if [[ $WAITFORIT_PORT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --port=*)
+        WAITFORIT_PORT="${1#*=}"
+        shift 1
+        ;;
+        -t)
+        WAITFORIT_TIMEOUT="$2"
+        if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --timeout=*)
+        WAITFORIT_TIMEOUT="${1#*=}"
+        shift 1
+        ;;
+        --)
+        shift
+        WAITFORIT_CLI=("$@")
+        break
+        ;;
+        --help)
+        usage
+        ;;
+        *)
+        echoerr "Unknown argument: $1"
+        usage
+        ;;
+    esac
+done
+
+if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
+    echoerr "Error: you need to provide a host and port to test."
+    usage
+fi
+
+WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
+WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
+WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
+WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
+
+# check to see if timeout is from busybox?
+WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
+WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
+if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
+        WAITFORIT_ISBUSY=1
+        WAITFORIT_BUSYTIMEFLAG="-t"
+
+else
+        WAITFORIT_ISBUSY=0
+        WAITFORIT_BUSYTIMEFLAG=""
+fi
+
+if [[ $WAITFORIT_CHILD -gt 0 ]]; then
+    wait_for
+    WAITFORIT_RESULT=$?
+    exit $WAITFORIT_RESULT
+else
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        wait_for_wrapper
+        WAITFORIT_RESULT=$?
+    else
+        wait_for
+        WAITFORIT_RESULT=$?
+    fi
+fi
+
+if [[ $WAITFORIT_CLI != "" ]]; then
+    if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
+        echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
+        exit $WAITFORIT_RESULT
+    fi
+    exec "${WAITFORIT_CLI[@]}"
+else
+    exit $WAITFORIT_RESULT
+fi

data/docker-compose.yml

@@ -0,0 +1,44 @@
+version: '3.6'
+services:
+  test:
+    image: ruby:2.6
+    command: sh -c "rm Gemfile.lock && bundle install && bin/run_tests"
+    depends_on:
+      - mysql56
+      - mysql57
+      - mysql80
+      - pg12
+    working_dir: /app
+    volumes:
+      - bundle:/usr/local/bundle
+      - .:/app
+    
+  mysql56:
+    image: mysql:5.6
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+    command: --innodb-large-prefix --innodb-file-format=barracuda
+    healthcheck:
+      test:  mysql --password=password -e "show databases;"
+  mysql57:
+    image: mysql:5.7
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+    healthcheck:
+      test:  mysql --password=password -e "show databases;"
+  mysql80:
+    image: mysql:8.0
+    command: --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+    healthcheck:
+      test:  mysql --password=password -e "show databases;"
+  pg12:
+    image: postgres:12
+    environment:
+      PGDATA: /data
+      POSTGRES_DB: db
+    healthcheck:
+      test: echo "\\l" | psql -U postgre
+volumes:
+  bundle:

data/gemfiles/5.2.gemfile

@@ -1,4 +1,6 @@
 gem "activesupport", "~> 5.2"
 gem "activemodel", "~> 5.2"
 gem "activerecord", "~> 5.2"
-gem 'sqlite3', '~> 1.3.6'
+gem 'sqlite3', '~> 1.3.6'
+gem 'mysql2'
+gem 'pg'

data/gemfiles/6.0.gemfile

@@ -1,4 +1,6 @@
 gem "activesupport", "~> 6.0"
 gem "activemodel", "~> 6.0"
 gem "activerecord", "~> 6.0"
-gem 'sqlite3', '~> 1.4.1'
+gem 'sqlite3', '~> 1.4.1'
+gem 'mysql2'
+gem 'pg'

data/lib/ulid/rails/formatter.rb

@@ -4,7 +4,8 @@ module ULID
   module Rails
     module Formatter
       def self.format(v)
-        v.length == 32 ? Base32::Crockford.encode(v.hex).rjust(26, "0") : v
+        sanitized = v.delete('-').hex
+        Base32::Crockford.encode(sanitized).rjust(26, "0")
       end
 
       def self.unformat(v)

data/lib/ulid/rails/type.rb

@@ -14,20 +14,24 @@ module ULID
       end
 
       def cast(value)
-        if value.is_a?(Data)
-          @formatter.format(value.to_s)
-        elsif value&.encoding == Encoding::ASCII_8BIT
-          @formatter.format(value.unpack("H*")[0])
-        elsif value&.length == 32
-          @formatter.format(value)
-        else
-          super
-        end
+        return nil if value.nil?
+
+        value = value.to_s if value.is_a?(Data)
+        value = value.unpack("H*")[0] if value.encoding == Encoding::ASCII_8BIT
+        value = value[2..] if value.start_with?("\\x")
+
+        value.length == 32 ? @formatter.format(value) : super
       end
 
       def serialize(value)
         return if value.nil?
-        Data.new(@formatter.unformat(value))
+
+        case ActiveRecord::Base.connection_config[:adapter]
+        when "mysql2", "sqlite3"
+          Data.new(@formatter.unformat(value))
+        when "postgresql"
+          Data.new([@formatter.unformat(value)].pack("H*"))
+        end
       end
     end
   end

data/lib/ulid/rails/version.rb

@@ -1,5 +1,5 @@
 module ULID
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ulid-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kazunori Kajihiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2019-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ulid
@@ -137,7 +137,10 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/run_tests
 - bin/setup
+- bin/wait-for-it.sh
+- docker-compose.yml
 - gemfiles/5.2.gemfile
 - gemfiles/6.0.gemfile
 - lib/ulid/rails.rb