protip 0.18.2 → 0.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b37a5ba7e9e56a626b357a5ccc3ffc7f476e4df4
-  data.tar.gz: 45f60bb6fdfe7e6d2119ef418313d614b02fc554
+  metadata.gz: 8b3cc36d1a0119a9d6a0c7aa985ef1c7ec9d0c80
+  data.tar.gz: 1172ca37789032767087b77783d8f274bac71e6e
 SHA512:
-  metadata.gz: 84348345f6f1a671badc27cacaf9a310f3bfaa10c86b8697d25c33b5b1de0278552736962b2070579ab2185a08805437bcaf6c3c4cb2bd6f4a0f1c57d5d1e2e9
-  data.tar.gz: d010f3a673368d5b941be895465b359db1335bb5d077995dea3935e9c1bf6c6f25cdc64348364ff09d9bdd335559e149a762ad256d6ab34da6b3e030b404d1bd
+  metadata.gz: 50fc9db60514ea58304d94e2b16ba3c9d565a748b9163ea0f1ef676a9d85c7d2b04355c9a3a92df812fb778d599b6631be9c8da79f1a2a9e0bcc082ca872c2ff
+  data.tar.gz: 1f3adf1b6aab2af7a433d9ab3257f584ea8fbaadf8126578b44248d83733bdfdb331ce508bab4c4ff748c45bd4cdc16c3bbc37c2810789308d2cd51cb9e4fb13

data/lib/protip/resource.rb

@@ -50,6 +50,10 @@ module Protip
 
       def_delegator :@wrapper, :message
       def_delegator :@wrapper, :as_json
+
+      # Initialize housekeeping variables
+      @belongs_to_associations = Set.new
+      @belongs_to_polymorphic_associations = Set.new
     end
 
     module ClassMethods
@@ -58,7 +62,7 @@ module Protip
 
       attr_accessor :client
 
-      attr_reader :message, :nested_resources
+      attr_reader :message, :nested_resources, :belongs_to_associations, :belongs_to_polymorphic_associations
 
       attr_writer :base_path, :converter
 
@@ -210,6 +214,7 @@ module Protip
       def belongs_to(association_name, options = {})
         association = ::Protip::Resource::Associations::BelongsToAssociation.new(self, association_name, options)
         association.define_accessors!
+        @belongs_to_associations.add association
         association
       end
 
@@ -233,6 +238,7 @@ module Protip
         association = ::Protip::Resource::Associations::BelongsToPolymorphicAssociation.new self,
           association_name, nested_association_creator.associations, options
         association.define_accessors!
+        @belongs_to_polymorphic_associations.add association
         association
       end
 

data/lib/protip/resource/associations/belongs_to_polymorphic_association.rb

@@ -7,18 +7,18 @@ module Protip
       class BelongsToPolymorphicAssociation
 
         include Protip::Resource::Associations::Association
-        attr_reader :resource_class, :association_name, :id_field
+        attr_reader :resource_class, :association_name, :id_field, :belongs_to_associations
 
         # Define a polymorphic association based on a one-of field. The options for the oneof must all be IDs with
         # an associated +Protip::Resource::Associations::BelongsToAssociation+ that's already been created.
         #
         # @param [Class] resource_class The +Protip::Resource+ class that holds a reference to an associated object.
         # @param [String] association_name The name to use when defining accessors for the associated object.
-        # @param [Array<Protip::Resource::Associations::BelongsToAssociation>] nested_associations The individual
-        #   associations corresponding to the fields within the `oneof`.
+        # @param [Enumerable<Protip::Resource::Associations::BelongsToAssociation>] belongs_to_associations The
+        #   individual associations corresponding to the fields within the `oneof`.
         # @param [Symbol|String] id_field The name of the `oneof` field that holds the association ID. Defaults to
         #   `#{association_name}_id`.
-        def initialize(resource_class, association_name, nested_associations, id_field: nil)
+        def initialize(resource_class, association_name, belongs_to_associations, id_field: nil)
           # The class where accessors will be defined
           @resource_class = resource_class
 
@@ -28,30 +28,32 @@ module Protip
           # The oneof field that holds the ID of the foreign resource
           @id_field  = (id_field ||
             Protip::Resource::Associations::BelongsToAssociation.default_id_field(association_name)).to_sym
-          @oneof = @resource_class.message.descriptor.lookup_oneof(@id_field.to_s)
-          raise "Invalid field name for polymorphic association: #{@id_field}" unless @oneof
+          @_oneof = @resource_class.message.descriptor.lookup_oneof(@id_field.to_s)
+          raise "Invalid field name for polymorphic association: #{@id_field}" unless @_oneof
+
 
           # Internally, keep the nested associations indexed by ID field
-          @_nested_associations = {}
-          nested_associations.each do |association|
-            if @_nested_associations.has_key? association.id_field.to_sym
+          @_indexed_belongs_to_associations = {}
+          belongs_to_associations.each do |association|
+            if @_indexed_belongs_to_associations.has_key? association.id_field.to_sym
               raise ArgumentError.new("Duplicate association for #{id_field}")
             end
-            @_nested_associations[association.id_field.to_sym] = association
+            @_indexed_belongs_to_associations[association.id_field.to_sym] = association
           end
-          field_names = @oneof.map{|desc| desc.name.to_sym}
-          unless (field_names.length == @_nested_associations.length &&
-            @_nested_associations.keys.all?{|id_field| field_names.include? id_field})
+          field_names = @_oneof.map{|desc| desc.name.to_sym}
+          unless (field_names.length == @_indexed_belongs_to_associations.length &&
+            @_indexed_belongs_to_associations.keys.all?{|id_field| field_names.include? id_field})
             raise ArgumentError.new(
               'Polymorphic association requires an association to be defined for all nested fields'
             )
           end
+          @belongs_to_associations = Set.new(belongs_to_associations)
         end
 
         def read(resource)
           field = resource.message.public_send(id_field)
           if field
-            @_nested_associations[field].read(resource)
+            @_indexed_belongs_to_associations[field].read(resource)
           else
             nil
           end
@@ -59,28 +61,28 @@ module Protip
 
         def write(resource, value)
           if value == nil
-            @oneof.each do |field_descriptor|
+            @_oneof.each do |field_descriptor|
               resource.public_send(:"#{field_descriptor.name}=", nil)
             end
             nil
           else
             # Find the nested reference matching this association type
-            matching_references = @_nested_associations.select do |id_field, reference|
-              value.is_a? reference.associated_resource_class
+            matching_associations = belongs_to_associations.select do |association|
+              value.is_a? association.associated_resource_class
             end
 
             # Make sure we found exactly one
-            if matching_references.empty?
+            if matching_associations.empty?
               raise ArgumentError.new("Could not find matching reference for value of type #{value.class}")
             end
-            if matching_references.length > 1
+            if matching_associations.length > 1
               raise ArgumentError.new(
                       "Value of type #{value.class} matched with #{matching_references.keys.map(&:to_s).join(', ')}"
                     )
             end
 
             # And forward the write operation
-            matching_references.values.first.write(resource, value)
+            matching_associations.first.write(resource, value)
           end
         end
       end

data/test/unit/protip/resource/associations/belongs_to_polymorphic_association_test.rb

@@ -70,6 +70,14 @@ describe Protip::Resource::Associations::BelongsToPolymorphicAssociation do
        :foo, [rick_ross_association, fetty_wap_association], id_field: :reference_id
       assert_equal :reference_id, association.id_field
     end
+
+    it 'stores the nested belongs-to associations' do
+      association = Protip::Resource::Associations::BelongsToPolymorphicAssociation.new resource_class,
+        :reference, [rick_ross_association, fetty_wap_association]
+      assert_equal 2, association.belongs_to_associations.length
+      assert_includes association.belongs_to_associations, rick_ross_association
+      assert_includes association.belongs_to_associations, fetty_wap_association
+    end
   end
 
   describe '(accessors)' do

data/test/unit/protip/resource_test.rb

@@ -882,6 +882,18 @@ module Protip::ResourceTest # Namespace for internal constants
           assert_equal association, resource_class.instance_variable_get(:'@result'), 'association was not returned'
         end
 
+        it 'stores the created association' do
+          association_class.expects(:new).once.returns(association)
+          resource_class.class_exec(method) { |method| send method, :association_name, &block }
+          assert_includes resource_class.public_send(:"#{method}_associations"), association
+        end
+
+        it 'initializes the set of associations to the empty set' do
+          stored_associations = resource_class.public_send(:"#{method}_associations")
+          assert_instance_of Set, stored_associations
+          assert_empty stored_associations
+        end
+
         it 'raises an error on invalid options' do
           error = assert_raises ArgumentError do
             resource_class.class_exec(method) do |method|
@@ -935,31 +947,6 @@ module Protip::ResourceTest # Namespace for internal constants
         Protip::Resource::Associations::BelongsToPolymorphicAssociation) { }
     end
 
-    # {
-    #   references_through_one_of: Protip::Resource::Associations::ReferencesThroughOneOfAssociation,
-    # }.each do |method, association_class|
-    #   describe ".#{method}" do
-    #     it 'creates an association of the correct type and defines accessors' do
-    #       association = mock.responds_like_instance_of(association_class)
-    #       association_class.expects(:new).once.with(resource_class, :some_id, {class_name: 'Foo'}).returns(association)
-    #       association.expects(:define_accessors!)
-    #       resource_class.class_exec(method) do
-    #         send(method, :some_id, class_name: 'Foo')
-    #       end
-    #     end
-    #
-    #     it 'raises an error on invalid options' do
-    #       error = assert_raises ArgumentError do
-    #         resource_class.class_exec(method) do
-    #           send(method, :some_id, bad_option: 'bad')
-    #         end
-    #       end
-    #
-    #       assert_match /bad_option/, error.message
-    #     end
-    #   end
-    # end
-
     describe '.converter' do
       describe 'default value' do
         it 'defaults to the standard converter' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protip
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.18.3
 platform: ruby
 authors:
 - AngelList
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel