on_form 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05e792fbba20f1c4d82034000b2e49f2f5e01586
-  data.tar.gz: d8841bae2c6429b08945385a899d89b64e19f3a1
+  metadata.gz: da2ced30fe04b528a602ad17e4b6ba170c08c02e
+  data.tar.gz: 757f860fa9c1b41c575f6ea5c0a7a4920d32c240
 SHA512:
-  metadata.gz: c6557351f0b77e782903e27985c77afd88a6a9872fd506acfb26dd80464fc090337962aa5eead731175a9983fbe9c991590dfd16ae3151eff769927dccafb349
-  data.tar.gz: 65bd1b58e606758dce47bf865a7debe2bb602286cf79c7d025fd28472223553f54b0a2322a9a319f806ce027f55775827dcab27b3cf0209992e4663bd0b664de
+  metadata.gz: d85b8d09675bb0edbd414bb4ed3ddbc44b14bc17a571e6259928099f2e611c56607d2f541c99067653f7f79deeab60a7aee1884d249e70c36a24204f26543733
+  data.tar.gz: cd09754e7fe9a5a686911a577aa2e2e85edd478c7f79107b4d7c2601a46d9b9b3158f2d43bb3d0c776074e61fa752ac825498a02af3cbeb9ffc80cc09c40975a

data/CHANGES.md

@@ -1,9 +1,15 @@
 Changelog
 =========
 
+3.0.0
+-----
+* Support `save(validate: false)` and `save!(validate: false)`.
+* Change callback order to better match ActiveRecord: validation callbacks fire before `before_save` fires, and model callbacks fire before the form's `after_validation` callback fires.
+* Collect errors from collection forms and present them on the form itself.  Thanks @Dhamsoft.
+
 2.3.0
 -----
