restforce-db 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 426c96af98332d2afd82da60f56121eaae4197e2
-  data.tar.gz: 7d6fdb0c0b304e9ce2cd4149e502a85cf6b98263
+  metadata.gz: d8a211ef8c000ea0d937a3a834aa54ba7c535161
+  data.tar.gz: a5c4889b4640d94fa9759d11bb4a32036ac60f6c
 SHA512:
-  metadata.gz: ed5d4a11b2b27fe9003e81c9ed0b68cd86fd43cc706d77443d43ee182f8726f35030efe030a65d17ba2a72439850da7a03d03e8941276b523cf3af10a451fe17
-  data.tar.gz: 9226923f587bbefa6e041a0a918e7e36b9e22ddcd5d78f991449a630854cdf1ec9684b3e4c7d37ad6f17fed4913fbce385f9e2f11491e897cc641c1427f12676
+  metadata.gz: d37096768b104f436c00a4a0945d61c0918a3bf2bd67ce3310d30ebb2b4d45e9761d3b5384fab1cb0fd447da06e31b9ff4c689da8947816d2cac4b11a8d88984
+  data.tar.gz: 9c206305857025aafeb0d93ec9e46366513a9da37e9eefab6a70b38058cf8ae4dfac24b4495d296be1c7820bee4f5c440dbab0354ae484852d82f8bbfec09620

data/lib/restforce/db/attribute_map.rb

@@ -19,14 +19,9 @@ module Restforce
       # adapter          - An adapter object which should be used to convert
       #                    between data formats.
       def initialize(database_model, salesforce_model, fields = {}, adapter = Adapter.new)
