tapping_device 0.5.7 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28a848cfef98c43315488230c1593aba48ef1b3ee91dc7a495a6cee7cb406771
-  data.tar.gz: 30601c6039343512d3d7c157bd0c8e5645b8005aa37a4b365458018cb477c2d2
+  metadata.gz: d8adc4b6842ade7721eafaf72e9b94c8a6a852c1f9f9beebdf2556b20cef6d4a
+  data.tar.gz: ab22b319f6468837e92f851f00f863cf732dd3c0cc73e286d5f9569d00c34db6
 SHA512:
-  metadata.gz: 2540416f3d4ece8dfb76ee567030d3f4ab9da497c9ae97e9d7418b952d7ce0552453aad33278344ce683dc89a393244d74aef20bc6c6cf9847f0198911999a20
-  data.tar.gz: b417c4c17f18a152ce0bbc4135657bc41cb90b70788b971debb4242a1d35a9189c21621420af5f5bf06e9aa76148f9a49c6e2fb786000769a193c57765de45d1
+  metadata.gz: 992f31b79a3c0a8abc8471ae643f02586cf76d505da493cfe66b37338781251c3dfdba43a158776431c93a342e8b9a02baff78118b71c679aba2f9114c65077c
+  data.tar.gz: cad971d539041804a9860225f17ae23754dc46ea6fa5b7dc15d674e5189c081dd4f6f2602eeea9c27e616fb1b959126fe452ef5f641e249d73392782b17a3c2c

data/.github/workflows/ruby.yml

@@ -1,6 +1,11 @@
 name: Ruby
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
   test:
@@ -8,9 +13,12 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        rails_version: ['5.2', '6']
-        ruby_version: ['2.5', '2.6']
+        rails_version: ['5.2', '6.0.0', '6.1.0']
+        ruby_version: ['2.7', '3.0']
         os: [ubuntu-latest]
+        exclude:
+          - ruby_version: '3.0'
+            rails_version: '5.2'
     steps:
     - uses: actions/checkout@v1
 
@@ -34,7 +42,9 @@ jobs:
         bundle install --jobs 4 --retry 3
 
     - name: Run test with Rails ${{ matrix.rails_version }}
-      run: bundle exec rake
+      env:
+        RAILS_VERSION: ${{ matrix.rails_version }}
+      run: make test
 
     - name: Publish Test Coverage
       uses: paambaati/codeclimate-action@v2.6.0

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+Gemfile.lock
+
 # rspec failure tracking
 .rspec_status

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.0.1

data/CHANGELOG.md

@@ -1,5 +1,72 @@
 # Changelog
 
+## [Unreleased](https://github.com/st0012/tapping_device/tree/HEAD)
+
+[Full Changelog](https://github.com/st0012/tapping_device/compare/v0.5.7...HEAD)
+
+**Implemented enhancements:**
+
+- Support Ruby 3.0 [\#71](https://github.com/st0012/tapping_device/pull/71) ([st0012](https://github.com/st0012))
+
+**Merged pull requests:**
+
+- Drop activerecord requirement [\#73](https://github.com/st0012/tapping_device/pull/73) ([st0012](https://github.com/st0012))
+- Improve file-writing tests [\#72](https://github.com/st0012/tapping_device/pull/72) ([st0012](https://github.com/st0012))
+- Simplify output logic with Ruby' Logger class [\#70](https://github.com/st0012/tapping_device/pull/70) ([st0012](https://github.com/st0012))
+- Refactor Payload classes [\#68](https://github.com/st0012/tapping_device/pull/68) ([st0012](https://github.com/st0012))
+
+## [v0.5.7](https://github.com/st0012/tapping_device/tree/v0.5.7) (2020-09-09)
+
+[Full Changelog](https://github.com/st0012/tapping_device/compare/v0.5.6...v0.5.7)
+
+**Closed issues:**
+
+- Support tag option [\#64](https://github.com/st0012/tapping_device/issues/64)
+
+**Merged pull requests:**
+
+- Use pastel to replace handmade colorizing logic [\#66](https://github.com/st0012/tapping_device/pull/66) ([st0012](https://github.com/st0012))
+- Add tag option [\#65](https://github.com/st0012/tapping_device/pull/65) ([st0012](https://github.com/st0012))
+
+## [v0.5.6](https://github.com/st0012/tapping_device/tree/v0.5.6) (2020-07-17)
+
+[Full Changelog](https://github.com/st0012/tapping_device/compare/v0.5.5...v0.5.6)
+
+## [v0.5.5](https://github.com/st0012/tapping_device/tree/v0.5.5) (2020-07-16)
+
+[Full Changelog](https://github.com/st0012/tapping_device/compare/v0.5.4...v0.5.5)
+
+**Fixed bugs:**
+
+- InitializationTracker's logic can cause error [\#60](https://github.com/st0012/tapping_device/issues/60)
+
+**Closed issues:**
+
+- Refactor get\_method\_from\_object [\#59](https://github.com/st0012/tapping_device/issues/59)
+
+**Merged pull requests:**
+
+- Fix init tracker [\#61](https://github.com/st0012/tapping_device/pull/61) ([st0012](https://github.com/st0012))
+
+## [v0.5.4](https://github.com/st0012/tapping_device/tree/v0.5.4) (2020-07-05)
+
+[Full Changelog](https://github.com/st0012/tapping_device/compare/v0.5.3...v0.5.4)
+
+**Closed issues:**
+
+- Add with\_print\_calls method [\#52](https://github.com/st0012/tapping_device/issues/52)
+- Tapping any instance of class [\#51](https://github.com/st0012/tapping_device/issues/51)
+- Add ignore\_private option [\#50](https://github.com/st0012/tapping_device/issues/50)
+
+**Merged pull requests:**
+
+- Restructure README.md [\#58](https://github.com/st0012/tapping_device/pull/58) ([st0012](https://github.com/st0012))
+- Better support on private methods [\#57](https://github.com/st0012/tapping_device/pull/57) ([st0012](https://github.com/st0012))
+- Add with\_\* helpers \(e.g. with\_print\_calls\) [\#56](https://github.com/st0012/tapping_device/pull/56) ([st0012](https://github.com/st0012))
+- Add force\_recording option for debugging [\#55](https://github.com/st0012/tapping_device/pull/55) ([st0012](https://github.com/st0012))
+- Add print\_instance\_\* and write\_instance\_\* helpers [\#54](https://github.com/st0012/tapping_device/pull/54) ([st0012](https://github.com/st0012))
+- Fix tap\_init by adding c\_\* event type [\#53](https://github.com/st0012/tapping_device/pull/53) ([st0012](https://github.com/st0012))
+
 ## [v0.5.3](https://github.com/st0012/tapping_device/tree/v0.5.3) (2020-06-21)
 
 [Full Changelog](https://github.com/st0012/tapping_device/compare/v0.5.2...v0.5.3)

data/Gemfile

@@ -2,3 +2,14 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in tapping_device.gemspec
 gemspec
+
+rails_version = ENV["RAILS_VERSION"]
+rails_version = "6.1.0" if rails_version.nil?
+
+if rails_version.to_f < 6
+  gem "sqlite3", "~> 1.3.0"
+else
+  gem "sqlite3"
+end
+
+gem "activerecord", "~> #{rails_version}"

data/Makefile

@@ -0,0 +1,3 @@
+test:
+	bundle exec rspec
+	WITH_ACTIVE_RECORD=true bundle exec rspec spec/active_record_spec.rb

data/lib/tapping_device.rb

@@ -1,4 +1,3 @@
-require "active_record"
 require "active_support/core_ext/module/introspection"
 require "pry" # for using Method#source
 
@@ -141,7 +140,7 @@ class TappingDevice
   end
 
   def build_payload(tp:, filepath:, line_number:)
-    Payload.init({
+    Payload.new(
       target: @target,
       receiver: tp.self,
       method_name: tp.callee_id,
@@ -152,10 +151,10 @@ class TappingDevice
       line_number: line_number,
       defined_class: tp.defined_class,
       trace: get_traces(tp),
-      is_private_call?: tp.defined_class.private_method_defined?(tp.callee_id),
+      is_private_call: tp.defined_class.private_method_defined?(tp.callee_id),
       tag: options[:tag],
       tp: tp
-    })
+    )
   end
 
   def get_method_object_from(target, method_name)

data/lib/tapping_device/method_hijacker.rb

@@ -20,10 +20,14 @@ class TappingDevice
 
     def is_writer_method?(method_name)
       has_definition_source?(method_name) && method_name.match?(/\w+=/) && target.method(method_name).source.match?(/attr_writer|attr_accessor/)
+    rescue MethodSource::SourceNotFoundError
+      false
     end
 
     def is_reader_method?(method_name)
       has_definition_source?(method_name) && target.method(method_name).source.match?(/attr_reader|attr_accessor/)
+    rescue MethodSource::SourceNotFoundError
+      false
     end
 
     def has_definition_source?(method_name)

data/lib/tapping_device/output.rb

@@ -1,7 +1,6 @@
-require "tapping_device/output/payload"
+require "logger"
+require "tapping_device/output/payload_wrapper"
 require "tapping_device/output/writer"
-require "tapping_device/output/stdout_writer"
-require "tapping_device/output/file_writer"
 
 class TappingDevice
   module Output
@@ -13,16 +12,16 @@ class TappingDevice
 
     module Helpers
       def and_write(payload_method = nil, options: {}, &block)
-        and_output(payload_method, options: options, writer_klass: FileWriter, &block)
+        and_output(payload_method, options: options, logger: Logger.new(options[:log_file]), &block)
       end
 
       def and_print(payload_method = nil, options: {}, &block)
-        and_output(payload_method, options: options, writer_klass: StdoutWriter, &block)
+        and_output(payload_method, options: options, logger: Logger.new($stdout), &block)
       end
 
-      def and_output(payload_method = nil, options: {}, writer_klass:, &block)
+      def and_output(payload_method = nil, options: {}, logger:, &block)
         output_block = generate_output_block(payload_method, block)
-        @output_writer = writer_klass.new(options, output_block)
+        @output_writer = Writer.new(options: options, output_block: output_block, logger: logger)
         self
       end
 

data/lib/tapping_device/output/{payload.rb → payload_wrapper.rb}

@@ -2,18 +2,38 @@ require "pastel"
 
 class TappingDevice
   module Output
-    class Payload < Payload
+    class PayloadWrapper
       UNDEFINED = "[undefined]"
       PRIVATE_MARK = " (private)"
 
       PASTEL = Pastel.new
       PASTEL.alias_color(:orange, :bright_red, :bright_yellow)
 
+      TappingDevice::Payload::ATTRS.each do |attr|
+        define_method attr do |options = {}|
+          @payload.send(attr)
+        end
+      end
+
+      alias :is_private_call? :is_private_call
+
+      def method_head
+        @payload.method_head
+      end
+
+      def location(options = {})
+        @payload.location(options)
+      end
+
       alias :raw_arguments :arguments
       alias :raw_return_value :return_value
 
+      def initialize(payload)
+        @payload = payload
+      end
+
       def method_name(options = {})
-        name = ":#{super(options)}"
+        name = ":#{@payload.method_name}"
 
         name += " [#{tag}]" if tag
         name += PRIVATE_MARK if is_private_call?
@@ -95,7 +115,7 @@ class TappingDevice
       end
 
       def ivar_changes(options = {})
-        super.map do |ivar, value_changes|
+        @payload.ivar_changes.map do |ivar, value_changes|
           before = generate_string_result(value_changes[:before], options[:inspect])
           after = generate_string_result(value_changes[:after], options[:inspect])
 

data/lib/tapping_device/output/writer.rb

@@ -1,19 +1,21 @@
 class TappingDevice
   module Output
     class Writer
-      def initialize(options, output_block)
+      def initialize(options:, output_block:, logger:)
         @options = options
         @output_block = output_block
+        @logger = logger
       end
 
       def write!(payload)
-        raise NotImplementedError
+        output = generate_output(payload)
+        @logger << output
       end
 
       private
 
       def generate_output(payload)
-        @output_block.call(Output::Payload.init(payload), @options)
+        @output_block.call(PayloadWrapper.new(payload), @options)
       end
     end
   end

data/lib/tapping_device/payload.rb

@@ -1,22 +1,32 @@
 class TappingDevice
-  class Payload < Hash
+  class Payload
     ATTRS = [
       :target, :receiver, :method_name, :method_object, :arguments, :return_value, :filepath, :line_number,
-      :defined_class, :trace, :tag, :tp, :ivar_changes, :is_private_call?
+      :defined_class, :trace, :tag, :tp, :ivar_changes, :is_private_call
     ]
 
-    ATTRS.each do |attr|
-      define_method attr do |options = {}|
-        self[attr]
-      end
-    end
+    attr_accessor(*ATTRS)
+
+    alias :is_private_call? :is_private_call
 
-    def self.init(hash)
-      h = new
-      hash.each do |k, v|
-        h[k] = v
-      end
-      h
+    def initialize(
+      target:, receiver:, method_name:, method_object:, arguments:, return_value:, filepath:, line_number:,
+      defined_class:, trace:, tag:, tp:, is_private_call:
+    )
+      @target = target
+      @receiver = receiver
+      @method_name = method_name
+      @method_object = method_object
+      @arguments = arguments
+      @return_value = return_value
+      @filepath = filepath
+      @line_number = line_number
+      @defined_class = defined_class
+      @trace = trace
+      @tag = tag
+      @tp = tp
+      @ivar_changes = {}
+      @is_private_call = is_private_call
     end
 
     def method_head

data/lib/tapping_device/trackers/initialization_tracker.rb

@@ -11,7 +11,7 @@ class TappingDevice
 
       def track(object)
         super
-        @is_active_record_model = target.ancestors.include?(ActiveRecord::Base)
+        @is_active_record_model = defined?(ActiveRecord) && target.ancestors.include?(ActiveRecord::Base)
         self
       end
 
@@ -20,8 +20,8 @@ class TappingDevice
 
         return payload if @is_active_record_model
 
-        payload[:return_value] = payload[:receiver]
-        payload[:receiver] = target
+        payload.return_value = payload.receiver
+        payload.receiver = target
         payload
       end
 

data/lib/tapping_device/trackers/mutation_tracker.rb

@@ -47,7 +47,7 @@ class TappingDevice
         payload = super
 
         if change_capturing_event?(tp)
-          payload[:ivar_changes] = capture_ivar_changes
+          payload.ivar_changes = capture_ivar_changes
         end
 
         payload
@@ -55,15 +55,14 @@ class TappingDevice
 
       def capture_ivar_changes
         changes = {}
-
         additional_keys = @latest_instance_variables.keys - @instance_variables_snapshot.keys
         additional_keys.each do |key|
-          changes[key] = {before: Output::Payload::UNDEFINED, after: @latest_instance_variables[key]}
+          changes[key] = {before: Output::PayloadWrapper::UNDEFINED, after: @latest_instance_variables[key]}
         end
 
         removed_keys = @instance_variables_snapshot.keys - @latest_instance_variables.keys
         removed_keys.each do |key|
-          changes[key] = {before: @instance_variables_snapshot[key], after: Output::Payload::UNDEFINED}
+          changes[key] = {before: @instance_variables_snapshot[key], after: Output::PayloadWrapper::UNDEFINED}
         end
 
         remained_keys = @latest_instance_variables.keys - additional_keys

data/lib/tapping_device/version.rb

@@ -1,3 +1,3 @@
 class TappingDevice
-  VERSION = "0.5.7"
+  VERSION = "0.6.0"
 end

data/tapping_device.gemspec

@@ -26,17 +26,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  if ENV["RAILS_VERSION"]
-    spec.add_dependency "activerecord", "~> #{ENV["RAILS_VERSION"]}"
-  else
-    spec.add_dependency "activerecord", ">= 5.2"
-  end
-
   spec.add_dependency "pry" # for using Method#source in MutationTracker
   spec.add_dependency "activesupport"
   spec.add_dependency "pastel"
 
-  spec.add_development_dependency "sqlite3", ">= 1.3.6"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: tapping_device
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.0
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2021-04-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -168,8 +140,8 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -184,9 +156,7 @@ files:
 - lib/tapping_device/manageable.rb
 - lib/tapping_device/method_hijacker.rb
 - lib/tapping_device/output.rb
-- lib/tapping_device/output/file_writer.rb
-- lib/tapping_device/output/payload.rb
-- lib/tapping_device/output/stdout_writer.rb
+- lib/tapping_device/output/payload_wrapper.rb
 - lib/tapping_device/output/writer.rb
 - lib/tapping_device/payload.rb
 - lib/tapping_device/trackable.rb
@@ -219,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: tapping_device lets you understand what your Ruby objects do without digging

data/Gemfile.lock

@@ -1,78 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tapping_device (0.5.7)
-      activerecord (>= 5.2)
-      activesupport
-      pastel
-      pry
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    database_cleaner (1.7.0)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    i18n (1.8.5)
-      concurrent-ruby (~> 1.0)
-    json (2.3.0)
-    method_source (1.0.0)
-    minitest (5.14.2)
-    pastel (0.8.0)
-      tty-color (~> 0.5)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sqlite3 (1.4.1)
-    thread_safe (0.3.6)
-    tty-color (0.5.2)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  database_cleaner
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  simplecov (= 0.17.1)
-  sqlite3 (>= 1.3.6)
-  tapping_device!
-
-BUNDLED WITH
-   2.1.1

data/lib/tapping_device/output/file_writer.rb

@@ -1,21 +0,0 @@
-class TappingDevice
-  module Output
-    class FileWriter < Writer
-      def initialize(options, output_block)
-        @path = options[:log_file]
-
-        File.write(@path, "") # clean file
-
-        super
-      end
-
-      def write!(payload)
-        output = generate_output(payload)
-
-        File.open(@path, "a") do |f|
-          f << output
-        end
-      end
-    end
-  end
-end

data/lib/tapping_device/output/stdout_writer.rb

@@ -1,9 +0,0 @@
-class TappingDevice
-  module Output
-    class StdoutWriter < Writer
-      def write!(payload)
-        puts(generate_output(payload))
-      end
-    end
-  end
-end