Permalink
Browse files

0.0.1 alpha sandbox

  • Loading branch information...
baweaver committed Jan 26, 2019
0 parents commit 91052994e82ba09ca09a7ded243000941cd6d5af
Showing with 377 additions and 0 deletions.
  1. +13 −0 .gitignore
  2. +3 −0 .rspec
  3. +7 −0 .travis.yml
  4. +74 −0 CODE_OF_CONDUCT.md
  5. +6 −0 Gemfile
  6. +21 −0 LICENSE.txt
  7. +104 −0 README.md
  8. +6 −0 Rakefile
  9. +14 −0 bin/console
  10. +8 −0 bin/setup
  11. +13 −0 lib/trace_spy.rb
  12. +52 −0 lib/trace_spy/method.rb
  13. +3 −0 lib/trace_spy/version.rb
  14. +14 −0 spec/spec_helper.rb
  15. +9 −0 spec/trace_spy_spec.rb
  16. +30 −0 trace_spy.gemspec
@@ -0,0 +1,13 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/

# rspec failure tracking
.rspec_status

*.gem
3 .rspec
@@ -0,0 +1,3 @@
--format documentation
--color
--require spec_helper
@@ -0,0 +1,7 @@
---
sudo: false
language: ruby
cache: bundler
rvm:
- 2.6.0
before_install: gem install bundler -v 1.17.2
@@ -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 keystonelemur@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/
@@ -0,0 +1,6 @@
source "https://rubygems.org"

git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

# Specify your gem's dependencies in trace_spy.gemspec
gemspec
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 Brandon Weaver

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.
104 README.md
@@ -0,0 +1,104 @@
# TraceSpy

TraceSpy is a wrapper around TracePoint to expose more power in matching against
various cases of Ruby and getting value from composable traces.

Right now this is super alpha and involves a lot of hackery, hence v0.0.1. I would
suggest reading into [Qo](https://github.com/baweaver/qo) to get an idea of how the matchers
work.

**WARNING**: When I say alpha, I mean no tests currently, and the API is going to likely
change quite a bit as I experiment with things. This is a proof-of-concept to see how
I can create a nice API, and we'll work from there.

## Usage

```ruby
def testing(a, b, c)
raise 'heck' if a.is_a?(Numeric) && a > 20
a + b + c
end
testing_spy = TraceSpy::Method.new(:testing) do |spy|
# On the arguments, given as keywords, will yield arguments to the block
spy.on_arguments do |m|
m.when(a: String, b: String, c: String) do |v|
puts "Oh hey! You called me with strings: #{v}"
end
m.when(a: 1, b: 2, c: 3) do |v|
puts "My args were 1, 2, 3: #{v}"
end
end
# On an exception, will yield exception to the block
spy.on_exception do |m|
m.when(RuntimeError) do |e|
puts "I encountered an error: #{e}"
end
end
# On a return value, will yield the return to the block
spy.on_return do |m|
m.when(String) do |v|
puts "Strings in, Strings out no?: #{v}"
end
m.when(:even?) do |v|
puts "I got an even return: #{v}"
end
end
end
testing_spy.enable
# => false
testing(1, 2, 3)
# My args were 1, 2, 3: {:a=>1, :b=>2, :c=>3}
# I got an even return: 6
# => 6
testing(21, 2, 3)
# I encountered an error: heck
# RuntimeError: heck
# from (pry):2:in `testing'
testing(*%w(foo bar baz))
# Oh hey! You called me with strings: {:a=>"foo", :b=>"bar", :c=>"baz"}
# Strings in, Strings out no?: foobarbaz
```

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'trace_spy'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install trace_spy

## 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/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.

## 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 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).
@@ -0,0 +1,6 @@
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :default => :spec
@@ -0,0 +1,14 @@
#!/usr/bin/env ruby

require "bundler/setup"
require "trace_spy"

# 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__)
@@ -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
@@ -0,0 +1,13 @@
require "trace_spy/version"

require 'qo'

module TraceSpy
class Error < StandardError; end

CALL_EVENT = Set.new([:call, :c_call])
RETURN_EVENT = Set.new([:return, :c_return])
RAISE_EVENT = Set.new([:raise])
end

require 'trace_spy/method'
@@ -0,0 +1,52 @@
module TraceSpy
class Method
def initialize(method_name, &fn)
@method_name = method_name
@spies = Hash.new { |h,k| h[k] = [] }
@tracepoint = nil

yield(self) if block_given?
end

def on_arguments(&matcher_fn)
@spies[:arguments] << Qo.match(&matcher_fn)
end

def on_return(&matcher_fn)
@spies[:return] << Qo.match(&matcher_fn)
end

def on_exception(&matcher_fn)
@spies[:exception] << Qo.match(&matcher_fn)
end

def enable
@tracepoint = TracePoint.new do |trace|
begin
next unless trace.method_id == @method_name

call_with = -> with { -> spy { spy.call(with) } }

@spies[:arguments].each(&call_with[extract_args(trace)]) if CALL_EVENT.include?(trace.event)
@spies[:return].each(&call_with[trace.return_value]) if RETURN_EVENT.include?(trace.event)
@spies[:exception].each(&call_with[trace.raised_exception]) if RAISE_EVENT.include?(trace.event)
rescue RuntimeError => e
# Stupid hack for now
p e
end
end

@tracepoint.enable
end

def disable
@tracepoint&.disable
end

def extract_args(trace)
param_names = trace.parameters.map(&:last)

param_names.map { |n| [n, trace.binding.eval(n.to_s)] }.to_h
end
end
end
@@ -0,0 +1,3 @@
module TraceSpy
VERSION = "0.0.1"
end
@@ -0,0 +1,14 @@
require "bundler/setup"
require "trace_spy"

RSpec.configure do |config|
# Enable flags like --only-failures and --next-failure
config.example_status_persistence_file_path = ".rspec_status"

# Disable RSpec exposing methods globally on `Module` and `main`
config.disable_monkey_patching!

config.expect_with :rspec do |c|
c.syntax = :expect
end
end
@@ -0,0 +1,9 @@
RSpec.describe TraceSpy do
it "has a version number" do
expect(TraceSpy::VERSION).not_to be nil
end

it "does something useful" do
expect(false).to eq(true)
end
end
@@ -0,0 +1,30 @@

lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "trace_spy/version"

Gem::Specification.new do |spec|
spec.name = "trace_spy"
spec.version = TraceSpy::VERSION
spec.authors = ["Brandon Weaver"]
spec.email = ["keystonelemur@gmail.com"]

spec.summary = %q{TraceSpy is a wrapper around TracePoint}
spec.homepage = "https://www.github.com/baweaver/trace_spy"
spec.license = "MIT"

# 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_runtime_dependency "qo"

spec.add_development_dependency "bundler", "~> 1.17"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "rspec", "~> 3.0"
end

0 comments on commit 9105299

Please sign in to comment.