oni 3.0.0 → 3.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2JlMGI4N2NhZDZmMDdmYTVjNWY0ZjExY2E5YzlmNGVlOWQ0Y2FjNg==
+    MTRkYjE1M2NkYjFkZjRjNzliMTRlNzMyNzgxYTY4ZGM4MjMwNWI2MA==
   data.tar.gz: !binary |-
-    NjAyMmEwMDA0YzYwZjQ1ZWQzNWNjYjVmNGI5N2YxYmY1NTJmYjhjZg==
+    YzAwOWVlYzI1NDg3Y2ZhMzNlOWRhZmMxYTYyNTcwNzIyZTdjZGJhZg==
 SHA512:
   metadata.gz: !binary |-
-    ODZjNTI3ZjlkZjZlOTNkZmU5YmQ4YzE1Zjc2N2FjMzMxMjI3M2ZlNjFlNWRl
-    OGYzMDQ0YTgwMTFkYjE3MzJlOTQ5MGU2NGRmZDljMDk3NmU4YTYzM2Q4NTY4
-    MWJkZjM1ZDliOTEzMDM3ZDk0YzBkMTZjMjg1OGJjNmZhMjIxMDY=
+    NGI3ODc5Mzc3MGRjOTRiNDAzYTJkNzM2M2UzYTYxMmY4N2VlODBkMzEwNWNj
+    MTRiYzM3N2QzODg5OGJlZjZjNmYzNWJjNWEyMGM1N2VlZWE2ZDJlNjc4Yjg5
+    YmRkNjE4ZDJlNTk2YTM5MjU4NGQ0YjJhNjk0ZmYxNmFkMGJlZTg=
   data.tar.gz: !binary |-
-    MDI0MjdmMTE2MGE4ZDA3ZGE0NWJlYzAyNjliYmQxMjIzZjQ1ZjlhOGU2MmIy
-    ZTljNjNkNDkzNTYyZWRmZDU5YzE2YTk4NWNmZmVlODZhY2IyMjFjYTA4Y2Uy
-    OWQ1MzY1YzdmNDUzM2U3YTBmODEzZTA5MDYzMjNlNjBkNzc0OGM=
+    M2E2NTZmZjY3MDI3OTA2ZDQ2ZjkzN2I0NmY3Mjg5MGI5NDdiYmVhNGY2NmNj
+    MjRiOGY1MGEzODY0MzYwNzNkMDc4ZmMyNTBhMzY2MTE3YjkwMWU2MTQ0MThi
+    Yjc0YzAyZDAwNWQ3Y2JlZjhiOWY0MTNmMTY5ZDhhMmE2OGJkNmY=

data/doc/changelog.md

@@ -1,6 +1,11 @@
 # @title Changelog
 # Changelog
 
+## 3.1.0 - December 17th, 2013
+
+Added the `Oni::WrappedError` class that can be used to wrap existing error
+classes within workers.
+
 ## 3.0.0 - December 17th, 2013
 
 This release reverts the changes of version 2.0.0 and 2.0.1 as they proved to

data/lib/oni.rb

@@ -6,3 +6,4 @@ require_relative 'oni/configurable'
 require_relative 'oni/mapper'
 require_relative 'oni/worker'
 require_relative 'oni/daemon'
+require_relative 'oni/wrapped_error'

data/lib/oni/version.rb

@@ -1,3 +1,3 @@
 module Oni
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end # Oni

data/lib/oni/wrapped_error.rb

@@ -0,0 +1,43 @@
+module Oni
+  ##
+  # Error class that can be used to wrap existing errors and attach extra data
+  # to them. This class is primarily intended to be used within workers to
+  # attach the input to the error.
+  #
+  # @!attribute [r] original_error
+  #  @return [StandardError]
+  #
+  # @!attribute [r] parameters
+  #  @return [Mixed]
+  #
+  class WrappedError < StandardError
+    attr_reader :original_error, :parameters
+
+    ##
+    # Wraps an existing error.
+    #
+    # @param [StandardError] error
+    # @param [Mixed] parameters
+    # @return [FeedbackDaemon::WorkerError]
+    #
+    def self.from(error, parameters = nil)
+      return new(
+        error.message,
+        :original_error => error,
+        :parameters     => parameters
+      )
+    end
+
+    ##
+    # @param [String] message
+    # @param [Hash] options
+    #
+    def initialize(message = nil, options = {})
+      super(message)
+
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value) if respond_to?(key)
+      end
+    end
+  end # WrappedError
+end # Oni

data/spec/oni/wrapped_error_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Oni::WrappedError do
+  before do
+    @original_error = StandardError.new('Hello world')
+    @parameters     = {:foo => :bar}
+  end
+
+  context 'manually creating instances' do
+    example 'set the message' do
+      Oni::WrappedError.new('foo').message.should == 'foo'
+    end
+
+    example 'set the original error' do
+      error = Oni::WrappedError.new('foo', :original_error => @original_error)
+
+      error.original_error.should == @original_error
+    end
+
+    example 'set the parameters' do
+      error = Oni::WrappedError.new('foo', :parameters => @parameters)
+
+      error.parameters.should == @parameters
+    end
+  end
+
+  context 'creating instances from other errors' do
+    before do
+      @error = Oni::WrappedError.from(@original_error, @parameters)
+    end
+
+    example 'set the message' do
+      @error.message.should == @original_error.message
+    end
+
+    example 'set the original error' do
+      @error.original_error.should == @original_error
+    end
+
+    example 'set the parameters' do
+      @error.parameters.should == @parameters
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oni
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Yorick Peterse
@@ -147,12 +147,14 @@ files:
 - lib/oni/mapper.rb
 - lib/oni/version.rb
 - lib/oni/worker.rb
+- lib/oni/wrapped_error.rb
 - oni.gemspec
 - spec/oni/configurable_spec.rb
 - spec/oni/daemon_spec.rb
 - spec/oni/daemons/sqs_spec.rb
 - spec/oni/mapper_spec.rb
 - spec/oni/worker_spec.rb
+- spec/oni/wrapped_error_spec.rb
 - spec/spec_helper.rb
 - spec/support/simplecov.rb
 - task/coverage.rake
@@ -190,6 +192,7 @@ test_files:
 - spec/oni/daemons/sqs_spec.rb
 - spec/oni/mapper_spec.rb
 - spec/oni/worker_spec.rb
+- spec/oni/wrapped_error_spec.rb
 - spec/spec_helper.rb
 - spec/support/simplecov.rb
 has_rdoc: yard