safely_block 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65bad436ec7ddcd49ef1836e3ec0f077b8754290
+  data.tar.gz: fcafabce7a11b00143410a3083f78cbdee24bab3
+SHA512:
+  metadata.gz: 180b1e137dcf01415624ea95333f2e571cd96edcaedb628ed99d83cb32d787ba470f8afc8f4084352cce7f5b162719bee5435e8742a431391dd0b5c95a0a4ff3
+  data.tar.gz: 381c7aa036d20fd55577d67425e2f4a264af515231bb65c25d124b8bf68c0eb3f789cfe4338f4c859d8ce69d8ccaaf931e7317c20287982c4068655992bb72bd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

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/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in safely_block.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# Safely
+
+Unexpected data can cause errors in production - don’t let it bring down the system
+
+```ruby
+safely do
+  # keep going if this code fails
+end
+```
+
+Exceptions are rescued and reported to your favorite reporting service.
+
+In development and test environments, exceptions are raised so you can fix them. :smirk:
+
+## Examples
+
+Great for analytics
+
+```ruby
+safely { track_event("Search") }
+```
+
+and background jobs
+
+```ruby
+User.find_each do |user|
+  safely { cache_recommendations(user) }
+end
+```
+
+Also aliased as `yolo`.
+
+## Features
+
+Throttle reporting with:
+
+```ruby
+safely sample: 1000 do
+  # reports ~ 1/1000 errors
+end
+```
+
+Specify a default value to return on exceptions
+
+```ruby
+score = safely(default: 30) { calculate_score }
+```
+
+Raise specific exceptions
+
+```ruby
+safely except: ActiveRecord::RecordNotUnique do
+  # all other exceptions will be rescued
+end
+```
+
+Pass an array for multiple exception classes.
+
+Rescue only specific exceptions
+
+```ruby
+safely only: ActiveRecord::RecordNotUnique do
+  # all other exceptions will be raised
+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
+Safely.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
+Safely.tag = false
+```
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'safely_block'
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/safely/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/safely/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/safely/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/safely_block.rb

@@ -0,0 +1,45 @@
+require "errbase"
+
+module Safely
+  VERSION = "0.1.0"
+
+  class << self
+    attr_accessor :env, :raise_envs, :tag, :report_exception_method
+
+    def report_exception(e)
+      report_exception_method.call(e)
+    end
+  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
+
+  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 = {})
+      yield
+    rescue *Array(options[:only] || StandardError) => e
+      raise e if Array(options[: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) }
+        rescue => e2
+          $stderr.puts "FAIL-SAFE #{e2.class.name}: #{e2.message}"
+        end
+      end
+      options[:default]
+    end
+    alias_method :yolo, :safely
+  end
+end
+
+Object.send :include, Safely::Methods

data/safely_block.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "safely_block"
+
+Gem::Specification.new do |spec|
+  spec.name          = "safely_block"
+  spec.version       = Safely::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = "Don’t let small errors bring down the system"
+  spec.description   = "Don’t let small errors bring down the system"
+  spec.homepage      = "https://github.com/ankane/safely_block"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "errbase"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", ">= 5"
+end

data/test/safely_test.rb

@@ -0,0 +1,85 @@
+require_relative "test_helper"
+
+class TestSafely < Minitest::Test
+  def setup
+    Safely.env = "production"
+    Safely.report_exception_method = Safely::DEFAULT_EXCEPTION_METHOD
+  end
+
+  def test_development_environment
+    Safely.env = "development"
+    assert_raises(Safely::TestError) do
+      safely do
+        raise Safely::TestError
+      end
+    end
+  end
+
+  def test_test_environment
+    Safely.env = "test"
+    assert_raises(Safely::TestError) do
+      safely do
+        raise Safely::TestError
+      end
+    end
+  end
+
+  def test_production_environment
+    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 do
+      raise exception
+    end
+    assert mock.verify
+  end
+
+  def test_yolo
+    exception = Safely::TestError.new
+    mock = MiniTest::Mock.new
+    mock.expect :report_exception, nil, [exception]
+    Safely.report_exception_method = proc { |e| mock.report_exception(e) }
+    yolo do
+      raise exception
+    end
+    assert mock.verify
+  end
+
+  def test_return_value
+    assert_equal 1, safely { 1 }
+    assert_equal nil, safely { raise Safely::TestError, "Boom" }
+  end
+
+  def test_default
+    assert_equal 1, safely(default: 2) { 1 }
+    assert_equal 2, safely(default: 2) { raise Safely::TestError, "Boom" }
+  end
+
+  def test_only
+    assert_equal 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_raises(RuntimeError, "Boom") { safely(only: [Safely::TestError]) { raise "Boom" } }
+  end
+
+  def test_except
+    assert_raises(Safely::TestError, "Boom") { safely(except: StandardError) { raise Safely::TestError, "Boom" } }
+  end
+
+  def test_silence
+    safely(silence: StandardError) { raise Safely::TestError, "Boom" }
+    assert true
+  end
+
+  def test_failsafe
+    Safely.report_exception_method = proc { raise "oops" }
+    out, err = capture_io do
+      safely { raise "boom" }
+    end
+    assert_equal "FAIL-SAFE RuntimeError: oops\n", err
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"
+
+module Safely
+  class TestError < StandardError; end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: safely_block
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: errbase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Don’t let small errors bring down the system
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/safely_block.rb
+- safely_block.gemspec
+- test/safely_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ankane/safely_block
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Don’t let small errors bring down the system
+test_files:
+- test/safely_test.rb
+- test/test_helper.rb
+has_rdoc: