form_obj 0.4.0 → 0.5.0

data/Rakefile

@@ -1,6 +1,13 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 require "rspec/core/rake_task"
 
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+# task :default => :test

data/form_obj.gemspec

@@ -33,13 +33,14 @@ well as serialized to a hash which reflects a model. ActiveModel::Errors could b
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "typed_array", ">= 1.0.1"
+  spec.add_dependency "typed_array", ">= 1.0.2"
   spec.add_dependency "activemodel", ">= 3.2"
   spec.add_dependency "activesupport", ">= 3.2"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "actionpack", ">= 3.2"
   spec.add_development_dependency "appraisal"
 end

data/lib/form_obj/form/array.rb

@@ -1,35 +1,35 @@
 module FormObj
   class Form < FormObj::Struct
     class Array < FormObj::Struct::Array
-      def update_attributes(vals)
-        ids_exists = []
-        items_to_add = []
+      def persisted?
+        all?(&:persisted?)
+      end
 
-        vals.each do |val|
-          id = primary_key(val)
-          item = self.find { |i| i.primary_key == id }
-          if item
-            item.update_attributes(val)
-            ids_exists << id
-          else
-            items_to_add << val
-          end
-        end
+      def mark_as_persisted
+        each(&:mark_as_persisted)
+      end
 
-        ids_to_remove = self.map(&:primary_key) - ids_exists
-        self.delete_if { |item| ids_to_remove.include? item.primary_key }
+      def mark_for_destruction
+        each(&:mark_for_destruction)
+      end
 
-        items_to_add.each do |item|
-          self.create.update_attributes(item)
-        end
+      private
 
-        sort! { |a, b| vals.index { |val| primary_key(val) == a.primary_key } <=> vals.index { |val| primary_key(val) == b.primary_key } }
+      # items_to_add - array of hashes of new attribute values
+      # items_to_update - hash where key is the item to update and value is a hash of new attribute values
+      def items_for_destruction(items_to_add:, items_to_update:)
+        items_to_update.select { |item, attr_values| attr_values[:_destroy] }.keys
       end
 
-      private
+      # items - array of items to be destroyed
+      def destroy_items(items)
+        items.each(&:mark_for_destruction)
+      end
 
-      def primary_key(hash)
-        hash.key?(item_class.primary_key.to_sym) ? hash[item_class.primary_key.to_sym] : hash[item_class.primary_key.to_s]
+      # items - hash where key is the item to update and value is a hash of new attribute values
+      # params - additional params for :update_attributes method
+      def update_items(items, params)
+        items.each_pair { |item, attr_values| item.update_attributes(attr_values, params) unless attr_values.delete(:_destroy) }
       end
     end
   end

data/lib/form_obj/form/attribute.rb

@@ -2,17 +2,9 @@ module FormObj
   class Form < FormObj::Struct
     class Attribute < FormObj::Struct::Attribute
       def initialize(name, array: false, class: nil, default: nil, parent:, primary_key: nil, &block)
-        super(name, array: array, class: binding.local_variable_get(:class), default: default, parent: parent, &block)
+        super(name, array: array, class: binding.local_variable_get(:class), default: default, parent: parent, primary_key: primary_key, &block)
 
         @nested_class.instance_variable_set(:@model_name, ActiveModel::Name.new(@nested_class, nil, name.to_s)) if !@nested_class && block_given?
-
-        if primary_key
-          if @nested_class
-            @nested_class.primary_key = primary_key
-          else
-            parent.primary_key = name.to_sym
-          end
-        end
       end
     end
   end

data/lib/form_obj/form/attributes.rb

@@ -1,13 +1,5 @@
 module FormObj
   class Form < FormObj::Struct
-    class Attributes < FormObj::Struct::Attributes
-      def find(name)
-        @items.find { |item| item.name == name.to_sym }
-      end
-
-      def each(&block)
-        @items.each(&block)
-      end
-    end
+    class Attributes < FormObj::Struct::Attributes; end
   end
 end

data/lib/form_obj/form.rb

