active_record-json_associations 0.7.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da40cb0d7c64c3ae4fc7e90333a9ceb5687ed65676435f68edc66563e13f609c
-  data.tar.gz: 77cd9023e9877aa3709162fbcfc1ac08c4ea5c7c581264fff450e20af58b6e2e
+  metadata.gz: 74ef04233cdf6b923c6be5762d8aa373428bf0ddd74a8fe48f46cbd9b3f16851
+  data.tar.gz: b40d4491c6619ecd3d858864706e3e05e459a3d3f3b20f50eadf0eed416c05db
 SHA512:
-  metadata.gz: e219263a6d06ff6bc97dd86df3a289c82642f6b3c333779e107e8f21ae07c75fcad39f110cd84f7ef25303f752b43ee81b51c78a0d9f12591877cafddf861657
-  data.tar.gz: 705383f050a1e3b84524c5a6dcc74e8e30027a3d663cd944e616da033527afd63f13bf4872c6b4c8175385939b240ceb6a0e4d4265622e53efa52e299831b3e2
+  metadata.gz: ea1b394dbe6ba8524b50228d9f226af19699171105cd8dda69b7f92f1b1fee6a9dfa06aa85301bfc2403fdb3831972799a38d01a6353c035235e1935fcc57bc2
+  data.tar.gz: e37aec9fff5cfe740cda139ed46c1b7fada912a30a26ebed3945ac6e0a8c7e9356071360278323867f949a666654cf47c9d351b2431c5a2b75fc568273b5439d

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: [ rails_5.1, rails_5.2, rails_6.0, rails_6.1, rails_7.0 ]
+        ruby: [ 2.6, 2.7, '3.0' ]
+        exclude:
+          - gemfile: rails_5.1
+            ruby: 3.0
+          - gemfile: rails_5.2
+            ruby: 3.0
+          - gemfile: rails_7.0
+            ruby: 2.6
+
+    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
+    steps:
+      - uses: actions/checkout@v2
+      - 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
+

data/Appraisals

@@ -1,8 +1,3 @@
-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
@@ -15,3 +10,11 @@ appraise "rails-6.0" do
   gem "rails", "~>6.0.0"
 end
 
+appraise "rails-6.1" do
+  gem "rails", "~>6.1.0"
+end
+
+appraise "rails-7.0" do
+  gem "rails", "~>7.0.0"
+end
+

data/README.md

@@ -43,6 +43,14 @@ And a scope method for finding records assocatied with an id:
 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
@@ -55,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

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "timecop"
 end
 

data/gemfiles/{rails_5.0.gemfile → rails_6.1.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~>5.0.0"
-gem "sqlite3", "~>1.3.13"
+gem "rails", "~>6.1.0"
 
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

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

data/lib/active_record/json_associations/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module JsonAssociations
-    VERSION = "0.7.0"
+    VERSION = "0.11.0"
   end
 end

data/lib/active_record/json_associations.rb

@@ -11,7 +11,7 @@ module ActiveRecord
     end
     private_constant :FIELD_INCLUDE_SCOPE_BUILDER_PROC
 
-    def belongs_to_many(many, class_name: nil)
+    def belongs_to_many(many, class_name: nil, touch: nil)
       one = many.to_s.singularize
       one_ids = :"#{one}_ids"
       one_ids_equals = :"#{one_ids}="
@@ -22,10 +22,38 @@ module ActiveRecord
 
       serialize one_ids, JSON
 
+      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]
+            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
+      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?
-          FIELD_INCLUDE_SCOPE_BUILDER_PROC.call(self, one_ids, id)
+          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
       }
 
@@ -79,8 +107,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
@@ -91,13 +123,11 @@ 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
           FIELD_INCLUDE_SCOPE_BUILDER_PROC.call(klass, foreign_key, id)
         end
 
@@ -112,6 +142,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/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,7 @@ 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
@@ -63,6 +70,129 @@ describe ActiveRecord::JsonAssociations do
           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
+
+      it "skips touching if in a .no_touching block" do
+        children = [Child.create!, Child.create!]
+        parent = Parent.create!(children: children)
+        children.each { |child| child.update!(updated_at: old_time) }
+        ActiveRecord::Base.no_touching { parent.save! }
+        expect(children.each(&:reload).map(&:updated_at)).to eq [old_time, old_time]
+      end
     end
 
     describe "#child_ids" do
@@ -225,6 +355,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.7.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,20 @@ 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
@@ -116,9 +130,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
@@ -126,10 +140,11 @@ files:
 - 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
+- gemfiles/rails_7.0.gemfile
 - lib/active_record/json_associations.rb
 - lib/active_record/json_associations/version.rb
 - spec/json_associations_spec.rb
@@ -153,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Instead of a many-to-many join table, serialize the ids into a JSON array.

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-rvm:
-  - 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"
-