ncs_mdes_warehouse 0.6.0 → 0.6.1

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 NCS Navigator MDES Warehouse History
 ====================================
 
+0.6.1
+-----
+
+- Change validation error reporting: Each validation error in
+  EnumTransformer now produces a separate TransformError. (Previously
+  they were concatenated into a single error.) (#2155)
+
+- Provide a SubprocessTransformer-compatible JSON serialization on
+  TransformError. (#2199)
+
 0.6.0
 -----
 

data/lib/ncs_navigator/warehouse/transform_status.rb

@@ -1,5 +1,6 @@
 require 'ncs_navigator/warehouse'
 require 'ncs_navigator/warehouse/data_mapper'
+require 'json'
 
 module NcsNavigator::Warehouse
   ##
@@ -38,12 +39,13 @@ module NcsNavigator::Warehouse
       self.transform_errors << TransformError.new(:message => message)
     end
 
-    def unsuccessful_record(record, message)
+    def unsuccessful_record(record, message, error_attributes={})
       self.transform_errors <<
-        TransformError.new(
+        TransformError.new({
           :model_class => record.class.name,
           :record_id => (record.key.first if record && record.key),
-          :message => message)
+          :message => message
+        }.merge(error_attributes))
     end
   end
 
@@ -57,6 +59,8 @@ module NcsNavigator::Warehouse
     property :message,     Text,   :required => true
     property :model_class, String, :length => 255
     property :record_id,   String, :length => 255
+    property :attribute_name,  String, :length => 255
+    property :attribute_value, Text
 
     belongs_to :transform_status, TransformStatus, :required => true
 
@@ -68,6 +72,28 @@ module NcsNavigator::Warehouse
         ].compact.join("\n")
       )
     end
+
+    ##
+    # Provides fpr a JSON serialization that is compatible with
+    # {SubprocessTransformer}.
+    #
+    # @return [Hash] a key-value object containing just the
+    #   serializable components of this instance
+    def as_json
+      model.properties.
+        reject { |p| [:id, :transform_status_id].include?(p.name) }.
+        inject({}) { |json, prop|
+          value = self.send(prop.name)
+          json[prop.name.to_s] = value if value
+          json
+        }
+    end
+
+    ##
+    # @return [String] single-line JSON serialization of {#as_json}.
+    def to_json
+      as_json.to_json
+    end
   end
 
   TransformError.finalize

data/lib/ncs_navigator/warehouse/transformers/enum_transformer.rb

@@ -98,9 +98,11 @@ module NcsNavigator::Warehouse::Transformers
 
     def save_model_instance(record, status)
       if !has_valid_psu?(record)
-        msg = "Invalid PSU ID #{record.psu_id.inspect}. The list of valid PSU IDs for this Study Center is #{@configuration.navigator.psus.collect(&:id).inspect}."
+        msg = "Invalid PSU ID. The list of valid PSU IDs for this Study Center is #{@configuration.navigator.psus.collect(&:id).inspect}."
         log.error "#{record_ident record}: #{msg}"
-        status.unsuccessful_record(record, msg)
+        status.unsuccessful_record(record, msg,
+          :attribute_name => 'psu_id',
+          :attribute_value => record.psu_id.inspect)
       elsif record.valid?
         log.debug("Saving valid record #{record_ident record}.")
         begin
@@ -115,9 +117,16 @@ module NcsNavigator::Warehouse::Transformers
           status.unsuccessful_record(record, msg)
         end
       else
-        msg = "Invalid record. #{record_messages(record).join(' ')}"
-        log.error msg
-        status.unsuccessful_record(record, msg)
+        log.error "Invalid record. #{record_messages(record).join(' ')}"
+        record.errors.keys.each do |prop|
+          record.errors[prop].each do |e|
+            status.unsuccessful_record(
+              record, "Invalid: #{e}.",
+              :attribute_name => prop,
+              :attribute_value => record.send(prop).inspect
+            )
+          end
+        end
       end
       status.record_count += 1
     end

data/lib/ncs_navigator/warehouse/version.rb

@@ -1,5 +1,5 @@
 module NcsNavigator
   module Warehouse
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
   end
 end

data/ncs_mdes_warehouse.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'ncs_mdes', '~> 0.6', '>= 0.6.1'
   s.add_dependency 'ncs_navigator_configuration', '~> 0.2'
 
