rollbar-mode 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5ed5cbeafaea0c193d7554024199c8704e8bf1d9f6f8eec1eeabecae2f6badc
+  data.tar.gz: 66b9033b62d0c9d9423205c59127870d07e4a0519f0d23464861f042b53ecffe
+SHA512:
+  metadata.gz: 77f00ff3d0d4ab88af5eef5e2a771b5adf76b7121431090b4daa3ae2004ee05a740b6a145787bd3d3d28812a088c6db158d9a2a2402d4ea0b1915c8d993321b5
+  data.tar.gz: 3d9d5ce5036bb4136297c35d67713af1f2ac31ebb1fa0a730f898fcf86509604d4fe211d13cb27fc2d1ffae79c7bc07d817f2b3391fd6090d22a81011ec38913

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,49 @@
+AllCops:
+  TargetRubyVersion: 2.4.2
+
+MethodLength:
+  Max: 20
+
+BlockLength:
+  Max: 70
+
+  Exclude:
+    - 'Rakefile'
+    - 'rakelib/**/*.rake'
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 80
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/YodaCondition:
+  EnforcedStyle: forbid_for_equality_operators_only
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rollbar-mode.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    rollbar-mode (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rollbar (2.22.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rollbar (~> 2.22)
+  rollbar-mode!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,109 @@
+# Rollbar::Mode
+
+The idea behind `Rollbar::Mode` is inspired from the [Emacs major and minor][1]
+modes, which alter the behaviour of the editor in certain cases. This is
+the equivalent of a "minor mode", which alters the way Rollbar integrates
+with your code:
+
+* In development it automatically re-raises exceptions logged with Rollbar
+* In production it alters some default values for better integration with Heroku
+
+[1]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Modes.html
+
+
+### Development mode
+
+In development (i.e. when the Rollbar token is not set), the reporter will
+not send errors to Rollbar but re-raise them, allowing the following code
+pattern to work well both in development and in production:
+
+``` ruby
+def find(id)
+  user = method_that_could_raise_exception(id)
+rescue StandardError => exception
+  Rollbar.error(exception)
+
+  nil
+end
+```
+
+As of v2.22 of the gem, Rollbar has a setting called `raise_on_error` but will
+only work if Rollbar believes it's enabled (the access token is enabled). See
+the early `return` in the code snippet below, taken from
+`Rollbar::Notifier#log`:
+
+
+``` ruby
+def log(level, *args)
+  return 'disabled' unless enabled?
+
+  message, exception, extra, context = extract_arguments(args)
+  use_exception_level_filters = use_exception_level_filters?(extra)
+
+  return 'ignored' if ignored?(exception, use_exception_level_filters)
+
+  begin
+    status = call_before_process(:level => level,
+                                 :exception => exception,
+                                 :message => message,
+                                 :extra => extra)
+    return 'ignored' if status == 'ignored'
+  rescue Rollbar::Ignore
+    return 'ignored'
+  end
+
+  level = lookup_exception_level(level, exception,
+                                 use_exception_level_filters)
+
+  ret = report_with_rescue(level, message, exception, extra, context)
+
+  raise(exception) if configuration.raise_on_error && exception
+
+  ret
+end
+```
+
+If the Rollbar access token is not availble _and_ the `raise_on_errror` setting
+is set to `true`, this gem will monkeypatch the `log` method described above
+to side-steps the error delivery mechanism and automatically re-raise the
+exception.
+
+In order to make sure that the gem only affects your code in development, you
+can enable it only in the Bundler `development` group:
+
+``` ruby
+group :development do
+  gem 'rollbar-mode'
+end
+```
+
+
+### Production mode
+
+Rollbar has several configuration options that help with error reporting, like:
+
+* `code_version` for linking stack traces to GitHub (SemVer, git SHA)
+* `environment` which defaults to "unspecified"
+* `populate_empty_backtraces` for manually initialized exceptions
+* `use_async` for reporting errors using either `girl_friday` or threading
+
+`Rollbar::Mode` will alter the default configuration for Rollbar to these
+values:
+
+* `code_version` will be set to the value of `HEROKU_SLUG_COMMIT` if available
+* `environment` will be set to the value of `HEROKU_APP_NAME`, if available
+* `populate_empty_backtraces` will be set to `true` (normal default is `false`)
+* `use_async` will be set to `true` (normal default is `false`)
+
+The `HEROKU_*` environment variables are provided by the [Dyno Metadata][2]
+feature and has to be enabled manually.
+
+[2]: https://devcenter.heroku.com/articles/dyno-metadata
+
+If you do not want these changes, make sure the gem is in the development
+group.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andreimaxim/rollbar-mode.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rollbar/mode"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rollbar/mode.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rollbar'
+
+require 'rollbar/mode/local_notifier'
+require 'rollbar/mode/production'
+require 'rollbar/mode/development'
+
+require 'rollbar/mode/version'
+
+module Rollbar
+  # Minor mode for Rollbar
+  module Mode
+
+    def self.apply
+      if Rollbar::Mode.production?
+        Rollbar::Mode::Production.apply
+      else
+        Rollbar::Mode::Development.apply
+      end
+    end
+
+    def self.production?
+      Rollbar::Mode::Production.access_token ||
+        Rollbar.configuration.enabled
+    end
+
+    # Determine if the current environment is a Heroku dyno based on the
+    # dyno metadata.
+    #
+    # See:
+    #
+    # https://devcenter.heroku.com/articles/dyno-metadata
+    def self.heroku?
+      ENV.key?('HEROKU_SLUG_COMMIT') &&
+        ENV.key?('HEROKU_APP_NAME')
+    end
+
+  end
+end
+
+Rollbar::Mode.apply

data/lib/rollbar/mode/development.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Rollbar
+  module Mode
+    # Rollbar development minor mode
+    class Development
+
+      class << self
+
+        # :reek:TooManyStatements
+        def apply
+          Rollbar.reset_notifier!
+          Rollbar.notifier = Rollbar::Mode::LocalNotifier.new
+
+          Rollbar.configure do |config|
+            config.enabled = false
+            config.raise_on_error = true
+          end
+
+          warn 'Rollbar: disabled, errors re-raised automatically'
+        end
+
+      end
+
+    end
+  end
+end

data/lib/rollbar/mode/local_notifier.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Rollbar
+  module Mode
+    # Local notifier that re-raises the exceptions
+    class LocalNotifier < ::Rollbar::Notifier
+
+      # Normally would send a report to Rollbar.
+      #
+      #  Accepts any number of arguments. The last String argument will become
+      # the message or description of the report. The last Exception argument
+      # will become the associated exception for the report. The last hash
+      # argument will be used as the extra data for the report.
+      #
+      # This method is used by code lilke:
+      #
+      # @example
+      #   begin
+      #     foo = bar
+      #   rescue => e
+      #     Rollbar.error(e)
+      #   end
+      #
+      # or:
+      #
+      # @example
+      #   begin
+      #     foo = bar
+      #    rescue => e
+      #      Rollbar.log(e, 'This is a description of the exception')
+      #    end
+      #
+      def log(_level, *args)
+        _message, exception, _extra, _context = extract_arguments(args)
+        raise(exception) if configuration.raise_on_error && exception
+      end
+
+    end
+  end
+end

data/lib/rollbar/mode/production.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Rollbar
+  module Mode
+    # Rollbar production minor-mode.
+    class Production
+
+      class << self
+
+        # :reek:TooManyStatements
+        def apply
+          Rollbar.configure do |config|
+            config.enabled = true
+            config.access_token = access_token
+
+            # Override the default values with better ones
+            config.populate_empty_backtraces = true
+            config.use_async = true
+
+            # Set up the code-related metrics.
+            config.code_version = code_version
+            config.environment = environment
+          end
+
+          warn 'Rollbar: using online service at https://rollbar.com'
+        end
+
+        def code_version
+          ENV['HEROKU_SLUG_COMMIT']
+        end
+
+        def environment
+          ENV['HEROKU_APP_NAME']
+        end
+
+        def access_token
+          ENV['ROLLBAR_ACCESS_TOKEN']
+        end
+
+      end
+
+    end
+  end
+end

data/lib/rollbar/mode/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rollbar
+  module Mode
+    VERSION = '0.0.1'
+  end
+end

data/rollbar-mode.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rollbar/mode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rollbar-mode'
+  spec.version       = Rollbar::Mode::VERSION
+  spec.authors       = 'Andrei Maxim'
+  spec.email         = 'andrei@andreimaxim.ro'
+
+  spec.summary       = 'Add a Rollbar minor mode to your environment'
+  spec.homepage      = 'https://github.com/andreimaxim/rollbar-mode'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rollbar', '~> 2.22'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rollbar-mode
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrei Maxim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: andrei@andreimaxim.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rollbar/mode.rb
+- lib/rollbar/mode/development.rb
+- lib/rollbar/mode/local_notifier.rb
+- lib/rollbar/mode/production.rb
+- lib/rollbar/mode/version.rb
+- rollbar-mode.gemspec
+homepage: https://github.com/andreimaxim/rollbar-mode
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Add a Rollbar minor mode to your environment
+test_files: []