tapping_device 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 145b8d4cd78d7f40b318352ff3a39a6a4aa194dee91e84db5e4946c522bd59b9
+  data.tar.gz: 9978287948da8f54fc96699be31059abd8ad7d643bf05cb9c54d43bc5ff06019
+SHA512:
+  metadata.gz: 7870a46e126309662fbdd4c7fea746b9bac8b4c31583061e7ed068f77c6d2d6960b84601f74172cb3bb289d615487c513468f1c18ee62f868eb4d229652e099d
+  data.tar.gz: 3b59a134c7e30ce2f5d2f1e3f6bdc6ad76b5fccac4e8092f5ae441c11858d1d3b0ad035b3e5648e0b3912b89da43633e8cc55db749662f1c0e8db8eee4b463d5

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  test:
+    name: Test on ruby ${{ matrix.ruby_version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        ruby_version: ['2.4', '2.5', '2.6']
+        os: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at stan001212@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tapping_device.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    tapping_device (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.0.4)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tapping_device!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 st0012
+
+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,176 @@
+# TappingDevice
+
+![](https://github.com/st0012/tapping_device/workflows/Ruby/badge.svg)
+
+`tapping_device` is a gem based on Ruby’s `TracePoint` class that allows you to tap method calls of specified objects. This could be useful for debugging. For example, you can use it to see who calls you `Post` records
+
+```ruby
+class PostsController < ApplicationController
+  include TappingDevice::Trackable
+
+  before_action :set_post, only: [:show, :edit, :update, :destroy]
+
+  # GET /posts/1
+  # GET /posts/1.json
+  def show
+    tap_on!(@post) do |payload|
+      puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+    end
+  end
+end
+```
+
+And you can see these in log:
+
+```
+Method: name line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
+Method: user_id line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:10
+Method: to_param line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
+```
+
+**Don't use this on production**
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tapping_device', group: :development
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install tapping_device
+```
+
+## Usage
+In order to use `tapping_device`, you need to include `TappingDevice::Trackable` module in where you want to track your code.
+
+### Methods
+- `tap_initialization_of!(class)` - allows you to track a class’ instance initialization
+	- shortcut - `tap_init!`
+- `tap_calls_on!(object)` - allows you to track any calls received by the object
+	- shortcut - `tap_on!`
+- `stop_tapping!(object)` - this stops tapping on the given object
+	- shortcut - `untap!`
+
+### Info of the call
+All tapping methods (start with `tap_`) takes a block and yield a hash as block argument. 
+
+```ruby
+tap_initialization_of!(Student) do |payload|
+  puts(payload.to_s)
+end
+
+Student.new("Stan", 18)
+
+#=> {:receiver=>#<Student:0x00007feec04d9e58 @name="Stan", @age=18>, :method_name=>:initialize, :arguments=>[[:name, "Stan"], [:age, 18]], :return_value=>18, :filepath=>"/path/spec/trackable_spec.rb", :line_number=>7, :defined_class=>Student}
+```
+
+The hash contains
+
+- `receiver` - the receiver object
+- `method_name` - method’s name (symbol) 
+	- e.g. `:name`
+- `arguments` - arguments of the method call
+	- e.g. `[[:name, “Stan”], [:age, 25]]`
+- `return_value` - return value of the method call
+- `filepath` - path to the file that performs the method call
+- `line_number` 
+- `defined_class` - in which class that defines the that’s being called
+- `trace` - stack trace of the call. Default is an empty array unless `with_trace_to` option is set
+- `tp` - trace point object of this call
+
+
+### Options
+- `with_trace_to` - the number of traces we want to put into `trace`. Default is `nil`, so `trace` would be empty
+- `exclude_from_paths` - an array of call path patterns that we want to skip. This could be very helpful when working on Rails projects.
+
+```ruby
+tap_on!(@post, exclude_from_paths: [/active_record/]) do |payload|
+  puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+end
+```
+
+```
+Method: _read_attribute line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
+Method: name line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
+Method: _read_attribute line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/activerecord-5.2.0/lib/active_record/attribute_methods/read.rb:40
+Method: user_id line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:10
+.......
+
+# versus
+
+Method: name line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
+Method: user_id line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:10
+Method: to_param line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
+```
+
+
+### `#tap_init!`
+
+```ruby
+calls = []
+tap_init!(Student) do |payload|
+  calls << [payload[:method_name], payload[:arguments]]
+end
+
+Student.new("Stan", 18)
+Student.new("Jane", 23)
+
+puts(calls.to_s) #=> [[:initialize, [[:name, "Stan"], [:age, 18]]], [:initialize, [[:name, "Jane"], [:age, 23]]]]
+```
+
+### `tap_on!`
+
+```ruby
+class PostsController < ApplicationController
+  include TappingDevice::Trackable
+
+  before_action :set_post, only: [:show, :edit, :update, :destroy]
+
+  # GET /posts/1
+  # GET /posts/1.json
+  def show
+    tap_on!(@post) do |payload|
+      puts "Method: #{payload[:method_name]} line: #{payload[:filepath]}:#{payload[:line_number]}"
+    end
+  end
+end
+```
+
+And you can see these in log:
+
+```
+Method: name line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:5
+Method: user_id line: /Users/st0012/projects/sample/app/views/posts/show.html.erb:10
+Method: to_param line: /Users/st0012/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/actionpack-5.2.0/lib/action_dispatch/routing/route_set.rb:236
+```
+
+
+
+## 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 tags, 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/[USERNAME]/tapping_device. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TappingDevice project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tapping_device/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tapping_device"
+
+# 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
+
+require "irb"
+IRB.start(__FILE__)

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/lib/tapping_device.rb

@@ -0,0 +1,7 @@
+require "tapping_device/version"
+require "tapping_device/trackable"
+
+module TappingDevice
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/tapping_device/trackable.rb

@@ -0,0 +1,67 @@
+module TappingDevice
+  module Trackable
+    TAPPING_DEVICE = :@tapping_device
+    CALLER_START_POINT = 2
+
+    def tap_initialization_of!(klass, options = {}, &block)
+      raise "argument should be a class, got #{klass}" unless klass.is_a?(Class)
+      options[:condition] = -> (arguments) { arguments[:method_name] == :initialize && arguments[:defined_class] == klass }
+      options[:block] = block
+      track(klass, **options)
+    end
+
+    def tap_calls_on!(object, options = {}, &block)
+      options[:condition] = -> (arguments) { arguments[:receiver].object_id == object.object_id }
+      options[:block] = block
+      track(object, **options)
+    end
+
+    def stop_tapping!(object)
+      get_tapping_device(object)&.each { |tp| tp.disable }
+    end
+
+    alias :tap_init! :tap_initialization_of!
+    alias :tap_on! :tap_calls_on!
+    alias :untap! :stop_tapping!
+
+    private
+
+    def track(object, condition:, block:, with_trace_to: nil, exclude_from_paths: [])
+      trace_point = TracePoint.trace(:return) do |tp|
+        filepath, line_number = caller(CALLER_START_POINT).first.split(":")[0..1]
+
+        # this needs to be placed upfront so we can exclude noise before doing more work
+        next if exclude_from_paths.any? { |pattern| pattern.match?(filepath) }
+
+        arguments = tp.binding.local_variables.map { |n| [n, tp.binding.local_variable_get(n)] }
+
+        yield_parameters = {
+          receiver: tp.self,
+          method_name: tp.callee_id,
+          arguments: arguments,
+          return_value: (tp.return_value rescue nil),
+          filepath: filepath,
+          line_number: line_number,
+          defined_class: tp.defined_class,
+          trace: [],
+          tp: tp
+        }
+
+        yield_parameters[:trace] = caller[CALLER_START_POINT..(CALLER_START_POINT + with_trace_to)] if with_trace_to
+
+        block.call(yield_parameters) if condition.call(yield_parameters)
+      end
+
+      add_tapping_device(object, trace_point)
+    end
+
+    def get_tapping_device(object)
+      object.instance_variable_get(TAPPING_DEVICE)
+    end
+
+    def add_tapping_device(object, trace_point)
+      object.instance_variable_set(TAPPING_DEVICE, []) unless get_tapping_device(object)
+      object.instance_variable_get(TAPPING_DEVICE) << trace_point
+    end
+  end
+end

data/lib/tapping_device/version.rb

@@ -0,0 +1,3 @@
+module TappingDevice
+  VERSION = "0.1.0"
+end

data/tapping_device.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tapping_device/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tapping_device"
+  spec.version       = TappingDevice::VERSION
+  spec.authors       = ["st0012"]
+  spec.email         = ["stan001212@gmail.com"]
+
+  spec.summary       = %q{tapping_device provides useful helpers to intercept method calls}
+  spec.description   = %q{tapping_device provides useful helpers to intercept method calls}
+  spec.homepage      = "https://github.com/st0012/tapping_device"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/st0012/tapping_device"
+  spec.metadata["changelog_uri"] = "https://github.com/st0012/tapping_device/releases"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: tapping_device
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- st0012
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: tapping_device provides useful helpers to intercept method calls
+email:
+- stan001212@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tapping_device.rb
+- lib/tapping_device/trackable.rb
+- lib/tapping_device/version.rb
+- tapping_device.gemspec
+homepage: https://github.com/st0012/tapping_device
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/st0012/tapping_device
+  source_code_uri: https://github.com/st0012/tapping_device
+  changelog_uri: https://github.com/st0012/tapping_device/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: tapping_device provides useful helpers to intercept method calls
+test_files: []