backtrace_cleaner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83eea65eb3f67a84cbfbf598a853b2337f0ad1fb126c6cc32916abc5244a5f5d
+  data.tar.gz: f9fd9d74d8bf53f51588ab96474b20f2392750916ca941b299c8bee6877b2b68
+SHA512:
+  metadata.gz: a21adffb2a8bca6d93ebd7ee66bd460c7b738d1b25a1a5aa2f2bb8b10ddb77ac8034be63a346638e4bccdf724c69184b41a8617e6fc1a9b68f767cc804754bf2
+  data.tar.gz: 68b9aea5cb38fcb747454537d1a95806baadacb34e23a1a102fd0def05d02859fcc5ef44e302b1f7f41e0e35f38c1813f209e2fa171dbc6a6f50064421ab193d

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/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at igor@morozov.is. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 backtrace_cleaner.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    backtrace_cleaner (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  backtrace_cleaner!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Igor S. Morozov
+
+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/LICENSE_ACTIVE_SUPPORT.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2005-2019 David Heinemeier Hansson
+
+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,50 @@
+# BacktraceCleaner
+
+This is an extraction of ActiveSupport's [BacktraceCleaner](https://api.rubyonrails.org/classes/ActiveSupport/BacktraceCleaner.html) library.
+
+This gem exists for everyone who needs this ActiveSupport's feature without the rest of ActiveSupport.
+
+You can find original [source code](https://github.com/rails/rails/blob/dd8d37881c936d22acbc244e7e3b9b3a26e441b8/activesupport/lib/active_support/backtrace_cleaner.rb) on GitHub.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backtrace_cleaner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backtrace_cleaner
+
+## Usage
+
+```ruby
+bc = BacktraceCleaner.new
+bc.add_filter   { |line| line.gsub(Rails.root.to_s, '') } # strip the Rails.root prefix
+bc.add_silencer { |line| line =~ /puma|rubygems/ } # skip any lines from puma or rubygems
+bc.clean(exception.backtrace) # perform the cleanup
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Morozzzko/backtrace_cleaner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BacktraceCleaner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/backtrace_cleaner/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/backtrace_cleaner.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backtrace_cleaner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'backtrace_cleaner'
+  spec.version       = BacktraceCleaner::VERSION
+  spec.authors       = ['Igor S. Morozov']
+  spec.email         = ['igor@morozov.is']
+
+  spec.summary       = 'BacktraceCleaner from ActiveSupport without any ActiveSupport'
+  spec.homepage      = 'https://github.com/Morozzzko'
+  spec.license       = 'MIT'
+
+  # 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 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "backtrace_cleaner"
+
+# 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/backtrace_cleaner/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class BacktraceCleaner
+  VERSION = '1.0.0'.freeze
+end

data/lib/backtrace_cleaner.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "backtrace_cleaner/version"
+
+# This is an extract from ActiveSupport's backtrace_cleaner
+# See https://github.com/rails/rails/blob/dd8d37881c936d22acbc244e7e3b9b3a26e441b8/activesupport/lib/active_support/backtrace_cleaner.rb
+#
+# see LICENSE_ACTIVE_SUPPORT for the proper license
+
+# Backtraces often include many lines that are not relevant for the context
+# under review. This makes it hard to find the signal amongst the backtrace
+# noise, and adds debugging time. With a BacktraceCleaner, filters and
+# silencers are used to remove the noisy lines, so that only the most relevant
+# lines remain.
+#
+# Filters are used to modify lines of data, while silencers are used to remove
+# lines entirely. The typical filter use case is to remove lengthy path
+# information from the start of each line, and view file paths relevant to the
+# app directory instead of the file system root. The typical silencer use case
+# is to exclude the output of a noisy library from the backtrace, so that you
+# can focus on the rest.
+#
+#   bc = BacktraceCleaner.new
+#   bc.add_filter   { |line| line.gsub(Rails.root.to_s, '') } # strip the Rails.root prefix
+#   bc.add_silencer { |line| line =~ /puma|rubygems/ } # skip any lines from puma or rubygems
+#   bc.clean(exception.backtrace) # perform the cleanup
+#
+# To reconfigure an existing BacktraceCleaner (like the default one in Rails)
+# and show as much data as possible, you can always call
+# <tt>BacktraceCleaner#remove_silencers!</tt>, which will restore the
+# backtrace to a pristine state. If you need to reconfigure an existing
+# BacktraceCleaner so that it does not filter or modify the paths of any lines
+# of the backtrace, you can call <tt>BacktraceCleaner#remove_filters!</tt>
+# These two methods will give you a completely untouched backtrace.
+#
+# Inspired by the Quiet Backtrace gem by thoughtbot.
+
+class BacktraceCleaner
+  def initialize
+    @filters, @silencers = [], []
+    add_gem_filter
+    add_gem_silencer
+    add_stdlib_silencer
+  end
+
+  # Returns the backtrace after all filters and silencers have been run
+  # against it. Filters run first, then silencers.
+  def clean(backtrace, kind = :silent)
+    filtered = filter_backtrace(backtrace)
+
+    case kind
+    when :silent
+      silence(filtered)
+    when :noise
+      noise(filtered)
+    else
+      filtered
+    end
+  end
+  alias :filter :clean
+
+  # Adds a filter from the block provided. Each line in the backtrace will be
+  # mapped against this filter.
+  #
+  #   # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
+  #   backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
+  def add_filter(&block)
+    @filters << block
+  end
+
+  # Adds a silencer from the block provided. If the silencer returns +true+
+  # for a given line, it will be excluded from the clean backtrace.
+  #
+  #   # Will reject all lines that include the word "puma", like "/gems/puma/server.rb" or "/app/my_puma_server/rb"
+  #   backtrace_cleaner.add_silencer { |line| line =~ /puma/ }
+  def add_silencer(&block)
+    @silencers << block
+  end
+
+  # Removes all silencers, but leaves in the filters. Useful if your
+  # context of debugging suddenly expands as you suspect a bug in one of
+  # the libraries you use.
+  def remove_silencers!
+    @silencers = []
+  end
+
+  # Removes all filters, but leaves in the silencers. Useful if you suddenly
+  # need to see entire filepaths in the backtrace that you had already
+  # filtered out.
+  def remove_filters!
+    @filters = []
+  end
+
+  private
+
+  FORMATTED_GEMS_PATTERN = /\A[^\/]+ \([\w.]+\) /
+
+  def add_gem_filter
+    gems_paths = (Gem.path | [Gem.default_dir]).map { |p| Regexp.escape(p) }
+    return if gems_paths.empty?
+
+    gems_regexp = %r{(#{gems_paths.join('|')})/(bundler/)?gems/([^/]+)-([\w.]+)/(.*)}
+    gems_result = '\3 (\4) \5'
+    add_filter { |line| line.sub(gems_regexp, gems_result) }
+  end
+
+  def add_gem_silencer
+    add_silencer { |line| FORMATTED_GEMS_PATTERN.match?(line) }
+  end
+
+  def add_stdlib_silencer
+    add_silencer { |line| line.start_with?(RbConfig::CONFIG["rubylibdir"]) }
+  end
+
+  def filter_backtrace(backtrace)
+    @filters.each do |f|
+      backtrace = backtrace.map { |line| f.call(line) }
+    end
+
+    backtrace
+  end
+
+  def silence(backtrace)
+    @silencers.each do |s|
+      backtrace = backtrace.reject { |line| s.call(line) }
+    end
+
+    backtrace
+  end
+
+  def noise(backtrace)
+    backtrace - silence(backtrace)
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: backtrace_cleaner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Igor S. Morozov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-19 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: 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: 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:
+- igor@morozov.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- LICENSE_ACTIVE_SUPPORT.txt
+- README.md
+- Rakefile
+- backtrace_cleaner.gemspec
+- bin/console
+- bin/setup
+- lib/backtrace_cleaner.rb
+- lib/backtrace_cleaner/version.rb
+homepage: https://github.com/Morozzzko
+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.7.6
+signing_key: 
+specification_version: 4
+summary: BacktraceCleaner from ActiveSupport without any ActiveSupport
+test_files: []