Merge pull request #463 from AlexGascon/master

Raising UnknownAttribute when adding an attribute not in the model

Author: andrykonchin

lib/dynamoid/errors.rb

@@ -75,5 +75,7 @@ def initialize(document)
     class InvalidQuery < Error; end
 
     class UnsupportedKeyType < Error; end
+
+    class UnknownAttribute < Error; end
   end
 end

lib/dynamoid/fields.rb

@@ -309,6 +309,10 @@ def warn_about_method_overriding(method_name, field_name)
     def write_attribute(name, value)
       name = name.to_sym
 
+      unless attribute_is_present_on_model?(name)
+        raise Dynamoid::Errors::UnknownAttribute.new("Attribute #{name} is not part of the model")
+      end
+
       if association = @associations[name]
         association.reset
       end
@@ -405,5 +409,10 @@ def set_inheritance_field
         send("#{type}=", self.class.name)
       end
     end
+
+    def attribute_is_present_on_model?(attribute_name)
+      setter = "#{attribute_name}=".to_sym
+      respond_to?(setter)
+    end
   end
 end

lib/dynamoid/persistence.rb

@@ -8,6 +8,7 @@
 require 'dynamoid/persistence/update_fields'
 require 'dynamoid/persistence/upsert'
 require 'dynamoid/persistence/save'
+require 'dynamoid/persistence/update_validations'
 
 # encoding: utf-8
 module Dynamoid
@@ -276,6 +277,9 @@ def update!(hash_key, range_key_value = nil, attrs)
       # +update_fields+ uses the +UpdateItem+ operation so it saves changes and
       # loads an updated document back with one HTTP request.
       #
+      # Raises a +Dynamoid::Errors::UnknownAttribute+ exception if any of the
+      # attributes is not on the model
+      #
       # @param hash_key_value [Scalar value] hash key
       # @param range_key_value [Scalar value] range key (optional)
       # @param attrs [Hash]
@@ -324,6 +328,9 @@ def update_fields(hash_key_value, range_key_value = nil, attrs = {}, conditions
       # +upsert+ uses the +UpdateItem+ operation so it saves changes and loads
       # an updated document back with one HTTP request.
       #
+      # Raises a +Dynamoid::Errors::UnknownAttribute+ exception if any of the
+      # attributes is not on the model
+      #
       # @param hash_key_value [Scalar value] hash key
       # @param range_key_value [Scalar value] range key (optional)
       # @param attrs [Hash]
@@ -491,6 +498,9 @@ def save(options = {})
     #
     #   user.update_attributes(age: 27, last_name: 'Tylor')
     #
+    # Raises a +Dynamoid::Errors::UnknownAttribute+ exception if any of the
+    # attributes is not on the model
+    #
     # @param attributes [Hash] a hash of attributes to update
     # @return [true|false] Whether updating successful or not
     # @since 0.2.0
@@ -507,6 +517,9 @@ def update_attributes(attributes)
     # Raises a +Dynamoid::Errors::DocumentNotValid+ exception if some vaidation
     # fails.
     #
+    # Raises a +Dynamoid::Errors::UnknownAttribute+ exception if any of the
+    # attributes is not on the model
+    #
     # @param attributes [Hash] a hash of attributes to update
     def update_attributes!(attributes)
       attributes.each { |attribute, value| write_attribute(attribute, value) }
@@ -519,6 +532,9 @@ def update_attributes!(attributes)
     #
     #   user.update_attribute(:last_name, 'Tylor')
     #
+    # Raises a +Dynamoid::Errors::UnknownAttribute+ exception if any of the
+    # attributes is not on the model
+    #
     # @param attribute [Symbol] attribute name to update
     # @param value [Object] the value to assign it
     # @return [Dynamoid::Document] self

lib/dynamoid/persistence/update_fields.rb

@@ -17,6 +17,8 @@ def initialize(model_class, partition_key:, sort_key:, attributes:, conditions:)
       end
 
       def call
+        UpdateValidations.validate_attributes_exist(@model_class, @attributes)
+
         if Dynamoid::Config.timestamps
           @attributes[:updated_at] ||= DateTime.now.in_time_zone(Time.zone)
         end

lib/dynamoid/persistence/update_validations.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dynamoid
+  module Persistence
+    # @private
+    module UpdateValidations
+      def self.validate_attributes_exist(model_class, attributes)
+        model_attributes = model_class.attributes.keys
+
+        attributes.each do |attr_name, _|
+          unless model_attributes.include?(attr_name)
+            raise Dynamoid::Errors::UnknownAttribute.new("Attribute #{attr_name} does not exist in #{model_class}")
+          end
+        end
+      end
+    end
+  end
+end

lib/dynamoid/persistence/upsert.rb

@@ -17,6 +17,8 @@ def initialize(model_class, partition_key:, sort_key:, attributes:, conditions:)
       end
 
       def call
+        UpdateValidations.validate_attributes_exist(@model_class, @attributes)
+
         if Dynamoid::Config.timestamps
           @attributes[:updated_at] ||= DateTime.now.in_time_zone(Time.zone)
         end

spec/dynamoid/fields_spec.rb

@@ -381,5 +381,13 @@ def name=(str)
         expect(obj.attributes[:count]).to eql(101)
       end
     end
+
+    it 'raises an UnknownAttribute error if the attribute is not on the model' do
+      obj = new_class.new
+
+      expect {
+        obj.write_attribute(:name, 'Alex')
+      }.to raise_error Dynamoid::Errors::UnknownAttribute
+    end
   end
 end

spec/dynamoid/persistence_spec.rb

@@ -928,6 +928,17 @@ def log_message
       end.to change { d.reload.name }.to('[Updated]')
     end
 
+    it 'raises an UnknownAttribute error when adding an attribute that is not on the model' do
+      klass = new_class do
+        field :name
+      end
+
+      obj = klass.create(name: 'Alex')
+      expect {
+        klass.update!(obj.id, age: 26)
+      }.to raise_error Dynamoid::Errors::UnknownAttribute
+    end
+
     describe 'timestamps' do
       it 'sets updated_at if Config.timestamps=true', config: { timestamps: true } do
         d = document_class.create(name: 'Document#1')
@@ -1047,6 +1058,18 @@ def log_message
       end.to change { d.reload.name }.to('[Updated]')
     end
 
+    it 'raises an UnknownAttribute error when adding an attribute that is not on the model' do
+      klass = new_class do
+        field :name
+      end
+
+      obj = klass.create(name: 'Alex')
+
+      expect do
+        klass.update(obj.id, name: 'New name', age: 26)
+      end.to raise_error Dynamoid::Errors::UnknownAttribute
+    end
+
     describe 'timestamps' do
       it 'sets updated_at if Config.timestamps=true', config: { timestamps: true } do
         d = document_class.create(name: 'Document#1')
@@ -1278,6 +1301,14 @@ def log_message
         expect(klass.find(a.id)[:hash]).to eql('1': 'b')
       end
     end
+
+    it 'raises an UnknownAttribute error when adding an attribute that is not on the model' do
+      obj = document_class.create(title: 'New Document')
+
+      expect {
+        document_class.update_fields(obj.id, { title: 'New title', publisher: 'New publisher' } )
+      }.to raise_error Dynamoid::Errors::UnknownAttribute
+    end
   end
 
   describe '.upsert' do
@@ -1455,6 +1486,14 @@ def log_message
         expect(klass.find(a.id)[:hash]).to eql('1': 'b')
       end
     end
+
+    it 'raises an UnknownAttribute error when adding an attribute that is not on the model' do
+      obj = document_class.create(title: 'New Document')
+
+      expect {
+        document_class.upsert(obj.id, { title: 'New title', publisher: 'New publisher' } )
+      }.to raise_error Dynamoid::Errors::UnknownAttribute
+    end
   end
 
   describe '.inc' do
@@ -1977,6 +2016,19 @@ def log_message
         end.not_to raise_error
       end
     end
+
+    it 'raises an UnknownAttribute error when adding an attribute that is not on the model' do
+      klass = new_class do
+        field :age, :integer
+        field :name, :string
+      end
+
+      obj = klass.create!(name: 'Alex', age: 26)
+
+      expect {
+        obj.update_attribute(:city, 'Dublin')
+      }.to raise_error(Dynamoid::Errors::UnknownAttribute)
+    end
   end
 
   describe '#update_attributes' do
@@ -2068,6 +2120,14 @@ def log_message
         end.not_to raise_error
       end
     end
+
+    it 'raises an UnknownAttribute error when adding an attribute that is not on the model' do
+      obj = klass.create!(name: 'Alex', age: 26)
+
+      expect {
+        obj.update_attributes!(city: 'Dublin', age: 27)
+      }.to raise_error(Dynamoid::Errors::UnknownAttribute)
+    end
   end
 
   describe '#update_attributes!' do
@@ -2110,6 +2170,14 @@ def log_message
       expect(klass.find(obj.id).age).to eql 26
     end
 
+    it 'raises an UnknownAttribute error when adding an attribute that is not on the model' do
+      obj = klass.create!(name: 'Alex', age: 26)
+
+      expect {
+        obj.update_attributes!(city: 'Dublin', age: 27)
+      }.to raise_error(Dynamoid::Errors::UnknownAttribute)
+    end
+
     describe 'type casting' do
       it 'type casts attributes' do
         klass = new_class do