duck_record 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06bf2457884cf16768ed22c8eab54c06cd03e59d
-  data.tar.gz: 2b9fdb3b1e20e91e52e2e553f061302f777d2885
+  metadata.gz: 26cdafb4677192d3b19b66b6c691f739e6dc70ae
+  data.tar.gz: 5c1e47c06bece7781a4812389dbc7218ae240ed1
 SHA512:
-  metadata.gz: 42bfba1df7380612fa22a300225f8e75e46e14bccc565c7c1e403105d7b6bba293376e32e08a6a74fd7c47a21120c5a86ef836eabde8a23bac818eb7b80817b1
-  data.tar.gz: '095d81f5ac4b851f3989f6bba870e0dd30cbf2c4542968183dc4e963fcc6a2162deb0956519ff9b9f1205acad6baa5fcb61f9de42db9de4f23d9935ead1ac449'
+  metadata.gz: ddf042c24da96f908e7dcb8183566574a7208e02da658e8cf023a8e729e63019a9a659c66a7f782ed8055842f7b45ac5fa74a690bd3d91b2e6901e428a474ee6
+  data.tar.gz: 6a63e7f449a1815fc742fc93530f90407645bb6d1b51ff5382dc4b6102e4dacd4eeb113b82a49c8125e972289a5ab8c856680dc0ceeabe9db927458c8e47a6ba

data/lib/duck_record/attribute_assignment.rb

@@ -1,18 +1,29 @@
+require 'active_support/core_ext/hash/keys'
 require 'active_model/forbidden_attributes_protection'
 
 module DuckRecord
   module AttributeAssignment
     extend ActiveSupport::Concern
-    include ActiveModel::AttributeAssignment
+    include ActiveModel::ForbiddenAttributesProtection
 
     # Alias for ActiveModel::AttributeAssignment#assign_attributes. See ActiveModel::AttributeAssignment.
-    def attributes=(attributes)
-      assign_attributes(attributes)
+    def attributes=(attributes, force_write_readonly: false)
+      assign_attributes(attributes, force_write_readonly: force_write_readonly)
+    end
+
+    def assign_attributes(new_attributes, force_write_readonly: false)
+      unless new_attributes.respond_to?(:stringify_keys)
+        raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
+      end
+      return if new_attributes.nil? || new_attributes.empty?
+
+      attributes = new_attributes.stringify_keys
+      _assign_attributes(sanitize_for_mass_assignment(attributes), force_write_readonly: force_write_readonly)
     end
 
     private
 
-    def _assign_attributes(attributes)
+    def _assign_attributes(attributes, force_write_readonly: false)
       multi_parameter_attributes  = {}
       nested_parameter_attributes = {}
 
@@ -23,15 +34,23 @@ module DuckRecord
           nested_parameter_attributes[k] = attributes.delete(k)
         end
       end
-      super(attributes)
 
-      assign_nested_parameter_attributes(nested_parameter_attributes) unless nested_parameter_attributes.empty?
-      assign_multiparameter_attributes(multi_parameter_attributes) unless multi_parameter_attributes.empty?
+      attributes.each do |k, v|
+        _assign_attribute(k, v, force_write_readonly: force_write_readonly)
+      end
+
+      unless nested_parameter_attributes.empty?
+        assign_nested_parameter_attributes(nested_parameter_attributes, force_write_readonly: force_write_readonly)
+      end
+
+      unless multi_parameter_attributes.empty?
+        assign_multiparameter_attributes(multi_parameter_attributes, force_write_readonly: force_write_readonly)
+      end
     end
 
     # Assign any deferred nested attributes after the base attributes have been set.
-    def assign_nested_parameter_attributes(pairs)
-      pairs.each { |k, v| _assign_attribute(k, v) }
+    def assign_nested_parameter_attributes(pairs, force_write_readonly: false)
+      pairs.each { |k, v| _assign_attribute(k, v, force_write_readonly: force_write_readonly) }
     end
 
     # Instantiates objects for all attribute classes that needs more than one constructor parameter. This is done
@@ -40,13 +59,14 @@ module DuckRecord
     # written_on (a date type) with Date.new("2004", "6", "24"). You can also specify a typecast character in the
     # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Integer and
     # f for Float. If all the values for a given attribute are empty, the attribute will be set to +nil+.
-    def assign_multiparameter_attributes(pairs)
+    def assign_multiparameter_attributes(pairs, force_write_readonly: false)
       execute_callstack_for_multiparameter_attributes(
-        extract_callstack_for_multiparameter_attributes(pairs)
+        extract_callstack_for_multiparameter_attributes(pairs),
+        force_write_readonly: force_write_readonly
       )
     end
 
-    def execute_callstack_for_multiparameter_attributes(callstack)
+    def execute_callstack_for_multiparameter_attributes(callstack, force_write_readonly: false)
       errors = []
       callstack.each do |name, values_with_empty_parameters|
         begin
@@ -55,7 +75,7 @@ module DuckRecord
           else
             values = values_with_empty_parameters
           end
-          send("#{name}=", values)
+          send("#{name}=", values, force_write_readonly: force_write_readonly)
         rescue => ex
           errors << AttributeAssignmentError.new("error on assignment #{values_with_empty_parameters.values.inspect} to #{name} (#{ex.message})", ex, name)
         end
@@ -87,5 +107,13 @@ module DuckRecord
     def find_parameter_position(multiparameter_name)
       multiparameter_name.scan(/\(([0-9]*).*\)/).first.first.to_i
     end
+
+    def _assign_attribute(k, v, force_write_readonly: false)
+      if respond_to?("#{k}=")
+        public_send("#{k}=", v, force_write_readonly: force_write_readonly)
+      else
+        raise UnknownAttributeError.new(self, k)
+      end
+    end
   end
 end

data/lib/duck_record/attribute_methods/write.rb

@@ -15,9 +15,9 @@ module DuckRecord
           DuckRecord::AttributeMethods::AttrNames.set_name_cache safe_name, name
 
           generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
-            def __temp__#{safe_name}=(value)
+            def __temp__#{safe_name}=(value, force_write_readonly: false)
               name = ::DuckRecord::AttributeMethods::AttrNames::ATTR_#{safe_name}
-              write_attribute(name, value)
+              write_attribute(name, value, force_write_readonly: force_write_readonly)
             end
             alias_method #{(name + '=').inspect}, :__temp__#{safe_name}=
             undef_method :__temp__#{safe_name}=
@@ -28,30 +28,32 @@ module DuckRecord
       # Updates the attribute identified by <tt>attr_name</tt> with the
       # specified +value+. Empty strings for Integer and Float columns are
       # turned into +nil+.
-      def write_attribute(attr_name, value)
+      def write_attribute(attr_name, value, force_write_readonly: false)
         name = if self.class.attribute_alias?(attr_name)
-          self.class.attribute_alias(attr_name).to_s
-        else
-          attr_name.to_s
-        end
+                 self.class.attribute_alias(attr_name).to_s
+               else
+                 attr_name.to_s
+               end
 
-        write_attribute_with_type_cast(name, value, true)
+        write_attribute_with_type_cast(name, value, true, force_write_readonly: force_write_readonly)
       end
 
-      def raw_write_attribute(attr_name, value) # :nodoc:
-        write_attribute_with_type_cast(attr_name, value, false)
+      def raw_write_attribute(attr_name, value, force_write_readonly: false) # :nodoc:
+        write_attribute_with_type_cast(attr_name, value, false, force_write_readonly: force_write_readonly)
       end
 
       private
 
       # Handle *= for method_missing.
-      def attribute=(attribute_name, value)
-        write_attribute(attribute_name, value)
+      def attribute=(attribute_name, value, force_write_readonly: false)
+        write_attribute(attribute_name, value, force_write_readonly: force_write_readonly)
       end
 
-      def write_attribute_with_type_cast(attr_name, value, should_type_cast)
+      def write_attribute_with_type_cast(attr_name, value, should_type_cast, force_write_readonly: false)
         attr_name = attr_name.to_s
 
+        return if !force_write_readonly && self.class.readonly_attributes.include?(attr_name)
+
         if should_type_cast
           @attributes.write_from_user(attr_name, value)
         else

data/lib/duck_record/base.rb

@@ -276,6 +276,7 @@ module DuckRecord #:nodoc:
     extend Translation
 
     include Core
+    include ReadonlyAttributes
     include ModelSchema
     include Inheritance
     include AttributeAssignment

data/lib/duck_record/core.rb

@@ -66,7 +66,7 @@ module DuckRecord
       initialize_internals_callback
 
       if attributes
-        assign_attributes(attributes)
+        assign_attributes(attributes, force_write_readonly: true)
         clear_changes_information
       end
 

data/lib/duck_record/readonly_attributes.rb

@@ -0,0 +1,23 @@
+module DuckRecord
+  module ReadonlyAttributes
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_attr_readonly, instance_accessor: false
+      self._attr_readonly = []
+    end
+
+    module ClassMethods
+      # Attributes listed as readonly will be used to create a new record but update operations will
+      # ignore these fields.
+      def attr_readonly(*attributes)
+        self._attr_readonly = Set.new(attributes.map(&:to_s)) + (_attr_readonly || [])
+      end
+
+      # Returns an array of all the attributes that have been specified as readonly.
+      def readonly_attributes
+        _attr_readonly
+      end
+    end
+  end
+end

data/lib/duck_record/version.rb

@@ -1,3 +1,3 @@
 module DuckRecord
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/duck_record.rb

@@ -15,6 +15,7 @@ module DuckRecord
   autoload :Inheritance
   autoload :ModelSchema
   autoload :NestedAttributes
+  autoload :ReadonlyAttributes
   autoload :Reflection
   autoload :Serialization
   autoload :Translation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duck_record
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - jasl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,6 +100,7 @@ files:
 - lib/duck_record/model_schema.rb
 - lib/duck_record/nested_attributes.rb
 - lib/duck_record/nested_validate_association.rb
+- lib/duck_record/readonly_attributes.rb
 - lib/duck_record/reflection.rb
 - lib/duck_record/serialization.rb
 - lib/duck_record/translation.rb