safely_block 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ba20f765b3e7d5a3a42de0c5376d06f2fa1a123
-  data.tar.gz: 100cf5b7ab1a8fba676b64e7914908d7d23f8276
+  metadata.gz: ff610f8bed6b2446fd70d85987ec4e622e5f5021
+  data.tar.gz: 56a9d89bee3fd0aa4804623e29639b3aeb39e8a2
 SHA512:
-  metadata.gz: c781fdff6e44069440281ba046b853e97a187c0ef59110231c4571113abd6451f15ecbb94484b7c53afcd0c2d07e24f8ddd28a3cd1ed843611dfcb2d97b73ee2
-  data.tar.gz: 1d261002fdf45d8fe088a75203ce55e61467aefb41547abbbad2ae617384f3f9bb3579b3ea961e24369daa21666dcd91803fde2eb8c9accd9a41521f1625d765
+  metadata.gz: 06cf78fcab0ee8e6a743f27b5ca9b95f45049a47c78700013da0298f7c7967616df9c6f6f082e1a013f5e06fa12e6636d2e7fc811747fa0aa7a362328754ecba
+  data.tar.gz: 1dcf67c2f094f854f358986240c14fe5e5afcfe6514d58a1f1cc95e8f670e5caa96462180a538f3e93427b9ef419bf1be66902c913d811adc0f889cd92dcc577

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.0
+
+- Added `tag` option to `safely` method
+- Switched to keyword arguments
+- Fixed frozen string error
+- Fixed tagging with custom error handler
+
 ## 0.1.1
 
 - Added `Safely.safely` to not pollute when included in gems

data/README.md

@@ -57,7 +57,9 @@ end
 Silence exceptions
 
 ```ruby
-safely(silence: ActiveRecord::RecordNotUnique) { code }
+safely silence: ActiveRecord::RecordNotUnique do
+  # code
+end
 ```
 
 Throttle reporting with:
