ulid-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83a5f3c3e4d66efd9d2df7948564b0e9603c1740dd2f3d8114f53d9db1da2d6b
+  data.tar.gz: ce3fa484e01d9886b24e9ad6c2e3ea18c7ddd7f2608888af48ef758abafd756e
+SHA512:
+  metadata.gz: 6782bc00605c44caec5faeaa1ec5e94f5db637226300a1db95cb852633405bf95ca73099dcd275eb4b59c72fe3a140b40d722aebcccc86a56c0bd5b07f233731
+  data.tar.gz: aaa614bb9fca638ecad81d0c5f76027ef464f7ba1e9b1e4d1493455d56f23090d03dcaaf2e1cbae27da7b40a7a2bda7f06e8d6e371d7a586e8a78385a10dde8a

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ulid-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kazunori Kajihiro
+
+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,91 @@
+# 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.
+
+
+## Installation
+
+
+```ruby
+gem 'ulid-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ulid-rails
+
+## Usage
+
+### Migrations
+
+If you use MySQL, 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
+      # ...
+    end
+  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
+
+Just add the below lines to your models.
+
+```ruby
+class MyModel < ApplicationRecord
+  include ULID::Rails
+  ulid :id # The argument is the primary key column name
+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.
+
+Defining the virtual `created_at` is kind of comlicated so this gem provides a helper method for it.
+
+```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
+```
+
+`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
+
+### Foreign Keys
+
+You need to specicfy `type` option
+
+```ruby
+    # MySQL
+    create_table :admin_usees do |t|
+      t.references :admin_user, foreign_key: true, type: "BINARY(16)"
+    end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ulid/rails"
+
+# 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(__FILE__)

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/ulid/rails.rb

@@ -0,0 +1,42 @@
+require "active_record"
+require "active_support/concern"
+require "active_model/type"
+require "ulid"
+require "base32/crockford"
+require "ulid/rails/version"
+require "ulid/rails/type"
+require "ulid/rails/patch"
+
+module ULID
+  module Rails
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def ulid(column_name = :id, primary_key: true)
+        attribute column_name, ULID::Rails::Type.new
+
+        before_create do
+          send("#{column_name}=", ULID.generate) if send(column_name).nil?
+        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
+          end
+
+          define_singleton_method(:timestamp_attributes_for_create) do
+            []
+          end
+        end
+      end
+    end
+
+    ActiveModel::Type.register(:ulid, ULID::Rails::Type)
+    ActiveRecord::ConnectionAdapters::TableDefinition.send :include, Patch::Migrations
+  end
+end

data/lib/ulid/rails/formatter.rb

@@ -0,0 +1,23 @@
+require "base32/crockford"
+
+module ULID
+  module Rails
+    module Formatter
+      def self.format(v)
+        if v.length == 32
+          Base32::Crockford.encode(v.hex)
+        else
+          v
+        end
+      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

@@ -0,0 +1,13 @@
+module ULID
+  module Rails
+    module Patch
+      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)"
+        end
+      end
+    end
+  end
+end

data/lib/ulid/rails/type.rb

@@ -0,0 +1,32 @@
+require "active_model/type"
+require "ulid/rails/formatter"
+
+module ULID
+  module Rails
+    class Type < ActiveModel::Type::Binary
+      class Data < ActiveModel::Type::Binary::Data
+        alias_method :hex, :to_s
+      end
+
+      def initialize(formatter = Formatter)
+        @formatter = formatter
+        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
+      end
+
+      def serialize(value)
+        return if value.nil?
+        Data.new(@formatter.unformat(value))
+      end
+    end
+  end
+end

data/lib/ulid/rails/version.rb

@@ -0,0 +1,5 @@
+module ULID
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/ulid-rails.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$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.summary       = %q{ULID for rails}
+  spec.description   = %q{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
+    `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.require_paths = ["lib"]
+
+  spec.add_dependency "ulid", "~> 1.0"
+  spec.add_dependency "base32-crockford", "~> 0.1"
+  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 "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: ulid-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazunori Kajihiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ulid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: base32-crockford
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: ULID for rails
+email:
+- kazunori.kajihiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ulid/rails.rb
+- lib/ulid/rails/formatter.rb
+- lib/ulid/rails/patch.rb
+- lib/ulid/rails/type.rb
+- lib/ulid/rails/version.rb
+- ulid-rails.gemspec
+homepage: 
+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.7.6
+signing_key: 
+specification_version: 4
+summary: ULID for rails
+test_files: []