@@ -5,8 +5,6 @@ require 'form_obj/form/array'
 require 'active_model'
 
 module FormObj
-  class UnknownAttributeError < RuntimeError; end
-
   class Form < FormObj::Struct
     extend ::ActiveModel::Naming
     extend ::ActiveModel::Translation
@@ -14,8 +12,6 @@ module FormObj
     include ::ActiveModel::Conversion
     include ::ActiveModel::Validations
 
-    class_attribute :primary_key, instance_predicate: false, instance_reader: false, instance_writer: false
-    self.primary_key = :id
     self._attributes = Attributes.new
 
     class << self
@@ -36,51 +32,47 @@ module FormObj
       end
     end
 
-    attr_accessor :persisted
+    attr_writer :persisted
     attr_reader :errors
 
-    def initialize()
+    def initialize(*args)
       @errors = ActiveModel::Errors.new(self)
       @persisted = false
+      super
     end
 
     def persisted?
-      @persisted
+      @persisted && self.class._attributes.reduce(true) { |persisted, attr|
+        persisted && (!attr.subform? || read_attribute(attr).persisted?)
+      }
     end
 
-    def _set_attribute_value(attribute, value)
-      @persisted = false
-      super
+    def mark_as_persisted
+      self.persisted = true
+      self.class._attributes.each { |attr|
+        read_attribute(attr).mark_as_persisted if attr.subform?
+      }
+      self
     end
 
-    def primary_key
-      send(self.class.primary_key)
+    def mark_for_destruction
+      @marked_for_destruction = true
+      self.class._attributes.each { |attr|
+        read_attribute(attr).mark_for_destruction if attr.subform?
+      }
+      self.persisted = false
+      self
     end
 
-    def primary_key=(val)
-      send("#{self.class.primary_key}=", val)
+    def marked_for_destruction?
+      @marked_for_destruction ||= false
     end
 
-    def update_attributes(new_attrs, raise_if_not_found: true)
-      new_attrs.each_pair do |new_attr, new_val|
-        attr = self.class._attributes.find(new_attr)
-        if attr.nil?
-          raise UnknownAttributeError.new(new_attr) if raise_if_not_found
-        else
-          if attr.subform?
-            self.send(new_attr).update_attributes(new_val)
-          else
-            self.send("#{new_attr}=", new_val)
-          end
-        end
-      end
-
-      self
-    end
+    private
 
-    def saved
-      @persisted = true
-      self
+    def _set_attribute_value(attribute, value)
+      @persisted = false unless _get_attribute_value(attribute) === value
+      super
     end
   end
 end

data/lib/form_obj/model_mapper/array.rb

@@ -1,15 +1,15 @@
 module FormObj
   module ModelMapper
     class Array < FormObj::Form::Array
-      def initialize(item_class, model_attribute:)
+      def initialize(item_class, model_attribute, *args)
         @model_attribute = model_attribute
-        super(item_class)
+        super(item_class, *args)
       end
 
-      def load_from_models(models)
+      def load_from_models(models, *args)
         clear
-        (models[:default] || []).each do |model|
-          create.load_from_models(models.merge(default: model))
+        iterate_through_models_to_load_them(models[:default] || [], *args) do |model|
+          build.load_from_models(models.merge(default: model), *args)
         end
         self
       end
@@ -32,7 +32,7 @@ module FormObj
         delete_models(model_array, ids_to_remove)
 
         items_to_add.each do |item|
-          model_array << model = @model_attribute.create_model # || model_array.create_model
+          model_array << model = model_attribute.create_model
           item.sync_to_models(models.merge(default: model))
         end
       end
@@ -61,6 +61,14 @@ module FormObj
         self.each { |item| models[:default] << item.to_models_hash(models.merge(default: {}))[:default] }
         models
       end
+
+      private
+
+      attr_reader :model_attribute
+
+      def iterate_through_models_to_load_them(models, *args, &block)
+        models.each { |model| block.call(model) }
+      end
     end
   end
 end

data/lib/form_obj/model_mapper/attribute.rb

@@ -5,8 +5,8 @@ module FormObj
     class Attribute < FormObj::Form::Attribute
       attr_reader :model_attribute
 
-      def initialize(name, array: false, class: nil, default: nil, model_hash: false, model: :default, model_attribute: nil, model_class: nil, parent:, primary_key: nil, &block)
-        @model_attribute = ModelAttribute.new(model: model, names: model_attribute, classes: model_class, default_name: name, array: array, hash: model_hash, subform: binding.local_variable_get(:class) || block_given?)
+      def initialize(name, array: false, class: nil, default: nil, model_hash: false, model: :default, model_attribute: nil, model_class: nil, model_nesting: true, parent:, primary_key: nil, &block)
+        @model_attribute = ModelAttribute.new(model: model, names: model_attribute, classes: model_class, default_name: name, nesting: model_nesting, array: array, hash: model_hash, subform: binding.local_variable_get(:class) || block_given?)
 
         if block_given?
           new_block = Proc.new do
@@ -16,7 +16,6 @@ module FormObj
         end
         super(name, array: array, class: binding.local_variable_get(:class), default: default, parent: parent, primary_key: primary_key, &new_block)
 
-        @nested_class            = Class.new(@nested_class) if binding.local_variable_get(:class)
         @nested_class.model_hash = model_hash if @nested_class
       end
 
@@ -26,8 +25,8 @@ module FormObj
 
       private
 
-      def create_array
-        @parent.array_class.new(@nested_class, model_attribute: @model_attribute)
+      def create_array(*args)
+        @parent.array_class.new(@nested_class, @model_attribute, *args)
       end
     end
   end

data/lib/form_obj/model_mapper/model_attribute.rb

@@ -6,9 +6,10 @@ module FormObj
     class ModelAttribute
       attr_reader :model
 
-      def initialize(names:, classes:, default_name:, array:, hash:, subform:, model:)
+      def initialize(names:, classes:, default_name:, array:, hash:, subform:, model:, nesting:)
         @read_from_model = @write_to_model = !(names === false)
 
+        @nesting = nesting
         @model = model
         @array = array
 
@@ -29,6 +30,10 @@ module FormObj
         end
       end
 
+      def names
+        @items.map(&:name)
+      end
+
       def last_name
         @items.last.name
       end
@@ -42,6 +47,10 @@ module FormObj
         @items.last.create_model
       end
 
+      def nesting?
+        @nesting
+      end
+
       def read_from_model?
         @read_from_model
       end

data/lib/form_obj/model_mapper.rb

@@ -29,12 +29,12 @@ module FormObj
       end
     end
 
-    def load_from_model(model)
-      load_from_models(default: model)
+    def load_from_model(model, *args)
+      load_from_models({ default: model }, *args)
     end
 
-    def load_from_models(models)
-      self.class._attributes.each { |attribute| load_attribute_from_model(attribute, models) }
+    def load_from_models(models, *args)
+      self.class._attributes.each { |attribute| load_attribute_from_model(attribute, models, *args) }
       self.persisted = true
       self
     end
@@ -60,24 +60,7 @@ module FormObj
 
     def to_models_hash(models = {})
       self.class._attributes.each do |attribute|
-        val = if attribute.subform?
-                if attribute.array?
-                  []
-                else
-                  attribute.model_attribute.write_to_model? ? {} : (models[attribute.model_attribute.model] ||= {})
-                end
-              else
-                send(attribute.name)
-              end
-
-        value = if attribute.subform? && !attribute.model_attribute.write_to_model?
-                  attribute.array? ? { self: val } : {}
-                elsif attribute.subform? || attribute.model_attribute.write_to_model?
-                  attribute.model_attribute.to_model_hash(val)
-                end
-
-        (models[attribute.model_attribute.model] ||= {}).merge!(value) if attribute.subform? || attribute.model_attribute.write_to_model?
-        send(attribute.name).to_models_hash(models.merge(default: val)) if attribute.subform?
+        attribute_to_models_hash(attribute, models)
       end
       models
     end
@@ -98,28 +81,55 @@ module FormObj
 
     private
 
-    def load_attribute_from_model(attribute, models)
+    def load_attribute_from_model(attribute, models, *args)
+      return unless attribute.model_attribute.read_from_model?
+
       if attribute.subform?
-        if attribute.model_attribute.read_from_model?
-          self.send(attribute.name).load_from_models(models.merge(default: attribute.model_attribute.read_from_models(models)))
+        if attribute.model_attribute.nesting?
+          read_attribute(attribute).load_from_models(models.merge(default: attribute.model_attribute.read_from_models(models)), *args)
         else
-          self.send(attribute.name).load_from_models(models.merge(default: models[attribute.model_attribute.model]))
+          read_attribute(attribute).load_from_models(models.merge(default: models[attribute.model_attribute.model]), *args)
         end
-      elsif attribute.model_attribute.read_from_model?
-        self.send("#{attribute.name}=", attribute.model_attribute.read_from_models(models))
+      else
+        write_attribute(attribute, attribute.model_attribute.read_from_models(models))
       end
     end
 
     def sync_attribute_to_model(attribute, models)
+      return unless attribute.model_attribute.write_to_model?
+
       if attribute.subform?
-        if attribute.model_attribute.write_to_model?
-          self.send(attribute.name).sync_to_models(models.merge(default: attribute.model_attribute.read_from_models(models, create_nested_model_if_nil: true)))
+        if attribute.model_attribute.nesting?
+          read_attribute(attribute).sync_to_models(models.merge(default: attribute.model_attribute.read_from_models(models, create_nested_model_if_nil: true)))
         else
-          self.send(attribute.name).sync_to_models(models.merge(default: models[attribute.model_attribute.model]))
+          read_attribute(attribute).sync_to_models(models.merge(default: models[attribute.model_attribute.model]))
         end
-      elsif attribute.model_attribute.write_to_model?
-        attribute.model_attribute.write_to_models(models, self.send(attribute.name))
+      else
+        attribute.model_attribute.write_to_models(models, read_attribute(attribute))
       end
     end
+
+    def attribute_to_models_hash(attribute, models)
+      return unless attribute.model_attribute.write_to_model?
+
+      val = if attribute.subform?
+              if attribute.array?
+                []
+              else
+                attribute.model_attribute.nesting? ? {} : (models[attribute.model_attribute.model] ||= {})
+              end
+            else
+              read_attribute(attribute)
+            end
+
+      value = if attribute.subform? && !attribute.model_attribute.nesting?
+                attribute.array? ? { self: val } : {}
+              else
+                attribute.model_attribute.to_model_hash(val)
+              end
+
+      (models[attribute.model_attribute.model] ||= {}).merge!(value)
+      read_attribute(attribute).to_models_hash(models.merge(default: val)) if attribute.subform?
+    end
   end
 end

data/lib/form_obj/struct/array.rb

@@ -3,19 +3,76 @@ require 'typed_array'
 module FormObj
   class Struct
     class Array < TypedArray
-      def create
-        self << (item = create_item)
+      def build(hash = nil, raise_if_not_found: true)
+        self << (item = build_item(hash, raise_if_not_found: raise_if_not_found))
         item
       end
 
+      def create(*args)
+        build(*args)
+      end
+
       def to_hash
         self.map(&:to_hash)
       end
 
+      def update_attributes(vals, raise_if_not_found:)
+        items_to_add = []
+        items_to_update = {}
+
+        vals.each do |val|
+          val = HashWithIndifferentAccess.new(val)
+          item = find_by_primary_key(primary_key(val))
+          if item
+            items_to_update[item] = val
+          else
+            items_to_add << val
+          end
+        end
+        items_to_destroy = items_for_destruction(items_to_add: items_to_add, items_to_update: items_to_update)
+
+        destroy_items(items_to_destroy)
+        update_items(items_to_update, raise_if_not_found: raise_if_not_found)
+        build_items(items_to_add, raise_if_not_found: raise_if_not_found)
+
+        sort! { |a, b| (vals.index { |val| primary_key(val) == a.primary_key } || -1) <=> (vals.index { |val| primary_key(val) == b.primary_key } || -1) }
+      end
+
       private
 
-      def create_item
-        item_class.new
+      def primary_key(hash)
+        hash[item_class.primary_key]
+      end
+
+      def find_by_primary_key(id)
+        find { |item| item.primary_key == id }
+      end
+
+      def build_item(hash, raise_if_not_found:)
+        item_class.new(hash, raise_if_not_found: raise_if_not_found)
+      end
+
+      # items_to_add - array of hashes of new attribute values
+      # items_to_update - hash where key is the item to update and value is a hash of new attribute values
+      def items_for_destruction(items_to_add:, items_to_update:)
+        self - items_to_update.keys
+      end
+
+      # items - array of items to be destroyed
+      def destroy_items(items)
+        items.each { |item| delete(item) }
+      end
+
+      # items - hash where key is the item to update and value is a hash of new attribute values
+      # params - additional params for :update_attributes method
+      def update_items(items, params)
+        items.each_pair { |item, attr_values| item.update_attributes(attr_values, params) }
+      end
+
+      # items - array of hashes of new attribute values
+      # params - additional params for constructor
+      def build_items(items, params)
+        items.each { |item| self << build_item(item, params) }
       end
     end
   end

data/lib/form_obj/struct/attribute.rb

@@ -3,16 +3,25 @@ module FormObj
     class Attribute
       attr_reader :name
 
-      def initialize(name, array: false, class: nil, default: nil, parent:, &block)
+      def initialize(name, array: false, class: nil, default: nil, parent:, primary_key: nil, &block)
         @name = name.to_sym
         @array = array
         @default_value = default
         @parent = parent
 
         @nested_class = binding.local_variable_get(:class)
+        @nested_class = @nested_class.constantize if @nested_class.is_a? String
         @nested_class = Class.new(@parent.nested_class, &block) if !@nested_class && block_given?
 
         raise ArgumentError.new('Nested structure has to be defined (either with :class parameter or with block) for arrays if :default parameter is not specified') if @array && @nested_class.nil? && @default_value.nil?
+
+        if primary_key
+          if @nested_class
+            @nested_class.primary_key = primary_key
+          else
+            parent.primary_key = name.to_sym
+          end
+        end
       end
 
       def subform?
@@ -47,22 +56,39 @@ module FormObj
             end
           end
 
-        elsif @default_value.is_a? Proc
-          @default_value.call(@parent, self)
-
         else
-          @default_value
+          value = if @default_value.is_a? ::Proc
+                    @default_value.call(@parent, self)
+                  else
+                    @default_value
+                  end
+
+          if @nested_class
+            if @array
+              raise FormObj::WrongDefaultValueClass unless value.is_a? ::Array
+              value = create_array(value.map do |val|
+                val = create_nested(val) if val.is_a?(::Hash)
+                raise FormObj::WrongDefaultValueClass if val.class != @nested_class
+                val
+              end)
+            else
+              value = create_nested(value) if value.is_a? ::Hash
+              raise FormObj::WrongDefaultValueClass if value.class != @nested_class
+            end
+          end
+
+          value
         end
       end
 
       private
 
-      def create_nested
-        @nested_class.new
+      def create_nested(*args)
+        @nested_class.new(*args)
       end
 
-      def create_array
-        @parent.array_class.new(@nested_class)
+      def create_array(*args)
+        @parent.array_class.new(@nested_class, *args)
       end
     end
   end

data/lib/form_obj/struct/attributes.rb

@@ -13,9 +13,21 @@ module FormObj
         end
       end
 
+      def each(&block)
+        @items.each(&block)
+      end
+
+      def find(name)
+        @items.find { |item| item.name == name.to_sym }
+      end
+
       def map(*args, &block)
         @items.map(*args, &block)
       end
+
+      def reduce(*args, &block)
+        @items.reduce(*args, &block)
+      end
     end
   end
 end