active_force 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 741f33a6c27d6bc11eaaa7655c2a7fb2ecc772f93d298e608866840b82e94321
-  data.tar.gz: 465abe2c572e35dc61817ab1bf8ac1d6d0e35e6f26eb2e933af3ed1781c2c68a
+  metadata.gz: 6de1df55a3215360cd78f76fa3f55d05ca9e8f9f9603d5ab4257667a5fd961a5
+  data.tar.gz: e85f2ae5bd075070adc261ec3a6d566eea2f9cf19c4d4423fa1b859cafdabcc4
 SHA512:
-  metadata.gz: 376ab891dc3a0bf92f030dd3b756aa900c8091bfd42b3424ef1c832ecc2ac14384785f96eeadc20764f22ee02315753cba10c4b0aec067294e2175a09754dc60
-  data.tar.gz: f60cf65275aaee5e96ebb173cc0718cbc663b3cced951bccf8b417df1029055606be56bdf82617e689130d68687b8ce8f8227acab83314c54715e95e6ca28629
+  metadata.gz: 5268395d3fcc92a705b909026b6de6deb36b4c6a9b622d0ee63307ed08d16142e96abca2bafb902c55fca02955d75c34aa3348eb84fc14c47784d3548b492f89
+  data.tar.gz: 3ea676afd55bb62601e211250c487a86e7902f1dee1f8b6fdc41410b903ce2052e5a4f893cc869798ba3bf5c1270aad2c84ea21c24dd137909e494e7c0564ff9

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Not released
 
+## 0.18.0
+
+- Fix eager loading of scoped associations. (https://github.com/Beyond-Finance/active_force/pull/67)
+- Adding `.blank?`, `.present?`, and `.any?` delegators to `ActiveQuery`. (https://github.com/Beyond-Finance/active_force/pull/68)
+- Adding `update` and `update!` class methods on `SObject`. (https://github.com/Beyond-Finance/active_force/pull/66)
+- Allow an argument to `last` allowing the query to select the `last(n)` records. Default is 1. (https://github.com/Beyond-Finance/active_force/pull/66)
+
 ## 0.17.0
 
 - Fix bug with has_many queries due to query method chaining mutating in-place (https://github.com/Beyond-Finance/active_force/pull/10)

data/lib/active_force/active_query.rb

@@ -21,9 +21,9 @@ module ActiveForce
     attr_reader :sobject, :association_mapping, :belongs_to_association_mapping
 
     def_delegators :sobject, :sfdc_client, :build, :table_name, :mappings
-    def_delegators :to_a, :each, :map, :inspect, :pluck, :each_with_object
+    def_delegators :to_a, :blank?, :present?, :any?, :each, :map, :inspect, :pluck, :each_with_object
 
-    def initialize (sobject, custom_table_name = nil)
+    def initialize(sobject, custom_table_name = nil)
       @sobject = sobject
       @association_mapping = {}
       @belongs_to_association_mapping = {}

data/lib/active_force/association/association.rb

@@ -26,6 +26,14 @@ module ActiveForce
         options[:relationship_name] || relation_model.to_s.constantize.table_name
       end
 
+      def scoped_as
+        options[:scoped_as] || nil
+      end
+
+      def scoped?
+        options[:scoped_as].present?
+      end
+
       ###
       # Does this association's relation_model represent
       # +sfdc_table_name+? Examples of +sfdc_table_name+

data/lib/active_force/association/eager_load_projection_builder.rb

@@ -1,5 +1,6 @@
 module ActiveForce
   module Association
+    class InvalidEagerLoadAssociation < StandardError; end
     class EagerLoadProjectionBuilder
       class << self
         def build(association, parent_association_field = nil)
@@ -34,6 +35,13 @@ module ActiveForce
       def projections
         raise "Must define #{self.class.name}#projections"
       end
+
+      def apply_association_scope(query)
+        return query unless association.scoped?
+        raise InvalidEagerLoadAssociation, "Cannot use scopes that expect arguments: #{association.relation_name}" if association.scoped_as.arity.positive?
+
+        query.instance_exec(&association.scoped_as)
+      end
     end
 
     class HasManyAssociationProjectionBuilder < AbstractProjectionBuilder
@@ -43,17 +51,17 @@ module ActiveForce
       # to be pluralized
       def projections
         relationship_name = association.sfdc_association_field
-        query = Query.new relationship_name
+        query = ActiveQuery.new(association.relation_model, relationship_name)
         query.fields association.relation_model.fields
-        ["(#{query.to_s})"]
+        ["(#{apply_association_scope(query).to_s})"]
       end
     end
 
     class HasOneAssociationProjectionBuilder < AbstractProjectionBuilder
       def projections
-        query = Query.new association.sfdc_association_field
+        query = ActiveQuery.new(association.relation_model, association.sfdc_association_field)
         query.fields association.relation_model.fields
-        ["(#{query.to_s})"]
+        ["(#{apply_association_scope(query).to_s})"]
       end
     end
 

data/lib/active_force/query.rb

@@ -81,8 +81,8 @@ module ActiveForce
       limit 1
     end
 
-    def last
-      order("Id DESC").limit(1)
+    def last(limit = 1)
+      order("Id DESC").limit(limit)
     end
 
     def join object_query

data/lib/active_force/sobject.rb

@@ -129,6 +129,14 @@ module ActiveForce
       new(args).create!
     end
 
+    def self.update(id, attributes)
+      new(attributes.merge(id: id)).update
+    end
+
+    def self.update!(id, attributes)
+      new(attributes.merge(id: id)).update!
+    end
+
     def save!
       run_callbacks :save do
         if persisted?
@@ -231,7 +239,7 @@ module ActiveForce
     end
 
     def default_attributes
-      @attributes.each_value.select do |value| 
+      @attributes.each_value.select do |value|
         value.is_a?(ActiveModel::Attribute::UserProvidedDefault) || value.instance_values["original_attribute"].is_a?(ActiveModel::Attribute::UserProvidedDefault)
       end.map(&:name)
     end

data/lib/active_force/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveForce
-  VERSION = '0.17.0'
+  VERSION = '0.18.0'
 end

data/spec/active_force/active_query_spec.rb

@@ -18,7 +18,6 @@ describe ActiveForce::ActiveQuery do
     ]
   end
 
-
   before do
     allow(active_query).to receive(:sfdc_client).and_return client
     allow(active_query).to receive(:build).and_return Object.new
@@ -40,6 +39,72 @@ describe ActiveForce::ActiveQuery do
     end
   end
 
+  describe '#blank? delegation' do
+    before do
+      allow(client).to receive(:query).and_return(api_result)
+    end
+
+    context 'when there are no records' do
+      let(:api_result) { [] }
+
+      it 'returns true' do
+        result = active_query.where("Text_Label = 'foo'").blank?
+        expect(result).to be true
+      end
+    end
+
+    context 'when records are returned' do
+      it 'returns false' do
+        result = active_query.where("Text_Label = 'foo'").blank?
+        expect(result).to be false
+      end
+    end
+  end
+
+  describe '#present? delegation' do
+    before do
+      allow(client).to receive(:query).and_return(api_result)
+    end
+
+    context 'when there are no records' do
+      let(:api_result) { [] }
+
+      it 'returns false' do
+        result = active_query.where("Text_Label = 'foo'").present?
+        expect(result).to be false
+      end
+    end
+
+    context 'when there are records' do
+      it 'returns true' do
+        result = active_query.where("Text_Label = 'foo'").present?
+        expect(result).to be true
+      end
+    end
+  end
+
+  describe '#any? delegation' do
+    before do
+      allow(client).to receive(:query).and_return(api_result)
+    end
+
+    context 'when there are no records' do
+      let(:api_result) { [] }
+
+      it 'returns true' do
+        result = active_query.where("Text_Label = 'foo'").any?
+        expect(result).to be false
+      end
+    end
+
+    context 'when records are returned' do
+      it 'returns false' do
+        result = active_query.where("Text_Label = 'foo'").any?
+        expect(result).to be true
+      end
+    end
+  end
+
   describe "select only some field using mappings" do
     it "should return a query only with selected field" do
       new_query = active_query.select(:field)

data/spec/active_force/query_spec.rb

@@ -168,14 +168,30 @@ describe ActiveForce::Query do
   end
 
   describe '.last' do
-    it 'should return the query for the last record' do
-      expect(query.last.to_s).to eq 'SELECT Id, name, etc FROM table_name ORDER BY Id DESC LIMIT 1'
-    end
-
-    it "should not update the original query" do
-      new_query = query.last
-      expect(query.to_s).to eq "SELECT Id, name, etc FROM table_name"
-      expect(new_query.to_s).to eq 'SELECT Id, name, etc FROM table_name ORDER BY Id DESC LIMIT 1'
+    context 'without any argument' do
+      it 'should return the query for the last record' do
+        expect(query.last.to_s).to eq 'SELECT Id, name, etc FROM table_name ORDER BY Id DESC LIMIT 1'
+      end
+
+      it "should not update the original query" do
+        new_query = query.last
+        expect(query.to_s).to eq "SELECT Id, name, etc FROM table_name"
+        expect(new_query.to_s).to eq 'SELECT Id, name, etc FROM table_name ORDER BY Id DESC LIMIT 1'
+      end
+    end
+
+    context 'with an argument' do
+      let(:last_argument) { 3 }
+
+      it 'should return the query for the last n records' do
+        expect(query.last(last_argument).to_s).to eq "SELECT Id, name, etc FROM table_name ORDER BY Id DESC LIMIT #{last_argument}"
+      end
+
+      it "should not update the original query" do
+        new_query = query.last last_argument
+        expect(query.to_s).to eq "SELECT Id, name, etc FROM table_name"
+        expect(new_query.to_s).to eq "SELECT Id, name, etc FROM table_name ORDER BY Id DESC LIMIT #{last_argument}"
+      end
     end
   end
 

data/spec/active_force/sobject/includes_spec.rb

@@ -225,6 +225,13 @@ module ActiveForce
           end
         end
 
+        context 'when assocation has a scope' do
+          it 'formulates the correct SOQL query with the scope applied' do
+            soql = Post.includes(:impossible_comments).where(id: '1234').to_s
+            expect(soql).to eq "SELECT Id, Title__c, BlogId, (SELECT Id, PostId, PosterId__c, FancyPostId, Body__c FROM Comments__r WHERE (1 = 0)) FROM Post__c WHERE (Id = '1234')"
+          end
+        end
+
         context 'with namespaced SObjects' do
           it 'formulates the correct SOQL query' do
             soql = Salesforce::Quota.includes(:prez_clubs).where(id: '123').to_s
@@ -286,9 +293,26 @@ module ActiveForce
         end
       end
 
+      context 'has_one' do
+        context 'when assocation has a scope' do
+          it 'formulates the correct SOQL query with the scope applied' do
+            soql = Post.includes(:last_comment).where(id: '1234').to_s
+            expect(soql).to eq "SELECT Id, Title__c, BlogId, (SELECT Id, PostId, PosterId__c, FancyPostId, Body__c FROM Comment__r WHERE (NOT ((Body__c = NULL))) ORDER BY CreatedDate DESC) FROM Post__c WHERE (Id = '1234')"
+          end
+        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')
+        context 'when the association is not defined' 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
+        context 'when the association is scoped and accepts an argument' do
+          it 'raises and error' do
+            expect { Post.includes(:reply_comments).find('1234')}.to raise_error(ActiveForce::Association::InvalidEagerLoadAssociation)
+          end
         end
       end
     end

data/spec/active_force/sobject_spec.rb

@@ -313,6 +313,24 @@ describe ActiveForce::SObject do
         expect(Whizbang.create(text: 'some text')).to be_instance_of(Whizbang)
       end
     end
+
+    describe 'self.update' do
+      it 'uses the client to update the correct record' do
+        expect(client).to receive(:update!)
+          .with(Whizbang.table_name, { 'Id' => '12345678', 'Text_Label' => 'my text', 'Updated_From__c' => 'Rails' })
+          .and_return(true)
+        Whizbang.update('12345678', text: 'my text')
+      end
+    end
+
+    describe 'self.update!' do
+      it 'uses the client to update the correct record' do
+        expect(client).to receive(:update!)
+          .with(Whizbang.table_name, { 'Id' => '123456789', 'Text_Label' => 'some other text', 'Updated_From__c' => 'Rails' })
+          .and_return(true)
+        Whizbang.update('123456789', text: 'some other text')
+      end
+    end
   end
 
   describe '.count' do

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: active_force
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Eloy Espinaco
 - Pablo Oldani
 - Armando Andini
 - José Piccioni
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -193,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
@@ -208,8 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Help you implement models persisting on Sales Force within Rails using RESTForce
 test_files: