introspect 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.codeclimate.yml +18 -0
- data/.gitignore +9 -0
- data/.rspec +1 -0
- data/.rubocop.yml +1156 -0
- data/.ruby-gemset +1 -0
- data/.ruby-version +1 -0
- data/.travis.yml +7 -0
- data/Gemfile +14 -0
- data/Guardfile +9 -0
- data/LICENSE +202 -0
- data/NOTICE +14 -0
- data/README.markdown +81 -0
- data/Rakefile +6 -0
- data/exe/introspect +5 -0
- data/introspect.gemspec +27 -0
- data/lib/introspect.rb +29 -0
- data/lib/introspect/cli.rb +16 -0
- data/lib/introspect/contents.rb +58 -0
- data/lib/introspect/core_ext.rb +3 -0
- data/lib/introspect/version.rb +3 -0
- data/lib/introspect/which.rb +33 -0
- metadata +122 -0
data/.ruby-gemset
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
introspection
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
ruby-2.3.1
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Guardfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/NOTICE
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
Anthony Michael Cook's Introspect
|
2
|
+
Copyright 2012-2016 Anthony Michael Cook
|
3
|
+
|
4
|
+
This product includes software developed by
|
5
|
+
[Anthony Michael Cook](http://anthonymcook.com).
|
6
|
+
|
7
|
+
All source code in this directory and all subdirectories are covered by
|
8
|
+
the Apache 2.0 License, unless explicitly noted otherwise.
|
9
|
+
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
|
11
|
+
All product documentation in this directory and all subdirectories are covered
|
12
|
+
by the Creative Commons Attribution-ShareAlike 4.0 International License,
|
13
|
+
unless explicitly noted otherwise.
|
14
|
+
To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/
|
data/README.markdown
ADDED
@@ -0,0 +1,81 @@
|
|
1
|
+
Introspect
|
2
|
+
==========
|
3
|
+
|
4
|
+
Tools for exploring Ruby's objects!
|
5
|
+
|
6
|
+
Basic Usage
|
7
|
+
-----------
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
require 'introspect/core_ext' # the core extensions are OPTIONAL but handy
|
11
|
+
my_object.introspect
|
12
|
+
```
|
13
|
+
|
14
|
+
Tools Available
|
15
|
+
---------------
|
16
|
+
|
17
|
+
### CONTENTS
|
18
|
+
|
19
|
+
Tells you all about the object and the objects inside it.
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'introspect'
|
23
|
+
Introspect.introspect my_object, :contents
|
24
|
+
```
|
25
|
+
|
26
|
+
example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
[1,2,3].introspect :contents
|
30
|
+
```
|
31
|
+
|
32
|
+
output
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
{
|
36
|
+
[1, 2, 3]=>
|
37
|
+
{
|
38
|
+
:class=>Array,
|
39
|
+
:ancestors=>
|
40
|
+
[
|
41
|
+
Array,
|
42
|
+
Enumerable,
|
43
|
+
Object,
|
44
|
+
PP::ObjectMixin,
|
45
|
+
Introspect::Which,
|
46
|
+
Introspect,
|
47
|
+
Kernel,
|
48
|
+
BasicObject
|
49
|
+
]
|
50
|
+
}
|
51
|
+
}
|
52
|
+
```
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
### WHICH
|
57
|
+
|
58
|
+
Tells you which object a method is defined on.
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
require 'introspect'
|
62
|
+
Introspect.introspect my_object, :which, :method_name
|
63
|
+
```
|
64
|
+
|
65
|
+
example
|
66
|
+
|
67
|
+
```ruby
|
68
|
+
[1,2,3].introspect :which, :cycle
|
69
|
+
```
|
70
|
+
output
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
Array
|
74
|
+
```
|
75
|
+
|
76
|
+
Contributing
|
77
|
+
------------
|
78
|
+
|
79
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/acook/introspection.
|
80
|
+
|
81
|
+
> © Anthony M. Cook 2012-2016
|
data/Rakefile
ADDED
data/exe/introspect
ADDED
data/introspect.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'introspect/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = 'introspect'
|
8
|
+
gem.version = Introspect::VERSION
|
9
|
+
gem.authors = ['Anthony Cook']
|
10
|
+
gem.email = ['github@anthonymcook.com']
|
11
|
+
gem.description = %q{Makes digging deeper into Ruby objects easier.}
|
12
|
+
gem.summary = %q{A tool to examine your Ruby environment.}
|
13
|
+
gem.homepage = 'http://github.com/acook/introspect'
|
14
|
+
gem.license = 'Apache-2.0'
|
15
|
+
|
16
|
+
gem.files = `git ls-files -z`.split("\x0").reject do |f|
|
17
|
+
f.match(%r{^(test|spec|features)/})
|
18
|
+
end
|
19
|
+
gem.executables = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
20
|
+
gem.bindir = 'exe'
|
21
|
+
gem.require_paths = ['lib']
|
22
|
+
|
23
|
+
gem.add_development_dependency 'bundler'
|
24
|
+
gem.add_development_dependency 'rake'
|
25
|
+
gem.add_development_dependency 'rspec'
|
26
|
+
gem.add_development_dependency 'open4'
|
27
|
+
end
|
data/lib/introspect.rb
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
#
|
2
|
+
# You can do `Object.send :include, Introspect`
|
3
|
+
# Then you can call `.introspect` on anything.
|
4
|
+
#
|
5
|
+
# The `introspect` method returns a hash with information about the receiver
|
6
|
+
# including its Class, the Constants, methods, and instance_methods defined inside it.
|
7
|
+
#
|
8
|
+
# The "depth" parameter indicates how deeply it should inspect the object.
|
9
|
+
# By default there is no depth limit. Pass in 1 to just get info on the object itself.
|
10
|
+
#
|
11
|
+
|
12
|
+
require 'introspect/version'
|
13
|
+
require 'introspect/contents'
|
14
|
+
require 'introspect/which'
|
15
|
+
|
16
|
+
module Introspect
|
17
|
+
def self.introspect obj, command = nil, opts = nil
|
18
|
+
case command
|
19
|
+
when :which then Introspect::Which.which obj, opts
|
20
|
+
when :contents then Introspect::Contents.contents obj, opts
|
21
|
+
else
|
22
|
+
raise ArgumentError, "unrecognized command: #{command}"
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
def introspect command = nil, opts = nil
|
27
|
+
Introspect.introspect self, command, opts
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
class Introspect::Contents
|
2
|
+
def self.contents object, arg = nil
|
3
|
+
self.new(object).contents arg
|
4
|
+
end
|
5
|
+
|
6
|
+
def initialize object
|
7
|
+
@object = object
|
8
|
+
end
|
9
|
+
|
10
|
+
def contents depth = 0
|
11
|
+
depth = 0 if depth.nil?
|
12
|
+
|
13
|
+
if @object.kind_of?(Module) && ![Object, Module, Class, BasicObject, Kernel].include?(@object)
|
14
|
+
@ancestors = @object.ancestors
|
15
|
+
@ancestors.shift
|
16
|
+
|
17
|
+
@constants = []
|
18
|
+
@object.constants.sort.each do |c|
|
19
|
+
object = @object.const_get(c)
|
20
|
+
|
21
|
+
if object.respond_to?(:contents) && (depth == 0 || depth > 1) then
|
22
|
+
@constants << object.contents(depth == 0 ? 0 : depth - 1)
|
23
|
+
else
|
24
|
+
@constants << nameof(object)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
@methods = []
|
29
|
+
@object.methods(false).each do |m|
|
30
|
+
@methods << @object.method(m)
|
31
|
+
end
|
32
|
+
|
33
|
+
@instance_methods = []
|
34
|
+
@object.instance_methods(false).each do |m|
|
35
|
+
@instance_methods << @object.instance_method(m)
|
36
|
+
end
|
37
|
+
else
|
38
|
+
@ancestors = @object.class.ancestors
|
39
|
+
end
|
40
|
+
|
41
|
+
structure = Hash.new
|
42
|
+
structure[:class] = @object.class
|
43
|
+
structure[:ancestors] = @ancestors unless @ancestors.nil? || @ancestors.empty?
|
44
|
+
structure[:constants] = @constants unless @constants.nil? || @constants.empty?
|
45
|
+
structure[:methods] = @methods unless @methods.nil? || @methods.empty?
|
46
|
+
structure[:instance_methods] = @instance_methods unless @instance_methods.nil? || @instance_methods.empty?
|
47
|
+
|
48
|
+
{nameof(@object) => structure}
|
49
|
+
end
|
50
|
+
|
51
|
+
def nameof obj
|
52
|
+
if obj.kind_of? Module
|
53
|
+
obj.methods(false).include?(:inspect) ? obj.name : obj
|
54
|
+
else
|
55
|
+
obj
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|