-        @database_model = database_model
-        @salesforce_model = salesforce_model
-        @fields = fields
-        @adapter = adapter
-
-        @types = {
-          database_model   => :database,
-          salesforce_model => :salesforce,
+        @field_maps = {
+          database_model   => AttributeMaps::Database.new(fields, adapter),
+          salesforce_model => AttributeMaps::Salesforce.new(fields),
         }
       end
 
@@ -36,27 +31,12 @@ module Restforce
       #
       # from_format - A String or Class reflecting the record type from which
       #               the attribute Hash is being compiled.
+      # record      - The underlying record for which attributes should be
+      #               collected.
       #
-      # Yields a series of attribute names.
       # Returns a Hash.
-      def attributes(from_format)
-        case @types[from_format]
-        when :salesforce
-          @fields.values.each_with_object({}) do |mapping, values|
-            values[mapping] = yield(mapping)
-          end
-        when :database
-          attributes = @fields.keys.each_with_object({}) do |attribute, values|
-            values[attribute] = yield(attribute)
-          end
-          attributes = @adapter.from_database(attributes)
-
-          @fields.each_with_object({}) do |(attribute, mapping), final|
-            final[mapping] = attributes[attribute]
-          end
-        else
-          raise ArgumentError
-        end
+      def attributes(from_format, record)
+        @field_maps[from_format].attributes(record)
       end
 
       # Public: Convert a Hash of normalized attributes to a format compatible
@@ -83,19 +63,7 @@ module Restforce
       #
       # Returns a Hash.
       def convert(to_format, attributes)
-        case @types[to_format]
-        when :database
-          attributes = @fields.each_with_object({}) do |(attribute, mapping), converted|
-            next unless attributes.key?(mapping)
-            converted[attribute] = attributes[mapping]
-          end
-
-          @adapter.to_database(attributes)
-        when :salesforce
-          attributes.dup
-        else
-          raise ArgumentError
-        end
+        @field_maps[to_format].convert(attributes)
       end
 
     end

data/lib/restforce/db/attribute_maps/database.rb

@@ -0,0 +1,73 @@
+module Restforce
+
+  module DB
+
+    module AttributeMaps
+
+      # Restforce::DB::AttributeMaps::Database encapsulates the logic for
+      # compiling and parsing normalized attribute hashes from/for ActiveRecord
+      # objects.
+      class Database
+
+        # Public: Initialize a Restforce::DB::AttributeMaps::Database.
+        #
+        # fields  - A Hash of mappings between database columns and fields in
+        #           Salesforce.
+        # adapter - An adapter object which should be used to convert between
+        #           data formats.
+        def initialize(fields, adapter = Adapter.new)
+          @fields = fields
+          @adapter = adapter
+        end
+
+        # Public: Build a normalized Hash of attributes from the appropriate set
+        # of mappings. The keys of the resulting mapping Hash will correspond to
+        # the Salesforce field names.
+        #
+        # record - The underlying ActiveRecord object for which attributes
+        #          should be collected.
+        #
+        # Returns a Hash.
+        def attributes(record)
+          attributes = @fields.keys.each_with_object({}) do |attribute, values|
+            values[attribute] = record.send(attribute)
+          end
+          attributes = @adapter.from_database(attributes)
+
+          @fields.each_with_object({}) do |(attribute, mapping), final|
+            final[mapping] = attributes[attribute]
+          end
+        end
+
+        # Public: Convert a Hash of normalized attributes to a format suitable
+        # for consumption by an ActiveRecord object.
+        #
+        # attributes - A Hash of attributes, with keys corresponding to the
+        #              normalized Salesforce attribute names.
+        #
+        # Examples
+        #
+        #   attribute_map = AttributeMaps::Database.new(
+        #     some_key: "SomeField__c",
+        #   )
+        #
+        #   attribute_map.convert(MyClass, "Some_Field__c" => "some value")
+        #   # => { some_key: "some value" }
+        #
+        # Returns a Hash.
+        def convert(attributes)
+          attributes = @fields.each_with_object({}) do |(attribute, mapping), converted|
+            next unless attributes.key?(mapping)
+            converted[attribute] = attributes[mapping]
+          end
+
+          @adapter.to_database(attributes)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/restforce/db/attribute_maps/salesforce.rb

@@ -0,0 +1,62 @@
+module Restforce
+
+  module DB
+
+    module AttributeMaps
+
+      # Restforce::DB::AttributeMaps::Database encapsulates the logic for
+      # compiling and parsing normalized attribute hashes from/for Salesforce
+      # objects.
+      class Salesforce
+
+        # Public: Initialize a Restforce::DB::AttributeMaps::Salesforce.
+        #
+        # fields - A Hash of mappings between database columns and fields in
+        #          Salesforce.
+        def initialize(fields)
+          @fields = fields
+        end
+
+        # Public: Build a normalized Hash of attributes from the appropriate set
+        # of mappings. The keys of the resulting mapping Hash will correspond to
+        # the Salesforce field names.
+        #
+        # record - The underlying Salesforce object for which attributes should
+        #          be collected.
+        #
+        # Returns a Hash.
+        def attributes(record)
+          @fields.values.each_with_object({}) do |mapping, values|
+            values[mapping] = mapping.split(".").inject(record) do |value, portion|
+              value[portion]
+            end
+          end
+        end
+
+        # Public: Convert a Hash of normalized attributes to a format suitable
+        # for consumption by an ActiveRecord object.
+        #
+        # attributes - A Hash of attributes, with keys corresponding to the
+        #              normalized Salesforce attribute names.
+        #
+        # Examples
+        #
+        #   attribute_map = AttributeMaps::Salesforce.new(
+        #     some_key: "SomeField__c",
+        #   )
+        #
+        #   mapping.convert("Object__c", "Some_Field__c" => "some other value")
+        #   # => { "Some_Field__c" => "some other value" }
+        #
+        # Returns a Hash.
+        def convert(attributes)
+          attributes.dup
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/restforce/db/instances/base.rb

@@ -37,7 +37,7 @@ module Restforce
         #
         # Returns a Hash.
         def attributes
-          @mapping.attributes(@record_type) { |attribute| record.send(attribute) }
+          @mapping.attributes(@record_type, record)
         end
 
         # Public: Has this record been synced with Salesforce?

data/lib/restforce/db/version.rb

@@ -3,7 +3,7 @@ module Restforce
   # :nodoc:
   module DB
 
-    VERSION = "3.3.0"
+    VERSION = "3.4.0"
 
   end
 

data/lib/restforce/db.rb

@@ -19,6 +19,9 @@ require "restforce/db/associations/foreign_key"
 require "restforce/db/associations/has_many"
 require "restforce/db/associations/has_one"
 
+require "restforce/db/attribute_maps/database"
+require "restforce/db/attribute_maps/salesforce"
+
 require "restforce/db/field_processor"
 require "restforce/db/instances/base"
 require "restforce/db/instances/active_record"

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

@@ -23,23 +23,19 @@ describe Restforce::DB::AttributeMap do
     end
 
     it "builds a normalized Hash of database attribute values" do
-      attributes = attribute_map.attributes(database_model) do |attribute|
-        expect(mapping.database_fields.include?(attribute)).to_equal true
-        attribute
-      end
+      record = Hashie::Mash.new(column_one: "Eenie", column_two: "Meenie")
+      attributes = attribute_map.attributes(database_model, record)
 
       expect(attributes.keys).to_equal(mapping.salesforce_fields)
-      expect(attributes.values).to_equal(mapping.database_fields)
+      expect(attributes.values).to_equal(%w(Eenie Meenie))
     end
 
     it "builds a normalized Hash of Salesforce field values" do
-      attributes = attribute_map.attributes(salesforce_model) do |attribute|
-        expect(mapping.salesforce_fields.include?(attribute)).to_equal true
-        attribute
-      end
+      record = Hashie::Mash.new("SF_Field_One__c" => "Minie", "SF_Field_Two__c" => "Moe")
+      attributes = attribute_map.attributes(salesforce_model, record)
 
       expect(attributes.keys).to_equal(mapping.salesforce_fields)
-      expect(attributes.values).to_equal(mapping.salesforce_fields)
+      expect(attributes.values).to_equal(%w(Minie Moe))
     end
   end
 
@@ -55,19 +51,6 @@ describe Restforce::DB::AttributeMap do
         fields.key(attributes.keys.first) => attributes.values.first,
       )
     end
