ulid-rails 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a5f3c3e4d66efd9d2df7948564b0e9603c1740dd2f3d8114f53d9db1da2d6b
-  data.tar.gz: ce3fa484e01d9886b24e9ad6c2e3ea18c7ddd7f2608888af48ef758abafd756e
+  metadata.gz: b4ae7aa650be9d57249be6d2a1a3bf77bf26fdb14493533137d7296f07772410
+  data.tar.gz: 521af5d85b5b033b182678cd189ebbbbebf6e4571f2cfe076bcae4fa37800c6d
 SHA512:
-  metadata.gz: 6782bc00605c44caec5faeaa1ec5e94f5db637226300a1db95cb852633405bf95ca73099dcd275eb4b59c72fe3a140b40d722aebcccc86a56c0bd5b07f233731
-  data.tar.gz: aaa614bb9fca638ecad81d0c5f76027ef464f7ba1e9b1e4d1493455d56f23090d03dcaaf2e1cbae27da7b40a7a2bda7f06e8d6e371d7a586e8a78385a10dde8a
+  metadata.gz: 7feebaa207e82b83fb213380f14df767216afb69ab8ee91d4ffd68495776d9b8c7f1ee2550f92ac5f7292b5b5c1511dc4a714cfa0671b2a7fe3528a15fb567b8
+  data.tar.gz: 886b465219c7fd77f57dad6c2c6c658149cfa22918ab7505863af86382beafbeb1d4616f02e1d13190fb14ab2044a95c8a9ca55bba6cbd87703c870e00c19284

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,17 @@
+---
+name: Tests
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix: 
+        activerecord-version: ["5.2", "6.0", "6.1"]
+        ruby-version: ["2.6", "2.7", "3.0"]
+        exclude:
+          - 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

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.3

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# ulid-rails CHANGELOG
+
+## 0.5
+
+- 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
+
+- Support old ruby versions
+- Fix auto_generate #2
+
+## 0.3
+
+- Support PostgresQL
+
+## 0.2
+
+### Breaking Changes
+
+- `primary_key` option's default has been changed to `false`. Now you need to specify `primary_key: true` for primary keys: `ulid :id, primary_key: true`
+
+### New Features
+
+- Added `auto_generate` option
+
+### Bug Fixes
+
+- Auto-generate was on for foreign keys
+- Encoded ULID was not 0-padded #1

data/Gemfile

@@ -1,6 +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__)

data/README.md

@@ -22,58 +22,76 @@ 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
     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
 ```
 
-If you use PostgreSQL, just specify `id: :uuid` to `create_table`
+
+### Model Changes
+
+Just add the below lines to your models.
 
 ```ruby
-  def change
-    create_table :users, id: :uuid do |t|
-      # ...
-    end
-  end
+class MyModel < ApplicationRecord
+  include ULID::Rails
+  ulid :id, primary_key: true # The first argument is the ULID column name
+end
 ```
 
+### Extract timestamp
 
-### Model Changes
-
-Just add the below lines to your models.
+Since ULID includes milli seconds precision timestamp, you don't need to store `created_at`.
+`ulid-rails` provides a helper method that defines timestamp method which extract timestamp from ULID column.
 
 ```ruby
 class MyModel < ApplicationRecord
   include ULID::Rails
-  ulid :id # The argument is the primary key column name
+  ulid :id, primary_key: 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.
+  ulid_extract_timestamp :id, :created_at
 end
 ```
 
 ### `created_at` virtual column
 
-**MySQL Only (for now)**
-
-Since ULID includes milli seconds precision timestamp, you don't need to store `created_at`. You can instead create a virtual column that extracts the timestamp from the ULID column.
+**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.
 
+A virtual column is useful if you want to add index on the timestamp column or want to execute raw SQL with created_at.
+
 ```ruby
-    create_table :users, id: false do |t|
-      t.binary :id, limit: 16, primary_key: true
-      t.datetime :updated_at
-      t.virtual_ulid_timestamp :created_at, :id
-    end
+create_table :users, id: false do |t|
+  t.binary :id, limit: 16, primary_key: true
+  t.datetime :updated_at
+  t.virtual_ulid_timestamp :created_at, :id
+end
 ```
 
 `virtual_ulid_timestamp` takes two arguments, the first one is the name of the column name (typically, `created_at`) and the second one is the ULID column that creation timestamp is extracted from.
 
-## FAQ
+### 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.
+
+```
+class Model < ApplicationRecord
+  ulid :id, primary_key: true # primary key. auto-generate enabled
+  ulid :foreign_key # auto-generate disabled
+  ulid :ulid, auto_generate: true # non primary, auto-generate enabled
+end
+```
 
 ### Foreign Keys
 
@@ -86,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/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

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+
+test_with_db() {
+  echo "Testing with $1"
+  DB=$1 bundle exec rake
+}
+
+test_with_db "sqlite3"
+
+test_with_db "mysql56"
+
+test_with_db "mysql57"
+
+test_with_db "mysql80"
+
+test_with_db "pg12"

data/docker-compose.yml

@@ -0,0 +1,49 @@
+version: '3.6'
+services:
+  test:
+    image: "ruby:${RUBY_VERSION}" 
+    command: sh -c "rm -f Gemfile.lock && bundle install && bin/run_tests"
+    depends_on:
+      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:
+      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
+      POSTGRES_HOST_AUTH_METHOD: trust
+    healthcheck:
+      test: echo "\\l" | psql -U postgres
+volumes:
+  bundle:

data/gemfiles/5.2.gemfile

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

data/gemfiles/6.0.gemfile

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

data/gemfiles/6.1.gemfile

@@ -0,0 +1,6 @@
+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,20 +4,13 @@ module ULID
   module Rails
     module Formatter
       def self.format(v)
-        if v.length == 32
-          Base32::Crockford.encode(v.hex)
-        else
-          v
-        end
+        sanitized = v.delete("-").hex
+        Base32::Crockford.encode(sanitized).rjust(26, "0")
       end
 
       def self.unformat(v)
         Base32::Crockford.decode(v).to_s(16).rjust(32, "0")
       end
-
-      def self.regexp
-        /\A[[:alnum:]]{25}\z/
-      end
     end
   end
 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,24 +10,45 @@ 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)
-        if value.is_a?(Data)
-          @formatter.format(value.to_s)
-        elsif value&.encoding == Encoding::ASCII_8BIT
-          @formatter.format(value.unpack("H*")[0])
-        else
-          super
-        end
+      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.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
 
       def serialize(value)
         return if value.nil?
-        Data.new(@formatter.unformat(value))
+
+        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

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.1.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/ulid/rails.rb

@@ -12,23 +12,32 @@ module ULID
     extend ActiveSupport::Concern
 
     class_methods do
-      def ulid(column_name = :id, primary_key: true)
+      def ulid(column_name, primary_key: false, auto_generate: nil)
         attribute column_name, ULID::Rails::Type.new
 
-        before_create do
-          send("#{column_name}=", ULID.generate) if send(column_name).nil?
+        auto_generate = primary_key || auto_generate
+        if auto_generate
+          before_create do
+            send("#{column_name}=", ULID.generate) if send(column_name).nil?
+          end
         end
+      end
 
-        if primary_key
-          define_method :created_at do
-            at = super() rescue nil
-            if !at && (id_val = send(column_name))
-              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

data/ulid-rails.gemspec

@@ -3,22 +3,22 @@ $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.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.license = "MIT"
 
   # 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 +26,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.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kazunori Kajihiro
-autorequire: 
+- Zendesk
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2021-10-25 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,33 +123,58 @@ 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
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/run_tests
 - bin/setup
+- docker-compose.yml
+- 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:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,9 +189,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.3
+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/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ulid-rails (0.1.0)
-      activemodel (>= 5.0)
-      activerecord (>= 5.0)
-      activesupport (>= 5.0)
-      base32-crockford (~> 0.1)
-      ulid (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.1)
-      activesupport (= 5.2.1)
-    activerecord (5.2.1)
-      activemodel (= 5.2.1)
-      activesupport (= 5.2.1)
-      arel (>= 9.0)
-    activesupport (5.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    base32-crockford (0.1.0)
-    concurrent-ruby (1.0.5)
-    i18n (1.1.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    rake (10.5.0)
-    sysrandom (1.0.5)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    ulid (1.0.0)
-      sysrandom (>= 1.0.0, < 2.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  ulid-rails!
-
-BUNDLED WITH
-   1.16.4