active_record-json_associations 0.6.10 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fca3b8622a2b4f80748fd6e8b1055736849ea5e8
-  data.tar.gz: 91ff667adef8880708685356ac43621f0c4338db
+SHA256:
+  metadata.gz: 3dcecc3d5ba41f7deed96e8178f04221c39678799e3706b0c95938f91f197daf
+  data.tar.gz: c9fcdad4e8cbe19a16fc7bf3d27c8e176e5cedb06a415e95c36aff1b734ffb85
 SHA512:
-  metadata.gz: 6ddd2a924f4e593b3e6f63d38619d41a7495c7b74fce5d1490c85f6f11be7d9f7180efe15b6191eab095ebeaaac72785907c47218b392b47e5bc852c612b1446
-  data.tar.gz: 8ee31eeeb4a56263aed118c8999b89771b574050172e37dd77bac01efb996683a0ca67ce3f113958b355e19ee9352a03ed07fce6533f970d39fc5de0083342e6
+  metadata.gz: a13fc51a526b61d909d6559e22969a9e4f7c75e880efc2ffc50b0c01e1b2aa7daf4858c33beb0dfbac7a57aa77329fd030af02db02efcb7058b8b78f93386328
+  data.tar.gz: e6d33f695da6f13a6ed3253ab90a0246e77a788f7593b3d1338ec8e11d6e449b4f294a8c690f5f4f2f506fb10478c3494e198fba7275d50b8d3f72f38e0d1485

data/.gitignore

@@ -6,6 +6,7 @@
 .ruby-version
 .ruby-gemset
 Gemfile.lock
+gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -1,6 +1,18 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.3.3
-  - 2.4.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+gemfile:
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile
+jobs:
+  exclude:
+    - rvm: 2.4
+      gemfile: gemfiles/rails_6.0.gemfile
+before_install:
+  - gem install bundler -v"~>1.17"
 

data/Appraisals

@@ -0,0 +1,21 @@
+appraise "rails-5.0" do
+  gem "rails", "~>5.0.0"
+  gem "sqlite3", "~>1.3.13" # 1.4 seems to break rails 5.0?
+end
+
+appraise "rails-5.1" do
+  gem "rails", "~>5.1.0"
+end
+
+appraise "rails-5.2" do
+  gem "rails", "~>5.2.0"
+end
+
+appraise "rails-6.0" do
+  gem "rails", "~>6.0.0"
+end
+
+appraise "rails-6.1" do
+  gem "rails", "~>6.1.0"
+end
+

data/README.md

