ulid-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a5f3c3e4d66efd9d2df7948564b0e9603c1740dd2f3d8114f53d9db1da2d6b
-  data.tar.gz: ce3fa484e01d9886b24e9ad6c2e3ea18c7ddd7f2608888af48ef758abafd756e
+  metadata.gz: 4d66abad8321b174f9037f061da19837f539c4d42d01d328f267710023a7fc1d
+  data.tar.gz: df85e60420b30edf90ad5790cf1c70c338950e8b062363c10c29309cff03ecfb
 SHA512:
-  metadata.gz: 6782bc00605c44caec5faeaa1ec5e94f5db637226300a1db95cb852633405bf95ca73099dcd275eb4b59c72fe3a140b40d722aebcccc86a56c0bd5b07f233731
-  data.tar.gz: aaa614bb9fca638ecad81d0c5f76027ef464f7ba1e9b1e4d1493455d56f23090d03dcaaf2e1cbae27da7b40a7a2bda7f06e8d6e371d7a586e8a78385a10dde8a
+  metadata.gz: ab2ffb0c44b887852eb56a6fe0b4b93f9881e06f6a8ce6fe6322f28debb90a1b922d7aaff15ecc4296171addd7e73f34c094d7eefde0d451d5554011e821e7e6
+  data.tar.gz: c32c054dd8f14849f8b96d8ed0b6f83eb6be4006bf2c4c87cf81da381ae902f2a9e36d638a1bb317630c29f853b2aa5ad355e77fdb78de3793a25ed80f12b6d7

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# ulid-rails CHANGELOG
+## 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

@@ -4,3 +4,6 @@ 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

@@ -51,7 +51,23 @@ 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
+  ulid :id, primary_key: true # The first argument is the ULID column name
+end
+```
+
+### Extract timestamp
+
+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, 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
 ```
 
@@ -59,20 +75,34 @@ end
 
 **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.
-
+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.
 
+### 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
+```
+
 ## FAQ
 
 ### Foreign Keys

data/gemfiles/5.2.gemfile

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

data/gemfiles/6.0.gemfile

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

data/lib/ulid/rails.rb

@@ -12,25 +12,30 @@ 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 = auto_generate.nil? ? primary_key : false
+        if auto_generate
+          before_create do
+            send("#{column_name}=", ULID.generate) if send(column_name).nil?
+          end
         end
 
-        if primary_key
-          define_method :created_at do
+        def ulid_extract_timestamp(ulid_column, timestamp_column = :created_at)
+          define_method timestamp_column do
             at = super() rescue nil
-            if !at && (id_val = send(column_name))
+            if !at && (id_val = send(ulid_column))
               Time.zone.at((Base32::Crockford.decode(id_val) >> 80) / 1000.0)
             else
               at
             end
           end
 
-          define_singleton_method(:timestamp_attributes_for_create) do
-            []
+          if timestamp_column.to_s == "created_at"
+            define_singleton_method(:timestamp_attributes_for_create) do
+              []
+            end
           end
         end
       end

data/lib/ulid/rails/formatter.rb

@@ -4,20 +4,12 @@ module ULID
   module Rails
     module Formatter
       def self.format(v)
-        if v.length == 32
-          Base32::Crockford.encode(v.hex)
-        else
-          v
-        end
+        v.length == 32 ? Base32::Crockford.encode(v.hex).rjust(26, "0") : v
       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/type.rb

@@ -18,6 +18,8 @@ module ULID
           @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

data/lib/ulid/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ulid-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kazunori Kajihiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2019-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ulid
@@ -131,13 +131,15 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/5.2.gemfile
+- gemfiles/6.0.gemfile
 - lib/ulid/rails.rb
 - lib/ulid/rails/formatter.rb
 - lib/ulid/rails/patch.rb

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