activerecord-ulid 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95a1ca6f4a8d8a906d219f5cfe27be3c0d2d8d939d901b81b0e6f316255c011
-  data.tar.gz: c5a04ae60b9d63fb49afda113b87be459d78d68478c4d2d11cd20c2224d00493
+  metadata.gz: 06673f10a49138758408e9726a955f0f36a593e957ddb7dd39ef45a6f1cd0c75
+  data.tar.gz: 2aafcce35ba85952f3fb6dc07e066415b042eecbedfc2d5ec90350b59332cba8
 SHA512:
-  metadata.gz: 8f72ad7d083e3397ea3afa71ef7d1b8cb441b59092b1b98d9aeec9d88fb4e8c5225634e3882ae6351d83edf266be2638a300bd0b748d6063f9955d620624790e
-  data.tar.gz: 240bb28a734d7352d81b4d41174458abca0121d4fd6ea0aad01b7706914eff01b58847515ef2071a0c35161194f9f25247bd40d24e246c0002360a0fac11517b
+  metadata.gz: 730788e32883f470e99bad3e4cc406e21369a9a47300404cab39d5f59046c9945b6522f19b4ac12b48f1d2e5367e03936f33c84226e58d55ecb0fd9ae9941b1e
+  data.tar.gz: 3646d1a6ca3d5245855d996b969b3f0c1956ccfc83211460f0e8754c3014c916e0bac74618ac3abe17f7221ff514f84d679b24c1519989b1787de0056d2845d3

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.2.0
+
+- Requires Ruby 4.0+ and Active Record 8.1+.
+- `ULIDAttribute` is now `ActiveRecordULID::Type`; the gem no longer defines a top-level constant.
+- Generate each record's ULID through a per-record attribute default. Rails main freezes a model's default attributes at
+  schema load, which cast `nil` once and handed every new record the same ULID.
+- Persist prefixed ULID columns when `partial_inserts` is enabled; they used to be skipped as unchanged and read back as
+  a new random value.
+- `initial: false` without `nullable: true` no longer raises on `nil`.
+- An explicit `default:` on a `:ulid` attribute is kept as given.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Abdelkader Boudih
+
+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,55 @@
+# activerecord-ulid
+
+A `:ulid` attribute type for Active Record. Every record gets its own
+[ULID](https://github.com/ulid/spec) the moment it's built: sortable, unique,
+and readable in a URL.
+
+Requires Ruby 4.0+ and Active Record 8.1+.
+
+## Installation
+
+```ruby
+gem "activerecord-ulid"
+```
+
+## Usage
+
+ULIDs live in string columns:
+
+```ruby
+create_table :users, id: :string do |t|
+  t.string :invite_code
+end
+
+class User < ApplicationRecord
+  attribute :id, :ulid
+end
+
+User.new.id # => "01JBQ8Z3X4M6V2N9R7T5K1W0HD"
+```
+
+Prefix them, Stripe style:
+
+```ruby
+attribute :id, :ulid, prefix: "usr_" # => "usr_01JBQ8Z3X4M6V2N9R7T5K1W0HD"
+```
+
+Options:
+
+- `prefix:` prepended to the ULID.
+- `nullable: true` (or `initial: false`) leaves `nil` alone: no ULID is generated.
+- `default:` given explicitly wins over the generated ULID.
+
+Assigning `nil` to a generating attribute gives it a fresh ULID.
+
+## Development
+
+```console
+$ bundle exec rake test                 # padded_cell, Rails 8.1
+$ RAILS_VERSION=edge bundle exec rake   # Rails main
+$ dictator lint .
+```
+
+## License
+
+MIT. See [LICENSE.txt](LICENSE.txt).

data/lib/activerecord/ulid/attribute_default.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveRecordULID
+  # Rails casts a model's default attributes once and shares them, so a ULID
+  # generated by the type would be the same for every record. A :ulid attribute
+  # without an explicit default gets one that generates per record instead.
+  module AttributeDefault
+    def attribute(name, type = nil, **options)
+      type = resolve_type_name(type, **options.except(:default)) if type == :ulid
+      if type.is_a?(Type) && type.generates_default? && !options.key?(:default)
+        options[:default] = -> { type.generate }
+      end
+
+      super
+    end
+  end
+end

data/lib/activerecord/ulid/type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveRecordULID
+  # The :ulid attribute type: a string column holding a ULID, optionally prefixed.
+  # A nil value becomes a fresh ULID unless the attribute is nullable or opted out
+  # with initial: false.
+  class Type < ActiveRecord::Type::String
+    attr_reader :prefix, :nullable, :initial
+
+    def initialize(prefix: nil, nullable: false, initial: true, **)
+      @prefix = prefix
+      @nullable = nullable
+      @initial = initial
+      super(**)
+    end
+
+    def generate
+      "#{prefix}#{ULID.generate}"
+    end
+
+    def generates_default?
+      initial && !nullable
+    end
+
+    def cast(value)
+      return value unless value.nil?
+
+      generate if generates_default?
+    end
+  end
+end

data/lib/activerecord/ulid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordULID
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/activerecord/ulid.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "ulid/version"
 require "active_record"
 require "ulid"
 
-require_relative "ulid/ulid_attribute"
-ActiveRecord::Type.register(:ulid, ULIDAttribute)
+require_relative "ulid/version"
+require_relative "ulid/type"
+require_relative "ulid/attribute_default"
+
+ActiveRecord::Type.register(:ulid, ActiveRecordULID::Type)
+ActiveSupport.on_load(:active_record) { singleton_class.prepend(ActiveRecordULID::AttributeDefault) }

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-ulid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,47 +15,51 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: ulid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ''
+        version: '1.4'
+description: 'A :ulid attribute type for Active Record: every record gets its own
+  ULID, optionally prefixed, generated when the record is built.'
 email:
 - terminale@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - lib/activerecord-ulid.rb
 - lib/activerecord/ulid.rb
-- lib/activerecord/ulid/ulid_attribute.rb
+- lib/activerecord/ulid/attribute_default.rb
+- lib/activerecord/ulid/type.rb
 - lib/activerecord/ulid/version.rb
 homepage: https://github.com/seuros/activerecord-ulid
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/seuros/activerecord-ulid
   source_code_uri: https://github.com/seuros/activerecord-ulid
   changelog_uri: https://github.com/seuros/activerecord-ulid/blob/master/CHANGELOG.md
-post_install_message: 
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -64,15 +67,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Add ULID support to ActiveRecord
 test_files: []

data/lib/activerecord/ulid/ulid_attribute.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-class ULIDAttribute < ActiveRecord::Type::String
-  attr_reader :prefix,
-              :nullable,
-              :initial
-
-  def initialize(precision: nil, limit: nil, scale: nil, prefix: nil, nullable: false, initial: true)
-    @prefix = prefix
-    @initial = initial
-    @nullable = nullable
-    super()
-  end
-
-  def cast(value)
-    return value if value.present?
-    return if value.nil? && nullable
-
-    value = ULID.generate if value.nil? && initial
-    return value if value.empty?
-
-    [prefix, value].compact.join
-  end
-end