active_force 0.15.1 → 0.17.0

data/spec/active_force/sobject/includes_spec.rb

@@ -285,6 +285,331 @@ module ActiveForce
           expect(account.owner.id).to eq '321'
         end
       end
+
+      context 'when invalid associations are passed' do
+        it 'raises an error' do
+          expect { Quota.includes(:invalid).find('123') }.to raise_error(ActiveForce::Association::InvalidAssociationError, 'Association named invalid was not found on Quota')
+        end
+      end
+    end
+
+    describe '.includes with nested associations' do
+
+      context 'with custom objects' do
+        it 'formulates the correct SOQL query' do
+          soql = Quota.includes(prez_clubs: :club_members).where(id: '123').to_s
+          expect(soql).to eq <<-SOQL.squish
+            SELECT Id, Bar_Id__c,
+              (SELECT Id, QuotaId,
+                (SELECT Id, Name, Email FROM ClubMembers__r)
+              FROM PrezClubs__r)
+            FROM Quota__c
+            WHERE (Bar_Id__c = '123')
+          SOQL
+        end
+
+        it 'builds the associated objects and caches them' do
+          response = [build_restforce_sobject({
+            'Id' => '123',
+            'PrezClubs__r' => build_restforce_collection([
+              {'Id' => '213', 'QuotaId' => '123', 'ClubMembers__r' => build_restforce_collection([
+                {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com'},
+                {'Id' => '214', 'Name' => 'def', 'Email' => 'def@af.com'}
+              ])},
+              {'Id' => '214', 'QuotaId' => '123', 'ClubMembers__r' => build_restforce_collection([
+                {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com'},
+                {'Id' => '214', 'Name' => 'def', 'Email' => 'def@af.com'}
+              ])}
+            ])
+          })]
+          allow(client).to receive(:query).once.and_return response
+          account = Quota.includes(prez_clubs: :club_members).find '123'
+          expect(account.prez_clubs).to be_an Array
+          expect(account.prez_clubs.all? { |o| o.is_a? PrezClub }).to eq true
+          expect(account.prez_clubs.first.club_members).to be_an Array
+          expect(account.prez_clubs.first.club_members.all? { |o| o.is_a? ClubMember }).to eq true
+          expect(account.prez_clubs.first.club_members.first.id).to eq '213'
+          expect(account.prez_clubs.first.club_members.first.name).to eq 'abc'
+          expect(account.prez_clubs.first.club_members.first.email).to eq 'abc@af.com'
+        end
+      end
+
+      context 'with namespaced sobjects' do
+        it 'formulates the correct SOQL query' do
+          soql = Salesforce::Account.includes({partner_opportunities: :owner}).where(id: '123').to_s
+          expect(soql).to eq <<-SOQL.squish
+            SELECT Id, Business_Partner__c,
+              (SELECT Id, OwnerId, AccountId, Business_Partner__c, Owner.Id
+              FROM Opportunities)
+            FROM Account
+            WHERE (Id = '123')
+          SOQL
+        end
+
+        it 'builds the associated objects and caches them' do
+          response = [build_restforce_sobject({
+            'Id' => '123',
+            'opportunities' => build_restforce_collection([
+              {'Id' => '213', 'AccountId' => '123', 'OwnerId' => '321', 'Business_Partner__c' => '123', 'Owner' => {'Id' => '321'}},
+              {'Id' => '214', 'AccountId' => '123', 'OwnerId' => '321', 'Business_Partner__c' => '123', 'Owner' => {'Id' => '321'}}            ])
+          })]
+          allow(client).to receive(:query).once.and_return response
+          account = Salesforce::Account.includes({partner_opportunities: :owner}).find '123'
+          expect(account.partner_opportunities).to be_an Array
+          expect(account.partner_opportunities.all? { |o| o.is_a? Salesforce::Opportunity }).to eq true
+          expect(account.partner_opportunities.first.owner).to be_a Salesforce::User
+          expect(account.partner_opportunities.first.owner.id).to eq '321'
+        end
+      end
+
+      context 'an array association nested within a hash association' do
+        it 'formulates the correct SOQL query' do
+          soql = Club.includes(book_clubs: [:club_members, :books]).where(id: '123').to_s
+          expect(soql).to eq <<-SOQL.squish
+            SELECT Id,
+            (SELECT Id, Name, Location,
+              (SELECT Id, Name, Email FROM ClubMembers__r),
+              (SELECT Id, Title, Author FROM Books__r)
+            FROM BookClubs__r)
+            FROM Club__c
+            WHERE (Id = '123')
+          SOQL
+        end
+
+        it 'builds the associated objects and caches them' do
+          response = [build_restforce_sobject({
+            'Id' => '123',
+            'BookClubs__r' => build_restforce_collection([
+              {
+                'Id' => '213',
+                'Name' => 'abc',
+                'Location' => 'abc_location',
+                'ClubMembers__r' => build_restforce_collection([{'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com'},{'Id' => '214', 'Name' => 'def', 'Email' => 'def@af.com'}]),
+                'Books__r' => build_restforce_collection([{'Id' => '213', 'Title' => 'Foo', 'Author' => 'author1'},{'Id' => '214', 'Title' => 'Bar', 'Author' => 'author2'}]),
+              },
+              {
+                'Id' => '214',
+                'Name' => 'def',
+                'Location' => 'def_location',
+                'ClubMembers__r' => build_restforce_collection([{'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com'},{'Id' => '214', 'Name' => 'def', 'Email' => 'def@af.com'}]),
+                'Books__r' => build_restforce_collection([{'Id' => '213', 'Title' => 'Foo', 'Author' => 'author1'},{'Id' => '214', 'Title' => 'Bar', 'Author' => 'author2'}]),
+              }
+            ])
+          })]
+          allow(client).to receive(:query).once.and_return response
+          club = Club.includes(book_clubs: [:club_members, :books]).find(id: '123')
+          expect(club.book_clubs).to be_an Array
+          expect(club.book_clubs.all? { |o| o.is_a? BookClub }).to eq true
+          expect(club.book_clubs.first.name).to eq 'abc'
+          expect(club.book_clubs.first.location).to eq 'abc_location'
+          expect(club.book_clubs.first.club_members).to be_an Array
+          expect(club.book_clubs.first.club_members.all? { |o| o.is_a? ClubMember }).to eq true
+          expect(club.book_clubs.first.club_members.first.id).to eq '213'
+          expect(club.book_clubs.first.club_members.first.name).to eq 'abc'
+          expect(club.book_clubs.first.club_members.first.email).to eq 'abc@af.com'
+          expect(club.book_clubs.first.books).to be_an Array
+          expect(club.book_clubs.first.books.all? { |o| o.is_a? Book }).to eq true
+          expect(club.book_clubs.first.books.first.id).to eq '213'
+          expect(club.book_clubs.first.books.first.title).to eq 'Foo'
+          expect(club.book_clubs.first.books.first.author).to eq 'author1'
+        end
+      end
+
+      context 'a hash association nested within a hash association' do
+        it 'formulates the correct SOQL query' do
+          soql = Club.includes(book_clubs: {club_members: :membership}).where(id: '123').to_s
+          expect(soql).to eq <<-SOQL.squish
+            SELECT Id,
+            (SELECT Id, Name, Location,
+              (SELECT Id, Name, Email,
+                (SELECT Id, Type, Club_Member_Id__c FROM Membership__r)
+              FROM ClubMembers__r)
+            FROM BookClubs__r)
+            FROM Club__c
+            WHERE (Id = '123')
+          SOQL
+        end
+
+        it 'builds the associated objects and caches them' do
+          response = [build_restforce_sobject({
+            'Id' => '123',
+            'BookClubs__r' => build_restforce_collection([
+              {
+                'Id' => '213',
+                'Name' => 'abc',
+                'Location' => 'abc_location',
+                'ClubMembers__r' => build_restforce_collection([
+                  {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '111', 'Type' => 'Gold'}])},
+                  {'Id' => '214', 'Name' => 'abc', 'Email' => 'abc@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '222', 'Type' => 'Silver'}])},
+                ]),
+              },
+              {
+                'Id' => '214',
+                'Name' => 'def',
+                'Location' => 'def_location',
+                'ClubMembers__r' => build_restforce_collection([
+                  {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '111', 'Type' => 'Gold'}])},
+                  {'Id' => '214', 'Name' => 'abc', 'Email' => 'abc@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '222', 'Type' => 'Silver'}])},
+                ]),
+              }
+            ])
+          })]
+          allow(client).to receive(:query).once.and_return response
+          club = Club.includes(book_clubs: {club_members: :membership}).find(id: '123')
+          expect(club.book_clubs).to be_an Array
+          expect(club.book_clubs.all? { |o| o.is_a? BookClub }).to eq true
+          expect(club.book_clubs.first.id).to eq '213'
+          expect(club.book_clubs.first.name).to eq 'abc'
+          expect(club.book_clubs.first.location).to eq 'abc_location'
+          expect(club.book_clubs.first.club_members).to be_an Array
+          expect(club.book_clubs.first.club_members.all? { |o| o.is_a? ClubMember }).to eq true
+          expect(club.book_clubs.first.club_members.first.id).to eq '213'
+          expect(club.book_clubs.first.club_members.first.name).to eq 'abc'
+          expect(club.book_clubs.first.club_members.first.email).to eq 'abc@af.com'
+          expect(club.book_clubs.first.club_members.first.membership).to be_a Membership
+          expect(club.book_clubs.first.club_members.first.membership.id).to eq '111'
+          expect(club.book_clubs.first.club_members.first.membership.type).to eq 'Gold'
+        end
+      end
+
+      context 'mulitple nested associations' do
+        it 'formulates the correct SOQL query' do
+          soql = Club.includes({prez_clubs: {club_members: :membership}}, {book_clubs: [:club_members, :books]}).where(id: '123').to_s
+          expect(soql).to eq <<-SOQL.squish
+            SELECT Id,
+            (SELECT Id, QuotaId,
+              (SELECT Id, Name, Email,
+                (SELECT Id, Type, Club_Member_Id__c FROM Membership__r)
+              FROM ClubMembers__r)
+            FROM PrezClubs__r),
+            (SELECT Id, Name, Location,
+              (SELECT Id, Name, Email FROM ClubMembers__r),
+              (SELECT Id, Title, Author FROM Books__r)
+            FROM BookClubs__r)
+            FROM Club__c
+            WHERE (Id = '123')
+          SOQL
+        end
+
+        it 'builds the associated objects and caches them' do
+          response = [build_restforce_sobject({
+            'Id' => '123',
+            'PrezClubs__r' => build_restforce_collection([
+              {'Id' => '213', 'QuotaId' => '123', 'ClubMembers__r' => build_restforce_collection([
+                {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '111', 'Type' => 'Gold'}])},
+                {'Id' => '214', 'Name' => 'def', 'Email' => 'def@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '222', 'Type' => 'Silver'}])},
+              ])},
+              {'Id' => '214', 'QuotaId' => '123', 'ClubMembers__r' => build_restforce_collection([
+                {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '111', 'Type' => 'Gold'}])},
+                {'Id' => '214', 'Name' => 'def', 'Email' => 'def@af.com', 'Membership__r' => build_restforce_collection([{'Id' => '222', 'Type' => 'Silver'}])},
+              ])}
+            ]),
+            'BookClubs__r' => build_restforce_collection([
+              {
+                'Id' => '213',
+                'Name' => 'abc',
+                'Location' => 'abc_location',
+                'ClubMembers__r' => build_restforce_collection([
+                  {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com'},
+                  {'Id' => '214', 'Name' => 'abc', 'Email' => 'abc@af.com'},
+                ]),
+                'Books__r' => build_restforce_collection([
+                  {'Id' => '213', 'Title' => 'Foo', 'Author' => 'author1'},
+                  {'Id' => '214', 'Title' => 'Bar', 'Author' => 'author2'},
+                ])
+              },
+              {
+                'Id' => '214',
+                'Name' => 'def',
+                'Location' => 'def_location',
+                'ClubMembers__r' => build_restforce_collection([
+                  {'Id' => '213', 'Name' => 'abc', 'Email' => 'abc@af.com'},
+                  {'Id' => '214', 'Name' => 'abc', 'Email' => 'abc@af.com'},
+                ]),
+                'Books__r' => build_restforce_collection([
+                  {'Id' => '213', 'Title' => 'Foo', 'Author' => 'author1'},
+                  {'Id' => '214', 'Title' => 'Bar', 'Author' => 'author2'},
+                ])
+              }
+            ])
+          })]
+          allow(client).to receive(:query).once.and_return response
+          club = Club.includes({prez_clubs: {club_members: :membership}}, {book_clubs: [:club_members, :books]}).find(id: '123')
+          expect(club.prez_clubs).to be_an Array
+          expect(club.prez_clubs.all? { |o| o.is_a? PrezClub }).to eq true
+          expect(club.prez_clubs.first.club_members).to be_an Array
+          expect(club.prez_clubs.first.club_members.all? { |o| o.is_a? ClubMember }).to eq true
+          expect(club.prez_clubs.first.club_members.first.id).to eq '213'
+          expect(club.prez_clubs.first.club_members.first.name).to eq 'abc'
+          expect(club.prez_clubs.first.club_members.first.email).to eq 'abc@af.com'
+          expect(club.prez_clubs.first.club_members.first.membership).to be_a Membership
+          expect(club.prez_clubs.first.club_members.first.membership.id).to eq '111'
+          expect(club.prez_clubs.first.club_members.first.membership.type).to eq 'Gold'
+          expect(club.book_clubs).to be_an Array
+          expect(club.book_clubs.all? { |o| o.is_a? BookClub }).to eq true
+          expect(club.book_clubs.first.id).to eq '213'
+          expect(club.book_clubs.first.name).to eq 'abc'
+          expect(club.book_clubs.first.location).to eq 'abc_location'
+          expect(club.book_clubs.first.club_members).to be_an Array
+          expect(club.book_clubs.first.club_members.all? { |o| o.is_a? ClubMember }).to eq true
+          expect(club.book_clubs.first.club_members.first.id).to eq '213'
+          expect(club.book_clubs.first.club_members.first.name).to eq 'abc'
+          expect(club.book_clubs.first.club_members.first.email).to eq 'abc@af.com'
+          expect(club.book_clubs.first.books).to be_an Array
+          expect(club.book_clubs.first.books.all? { |o| o.is_a? Book }).to eq true
+          expect(club.book_clubs.first.books.first.id).to eq '213'
+          expect(club.book_clubs.first.books.first.title).to eq 'Foo'
+          expect(club.book_clubs.first.books.first.author).to eq 'author1'
+        end
+      end
+
+      context 'nested belongs-to association' do
+        it 'formulates the correct SOQL query' do
+          soql = Comment.includes(post: :blog).where(id: '123').to_s
+          expect(soql).to eq <<-SOQL.squish
+            SELECT Id, PostId, PosterId__c, FancyPostId, Body__c,
+              PostId.Id, PostId.Title__c, PostId.BlogId,
+                PostId.BlogId.Id, PostId.BlogId.Name, PostId.BlogId.Link__c
+            FROM Comment__c
+            WHERE (Id = '123')
+          SOQL
+        end
+
+        it 'builds the associated objects and caches them' do
+          response = [build_restforce_sobject({
+            'Id' => '123',
+            'PostId' => '321',
+            'PosterId__c' => '432',
+            'FancyPostId' => '543',
+            'Body__c' => 'body',
+            'PostId' => {
+              'Id' => '321',
+              'Title__c' => 'title',
+              'BlogId' => '432',
+              'BlogId' => {
+                'Id' => '432',
+                'Name' => 'name',
+                'Link__c' => 'link'
+              }
+            }
+          })]
+          allow(client).to receive(:query).once.and_return response
+          comment = Comment.includes(post: :blog).find '123'
+          expect(comment.post).to be_a Post
+          expect(comment.post.id).to eq '321'
+          expect(comment.post.title).to eq 'title'
+          expect(comment.post.blog).to be_a Blog
+          expect(comment.post.blog.id).to eq '432'
+          expect(comment.post.blog.name).to eq 'name'
+          expect(comment.post.blog.link).to eq 'link'
+        end
+      end
+
+      context 'when invalid nested associations are passed' do
+        it 'raises an error' do
+          expect { Quota.includes(prez_clubs: :invalid).find('123') }.to raise_error(ActiveForce::Association::InvalidAssociationError, 'Association named invalid was not found on PrezClub')
+        end
+      end
     end
   end
 end

data/spec/active_force/sobject_spec.rb

@@ -96,6 +96,20 @@ describe ActiveForce::SObject do
         it 'sets percent field upon object instantiation' do
           expect(subject.new(**instantiation_attributes)[:percent]).to eq(percent)
         end
+
+        context 'when the override to default value is the same as the default value' do
+          let(:percent) { 50.0 }
+
+          it 'sends percent to salesforce' do
+            expect(client).to receive(:create!)
+                          .with(anything, hash_including('Percent_Label' => percent))
+            subject.create(**instantiation_attributes)
+          end
+
+          it 'sets percent field upon object instantiation' do
+            expect(subject.new(**instantiation_attributes)[:percent]).to eq(percent)
+          end
+        end
       end
     end
 
@@ -301,18 +315,67 @@ describe ActiveForce::SObject do
     end
   end
 
-  describe "#count" do
-    let(:count_response){ [Restforce::Mash.new(expr0: 1)] }
+  describe '.count' do
+    let(:response) { [Restforce::Mash.new(expr0: 1)] }
+
+    before do
+      allow(client).to receive(:query).and_return(response)
+    end
 
-    it "responds to count" do
-      expect(Whizbang).to respond_to(:count)
+    it 'sends the correct query to the client' do
+      expected = 'SELECT count(Id) FROM Whizbang__c'
+      Whizbang.count
+      expect(client).to have_received(:query).with(expected)
     end
 
