robustly 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3358a29e863fa2ee454fe1d98b28cce45552d8be
-  data.tar.gz: 36d2b9074c3539947d8b84471a5e02207db631a9
+  metadata.gz: 9dbd670fd6832a14e2315b0195a6bb13381eaed8
+  data.tar.gz: 31b9a08a7b218feedafe11b15b4a000204e0c7b3
 SHA512:
-  metadata.gz: 1533250d894eb14a9cf777554b0c6f02db0df96d472eda9c4898fd7e95f848312c53de1367b4ec906ee62d2024139bde2e6ce1f9962454b2b5bfc87b1a0136a3
-  data.tar.gz: 350ad47a7bf3e6b4f643e7cc8e910dde3fed37c0852acfe9b1967dcfba39fe690b075fa35aabf7c898b5a041773e39adf9cd66704a9301b64f3a3793d205cd6b
+  metadata.gz: 867d1290360d87b7835e8ed65159e29077ed26a896cc937284288a598e9871c048f031d1bad0bf02b399a16edbd77672bdeb0a4b56b37ff213d5ee7ee6d5a2e1
+  data.tar.gz: 161bc8ac868488b646f88268710d4476569b39992040c345f47e2cc17ac1122a2174e251a58fb4ac063303927a5c6a75ebcda5c4820944c36bc893c99d1eab3c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0
+
+- Added `tag` option and tag exception message by default
+- Added `except` option
+- Added `silence` option

data/README.md

@@ -1,6 +1,6 @@
 # Robustly
 
-Don’t let small errors bring down the system
+Unexpected data can cause errors in production - don’t let it bring down the system
 
 ```ruby
 safely do
@@ -8,41 +8,55 @@ safely do
 end
 ```
 
-Raises exceptions in development and test environments and rescues and reports exceptions elsewhere.
+Exceptions are rescued and reported to your favorite reporting service.
 
-Also aliased as `yolo`.
+In development and test environments, exceptions are raised so you can fix them. :smirk:
+
+## Examples
+
+Great for analytics
 
 ```ruby
-yolo do
-  # get crazy in here
-end
+safely { track_event("Search") }
 ```
 
-Reports exceptions to [Rollbar](https://rollbar.com/), [Airbrake](https://airbrake.io/), [Exceptional](http://www.exceptional.io/), [Honeybadger](https://www.honeybadger.io/), [Sentry](https://getsentry.com/), [Raygun](https://raygun.io/), and [Bugsnag](https://bugsnag.com/) out of the box thanks to [Errbase](https://github.com/ankane/errbase).
-
-Customize reporting with:
+and background jobs
 
 ```ruby
-Robustly.report_exception_method = proc {|e| Rollbar.report_exception(e) }
+User.find_each do |user|
+  safely { cache_recommendations(user) }
+end
 ```
 
-And throttle reporting with:
+Also aliased as `yolo`.
+
+## Features
+
+Throttle reporting with:
 
 ```ruby
-safely throttle: 1000 do
+safely sample: 1000 do
   # reports ~ 1/1000 errors
 end
 ```
 
-Specify a default value to return on errors:
+Specify a default value to return on exceptions
+
+```ruby
+score = safely(default: 30) { calculate_score }
+```
+
+Raise specific exceptions
 
 ```ruby
-safely default: 30 do
-  # big bucks, no whammy
+safely except: ActiveRecord::RecordNotUnique do
+  # all other exceptions will be rescued
 end
 ```
 
-Catch specific errors
+Pass an array for multiple exception classes.
+
+Rescue only specific exceptions
 
 ```ruby
 safely only: ActiveRecord::RecordNotUnique do
@@ -50,6 +64,38 @@ safely only: ActiveRecord::RecordNotUnique do
 end
 ```
 
+Silence exceptions
+
+```ruby
+safely(silence: ActiveRecord::RecordNotUnique) { code }
+```
+
+## Reporting
+
+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/)
+- [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/)
+
+Customize reporting with:
+
+```ruby
+Robustly.report_exception_method = proc { |e| Rollbar.error(e) }
+```
+
+By default, exception messages are prefixed with `[safely]`. This makes it easier to spot rescued exceptions. Turn this off with:
+
+```ruby
+Robustly.tag = false
+```
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -58,6 +104,10 @@ Add this line to your application’s Gemfile:
 gem 'robustly'
 ```
 
+## History
+
+View the [changelog](https://github.com/ankane/robustly/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/robustly.rb

@@ -3,33 +3,39 @@ require "errbase"
 
 module Robustly
   class << self
-    attr_accessor :env, :report_exception_method
+    attr_accessor :env, :raise_envs, :tag, :report_exception_method
 
     def report_exception(e)
       report_exception_method.call(e)
     end
   end
-  self.env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
-  self.report_exception_method = proc do |e|
+
+  DEFAULT_EXCEPTION_METHOD = proc do |e|
+    e = e.dup # leave original exception unmodified
+    e.message.prepend("[safely] ") if e.message && Robustly.tag
     Errbase.report(e)
   end
 
+  self.env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+  self.tag = true
+  self.report_exception_method = DEFAULT_EXCEPTION_METHOD
+  self.raise_envs = %w(development test)
+
   module Methods
     def safely(options = {})
-      class_names = Array(options[:only] || StandardError)
-      begin
-        yield
-      rescue *class_names => e
-        raise e if %w(development test).include?(Robustly.env)
-        if options[:throttle] ? rand < 1.0 / options[:throttle] : true
-          begin
-            Robustly.report_exception(e)
-          rescue => e2
-            $stderr.puts "FAIL-SAFE #{e2.class.name}: #{e2.message}"
-          end
+      yield
+    rescue *Array(options[:only] || StandardError) => e
+      raise e if Array(options[:except]).any? { |c| e.is_a?(c) }
+      raise e if Robustly.raise_envs.include?(Robustly.env)
+      sample = options[:sample] || options[:throttle]
+      if sample ? rand < 1.0 / sample : true
+        begin
+          Robustly.report_exception(e) unless Array(options[:silence]).any? { |c| e.is_a?(c) }
+        rescue => e2
+          $stderr.puts "FAIL-SAFE #{e2.class.name}: #{e2.message}"
         end
-        options[:default]
       end
+      options[:default]
     end
     alias_method :yolo, :safely
     alias_method :robustly, :safely # legacy

data/lib/robustly/version.rb

@@ -1,3 +1,3 @@
 module Robustly
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/test/robustly_test.rb

@@ -3,7 +3,7 @@ require_relative "test_helper"
 class TestRobustly < Minitest::Test
   def setup
     Robustly.env = "production"
-    Robustly.report_exception_method = proc { |e| Errbase.report(e) }
+    Robustly.report_exception_method = Robustly::DEFAULT_EXCEPTION_METHOD
   end
 
   def test_safely_development_environment
@@ -46,35 +46,33 @@ class TestRobustly < Minitest::Test
     assert mock.verify
   end
 
-  def test_robustly
-    exception = Robustly::TestError.new
-    mock = MiniTest::Mock.new
-    mock.expect :report_exception, nil, [exception]
-    Robustly.report_exception_method = proc { |e| mock.report_exception(e) }
-    robustly do
-      raise exception
-    end
-    assert mock.verify
-  end
-
   def test_return_value
     assert_equal 1, safely { 1 }
-    assert_equal nil, safely { raise Robustly::TestError }
+    assert_equal nil, safely { raise Robustly::TestError, "Boom" }
   end
 
   def test_default
     assert_equal 1, safely(default: 2) { 1 }
-    assert_equal 2, safely(default: 2) { raise Robustly::TestError }
+    assert_equal 2, safely(default: 2) { raise Robustly::TestError, "Boom" }
   end
 
   def test_only
     assert_equal nil, safely(only: Robustly::TestError) { raise Robustly::TestError }
-    assert_raises(RuntimeError, "Boom") { safely(only: Robustly::TestError) { raise RuntimeError.new("Boom") } }
+    assert_raises(RuntimeError, "Boom") { safely(only: Robustly::TestError) { raise RuntimeError, "Boom" } }
   end
 
   def test_only_array
     assert_equal nil, safely(only: [Robustly::TestError]) { raise Robustly::TestError }
-    assert_raises(RuntimeError, "Boom") { safely(only: [Robustly::TestError]) { raise RuntimeError.new("Boom") } }
+    assert_raises(RuntimeError, "Boom") { safely(only: [Robustly::TestError]) { raise RuntimeError, "Boom" } }
+  end
+
+  def test_except
+    assert_raises(Robustly::TestError, "Boom") { safely(except: StandardError) { raise Robustly::TestError, "Boom" } }
+  end
+
+  def test_silence
+    safely(silence: StandardError) { raise Robustly::TestError, "Boom" }
+    assert true
   end
 
   def test_failsafe

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robustly
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: errbase
@@ -74,7 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md

data/.rubocop.yml

@@ -1,32 +0,0 @@
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-Style/Documentation:
-  Enabled: false
-
-Style/SignalException:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockNesting:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false