ulid-rails 1.1.0 → 2.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f122ca0476d8b8c06f1f4bf08219bdf653d0ba890a3cdb6d9d5d99dfec353424
-  data.tar.gz: 0d1d58ea8a26637db28421610971049cbc9730201c39f9d9444757a65a249a4e
+  metadata.gz: 4fe6dfad2124c31cc7fbd3b744c8309d3abbd1fe8b3f0f737e87730d48e4a7ad
+  data.tar.gz: 5c94f88160609b46cb584c5e802e1a8fbfc3ae92e75e08277ca50c4f5693d24b
 SHA512:
-  metadata.gz: c37272d98ec13e144f2aa8c704d3db3140bf672cf3f6d7e76931acc7ab008b0a51cc91a51c402a8dbc14d73da3ce31092ace18e99efcf31b9ad4ff4c5fd6cb16
-  data.tar.gz: d7bcabb538e9f4a588b7d28b79459c06e44c9bfaeffdcaf5e563823908cdad5bcf7de3cd9fd2da20b21062415686e40f5df0904b53e38b9ac367084021616a19
+  metadata.gz: 0f39ff3a403a16b42ea3ee18a82938b266998f936dabe319084d52dedc2a2260761b92ed3273b8b074c0ee95b30979eef30b41abfa8db73ea16b0436652f1b26
+  data.tar.gz: a836d749d63b71b66cc310262db3c3cd529b5378e17c3ef5c265503c695d446fdc954df36f9c74b828ab423620e707138877322db1546b1d6fc3f3e7c4b986aa

data/.env

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

data/.github/workflows/lint.yml

@@ -6,6 +6,7 @@ on:
   push:
     branches:
       - master
+  workflow_dispatch:
 
 jobs:
   standardrb:

data/.github/workflows/test.yml

@@ -6,25 +6,22 @@ on:
   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", "7.0"]
-        ruby-version: ["2.6", "2.7", "3.0", "3.1"]
-        exclude:
-          - {activerecord-version: "5.0", ruby-version: "3.0"}
-          - {activerecord-version: "5.0", ruby-version: "3.1"}
-          - {activerecord-version: "5.1", ruby-version: "3.0"}
-          - {activerecord-version: "5.1", ruby-version: "3.1"}
-          - {activerecord-version: "5.2", ruby-version: "3.0"}
-          - {activerecord-version: "5.2", ruby-version: "3.1"}
-          - {activerecord-version: "6.0", ruby-version: "3.1"}
-          - {activerecord-version: "7.0", ruby-version: "2.6"}
+        activerecord-version: ["6.0", "6.1", "7.0", "7.0.5"]
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
+        include:
+          - {activerecord-version: "5.2", ruby-version: "2.7"}
     steps:
       - uses: actions/checkout@v3
-      - 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
+      - run: docker-compose run test
+        env:
+          RUBY_VERSION: ${{ matrix.ruby-version }}
+          AR_VERSION: ${{ matrix.activerecord-version }}

data/.rubocop.yml

@@ -10,3 +10,4 @@ AllCops:
   NewCops: enable
   Exclude:
     - 'vendor/**/*'
+  TargetRubyVersion: "2.7"

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ulid-rails CHANGELOG
 
+## Unreleased
+
+## 2.0.0.pre.1
+
+- Drop support for Rails 5.0 and Rails 5.1.
+- Fix various issues when calling `#where` with non-String values, or multiple ULID values.
+
+## 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).

data/README.md

@@ -37,6 +37,8 @@ Specify `id: false` to `create_table` and add `id` column as 16-byte binary type
   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
 
 Just add the below lines to your models.
@@ -110,7 +112,7 @@ You need to specicfy `type` option
 
 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. 
+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:
 
@@ -160,13 +162,9 @@ $ 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
+$ AR_VERSION=6.1 bundle update && AR_VERSION=6.1 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/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

@@ -2,9 +2,9 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "activesupport", "~> 7.0.0"
-gem "activemodel", "~> 7.0.0"
-gem "activerecord", "~> 7.0.0"
+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,46 +8,6 @@ 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/postgresql_type.rb

@@ -0,0 +1,39 @@
+require_relative "type"
+
+module ULID
+  module Rails
+    class PostgresqlType < Type
+      class Data < ULID::Rails::Type::Data
+        def hex
+          hexed = super
+          return nil if hexed.nil?
+          [hexed].pack("H*")
+        end
+
+        alias_method :to_s, :hex
+      end
+
+      # Inspired by active_record/connection_adapters/postgresql/oid/bytea
+      def deserialize(value)
+        case value
+        when nil
+          nil
+        when ULID::Rails::Type::Data
+          super(value.value)
+        else
+          super(PG::Connection.unescape_bytea(value))
+        end
+      end
+
+      private
+
+      def cast_string_to_ulid(value)
+        if value.is_a?(String) && value.length == 34 && value.start_with?("\\x")
+          Data.from_serialized(value[2..])
+        else
+          super(value, data_class: PostgresqlType::Data)
+        end
+      end
+    end
+  end
+end

data/lib/ulid/rails/sqlite_type.rb

@@ -0,0 +1,21 @@
+require_relative "type"
+
+module ULID
+  module Rails
+    class SqliteType < Type
+      class Data < ULID::Rails::Type::Data
+        alias_method :to_s, :hex
+      end
+
+      private
+
+      def cast_string_to_ulid(value)
+        if value.is_a?(String) && value.length == 32
+          Data.from_serialized(value)
+        else
+          super(value, data_class: SqliteType::Data)
+        end
+      end
+    end
+  end
+end

data/lib/ulid/rails/type.rb

@@ -1,53 +1,78 @@
 require "active_model/type"
-require "ulid/rails/formatter"
-require "ulid/rails/validator"
+require "base32/crockford"
 require "ulid/rails/errors"
 
 module ULID
   module Rails
     class Type < ActiveModel::Type::Binary
-      class Data < ActiveModel::Type::Binary::Data
-        alias_method :hex, :to_s
+      def assert_valid_value(value)
+        raise ArgumentError, "`#{value}` is not a ULID format" unless Data.valid_ulid?(value)
       end
 
-      def initialize(formatter = Formatter, validator = Validator)
-        @formatter = formatter
-        @validator = validator
-        super()
+      def cast(value)
+        return nil if value.nil?
+
+        str = value.is_a?(Data) ? value.value : value
+
+        cast_string_to_ulid(str).value
       end
 
-      def assert_valid_value(value)
-        raise ArgumentError, "`#{value}` is not a ULID format" unless @validator.is_valid?(value)
+      def serialize(value)
+        return value if value.is_a?(Data)
+        return Data.null unless value.is_a?(String)
+
+        cast_string_to_ulid(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
+        super
       end
 
-      def serialize(value)
-        return if value.nil?
+      private
 
-        case adapter
-        when "mysql2", "sqlite3"
-          Data.new(@formatter.unformat(value))
-        when "postgresql"
-          Data.new([@formatter.unformat(value)].pack("H*"))
+      def cast_string_to_ulid(value, data_class: Data)
+        raise ArgumentError if !value.is_a?(String)
+
+        if data_class.valid_ulid?(value)
+          data_class.new(value)
+        else
+          data = value.unpack1("H*")
+          data_class.from_serialized(data)
         end
       end
 
-      private
+      class Data < ActiveModel::Type::Binary::Data
+        def self.null
+          new(nil)
+        end
 
-      def adapter
-        if ::ActiveRecord::Base.respond_to?(:connection_db_config)
-          ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter]
-        else
-          ::ActiveRecord::Base.connection_config[:adapter]
+        def self.from_serialized(data)
+          deserialized = Base32::Crockford.encode(data.hex).rjust(26, "0")
+          new(deserialized)
+        end
+
+        def self.valid_ulid?(str)
+          return true if str.nil?
+
+          str.length == 26 && Base32::Crockford.valid?(str)
+        end
+
+        def initialize(value)
+          @value = nil
+          super if self.class.valid_ulid?(value)
+        end
+
+        attr_reader :value
+
+        def hex
+          return nil if @value.nil?
+
+          hexed = Base32::Crockford.decode(@value).to_s(16).rjust(32, "0")
+          raise ArgumentError if hexed.length > 32
+
+          hexed
         end
       end
     end

data/lib/ulid/rails/version.rb

@@ -1,5 +1,5 @@
 module ULID
   module Rails
-    VERSION = "1.1.0"
+    VERSION = "2.0.0.pre.1"
   end
 end

data/lib/ulid/rails.rb

@@ -5,6 +5,8 @@ require "ulid"
 require "base32/crockford"
 require "ulid/rails/version"
 require "ulid/rails/type"
+require "ulid/rails/postgresql_type"
+require "ulid/rails/sqlite_type"
 require "ulid/rails/patch"
 
 module ULID
@@ -13,7 +15,7 @@ module ULID
 
     class_methods do
       def ulid(column_name, auto_generate: false)
-        attribute column_name, ULID::Rails::Type.new
+        attribute column_name, :ulid
 
         if auto_generate
           before_create do
@@ -44,15 +46,10 @@ module ULID
       end
     end
 
-    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
+    ActiveRecord::Type.register(:ulid, ULID::Rails::Type, override: false)
+    ActiveRecord::Type.register(:ulid, ULID::Rails::PostgresqlType, adapter: :postgresql)
+    ActiveRecord::Type.register(:ulid, ULID::Rails::SqliteType, adapter: :sqlite)
+    ActiveRecord::Type.register(:ulid, ULID::Rails::SqliteType, adapter: :sqlite3)
+    ActiveRecord::ConnectionAdapters::TableDefinition.include(Patch::Migrations)
   end
 end

data/ulid-rails.gemspec

@@ -32,10 +32,11 @@ Gem::Specification.new do |spec|
 
   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_dependency "activesupport", ">= 5.2"
+  spec.add_dependency "activemodel", ">= 5.2"
+  spec.add_dependency "activerecord", ">= 5.2"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rubocop-minitest"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ulid-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0.pre.1
 platform: ruby
 authors:
 - Kazunori Kajihiro
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ulid
@@ -45,42 +45,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -174,18 +188,17 @@ files:
 - bin/run_tests
 - bin/setup
 - docker-compose.yml
-- gemfiles/5.0.gemfile
-- gemfiles/5.1.gemfile
 - 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
 - lib/ulid/rails/patch.rb
+- lib/ulid/rails/postgresql_type.rb
+- lib/ulid/rails/sqlite_type.rb
 - lib/ulid/rails/type.rb
-- lib/ulid/rails/validator.rb
 - lib/ulid/rails/version.rb
 - ulid-rails.gemspec
 homepage: https://github.com/k2nr/ulid-rails/
@@ -207,11 +220,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: ULID for rails

data/gemfiles/5.0.gemfile

@@ -1,10 +0,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,10 +0,0 @@
-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/lib/ulid/rails/formatter.rb

@@ -1,16 +0,0 @@
-require "base32/crockford"
-
-module ULID
-  module Rails
-    module Formatter
-      def self.format(v)
-        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
-    end
-  end
-end

data/lib/ulid/rails/validator.rb

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