ulid-rails 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad104e01d6ca64c2430e444ea5d900dcabf387200d177edf90be642bbebe3eaf
-  data.tar.gz: 28dc14190454edd67f047908981940d2741fb6cd7da2b416a4631cd0ea651e8d
+  metadata.gz: 5af3537525b91e1c92af1b6ea6bdc8a5a872943a1cb5c8d895f50addb0ae7508
+  data.tar.gz: 0032d5ad04a924b166bbcf10b1fa9d01a5222aa57175fca0b645dd5df05eee70
 SHA512:
-  metadata.gz: f7e03ce00d239548a353a0fb5d1601d8af16303a384fd7c20176065a34a4a3345b8fda3bcc1c18d140858edda8e7544638226037bc2d20c74a1341de3ac62d9d
-  data.tar.gz: 0c7a894e1124d72608f9e493ce7db594780715c1c0e0a69345970d59b093dcf10bc4bc4b1f21f5db9a48bc4862838cb06851485958b19caa4f8085fb1227eacb
+  metadata.gz: 3d2855d4fd84b86d85191104aeee9e8574bf3a29bf095c4fec622c611db9c19694db182476d9bd89c2f78f98193c6b8f2fbadf4045fe6240a0d0f0091f30ff19
+  data.tar.gz: 02ebc48788b7d39f5d1684802a2941b10e237d880885c63e311d76493d02f6a5956ba98b54c77c9d54014eec0306ac4df9f91d78324279c621623500bbaf002b

data/.env

@@ -1 +1 @@
-RUBY_VERSION=2.6
+RUBY_VERSION=2.7

data/.github/workflows/lint.yml

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

data/.github/workflows/test.yml

@@ -1,21 +1,36 @@
 ---
 name: Tests
-on: [push, pull_request]
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
 jobs:
   tests:
+    name: ActiveRecord ${{ matrix.activerecord-version }} / Ruby ${{ matrix.ruby-version }}
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        activerecord-version: ["5.0", "5.1", "5.2", "6.0", "6.1"]
-        ruby-version: ["2.6", "2.7", "3.0"]
+        activerecord-version: ["5.0", "5.1", "5.2", "6.0", "6.1", "7.0", "7.0.5"]
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
         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"
+          - {activerecord-version: "5.0", ruby-version: "3.0"}
+          - {activerecord-version: "5.0", ruby-version: "3.1"}
+          - {activerecord-version: "5.0", ruby-version: "3.2"}
+          - {activerecord-version: "5.1", ruby-version: "3.0"}
+          - {activerecord-version: "5.1", ruby-version: "3.1"}
+          - {activerecord-version: "5.1", ruby-version: "3.2"}
+          - {activerecord-version: "5.2", ruby-version: "3.0"}
+          - {activerecord-version: "5.2", ruby-version: "3.1"}
+          - {activerecord-version: "5.2", ruby-version: "3.2"}
+          - {activerecord-version: "6.0", ruby-version: "3.1"}
     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
+      - uses: actions/checkout@v3
+      - run: docker-compose run test
+        env:
+          RUBY_VERSION: ${{ matrix.ruby-version }}
+          AR_VERSION: ${{ matrix.activerecord-version }}

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require:
+  - rubocop-minitest
+  - standard
+
+inherit_gem:
+  rubocop-minitest: config/default.yml
+  standard: config/base.yml
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # ulid-rails CHANGELOG
 
+## Unreleased
+
+## 1.1.1
+
+- Drop support for ruby 2.6.
+- Fix compatibility with ActiveRecord 7.0.5+.
+
+## 1.1.0
+
+- Fix eager loading with limit/offset on models that have ulid primary key. The fix only applies to ActiveRecord 5.2, 6 and 7 (#38).
+- Add support for Ruby 3.1.
+- Add support for ActiveRecord 7.
+
 ## 1.0.0
 
 - Drop support for Rails 4.2.
@@ -11,6 +24,7 @@
 ## 0.6.0
 
 - Add support for Rails 4.2, 5.0 and 5.1.
+- Known Issue: AREL expressions incorrectly serialize ULID values in Rails 4.2 (#27).
 
 ## 0.5.0
 

data/Gemfile

@@ -1,9 +1,2 @@
-source "https://rubygems.org"
-
-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

@@ -2,24 +2,28 @@
 
 This gem makes it possible to use [ULID](https://github.com/ulid/spec) for DB in a Ruby on Rails app.
 
-
 ## Installation
 
-
 ```ruby
 gem 'ulid-rails'
 ```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install ulid-rails
+```
+$ gem install ulid-rails
+```
 
 ## Usage
 
+First, load up the gem with `require 'ulid/rails'`.
+
 ### Migrations
 
 Specify `id: false` to `create_table` and add `id` column as 16-byte binary type.
@@ -27,12 +31,13 @@ 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
+      t.binary :id, limit: 16, auto_generate: true
       # ...
     end
   end
 ```
 
+**MySQL note:** You can also declare the `id` column as `t.column :id, 'binary(16)'` when using MySQL, given that the syntax in the example will generate a SQL that makes the id as `VARBINARY(16)` instead of `BINARY(16)`.
 
 ### Model Changes
 
@@ -72,7 +77,7 @@ A virtual column is useful if you want to add index on the timestamp column or w
 
 ```ruby
 create_table :users, id: false do |t|
-  t.binary :id, limit: 16, primary_key: true
+  t.binary :id, limit: 16, auto_generate: true
   t.datetime :updated_at
   t.virtual_ulid_timestamp :created_at, :id
 end
@@ -103,6 +108,41 @@ You need to specicfy `type` option
     end
 ```
 
+### Many to many associations
+
+Please note that this library doesn't work properly with `has_and_belongs_to_many` associations.
+
+Our recommendation is to be explicit and instead use the `has_many, through: join_class` association.
+Notice that for it to work properly you must specify the `has_many` to the join class in the main classes of the association,
+and your join class must have `belongs_to` main classes defined as shown in the example below:
+
+```ruby
+  class User < ActiveRecord::Base
+    include ULID::Rails
+    ulid :id, auto_generate: true
+
+    has_many :user_articles
+    has_many :articles, through: :user_articles
+  end
+
+  class UserArticle < ActiveRecord::Base
+    include ULID::Rails
+    ulid :id, auto_generate: true
+    ulid :user_id
+    ulid :article_id
+
+    belongs_to :user
+    belongs_to :article
+  end
+
+  class Article < ActiveRecord::Base
+    include ULID::Rails
+    ulid :id, auto_generate: true
+
+    has_many :user_articles
+  end
+```
+
 ## Development
 
 ### Run tests
@@ -125,6 +165,10 @@ Or run tests locally, without docker-compose
 $ AR_VERSION=4.2 bundle update && AR_VERSION=4.2 bundle exec rake test
 ```
 
+## Known issues
+
+- ActiveRecord 5.0 and 5.1 do not work properly with some data association loading methods. For example, eager loading with limit/offset on a model that has a ulid ID. Refer to test cases that are skiped for AR 5.0 and 5.1.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/docker-compose.yml

@@ -1,8 +1,10 @@
 version: '3.6'
 services:
   test:
-    image: "ruby:${RUBY_VERSION}" 
+    image: "ruby:${RUBY_VERSION}"
     command: sh -c "rm -f Gemfile.lock && bundle install && bin/run_tests"
+    environment:
+      - AR_VERSION=${AR_VERSION}
     depends_on:
       pg12:
         condition: service_healthy
@@ -23,20 +25,20 @@ services:
       MYSQL_ROOT_PASSWORD: password
     command: --innodb-large-prefix --innodb-file-format=barracuda
     healthcheck:
-      test:  mysql --password=password -e "show databases;"
+      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;"
+      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;"
+      test: mysql --password=password -e "show databases;"
   pg12:
     image: postgres:12
     environment:

data/gemfiles/5.0.gemfile

@@ -1,6 +1,10 @@
-gem "activesupport", "~> 5.0"
-gem "activemodel", "~> 5.0"
-gem "activerecord", "~> 5.0"
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activesupport", "~> 5.0.0"
+gem "activemodel", "~> 5.0.0"
+gem "activerecord", "~> 5.0.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

@@ -1,6 +1,10 @@
-gem "activesupport", "~> 5.1"
-gem "activemodel", "~> 5.1"
-gem "activerecord", "~> 5.1"
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activesupport", "~> 5.1.0"
+gem "activemodel", "~> 5.1.0"
+gem "activerecord", "~> 5.1.0"
 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,8 +1,10 @@
 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"
+gemspec path: ".."
+
+gem "activesupport", "~> 5.2.0"
+gem "activemodel", "~> 5.2.0"
+gem "activerecord", "~> 5.2.0"
+gem "sqlite3", "~> 1.3", ">= 1.3.6"
+gem "mysql2", ">= 0.4.4", "< 0.6.0"
+gem "pg", ">= 0.18", "< 2.0"

data/gemfiles/6.0.gemfile

@@ -1,8 +1,10 @@
 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"
+gemspec path: ".."
+
+gem "activesupport", "~> 6.0.0"
+gem "activemodel", "~> 6.0.0"
+gem "activerecord", "~> 6.0.0"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", ">= 0.4.4"
+gem "pg", ">= 0.18", "< 2.0"

data/gemfiles/6.1.gemfile

@@ -1,8 +1,10 @@
 source "https://rubygems.org"
 
+gemspec path: ".."
+
 gem "activesupport", "~> 6.1.0"
 gem "activemodel", "~> 6.1.0"
 gem "activerecord", "~> 6.1.0"
-gem "sqlite3", "~> 1.4.2"
-gem "mysql2"
-gem "pg"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", "~> 0.5"
+gem "pg", "~> 1.1"

data/gemfiles/7.0.5.gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activesupport", "~> 7.0.5"
+gem "activemodel", "~> 7.0.5"
+gem "activerecord", "~> 7.0.5"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", "~> 0.5"
+gem "pg", "~> 1.1"

data/gemfiles/7.0.gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activesupport", "~> 7.0.0", "< 7.0.5"
+gem "activemodel", "~> 7.0.0", "< 7.0.5"
+gem "activerecord", "~> 7.0.0", "< 7.0.5"
+gem "sqlite3", "~> 1.4"
+gem "mysql2", "~> 0.5"
+gem "pg", "~> 1.1"

data/lib/ulid/rails/patch.rb

@@ -8,6 +8,46 @@ module ULID
             as: "FROM_UNIXTIME(CONV(HEX(#{ulid_column_name} >> 80), 16, 10) / 1000.0)"
         end
       end
+
+      module FinderMethods
+        def limited_ids_for(relation)
+          id_rows = super
+          if klass.attribute_types[primary_key].is_a? ULID::Rails::Type
+            id_rows.map do |id|
+              klass.attribute_types[primary_key].deserialize id
+            end
+          else
+            id_rows
+          end
+        end
+      end
+
+      module SchemaStatements
+        def distinct_relation_for_primary_key(relation) # :nodoc:
+          values = columns_for_distinct(
+            visitor.compile(relation.table[relation.primary_key]),
+            relation.order_values
+          )
+
+          limited = relation.reselect(values).distinct!
+          limited_ids = select_rows(limited.arel, "SQL").map(&:last)
+
+          if relation.klass.attribute_types[relation.primary_key].is_a? ULID::Rails::Type
+            limited_ids.map! do |id|
+              relation.klass.attribute_types[relation.primary_key].deserialize id
+            end
+          end
+
+          if limited_ids.empty?
+            relation.none!
+          else
+            relation.where!(relation.primary_key => limited_ids)
+          end
+
+          relation.limit_value = relation.offset_value = nil
+          relation
+        end
+      end
     end
   end
 end

data/lib/ulid/rails/type.rb

@@ -23,9 +23,24 @@ module ULID
       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")
+        case adapter
+        when "mysql2"
+          if value.is_a?(Data)
+            value = value.to_s
+          elsif value.is_a?(String)
+            value = value.unpack1("H*")
+          end
+        when "postgresql"
+          if value.is_a?(Data)
+            value = value.to_s
+            value = value.unpack1("H*")
+          end
+          value = value[2..-1] if value.start_with?("\\x")
+        when "sqlite3"
+          if value.is_a?(Data)
+            value = value.to_s
+          end
+        end
 
         value.length == 32 ? @formatter.format(value) : super
       end

data/lib/ulid/rails/version.rb

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

data/lib/ulid/rails.rb

@@ -46,5 +46,13 @@ module ULID
 
     ActiveModel::Type.register(:ulid, ULID::Rails::Type)
     ActiveRecord::ConnectionAdapters::TableDefinition.send :include, Patch::Migrations
+    case ActiveRecord::VERSION::MAJOR
+    when 5
+      ActiveRecord::FinderMethods.prepend(Patch::FinderMethods) unless ActiveRecord::VERSION::MINOR < 2
+    when 6
+      ActiveRecord::FinderMethods.prepend(Patch::FinderMethods)
+    when 7
+      ActiveRecord::ConnectionAdapters::SchemaStatements.prepend(Patch::SchemaStatements)
+    end
   end
 end

data/ulid-rails.gemspec

@@ -38,5 +38,6 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "rubocop-minitest"
+  spec.add_development_dependency "standard", "~> 1.16.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ulid-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kazunori Kajihiro
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ulid
@@ -123,20 +123,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.16.0
 description: ULID for rails
 email:
 - kazunori.kajihiro@gmail.com
@@ -149,6 +163,7 @@ files:
 - ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".standard.yml"
 - CHANGELOG.md
 - Gemfile
@@ -164,6 +179,8 @@ files:
 - gemfiles/5.2.gemfile
 - gemfiles/6.0.gemfile
 - gemfiles/6.1.gemfile
+- gemfiles/7.0.5.gemfile
+- gemfiles/7.0.gemfile
 - lib/ulid/rails.rb
 - lib/ulid/rails/errors.rb
 - lib/ulid/rails/formatter.rb
@@ -195,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: ULID for rails