active_record-json_associations 0.13.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0210b855faca7f7e383b01be2e5e7fb6f78a24770fc5456f6fe6661e3862d2
-  data.tar.gz: 95abf57fc202bb226e8c3dd01c018c489c21ed47c3e00fbd1fc920b0df8f7856
+  metadata.gz: 0425a5d0c7935d72007daa4961178471c58a88dac30522a9137e89923f158dbd
+  data.tar.gz: cfbc21cae4d8655ad0c62c2a73c95715d6207f882e3de6433dc079abc3eff9d9
 SHA512:
-  metadata.gz: d396317afb6cb24bccf06d8f7d9a773f8b76ca65e117d9194230c9378804eeb26f9eb608b26e7240fa0de45e5292f03b6170e544473bfb77621d695a7a0cc887
-  data.tar.gz: 72cc81817ebb6f46f4d82a446f1a17235d60ca701f43300aa23425d2bbd298d5119587ad407eaaf441c74dca0a68aa0d58483b42ef315e064eacb4fe869f8784
+  metadata.gz: 15b8f1ea8aebceea06a143635cfb8242fec793f319196d1af11e90a5dbc77bbc68e43d08ff6e9c893d94f79180bb9d1f11db2bf8c4a6f3048e2c870a9f70cffc
+  data.tar.gz: 2862a70dfb5c0db59dbf30facb73f0c5d810e7c4c00404c5c5eb74daf7aa6c1cacdca86560db5727b1c7e6537f3d0d3bdea2515837c4af0ee3a18b4a5b680fb4

data/.github/workflows/ci.yml

@@ -1,21 +1,57 @@
 name: CI
+
 on: [push, pull_request]
+
 jobs:
   test:
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        gemfile: [ rails_7.0, rails_7.1, rails_7.2 ]
-        ruby: [ 3.1, 3.2, 3.3 ]
-
-    runs-on: ubuntu-latest
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+        ruby: ["3.2", "3.3", "3.4", "4.0"]
+        gemfile:
+          - gemfiles/rails_7.2.gemfile
+          - gemfiles/rails_8.0.gemfile
+          - gemfiles/rails_8.1.gemfile
+        database: [sqlite, postgres, mysql]
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+      mysql:
+        image: mysql:8
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 3306:3306
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-      - run: bundle exec rake
-
+          bundler-cache: true
+      - name: Create test database
+        if: matrix.database == 'postgres'
+        run: PGPASSWORD=postgres createdb -h localhost -U postgres test
+      - name: Create test database
+        if: matrix.database == 'mysql'
+        run: mysql -h 127.0.0.1 -u root -e "CREATE DATABASE test"
+      - name: Run tests
+        run: bundle exec rake
+        env:
+          DATABASE_URL: ${{ matrix.database == 'postgres' && 'postgres://postgres:postgres@localhost:5432/test' || matrix.database == 'mysql' && 'trilogy://root@127.0.0.1:3306/test' || 'sqlite3::memory:' }}

data/Appraisals

@@ -1,13 +1,11 @@
-appraise "rails-7.0" do
-  gem "rails", "~>7.0.0"
-  gem "sqlite3", "~>1.0"
+appraise "rails-7.2" do
+  gem "rails", "~>7.2.0"
 end
 
-appraise "rails-7.1" do
-  gem "rails", "~>7.1.0"
+appraise "rails-8.0" do
+  gem "rails", "~>8.0.0"
 end
 
-appraise "rails-7.2" do
-  gem "rails", "~>7.2.0"
+appraise "rails-8.1" do
+  gem "rails", "~>8.1.0"
 end
-

data/CLAUDE.md

@@ -0,0 +1,38 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## About
+
+ActiveRecord::JsonAssociations is a Ruby gem that provides an alternative to traditional many-to-many join tables by storing foreign keys in a JSON array on the parent record.
+
+## Development Commands
+
+```bash
+# Run all tests
+bundle exec rake
+
+# Run a single spec file
+bundle exec rspec spec/belongs_to_many_spec.rb
+
+# Run a specific test by line number
+bundle exec rspec spec/belongs_to_many_spec.rb:42
+
+# Test against specific Rails versions using Appraisal
+BUNDLE_GEMFILE=gemfiles/rails_7.1.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails_8.0.gemfile bundle exec rake
+```
+
+## Architecture
+
+The gem extends `ActiveRecord::Base` with a single module (`ActiveRecord::JsonAssociations`) that provides two main class methods:
+
+- **`belongs_to_many`** - Stores foreign keys as a JSON array in a text/json column on the parent model. Provides `children`, `children=`, `child_ids`, `child_ids=`, `children?` methods plus a `child_ids_including` scope for querying.
+
+- **`has_many :json_foreign_key`** - The inverse relationship. When a child model uses this option, it can find parents that reference it via their JSON arrays. Also provides `build_parent`, `create_parent`, `create_parent!` builder methods.
+
+Both methods support native JSON columns (using `JSON_CONTAINS`) or text columns (using `LIKE` queries with serialized JSON).
+
+## Testing
+
+Tests use RSpec with an in-memory SQLite database. Each spec file sets up its own schema and model classes. Use `focus: true` on individual specs during development.

data/README.md

@@ -1,7 +1,6 @@
 # ActiveRecord::JsonAssociations
 
 [![CI Status](https://github.com/botandrose/active_record-json_associations/actions/workflows/ci.yml/badge.svg)](https://github.com/botandrose/active_record-json_associations/actions/workflows/ci.yml)
-[![Code Climate](https://codeclimate.com/github/botandrose/active_record-json_associations/badges/gpa.svg)](https://codeclimate.com/github/botandrose/active_record-json_associations)
 
 Instead of keeping the foreign keys on the children, or in a many-to-many join table, let's keep them in a JSON array on the parent.
 
@@ -12,7 +11,7 @@ require "active_record/json_associations"
 
 ActiveRecord::Schema.define do
   create_table :parents do |t|
-    t.text :child_ids
+    t.json :child_ids, default: []
   end
 
   create_table :children
@@ -23,6 +22,8 @@ class Parent < ActiveRecord::Base
 end
 ```
 
+**Note:** The `child_ids` column must be a native JSON type. Text columns are not supported.
+
 This will add some familiar `has_many`-style methods:
 
 ```ruby
@@ -37,16 +38,16 @@ parent.child_ids #=> [1,2]
 parent.children? #=> true
 ```
 
-And a scope method for finding records assocatied with an id:
+And a scope method for finding records associated with an id:
 
 ```ruby
 Parent.child_ids_including(2) # => [<Parent child_ids: [1,2,3]>]
 ```
 
-Or any of specified array of ids:
+Or any of a specified array of ids:
 
 ```ruby
-Parent.child_ids_including([2,4,5]) # => [<Parent child_ids: [1,2,3]>]
+Parent.child_ids_including(any: [2,4,5]) # => [<Parent child_ids: [1,2,3]>]
 ```
 
 `touch: true` can be specified on belongs_to_many to touch the associated records' timestamps when the record is modified.
@@ -77,7 +78,9 @@ child.build_parent(name: "Momma")
 
 ## Requirements
 
-* ActiveRecord 5.0+
+* Ruby 3.2+
+* ActiveRecord 7.2+
+* Database with JSON column support (MySQL, PostgreSQL, SQLite 3.9+)
 
 ## Contributing
 

data/active_record-json_associations.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Instead of a many-to-many join table, serialize the ids into a JSON array.}
   spec.homepage      = "https://github.com/botandrose/active_record-json_associations"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.2"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -25,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "trilogy"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "timecop"
 end

data/gemfiles/{rails_7.1.gemfile → rails_8.0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~>7.1.0"
+gem "rails", "~>8.0.0"
 
 gemspec path: "../"

data/gemfiles/{rails_7.0.gemfile → rails_8.1.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~>7.0.0"
-gem "sqlite3", "~>1.0"
+gem "rails", "~>8.1.0"
 
 gemspec path: "../"

data/lib/active_record/json_associations/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module JsonAssociations
-    VERSION = "0.13.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/active_record/json_associations.rb

@@ -1,18 +1,44 @@
+# frozen_string_literal: true
+
 require "active_record"
 require "json"
 
 module ActiveRecord
   module JsonAssociations
+    ORDER_BY_IDS_PROC = proc do |scope, ids|
+      if ids.empty?
+        scope
+      else
+        pk = scope.klass.primary_key
+        quoted_ids = ids.map { |id| scope.connection.quote(id) }
+        order_sql = case scope.connection.adapter_name
+        when "Mysql2", "Trilogy"
+          "FIELD(#{pk}, #{quoted_ids.join(",")})"
+        when "PostgreSQL"
+          "array_position(ARRAY[#{quoted_ids.join(",")}], #{pk})"
+        else
+          fragments = ids.each_with_index.map { |id, i| "WHEN #{quoted_ids[i]} THEN #{i}" }
+          "CASE #{pk} #{fragments.join(" ")} END"
+        end
+        scope.order!(Arel.sql(order_sql))
+      end
+    end
+    private_constant :ORDER_BY_IDS_PROC
+
     FIELD_INCLUDE_SCOPE_BUILDER_PROC = proc do |context, field, id|
-      using_json = context.columns_hash[field.to_s].type == :json
+      unless context.columns_hash[field.to_s].type == :json
+        raise ArgumentError, "#{field} column must be of type :json"
+      end
+
+      sanitized_id = id.to_i
 
-      if using_json
-        context.where("JSON_CONTAINS(#{field}, ?, '$')", id.to_json)
+      case context.connection.adapter_name
+      when "Mysql2", "Trilogy"
+        context.where("JSON_CONTAINS(#{field}, ?, '$')", sanitized_id.to_json)
+      when "PostgreSQL"
+        context.where("#{field}::jsonb @> ?::jsonb", [sanitized_id].to_json)
       else
-        context.where("#{field}='[#{id}]'").or(
-          context.where("#{field} LIKE '[#{id},%'")).or(
-            context.where("#{field} LIKE '%,#{id},%'")).or(
-              context.where("#{field} LIKE '%,#{id}]'"))
+        context.where("EXISTS (SELECT 1 FROM json_each(#{field}) WHERE value = ?)", sanitized_id)
       end
     end
     private_constant :FIELD_INCLUDE_SCOPE_BUILDER_PROC
@@ -26,34 +52,16 @@ module ActiveRecord
 
       class_name ||= one.classify
 
-      using_json = columns_hash[one_ids.to_s].type == :json
-
-      if !using_json
-        if ActiveRecord.version >= Gem::Version.new("7.1")
-          serialize one_ids, coder: JSON
-        else
-          serialize one_ids, JSON
-        end
+      unless columns_hash[one_ids.to_s].type == :json
+        raise ArgumentError, "#{one_ids} column must be of type :json"
       end
 
       if touch
         after_commit do
           unless no_touching?
-            method = respond_to?(:saved_changes) ? :saved_changes : :previous_changes
-            old_ids, new_ids = send(method)[one_ids.to_s]
+            old_ids, new_ids = saved_changes[one_ids.to_s]
             ids = Array(send(one_ids)) | Array(old_ids) | Array(new_ids)
-            scope = class_name.constantize.where(self.class.primary_key => ids)
-
-            if scope.respond_to?(:touch) # AR 6.0+
-              scope.touch_all
-            elsif self.class.respond_to?(:touch_attributes_with_time) # AR 5.1+
-              scope.update_all self.class.touch_attributes_with_time
-            else # AR 5.0
-              attributes = timestamp_attributes_for_update_in_model.inject({}) do |attributes, key|
-                attributes.merge(key => current_time_from_proper_timezone)
-              end
-              scope.update_all attributes
-            end
+            class_name.constantize.where(self.class.primary_key => ids).touch_all
           end
         end
       end
@@ -84,16 +92,9 @@ module ActiveRecord
 
         define_method many do
           klass = class_name.constantize
-          scope = klass.all
-
-          ids = send(one_ids)
-          scope.where!(klass.primary_key => ids)
-
-          fragments = []
-          fragments += ["#{klass.primary_key} NOT IN (#{ids.map(&:to_s).join(",")})"] if ids.any?
-          fragments += ids.reverse.map { |id| "#{klass.primary_key}=#{id}" }
-          order_by_ids = fragments.join(", ")
-          scope.order!(Arel.sql(order_by_ids))
+          ids = send(one_ids).map(&:to_i)
+          scope = klass.where(klass.primary_key => ids)
+          ORDER_BY_IDS_PROC.call(scope, ids)
         end
 
         define_method many_equals do |collection|
@@ -126,30 +127,43 @@ module ActiveRecord
       create_one_bang = :"create_#{one}!"
 
       class_name = options[:class_name] || one.classify
-      klass = class_name.constantize
 
       foreign_key = options[:json_foreign_key]
       foreign_key = :"#{model_name.singular}_ids" if foreign_key == true
 
+      pending_associations_var = :"@pending_#{many}"
+
+      after_create do
+        if (pending = instance_variable_get(pending_associations_var))
+          instance_variable_set(pending_associations_var, nil)
+          send(many_equals, pending)
+        end
+      end
+
       include Module.new {
         define_method one_ids do
           send(many).pluck(:id)
         end
 
         define_method one_ids_equals do |ids|
+          klass = class_name.constantize
           normalized_ids = Array(ids).select(&:present?).map(&:to_i).uniq
           send many_equals, klass.find(normalized_ids)
         end
 
         define_method many do
+          klass = class_name.constantize
           FIELD_INCLUDE_SCOPE_BUILDER_PROC.call(klass, foreign_key, id)
         end
 
         define_method many_equals do |collection|
-          collection.each do |record|
-            new_id_array = Array(record.send(foreign_key)) | [id]
-            raise "FIXME: Cannot assign during creation, because no id has yet been reified." if new_id_array.any?(&:nil?)
-            record.update foreign_key => new_id_array
+          if new_record?
+            instance_variable_set(pending_associations_var, collection)
+          else
+            collection.each do |record|
+              new_id_array = Array(record.send(foreign_key)) | [id]
+              record.update foreign_key => new_id_array
+            end
           end
         end
 
@@ -158,14 +172,17 @@ module ActiveRecord
         end
 
         define_method build_one do |attributes={}|
+          klass = class_name.constantize
           klass.new attributes.merge!(foreign_key => [id])
         end
 
         define_method create_one do |attributes={}|
+          klass = class_name.constantize
           klass.create attributes.merge!(foreign_key => [id])
         end
 
         define_method create_one_bang do |attributes={}|
+          klass = class_name.constantize
           klass.create! attributes.merge!(foreign_key => [id])
         end
       }

data/spec/belongs_to_many_spec.rb

@@ -2,23 +2,22 @@ require "active_record/json_associations"
 
 describe ActiveRecord::JsonAssociations do
   before do
-    ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+    ActiveRecord::Base.establish_connection database_config
 
     silence_stream(STDOUT) do
       ActiveRecord::Schema.define do
-        create_table :parents do |t|
+        create_table :parents, force: true do |t|
           t.string :name
-          t.text :child_ids
-          t.text :fuzzy_ids
-          t.json :dependent_types_and_ids
+          t.json :child_ids
+          t.json :fuzzy_ids
           t.timestamps
         end
 
-        create_table :children do |t|
+        create_table :children, force: true do |t|
           t.timestamps
         end
 
-        create_table :pets do |t|
+        create_table :pets, force: true do |t|
           t.timestamps
         end
       end

data/spec/has_many_spec.rb

@@ -2,22 +2,22 @@ require "active_record/json_associations"
 
 describe ActiveRecord::JsonAssociations do
   before do
-    ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+    ActiveRecord::Base.establish_connection database_config
 
     silence_stream(STDOUT) do
       ActiveRecord::Schema.define do
-        create_table :parents do |t|
+        create_table :parents, force: true do |t|
           t.string :name
-          t.text :child_ids
-          t.text :fuzzy_ids
+          t.json :child_ids
+          t.json :fuzzy_ids
           t.timestamps
         end
 
-        create_table :children do |t|
+        create_table :children, force: true do |t|
           t.timestamps
         end
 
-        create_table :pets do |t|
+        create_table :pets, force: true do |t|
           t.timestamps
         end
       end
@@ -87,6 +87,14 @@ describe ActiveRecord::JsonAssociations do
         expect(subject.parents).to eq parents
       end
 
+      it "defers assignment until after create for new records" do
+        child = Child.new
+        child.parents = parents
+        expect(parents.map { |p| p.reload.child_ids }).to eq [[], [], []]
+        child.save!
+        expect(parents.map { |p| p.reload.child_ids }).to eq [[child.id], [child.id], [child.id]]
+      end
+
       context "finds records with the specified id" do
         let(:child) { Child.create! }
 

data/spec/spec_helper.rb

@@ -1,6 +1,14 @@
 require "byebug"
 require "timecop"
 
+def database_config
+  if ENV["DATABASE_URL"]
+    { url: ENV["DATABASE_URL"] }
+  else
+    { adapter: "sqlite3", database: ":memory:" }
+  end
+end
+
 RSpec.configure do |config|
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-json_associations
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Micah Geisel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-15 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: trilogy
+  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: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -134,15 +162,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - Appraisals
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_record-json_associations.gemspec
 - bin/setup
-- gemfiles/rails_7.0.gemfile
-- gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
 - lib/active_record/json_associations.rb
 - lib/active_record/json_associations/version.rb
 - spec/belongs_to_many_spec.rb
@@ -152,7 +181,7 @@ homepage: https://github.com/botandrose/active_record-json_associations
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -168,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Instead of a many-to-many join table, serialize the ids into a JSON array.
 test_files: