restforce-db 0.5.1 → 1.0.0

data/test/lib/restforce/db/mapping_test.rb

@@ -13,29 +13,19 @@ describe Restforce::DB::Mapping do
       column_two: "SF_Field_Two__c",
     }
   end
+  let(:through) { nil }
   let!(:mapping) do
-    Restforce::DB::Mapping.new(
-      database_model,
-      salesforce_model,
-      fields: fields,
-      associations: associations,
-    )
-  end
-
-  describe ".each" do
-
-    # Restforce::DB::Mapping actually implements Enumerable, so we're just
-    # going with a trivially testable portion of the Enumerable API.
-    it "yields the registered record types" do
-      expect(Restforce::DB::Mapping.first).to_equal mapping
+    Restforce::DB::Mapping.new(database_model, salesforce_model).tap do |m|
+      m.fields       = fields
+      m.associations = associations
+      m.through      = through
     end
   end
 
   describe "#initialize" do
 
-    it "adds the mapping to the global collection" do
-      expect(Restforce::DB::Mapping[database_model]).to_equal [mapping]
-      expect(Restforce::DB::Mapping[salesforce_model]).to_equal [mapping]
+    it "defaults to an initialization strategy of `Always`" do
+      expect(mapping.strategy).to_be_instance_of(Restforce::DB::Strategies::Always)
     end
   end
 

data/test/lib/restforce/db/model_test.rb

@@ -6,12 +6,6 @@ describe Restforce::DB::Model do
 
   let(:database_model) { CustomObject }
   let(:salesforce_model) { "CustomObject__c" }
-  let(:fields) do
-    {
-      name:    "Name",
-      example: "Example_Field__c",
-    }
-  end
 
   before do
     database_model.send(:include, Restforce::DB::Model)
@@ -19,11 +13,16 @@ describe Restforce::DB::Model do
 
   describe ".sync_with" do
     before do
-      database_model.sync_with(salesforce_model, fields: fields)
+      database_model.sync_with(salesforce_model) do
+        maps(
+          name:    "Name",
+          example: "Example_Field__c",
+        )
+      end
     end
 
-    it "creates a mapping in Restforce::DB::Mapping" do
-      expect(Restforce::DB::Mapping[database_model]).to_not_be :empty?
+    it "adds a mapping to the global Restforce::DB::Registry" do
+      expect(Restforce::DB::Registry[database_model]).to_not_be :empty?
     end
   end
 

data/test/lib/restforce/db/record_types/active_record_test.rb

@@ -26,6 +26,10 @@ describe Restforce::DB::RecordTypes::ActiveRecord do
     end
     let(:instance) { record_type.create!(create_from).record }
 
+    before do
+      Restforce::DB::Registry << mapping
+    end
+
     it "creates a record in the database from the passed Salesforce record's attributes" do
       expect(instance.salesforce_id).to_equal salesforce_id
       expect(instance.name).to_equal attributes[:name]
@@ -39,12 +43,12 @@ describe Restforce::DB::RecordTypes::ActiveRecord do
       let(:associations) { { user: "Friend__c" } }
 
       before do
-        mapping = Restforce::DB::Mapping.new(
-          User,
-          "Contact",
-          through: "Friend__c",
-          fields: { email: "Email" },
-        )
+        mapping = Restforce::DB::Mapping.new(User, "Contact").tap do |m|
+          m.through = "Friend__c"
+          m.fields  = { email: "Email" }
+        end
+        Restforce::DB::Registry << mapping
+
         salesforce_record_type = mapping.salesforce_record_type
 
         # Stub out the `#find` method on the record type

data/test/lib/restforce/db/registry_test.rb

@@ -0,0 +1,43 @@
+describe Restforce::DB::Registry do
+
+  configure!
+  mappings!
+
+  describe ".<<" do
+    before do
+      Restforce::DB::Registry << mapping
+    end
+
+    it "appends a mapping in the registry under its ActiveRecord class" do
+      expect(Restforce::DB::Registry[database_model]).to_equal [mapping]
+    end
+
+    it "appends a mapping in the registry under its Salesforce object type" do
+      expect(Restforce::DB::Registry[salesforce_model]).to_equal [mapping]
+    end
+  end
+
+  describe ".each" do
+    before do
+      Restforce::DB::Registry << mapping
+    end
+
+    # Restforce::DB::Registry actually implements Enumerable, so we're just
+    # going with a trivially testable portion of the Enumerable API.
+    it "yields the registered record types" do
+      expect(Restforce::DB::Registry.first).to_equal mapping
+    end
+  end
+
+  describe ".clean!" do
+    before do
+      Restforce::DB::Registry << mapping
+    end
+
+    it "clears out the currently registered mappings" do
+      expect(Restforce::DB::Registry.first).to_not_be_nil
+      Restforce::DB::Registry.clean!
+      expect(Restforce::DB::Registry.first).to_be_nil
+    end
+  end
+end

data/test/lib/restforce/db/strategies/always_test.rb

@@ -0,0 +1,38 @@
+require_relative "../../../../test_helper"
+
+describe Restforce::DB::Strategies::Always do
+
+  configure!
+  mappings!
+
+  let(:strategy) { Restforce::DB::Strategies::Always.new }
+
+  it "is not a passive strategy" do
+    expect(strategy).to_not_be :passive?
+  end
+
+  describe "#build?", :vcr do
+
+    describe "given a Salesforce record" do
+      let(:salesforce_id) { Salesforce.create! salesforce_model }
+      let(:record) { mapping.salesforce_record_type.find(salesforce_id) }
+
+      it "wants to build a new matching record" do
+        expect(strategy.build?(record)).to_equal true
+      end
+
+      describe "with a corresponding database record" do
+        before do
+          CustomObject.create!(
+            salesforce_id: salesforce_id,
+            synchronized_at: Time.now,
+          )
+        end
+
+        it "does not want to build a new record" do
+          expect(strategy.build?(record)).to_equal false
+        end
+      end
+    end
+  end
+end

data/test/lib/restforce/db/strategies/passive_test.rb

@@ -0,0 +1,17 @@
+require_relative "../../../../test_helper"
+
+describe Restforce::DB::Strategies::Passive do
+  let(:strategy) { Restforce::DB::Strategies::Passive.new }
+
+  it "is a passive strategy" do
+    expect(strategy).to_be :passive?
+  end
+
+  describe "#build?" do
+
+    it "returns false for any record" do
+      record = Object.new
+      expect(strategy.build?(record)).to_equal false
+    end
+  end
+end

data/test/lib/restforce/db/strategy_test.rb

@@ -0,0 +1,19 @@
+require_relative "../../../test_helper"
+
+describe Restforce::DB::Strategy do
+
+  describe ".for" do
+    let(:strategy) { Restforce::DB::Strategy.for(type) }
+
+    describe ":always" do
+      let(:type) { :always }
+      it { expect(strategy).to_be_instance_of(Restforce::DB::Strategies::Always) }
+    end
+
+    describe ":always" do
+      let(:type) { :passive }
+      it { expect(strategy).to_be_instance_of(Restforce::DB::Strategies::Passive) }
+    end
+  end
+
+end

data/test/support/utilities.rb

@@ -5,7 +5,7 @@ def configure!
   end
 
   after do
-    Restforce::DB::Mapping.collection = {}
+    Restforce::DB::Registry.clean!
     DatabaseCleaner.clean
     Salesforce.clean!
   end
@@ -20,13 +20,11 @@ def mappings!
   let(:conditions) { [] }
   let(:through) { nil }
   let!(:mapping) do
-    Restforce::DB::Mapping.new(
-      database_model,
-      salesforce_model,
-      through: through,
-      fields: fields,
-      associations: associations,
-      conditions: conditions,
-    )
+    Restforce::DB::Mapping.new(database_model, salesforce_model).tap do |m|
+      m.through      = through
+      m.conditions   = conditions
+      m.fields       = fields
+      m.associations = associations
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -227,6 +227,7 @@ files:
 - lib/restforce/db/collector.rb
 - lib/restforce/db/command.rb
 - lib/restforce/db/configuration.rb
+- lib/restforce/db/dsl.rb
 - lib/restforce/db/initializer.rb
 - lib/restforce/db/instances/active_record.rb
 - lib/restforce/db/instances/base.rb
@@ -236,7 +237,11 @@ files:
 - lib/restforce/db/record_types/active_record.rb
 - lib/restforce/db/record_types/base.rb
 - lib/restforce/db/record_types/salesforce.rb
+- lib/restforce/db/registry.rb
 - lib/restforce/db/runner.rb
+- lib/restforce/db/strategies/always.rb
+- lib/restforce/db/strategies/passive.rb
+- lib/restforce/db/strategy.rb
 - lib/restforce/db/synchronizer.rb
 - lib/restforce/db/tracker.rb
 - lib/restforce/db/version.rb
@@ -247,9 +252,9 @@ files:
 - test/cassettes/Restforce_DB_Collector/_run/given_a_Salesforce_record_with_an_associated_database_record/returns_the_attributes_from_both_records.yml
 - test/cassettes/Restforce_DB_Collector/_run/given_an_existing_Salesforce_record/returns_the_attributes_from_the_Salesforce_record.yml
 - test/cassettes/Restforce_DB_Collector/_run/given_an_existing_database_record/returns_the_attributes_from_the_database_record.yml
-- test/cassettes/Restforce_DB_Initializer/_run/given_an_existing_Salesforce_record/for_a_non-root_mapping/does_not_create_a_database_record.yml
-- test/cassettes/Restforce_DB_Initializer/_run/given_an_existing_Salesforce_record/for_a_root_mapping/creates_a_matching_database_record.yml
-- test/cassettes/Restforce_DB_Initializer/_run/given_an_existing_database_record/for_a_root_mapping/populates_Salesforce_with_the_new_record.yml
+- test/cassettes/Restforce_DB_Initializer/_run/given_an_existing_Salesforce_record/for_a_Passive_strategy/does_not_create_a_database_record.yml
+- test/cassettes/Restforce_DB_Initializer/_run/given_an_existing_Salesforce_record/for_an_Always_strategy/creates_a_matching_database_record.yml
+- test/cassettes/Restforce_DB_Initializer/_run/given_an_existing_database_record/for_an_Always_strategy/populates_Salesforce_with_the_new_record.yml
 - test/cassettes/Restforce_DB_Instances_Salesforce/_copy_/updates_the_record_with_the_attributes_from_the_copied_object.yml
 - test/cassettes/Restforce_DB_Instances_Salesforce/_synced_/when_a_matching_database_record_exists/returns_true.yml
 - test/cassettes/Restforce_DB_Instances_Salesforce/_synced_/when_no_matching_database_record_exists/returns_false.yml
@@ -262,6 +267,8 @@ files:
 - test/cassettes/Restforce_DB_RecordTypes_Salesforce/_find/given_a_set_of_mapping_conditions/when_a_record_does_not_meet_the_conditions/does_not_find_the_record.yml
 - test/cassettes/Restforce_DB_RecordTypes_Salesforce/_find/given_a_set_of_mapping_conditions/when_a_record_meets_the_conditions/finds_the_record.yml
 - test/cassettes/Restforce_DB_RecordTypes_Salesforce/_find/returns_nil_when_no_matching_record_exists.yml
+- test/cassettes/Restforce_DB_Strategies_Always/_build_/given_a_Salesforce_record/wants_to_build_a_new_matching_record.yml
+- test/cassettes/Restforce_DB_Strategies_Always/_build_/given_a_Salesforce_record/with_a_corresponding_database_record/does_not_want_to_build_a_new_record.yml
 - test/cassettes/Restforce_DB_Synchronizer/_run/given_a_Salesforce_record_with_an_associated_database_record/updates_the_database_record.yml
 - test/cassettes/Restforce_DB_Synchronizer/_run/given_a_Salesforce_record_with_an_associated_database_record/updates_the_salesforce_record.yml
 - test/lib/restforce/db/accumulator_test.rb
@@ -269,6 +276,7 @@ files:
 - test/lib/restforce/db/attribute_map_test.rb
 - test/lib/restforce/db/collector_test.rb
 - test/lib/restforce/db/configuration_test.rb
+- test/lib/restforce/db/dsl_test.rb
 - test/lib/restforce/db/initializer_test.rb
 - test/lib/restforce/db/instances/active_record_test.rb
 - test/lib/restforce/db/instances/salesforce_test.rb
@@ -276,7 +284,11 @@ files:
 - test/lib/restforce/db/model_test.rb
 - test/lib/restforce/db/record_types/active_record_test.rb
 - test/lib/restforce/db/record_types/salesforce_test.rb
+- test/lib/restforce/db/registry_test.rb
 - test/lib/restforce/db/runner_test.rb
+- test/lib/restforce/db/strategies/always_test.rb
+- test/lib/restforce/db/strategies/passive_test.rb
+- test/lib/restforce/db/strategy_test.rb
 - test/lib/restforce/db/synchronizer_test.rb
 - test/lib/restforce/db/tracker_test.rb
 - test/lib/restforce/db_test.rb