search_warrant 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 97bbb1f38279b2143fa9ba2bf7489da8a7868354
4
+ data.tar.gz: cc30457211e39bd552037ff7b2cd8501063d9ec9
5
+ SHA512:
6
+ metadata.gz: 3d825de0ccf44110021dbda29c3752e8a4c689c1b451f4ce102b8ccac2a58cf0899fa52622bfc4326c2272b2658575904f32db846501b735e163ff511ace20d3
7
+ data.tar.gz: 7e76aba1d94a5bb5341beb4da710a67723f22536622bdd5e1e3d22692d8de092600a57bd74fb335bb69b9a134722b088d651995ac25d089da8615048895cee23
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.0
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at tom.lord@comlaude.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in search_warrant.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Tom Lord
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.
@@ -0,0 +1,69 @@
1
+ # SearchWarrant
2
+
3
+ A library to trace method calls on a given class.
4
+
5
+ More descriptive description to follow...
6
+
7
+ ## Installation
8
+
9
+ The usual:
10
+
11
+ ```ruby
12
+ gem install search_warrant
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ ```ruby
18
+ class Foo
19
+ include SearchWarrant # <-- !!!
20
+
21
+ def hello(x)
22
+ greeting('hello', x)
23
+ end
24
+
25
+ private
26
+
27
+ def greeting(intro, message)
28
+ "#{intro}, #{message}".capitalize
29
+ end
30
+ end
31
+
32
+ Foo.new.hello('world')
33
+
34
+ ==> In (irb):14:in `irb_binding'
35
+ Calling #<Foo:0x00000001674250>.hello("world")
36
+ ==> In (irb):4:in `hello'
37
+ Calling #<Foo:0x00000001674250>.greeting("hello", "world")
38
+ <== Returns "Hello, world"
39
+ <== Returns "Hello, world"
40
+
41
+ => "Hello, world"
42
+ ```
43
+
44
+ ## Danger
45
+
46
+ Do not use this in production!!
47
+
48
+ I wrote this as a fun meta-programming challenge, with intended use for debugging
49
+ in development/test environments only.
50
+
51
+ You can use this library to trace *any* ruby class. Use with caution!
52
+
53
+ ## Development
54
+
55
+ 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.
56
+
57
+ 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).
58
+
59
+ ## Contributing
60
+
61
+ Bug reports and pull requests are welcome on GitHub at https://github.com/tom-lord/search_warrant.
62
+ This project is intended to be a safe, welcoming space for collaboration, and contributors are
63
+ expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
64
+
65
+
66
+ ## License
67
+
68
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
69
+
@@ -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
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "search_warrant"
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
@@ -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,102 @@
1
+ module SearchWarrant
2
+ VERSION = "0.1.0"
3
+
4
+ HOOK_METHODS = %i(
5
+ search_warrant_before_method_hook
6
+ search_warrant_after_method_succeeds_hook
7
+ search_warrant_after_method_fails_hook
8
+ )
9
+
10
+ def self.suppress_tracing
11
+ old_value = Thread.current[:'suppress tracing']
12
+ Thread.current[:'suppress tracing'] = true
13
+ yield
14
+ ensure
15
+ Thread.current[:'suppress tracing'] = old_value
16
+ end
17
+
18
+ def self.bypass_trace?(method_name)
19
+ Thread.current[:'suppress tracing'] ||
20
+ SearchWarrant.suppress_tracing { HOOK_METHODS.include?(method_name) }
21
+ end
22
+
23
+ def self.before_method_hook(object, method_name, args)
24
+ return if bypass_trace?(method_name)
25
+ SearchWarrant.suppress_tracing { object.search_warrant_before_method_hook(method_name, args) }
26
+ end
27
+
28
+ def self.after_method_succeeds_hook(object, method_name, result)
29
+ return if bypass_trace?(method_name)
30
+ SearchWarrant.suppress_tracing { object.search_warrant_after_method_succeeds_hook(method_name, result) }
31
+ end
32
+
33
+ def self.after_method_fails_hook(object, method_name, error)
34
+ return if bypass_trace?(method_name)
35
+ SearchWarrant.suppress_tracing { object.search_warrant_after_method_fails_hook(method_name, error) }
36
+ end
37
+
38
+ def self.wrap_method(klass, method_name)
39
+ method_hash = klass.const_get(:METHOD_HASH)
40
+ method_hash[method_name] = klass.instance_method(method_name)
41
+ klass.class_eval do
42
+ define_method(method_name) do |*args, &block|
43
+ SearchWarrant.before_method_hook(self, method_name, args)
44
+ begin
45
+ result = method_hash[method_name].bind(self).call(*args, &block)
46
+ rescue => error
47
+ SearchWarrant.after_method_fails_hook(self, method_name, error)
48
+ raise error
49
+ end
50
+ SearchWarrant.after_method_succeeds_hook(self, method_name, result)
51
+ result
52
+ end
53
+ end
54
+ end
55
+
56
+ def self.included(klass)
57
+ klass.const_set(:METHOD_HASH, {})
58
+
59
+ # For methods defined directly within the class
60
+ def klass.method_added(name)
61
+ return if @_adding_a_method
62
+ SearchWarrant.suppress_tracing do
63
+ @_adding_a_method = true
64
+ SearchWarrant.wrap_method(self, name)
65
+ @_adding_a_method = false
66
+ end
67
+ end
68
+
69
+ # For modules mixed in BEFORE SearchWarrant
70
+ # And base classes (excluding Object/BasicObject)
71
+ (klass.instance_methods - Object.instance_methods).each do |method|
72
+ klass.method_added(method)
73
+ end
74
+
75
+ # For modules mixed in AFTER SearchWarrant
76
+ def klass.include(module_name)
77
+ super
78
+ (module_name.instance_methods - Object.instance_methods).each do |method|
79
+ method_added(method)
80
+ end
81
+ end
82
+ end
83
+
84
+ def search_warrant_before_method_hook(method_name, args)
85
+ Thread.current[:'method trace depth'] ||= 0
86
+ print "#{' '*Thread.current[:'method trace depth']}==> "
87
+ puts "In #{caller[6]}"
88
+ print ' ' * (Thread.current[:'method trace depth'] + 2)
89
+ puts "Calling #{self.inspect}.#{method_name}(#{args.map(&:inspect).join(', ')})"
90
+ Thread.current[:'method trace depth'] += 1
91
+ end
92
+
93
+ def search_warrant_after_method_succeeds_hook(method_name, result)
94
+ Thread.current[:'method trace depth'] -= 1
95
+ puts "#{' '*Thread.current[:'method trace depth']}<== " +
96
+ "Returns #{result.inspect}"
97
+ end
98
+
99
+ def search_warrant_after_method_fails_hook(method_name, error)
100
+ puts "<== FAILS with error: #{error.message}"
101
+ end
102
+ end
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'search_warrant'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "search_warrant"
8
+ spec.version = SearchWarrant::VERSION
9
+ spec.authors = ["Tom Lord"]
10
+ spec.email = ["tom.lord@comlaude.com"]
11
+
12
+ spec.summary = %q{Trace all method calls on instances of a given class}
13
+ spec.homepage = "https://github.com/tom-lord/search_warrant"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.12"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ spec.add_development_dependency "rspec", "~> 3.0"
24
+ end
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: search_warrant
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Tom Lord
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-10-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description:
56
+ email:
57
+ - tom.lord@comlaude.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/search_warrant.rb
73
+ - search_warrant.gemspec
74
+ homepage: https://github.com/tom-lord/search_warrant
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.6.12
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: Trace all method calls on instances of a given class
98
+ test_files: []