tapping_device 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9806974025c4e1ba9042bf2df5a4b4211a7e4a9630b291e05892d472e54263cc
-  data.tar.gz: fc609ed5be23cac4943e90c34d7126aaffd53816910320f7300d2a33a9d40585
+  metadata.gz: 1b44a9cf6d9eb0e17b965c87b38f5c431058c283c2a6b79dcce1d2b88aafcc5e
+  data.tar.gz: 6afad055a9606958c47534cfa68394bc859c465300ac2c3f9959335edc0b7f4d
 SHA512:
-  metadata.gz: 15ee39e171f665492e47c378bcffedd3d7bc1c8204269607e54c1ac174f44fe5ee4cc33a0ffcd82d4b732abc63def63eefb8b1fda386d4e40503a4bd959e71e2
-  data.tar.gz: 3b4bb1b05949fd4735fde568995e8c92c64634ad39f196f76649e2f401834d8fdc605080546655f90920e8c2cfc1cebb4bf686b7da34494217c677e058f6c73b
+  metadata.gz: e36715dc9d885af5b143ace2b5c3af6ff782e49d371e4b24787ac475f58d140abbad1a9730769722a59c2e06240a3a72930d9588f488595eaa6dc75973a17a31
+  data.tar.gz: e3bd4a46af607281dc82e6bb4e3f57ad54f600d99a25892d7914c4e5577dcf8a3dc212d60449e9ced5b1789680eead0f79f3758ef6b06c25b1b7647f52e2282e

data/.github/workflows/ruby.yml

@@ -33,10 +33,17 @@ jobs:
         gem install bundler
         bundle install --jobs 4 --retry 3
 
-    - name: Run test with Rails ${{ matrix.rails_version }} and publish result
-      uses: paambaati/codeclimate-action@v2.3.0
+    - name: Run test with Rails ${{ matrix.rails_version }}
+      run: bundle exec rake
+
+    - name: Publish Test Coverage
+      uses: paambaati/codeclimate-action@v2.6.0
       env:
-        CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      if: ${{ env.CC_TEST_REPORTER_ID != '' }}
       with:
-        coverageCommand: bundle exec rake
+        # the coverage result should already be generated by the previous step
+        # so we don't need to provide and command in the step
+        # this is just a placeholder to avoid it run the default `yarn coverage` command
+        coverageCommand: ruby -v
         debug: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tapping_device (0.5.0)
+    tapping_device (0.5.1)
       activerecord (>= 5.2)
 
 GEM
@@ -23,7 +23,7 @@ GEM
     database_cleaner (1.7.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
     json (2.3.0)
     method_source (0.9.2)

data/README.md

@@ -21,7 +21,7 @@ Still sounds vague? Let's see some examples:
 
 ### `print_calls` To Track Method Calls
 
-In [Discourse](https://github.com/discourse/discourse), it uses the `Guardian` class for authorization (like policy objects). It's barely visible in controller actions, but it does many checks under the hood. Now, let's say we want to know what the `Guadian` would do when a user creates a post; here's the controller action:
+In [Discourse](https://github.com/discourse/discourse), it uses the `Guardian` class for authorization (like policy objects). It's barely visible in controller actions, but it does many checks under the hood. Now, let's say we want to know what the `Guardian` would do when a user creates a post; here's the controller action:
 
 ```ruby
   def create

data/lib/tapping_device.rb

@@ -5,7 +5,6 @@ require "tapping_device/payload"
 require "tapping_device/output_payload"
 require "tapping_device/trackable"
 require "tapping_device/exceptions"
-require "tapping_device/sql_tapping_methods"
 
 class TappingDevice
 
@@ -17,7 +16,6 @@ class TappingDevice
   @devices = []
   @suspend_new = false
 
-  include SqlTappingMethods
   extend Manageable
 
   def initialize(options = {}, &block)
@@ -111,6 +109,13 @@ class TappingDevice
 
         next unless with_condition_satisfied?(payload)
 
+        # skip TappingDevice related calls
+        if Module.respond_to?(:module_parents)
+          next if payload.defined_class.module_parents.include?(TappingDevice)
+        else
+          next if payload.defined_class.parents.include?(TappingDevice)
+        end
+
         record_call!(payload)
 
         stop_if_condition_fulfilled(payload)

data/lib/tapping_device/trackable.rb

@@ -1,6 +1,6 @@
 class TappingDevice
   module Trackable
-    [:tap_on!, :tap_init!, :tap_assoc!, :tap_sql!, :tap_passed!].each do |method|
+    [:tap_on!, :tap_init!, :tap_assoc!, :tap_passed!].each do |method|
       define_method method do |object, options = {}, &block|
         new_device(options, &block).send(method, object)
       end
@@ -17,7 +17,7 @@ class TappingDevice
       device_2 = tap_passed!(target, options).and_print do |output_payload|
         output_payload.passed_at(inspect: inspect, colorize: colorize)
       end
-      [device_1, device_2]
+      CollectionProxy.new([device_1, device_2])
     end
 
     def print_calls(target, options = {})
@@ -32,6 +32,20 @@ class TappingDevice
     def new_device(options, &block)
       TappingDevice.new(options, &block)
     end
+
+    class CollectionProxy
+      def initialize(devices)
+        @devices = devices
+      end
+
+      [:stop!, :stop_when, :with].each do |method|
+        define_method method do |&block|
+          @devices.each do |device|
+            device.send(method, &block)
+          end
+        end
+      end
+    end
   end
 end
 

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -153,7 +153,6 @@ files:
 - lib/tapping_device/manageable.rb
 - lib/tapping_device/output_payload.rb
 - lib/tapping_device/payload.rb
-- lib/tapping_device/sql_tapping_methods.rb
 - lib/tapping_device/trackable.rb
 - lib/tapping_device/version.rb
 - tapping_device.gemspec

data/lib/tapping_device/sql_tapping_methods.rb

@@ -1,89 +0,0 @@
-class TappingDevice
-  module SqlTappingMethods
-    CALL_STACK_SKIPPABLE_METHODS = [:transaction, :tap]
-
-    # SQLListener acts like an interface for us to intercept activerecord query instrumentations
-    # this means we only need to register one subscriber no matter how many objects we want to tap on
-    class SQLListener
-      def call(name, start, finish, message_id, values);end
-    end
-    @@sql_listener = SQLListener.new
-
-    ActiveSupport::Notifications.subscribe("sql.active_record", @@sql_listener)
-
-    def tap_sql!(object)
-      @call_stack = []
-      @target ||= object
-      @trace_point = with_trace_point_on_target(object, event: [:call, :c_call]) do |start_tp|
-        ########## Check if the call is worth recording ##########
-        filepath, line_number = get_call_location(start_tp, padding: 1) # we need extra padding because of `with_trace_point_on_target`
-        method = start_tp.callee_id
-        next if already_recording?(method)
-
-        ########## Start the recording ##########
-        # 1. Mark recording state by pushing method into @call_stack
-        # 2. Subscribe sql instrumentations generated by activerecord
-        # 3. Record those sqls and run device callbacks
-        # 4. Start waiting for current call's return callback
-        @call_stack.push(method)
-        payload = build_payload(tp: start_tp, filepath: filepath, line_number: line_number)
-        device = tap_on_sql_instrumentation!(payload)
-
-        with_trace_point_on_target(object, event: :return) do |return_tp|
-          next unless return_tp.callee_id == method
-
-          ########## End recording ##########
-          # 1. Close itself
-          # 2. Stop our subscription on SQLListener
-          # 3. Remove current method from @call_stack
-          # 4. Stop the device if stop condition is fulfilled
-          return_tp.disable
-          device.stop!
-          @call_stack.pop
-          stop_if_condition_fulfilled(payload)
-
-          ########## Track descendant objects ##########
-          # if the method creates another Relation object
-          if return_tp.defined_class == ActiveRecord::QueryMethods
-            create_child_device.tap_sql!(return_tp.return_value)
-          end
-        end.enable
-      end
-
-      @trace_point.enable unless self.class.suspend_new
-
-      self
-    end
-  end
-
-  private
-
-  def tap_on_sql_instrumentation!(payload)
-    device = TappingDevice.new do |sql_listener_payload|
-      values = sql_listener_payload.arguments[:values]
-
-      next if should_be_skipped_by_paths?(payload.filepath) ||
-        ["SCHEMA", "TRANSACTION"].include?(values[:name]) ||
-        values[:sql].match?(/SAVEPOINT/)
-
-      payload[:sql] = values[:sql]
-      record_call!(payload)
-    end
-    device.tap_on!(@@sql_listener)
-  end
-
-  # usually, AR's query methods (like `first`) will end up calling `find_by_sql`
-  # then to TappingDevice, both `first` and `find_by_sql` generates the sql
-  # but the results are duplicated, we should only consider the `first` call
-  def already_recording?(method)
-    !@call_stack.empty? || CALL_STACK_SKIPPABLE_METHODS.include?(method)
-  end
-
-  def with_trace_point_on_target(object, event:)
-    TracePoint.new(*event) do |tp|
-      if is_from_target?(object, tp)
-        yield(tp)
-      end
-    end
-  end
-end