-  s.add_dependency 'activesupport', '~> 3.0'
+  # Post-3.2.4 breaks DataMapper due to https://github.com/rails/rails/pull/6857
+  s.add_dependency 'activesupport', '~> 3.0', '< 3.2.4'
   s.add_dependency 'i18n', '~> 0.4' # required by activesupport
 
   s.add_dependency 'thor', '~> 0.14.6'

data/spec/ncs_navigator/warehouse/transform_status_spec.rb

@@ -62,5 +62,46 @@ module NcsNavigator::Warehouse
         end
       end
     end
+
+    describe '#to_json' do
+      let(:error) {
+        TransformError.new(
+          :message => "It's\n complicated",
+          :model_class => SampleRecordishThing.to_s,
+          :record_id => '45-T',
+          :attribute_name => 'Fred',
+          :attribute_value => 'MacMurray'
+        )
+      }
+      let(:json) { error.to_json }
+      let(:parsed) { JSON.parse(json) }
+
+      it 'is a single line' do
+        json.should_not =~ /\n/
+      end
+
+      describe 'the JSON contents' do
+        %w(message model_class record_id attribute_name attribute_value).each do |prop|
+          it "includes the #{prop.gsub('_', ' ')}" do
+            parsed[prop].should == error.send(prop)
+          end
+
+          it "does not include #{prop.gsub('_', ' ')} when it isn't set" do
+            error.send("#{prop}=", nil)
+            parsed.should_not have_key(prop)
+          end
+        end
+
+        it 'never contains the transform status ID' do
+          error.transform_status_id = 5
+          parsed.should_not have_key('transform_status_id')
+        end
+
+        it "never contains the error's own ID" do
+          error.id = 7
+          parsed.should_not have_key('id')
+        end
+      end
+    end
   end
 end

data/spec/ncs_navigator/warehouse/transformers/enum_transformer_spec.rb

@@ -8,7 +8,7 @@ module NcsNavigator::Warehouse::Transformers
       include ::DataMapper::Resource
 
       property :psu_id, String
-      property :recruit_type, String
+      property :recruit_type, String, :format => /^\d$/
       property :id, Integer, :key => true
       property :name, String, :required => true
     end
@@ -46,15 +46,37 @@ module NcsNavigator::Warehouse::Transformers
           records[0].should_receive(:save).and_return(true)
           records[1].should_receive(:save).and_return(true)
           records[2].name = nil
+          records[2].recruit_type = 'H'
 
           subject.transform(transform_status)
         end
 
-        it 'records the invalid instance' do
-          err = transform_status.transform_errors.first
-          err.model_class.should == Sample.to_s
-          err.record_id.should == '3'
-          err.message.should == 'Invalid record. Name must not be blank (name=nil).'
+        it 'records each invalidity separately' do
+          transform_status.transform_errors.size.should == 2
+        end
+
+        describe 'the error for an invalidity' do
+          let(:err) { transform_status.transform_errors.sort_by { |te| te.message }.last }
+
+          it "knows the record's class" do
+            err.model_class.should == Sample.to_s
+          end
+
+          it 'knows the record ID' do
+            err.record_id.should == '3'
+          end
+
+          it 'has the invalidity message' do
+            err.message.should == 'Invalid: Recruit type has an invalid format.'
+          end
+
+          it 'knows the invalid attribute' do
+            err.attribute_name.should == 'recruit_type'
+          end
+
+          it 'knows the invalid value' do
+            err.attribute_value.should == '"H"'
+          end
         end
 
         it 'saves the other instances' do
@@ -101,7 +123,15 @@ module NcsNavigator::Warehouse::Transformers
 
           it 'has a message' do
             error.message.should ==
-              'Invalid PSU ID "20000041". The list of valid PSU IDs for this Study Center is ["20000030", "20000042"].'
+              'Invalid PSU ID. The list of valid PSU IDs for this Study Center is ["20000030", "20000042"].'
+          end
+
+          it 'has the PSU attribute' do
+            error.attribute_name.should == 'psu_id'
+          end
+
+          it 'has the invalid value' do
+            error.attribute_value.should == '"20000041"'
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ncs_mdes_warehouse
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2012-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ncs_mdes
@@ -57,6 +57,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -65,6 +68,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.2.4
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -1391,7 +1397,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3515140994964580635
+      hash: 766009229452089340
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -1400,7 +1406,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3515140994964580635
+      hash: 766009229452089340
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24