@@ -74,20 +76,20 @@ end
 
 Reports exceptions to a variety of services out of the box thanks to [Errbase](https://github.com/ankane/errbase).
 
-- [Rollbar](https://rollbar.com/)
 - [Airbrake](https://airbrake.io/)
+- [Appsignal](https://appsignal.com/)
+- [Bugsnag](https://bugsnag.com/)
 - [Exceptional](http://www.exceptional.io/)
 - [Honeybadger](https://www.honeybadger.io/)
-- [Sentry](https://getsentry.com/)
-- [Raygun](https://raygun.io/)
-- [Bugsnag](https://bugsnag.com/)
-- [Appsignal](https://appsignal.com/)
 - [Opbeat](https://opbeat.com/)
+- [Raygun](https://raygun.io/)
+- [Rollbar](https://rollbar.com/)
+- [Sentry](https://getsentry.com/)
 
 Customize reporting with:
 
 ```ruby
-Safely.report_exception_method = proc { |e| Rollbar.error(e) }
+Safely.report_exception_method = -> (e) { Rollbar.error(e) }
 ```
 
 By default, exception messages are prefixed with `[safely]`. This makes it easier to spot rescued exceptions. Turn this off with:

data/lib/safely/core.rb

@@ -24,8 +24,6 @@ module Safely
   end
 
   DEFAULT_EXCEPTION_METHOD = proc do |e|
-    e = e.dup # leave original exception unmodified
-    e.message.prepend("[safely] ") if e.message && Safely.tag
     Errbase.report(e)
   end
 
@@ -36,20 +34,29 @@ module Safely
   self.throttle_counter = Hash.new(0)
 
   module Methods
-    def safely(options = {})
+    def safely(tag: nil, sample: nil, except: nil, only: nil, silence: nil, throttle: false, default: nil)
       yield
-    rescue *Array(options[:only] || StandardError) => e
-      raise e if Array(options[:except]).any? { |c| e.is_a?(c) }
+    rescue *Array(only || StandardError) => e
+      raise e if Array(except).any? { |c| e.is_a?(c) }
       raise e if Safely.raise_envs.include?(Safely.env)
-      sample = options[:sample]
       if sample ? rand < 1.0 / sample : true
         begin
-          Safely.report_exception(e) unless Array(options[:silence]).any? { |c| e.is_a?(c) } || Safely.throttled?(e, options[:throttle])
+          unless Array(silence).any? { |c| e.is_a?(c) } || Safely.throttled?(e, throttle)
+            tag = Safely.tag if tag.nil?
+            if tag && e.message
+              e = e.dup # leave original exception unmodified
+              message = e.message
+              e.define_singleton_method(:message) do
+                "[#{tag == true ? "safely" : tag}] #{message}"
+              end
+            end
+            Safely.report_exception(e)
+          end
         rescue => e2
           $stderr.puts "FAIL-SAFE #{e2.class.name}: #{e2.message}"
         end
       end
-      options[:default]
+      default
     end
     alias_method :yolo, :safely
   end

data/lib/safely/version.rb

@@ -1,3 +1,3 @@
 module Safely
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/safely_test.rb

@@ -3,6 +3,7 @@ require_relative "test_helper"
 class TestSafely < Minitest::Test
   def setup
     Safely.env = "production"
+    Safely.tag = true
     Safely.report_exception_method = Safely::DEFAULT_EXCEPTION_METHOD
   end
 
@@ -28,7 +29,7 @@ class TestSafely < Minitest::Test
     exception = Safely::TestError.new
     mock = MiniTest::Mock.new
     mock.expect :report_exception, nil, [exception]
-    Safely.report_exception_method = proc { |e| mock.report_exception(e) }
+    Safely.report_exception_method = -> (e) { mock.report_exception(e) }
     safely do
       raise exception
     end
@@ -39,16 +40,38 @@ class TestSafely < Minitest::Test
     exception = Safely::TestError.new
     mock = MiniTest::Mock.new
     mock.expect :report_exception, nil, [exception]
-    Safely.report_exception_method = proc { |e| mock.report_exception(e) }
+    Safely.report_exception_method = -> (e) { mock.report_exception(e) }
     yolo do
       raise exception
     end
     assert mock.verify
   end
 
+  def test_tagged
+    ex = nil
+    Safely.report_exception_method = -> (e) { ex = e }
+    safely { raise Safely::TestError, "Boom" }
+    assert_equal "[safely] Boom", ex.message
+  end
+
+  def test_not_tagged
+    Safely.tag = false
+    ex = nil
+    Safely.report_exception_method = -> (e) { ex = e }
+    safely { raise Safely::TestError, "Boom" }
+    assert_equal "Boom", ex.message
+  end
+
+  def test_local_tag
+    ex = nil
+    Safely.report_exception_method = -> (e) { ex = e }
+    safely(tag: "hi") { raise Safely::TestError, "Boom" }
+    assert_equal "[hi] Boom", ex.message
+  end
+
   def test_return_value
     assert_equal 1, safely { 1 }
-    assert_equal nil, safely { raise Safely::TestError, "Boom" }
+    assert_nil safely { raise Safely::TestError, "Boom" }
   end
 
   def test_default
@@ -57,12 +80,12 @@ class TestSafely < Minitest::Test
   end
 
   def test_only
-    assert_equal nil, safely(only: Safely::TestError) { raise Safely::TestError }
+    assert_nil safely(only: Safely::TestError) { raise Safely::TestError }
     assert_raises(RuntimeError, "Boom") { safely(only: Safely::TestError) { raise "Boom" } }
   end
 
   def test_only_array
-    assert_equal nil, safely(only: [Safely::TestError]) { raise Safely::TestError }
+    assert_nil safely(only: [Safely::TestError]) { raise Safely::TestError }
     assert_raises(RuntimeError, "Boom") { safely(only: [Safely::TestError]) { raise "Boom" } }
   end
 
@@ -76,8 +99,8 @@ class TestSafely < Minitest::Test
   end
 
   def test_failsafe
-    Safely.report_exception_method = proc { raise "oops" }
-    out, err = capture_io do
+    Safely.report_exception_method = -> (_) { raise "oops" }
+    _, err = capture_io do
       safely { raise "boom" }
     end
     assert_equal "FAIL-SAFE RuntimeError: oops\n", err
@@ -85,7 +108,7 @@ class TestSafely < Minitest::Test
 
   def test_throttle
     count = 0
-    Safely.report_exception_method = proc { |e| count += 1 }
+    Safely.report_exception_method = -> (_) { count += 1 }
     5.times do |n|
       safely throttle: {limit: 2, period: 3600} do
         raise Safely::TestError
@@ -96,7 +119,7 @@ class TestSafely < Minitest::Test
 
   def test_throttle_key
     count = 0
-    Safely.report_exception_method = proc { |e| count += 1 }
+    Safely.report_exception_method = -> (_) { count += 1 }
     5.times do |n|
       safely throttle: {limit: 2, period: 3600, key: "boom#{n % 2}"} do
         raise Safely::TestError
@@ -104,4 +127,10 @@ class TestSafely < Minitest::Test
     end
     assert_equal 4, count
   end
+
+  def test_bad_argument
+    assert_raises(ArgumentError) do
+      safely(unknown: true) { }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safely_block
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: errbase
@@ -105,11 +105,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Awesome exception handling
 test_files:
 - test/safely_test.rb
 - test/test_helper.rb
-has_rdoc: