hoodoo 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 558f4ad8d5dd9efe88b282630fcb24a5fc244382e7dc3ff769b21998c38c058e
-  data.tar.gz: 0b2b67b5d32e25c160f1a4ec755898b294fb742044615557c05a9d18769e8699
+  metadata.gz: 46ac63e8aa118e94f032e34184b681adb622215fdd8fce503980461dbf5917bd
+  data.tar.gz: 7c4f3a6e0f3237cd1accd3159029081a7e8ef58797da65e3d986dec464709797
 SHA512:
-  metadata.gz: 9dc89cb9a030e29d0c678a4cef606fff9ad2bee6761148573c4c5ea8e8fa173ffc99dcf0f2e50f7ca6ac7f90baac80a6854314159cc53adc2624e2326478622b
-  data.tar.gz: de09f589b82a11eec89cd494860b9b2c3ee00262fd16cd18307296d88caf3ab3b5eef2ce28387adc525dc924a9d34d1074dd13233edb6346e9b61470eb8d9804
+  metadata.gz: 684ffccf17fc0aead47c9abfbc413ce8cb9fd60efd4798eb61a7dfef928d9f31acc76ad3818cd6f6a26db0b5b5857c7e723e27a111b4911b3c2ae12b0787d16a
+  data.tar.gz: 3a9c95d8e592dec3f6037eb551e142d433449e4d5805317109ed0b3f8aa6701c8518fba91cdca2e634cd809073908a292c3a3f9be0649095c767eecaecb010ae

data/lib/hoodoo/active/active_record/error_mapping.rb

@@ -7,8 +7,13 @@
 #           validation errors.
 # ----------------------------------------------------------------------
 #           17-Nov-2014 (ADH): Created.
+#           12-Dec-2018 (ADH): Moved most of the error mapping code out
+#                              to Hoodoo::ActiveRecord::Support, so that
+#                              it can be reused more easily.
 ########################################################################
 
+require 'hoodoo/active/active_record/support'
+
 module Hoodoo
 
   # Support mixins for models subclassed from ActiveRecord::Base. See:
@@ -39,7 +44,11 @@ module Hoodoo
       # Returns +true+ if any errors were added (model instance is invalid)
       # else +false+ if everything is OK (model instance is valid).
       #
-      # == Mapping ActiveRecord errors to API errors
+      # Uses Hoodoo::ActiveRecord::Support#translate_errors_on to perform
+      # the mapping. For detailed information on how the mapping works,
+      # please see that method.
+      #
+      # == Mapping ActiveRecord errors to Hoodoo errors
       #
       # The method makes an idiomatic example for "check errors in the model,
       # map them to platform errors in my service's response and return the
@@ -107,69 +116,6 @@ module Hoodoo
       # possible - provided one assumes that the non-error path is the much
       # more common case!
       #
-      # == Associations
-      #
-      # When a model has associations and nested attributes are accepted for
-      # those associations, a validity query on an instance constructed with
-      # nested attributes will cause ActiveRecord to traverse all such
-      # attributes and aggregate specific errors on the parent object. This
-      # is specifically different from +validates_associated+, wherein
-      # associations constructed and attached through any means are validated
-      # independently, with validation errors independently added to those
-      # objects and the parent only gaining a generic "foo is invalid" error.
-      #
-      # In such cases, the error mapper will attempt to path-traverse the
-      # error's column references to determine the association's column type
-      # and produce a fully mapped error with a reference to the full path.
-      # Service authors are encouraged to use this approach if associations
-      # are involved, as it yields the most comprehensive mapped error
-      # collection.
-      #
-      # In the example below, note how the Child model does not need to
-      # include Hoodoo error mapping (though it can do so harmlessly if it so
-      # wishes) because it is the Parent model that drives the mapping of all
-      # the validations aggregated by ActiveRecord into an instance of Parent
-      # due to +accepts_nested_attributes_for+.
-      #
-      # So, given this:
-      #
-      #     def Parent < ActiveRecord::Base
-      #       include Hoodoo::ActiveRecord::ErrorMapping
-      #
-      #       has_many :children
-      #       accepts_nested_attributes_for :children
-      #     end
-      #
-      #     def Child < ActiveRecord::Base
-      #       belongs_to :parent
-      #
-      #       # ...then add ActiveRecord validations - e.g.:
-      #
-      #       validates :some_child_field, :length => { :maximum => 5 }
-      #     end
-      #
-      # ...then if a Parent were to be constructed thus:
-      #
-      #     parent = Parent.new( {
-      #       "parent_field_1" = "foo",
-      #       "parent_field_2" = "bar",
-      #       "children_attributes" = [
-      #         { "some_child_field" = "child_1_foo" },
-      #         { "some_child_field" = "child_2_foo" },
-      #         # ...
-      #       ],
-      #       # ...
-      #     } )
-      #
-      # ...then <tt>parent.adds_errors_to?( some_collection )</tt> could lead
-      # to +some_collection+ containing errors such as:
-      #
-      #     {
-      #       "code"      => "generic.invalid_string",
-      #       "message    => "is too long (maximum is 5 characters)",
-      #       "reference" => "children.some_child_field"
-      #     }
-      #
       # +collection+:: A Hoodoo::Errors instance, typically obtained
       #                from the Hoodoo::Services::Context instance passed to
       #                a service implementation in calls like
@@ -183,34 +129,8 @@ module Hoodoo
       #                the collection.
       #
       def adds_errors_to?( collection )
-
         self.validate()
-
-        self.errors.messages.each_pair do | attribute_name, message_array |
-          attribute_name = attribute_name.to_s
-
-          attribute_type = nz_co_loyalty_determine_deep_attribute_type( attribute_name )
-          attribute_name = 'model instance' if attribute_name == 'base'
-
-          message_array.each do | message |
-            error_code = case message
-              when 'has already been taken'
-                'generic.invalid_duplication'
-              else
-                attribute_type == 'text' ? 'generic.invalid_string' : "generic.invalid_#{ attribute_type }"
-            end
-
-            unless collection.descriptions.recognised?( error_code )
-              error_code = 'generic.invalid_parameters'
-            end
-
-            collection.add_error(
-              error_code,
-              :message   => message,
-              :reference => { :field_name => attribute_name }
-            )
-          end
-        end
+        Hoodoo::ActiveRecord::Support.translate_errors_on( self, collection )
 
         return self.errors.any?
       end
@@ -254,98 +174,6 @@ module Hoodoo
         return collection
       end
 
-    private
-
-      # Given an attribute for this model as a string, return the column type
-      # associated with it.
-      #
-      # The attribute name intended for use here comes from validation and,
-      # when there are unsaved associations in an ActiveRecord graph that is
-      # being saved, ActiveRecord aggregates child object errors into the
-      # target parent being saved with the attribute names using a dot
-      # notation to indicate the path of methods to get from one instance to
-      # the next. This is resolved. For example:
-      #
-      # * <tt>address</tt> would look up the type of a column called
-      #   "address" in 'this' model.
-      #
-      # * <tt>addresses.home</tt> would look up the type of a column called
-      #   "home" in whatever is accessed by "model.addresses". If this gives
-      #   an array, the first entry in the array is taken for column type
-      #   retrieval.
-      #
-      # This path chasing will be done to an arbitrary depth. If at any point
-      # there is a failure to follow the path, the path follower exits and
-      # the top-level error is used instead, with a generic unknown column
-      # type returned.
-      #
-      # Parameters:
-      #
-      # +attribute_path+:: _String_ attribute path. Not a Symbol or Array!
-      #
-      # Return values are any ActiveRecord column type or these special
-      # values:
-      #
-      # * +unknown+ for any unrecognised attribute name or an attribute name
-      #   that is a path (it has one or more "."s in it) but where the path
-      #   cannot be followed.
-      #
-      # * +array+ for columns that appear to respond to the +array+ method.
-      #
-      # * +uuid+ for columns of any known but non-array type, where there is
-      #   a UuidValidator present.
-      #
-      def nz_co_loyalty_determine_deep_attribute_type( attribute_path )
-
-        attribute_name  = attribute_path
-        target_instance = self
-
-        # Descend a path of "foo.bar.baz" dereferencing associations from the
-        # field names in the dot-separated path until we're at the lowest leaf
-        # object with "baz" as its errant field.
-
-        if attribute_path.include?( '.' )
-
-          leaf_instance = target_instance
-          leaf_field    = attribute_path
-
-          fields        =  attribute_path.split( '.' )
-          leaf_field    = fields.pop() # (remove final entry - the leaf object's errant field)
-          reached_field = nil
-
-          fields.each do | field |
-            object_at_field = leaf_instance.send( field ) if   leaf_instance.respond_to?(  field )
-            object_at_field = object_at_field.first       if object_at_field.respond_to?( :first )
-
-            break if object_at_field.nil?
-
-            leaf_instance = object_at_field
-            reached_field = field
-          end
-
-          if reached_field == fields.last
-            attribute_name  = leaf_field
-            target_instance = leaf_instance
-          end
-        end
-
-        column = target_instance.class.columns_hash[ attribute_name ]
-
-        attribute_type = if column.nil?
-          'unknown'
-        elsif column.respond_to?( :array ) && column.array
-          'array'
-        elsif target_instance.class.validators_on( attribute_name ).any? { | v |
-            v.instance_of?( UuidValidator )
-          } # Considered a UUID since it uses the UUID validator
-          'uuid'
-        else
-          column.type.to_s()
-        end
-
-        return attribute_type
-      end
-
     end
   end
 end

data/lib/hoodoo/active/active_record/support.rb

@@ -183,6 +183,219 @@ module Hoodoo
         return base_scope
       end
 
+      # When given an ActiveRecord model instance which may have errors set
+      # on it as a result of a prior #validate or #save call, map any found
+      # errors from ActiveRecord to a Hoodoo::Errors instance. The mapping is
+      # comprehensive; it even checks the data type of errant columns and
+      # tries to find a +generic...+ family error to use for mapped result
+      # (e.g. +generic.invalid_string+ or +generic.invalid_integer+).
+      #
+      # Usually, the Hoodoo:ActiveRecord::ErrorMapping mixin is included into
+      # an ActiveRecord model directly and this method is therefore not used
+      # directly; Hoodoo:ActiveRecord::ErrorMapping.adds_errors_to? or
+      # similar is called instead.
+      #
+      # == Associations
+      #
+      # When a model has associations and nested attributes are accepted for
+      # those associations, a validity query on an instance constructed with
+      # nested attributes will cause ActiveRecord to traverse all such
+      # attributes and aggregate specific errors on the parent object. This
+      # is specifically different from +validates_associated+, wherein
+      # associations constructed and attached through any means are validated
+      # independently, with validation errors independently added to those
+      # objects and the parent only gaining a generic "foo is invalid" error.
+      #
+      # In such cases, the error mapper will attempt to path-traverse the
+      # error's column references to determine the association's column type
+      # and produce a fully mapped error with a reference to the full path.
+      # Service authors are encouraged to use this approach if associations
+      # are involved, as it yields the most comprehensive mapped error
+      # collection.
+      #
+      # In the example below, note how the Child model does not need to
+      # include Hoodoo error mapping (though it can do so harmlessly if it so
+      # wishes) because it is the Parent model that drives the mapping of all
+      # the validations aggregated by ActiveRecord into an instance of Parent
+      # due to +accepts_nested_attributes_for+.
+      #
+      # So, given this:
+      #
+      #     def Parent < ActiveRecord::Base
+      #       has_many :children
+      #       accepts_nested_attributes_for :children
+      #     end
+      #
+      #     def Child < ActiveRecord::Base
+      #       belongs_to :parent
+      #
+      #       # ...then add ActiveRecord validations - e.g.:
+      #
+      #       validates :some_child_field, :length => { :maximum => 5 }
+      #     end
+      #
+      # ...then if a Parent were to be constructed thus:
+      #
+      #     parent = Parent.new( {
+      #       "parent_field_1" = "foo",
+      #       "parent_field_2" = "bar",
+      #       "children_attributes" = [
+      #         { "some_child_field" = "child_1_foo" },
+      #         { "some_child_field" = "child_2_foo" },
+      #         # ...
+      #       ],
+      #       # ...
+      #     } )
+      #
+      # ...then <tt>translate_errors_on( parent )</tt> could return a
+      # Hoodoo::Errors collection containing entries such as:
+      #
+      #     {
+      #       "code"      => "generic.invalid_string",
+      #       "message    => "is too long (maximum is 5 characters)",
+      #       "reference" => "children.some_child_field"
+      #     }
+      #
+      # +model_instance+:: The ActiveRecord model which may have errors set
+      #                    as a result of a prior validation failure.
+      #
+      # +hoodoo_errors+::  Optional Hoodoo::Errors instance. If provided, any
+      #                    mapped errors are added onto this existing set. If
+      #                    omitted, the method returns a new collection.
+      #
+      # Returns a new Hoodoo::Errors collection (which may have no errors in
+      # it, if the model had not validation errors) or the value given in the
+      # +hoodoo_errors+ parameter with zero or more new errors added.
+      #
+      def self.translate_errors_on( model_instance, hoodoo_errors = nil )
+        hoodoo_errors ||= Hoodoo::Errors.new
+
+        if model_instance.errors.any?
+          model_instance.errors.messages.each_pair do | attribute_name, message_array |
+            attribute_name = attribute_name.to_s
+
+            attribute_type = determine_deep_attribute_type( model_instance, attribute_name )
+            attribute_name = 'model instance' if attribute_name == 'base'
+
+            message_array.each do | message |
+              error_code = case message
+                when 'has already been taken'
+                  'generic.invalid_duplication'
+                else
+                  attribute_type == 'text' ? 'generic.invalid_string' : "generic.invalid_#{ attribute_type }"
+              end
+
+              unless hoodoo_errors.descriptions.recognised?( error_code )
+                error_code = 'generic.invalid_parameters'
+              end
+
+              hoodoo_errors.add_error(
+                error_code,
+                :message   => message,
+                :reference => { :field_name => attribute_name }
+              )
+            end
+          end
+        end
+
+        return hoodoo_errors
+      end
+
+    private
+
+      # Given an attribute for a given model as a string, return the column
+      # type associated with it.
+      #
+      # The attribute name intended for use here comes from validation and,
+      # when there are unsaved associations in an ActiveRecord graph that is
+      # being saved, ActiveRecord aggregates child object errors into the
+      # target parent being saved with the attribute names using a dot
+      # notation to indicate the path of methods to get from one instance to
+      # the next. This is resolved. For example:
+      #
+      # * <tt>address</tt> would look up the type of a column called
+      #   "address" in 'this' model.
+      #
+      # * <tt>addresses.home</tt> would look up the type of a column called
+      #   "home" in whatever is accessed by "model.addresses". If this gives
+      #   an array, the first entry in the array is taken for column type
+      #   retrieval.
+      #
+      # This path chasing will be done to an arbitrary depth. If at any point
+      # there is a failure to follow the path, the path follower exits and
+      # the top-level error is used instead, with a generic unknown column
+      # type returned.
+      #
+      # Parameters:
+      #
+      # +model_instance+:: The ActiveRecord model instance to inspect.
+      # +attribute_path+:: _String_ attribute path. Not a Symbol or Array!
+      #
+      # Return values are any ActiveRecord column type or these special
+      # values:
+      #
+      # * +unknown+ for any unrecognised attribute name or an attribute name
+      #   that is a path (it has one or more "."s in it) but where the path
+      #   cannot be followed.
+      #
+      # * +array+ for columns that appear to respond to the +array+ method.
+      #
+      # * +uuid+ for columns of any known but non-array type, where there is
+      #   a UuidValidator present.
+      #
+      def self.determine_deep_attribute_type( model_instance, attribute_path )
+
+        attribute_name  = attribute_path
+        target_instance = model_instance
+
+        # Descend a path of "foo.bar.baz" dereferencing associations from the
+        # field names in the dot-separated path until we're at the lowest leaf
+        # object with "baz" as its errant field.
+
+        if attribute_path.include?( '.' )
+
+          leaf_instance = target_instance
+          leaf_field    = attribute_path
+
+          fields        =  attribute_path.split( '.' )
+          leaf_field    = fields.pop() # (remove final entry - the leaf object's errant field)
+          reached_field = nil
+
+          fields.each do | field |
+            object_at_field = leaf_instance.send( field ) if   leaf_instance.respond_to?(  field )
+            object_at_field = object_at_field.first       if object_at_field.respond_to?( :first )
+
+            break if object_at_field.nil?
+
+            leaf_instance = object_at_field
+            reached_field = field
+          end
+
+          if reached_field == fields.last
+            attribute_name  = leaf_field
+            target_instance = leaf_instance
+          end
+        end
+
+        column = target_instance.class.columns_hash[ attribute_name ]
+
+        attribute_type = if column.nil?
+          'unknown'
+        elsif column.respond_to?( :array ) && column.array
+          'array'
+        elsif target_instance.class.validators_on( attribute_name ).any? { | v |
+            v.instance_of?( UuidValidator )
+          } # Considered a UUID since it uses the UUID validator
+          'uuid'
+        else
+          column.type.to_s()
+        end
+
+        return attribute_type
+      end
+
+      private_class_method( :determine_deep_attribute_type )
+
     end
   end
 end

data/lib/hoodoo/version.rb

@@ -12,11 +12,11 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  VERSION = '2.10.0'
+  VERSION = '2.11.0'
 
   # The Hoodoo gem date. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  DATE = '2018-12-04'
+  DATE = '2018-12-12'
 
 end

data/spec/active/active_record/error_mapping_shared_context.rb

@@ -0,0 +1,95 @@
+shared_context 'error mapping' do
+  before :all do
+    spec_helper_silence_stdout() do
+      ActiveRecord::Migration.create_table( :r_spec_model_error_mapping_tests ) do | t |
+        t.string   :uuid
+        t.boolean  :boolean
+        t.date     :date
+        t.datetime :datetime
+        t.decimal  :decimal, :precision => 5, :scale => 2
+        t.float    :float
+        t.integer  :integer
+        t.string   :string, :limit => 16
+        t.text     :text
+        t.time     :time
+        t.text     :array, :array => true
+      end unless ActiveRecord::Base.connection.table_exists?( :r_spec_model_error_mapping_tests )
+
+      ActiveRecord::Migration.create_table( :r_spec_model_associated_error_mapping_tests ) do | t |
+        t.string :other_string
+
+        # For 'has_many' - can't use "t.reference" as the generated
+        # column name is too long!
+        #
+        t.integer :many_id
+        t.index   :many_id
+      end unless ActiveRecord::Base.connection.table_exists?( :r_spec_model_associated_error_mapping_tests )
+
+      class RSpecModelErrorMappingTest < ActiveRecord::Base
+        include Hoodoo::ActiveRecord::ErrorMapping
+
+        has_many :r_spec_model_associated_error_mapping_tests,
+                 :foreign_key => :many_id,
+                 :class_name  => :RSpecModelAssociatedErrorMappingTest
+
+        accepts_nested_attributes_for :r_spec_model_associated_error_mapping_tests
+
+        validates_presence_of :boolean,
+                              :date,
+                              :datetime,
+                              :decimal,
+                              :float,
+                              :integer,
+                              :string,
+                              :text,
+                              :time,
+                              :array
+
+        validates_uniqueness_of :integer
+        validates :string, :length => { :maximum => 16 }
+        validates :uuid, :uuid => true
+
+        validate do
+          if string == 'magic'
+            errors.add( 'this.thing', 'is not a column' )
+          end
+        end
+      end
+
+      class RSpecModelAssociatedErrorMappingTest < ActiveRecord::Base
+        belongs_to :r_spec_model_error_mapping_test,
+                   :foreign_key => :many_id,
+                   :class_name  => :RSpecModelErrorMappingTest
+
+        validates :other_string, :length => { :maximum => 6 }
+      end
+
+      class RSpecModelErrorMappingTestBase < ActiveRecord::Base
+        self.table_name = RSpecModelErrorMappingTest.table_name
+
+        include Hoodoo::ActiveRecord::ErrorMapping
+
+        validate do | instance |
+          instance.errors.clear()
+          instance.errors.add( :base, 'this is a test' )
+        end
+      end
+    end
+  end
+
+  let( :valid_model ) {
+    RSpecModelErrorMappingTest.new( {
+      :uuid     => Hoodoo::UUID.generate(),
+      :boolean  => true,
+      :date     => Time.now,
+      :datetime => Time.now,
+      :decimal  => 2.3,
+      :float    => 2.3,
+      :integer  => 42,
+      :string   => "hello",
+      :text     => "hello",
+      :time     => Time.now,
+      :array    => [ 'hello' ]
+    } )
+  }
+end

data/spec/active/active_record/error_mapping_spec.rb

@@ -1,106 +1,15 @@
 require 'spec_helper'
 require 'active_record'
+require 'active/active_record/error_mapping_shared_context'
 
 describe Hoodoo::ActiveRecord::ErrorMapping do
-  before :all do
-    spec_helper_silence_stdout() do
-      ActiveRecord::Migration.create_table( :r_spec_model_error_mapping_tests ) do | t |
-        t.string   :uuid
-        t.boolean  :boolean
-        t.date     :date
-        t.datetime :datetime
-        t.decimal  :decimal, :precision => 5, :scale => 2
-        t.float    :float
-        t.integer  :integer
-        t.string   :string, :limit => 16
-        t.text     :text
-        t.time     :time
-        t.text     :array, :array => true
-      end
-
-      ActiveRecord::Migration.create_table( :r_spec_model_associated_error_mapping_tests ) do | t |
-        t.string :other_string
-
-        # For 'has_many' - can't use "t.reference" as the generated
-        # column name is too long!
-        #
-        t.integer :many_id
-        t.index   :many_id
-      end
-
-      class RSpecModelErrorMappingTest < ActiveRecord::Base
-        include Hoodoo::ActiveRecord::ErrorMapping
-
-        has_many :r_spec_model_associated_error_mapping_tests,
-                 :foreign_key => :many_id,
-                 :class_name  => :RSpecModelAssociatedErrorMappingTest
-
-        accepts_nested_attributes_for :r_spec_model_associated_error_mapping_tests
-
-        validates_presence_of :boolean,
-                              :date,
-                              :datetime,
-                              :decimal,
-                              :float,
-                              :integer,
-                              :string,
-                              :text,
-                              :time,
-                              :array
-
-        validates_uniqueness_of :integer
-        validates :string, :length => { :maximum => 16 }
-        validates :uuid, :uuid => true
-
-        validate do
-          if string == 'magic'
-            errors.add( 'this.thing', 'is not a column' )
-          end
-        end
-      end
-
-      class RSpecModelAssociatedErrorMappingTest < ActiveRecord::Base
-        belongs_to :r_spec_model_error_mapping_test,
-                   :foreign_key => :many_id,
-                   :class_name  => :RSpecModelErrorMappingTest
-
-        validates :other_string, :length => { :maximum => 6 }
-      end
-
-      class RSpecModelErrorMappingTestBase < ActiveRecord::Base
-        self.table_name = RSpecModelErrorMappingTest.table_name
-
-        include Hoodoo::ActiveRecord::ErrorMapping
-
-        validate do | instance |
-          instance.errors.add( :base, 'this is a test' )
-        end
-      end
-    end
-  end
+  include_context 'error mapping'
 
   before :each do
     @errors = Hoodoo::Errors.new( Hoodoo::ErrorDescriptions.new )
   end
 
-  let( :valid_model ) {
-    RSpecModelErrorMappingTest.new( {
-      :uuid     => Hoodoo::UUID.generate(),
-      :boolean  => true,
-      :date     => Time.now,
-      :datetime => Time.now,
-      :decimal  => 2.3,
-      :float    => 2.3,
-      :integer  => 42,
-      :string   => "hello",
-      :text     => "hello",
-      :time     => Time.now,
-      :array    => [ 'hello' ]
-    } )
-  }
-
   it 'auto-validates and maps errors correctly' do
-
     m = RSpecModelErrorMappingTest.new( :uuid => 'not a valid UUID' )
     expect( m.adds_errors_to?( @errors ) ).to eq( true )
 
@@ -170,6 +79,7 @@ describe Hoodoo::ActiveRecord::ErrorMapping do
     m = RSpecModelErrorMappingTestBase.new
 
     expect( m.adds_errors_to?( @errors ) ).to eq( true )
+
     expect( @errors.errors ).to eq( [
       {
         "code" => "generic.invalid_parameters",
@@ -273,44 +183,51 @@ describe Hoodoo::ActiveRecord::ErrorMapping do
     ] )
   end
 
-  it 'handles downgrade to generic error code' do
-
+  context 'downgrade to generic error code' do
     class LocalHackableErrors < Hoodoo::ErrorDescriptions
     end
 
-    @errors = Hoodoo::Errors.new( Hoodoo::ErrorDescriptions.new )
-
     # We have to hack to test this...
     #
-    desc = @errors.descriptions.instance_variable_get( '@descriptions' )
-    desc.delete( 'generic.invalid_boolean' )
-    desc.delete( 'generic.invalid_date' )
-
-    m = RSpecModelErrorMappingTest.new( {
-      :datetime => Time.now,
-      :decimal  => 2.3,
-      :float    => 2.3,
-      :integer  => 42,
-      :string   => "hello",
-      :text     => "hello",
-      :time     => Time.now,
-      :array    => [ 'hello' ]
-    } )
+    before :all do
+      @collection = Hoodoo::Errors.new( Hoodoo::ErrorDescriptions.new )
+      @desc       = @collection.descriptions.instance_variable_get( '@descriptions' )
+      @val1       = @desc.delete( 'generic.invalid_boolean' )
+      @val2       = @desc.delete( 'generic.invalid_date' )
+    end
 
-    m.adds_errors_to?( @errors )
+    after :all do
+      @desc[ 'generic.invalid_boolean' ] = @val1
+      @desc[ 'generic.invalid_date'    ] = @val2
+    end
 
-    expect( @errors.errors ).to eq( [
-      {
-        "code" => "generic.invalid_parameters",
-        "message" => "can't be blank",
-        "reference" => "boolean"
-      },
-      {
-        "code" => "generic.invalid_parameters",
-        "message" => "can't be blank",
-        "reference" => "date"
-      }
-    ] )
+    it "is handled" do
+      m = RSpecModelErrorMappingTest.new( {
+        :datetime => Time.now,
+        :decimal  => 2.3,
+        :float    => 2.3,
+        :integer  => 42,
+        :string   => "hello",
+        :text     => "hello",
+        :time     => Time.now,
+        :array    => [ 'hello' ]
+      } )
+
+      m.adds_errors_to?( @collection )
+
+      expect( @collection.errors ).to eq( [
+        {
+          "code" => "generic.invalid_parameters",
+          "message" => "can't be blank",
+          "reference" => "boolean"
+        },
+        {
+          "code" => "generic.invalid_parameters",
+          "message" => "can't be blank",
+          "reference" => "date"
+        }
+      ] )
+    end
   end
 
   it 'adds nothing if the model is valid' do

data/spec/active/active_record/support_spec.rb

@@ -1,4 +1,5 @@
-require 'spec_helper.rb'
+require 'spec_helper'
+require 'active/active_record/error_mapping_shared_context'
 
 describe Hoodoo::ActiveRecord::Support do
   context '#framework_search_and_filter_data' do
@@ -312,4 +313,262 @@ describe Hoodoo::ActiveRecord::Support do
       end
     end
   end
+
+  context '#translate_errors_to' do
+    include_context 'error mapping'
+
+    it 'adds nothing if the model is valid' do
+      m = valid_model
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [] )
+      expect { m.save! }.to_not raise_error
+    end
+
+    it 'maps column types correctly' do
+      m = RSpecModelErrorMappingTest.new( :uuid => 'not a valid UUID' )
+      m.validate()
+
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [
+        {
+          "code" => "generic.invalid_boolean",
+          "message" => "can't be blank",
+          "reference" => "boolean"
+        },
+        {
+          "code" => "generic.invalid_date",
+          "message" => "can't be blank",
+          "reference" => "date"
+        },
+        {
+          "code" => "generic.invalid_datetime",
+          "message" => "can't be blank",
+          "reference" => "datetime"
+        },
+        {
+          "code" => "generic.invalid_decimal",
+          "message" => "can't be blank",
+          "reference" => "decimal"
+        },
+        {
+          "code" => "generic.invalid_float",
+          "message" => "can't be blank",
+          "reference" => "float"
+        },
+        {
+          "code" => "generic.invalid_integer",
+          "message" => "can't be blank",
+          "reference" => "integer"
+        },
+        {
+          "code" => "generic.invalid_string",
+          "message" => "can't be blank",
+          "reference" => "string"
+        },
+        {
+          "code" => "generic.invalid_string",
+          "message" => "can't be blank",
+          "reference" => "text"
+        },
+        {
+          "code" => "generic.invalid_time",
+          "message" => "can't be blank",
+          "reference" => "time"
+        },
+        {
+          "code" => "generic.invalid_array",
+          "message" => "can't be blank",
+          "reference" => "array"
+        },
+
+        # Checks that custom UUID validator is working.
+
+        {
+          "code" => "generic.invalid_uuid",
+          "message" => "is invalid",
+          "reference" => "uuid"
+        }
+      ] )
+    end
+
+    it 'maps "base" errors correctly' do
+      m = RSpecModelErrorMappingTestBase.new
+
+      m.validate()
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [
+        {
+          "code" => "generic.invalid_parameters",
+          "message" => "this is a test",
+          "reference" => "model instance"
+        }
+      ] )
+    end
+
+    it 'adds to an existing collection' do
+      m = RSpecModelErrorMappingTestBase.new
+      collection = Hoodoo::Errors.new
+
+      collection.add_error( 'platform.timeout' )
+
+      m.validate()
+      expect( described_class.translate_errors_on( m, collection ).errors ).to eq( [
+        {
+          "code" => "platform.timeout",
+          "message" => "Request timeout"
+        },
+        {
+          "code" => "generic.invalid_parameters",
+          "message" => "this is a test",
+          "reference" => "model instance"
+        }
+      ] )
+    end
+
+    it 'handles varying validation types' do
+      m = RSpecModelErrorMappingTest.new( {
+        :boolean  => true,
+        :date     => Time.now,
+        :datetime => Time.now,
+        :decimal  => 2.3,
+        :float    => 2.3,
+        :integer  => 42,
+        :string   => "hello - this is far too long for the maximum field length",
+        :text     => "hello",
+        :time     => Time.now,
+        :array    => [ 'hello' ]
+      } )
+
+      m.validate()
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [
+        {
+          "code" => "generic.invalid_string",
+          "message" => "is too long (maximum is 16 characters)",
+          "reference" => "string"
+        }
+      ] )
+    end
+
+    it 'handles arrays' do
+      m = RSpecModelErrorMappingTest.new( {
+        :boolean  => true,
+        :date     => Time.now,
+        :datetime => Time.now,
+        :decimal  => 2.3,
+        :float    => 2.3,
+        :integer  => 42,
+        :string   => 'hello',
+        :text     => 'world',
+        :time     => Time.now,
+        :array    => []
+      } )
+
+      array_col = RSpecModelErrorMappingTest.columns_hash[ 'array' ]
+      expect( array_col ).to receive( :array ).once.and_return( true )
+
+      m.validate()
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [
+        {
+          "code" => "generic.invalid_array",
+          "message" => "can't be blank",
+          "reference" => "array"
+        }
+      ] )
+    end
+
+    it 'maps duplicates' do
+      m = valid_model
+
+      m.validate()
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [] )
+      m.save!
+
+      n = m.dup
+      n.validate()
+      expect( described_class.translate_errors_on( n ).errors ).to eq( [
+        {
+          "code" => "generic.invalid_duplication",
+          "message" => "has already been taken",
+          "reference" => "integer"
+        }
+      ] )
+    end
+
+    context 'downgrade to generic error code' do
+      class LocalHackableErrors < Hoodoo::ErrorDescriptions
+      end
+
+      # We have to hack to test this...
+      #
+      before :all do
+        @collection = Hoodoo::Errors.new( Hoodoo::ErrorDescriptions.new )
+        @desc       = @collection.descriptions.instance_variable_get( '@descriptions' )
+        @val1       = @desc.delete( 'generic.invalid_boolean' )
+        @val2       = @desc.delete( 'generic.invalid_date' )
+      end
+
+      after :all do
+        @desc[ 'generic.invalid_boolean' ] = @val1
+        @desc[ 'generic.invalid_date'    ] = @val2
+      end
+
+      it "is handled" do
+        m = RSpecModelErrorMappingTest.new( {
+          :datetime => Time.now,
+          :decimal  => 2.3,
+          :float    => 2.3,
+          :integer  => 42,
+          :string   => "hello",
+          :text     => "hello",
+          :time     => Time.now,
+          :array    => [ 'hello' ]
+        } )
+
+        m.validate()
+        expect( described_class.translate_errors_on( m, @collection ).errors ).to eq( [
+          {
+            "code" => "generic.invalid_parameters",
+            "message" => "can't be blank",
+            "reference" => "boolean"
+          },
+          {
+            "code" => "generic.invalid_parameters",
+            "message" => "can't be blank",
+            "reference" => "date"
+          }
+        ] )
+      end
+    end
+
+    it 'has-many associations are dereferenced' do
+      attrs = valid_model.attributes
+      attrs[ 'r_spec_model_associated_error_mapping_tests_attributes' ] = [
+        { :other_string => 'ok 1' },
+        { :other_string => 'ok 2' },
+        { :other_string => 'too long, so fails validation' }
+      ]
+
+      m = RSpecModelErrorMappingTest.new( attrs )
+
+      m.validate()
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [
+        {
+          "code" => "generic.invalid_string",
+          "message" => "is too long (maximum is 6 characters)",
+          "reference" => "r_spec_model_associated_error_mapping_tests.other_string"
+        }
+      ] )
+    end
+
+    it 'works with dot-separated non-attribute paths' do
+      m = valid_model
+      m.string = 'magic'
+
+      m.validate()
+      expect( described_class.translate_errors_on( m ).errors ).to eq( [
+        {
+          "code" => "generic.invalid_parameters",
+          "message" => "is not a column",
+          "reference" => "this.thing"
+        }
+      ] )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -458,6 +458,7 @@ files:
 - spec/active/active_record/base_spec.rb
 - spec/active/active_record/creator_spec.rb
 - spec/active/active_record/dated_spec.rb
+- spec/active/active_record/error_mapping_shared_context.rb
 - spec/active/active_record/error_mapping_spec.rb
 - spec/active/active_record/finder_spec.rb
 - spec/active/active_record/manually_dated_spec.rb
@@ -603,126 +604,127 @@ signing_key:
 specification_version: 4
 summary: Opinionated APIs
 test_files:
-- spec/active/active_record/base_spec.rb
-- spec/active/active_record/creator_spec.rb
-- spec/active/active_record/dated_spec.rb
-- spec/active/active_record/error_mapping_spec.rb
-- spec/active/active_record/finder_spec.rb
-- spec/active/active_record/manually_dated_spec.rb
-- spec/active/active_record/search_helper_spec.rb
-- spec/active/active_record/secure_spec.rb
-- spec/active/active_record/security_helper_spec.rb
-- spec/active/active_record/support_spec.rb
-- spec/active/active_record/translated_spec.rb
-- spec/active/active_record/uuid_spec.rb
-- spec/active/active_record/writer_spec.rb
-- spec/client/augmented_array_spec.rb
-- spec/client/augmented_base_spec.rb
-- spec/client/augmented_hash_spec.rb
-- spec/client/client_spec.rb
-- spec/client/endpoint/endpoint_spec.rb
-- spec/client/endpoint/endpoints/amqp_spec.rb
-- spec/client/endpoint/endpoints/auto_session_spec.rb
-- spec/client/endpoint/endpoints/http_based_spec.rb
-- spec/client/endpoint/endpoints/http_spec.rb
-- spec/client/endpoint/endpoints/not_found_spec.rb
-- spec/client/headers_spec.rb
-- spec/client/paginated_enumeration_spec.rb
-- spec/communicators/fast_spec.rb
-- spec/communicators/pool_spec.rb
-- spec/communicators/slow_spec.rb
-- spec/data/resources/caller_spec.rb
-- spec/data/resources/errors_spec.rb
-- spec/data/resources/log_spec.rb
-- spec/data/resources/session_spec.rb
-- spec/data/types/error_primitive_spec.rb
-- spec/data/types/permissions_defaults_spec.rb
-- spec/data/types/permissions_full_spec.rb
-- spec/data/types/permissions_resources_spec.rb
-- spec/data/types/permissions_spec.rb
-- spec/ddtrace.rb
+- spec/shared_examples/middleware_amqp.rb
+- spec/newrelic_rpm.rb
 - spec/errors/error_descriptions_spec.rb
 - spec/errors/errors_spec.rb
-- spec/files/regenerate.rb
-- spec/integration/service_actions_spec.rb
-- spec/logger/fast_writer_spec.rb
-- spec/logger/logger_spec.rb
-- spec/logger/slow_writer_spec.rb
-- spec/logger/writers/file_writer_spec.rb
-- spec/logger/writers/log_entries_dot_com_writer_spec.rb
-- spec/logger/writers/stream_writer_spec.rb
-- spec/monkey/monkey_spec.rb
-- spec/monkey/patch/datadog_traced_amqp_spec.rb
-- spec/monkey/patch/newrelic_middleware_analytics_spec.rb
-- spec/monkey/patch/newrelic_traced_amqp_spec.rb
-- spec/new_relic/agent/logger.rb
-- spec/new_relic/agent/method_tracer.rb
-- spec/new_relic/agent/transaction.rb
-- spec/newrelic_rpm.rb
-- spec/presenters/base_dsl_spec.rb
-- spec/presenters/base_spec.rb
-- spec/presenters/common_resource_fields_spec.rb
-- spec/presenters/embedding_spec.rb
-- spec/presenters/types/array_spec.rb
-- spec/presenters/types/boolean_spec.rb
-- spec/presenters/types/date_spec.rb
-- spec/presenters/types/date_time_spec.rb
-- spec/presenters/types/decimal_spec.rb
-- spec/presenters/types/enum_spec.rb
-- spec/presenters/types/field_spec.rb
-- spec/presenters/types/float_spec.rb
-- spec/presenters/types/hash_spec.rb
-- spec/presenters/types/integer_spec.rb
-- spec/presenters/types/object_spec.rb
-- spec/presenters/types/string_spec.rb
-- spec/presenters/types/tags_spec.rb
-- spec/presenters/types/text_spec.rb
-- spec/presenters/types/uuid_spec.rb
-- spec/presenters/walk_spec.rb
-- spec/services/discovery/discoverers/by_convention_spec.rb
-- spec/services/discovery/discoverers/by_drb/by_drb_spec.rb
-- spec/services/discovery/discoverers/by_drb/drb_server_spec.rb
-- spec/services/discovery/discoverers/by_flux_spec.rb
+- spec/ddtrace.rb
+- spec/services/services/interface_spec.rb
+- spec/services/services/application_spec.rb
+- spec/services/services/session_spec.rb
+- spec/services/services/response_spec.rb
+- spec/services/services/permissions_spec.rb
+- spec/services/services/request_spec.rb
+- spec/services/services/implementation_spec.rb
+- spec/services/services/context_spec.rb
 - spec/services/discovery/discovery_spec.rb
-- spec/services/discovery/results/for_amqp_spec.rb
+- spec/services/discovery/results/for_remote_spec.rb
 - spec/services/discovery/results/for_http_spec.rb
+- spec/services/discovery/results/for_amqp_spec.rb
 - spec/services/discovery/results/for_local_spec.rb
-- spec/services/discovery/results/for_remote_spec.rb
-- spec/services/middleware/amqp_log_writer_spec.rb
-- spec/services/middleware/endpoints/inter_resource_local_spec.rb
+- spec/services/discovery/discoverers/by_convention_spec.rb
+- spec/services/discovery/discoverers/by_flux_spec.rb
+- spec/services/discovery/discoverers/by_drb/by_drb_spec.rb
+- spec/services/discovery/discoverers/by_drb/drb_server_spec.rb
 - spec/services/middleware/endpoints/inter_resource_remote_spec.rb
-- spec/services/middleware/exception_reporting/base_reporter_spec.rb
-- spec/services/middleware/exception_reporting/exception_reporting_spec.rb
-- spec/services/middleware/exception_reporting/reporters/airbrake_reporter_spec.rb
-- spec/services/middleware/exception_reporting/reporters/raygun_reporter_spec.rb
+- spec/services/middleware/endpoints/inter_resource_local_spec.rb
 - spec/services/middleware/middleware_assumed_identity_spec.rb
-- spec/services/middleware/middleware_cors_spec.rb
 - spec/services/middleware/middleware_create_update_spec.rb
-- spec/services/middleware/middleware_dated_at_spec.rb
+- spec/services/middleware/middleware_spec.rb
 - spec/services/middleware/middleware_exotic_communication_spec.rb
+- spec/services/middleware/string_inquirer_spec.rb
+- spec/services/middleware/middleware_public_spec.rb
 - spec/services/middleware/middleware_logging_spec.rb
