Merge pull request #29 from carlosdanielpohlod/fix/custom_trace_selector

fix: fix CustomTraceSelectorFilter to return true when a trace matches with the provided filters

Author: carlosdanielpohlod

lib/rails_tracepoint_stack/filter/custom_trace_selector_filter.rb

@@ -4,7 +4,7 @@ module CustomTraceSelectorFilter
       def is_a_trace_required_to_watch_by_the_custom_configs?(trace:)
         return false unless RailsTracepointStack.configuration.file_path_to_filter_patterns.any?
 
-        !filter_match_a_custom_pattern_to_be_not_ignored?(trace)
+        filter_match_a_custom_pattern_to_be_not_ignored?(trace)
       end
 
       private

spec/rails_tracepoint_stack/filter/custom_trace_selector_filter_spec.rb

@@ -11,21 +11,25 @@
       let(:trace) { instance_double(RailsTracepointStack::Trace, file_path: file_path) }
 
       before do
-        allow(RailsTracepointStack.configuration).to receive(:file_path_to_filter_patterns).and_return([/app\/controllers/])
+        allow(RailsTracepointStack.configuration)
+          .to receive(:file_path_to_filter_patterns)
+          .and_return([/app\/controllers/])
       end
 
-      it { is_expected.to be_falsey }
+      it { is_expected.to be_truthy }
     end
 
     context "when the trace's file path does not match a custom pattern" do
       let(:file_path) { 'app/models/post.rb' }
       let(:trace) { instance_double(RailsTracepointStack::Trace, file_path: file_path) }
 
       before do
-        allow(RailsTracepointStack.configuration).to receive(:file_path_to_filter_patterns).and_return([/app\/controllers/])
+        allow(RailsTracepointStack.configuration)
+          .to receive(:file_path_to_filter_patterns)
+          .and_return([/app\/controllers/])
       end
 
-      it { is_expected.to be_truthy }
+      it { is_expected.to be_falsey }
     end
   end
 end 

spec/rails_tracepoint_stack/tracer_spec.rb

@@ -13,7 +13,15 @@ def dummy_method_with_params(param_1, param_2)
 RSpec.describe RailsTracepointStack::Tracer do
   let(:tracer) { RailsTracepointStack::Tracer.new }
 
-  context "when the log not should be ignored" do
+  before do
+    allow(RailsTracepointStack::Logger)
+      .to receive(:log)
+
+    allow_any_instance_of(TracePoint)
+      .to receive(:lineno).and_return(6)
+  end
+
+  describe "when the log should not be ignored because not match any filter block" do
     before do
       allow(RailsTracepointStack::Filter::GemPath)
         .to receive(:full_gem_path)
@@ -23,71 +31,16 @@ def dummy_method_with_params(param_1, param_2)
         .to receive(:ruby_lib_path)
         .and_return('/path/to/ruby/lib')
 
-      allow(RailsTracepointStack::Logger).to receive(:log)
-
       allow_any_instance_of(TracePoint)
         .to receive(:path)
         .and_return("/app/rails_tracepoint_stack/spec/tracer_spec.rb")
 
-      allow_any_instance_of(TracePoint).to receive(:lineno).and_return(6)
-
       allow_any_instance_of(RailsTracepointStack::Configuration)
         .to receive(:log_format)
         .and_return(:text)
     end
 
-    context "when log format is text" do
-      before do
-        RailsTracepointStack.configure do |config|
-          config.log_format = :text
-        end
-      end
-
-      it 'calls logger with correct log' do
-        tracer.tracer.enable do
-          Foo.new.dummy_method
-        end
-
-        expect(RailsTracepointStack::Logger)
-          .to have_received(:log)
-          .with("called: Foo#dummy_method in /app/rails_tracepoint_stack/spec/tracer_spec.rb:6 with params: {}")
-      end
-    end
-
-    context "when log format is json" do
-      before do
-        RailsTracepointStack.configure do |config|
-          config.log_format = :json
-        end
-      end
-      # TODO: Extract this test to a proper place
-      it 'calls logger with correct log with json log format' do
-        allow_any_instance_of(RailsTracepointStack::Configuration)
-          .to receive(:log_format)
-          .and_return(:json)
-
-        tracer.tracer.enable do
-          Foo.new.dummy_method
-        end
-
-        expect(RailsTracepointStack::Logger)
-          .to have_received(:log)
-          .with("{\"class\":\"Foo\",\"method_name\":\"dummy_method\",\"path\":\"/app/rails_tracepoint_stack/spec/tracer_spec.rb\",\"line\":6,\"params\":{}}")
-      end
-     
-      # TODO: Extract this test to a proper place
-      it 'calls logger with correct log with json log format' do
-        allow_any_instance_of(RailsTracepointStack::Configuration).to receive(:log_format).and_return(:json)
-
-        tracer.tracer.enable do
-          Foo.new.dummy_method_with_params("param_1_value", "param_2_value")
-        end
-
-        expect(RailsTracepointStack::Logger)
-          .to have_received(:log)
-          .with("{\"class\":\"Foo\",\"method_name\":\"dummy_method_with_params\",\"path\":\"/app/rails_tracepoint_stack/spec/tracer_spec.rb\",\"line\":6,\"params\":{\"param_1\":\"param_1_value\",\"param_2\":\"param_2_value\"}}")
-      end
-    end
+    include_examples "tracer success examples asserts"
   end
 
   context "when the log should be ignored because is a gem dependency" do
@@ -104,8 +57,6 @@ def dummy_method_with_params(param_1, param_2)
         .to receive(:path)
         .and_return("/path/to/ruby/lib")
 
-      allow(RailsTracepointStack::Logger).to receive(:log)
-
       RailsTracepointStack.configure do |config|
         config.log_external_sources = false
       end
@@ -134,8 +85,6 @@ def dummy_method_with_params(param_1, param_2)
         .to receive(:path)
         .and_return("/path/to/gem/some_file.rb")
 
-      allow(RailsTracepointStack::Logger).to receive(:log)
-
       RailsTracepointStack.configure do |config|
         config.log_external_sources = false
       end
@@ -164,8 +113,6 @@ def dummy_method_with_params(param_1, param_2)
         .to receive(:path)
         .and_return("/another/path/to/gem/some_file.rb")
 
-      allow(RailsTracepointStack::Logger).to receive(:log)
-
       RailsTracepointStack.configure do |config|
         config.log_external_sources = true
       end
@@ -194,8 +141,6 @@ def dummy_method_with_params(param_1, param_2)
         .to receive(:path)
         .and_return("/another/path/to/gem/some_file.rb")
 
-      allow(RailsTracepointStack::Logger).to receive(:log)
-
       RailsTracepointStack.configure do |config|
         config.ignore_patterns = [/another\/path/]
       end
@@ -222,20 +167,18 @@ def dummy_method_with_params(param_1, param_2)
 
       allow_any_instance_of(TracePoint)
         .to receive(:path)
-        .and_return("/another/path/to/gem/some_file.rb")
-
-      allow(RailsTracepointStack::Logger).to receive(:log)
-
+        .and_return("/another/path/some_file.rb")
+        
       allow_any_instance_of(RailsTracepointStack::Trace)
         .to receive(:file_path)
-        .and_return("/another/path/to/gem/some_file.rb")
+        .and_return("/another/path/some_file.rb")
 
       RailsTracepointStack.configure do |config|
         config.file_path_to_filter_patterns = [/another\/path/]
       end
     end
 
-    it 'calls logger' do
+    it "calls logger" do
       tracer.tracer.enable do
         Foo.new.dummy_method
       end

spec/shared/tracer_examples.rb

@@ -0,0 +1,31 @@
+RSpec.shared_examples "tracer success examples asserts" do
+  context "when log format is text" do
+    it 'calls logger with correct log' do
+      tracer.tracer.enable do
+        Foo.new.dummy_method
+      end
+
+      expect(RailsTracepointStack::Logger)
+        .to have_received(:log)
+        .with("called: Foo#dummy_method in /app/rails_tracepoint_stack/spec/tracer_spec.rb:6 with params: {}")
+    end
+  end
+
+  context "when log format is json" do
+    before do
+      allow(RailsTracepointStack.configuration)
+        .to receive(:log_format)
+        .and_return(:json)
+    end
+    # TODO: Extract this test to a proper place
+    it 'calls logger with correct log with json log format' do
+      tracer.tracer.enable do
+        Foo.new.dummy_method
+      end
+
+      expect(RailsTracepointStack::Logger)
+        .to have_received(:log)
+        .with("{\"class\":\"Foo\",\"method_name\":\"dummy_method\",\"path\":\"/app/rails_tracepoint_stack/spec/tracer_spec.rb\",\"line\":6,\"params\":{}}")
+    end
+  end
+end

spec/spec_helper.rb

@@ -1,4 +1,5 @@
 Dir[File.join(File.dirname(__FILE__), '../lib/**/*.rb')].sort.each { |file| require file }
+Dir[File.join(File.dirname(__FILE__), './shared/**/*.rb')].each { |f| require f }
 
 def initialize_gem_configuration!
   RailsTracepointStack.configuration = RailsTracepointStack::Configuration.new