-    it "sends the query to the client" do
-      expect(client).to receive(:query).and_return(count_response)
+    it 'returns the result from the response' do
       expect(Whizbang.count).to eq(1)
     end
 
+    it 'works with .where' do
+      expected = 'SELECT count(Id) FROM Whizbang__c WHERE (Boolean_Label = true)'
+      Whizbang.where(boolean: true).count
+      expect(client).to have_received(:query).with(expected)
+    end
+  end
+
+  describe '.sum' do
+    let(:response) { [Restforce::Mash.new(expr0: 22)] }
+
+    before do
+      allow(client).to receive(:query).and_return(response)
+    end
+
+    it 'raises ArgumentError if given blank' do
+      expect { Whizbang.sum(nil) }.to raise_error(ArgumentError, 'field is required')
+    end
+
+    it 'raises ArgumentError if given invalid field' do
+      expect { Whizbang.sum(:invalid) }
+        .to raise_error(ArgumentError, /field 'invalid' does not exist on Whizbang/i)
+    end
+
+    it 'sends the correct query to the client' do
+      expected = 'SELECT sum(Percent_Label) FROM Whizbang__c'
+      Whizbang.sum(:percent)
+      expect(client).to have_received(:query).with(expected)
+    end
+
+    it 'works when given a string field' do
+      expected = 'SELECT sum(Percent_Label) FROM Whizbang__c'
+      Whizbang.sum('percent')
+      expect(client).to have_received(:query).with(expected)
+    end
+
+    it 'returns the result from the response' do
+      expect(Whizbang.sum(:percent)).to eq(22)
+    end
+
+    it 'works with .where' do
+      expected = 'SELECT sum(Percent_Label) FROM Whizbang__c WHERE (Boolean_Label = true)'
+      Whizbang.where(boolean: true).sum(:percent)
+      expect(client).to have_received(:query).with(expected)
+    end
   end
 
   describe "#find_by" do

data/spec/support/sobjects.rb

@@ -10,6 +10,7 @@ end
 class Post < ActiveForce::SObject
   self.table_name = "Post__c"
   field :title
+  field :blog_id, from: "BlogId"
   has_many :comments
   has_many :impossible_comments, model: Comment, scoped_as: ->{ where('1 = 0') }
   has_many :reply_comments, model: Comment, scoped_as: ->(post){ where(body: "RE: #{post.title}").order('CreationDate DESC') }
@@ -17,6 +18,13 @@ class Post < ActiveForce::SObject
   has_many :poster_comments, { foreign_key: :poster_id, model: Comment }
   has_one :last_comment, model: Comment, scoped_as: -> { where.not(body: nil).order('CreatedDate DESC') }
   has_one :repeat_comment, model: Comment, scoped_as: ->(post) { where(body: post.title) }
+  belongs_to :blog
+end
+
+class Blog < ActiveForce::SObject
+  field :name, from: 'Name'
+  field :link, from: 'Link__c'
+  has_many :posts
 end
 class Territory < ActiveForce::SObject
   field :quota_id, from: "Quota__c"
@@ -26,7 +34,40 @@ end
 class PrezClub < ActiveForce::SObject
   field :quota_id, from: 'QuotaId'
   belongs_to :quota
+  has_many :club_members
+  has_one :club_owner
+end
+
+class Club < ActiveForce::SObject
+  has_many :book_clubs
+  has_many :prez_clubs
+end
+
+class BookClub < ActiveForce::SObject
+  field :name, from: 'Name'
+  field :location, from: 'Location'
+  has_many :club_members
+  has_many :books
 end
+class ClubMember < ActiveForce::SObject
+  field :name, from: 'Name'
+  field :email, from: 'Email'
+  has_one :membership
+end
+
+class Book < ActiveForce::SObject
+  field :title, from: 'Title'
+  field :author, from: 'Author'
+end
+class Membership < ActiveForce::SObject
+  field :type, from: 'Type'
+  field :club_member_id, from: 'Club_Member_Id__c'
+end
+
+class ClubOwner < ActiveForce::SObject
+  field :name, from: 'Name'
+end
+
 class Quota < ActiveForce::SObject
   field :id, from: 'Bar_Id__c'
   has_many :prez_clubs

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: active_force
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Eloy Espinaco
 - Pablo Oldani
 - Armando Andini
 - José Piccioni
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -150,6 +150,7 @@ files:
 - lib/active_force/association.rb
 - lib/active_force/association/association.rb
 - lib/active_force/association/belongs_to_association.rb
+- lib/active_force/association/eager_load_builder_for_nested_includes.rb
 - lib/active_force/association/eager_load_projection_builder.rb
 - lib/active_force/association/has_many_association.rb
 - lib/active_force/association/has_one_association.rb
@@ -192,7 +193,7 @@ metadata:
   bug_tracker_uri: https://github.com/Beyond-Finance/active_force/issues
   changelog_uri: https://github.com/Beyond-Finance/active_force/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/Beyond-Finance/active_force
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -207,8 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Help you implement models persisting on Sales Force within Rails using RESTForce
 test_files: