give_back_my_traces 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b90f146fc69d87b26e750c8488df198790455e7ef9df8ef3ebd47a5a0b9486
-  data.tar.gz: 119c08f92ef0953874ff6577ba11eb5967fff7980e8a208a4df0a2c39c7bd983
+  metadata.gz: 8a33c10a1184b7bda92c8132962fb79bc59a6f1f04680d80d7603d54b9d10014
+  data.tar.gz: 1968735c7bc44474504fe808e1fae4f5ba274daac0c112395bc8353022708dc9
 SHA512:
-  metadata.gz: d85098ced00e20dc0eae0c602d71b9a25be76d26bad5756011f676a5ecfa473c625f766864b6768b5ac29de6e1c1827f9d94e6f79c7c2f1eff02a097c236cd26
-  data.tar.gz: 1c721fb4231841608335e5291853d53920b2057f3af4aa7ed7e5a10f9db904e545cbfe0485c5401cba8a2d529261e27e6fbafb9db4f6662957d823dd858f322b
+  metadata.gz: df1b8338dfbccad012766c72ab18b4df0a64b42d8961214bec128b01a2b601d124fe75cb703f51be3c2963ef9fb8d6179f636774983539ecc8b11a815328de66
+  data.tar.gz: 9182cae21e229251718691ffadca6b0550aef7693160d240625db2dcac28570fac5857f43305433d7065b5b975eb447ea870d707dfdd29f06c771137433846fd

data/.github/workflows/main.yml

@@ -1,17 +1,39 @@
 name: Ruby
 
-on: [push, workflow_dispatch]
+on:
+  push:
+    branches: [ master ]
+  workflow_dispatch:
+  pull_request:
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
         cache-version: 1
+
+    - name: Setup Code Climate test-reporter
+      if: ${{ matrix.ruby-version }} == '2.7'
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+
     - name: Run the default task
       run: bundle exec rake
+
+    - name: Publish code coverage
+      if: ${{ matrix.ruby-version }} == '2.7'
+      run: |
+        export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
+        ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}}

data/Gemfile

@@ -12,3 +12,5 @@ gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.36"
 
 gem "pry-byebug"
+
+gem "simplecov", "~> 0.17.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    give_back_my_traces (0.1.1)
+    give_back_my_traces (0.1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +10,7 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
+    docile (1.4.0)
     json (2.6.2)
     method_source (1.0.0)
     parallel (1.22.1)
@@ -51,6 +52,11 @@ GEM
     rubocop-ast (1.22.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     unicode-display_width (2.3.0)
 
 PLATFORMS
@@ -62,6 +68,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.36)
+  simplecov (~> 0.17.0)
 
 BUNDLED WITH
    2.3.22

data/README.md

@@ -1,5 +1,9 @@
 # GiveBackMyTraces
 
+![](https://github.com/catks/give_back_my_traces/workflows/Ruby/badge.svg?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/698f7f3d0cb19d95a2e9/maintainability)](https://codeclimate.com/github/catks/give_back_my_traces/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/698f7f3d0cb19d95a2e9/test_coverage)](https://codeclimate.com/github/catks/give_back_my_traces/test_coverage)
+
 GiveBackMyTraces let you discover those sneaky errors in ruby apps.
 
 ## Usage
@@ -48,18 +52,21 @@ require 'give_back_my_traces'
 
 RSpec.configure do |config|
   config.around(:each) do |example|
-    GBMT.init
+    GBMT.init(
+      from: ENV.fetch("GBMT_BACKTRACE_FROM", Rails.root.to_s) # By default only print errors with a backtrace from your app
+    )
 
     example.call
 
     GBMT.clear
+    GBMT.stop
   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
+GBMT_ENABLE=1 rspec spec/requests/my_action_spec.rb
 ----------------------------------------------------
  Error: BaseError
  Message: Test error
@@ -73,6 +80,10 @@ GBMT_ENABLE=1 rspec spec/requests/my_action_spec.rb 2>&1 | head -10
 
 ```
 
+Also you can filter erros by their backtrace with `GBMT_BACKTRACE_FROM`, it could be any string/regexp that matches the first line in the backtrace, eg:
+
+`GBMT_ENABLE=1 GBMT_BACKTRACE_FROM='controllers/my_action_controller' rspec spec/requests/my_action_spec.rb`
+
 See more in the examples folder.
 
 ## Development

data/lib/give_back_my_traces/tracker.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GiveBackMyTraces
+  # class responsible to handle errors that are occurring at Runtime
+  class Tracker
+    NO_OP = ->(_) {}
+
+    def initialize(filters: [], **options)
+      @filters = filters
+      @options = options
+    end
+
+    def call(error)
+      return unless valid?(error)
+
+      print_error(error)
+    end
+
+    private
+
+    attr_accessor :filters, :options
+
+    def valid?(error)
+      filters.all? { |filter| filter.call(error) }
+    end
+
+    def print_error(error)
+      warn GiveBackMyTraces::Helpers.pretty_format(error, **options)
+    end
+  end
+end

data/lib/give_back_my_traces/version.rb

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

data/lib/give_back_my_traces.rb

@@ -2,6 +2,7 @@
 
 require_relative "give_back_my_traces/version"
 require_relative "give_back_my_traces/errors_collection"
+require_relative "give_back_my_traces/tracker"
 require_relative "gbmt"
 
 # Main module to handle GBMT api
@@ -22,18 +23,25 @@ require_relative "gbmt"
 # 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
-    }
+    },
+    from: ENV["GBMT_BACKTRACE_FROM"] && Regexp.new(ENV["GBMT_BACKTRACE_FROM"])
   }.freeze
 
+  FROM_BACKTRACE_FILTER = lambda do |error|
+    return true if GiveBackMyTraces.config[:from].nil?
+    return false unless error.backtrace
+
+    error.backtrace.first.match?(GiveBackMyTraces.config[:from])
+  end
+
   TRACKERS = {
-    normal: ->(error) { warn GiveBackMyTraces::Helpers.pretty_format(error) },
-    silent: ->(_) {},
-    verbose: ->(error) { warn GiveBackMyTraces::Helpers.pretty_format(error, verbose: true) }
+    normal: Tracker.new(filters: [FROM_BACKTRACE_FILTER]),
+    silent: Tracker::NO_OP,
+    verbose: Tracker.new(filters: [FROM_BACKTRACE_FILTER], verbose: true)
   }.freeze
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: give_back_my_traces
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -35,6 +35,7 @@ files:
 - 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/tracker.rb
 - lib/give_back_my_traces/version.rb
 homepage: https://github.com/catks/give_back_my_traces
 licenses: