search_warrant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97bbb1f38279b2143fa9ba2bf7489da8a7868354
+  data.tar.gz: cc30457211e39bd552037ff7b2cd8501063d9ec9
+SHA512:
+  metadata.gz: 3d825de0ccf44110021dbda29c3752e8a4c689c1b451f4ce102b8ccac2a58cf0899fa52622bfc4326c2272b2658575904f32db846501b735e163ff511ace20d3
+  data.tar.gz: 7e76aba1d94a5bb5341beb4da710a67723f22536622bdd5e1e3d22692d8de092600a57bd74fb335bb69b9a134722b088d651995ac25d089da8615048895cee23

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tom.lord@comlaude.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tom Lord
+
+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,69 @@
+# SearchWarrant
+
+A library to trace method calls on a given class.
+
+More descriptive description to follow...
+
+## Installation
+
+The usual: 
+
+```ruby
+gem install search_warrant
+```
+
+## Usage
+
+```ruby
+class Foo
+  include SearchWarrant # <-- !!!
+
+  def hello(x)
+    greeting('hello', x)
+  end
+
+  private
+
+  def greeting(intro, message)
+    "#{intro}, #{message}".capitalize
+  end
+end
+
+Foo.new.hello('world')
+
+==> In (irb):14:in `irb_binding'
+    Calling #<Foo:0x00000001674250>.hello("world")
+  ==> In (irb):4:in `hello'
+      Calling #<Foo:0x00000001674250>.greeting("hello", "world")
+  <== Returns "Hello, world"
+<== Returns "Hello, world"
+
+ => "Hello, world"
+```
+
+## Danger
+
+Do not use this in production!!
+
+I wrote this as a fun meta-programming challenge, with intended use for debugging
+in development/test environments only.
+
+You can use this library to trace *any* ruby class. Use with caution!
+
+## 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, 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/tom-lord/search_warrant.
+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](http://opensource.org/licenses/MIT).
+

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 "search_warrant"
+
+# 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

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/search_warrant.rb

@@ -0,0 +1,102 @@
+module SearchWarrant
+  VERSION = "0.1.0"
+
+  HOOK_METHODS = %i(
+    search_warrant_before_method_hook
+    search_warrant_after_method_succeeds_hook
+    search_warrant_after_method_fails_hook
+  )
+
+  def self.suppress_tracing
+    old_value = Thread.current[:'suppress tracing']
+    Thread.current[:'suppress tracing'] = true
+    yield
+  ensure
+    Thread.current[:'suppress tracing'] = old_value
+  end
+
+  def self.bypass_trace?(method_name)
+    Thread.current[:'suppress tracing'] ||
+      SearchWarrant.suppress_tracing { HOOK_METHODS.include?(method_name) }
+  end
+
+  def self.before_method_hook(object, method_name, args)
+    return if bypass_trace?(method_name)
+    SearchWarrant.suppress_tracing { object.search_warrant_before_method_hook(method_name, args) }
+  end
+
+  def self.after_method_succeeds_hook(object, method_name, result)
+    return if bypass_trace?(method_name)
+    SearchWarrant.suppress_tracing { object.search_warrant_after_method_succeeds_hook(method_name, result) }
+  end
+
+  def self.after_method_fails_hook(object, method_name, error)
+    return if bypass_trace?(method_name)
+    SearchWarrant.suppress_tracing { object.search_warrant_after_method_fails_hook(method_name, error) }
+  end
+
+  def self.wrap_method(klass, method_name)
+    method_hash = klass.const_get(:METHOD_HASH)
+    method_hash[method_name] = klass.instance_method(method_name)
+    klass.class_eval do
+      define_method(method_name) do |*args, &block|
+        SearchWarrant.before_method_hook(self, method_name, args)
+        begin
+          result = method_hash[method_name].bind(self).call(*args, &block)
+        rescue => error
+          SearchWarrant.after_method_fails_hook(self, method_name, error)
+          raise error
+        end
+        SearchWarrant.after_method_succeeds_hook(self, method_name, result)
+        result
+      end
+    end
+  end
+
+  def self.included(klass)
+    klass.const_set(:METHOD_HASH, {})
+
+    # For methods defined directly within the class
+    def klass.method_added(name)
+      return if @_adding_a_method
+      SearchWarrant.suppress_tracing do
+        @_adding_a_method = true
+        SearchWarrant.wrap_method(self, name)
+        @_adding_a_method = false
+      end
+    end
+
+    # For modules mixed in BEFORE SearchWarrant
+    # And base classes (excluding Object/BasicObject)
+    (klass.instance_methods - Object.instance_methods).each do |method|
+      klass.method_added(method)
+    end
+
+    # For modules mixed in AFTER SearchWarrant
+    def klass.include(module_name)
+      super
+      (module_name.instance_methods - Object.instance_methods).each do |method|
+        method_added(method)
+      end
+    end
+  end
+
+  def search_warrant_before_method_hook(method_name, args)
+    Thread.current[:'method trace depth'] ||= 0
+    print "#{'  '*Thread.current[:'method trace depth']}==> "
+    puts "In #{caller[6]}"
+    print '  ' * (Thread.current[:'method trace depth'] + 2)
+    puts "Calling #{self.inspect}.#{method_name}(#{args.map(&:inspect).join(', ')})"
+    Thread.current[:'method trace depth'] += 1
+  end
+
+  def search_warrant_after_method_succeeds_hook(method_name, result)
+    Thread.current[:'method trace depth'] -= 1
+    puts "#{'  '*Thread.current[:'method trace depth']}<== " +
+      "Returns #{result.inspect}"
+  end
+
+  def search_warrant_after_method_fails_hook(method_name, error)
+    puts "<== FAILS with error: #{error.message}"
+  end
+end

data/search_warrant.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'search_warrant'
+
+Gem::Specification.new do |spec|
+  spec.name          = "search_warrant"
+  spec.version       = SearchWarrant::VERSION
+  spec.authors       = ["Tom Lord"]
+  spec.email         = ["tom.lord@comlaude.com"]
+
+  spec.summary       = %q{Trace all method calls on instances of a given class}
+  spec.homepage      = "https://github.com/tom-lord/search_warrant"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: search_warrant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Lord
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 
+email:
+- tom.lord@comlaude.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/search_warrant.rb
+- search_warrant.gemspec
+homepage: https://github.com/tom-lord/search_warrant
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Trace all method calls on instances of a given class
+test_files: []