-* Add `take_identity_from` to improve interoperability with standard resource ('RESTful') controllers and form helpers
+* Add `take_identity_from` to improve interoperability with standard resource ('RESTful') controllers and form helpers.
 
 2.2.2
 -----

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Powershop New Zealand Limited
+Copyright (c) 2016-2018 Flux Federation Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -259,14 +259,16 @@ protected
 end
 ```
 
-Note that model save calls are nested inside the form save calls, which means that although form validation takes place before form save starts, model validation takes place after form saving begins.
+Model validations and validation callbacks occur between the form validation before and after callbacks, and model save calls are nested inside the form save calls, but the save calls all follow the validations and validation callbacks.
 
     form before_validation
+    model before_validation
+    model validate (validations defined on the model)
+    model after_validation
     form validate (validations defined on the form itself)
+    form after_validation
     form before_save
     form around_save begins
-      model before_validation
-      model validate (validations defined on the model)
       model before_save
       model around_save begins
         model saved
@@ -386,7 +388,7 @@ If you prefer, you can use the Rails `included` block syntax in the module inste
 
 After checking out the repo, pick the rails version you'd like to run tests against, and run:
 
-    RAILS_VERSION=5.0.0.1 bundle update
+    RAILS_VERSION=5.2.0 bundle update
 
 You should then be able to run the test suite:
 
@@ -404,4 +406,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/powers
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-Copyright © Powershop New Zealand Limited, 2016
+Copyright © Flux Federation Limited, 2016-2018.

data/lib/on_form/collection_wrapper.rb

@@ -0,0 +1,121 @@
+module OnForm
+  class CollectionWrapper
+    include ::Enumerable
+
+    attr_reader :parent, :association_name, :collection_form_class, :allow_insert, :allow_update, :allow_destroy
+
+    delegate :each, :first, :last, :[], to: :to_a
+
+    def initialize(parent, association_name, collection_form_class, allow_insert, allow_update, allow_destroy)
+      @parent = parent
+      @association_name = association_name
+      @association = parent.association(association_name)
+      @association_proxy = parent.send(association_name)
+      @collection_form_class = collection_form_class
+      @allow_insert, @allow_update, @allow_destroy = allow_insert, allow_update, allow_destroy
+      @wrapped_records = {}
+      @wrapped_new_records = []
+      @loaded_forms = []
+    end
+
+    def to_ary
+      to_a
+    end
+
+    def each
+      @association_proxy.each { |record| yield wrapped_record(record) }
+    end
+
+    def size
+      @association_proxy.size
+    end
+
+    def save_forms(validate: true)
+      @loaded_forms.each do |form|
+        if form.marked_for_destruction?
+          form.record.destroy
+        else
+          form.save!(validate: validate)
+        end
+      end
+    end
+
+    def validate_forms(parent_form)
+      @loaded_forms.collect do |form|
+        add_errors_to_parent(parent_form, form) if form.invalid?
+      end
+    end
+
+    def form_errors?
+      @loaded_forms.map(&:form_errors?).any?
+    end
+
+    def reset_forms_errors
+      @loaded_forms.collect(&:reset_errors)
+    end
+
+    def parse_collection_attributes(params)
+      params = params.values unless params.is_a?(Array)
+
+      records_to_insert = []
+      records_to_update = {}
+      records_to_destroy = []
+
+      params.each do |attributes|
+        destroy = self.class.boolean_type.cast(attributes['_destroy']) || self.class.boolean_type.cast(attributes[:_destroy])
+        if id = attributes['id'] || attributes[:id]
+          if destroy
+            records_to_destroy << id.to_i if allow_destroy
+          else
+            records_to_update[id.to_i] = attributes.except('id', :id, '_destroy', :destroy) if allow_update
+          end
+        elsif !destroy
+          records_to_insert << attributes.except('_destroy', :destroy) if allow_insert
+        end
+      end
+
+      to_a if @association_proxy.loaded?
+      records_to_load = records_to_update.keys + records_to_destroy - @wrapped_records.keys.collect(&:id)
+      @association_proxy.find(records_to_load).each do |record|
+        @association.add_to_target(record, :skip_callbacks)
+        wrapped_record(record)
+      end
+      loaded_forms_by_id = @wrapped_records.values.index_by(&:id)
+
+      records_to_insert.each do |attributes|
+        wrapped_record(@association_proxy.build).attributes = attributes
+      end
+
+      records_to_update.each do |id, attributes|
+        loaded_forms_by_id[id].attributes = attributes
+      end
+
+      records_to_destroy.each do |id|
+        loaded_forms_by_id[id].mark_for_destruction
+      end
+
+      params
+    end
+
+  protected
+    def self.boolean_type
+      @boolean_type ||= Types.lookup(:boolean, {})
+    end
+
+    def add_errors_to_parent(parent_form, child_form)
+      return unless child_form.errors.present?
+
+      association_exposed_name = child_form.class.identity_model_name.to_s.pluralize
+      child_form.errors.each do |attribute, errors|
+        Array(errors).each { |error| parent_form.errors["#{association_exposed_name}.#{attribute}"] << error }
+        if parent_form.errors["#{association_exposed_name}.#{attribute}"].present?
+          parent_form.errors["#{association_exposed_name}.#{attribute}"].uniq!
+        end
+      end
+    end
+
+    def wrapped_record(record)
+      @wrapped_records[record] ||= @collection_form_class.new(record).tap { |form| @loaded_forms << form }
+    end
+  end
+end

data/lib/on_form/errors.rb

@@ -4,12 +4,17 @@ module OnForm
       @errors ||= ActiveModel::Errors.new(self)
     end
 
-  private
     def reset_errors
       @errors = nil
+      reset_errors_on_child_forms
+    end
+
+  private
+    def reset_errors_on_child_forms
+      collection_wrappers.each_value(&:reset_forms_errors)
     end
 
-    def collect_errors
+    def collect_errors_from_backing_model_instances
       self.class.exposed_attributes.each do |backing_model_name, attribute_mappings|
         backing_model = backing_model_instance(backing_model_name)
 

data/lib/on_form/form.rb

@@ -1,6 +1,7 @@
 module OnForm
   class Form
     include ActiveModel::Validations
+    include Validations
     include ActiveModel::Validations::Callbacks
 
     include Attributes
@@ -68,10 +69,33 @@ module OnForm
       define_method("#{name}=")                 { |arg| introduced_attribute_values.delete(name); introduced_attribute_values_before_type_cast[name] = arg }
     end
 
-    def self.take_identity_from(backing_model_name)
+    def self.take_identity_from(backing_model_name, convert_to_model: true)
       @identity_model_name = backing_model_name.to_sym
       expose_backing_model(@identity_model_name)
-      delegate :to_model, :to_key, :to_param, :persisted?, to: backing_model_name
+      delegate :id, :to_key, :to_param, :persisted?, :mark_for_destruction, :_destroy, :marked_for_destruction?, to: backing_model_name
+      delegate :to_model, to: backing_model_name if convert_to_model
+    end
+
+    def self.expose_collection_of(association_name, on: nil, prefix: nil, suffix: nil, as: nil, allow_insert: true, allow_update: true, allow_destroy: false, &block)
+      exposed_name = as || "#{prefix}#{association_name}#{suffix}"
+      singular_name = exposed_name.to_s.singularize
+      association_name = association_name.to_sym
+
+      on = prepare_model_to_expose!(on)
+
+      collection_form_class = Class.new(OnForm::Form)
+      const_set(exposed_name.to_s.classify + "Form", collection_form_class)
+
+      collection_form_class.send(:define_method, :initialize) { |record| @record = record }
+      collection_form_class.send(:attr_reader, :record)
+      collection_form_class.send(:alias_method, singular_name, :record)
+      collection_form_class.take_identity_from singular_name, convert_to_model: false
+      collection_form_class.class_eval(&block)
+
+      define_method(exposed_name) { collection_wrappers[association_name] ||= CollectionWrapper.new(backing_model_instance(on), association_name, collection_form_class, allow_insert, allow_update, allow_destroy) } # used by action_view's fields_for, and by the following lines
+      define_method("#{exposed_name}_attributes=") { |params| send(exposed_name).parse_collection_attributes(params) }
+
+      collection_form_class
     end
 
   protected
@@ -82,5 +106,16 @@ module OnForm
     def introduced_attribute_values_before_type_cast
       @introduced_attribute_values_before_type_cast ||= {}
     end
+
+    def collection_wrappers
+      @collection_wrappers ||= {}
+    end
+
+    def self.prepare_model_to_expose!(on)
+      raise ArgumentError, "must choose the model to expose the attributes on" unless on || identity_model_name
+      on = (on || identity_model_name).to_sym
+      expose_backing_model(on)
+      on
+    end
   end
 end

data/lib/on_form/saving.rb

@@ -14,31 +14,33 @@ module OnForm
       end
     end
 
-    def invalid?
-      !valid?
-    end
-
-    def save!
-      reset_errors
+    def save!(validate: true)
       transaction do
         reset_errors
-        unless run_validations!(backing_model_validations: false)
-          raise ActiveModel::ValidationError, self
+
+        if validate
+          run_validations!
+
+          if !errors.empty?
+            if form_errors?
+              raise ActiveModel::ValidationError, self
+            else
+              raise ActiveRecord::RecordInvalid, self
+            end
+          end
         end
+
         run_callbacks :save do
-          begin
-            backing_model_instances.each { |backing_model| backing_model.save! }
-          rescue ActiveRecord::RecordInvalid, ActiveModel::ValidationError
-            collect_errors
-            raise
-          end
+          # we pass (validate: false) to avoid running the validations a second time, but we use save! to get the RecordNotFound behavior
+          backing_model_instances.each { |backing_model| backing_model.save!(validate: false) }
+          save_child_forms(validate: false)
         end
       end
       true
     end
 
-    def save
-      save!
+    def save(validate: true)
+      save!(validate: validate)
     rescue ActiveRecord::RecordInvalid, ActiveModel::ValidationError
       false
     end
@@ -71,15 +73,8 @@ module OnForm
       end
     end
 
-    def run_validations!(backing_model_validations: true)
-      super()
-      run_backing_model_validations if backing_model_validations
-      errors.empty?
-    end
-
-    def run_backing_model_validations
-      backing_model_instances.collect { |backing_model| backing_model.valid? }
-      collect_errors
+    def save_child_forms(validate: true)
+      collection_wrappers.each_value {|collection| collection.save_forms(validate: validate) }
     end
   end
 end

data/lib/on_form/validations.rb

@@ -0,0 +1,36 @@
+module OnForm
+  module Validations
+    def self.included(base)
+      base.validate :run_backing_model_validations
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    def form_errors?
+      !!(@_form_validation_errors || child_form_errors?)
+    end
+
+  private
+    def run_backing_model_validations
+      backing_model_instances.each { |backing_model| backing_model.valid? }
+    end
+
+    def run_validations!
+      super
+      @_form_validation_errors = !errors.empty?
+      collect_errors_from_backing_model_instances
+      run_child_form_validations!
+      errors.empty?
+    end
+
+    def run_child_form_validations!
+      collection_wrappers.each_value {|collection| collection.validate_forms(self) }
+    end
+
+    def child_form_errors?
+      collection_wrappers.values.map(&:form_errors?).any?
+    end
+  end
+end

data/lib/on_form/version.rb

@@ -1,3 +1,3 @@
 module OnForm
-  VERSION = "2.3.0"
+  VERSION = "3.0.0"
 end

data/lib/on_form.rb

@@ -4,6 +4,8 @@ require "on_form/version"
 require "on_form/rails_compat"
 require "on_form/attributes"
 require "on_form/errors"
+require "on_form/validations"
 require "on_form/saving"
 require "on_form/types"
+require "on_form/collection_wrapper"
 require "on_form/form"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: on_form
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Will Bryant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -98,11 +98,13 @@ files:
 - bin/setup
 - lib/on_form.rb
 - lib/on_form/attributes.rb
+- lib/on_form/collection_wrapper.rb
 - lib/on_form/errors.rb
 - lib/on_form/form.rb
 - lib/on_form/rails_compat.rb
 - lib/on_form/saving.rb
 - lib/on_form/types.rb
+- lib/on_form/validations.rb
 - lib/on_form/version.rb
 - on_form.gemspec
 homepage: https://github.com/powershop/on_form
@@ -125,9 +127,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A pragmatism-first library to help Rails applications migrate from complex
   nested attribute models to tidy form objects.
 test_files: []
+has_rdoc: