ulid-rails 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c37eb5b4b0722d0858a1c08682e89a8285350ab1d151bc90bbb6aaf1c6cff5d
-  data.tar.gz: 9bd6b0bff5eb157b998f04b26b7eb75e3b53d90c4820e2dcbc9ede7c8a1246b8
+  metadata.gz: ad104e01d6ca64c2430e444ea5d900dcabf387200d177edf90be642bbebe3eaf
+  data.tar.gz: 28dc14190454edd67f047908981940d2741fb6cd7da2b416a4631cd0ea651e8d
 SHA512:
-  metadata.gz: ab1f5cf9796884e8845a67bf13a3e6b69f2e3d48c2b21c23ff5d0f1836fdbd6da1850dcb9292be74cad38476f4df3f4cd46306d66d2bdc203c7da50c24861ce2
-  data.tar.gz: f8300abe5bd288884ae1d8a24a12f08e3b6c248c144cc68f564fe567ff7c7fa213ce9a3110a1b5125a9ec9a38220afa139938cb12ce0b779532b613c6390e9a4
+  metadata.gz: f7e03ce00d239548a353a0fb5d1601d8af16303a384fd7c20176065a34a4a3345b8fda3bcc1c18d140858edda8e7544638226037bc2d20c74a1341de3ac62d9d
+  data.tar.gz: 0c7a894e1124d72608f9e493ce7db594780715c1c0e0a69345970d59b093dcf10bc4bc4b1f21f5db9a48bc4862838cb06851485958b19caa4f8085fb1227eacb

data/.env

@@ -0,0 +1 @@
+RUBY_VERSION=2.6

data/.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+---
+name: Linting
+on: [push, pull_request]
+jobs:
+  standardrb:
+    env:
+      AR_VERSION: "5.2"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - run: bundle exec standardrb

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+---
+name: Tests
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        activerecord-version: ["5.0", "5.1", "5.2", "6.0", "6.1"]
+        ruby-version: ["2.6", "2.7", "3.0"]
+        exclude:
+          - activerecord-version: "5.0"
+            ruby-version: "3.0"
+          - activerecord-version: "5.1"
+            ruby-version: "3.0"
+          - activerecord-version: "5.2"
+            ruby-version: "3.0"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Test ActiveRecord ${{ matrix.activerecord-version }} and Ruby ${{ matrix.ruby-version }}
+        run: RUBY_VERSION=${{ matrix.ruby-version }} docker-compose run -e AR_VERSION=${{ matrix.activerecord-version }} test

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+/gemfiles/*.gemfile.lock

data/.standard.yml

@@ -0,0 +1,4 @@
+ruby_version: 2.3
+ignore:
+  - 'vendor/**/*'
+  - 'gemfiles/vendor/**/*'

data/CHANGELOG.md

@@ -1,10 +1,32 @@
 # ulid-rails CHANGELOG
 
-## 0.3
+## 1.0.0
+
+- Drop support for Rails 4.2.
+
+### Breaking Changes
+
+- `primary_key` option has been removed. You need to specify `auto_generate: true` to automatically fill your primary key columns.
+
+## 0.6.0
+
+- Add support for Rails 4.2, 5.0 and 5.1.
+
+## 0.5.0
+
+- Ensure ULID order respects timestamp order to millisecond precision.
+- Validation of ULID format when setting value. A wrong format value will trigger a `ULID::Rails::ArgumentError`.
+
+## 0.4.0
+
+- Support old ruby versions
+- Fix auto_generate #2
+
+## 0.3.0
 
 - Support PostgresQL
 
-## 0.2
+## 0.2.0
 
 ### Breaking Changes
 

data/Gemfile

@@ -1,9 +1,9 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in ulid-rails.gemspec
 gemspec
 
-version = ENV['AR_VERSION'] || '6.0'
-eval_gemfile File.expand_path("../gemfiles/#{version}.gemfile", __FILE__)
+version = ENV["AR_VERSION"] || "6.0"
+eval_gemfile File.expand_path("../gemfiles/#{version}.gemfile", __FILE__)

data/README.md

@@ -1,6 +1,6 @@
 # ULID::Rails
 
-This gem makes it possible to use [ULID](https://github.com/ulid/spec) for DB primary keys in a Ruby on Rails app.
+This gem makes it possible to use [ULID](https://github.com/ulid/spec) for DB in a Ruby on Rails app.
 
 
 ## Installation
@@ -27,7 +27,7 @@ Specify `id: false` to `create_table` and add `id` column as 16-byte binary type
 ```ruby
   def change
     create_table :users, id: false do |t|
-      t.binary :id, limit: 16, primary_key: true # MySQL
+      t.binary :id, limit: 16, primary_key: true
       # ...
     end
   end
@@ -41,7 +41,7 @@ Just add the below lines to your models.
 ```ruby
 class MyModel < ApplicationRecord
   include ULID::Rails
-  ulid :id, primary_key: true # The first argument is the ULID column name
+  ulid :id, auto_generate: true # The first argument is the ULID column name
 end
 ```
 
@@ -53,7 +53,7 @@ Since ULID includes milli seconds precision timestamp, you don't need to store `
 ```ruby
 class MyModel < ApplicationRecord
   include ULID::Rails
-  ulid :id, primary_key: true # The first argument is the ULID column name
+  ulid :id, auto_generate: true # The first argument is the ULID column name
 
   # defines `created_at` method which extract timestamp value from id column.
   # This way you don't need physical `created_at` column.
@@ -63,7 +63,7 @@ end
 
 ### `created_at` virtual column
 
-**MySQL Only (for now)**
+**MySQL 5.7 and higher Only (for now)**
 
 You can define a "virtual column" in MySQL DB that acts same as a physical column.
 Defining the virtual `created_at` is kind of comlicated so this gem provides a helper method for it.
@@ -82,14 +82,13 @@ end
 
 ### Auto-generate ULID
 
-If `primary_key` is `true`, ULID is auto-generated before create by default.
-You can enable or disable auto-generation with `auto_generate` option.
+If `auto_generate` is `true`, ULID is auto-generated before create by default.
+If not specified, the default is `false`.
 
 ```
 class Model < ApplicationRecord
-  ulid :id, primary_key: true # primary key. auto-generate enabled
+  ulid :id, auto_generate: true #  auto-generate enabled
   ulid :foreign_key # auto-generate disabled
-  ulid :ulid, auto_generate: true # non primary, auto-generate enabled
 end
 ```
 
@@ -114,6 +113,18 @@ Just run the below command to test with all supported DB engines.
 $ docker-compose run test
 ```
 
+Or run with a specific ActiveRecord version
+
+```
+$ docker-compose run -e AR_VERSION=6.1 test
+```
+
+Or run tests locally, without docker-compose
+
+```
+$ AR_VERSION=4.2 bundle update && AR_VERSION=4.2 bundle exec rake test
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/bin/run_tests

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+set -e
+
 test_with_db() {
   echo "Testing with $1"
   DB=$1 bundle exec rake
@@ -7,17 +9,10 @@ test_with_db() {
 
 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"
+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"
+test_with_db "pg12"

data/docker-compose.yml

@@ -1,18 +1,22 @@
 version: '3.6'
 services:
   test:
-    image: ruby:2.6
-    command: sh -c "rm Gemfile.lock && bundle install && bin/run_tests"
+    image: "ruby:${RUBY_VERSION}" 
+    command: sh -c "rm -f Gemfile.lock && bundle install && bin/run_tests"
     depends_on:
-      - mysql56
-      - mysql57
-      - mysql80
-      - pg12
+      pg12:
+        condition: service_healthy
+      mysql56:
+        condition: service_healthy
+      mysql57:
+        condition: service_healthy
+      mysql80:
+        condition: service_healthy
     working_dir: /app
     volumes:
       - bundle:/usr/local/bundle
       - .:/app
-    
+
   mysql56:
     image: mysql:5.6
     environment:
@@ -38,7 +42,8 @@ services:
     environment:
       PGDATA: /data
       POSTGRES_DB: db
+      POSTGRES_HOST_AUTH_METHOD: trust
     healthcheck:
-      test: echo "\\l" | psql -U postgre
+      test: echo "\\l" | psql -U postgres
 volumes:
-  bundle:
+  bundle:

data/gemfiles/5.0.gemfile

@@ -0,0 +1,6 @@
+gem "activesupport", "~> 5.0"
+gem "activemodel", "~> 5.0"
+gem "activerecord", "~> 5.0"
+gem "sqlite3", "~> 1.3.6"
+gem "mysql2", ">= 0.3.18", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"

data/gemfiles/5.1.gemfile

@@ -0,0 +1,6 @@
+gem "activesupport", "~> 5.1"
+gem "activemodel", "~> 5.1"
+gem "activerecord", "~> 5.1"
+gem "sqlite3", "~> 1.3", ">= 1.3.6"
+gem "mysql2", ">= 0.3.18", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"

data/gemfiles/5.2.gemfile

@@ -1,6 +1,8 @@
+source "https://rubygems.org"
+
 gem "activesupport", "~> 5.2"
 gem "activemodel", "~> 5.2"
 gem "activerecord", "~> 5.2"
-gem 'sqlite3', '~> 1.3.6'
-gem 'mysql2'
-gem 'pg'
+gem "sqlite3", "~> 1.3.6"
+gem "mysql2"
+gem "pg"

data/gemfiles/6.0.gemfile

@@ -1,6 +1,8 @@
+source "https://rubygems.org"
+
 gem "activesupport", "~> 6.0"
 gem "activemodel", "~> 6.0"
 gem "activerecord", "~> 6.0"
-gem 'sqlite3', '~> 1.4.1'
-gem 'mysql2'
-gem 'pg'
+gem "sqlite3", "~> 1.4.1"
+gem "mysql2"
+gem "pg"

data/gemfiles/6.1.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.1.0"
+gem "activemodel", "~> 6.1.0"
+gem "activerecord", "~> 6.1.0"
+gem "sqlite3", "~> 1.4.2"
+gem "mysql2"
+gem "pg"

data/lib/ulid/rails/errors.rb

@@ -0,0 +1,5 @@
+module ULID
+  module Rails
+    class ArgumentError < StandardError; end
+  end
+end

data/lib/ulid/rails/formatter.rb

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

data/lib/ulid/rails/patch.rb

@@ -4,8 +4,8 @@ module ULID
       module Migrations
         def virtual_ulid_timestamp(timestamp_column_name, ulid_column_name)
           virtual timestamp_column_name,
-                  type: :datetime,
-                  as: "FROM_UNIXTIME(CONV(HEX(#{ulid_column_name} >> 80), 16, 10) / 1000.0)"
+            type: :datetime,
+            as: "FROM_UNIXTIME(CONV(HEX(#{ulid_column_name} >> 80), 16, 10) / 1000.0)"
         end
       end
     end

data/lib/ulid/rails/type.rb

@@ -1,5 +1,7 @@
 require "active_model/type"
 require "ulid/rails/formatter"
+require "ulid/rails/validator"
+require "ulid/rails/errors"
 
 module ULID
   module Rails
@@ -8,17 +10,22 @@ module ULID
         alias_method :hex, :to_s
       end
 
-      def initialize(formatter = Formatter)
+      def initialize(formatter = Formatter, validator = Validator)
         @formatter = formatter
+        @validator = validator
         super()
       end
 
-      def cast(value)
+      def assert_valid_value(value)
+        raise ArgumentError, "`#{value}` is not a ULID format" unless @validator.is_valid?(value)
+      end
+
+      def deserialize(value)
         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 = value.unpack1("H*") if value.encoding == Encoding::ASCII_8BIT
+        value = value[2..-1] if value.start_with?("\\x")
 
         value.length == 32 ? @formatter.format(value) : super
       end
@@ -26,13 +33,23 @@ module ULID
       def serialize(value)
         return if value.nil?
 
-        case ActiveRecord::Base.connection_config[:adapter]
+        case adapter
         when "mysql2", "sqlite3"
           Data.new(@formatter.unformat(value))
         when "postgresql"
           Data.new([@formatter.unformat(value)].pack("H*"))
         end
       end
+
+      private
+
+      def adapter
+        if ::ActiveRecord::Base.respond_to?(:connection_db_config)
+          ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter]
+        else
+          ::ActiveRecord::Base.connection_config[:adapter]
+        end
+      end
     end
   end
 end

data/lib/ulid/rails/validator.rb

@@ -0,0 +1,12 @@
+require "base32/crockford"
+
+module ULID
+  module Rails
+    module Validator
+      def self.is_valid?(v)
+        return true if v.nil?
+        v.length == 26 && Base32::Crockford.valid?(v)
+      end
+    end
+  end
+end

data/lib/ulid/rails/version.rb

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

data/lib/ulid/rails.rb

@@ -12,30 +12,33 @@ module ULID
     extend ActiveSupport::Concern
 
     class_methods do
-      def ulid(column_name, primary_key: false, auto_generate: nil)
+      def ulid(column_name, auto_generate: false)
         attribute column_name, ULID::Rails::Type.new
 
-        auto_generate = auto_generate.nil? ? primary_key : false
         if auto_generate
           before_create do
             send("#{column_name}=", ULID.generate) if send(column_name).nil?
           end
         end
+      end
 
-        def ulid_extract_timestamp(ulid_column, timestamp_column = :created_at)
-          define_method timestamp_column do
-            at = super() rescue nil
-            if !at && (id_val = send(ulid_column))
-              Time.zone.at((Base32::Crockford.decode(id_val) >> 80) / 1000.0)
-            else
-              at
-            end
+      def ulid_extract_timestamp(ulid_column, timestamp_column = :created_at)
+        define_method timestamp_column do
+          at = begin
+            super()
+          rescue
+            nil
+          end
+          if !at && (id_val = send(ulid_column))
+            Time.zone.at((Base32::Crockford.decode(id_val) >> 80) / 1000.0)
+          else
+            at
           end
+        end
 
-          if timestamp_column.to_s == "created_at"
-            define_singleton_method(:timestamp_attributes_for_create) do
-              []
-            end
+        if timestamp_column.to_s == "created_at"
+          define_singleton_method(:timestamp_attributes_for_create) do
+            []
           end
         end
       end

data/ulid-rails.gemspec

@@ -3,22 +3,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ulid/rails/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "ulid-rails"
-  spec.version       = ULID::Rails::VERSION
-  spec.authors       = ["Kazunori Kajihiro"]
-  spec.email         = ["kazunori.kajihiro@gmail.com"]
+  spec.name = "ulid-rails"
+  spec.version = ULID::Rails::VERSION
+  spec.required_ruby_version = ">= 2.5.0"
+  spec.authors = ["Kazunori Kajihiro", "Zendesk"]
+  spec.email = ["kazunori.kajihiro@gmail.com", "ruby-core@zendesk.com"]
 
-  spec.summary       = %q{ULID for rails}
-  spec.description   = %q{ULID for rails}
-  spec.license       = "MIT"
+  spec.summary = "ULID for rails"
+  spec.description = "ULID for rails"
+  spec.homepage = "https://github.com/k2nr/ulid-rails/"
+  spec.license = "MIT"
+
+  spec.metadata = {
+    "changelog_uri" => "https://github.com/k2nr/ulid-rails/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/k2nr/ulid-rails/",
+    "bug_tracker_uri" => "https://github.com/k2nr/ulid-rails/issues",
+    "rubygems_mfa_required" => "true"
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "ulid", "~> 1.0"
@@ -26,7 +35,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 5.0"
   spec.add_dependency "activemodel", ">= 5.0"
   spec.add_dependency "activerecord", ">= 5.0"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "standard", "~> 1.3.0"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ulid-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kazunori Kajihiro
-autorequire: 
+- Zendesk
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-24 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ulid
@@ -84,30 +85,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -122,15 +123,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 description: ULID for rails
 email:
 - kazunori.kajihiro@gmail.com
+- ruby-core@zendesk.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env"
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -139,21 +158,29 @@ files:
 - bin/console
 - bin/run_tests
 - bin/setup
-- bin/wait-for-it.sh
 - docker-compose.yml
+- gemfiles/5.0.gemfile
+- gemfiles/5.1.gemfile
 - gemfiles/5.2.gemfile
 - gemfiles/6.0.gemfile
+- gemfiles/6.1.gemfile
 - lib/ulid/rails.rb
+- lib/ulid/rails/errors.rb
 - lib/ulid/rails/formatter.rb
 - lib/ulid/rails/patch.rb
 - lib/ulid/rails/type.rb
+- lib/ulid/rails/validator.rb
 - lib/ulid/rails/version.rb
 - ulid-rails.gemspec
-homepage: 
+homepage: https://github.com/k2nr/ulid-rails/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/k2nr/ulid-rails/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/k2nr/ulid-rails/
+  bug_tracker_uri: https://github.com/k2nr/ulid-rails/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,16 +188,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.29
+signing_key:
 specification_version: 4
 summary: ULID for rails
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.4

data/bin/wait-for-it.sh

@@ -1,178 +0,0 @@
-#!/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