trace_spy 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a36db56361a6223b879ca27adfedfbb65660a7617bd5e24fca290a876be6df92
4
+ data.tar.gz: 68506cf1d4bb171fc998761190a680547d238418e43e04f51a432af10be5f9ff
5
+ SHA512:
6
+ metadata.gz: 6155fea20309cba45610af5d966eab12e348769dfb1d376894e97eda9b7bd7fda593fa0f3fdd4947a2637016bb6a3a1b3f3b454318a28bd2c85465e7cd0ada7c
7
+ data.tar.gz: 543c16db8f7d8055137d22b1959f97f216b8f117136d7e1eb5453a33263ce13aa4de108c38cca56caa0cedd0ea93efaa1796b43ed2178554cdaa4d4f2daea6bf
data/.gitignore ADDED
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ *.gem
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.0
7
+ before_install: gem install bundler -v 1.17.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at keystonelemur@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in trace_spy.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Brandon Weaver
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,104 @@
1
+ # TraceSpy
2
+
3
+ TraceSpy is a wrapper around TracePoint to expose more power in matching against
4
+ various cases of Ruby and getting value from composable traces.
5
+
6
+ Right now this is super alpha and involves a lot of hackery, hence v0.0.1. I would
7
+ suggest reading into [Qo](https://github.com/baweaver/qo) to get an idea of how the matchers
8
+ work.
9
+
10
+ **WARNING**: When I say alpha, I mean no tests currently, and the API is going to likely
11
+ change quite a bit as I experiment with things. This is a proof-of-concept to see how
12
+ I can create a nice API, and we'll work from there.
13
+
14
+ ## Usage
15
+
16
+ ```ruby
17
+ def testing(a, b, c)
18
+ raise 'heck' if a.is_a?(Numeric) && a > 20
19
+
20
+ a + b + c
21
+ end
22
+
23
+ testing_spy = TraceSpy::Method.new(:testing) do |spy|
24
+ # On the arguments, given as keywords, will yield arguments to the block
25
+ spy.on_arguments do |m|
26
+ m.when(a: String, b: String, c: String) do |v|
27
+ puts "Oh hey! You called me with strings: #{v}"
28
+ end
29
+
30
+ m.when(a: 1, b: 2, c: 3) do |v|
31
+ puts "My args were 1, 2, 3: #{v}"
32
+ end
33
+ end
34
+
35
+ # On an exception, will yield exception to the block
36
+ spy.on_exception do |m|
37
+ m.when(RuntimeError) do |e|
38
+ puts "I encountered an error: #{e}"
39
+ end
40
+ end
41
+
42
+ # On a return value, will yield the return to the block
43
+ spy.on_return do |m|
44
+ m.when(String) do |v|
45
+ puts "Strings in, Strings out no?: #{v}"
46
+ end
47
+
48
+ m.when(:even?) do |v|
49
+ puts "I got an even return: #{v}"
50
+ end
51
+ end
52
+ end
53
+
54
+ testing_spy.enable
55
+ # => false
56
+
57
+ testing(1, 2, 3)
58
+ # My args were 1, 2, 3: {:a=>1, :b=>2, :c=>3}
59
+ # I got an even return: 6
60
+ # => 6
61
+
62
+ testing(21, 2, 3)
63
+ # I encountered an error: heck
64
+ # RuntimeError: heck
65
+ # from (pry):2:in `testing'
66
+
67
+ testing(*%w(foo bar baz))
68
+ # Oh hey! You called me with strings: {:a=>"foo", :b=>"bar", :c=>"baz"}
69
+ # Strings in, Strings out no?: foobarbaz
70
+ ```
71
+
72
+ ## Installation
73
+
74
+ Add this line to your application's Gemfile:
75
+
76
+ ```ruby
77
+ gem 'trace_spy'
78
+ ```
79
+
80
+ And then execute:
81
+
82
+ $ bundle
83
+
84
+ Or install it yourself as:
85
+
86
+ $ gem install trace_spy
87
+
88
+ ## Development
89
+
90
+ 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.
91
+
92
+ 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).
93
+
94
+ ## Contributing
95
+
96
+ Bug reports and pull requests are welcome on GitHub at https://github.com/baweaver/trace_spy. 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.
97
+
98
+ ## License
99
+
100
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
101
+
102
+ ## Code of Conduct
103
+
104
+ Everyone interacting in the TraceSpy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/baweaver/trace_spy/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "trace_spy"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,52 @@
1
+ module TraceSpy
2
+ class Method
3
+ def initialize(method_name, &fn)
4
+ @method_name = method_name
5
+ @spies = Hash.new { |h,k| h[k] = [] }
6
+ @tracepoint = nil
7
+
8
+ yield(self) if block_given?
9
+ end
10
+
11
+ def on_arguments(&matcher_fn)
12
+ @spies[:arguments] << Qo.match(&matcher_fn)
13
+ end
14
+
15
+ def on_return(&matcher_fn)
16
+ @spies[:return] << Qo.match(&matcher_fn)
17
+ end
18
+
19
+ def on_exception(&matcher_fn)
20
+ @spies[:exception] << Qo.match(&matcher_fn)
21
+ end
22
+
23
+ def enable
24
+ @tracepoint = TracePoint.new do |trace|
25
+ begin
26
+ next unless trace.method_id == @method_name
27
+
28
+ call_with = -> with { -> spy { spy.call(with) } }
29
+
30
+ @spies[:arguments].each(&call_with[extract_args(trace)]) if CALL_EVENT.include?(trace.event)
31
+ @spies[:return].each(&call_with[trace.return_value]) if RETURN_EVENT.include?(trace.event)
32
+ @spies[:exception].each(&call_with[trace.raised_exception]) if RAISE_EVENT.include?(trace.event)
33
+ rescue RuntimeError => e
34
+ # Stupid hack for now
35
+ p e
36
+ end
37
+ end
38
+
39
+ @tracepoint.enable
40
+ end
41
+
42
+ def disable
43
+ @tracepoint&.disable
44
+ end
45
+
46
+ def extract_args(trace)
47
+ param_names = trace.parameters.map(&:last)
48
+
49
+ param_names.map { |n| [n, trace.binding.eval(n.to_s)] }.to_h
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,3 @@
1
+ module TraceSpy
2
+ VERSION = "0.0.1"
3
+ end
data/lib/trace_spy.rb ADDED
@@ -0,0 +1,13 @@
1
+ require "trace_spy/version"
2
+
3
+ require 'qo'
4
+
5
+ module TraceSpy
6
+ class Error < StandardError; end
7
+
8
+ CALL_EVENT = Set.new([:call, :c_call])
9
+ RETURN_EVENT = Set.new([:return, :c_return])
10
+ RAISE_EVENT = Set.new([:raise])
11
+ end
12
+
13
+ require 'trace_spy/method'
data/trace_spy.gemspec ADDED
@@ -0,0 +1,30 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "trace_spy/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "trace_spy"
8
+ spec.version = TraceSpy::VERSION
9
+ spec.authors = ["Brandon Weaver"]
10
+ spec.email = ["keystonelemur@gmail.com"]
11
+
12
+ spec.summary = %q{TraceSpy is a wrapper around TracePoint}
13
+ spec.homepage = "https://www.github.com/baweaver/trace_spy"
14
+ spec.license = "MIT"
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_runtime_dependency "qo"
26
+
27
+ spec.add_development_dependency "bundler", "~> 1.17"
28
+ spec.add_development_dependency "rake", "~> 10.0"
29
+ spec.add_development_dependency "rspec", "~> 3.0"
30
+ end
metadata ADDED
@@ -0,0 +1,113 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: trace_spy
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Brandon Weaver
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-01-26 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: qo
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.17'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.17'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description:
70
+ email:
71
+ - keystonelemur@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - CODE_OF_CONDUCT.md
80
+ - Gemfile
81
+ - LICENSE.txt
82
+ - README.md
83
+ - Rakefile
84
+ - bin/console
85
+ - bin/setup
86
+ - lib/trace_spy.rb
87
+ - lib/trace_spy/method.rb
88
+ - lib/trace_spy/version.rb
89
+ - trace_spy.gemspec
90
+ homepage: https://www.github.com/baweaver/trace_spy
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubygems_version: 3.0.1
110
+ signing_key:
111
+ specification_version: 4
112
+ summary: TraceSpy is a wrapper around TracePoint
113
+ test_files: []