stockboy 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b61bae292712fd23cbd3670b7af75f1c1accd9f3
-  data.tar.gz: b7bf75470c330236ae3853f3a70a73827197da2b
+  metadata.gz: b590275e79cec3c13367aa9afd5c2834c72136fe
+  data.tar.gz: 5b0c8114e76759d46507f9015a0af11a60dcc322
 SHA512:
-  metadata.gz: debeaaa64a47c5ebd9cf4feeff2f2e4d7410eb59c4157d4ddadf8b498a807bc84558db597d7e4d3bd72b9bee0c599181e8ebac9370e9e48fb13f0cbd066d0966
-  data.tar.gz: f1474b711a72cbda96c44e3324d0214c8a2270ba4c0d81529ebb07d8a848a580e74c260ae01679de4b8dfc7cb99209cd33f0186501f23752ea19562794c15af7
+  metadata.gz: ebae87b6ddc0f7f90faed9d3e31ea5dc2e381bce97347b16cc94a91386d65e53a7dfa54ae988aeb0721e3f9c81f5a46bc4be676a7e42091b071013e3b0c24266
+  data.tar.gz: b5ee7acaf3385daf91c0dca08c283296a555ba4d37dbdce2a54254a74e2a0398bbc55457f5b3ab138afe6a5a9041985c9ab67ada07ff3a9642a95144343382ef

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.0 / 2016-08-02
+
+* [ENHANCEMENT] Option to handle errors raised in translation chain
+
 ## 1.1.2 / 2016-05-26
 
 * [BUGFIX]      Cast other types in string converter to string

data/Gemfile

@@ -22,3 +22,8 @@ platforms :rbx do
   gem "rubysl", "~> 2.0"
   gem "racc"
 end
+
+if RUBY_VERSION < "2.2.2"
+  gem "rack", '<2.0'
+  gem "activesupport", "<5.0"
+end

data/README.md

@@ -261,6 +261,25 @@ individually as `attribute :name`.
 [ukda]: lib/stockboy/translators/uk_date.rb
 [usda]: lib/stockboy/translators/us_date.rb
 
+#### Debugging attribute translations
+
+If an attribute can't be translated the default behaviour is to return `nil`
+instead of raising an error that would terminate the entire job. There is a
+global config option to handle these errors as needed, perhaps for debugging:
+
+    Stockboy.configuration.translation_error_handler = proc { |error|
+      puts "Failed attribute: #{error.key.inspect}"
+      puts "Input: #{error.record.raw_hash.inspect}"
+      puts error.backtrace
+    }
+
+The object yielded to the error handler is an exception with additional properties:
+
+* `key`: The name of the attribute key that was attempted to translate
+* `record`: The original record context with all the input fields for inspection
+
+It can simply be raised if preferred.
+
 
 ### 4. Funnel it with filters
 

data/lib/stockboy/candidate_record.rb

@@ -119,7 +119,8 @@ module Stockboy
             fields[key] = tr[value]
             SourceRecord.new(fields, @table)
           rescue
-            fields[key] = nil
+            translation_error = TranslationError.new(key, self)
+            fields[key] = Stockboy.configuration.translation_error_handler.call(translation_error)
             break SourceRecord.new(fields, @table)
           end
         end

data/lib/stockboy/configuration.rb

@@ -27,6 +27,13 @@ module Stockboy
     #
     attr_accessor :logger
 
+    # To allow inspection when tranlastion error occurs
+    #
+    # By default returns nil on error but can be overridden 
+    attr_accessor :translation_error_handler
+
+
+
     # Initialize a set of global configuration options
     #
     # @yield self for configuration
@@ -35,6 +42,7 @@ module Stockboy
       @template_load_paths = []
       @logger = Logger.new(STDOUT)
       @tmp_dir = Dir.tmpdir
+      @translation_error_handler = -> (error) { nil }
       yield self if block_given?
     end
   end

data/lib/stockboy/exceptions.rb

@@ -1,3 +1,20 @@
 module Stockboy
   class OutOfSequence < StandardError; end
+
+  # TranslationError is a wrapper to store the standard error as well as the key and record which caused it
+  class TranslationError < StandardError 
+
+     def initialize (key, record)
+      @key = key
+      @record = record
+     end
+
+     def message
+      "Attribute [#{key}] caused #{cause.message}"
+     end
+
+     attr_reader :key
+     attr_reader :record
+
+    end
 end

data/lib/stockboy/version.rb

@@ -1,3 +1,3 @@
 module Stockboy
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/spec/spec_helper.rb

@@ -21,6 +21,7 @@ require 'rspec/its'
 require 'ostruct'
 require 'savon'
 require 'savon/mock/spec_helper'
+require 'pathname'
 # require 'vcr'
 
 $:.unshift File.expand_path('../lib/stockboy/lib', __FILE__)

data/spec/stockboy/candidate_record_spec.rb

@@ -57,7 +57,8 @@ module Stockboy
     end
 
     describe "attribute translation" do
-      subject(:hash) { CandidateRecord.new(hash_attrs, map).to_hash }
+      let (:record) { CandidateRecord.new(hash_attrs, map) }
+      subject(:hash) { record.to_hash }
 
       context "from lambda" do
         let(:map) { AttributeMap.new{ birthday as: ->(r){ Date.parse(r.birthday) } } }
@@ -78,6 +79,13 @@ module Stockboy
       context "with exception" do
         let(:map) { AttributeMap.new{ id as: [->(r){r.id.to_i}, ->(r){r.id / 0}] } }
         it { should eq({id: nil}) }
+
+        context "while debugging" do
+          it "raises the error" do 
+            Stockboy.configuration.translation_error_handler = -> (error) { raise error }
+            expect { hash }.to(raise_error(Stockboy::TranslationError)) 
+          end
+        end
       end
 
       context "dynamic without an input field" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockboy
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Vit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -284,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: stockboy
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Multi-source data normalization library