-
-    describe "when an adapter has been specified" do
-      let(:adapter) { boolean_adapter }
-
-      it "uses the adapter to convert attributes to a database-compatible form" do
-        expect(attribute_map.convert(database_model, "SF_Field_One__c" => "Yes")).to_equal(
-          column_one: true,
-        )
-        expect(attribute_map.convert(database_model, "SF_Field_One__c" => "No")).to_equal(
-          column_one: false,
-        )
-      end
-    end
   end
 
 end

data/test/lib/restforce/db/attribute_maps/database_test.rb

@@ -0,0 +1,51 @@
+require_relative "../../../../test_helper"
+
+describe Restforce::DB::AttributeMaps::Database do
+
+  configure!
+
+  let(:adapter) { Restforce::DB::Adapter.new }
+  let(:attribute_map) { Restforce::DB::AttributeMaps::Database.new(fields, adapter) }
+  let(:fields) do
+    {
+      column_one: "SF_Field_One__c",
+      column_two: "SF_Field_Two__c",
+    }
+  end
+
+  describe "#attributes" do
+
+    it "builds a normalized Hash of database attribute values" do
+      record = Hashie::Mash.new(column_one: "Winkin", column_two: "Blinkin")
+      attributes = attribute_map.attributes(record)
+
+      expect(attributes.keys).to_equal(fields.values)
+      expect(attributes.values).to_equal(%w(Winkin Blinkin))
+    end
+  end
+
+  describe "#convert" do
+    let(:attributes) { { "SF_Field_One__c" => "some value" } }
+
+    it "converts an attribute Hash to a database-compatible form" do
+      expect(attribute_map.convert(attributes)).to_equal(
+        fields.key(attributes.keys.first) => attributes.values.first,
+      )
+    end
+
+    describe "when an adapter has been specified" do
+      let(:adapter) { boolean_adapter }
+
+      it "uses the adapter to convert attributes to a database-compatible form" do
+        expect(attribute_map.convert("SF_Field_One__c" => "Yes")).to_equal(
+          column_one: true,
+        )
+        expect(attribute_map.convert("SF_Field_One__c" => "No")).to_equal(
+          column_one: false,
+        )
+      end
+
+    end
+  end
+
+end

data/test/lib/restforce/db/attribute_maps/salesforce_test.rb

@@ -0,0 +1,54 @@
+require_relative "../../../../test_helper"
+
+describe Restforce::DB::AttributeMaps::Salesforce do
+
+  configure!
+
+  let(:attribute_map) { Restforce::DB::AttributeMaps::Salesforce.new(fields) }
+  let(:fields) do
+    {
+      column_one: "SF_Field_One__c",
+      column_two: "SF_Field_Two__c",
+    }
+  end
+
+  describe "#attributes" do
+
+    it "builds a normalized Hash of Salesforce attribute values" do
+      record = Hashie::Mash.new("SF_Field_One__c" => "Winkin", "SF_Field_Two__c" => "Blinkin")
+      attributes = attribute_map.attributes(record)
+
+      expect(attributes.keys).to_equal(fields.values)
+      expect(attributes.values).to_equal(%w(Winkin Blinkin))
+    end
+
+    describe "for a mapping requiring Salesforce association traversal" do
+      let(:fields) do
+        {
+          name: "Name",
+          friend_name: "Friend__r.Name",
+        }
+      end
+
+      it "builds a flattened normalized Hash of Salesforce attribute values" do
+        record = Hashie::Mash.new(
+          "Name" => "Turner",
+          "Friend__r" => { "Name" => "Hooch" },
+        )
+        attributes = attribute_map.attributes(record)
+
+        expect(attributes.keys).to_equal(fields.values)
+        expect(attributes.values).to_equal(%w(Turner Hooch))
+      end
+    end
+  end
+
+  describe "#convert" do
+    let(:attributes) { { "SF_Field_One__c" => "some value" } }
+
+    it "doesn't perform any special modification of the passed attribute Hash" do
+      expect(attribute_map.convert(attributes)).to_equal(attributes)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -218,6 +218,8 @@ files:
 - lib/restforce/db/associator.rb
 - lib/restforce/db/attacher.rb
 - lib/restforce/db/attribute_map.rb
+- lib/restforce/db/attribute_maps/database.rb
+- lib/restforce/db/attribute_maps/salesforce.rb
 - lib/restforce/db/cleaner.rb
 - lib/restforce/db/client.rb
 - lib/restforce/db/collector.rb
@@ -341,6 +343,8 @@ files:
 - test/lib/restforce/db/associator_test.rb
 - test/lib/restforce/db/attacher_test.rb
 - test/lib/restforce/db/attribute_map_test.rb
+- test/lib/restforce/db/attribute_maps/database_test.rb
+- test/lib/restforce/db/attribute_maps/salesforce_test.rb
 - test/lib/restforce/db/cleaner_test.rb
 - test/lib/restforce/db/collector_test.rb
 - test/lib/restforce/db/configuration_test.rb