+- spec/services/middleware/middleware_dated_at_spec.rb
 - spec/services/middleware/middleware_multi_local_spec.rb
-- spec/services/middleware/middleware_multi_remote_spec.rb
+- spec/services/middleware/amqp_log_writer_spec.rb
+- spec/services/middleware/middleware_cors_spec.rb
 - spec/services/middleware/middleware_permissions_spec.rb
-- spec/services/middleware/middleware_public_spec.rb
-- spec/services/middleware/middleware_spec.rb
-- spec/services/middleware/string_inquirer_spec.rb
-- spec/services/services/application_spec.rb
-- spec/services/services/context_spec.rb
-- spec/services/services/implementation_spec.rb
-- spec/services/services/interface_spec.rb
-- spec/services/services/permissions_spec.rb
-- spec/services/services/request_spec.rb
-- spec/services/services/response_spec.rb
-- spec/services/services/session_spec.rb
-- spec/shared_examples/middleware_amqp.rb
-- spec/spec_helper.rb
-- spec/transient_store/transient_store/base_spec.rb
-- spec/transient_store/transient_store/memcached_redis_mirror_spec.rb
-- spec/transient_store/transient_store/memcached_spec.rb
+- spec/services/middleware/exception_reporting/exception_reporting_spec.rb
+- spec/services/middleware/exception_reporting/reporters/airbrake_reporter_spec.rb
+- spec/services/middleware/exception_reporting/reporters/raygun_reporter_spec.rb
+- spec/services/middleware/exception_reporting/base_reporter_spec.rb
+- spec/services/middleware/middleware_multi_remote_spec.rb
+- spec/files/regenerate.rb
+- spec/integration/service_actions_spec.rb
+- spec/new_relic/agent/transaction.rb
+- spec/new_relic/agent/method_tracer.rb
+- spec/new_relic/agent/logger.rb
+- spec/communicators/pool_spec.rb
+- spec/communicators/slow_spec.rb
+- spec/communicators/fast_spec.rb
 - spec/transient_store/transient_store/mocks/dalli_client_spec.rb
 - spec/transient_store/transient_store/mocks/redis_spec.rb
+- spec/transient_store/transient_store/memcached_redis_mirror_spec.rb
+- spec/transient_store/transient_store/base_spec.rb
 - spec/transient_store/transient_store/redis_spec.rb
+- spec/transient_store/transient_store/memcached_spec.rb
 - spec/transient_store/transient_store_spec.rb
-- spec/utilities/utilities_spec.rb
+- spec/spec_helper.rb
 - spec/utilities/uuid_spec.rb
+- spec/utilities/utilities_spec.rb
+- spec/presenters/common_resource_fields_spec.rb
+- spec/presenters/embedding_spec.rb
+- spec/presenters/base_spec.rb
+- spec/presenters/walk_spec.rb
+- spec/presenters/types/float_spec.rb
+- spec/presenters/types/text_spec.rb
+- spec/presenters/types/date_spec.rb
+- spec/presenters/types/uuid_spec.rb
+- spec/presenters/types/object_spec.rb
+- spec/presenters/types/hash_spec.rb
+- spec/presenters/types/field_spec.rb
+- spec/presenters/types/array_spec.rb
+- spec/presenters/types/decimal_spec.rb
+- spec/presenters/types/string_spec.rb
+- spec/presenters/types/enum_spec.rb
+- spec/presenters/types/boolean_spec.rb
+- spec/presenters/types/date_time_spec.rb
+- spec/presenters/types/integer_spec.rb
+- spec/presenters/types/tags_spec.rb
+- spec/presenters/base_dsl_spec.rb
+- spec/monkey/patch/newrelic_traced_amqp_spec.rb
+- spec/monkey/patch/datadog_traced_amqp_spec.rb
+- spec/monkey/patch/newrelic_middleware_analytics_spec.rb
+- spec/monkey/monkey_spec.rb
+- spec/logger/slow_writer_spec.rb
+- spec/logger/logger_spec.rb
+- spec/logger/fast_writer_spec.rb
+- spec/logger/writers/stream_writer_spec.rb
+- spec/logger/writers/file_writer_spec.rb
+- spec/logger/writers/log_entries_dot_com_writer_spec.rb
+- spec/client/augmented_array_spec.rb
+- spec/client/paginated_enumeration_spec.rb
+- spec/client/endpoint/endpoints/http_spec.rb
+- spec/client/endpoint/endpoints/http_based_spec.rb
+- spec/client/endpoint/endpoints/amqp_spec.rb
+- spec/client/endpoint/endpoints/not_found_spec.rb
+- spec/client/endpoint/endpoints/auto_session_spec.rb
+- spec/client/endpoint/endpoint_spec.rb
+- spec/client/headers_spec.rb
+- spec/client/augmented_hash_spec.rb
+- spec/client/augmented_base_spec.rb
+- spec/client/client_spec.rb
+- spec/active/active_record/translated_spec.rb
+- spec/active/active_record/secure_spec.rb
+- spec/active/active_record/support_spec.rb
+- spec/active/active_record/search_helper_spec.rb
+- spec/active/active_record/uuid_spec.rb
+- spec/active/active_record/security_helper_spec.rb
+- spec/active/active_record/dated_spec.rb
+- spec/active/active_record/base_spec.rb
+- spec/active/active_record/manually_dated_spec.rb
+- spec/active/active_record/error_mapping_shared_context.rb
+- spec/active/active_record/writer_spec.rb
+- spec/active/active_record/error_mapping_spec.rb
+- spec/active/active_record/finder_spec.rb
+- spec/active/active_record/creator_spec.rb
+- spec/data/resources/log_spec.rb
+- spec/data/resources/errors_spec.rb
+- spec/data/resources/session_spec.rb
+- spec/data/resources/caller_spec.rb
+- spec/data/types/error_primitive_spec.rb
+- spec/data/types/permissions_defaults_spec.rb
+- spec/data/types/permissions_resources_spec.rb
+- spec/data/types/permissions_full_spec.rb
+- spec/data/types/permissions_spec.rb