@@ -37,6 +37,20 @@ parent.child_ids #=> [1,2]
 parent.children? #=> true
 ```
 
+And a scope method for finding records assocatied with an id:
+
+```ruby
+Parent.child_ids_including(2) # => [<Parent child_ids: [1,2,3]>]
+```
+
+Or any of specified array of ids:
+
+```ruby
+Parent.child_ids_including([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.
+
 It also adds an `json_foreign_key` option to `has_many` for specifying that the foreign keys are in a json array.
 
 ```ruby
@@ -49,6 +63,18 @@ parent = Parent.create children: [child]
 child.parents == [parent] #=> true
 ```
 
+I can't figure out how to support building records off the association, so instead there are the `has_one`/`belongs_to` builder methods:
+
+```ruby
+child.build_parent
+child.create_parent
+child.create_parent!
+
+# also supports optional attributes:
+
+child.build_parent(name: "Momma")
+```
+
 ## Requirements
 
 * ActiveRecord 5.0+

data/active_record-json_associations.gemspec

@@ -20,10 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activerecord"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "timecop"
 end
 

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~>5.0.0"
+gem "sqlite3", "~>1.3.13"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~>5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~>5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~>6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~>6.1.0"
+
+gemspec path: "../"

data/lib/active_record/json_associations.rb

@@ -3,7 +3,15 @@ require "json"
 
 module ActiveRecord
   module JsonAssociations
-    def belongs_to_many(many, class_name: nil)
+    FIELD_INCLUDE_SCOPE_BUILDER_PROC = proc do |context, field, id|
+      context.where("#{field}='[#{id}]'").or(
+        context.where("#{field} LIKE '[#{id},%'")).or(
+          context.where("#{field} LIKE '%,#{id},%'")).or(
+            context.where("#{field} LIKE '%,#{id}]'"))
+    end
+    private_constant :FIELD_INCLUDE_SCOPE_BUILDER_PROC
+
+    def belongs_to_many(many, class_name: nil, touch: nil)
       one = many.to_s.singularize
       one_ids = :"#{one}_ids"
       one_ids_equals = :"#{one_ids}="
@@ -14,6 +22,39 @@ module ActiveRecord
 
       serialize one_ids, JSON
 
+      if touch
+        after_commit do
+          method = respond_to?(:saved_changes) ? :saved_changes : :previous_changes
+          old_ids, new_ids = send(method)[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
+        end
+      end
+
+      extend Module.new {
+        define_method :"#{one_ids}_including" do |id|
+          raise "can't query for a record that does not have an id!" if id.blank?
+          if id.is_a?(Hash)
+            Array(id[:any]).inject(none) do |context, id|
+              context.or(FIELD_INCLUDE_SCOPE_BUILDER_PROC.call(self, one_ids, id))
+            end
+          else
+            FIELD_INCLUDE_SCOPE_BUILDER_PROC.call(self, one_ids, id)
+          end
+        end
+      }
+
       include Module.new {
         define_method one_ids do
           super().tap do |value|
@@ -49,7 +90,7 @@ module ActiveRecord
       }
     end
 
-    def has_many many, scope = nil, options = {}, &extension
+    def has_many many, scope = nil, **options, &extension
       unless (scope.is_a?(Hash) && scope[:json_foreign_key]) || (options.is_a?(Hash) && options[:json_foreign_key])
         return super
       end
@@ -64,8 +105,12 @@ module ActiveRecord
       one_ids_equals = :"#{one_ids}="
       many_equals = :"#{many}="
       many_eh = :"#{many}?"
+      build_one = :"build_#{one}"
+      create_one = :"create_#{one}"
+      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
@@ -76,17 +121,12 @@ module ActiveRecord
         end
 
         define_method one_ids_equals do |ids|
-          klass = class_name.constantize
           normalized_ids = Array(ids).select(&:present?).map(&:to_i)
           send many_equals, klass.find(normalized_ids)
         end
 
         define_method many do
-          klass = class_name.constantize
-          klass.where("#{foreign_key} LIKE '[#{id}]'").or(
-            klass.where("#{foreign_key} LIKE '[#{id},%'")).or(
-            klass.where("#{foreign_key} LIKE '%,#{id},%'")).or(
-            klass.where("#{foreign_key} LIKE '%,#{id}]'"))
+          FIELD_INCLUDE_SCOPE_BUILDER_PROC.call(klass, foreign_key, id)
         end
 
         define_method many_equals do |collection|
@@ -100,6 +140,18 @@ module ActiveRecord
         define_method many_eh do
           send(many).any?
         end
+
+        define_method build_one do |attributes={}|
+          klass.new attributes.merge!(foreign_key => [id])
+        end
+
+        define_method create_one do |attributes={}|
+          klass.create attributes.merge!(foreign_key => [id])
+        end
+
+        define_method create_one_bang do |attributes={}|
+          klass.create! attributes.merge!(foreign_key => [id])
+        end
       }
     end
   end

data/lib/active_record/json_associations/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module JsonAssociations
-    VERSION = "0.6.10"
+    VERSION = "0.10.0"
   end
 end

data/spec/json_associations_spec.rb

@@ -7,18 +7,24 @@ describe ActiveRecord::JsonAssociations do
     silence_stream(STDOUT) do
       ActiveRecord::Schema.define do
         create_table :parents do |t|
+          t.string :name
           t.text :child_ids
           t.text :fuzzy_ids
+          t.timestamps
         end
 
-        create_table :children
+        create_table :children do |t|
+          t.timestamps
+        end
 
-        create_table :pets
+        create_table :pets do |t|
+          t.timestamps
+        end
       end
     end
 
     class Parent < ActiveRecord::Base
-      belongs_to_many :children
+      belongs_to_many :children, touch: true
       belongs_to_many :fuzzies, class_name: "Pet"
     end
 
@@ -38,6 +44,148 @@ describe ActiveRecord::JsonAssociations do
  
   describe ".belongs_to_many :children" do
     subject { Parent.new }
+    let!(:winner) { Parent.create! }
+
+    describe ".child_ids_including" do
+      context "finds records with the specified id" do
+        let(:child) { Child.create! }
+
+        it "as the whole json array" do
+          parent = Parent.create(children: [child])
+          expect(Parent.child_ids_including(child.id)).to eq [parent]
+        end
+
+        it "at the beginning of the json array" do
+          parent = Parent.create(children: [child, Child.create!])
+          expect(Parent.child_ids_including(child.id)).to eq [parent]
+        end
+
+        it "in the middle of the json array" do
+          parent = Parent.create(children: [Child.create!, child, Child.create!])
+          expect(Parent.child_ids_including(child.id)).to eq [parent]
+        end
+
+        it "at the end of the json array" do
+          parent = Parent.create(children: [Child.create!, child])
+          expect(Parent.child_ids_including(child.id)).to eq [parent]
+        end
+      end
+
+      context "finds records including any of the specified array of ids" do
+        let(:peter) { Child.create! }
+        let(:paul) { Child.create! }
+
+        it "both as the whole json array" do
+          parent = Parent.create(children: [peter, paul])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "one as the whole json array" do
+          parent = Parent.create(children: [peter])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "the other as the whole json array" do
+          parent = Parent.create(children: [paul])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "both at the beginning of the json array" do
+          parent = Parent.create(children: [peter, paul, Child.create!])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "one at the beginning of the json array" do
+          parent = Parent.create(children: [peter, Child.create!])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "the other at the beginning of the json array" do
+          parent = Parent.create(children: [paul, Child.create!])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "both in the middle of the json array" do
+          parent = Parent.create(children: [Child.create!, peter, paul, Child.create!])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "one in the middle of the json array" do
+          parent = Parent.create(children: [Child.create!, peter, Child.create!])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "the other in the middle of the json array" do
+          parent = Parent.create(children: [Child.create!, paul, Child.create!])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "both at the end of the json array" do
+          parent = Parent.create(children: [Child.create!, peter, paul])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "one at the end of the json array" do
+          parent = Parent.create(children: [Child.create!, peter])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+
+        it "the other at the end of the json array" do
+          parent = Parent.create(children: [Child.create!, paul])
+          expect(Parent.child_ids_including(any: [peter.id, paul.id])).to eq [parent]
+        end
+      end
+    end
+
+    describe "touch: true" do
+      around do |example|
+        old_zone = Time.zone
+        Time.zone = "UTC"
+        example.run
+        Time.zone = old_zone
+      end
+
+      let(:old_time) { 1.year.ago.round }
+      let(:new_time) { 1.second.ago.round }
+
+      around do |example|
+        Timecop.freeze(new_time) do
+          example.run
+        end
+      end
+
+      it "touches records associated upon creation" do
+        children = [Child.create!(updated_at: old_time), Child.create!(updated_at: old_time)]
+        fuzzies = [Pet.create!(updated_at: old_time), Pet.create!(updated_at: old_time)]
+        parent = Parent.create!(children: children, fuzzies: fuzzies)
+        expect(children.each(&:reload).map(&:updated_at)).to eq [new_time, new_time] # touch: true
+        expect(fuzzies.each(&:reload).map(&:updated_at)).to eq [old_time, old_time] # touch: nil
+      end
+
+      it "touches exising association records" do
+        children = [Child.create!, Child.create!]
+        parent = Parent.create!(children: children)
+        children.each { |child| child.update!(updated_at: old_time) }
+        parent.save!
+        expect(children.each(&:reload).map(&:updated_at)).to eq [new_time, new_time]
+      end
+
+      it "touches removed associated records" do
+        peter, paul, mary = Child.create!, Child.create!, Child.create!
+        parent = Parent.create!(children: [peter, paul, mary])
+        [peter, paul, mary].each { |child| child.update_column :updated_at, old_time }
+        parent.update!(children: [peter, paul])
+        expect([peter, paul, mary].each(&:reload).map(&:updated_at)).to eq [new_time, new_time, new_time]
+      end
+
+      it "touches added associated records" do
+        peter, paul, mary = Child.create!, Child.create!, Child.create!
+        parent = Parent.create!(children: [peter, paul])
+        [peter, paul, mary].each { |child| child.update_column :updated_at, old_time }
+        parent.update!(children: [peter, paul, mary])
+        expect([peter, paul, mary].each(&:reload).map(&:updated_at)).to eq [new_time, new_time, new_time]
+      end
+    end
 
     describe "#child_ids" do
       it "is empty by default" do
@@ -199,6 +347,67 @@ describe ActiveRecord::JsonAssociations do
         expect(subject.parents?).to be_truthy
       end
     end
+
+    describe "#build_parent" do
+      it "doesnt save the record" do
+        parent = subject.build_parent
+        expect(parent).to be_new_record
+      end
+
+      it "sets the foreign key column" do
+        parent = subject.build_parent
+        expect(parent.children).to eq([subject])
+      end
+
+      it "passes attributes through" do
+        parent = subject.build_parent(name: "Parent")
+        expect(parent.name).to eq("Parent")
+      end
+    end
+
+    describe "#create_parent" do
+      it "saves the record" do
+        parent = subject.create_parent
+        expect(parent).to be_persisted
+      end
+
+      it "sets the foreign key column" do
+        parent = subject.create_parent
+        expect(parent.children).to eq([subject])
+      end
+
+      it "passes attributes through" do
+        parent = subject.create_parent(name: "Parent")
+        expect(parent.name).to eq("Parent")
+      end
+
+      it "calls create on the model" do
+        expect(Parent).to receive(:create)
+        subject.create_parent
+      end
+    end
+
+    describe "#create_parent!" do
+      it "saves the record" do
+        parent = subject.create_parent!
+        expect(parent).to be_persisted
+      end
+
+      it "sets the foreign key column" do
+        parent = subject.create_parent!
+        expect(parent.children).to eq([subject])
+      end
+
+      it "passes attributes through" do
+        parent = subject.create_parent!(name: "Parent")
+        expect(parent.name).to eq("Parent")
+      end
+
+      it "calls create! on the model" do
+        expect(Parent).to receive(:create!)
+        subject.create_parent!
+      end
+    end
   end
 
   describe ".has_many :parents, json_foreign_key: :fuzzy_ids" do

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "byebug"
+require "timecop"
 
 RSpec.configure do |config|
   config.filter_run focus: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-json_associations
 version: !ruby/object:Gem::Version
-  version: 0.6.10
+  version: 0.10.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,16 +28,30 @@ dependencies:
   name: bundler
   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: '1.6'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,21 +108,43 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
 description: Instead of a many-to-many join table, serialize the ids into a JSON array.
 email:
 - micah@botandrose.com
-executables: []
+executables:
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_record-json_associations.gemspec
+- bin/setup
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
 - lib/active_record/json_associations.rb
 - lib/active_record/json_associations/version.rb
 - spec/json_associations_spec.rb
@@ -132,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Instead of a many-to-many join table, serialize the ids into a JSON array.