augmented 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7614af557970d760bbf22bb29e09ba552d62da96b7980ebddaf0677ca2639be7
-  data.tar.gz: 41f453b5c5b095ab76b48ddc033db840884598fe4e78c3f56dd76dcac4464cfe
+  metadata.gz: 02a3d4fd8fbc13022569168b89c6fb60b575dea7030a6c36b1457a049c468b62
+  data.tar.gz: bb89fe218a192cb1eb72f9456988a65c08eec651fc6e3f89e62941e9632dac9a
 SHA512:
-  metadata.gz: 6c2622e88196a3746e3c344a44329dfbae27c5b9abf9f49eff8862b33faf1c53548df07fd4f61f8087e3599e065c501da0740f1fae6cd88239b0b70dee763c51
-  data.tar.gz: bf2aa41adb4d32fdd97ac28a1694916ef175a395e3feb735ce48567f6b50de0130ca6ec2bc64d2c4e0622f542b9c68cdac28063fa9462dd7f74bf58809042926
+  metadata.gz: c4f04bc92e1bdfbff68e62283bfb16b7f8499297916c208ae62156e84d1358efdf4a94f56cb5d0d0123ea985a7f315126026147b82e338e6fea7d4ddcbff489f
+  data.tar.gz: 99d873ac314d8ff5a8cc7bf6f6fc5a47cfb27080dbf69167c2a6f6f0509175e6f7cd4c6ab23c2a41a7f73cbd8a5b39cda20c473d1448228dd0316013b7659ae9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.2.5] - 2021-05-30
+
+- Added `Exception#details`, `Exception#details=`, `Exception#detailed`
+- Added `Exception#chain`
+- Added `Exception#to_h`
+
 ## [0.2.3] - 2021-05-29
 
 - Added `String#truncate`, `String#truncate!` and `String#blank?`

data/README.md

@@ -31,6 +31,7 @@ You can load all refinements for just one type:
 ```ruby
 using Augmented::Arrays
 using Augmented::Enumerators
+using Augmented::Exceptions
 using Augmented::Hashes
 using Augmented::Modules
 using Augmented::Objects
@@ -83,6 +84,81 @@ using Augmented::Enumerators::Indexing
 ```
 
 
+#### `Augmented::Exceptions`
+
+##### `Exception#chain`
+
+Returns an enumerator over the exception's causal chain, starting with the exception itself.
+
+```ruby
+using Augmented::Exceptions::Chain
+
+begin
+  begin
+    begin
+      raise 'first'
+    rescue
+      raise 'second'
+    end
+  rescue
+    raise 'third'
+  end
+rescue => error
+  error.chain.map(&:message)
+end
+# ["third", "second", "first"]
+```
+
+
+##### `Exception#details`, `Exception#details=`, `Exception#detailed`
+
+Attach a hash of details to any exception.
+
+```ruby
+using Augmented::Exceptions::Detailed
+
+exception = RuntimeError.new('oops!').detailed(foo: 10, bar: { baz: 30 })
+exception.details
+# {:foo=>10, :bar=>{:baz=>30}}
+exception.details = { bam: 40 }
+exception.details
+# {:bam=>40}
+```
+
+
+##### `Exception#to_h`
+
+Serializes an exception into a Hash including its backtrace, details and causal chain.
+
+```ruby
+using Augmented::Exceptions::Serializable
+using Augmented::Exceptions::Detailed
+
+begin
+  begin
+    raise RuntimeError.new('first').detailed(foo: 10)
+  rescue
+    raise RuntimeError.new('second').detailed(bar: 20)
+  end
+rescue => error
+  error.to_h
+end
+# {
+#   :class => "RuntimeError",
+#   :message => "second",
+#   :details => { :bar => 20 },
+#   :backtrace => [ ... ],
+#   :cause => {
+#     :class => "RuntimeError",
+#     :message => "first",
+#     :details => { :foo => 10 },
+#     :backtrace => [ ... ],
+#     :cause => nil
+#   }
+# }
+```
+
+
 #### `Augmented::Hashes`
 
 ##### `Hash#map_values`

data/lib/augmented.rb

@@ -2,6 +2,7 @@ require 'augmented/version'
 
 require 'augmented/arrays'
 require 'augmented/enumerators'
+require 'augmented/exceptions'
 require 'augmented/hashes'
 require 'augmented/modules'
 require 'augmented/objects'
@@ -12,6 +13,7 @@ require 'augmented/symbols'
 module Augmented
   include Arrays
   include Enumerators
+  include Exceptions
   include Hashes
   include Modules
   include Objects

data/lib/augmented/exceptions.rb

@@ -0,0 +1,11 @@
+require 'augmented/exceptions/chain'
+require 'augmented/exceptions/detailed'
+require 'augmented/exceptions/serializable'
+
+module Augmented
+  module Exceptions
+    include Chain
+    include Detailed
+    include Serializable
+  end
+end

data/lib/augmented/exceptions/chain.rb

@@ -0,0 +1,16 @@
+module Augmented
+  module Exceptions
+    module Chain
+      refine Exception do
+
+        def chain
+          Enumerator.new do |yielder|
+            yielder << exception = self
+            yielder << exception while exception = exception.cause
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/exceptions/detailed.rb

@@ -0,0 +1,22 @@
+module Augmented
+  module Exceptions
+    module Detailed
+      refine Exception do
+
+        def details
+          @_details ||= {}
+        end
+
+        def details= **details
+          @_details = details
+        end
+
+        def detailed **details
+          self.details = details
+          self
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/exceptions/serializable.rb

@@ -0,0 +1,25 @@
+module Augmented
+  module Exceptions
+    module Serializable
+      refine Exception do
+        using Chain
+        using Detailed
+
+        def to_h
+          self.chain.map do |exception|
+            {
+              class: exception.class.name,
+              message: exception.message,
+              details: exception.details,
+              backtrace: exception.backtrace || [],
+              cause: nil,
+            }
+          end.reverse.reduce do |cause, exception|
+            exception.merge!(cause: cause)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/version.rb

@@ -1,3 +1,3 @@
 module Augmented
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: augmented
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - brunze
@@ -57,6 +57,10 @@ files:
 - lib/augmented/arrays/tieable.rb
 - lib/augmented/enumerators.rb
 - lib/augmented/enumerators/indexing.rb
+- lib/augmented/exceptions.rb
+- lib/augmented/exceptions/chain.rb
+- lib/augmented/exceptions/detailed.rb
+- lib/augmented/exceptions/serializable.rb
 - lib/augmented/hashes.rb
 - lib/augmented/hashes/mappable.rb
 - lib/augmented/hashes/polymorphable.rb