give_back_my_traces 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3b90f146fc69d87b26e750c8488df198790455e7ef9df8ef3ebd47a5a0b9486
+  data.tar.gz: 119c08f92ef0953874ff6577ba11eb5967fff7980e8a208a4df0a2c39c7bd983
+SHA512:
+  metadata.gz: d85098ced00e20dc0eae0c602d71b9a25be76d26bad5756011f676a5ecfa473c625f766864b6768b5ac29de6e1c1827f9d94e6f79c7c2f1eff02a097c236cd26
+  data.tar.gz: 1c721fb4231841608335e5291853d53920b2057f3af4aa7ed7e5a10f9db904e545cbfe0485c5401cba8a2d529261e27e6fbafb9db4f6662957d823dd858f322b

data/.github/workflows/main.yml

@@ -0,0 +1,17 @@
+name: Ruby
+
+on: [push, workflow_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+        cache-version: 1
+    - name: Run the default task
+      run: bundle exec rake

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,23 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+    - 'examples/*.rb'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in give_back_my_traces.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.36"
+
+gem "pry-byebug"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    give_back_my_traces (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    json (2.6.2)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.37.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.22.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.22.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  give_back_my_traces!
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.36)
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Carlos Atkinson
+
+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,90 @@
+# GiveBackMyTraces
+
+GiveBackMyTraces let you discover those sneaky errors in ruby apps.
+
+## Usage
+
+Suppose you have the following code in your rails app:
+
+```ruby
+class ApplicationController < ActionController::Base
+  rescue_from 'BaseError' do
+    head 422
+  end
+end
+```
+
+After a huge refactoring or upgrade you may face some errors like:
+
+```shell
+❯ rspec spec/requests/my_action_spec.rb
+F
+
+Failures:
+
+  1) MyActions GET /index returns http success
+     Failure/Error: expect(response).to have_http_status(:success)
+       expected the response to have a success status code (2xx) but it was 422
+     # ./spec/requests/my_action_spec.rb:7:in `block (3 levels) in <top (required)>'
+
+Finished in 0.07235 seconds (files took 0.80333 seconds to load)
+1 example, 1 failure
+
+....
+```
+
+And then to discover the real error you may need to start debugging to find the real issue.
+
+Enter `give_back_my_traces`, just add in your Gemfile, eg:
+
+```ruby
+gem 'give_back_my_traces'
+```
+
+And add `GBMT.init` in your spec_helper:
+
+```ruby
+require 'give_back_my_traces'
+
+RSpec.configure do |config|
+  config.around(:each) do |example|
+    GBMT.init
+
+    example.call
+
+    GBMT.clear
+  end
+```
+
+And then you can see the errors running it with some GBMT envs:
+
+```
+GBMT_ENABLE=1 rspec spec/requests/my_action_spec.rb 2>&1 | head -10
+----------------------------------------------------
+ Error: BaseError
+ Message: Test error
+ Backtrace:
+   /home/foo/projetos/test-gbmt/app/controllers/my_action_controller.rb:5:in `index'
+   /home/foo/.rbenv/versions/3.0.4/lib/ruby/gems/3.0.0/gems/actionpack-7.0.4/lib/action_controller/metal/basic_implicit_render.rb:6:in `send_action'
+   /home/foo/.rbenv/versions/3.0.4/lib/ruby/gems/3.0.0/gems/actionpack-7.0.4/lib/abstract_controller/base.rb:215:in `process_action'
+   /home/foo/.rbenv/versions/3.0.4/lib/ruby/gems/3.0.0/gems/actionpack-7.0.4/lib/action_controller/metal/rendering.rb:53:in `process_action'
+   /home/foo/.rbenv/versions/3.0.4/lib/ruby/gems/3.0.0/gems/actionpack-7.0.4/lib/abstract_controller/callbacks.rb:234:in `block in process_action'
+   ...
+
+```
+
+See more in the examples folder.
+
+## 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 the created tag, 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/catks/give_back_my_traces.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "give_back_my_traces"
+
+# 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

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/examples/multiple.rb

@@ -0,0 +1,19 @@
+require 'give_back_my_traces'
+
+# Usage:
+#   ruby simple.rb
+#   GBMT_MODE=normal GBMT_BACKTRACE_MAX_LINES=2 ruby multiple.rb
+#   GBMT_MODE=verbose GBMT_BACKTRACE_MAX_LINES=5 ruby multiple.rb
+#   GBMT_MODE=silent ruby simple.rb
+
+GiveBackMyTraces.start
+
+def bar(baz:)
+end
+
+def some_method
+  bar rescue  StandardError
+  bar(baz: 42, invalid_key: 42) rescue  StandardError
+end
+
+some_method

data/examples/simple.rb

@@ -0,0 +1,20 @@
+require 'give_back_my_traces'
+
+# Usage:
+#   ruby simple.rb
+#   GBMT_MODE=normal GBMT_BACKTRACE_MAX_LINES=2 ruby simple.rb
+#   GBMT_MODE=verbose GBMT_BACKTRACE_MAX_LINES=5 ruby simple.rb
+#   GBMT_MODE=silent ruby simple.rb
+
+GiveBackMyTraces.start
+
+def bar(baz:)
+end
+
+def some_method
+  bar
+rescue  StandardError
+  # Nothing to see
+end
+
+some_method

data/give_back_my_traces.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/give_back_my_traces/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "give_back_my_traces"
+  spec.version       = GiveBackMyTraces::VERSION
+  spec.authors       = ["Carlos Atkinson"]
+  spec.email         = ["carlos.atks@gmail.com"]
+
+  spec.summary       = "GiveBackMyTraces let's you get your traces back"
+  spec.homepage      = "https://github.com/catks/give_back_my_traces"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/catks/give_back_my_traces"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gbmt.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+GBMT = GiveBackMyTraces

data/lib/give_back_my_traces/errors_collection.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "give_back_my_traces/helpers"
+
+module GiveBackMyTraces
+  # class to handle errors collected by GBMT
+  class ErrorsCollection
+    include Enumerable
+    include Comparable
+    extend Forwardable
+
+    delegate %i[each last <<] => :@errors
+
+    def initialize(errors = [])
+      @errors = errors
+    end
+
+    def pretty_print
+      GiveBackMyTraces::Helpers.pretty_print(@errors)
+    end
+
+    def <=>(other)
+      @errors <=> other
+    end
+  end
+end

data/lib/give_back_my_traces/helpers.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GiveBackMyTraces
+  # Helper class with error formating methods
+  module Helpers
+    class << self
+      def pretty_print(errors, verbose: false)
+        errors.each do |error|
+          $stdout.puts pretty_format(error, verbose: verbose)
+        end
+      end
+
+      def pretty_format(error, verbose: false)
+        backtrace_max_lines = verbose ? 1000 : config[:backtrace][:max_lines]
+
+        <<~FORMAT
+          ----------------------------------------------------
+           Error: #{error.class}
+           Message: #{error.message}
+           Backtrace:
+             #{format_backtrace(error.backtrace, max_lines: backtrace_max_lines)}
+          ----------------------------------------------------
+        FORMAT
+      end
+
+      private
+
+      def format_backtrace(backtrace, max_lines:)
+        backtrace_lines = backtrace.first(max_lines).join("\n   ")
+
+        return "#{backtrace_lines}\n   ..." if backtrace.size > max_lines
+
+        backtrace_lines
+      end
+
+      def config
+        GiveBackMyTraces.config
+      end
+    end
+  end
+end

data/lib/give_back_my_traces/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GiveBackMyTraces
+  VERSION = "0.1.1"
+end

data/lib/give_back_my_traces.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative "give_back_my_traces/version"
+require_relative "give_back_my_traces/errors_collection"
+require_relative "gbmt"
+
+# Main module to handle GBMT api
+#
+# Usage:
+#
+# # With ENV variables to enable (aka: GBMT_ENABLE=1)
+#  GiveBackMyTraces.init(mode: :verbose)
+#  #  # ...Some code...
+#  GiveBackMyTraces.errors # See all the errors rescued so far
+#
+# # Explicity enabling it
+#  GiveBackMyTraces.start(mode: :silent)
+#  #  # ...Some code...
+#  GiveBackMyTraces.errors # See all the errors rescued so far
+#
+#
+# GiveBackMyTraces.errors.pretty_print # Print errors
+module GiveBackMyTraces
+  class Error < StandardError; end
+
+  DEFAULT_CONFIG = {
+    mode: ENV.fetch("GBMT_MODE", :normal).to_sym,
+    backtrace: {
+      max_lines: ENV.fetch("GBMT_BACKTRACE_MAX_LINES", 5).to_i
+    }
+  }.freeze
+
+  TRACKERS = {
+    normal: ->(error) { warn GiveBackMyTraces::Helpers.pretty_format(error) },
+    silent: ->(_) {},
+    verbose: ->(error) { warn GiveBackMyTraces::Helpers.pretty_format(error, verbose: true) }
+  }.freeze
+
+  class << self
+    def init(**options)
+      start(**options) if ENV.key?("GBMT_ENABLE")
+    end
+
+    def start(**options)
+      config.merge!(options)
+
+      @trace = TracePoint.new(:raise) do |tp|
+        error = tp.raised_exception
+
+        errors << error
+
+        GiveBackMyTraces::TRACKERS[config[:mode]].call(error)
+      end
+
+      @trace.enable
+
+      return unless block_given?
+
+      yield
+
+      stop
+    end
+
+    def stop
+      @trace&.disable
+    end
+
+    def clear
+      self.errors = GiveBackMyTraces::ErrorsCollection.new
+    end
+
+    def errors
+      @errors ||= GiveBackMyTraces::ErrorsCollection.new
+    end
+
+    def config
+      @config ||= DEFAULT_CONFIG.dup
+    end
+
+    private
+
+    attr_writer :errors
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: give_back_my_traces
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Carlos Atkinson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-21 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- carlos.atks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/multiple.rb
+- examples/simple.rb
+- give_back_my_traces.gemspec
+- lib/gbmt.rb
+- lib/give_back_my_traces.rb
+- lib/give_back_my_traces/errors_collection.rb
+- lib/give_back_my_traces/helpers.rb
+- lib/give_back_my_traces/version.rb
+homepage: https://github.com/catks/give_back_my_traces
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/catks/give_back_my_traces
+  source_code_uri: https://github.com/catks/give_back_my_traces
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: GiveBackMyTraces let's you get your traces back
+test_files: []