debug_helper 1.7.0 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +22 -22
- data/README.md +848 -218
- data/lib/debug_helper.rb +79 -160
- data/lib/debug_helper/array_handler.rb +12 -0
- data/lib/debug_helper/dir_handler.rb +19 -0
- data/lib/debug_helper/each_pair_handler.rb +13 -0
- data/lib/debug_helper/each_with_index_handler.rb +11 -0
- data/lib/debug_helper/exception_handler.rb +14 -0
- data/lib/debug_helper/file_handler.rb +29 -0
- data/lib/debug_helper/generic_handler.rb +12 -0
- data/lib/debug_helper/handler.rb +102 -0
- data/lib/debug_helper/hash_handler.rb +19 -0
- data/lib/debug_helper/io_handler.rb +15 -0
- data/lib/debug_helper/match_data_handler.rb +17 -0
- data/lib/debug_helper/object_handler.rb +13 -0
- data/lib/debug_helper/open_struct_handler.rb +16 -0
- data/lib/debug_helper/range_handler.rb +14 -0
- data/lib/debug_helper/regexp_handler.rb +16 -0
- data/lib/debug_helper/set_handler.rb +12 -0
- data/lib/debug_helper/string_handler.rb +17 -0
- data/lib/debug_helper/struct_handler.rb +18 -0
- data/lib/debug_helper/symbol_handler.rb +15 -0
- data/lib/debug_helper/version.rb +3 -3
- data/markdown/readme/Rakefile +36 -6
- data/markdown/readme/class_inclusions.md +10 -3
- data/markdown/readme/class_links.md +10 -3
- data/markdown/readme/classes/array/circular/show.md +4 -2
- data/markdown/readme/classes/array/circular/show.yaml +4 -2
- data/markdown/readme/classes/array/mixed/show.md +6 -3
- data/markdown/readme/classes/array/mixed/show.yaml +6 -3
- data/markdown/readme/classes/array/nested/show.md +6 -3
- data/markdown/readme/classes/array/nested/show.yaml +6 -3
- data/markdown/readme/classes/array/simple/show.md +2 -1
- data/markdown/readme/classes/array/simple/show.yaml +2 -1
- data/markdown/readme/classes/dir/simple/show.md +28 -0
- data/markdown/readme/classes/dir/simple/show.rb +4 -0
- data/markdown/readme/classes/dir/simple/show.yaml +11 -0
- data/markdown/readme/classes/dir/simple/template.md +9 -0
- data/markdown/readme/classes/dir/template.md +3 -0
- data/markdown/readme/classes/exception/simple/show.md +44 -0
- data/markdown/readme/classes/exception/simple/show.rb +22 -0
- data/markdown/readme/classes/exception/simple/show.yaml +9 -0
- data/markdown/readme/classes/exception/simple/template.md +9 -0
- data/markdown/readme/classes/exception/template.md +3 -0
- data/markdown/readme/classes/file/simple/show.md +3 -3
- data/markdown/readme/classes/file/simple/show.yaml +3 -3
- data/markdown/readme/classes/hash/circular/show.md +12 -4
- data/markdown/readme/classes/hash/circular/show.yaml +12 -4
- data/markdown/readme/classes/hash/mixed/show.md +14 -6
- data/markdown/readme/classes/hash/mixed/show.yaml +14 -6
- data/markdown/readme/classes/hash/nested/show.md +24 -9
- data/markdown/readme/classes/hash/nested/show.yaml +24 -9
- data/markdown/readme/classes/hash/simple/show.md +10 -4
- data/markdown/readme/classes/hash/simple/show.yaml +10 -4
- data/markdown/readme/classes/io/simple/show.md +23 -0
- data/markdown/readme/classes/io/simple/show.rb +4 -0
- data/markdown/readme/classes/io/simple/show.yaml +6 -0
- data/markdown/readme/classes/io/simple/template.md +9 -0
- data/markdown/readme/classes/io/template.md +3 -0
- data/markdown/readme/classes/match_data/multiple_captures/show.md +33 -0
- data/markdown/readme/classes/match_data/multiple_captures/show.rb +4 -0
- data/markdown/readme/classes/match_data/multiple_captures/show.yaml +16 -0
- data/markdown/readme/classes/match_data/multiple_captures/template.md +9 -0
- data/markdown/readme/classes/match_data/named_captures/show.md +31 -0
- data/markdown/readme/classes/match_data/named_captures/show.rb +4 -0
- data/markdown/readme/classes/match_data/named_captures/show.yaml +14 -0
- data/markdown/readme/classes/match_data/named_captures/template.md +9 -0
- data/markdown/readme/classes/match_data/simple/show.md +25 -0
- data/markdown/readme/classes/match_data/simple/show.rb +4 -0
- data/markdown/readme/classes/match_data/simple/show.yaml +8 -0
- data/markdown/readme/classes/match_data/simple/template.md +9 -0
- data/markdown/readme/classes/match_data/template.md +7 -0
- data/markdown/readme/classes/object/object/show.md +23 -0
- data/markdown/readme/classes/object/object/show.rb +8 -0
- data/markdown/readme/classes/object/object/show.yaml +2 -0
- data/markdown/readme/classes/object/object/template.md +9 -0
- data/markdown/readme/classes/object/template.md +1 -7
- data/markdown/readme/classes/open_struct/circular/show.md +40 -0
- data/markdown/readme/classes/open_struct/circular/show.rb +8 -0
- data/markdown/readme/classes/open_struct/circular/show.yaml +17 -0
- data/markdown/readme/classes/open_struct/circular/template.md +11 -0
- data/markdown/readme/classes/open_struct/mixed/show.md +51 -0
- data/markdown/readme/classes/open_struct/mixed/show.rb +5 -0
- data/markdown/readme/classes/open_struct/mixed/show.yaml +33 -0
- data/markdown/readme/classes/open_struct/mixed/template.md +9 -0
- data/markdown/readme/classes/open_struct/nested/show.md +73 -0
- data/markdown/readme/classes/open_struct/nested/show.rb +14 -0
- data/markdown/readme/classes/open_struct/nested/show.yaml +46 -0
- data/markdown/readme/classes/open_struct/nested/template.md +9 -0
- data/markdown/readme/classes/open_struct/simple/show.md +41 -0
- data/markdown/readme/classes/open_struct/simple/show.rb +5 -0
- data/markdown/readme/classes/open_struct/simple/show.yaml +23 -0
- data/markdown/readme/classes/open_struct/simple/template.md +9 -0
- data/markdown/readme/classes/open_struct/template.md +9 -0
- data/markdown/readme/classes/range/exclude_end/show.md +22 -0
- data/markdown/readme/classes/range/exclude_end/show.rb +4 -0
- data/markdown/readme/classes/range/exclude_end/show.yaml +5 -0
- data/markdown/readme/classes/range/exclude_end/template.md +9 -0
- data/markdown/readme/classes/range/include_end/show.md +22 -0
- data/markdown/readme/classes/range/include_end/show.rb +4 -0
- data/markdown/readme/classes/range/include_end/show.yaml +5 -0
- data/markdown/readme/classes/range/include_end/template.md +9 -0
- data/markdown/readme/classes/range/template.md +5 -0
- data/markdown/readme/classes/regexp/named_captures/show.md +28 -0
- data/markdown/readme/classes/regexp/named_captures/show.rb +4 -0
- data/markdown/readme/classes/regexp/named_captures/show.yaml +11 -0
- data/markdown/readme/classes/regexp/named_captures/template.md +9 -0
- data/markdown/readme/classes/regexp/simple/show.md +24 -0
- data/markdown/readme/classes/regexp/simple/show.rb +4 -0
- data/markdown/readme/classes/regexp/simple/show.yaml +7 -0
- data/markdown/readme/classes/regexp/simple/template.md +9 -0
- data/markdown/readme/classes/regexp/template.md +5 -0
- data/markdown/readme/classes/set/circular/show.md +4 -2
- data/markdown/readme/classes/set/circular/show.yaml +4 -2
- data/markdown/readme/classes/set/mixed/show.md +6 -3
- data/markdown/readme/classes/set/mixed/show.yaml +6 -3
- data/markdown/readme/classes/set/nested/show.md +6 -3
- data/markdown/readme/classes/set/nested/show.yaml +6 -3
- data/markdown/readme/classes/set/simple/show.md +2 -1
- data/markdown/readme/classes/set/simple/show.yaml +2 -1
- data/markdown/readme/classes/string/multiline/show.md +2 -1
- data/markdown/readme/classes/string/multiline/show.yaml +2 -1
- data/markdown/readme/classes/string/simple/show.md +2 -1
- data/markdown/readme/classes/string/simple/show.yaml +2 -1
- data/markdown/readme/classes/struct/circular/show.md +34 -8
- data/markdown/readme/classes/struct/circular/show.yaml +34 -8
- data/markdown/readme/classes/struct/mixed/show.md +21 -6
- data/markdown/readme/classes/struct/mixed/show.yaml +21 -6
- data/markdown/readme/classes/struct/nested/show.md +36 -9
- data/markdown/readme/classes/struct/nested/show.yaml +36 -9
- data/markdown/readme/classes/struct/simple/show.md +17 -4
- data/markdown/readme/classes/struct/simple/show.yaml +17 -4
- data/markdown/readme/classes/symbol/simple/show.md +2 -1
- data/markdown/readme/classes/symbol/simple/show.yaml +2 -1
- data/markdown/readme/options/depth/show.md +30 -15
- data/markdown/readme/options/depth/show.yaml +30 -15
- data/markdown/readme/template.md +8 -8
- metadata +88 -14
- data/markdown/readme/classes/object/datetime/show.md +0 -18
- data/markdown/readme/classes/object/datetime/show.rb +0 -4
- data/markdown/readme/classes/object/datetime/show.yaml +0 -1
- data/markdown/readme/classes/object/datetime/template.md +0 -9
- data/markdown/readme/classes/object/range/show.md +0 -19
- data/markdown/readme/classes/object/range/show.rb +0 -4
- data/markdown/readme/classes/object/range/show.yaml +0 -2
- data/markdown/readme/classes/object/range/template.md +0 -9
- data/markdown/readme/classes/object/regexp/show.md +0 -19
- data/markdown/readme/classes/object/regexp/show.rb +0 -4
- data/markdown/readme/classes/object/regexp/show.yaml +0 -2
- data/markdown/readme/classes/object/regexp/template.md +0 -9
@@ -0,0 +1,44 @@
|
|
1
|
+
#### Simple Exception
|
2
|
+
|
3
|
+
This example shows a simple ```Exception```.
|
4
|
+
|
5
|
+
```show.rb```:
|
6
|
+
```ruby
|
7
|
+
require 'debug_helper'
|
8
|
+
|
9
|
+
def foo
|
10
|
+
exception = nil
|
11
|
+
begin
|
12
|
+
raise Exception.new('Boo!')
|
13
|
+
rescue Exception => exception
|
14
|
+
# Already saved.
|
15
|
+
end
|
16
|
+
DebugHelper.show(exception, 'My simple exception')
|
17
|
+
end
|
18
|
+
|
19
|
+
def bar
|
20
|
+
foo
|
21
|
+
end
|
22
|
+
|
23
|
+
def baz
|
24
|
+
bar
|
25
|
+
end
|
26
|
+
|
27
|
+
baz
|
28
|
+
|
29
|
+
```
|
30
|
+
|
31
|
+
The output shows details of the ```Exception```.
|
32
|
+
|
33
|
+
```show.yaml```:
|
34
|
+
```yaml
|
35
|
+
---
|
36
|
+
Exception (message='My simple exception'):
|
37
|
+
message: Boo!
|
38
|
+
cause:
|
39
|
+
backtrace:
|
40
|
+
- show.rb:6:in `foo'
|
41
|
+
- show.rb:14:in `bar'
|
42
|
+
- show.rb:18:in `baz'
|
43
|
+
- show.rb:21:in `<main>'
|
44
|
+
```
|
@@ -0,0 +1,22 @@
|
|
1
|
+
require 'debug_helper'
|
2
|
+
|
3
|
+
def foo
|
4
|
+
exception = nil
|
5
|
+
begin
|
6
|
+
raise Exception.new('Boo!')
|
7
|
+
rescue Exception => exception
|
8
|
+
# Already saved.
|
9
|
+
end
|
10
|
+
DebugHelper.show(exception, 'My simple exception')
|
11
|
+
end
|
12
|
+
|
13
|
+
def bar
|
14
|
+
foo
|
15
|
+
end
|
16
|
+
|
17
|
+
def baz
|
18
|
+
bar
|
19
|
+
end
|
20
|
+
|
21
|
+
baz
|
22
|
+
|
@@ -17,12 +17,12 @@ The output shows details of the file.
|
|
17
17
|
---
|
18
18
|
File (message='My simple file'):
|
19
19
|
absolute_path: C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
|
20
|
-
atime: 2018-07-
|
21
|
-
ctime: 2018-07-
|
20
|
+
atime: 2018-07-14 12:45:32.000000000 -05:00
|
21
|
+
ctime: 2018-07-14 12:45:32.000000000 -05:00
|
22
22
|
executable?: false
|
23
23
|
exist?: true
|
24
24
|
ftype: file
|
25
|
-
mtime: 2018-07-
|
25
|
+
mtime: 2018-07-14 12:45:32.000000000 -05:00
|
26
26
|
path: show.rb
|
27
27
|
pipe?: false
|
28
28
|
readable?: true
|
@@ -1,12 +1,12 @@
|
|
1
1
|
---
|
2
2
|
File (message='My simple file'):
|
3
3
|
absolute_path: C:/Users/Burdette/Documents/GitHub/debug_helper/markdown/readme/classes/file/simple/show.rb
|
4
|
-
atime: 2018-07-
|
5
|
-
ctime: 2018-07-
|
4
|
+
atime: 2018-07-14 12:45:32.000000000 -05:00
|
5
|
+
ctime: 2018-07-14 12:45:32.000000000 -05:00
|
6
6
|
executable?: false
|
7
7
|
exist?: true
|
8
8
|
ftype: file
|
9
|
-
mtime: 2018-07-
|
9
|
+
mtime: 2018-07-14 12:45:32.000000000 -05:00
|
10
10
|
path: show.rb
|
11
11
|
pipe?: false
|
12
12
|
readable?: true
|
@@ -20,18 +20,26 @@ The circular reference is not followed.
|
|
20
20
|
```show.yaml```:
|
21
21
|
```yaml
|
22
22
|
---
|
23
|
-
Hash (
|
23
|
+
Hash (message='My circular hashes'):
|
24
|
+
size: 1
|
25
|
+
default:
|
26
|
+
default_proc:
|
24
27
|
Pair 0:
|
25
28
|
Key:
|
26
|
-
Symbol
|
29
|
+
Symbol:
|
27
30
|
to_s: foo
|
31
|
+
size: 3
|
28
32
|
encoding: !ruby/encoding US-ASCII
|
29
33
|
Value:
|
30
|
-
Hash
|
34
|
+
Hash:
|
35
|
+
size: 1
|
36
|
+
default:
|
37
|
+
default_proc:
|
31
38
|
Pair 0:
|
32
39
|
Key:
|
33
|
-
Symbol
|
40
|
+
Symbol:
|
34
41
|
to_s: bar
|
42
|
+
size: 3
|
35
43
|
encoding: !ruby/encoding US-ASCII
|
36
44
|
Value: Hash {:foo=>{:bar=>{...}}}
|
37
45
|
```
|
@@ -1,15 +1,23 @@
|
|
1
1
|
---
|
2
|
-
Hash (
|
2
|
+
Hash (message='My circular hashes'):
|
3
|
+
size: 1
|
4
|
+
default:
|
5
|
+
default_proc:
|
3
6
|
Pair 0:
|
4
7
|
Key:
|
5
|
-
Symbol
|
8
|
+
Symbol:
|
6
9
|
to_s: foo
|
10
|
+
size: 3
|
7
11
|
encoding: !ruby/encoding US-ASCII
|
8
12
|
Value:
|
9
|
-
Hash
|
13
|
+
Hash:
|
14
|
+
size: 1
|
15
|
+
default:
|
16
|
+
default_proc:
|
10
17
|
Pair 0:
|
11
18
|
Key:
|
12
|
-
Symbol
|
19
|
+
Symbol:
|
13
20
|
to_s: bar
|
21
|
+
size: 3
|
14
22
|
encoding: !ruby/encoding US-ASCII
|
15
23
|
Value: Hash {:foo=>{:bar=>{...}}}
|
@@ -19,31 +19,39 @@ The output shows details of the hash.
|
|
19
19
|
```show.yaml```:
|
20
20
|
```yaml
|
21
21
|
---
|
22
|
-
Hash (
|
22
|
+
Hash (message='My mixed hash'):
|
23
|
+
size: 3
|
24
|
+
default:
|
25
|
+
default_proc:
|
23
26
|
Pair 0:
|
24
27
|
Key:
|
25
|
-
Symbol
|
28
|
+
Symbol:
|
26
29
|
to_s: a
|
30
|
+
size: 1
|
27
31
|
encoding: !ruby/encoding US-ASCII
|
28
32
|
Value: Fixnum 0
|
29
33
|
Pair 1:
|
30
34
|
Key:
|
31
|
-
Symbol
|
35
|
+
Symbol:
|
32
36
|
to_s: b
|
37
|
+
size: 1
|
33
38
|
encoding: !ruby/encoding US-ASCII
|
34
39
|
Value:
|
35
|
-
String
|
40
|
+
String:
|
36
41
|
to_s: one
|
42
|
+
size: 3
|
37
43
|
encoding: !ruby/encoding UTF-8
|
38
44
|
ascii_only?: true
|
39
45
|
bytesize: 3
|
40
46
|
Pair 2:
|
41
47
|
Key:
|
42
|
-
Symbol
|
48
|
+
Symbol:
|
43
49
|
to_s: c
|
50
|
+
size: 1
|
44
51
|
encoding: !ruby/encoding US-ASCII
|
45
52
|
Value:
|
46
|
-
Symbol
|
53
|
+
Symbol:
|
47
54
|
to_s: two
|
55
|
+
size: 3
|
48
56
|
encoding: !ruby/encoding US-ASCII
|
49
57
|
```
|
@@ -1,28 +1,36 @@
|
|
1
1
|
---
|
2
|
-
Hash (
|
2
|
+
Hash (message='My mixed hash'):
|
3
|
+
size: 3
|
4
|
+
default:
|
5
|
+
default_proc:
|
3
6
|
Pair 0:
|
4
7
|
Key:
|
5
|
-
Symbol
|
8
|
+
Symbol:
|
6
9
|
to_s: a
|
10
|
+
size: 1
|
7
11
|
encoding: !ruby/encoding US-ASCII
|
8
12
|
Value: Fixnum 0
|
9
13
|
Pair 1:
|
10
14
|
Key:
|
11
|
-
Symbol
|
15
|
+
Symbol:
|
12
16
|
to_s: b
|
17
|
+
size: 1
|
13
18
|
encoding: !ruby/encoding US-ASCII
|
14
19
|
Value:
|
15
|
-
String
|
20
|
+
String:
|
16
21
|
to_s: one
|
22
|
+
size: 3
|
17
23
|
encoding: !ruby/encoding UTF-8
|
18
24
|
ascii_only?: true
|
19
25
|
bytesize: 3
|
20
26
|
Pair 2:
|
21
27
|
Key:
|
22
|
-
Symbol
|
28
|
+
Symbol:
|
23
29
|
to_s: c
|
30
|
+
size: 1
|
24
31
|
encoding: !ruby/encoding US-ASCII
|
25
32
|
Value:
|
26
|
-
Symbol
|
33
|
+
Symbol:
|
27
34
|
to_s: two
|
35
|
+
size: 3
|
28
36
|
encoding: !ruby/encoding US-ASCII
|
@@ -24,43 +24,58 @@ The output shows details of the hashes.
|
|
24
24
|
```show.yaml```:
|
25
25
|
```yaml
|
26
26
|
---
|
27
|
-
Hash (
|
27
|
+
Hash (message='My nested hash'):
|
28
|
+
size: 2
|
29
|
+
default:
|
30
|
+
default_proc:
|
28
31
|
Pair 0:
|
29
32
|
Key:
|
30
|
-
Symbol
|
33
|
+
Symbol:
|
31
34
|
to_s: a
|
35
|
+
size: 1
|
32
36
|
encoding: !ruby/encoding US-ASCII
|
33
37
|
Value:
|
34
|
-
Hash
|
38
|
+
Hash:
|
39
|
+
size: 2
|
40
|
+
default:
|
41
|
+
default_proc:
|
35
42
|
Pair 0:
|
36
43
|
Key:
|
37
|
-
Symbol
|
44
|
+
Symbol:
|
38
45
|
to_s: b
|
46
|
+
size: 1
|
39
47
|
encoding: !ruby/encoding US-ASCII
|
40
48
|
Value: Fixnum 0
|
41
49
|
Pair 1:
|
42
50
|
Key:
|
43
|
-
Symbol
|
51
|
+
Symbol:
|
44
52
|
to_s: c
|
53
|
+
size: 1
|
45
54
|
encoding: !ruby/encoding US-ASCII
|
46
55
|
Value: Fixnum 1
|
47
56
|
Pair 1:
|
48
57
|
Key:
|
49
|
-
Symbol
|
58
|
+
Symbol:
|
50
59
|
to_s: d
|
60
|
+
size: 1
|
51
61
|
encoding: !ruby/encoding US-ASCII
|
52
62
|
Value:
|
53
|
-
Hash
|
63
|
+
Hash:
|
64
|
+
size: 2
|
65
|
+
default:
|
66
|
+
default_proc:
|
54
67
|
Pair 0:
|
55
68
|
Key:
|
56
|
-
Symbol
|
69
|
+
Symbol:
|
57
70
|
to_s: e
|
71
|
+
size: 1
|
58
72
|
encoding: !ruby/encoding US-ASCII
|
59
73
|
Value: Fixnum 2
|
60
74
|
Pair 1:
|
61
75
|
Key:
|
62
|
-
Symbol
|
76
|
+
Symbol:
|
63
77
|
to_s: f
|
78
|
+
size: 1
|
64
79
|
encoding: !ruby/encoding US-ASCII
|
65
80
|
Value: Fixnum 3
|
66
81
|
```
|
@@ -1,40 +1,55 @@
|
|
1
1
|
---
|
2
|
-
Hash (
|
2
|
+
Hash (message='My nested hash'):
|
3
|
+
size: 2
|
4
|
+
default:
|
5
|
+
default_proc:
|
3
6
|
Pair 0:
|
4
7
|
Key:
|
5
|
-
Symbol
|
8
|
+
Symbol:
|
6
9
|
to_s: a
|
10
|
+
size: 1
|
7
11
|
encoding: !ruby/encoding US-ASCII
|
8
12
|
Value:
|
9
|
-
Hash
|
13
|
+
Hash:
|
14
|
+
size: 2
|
15
|
+
default:
|
16
|
+
default_proc:
|
10
17
|
Pair 0:
|
11
18
|
Key:
|
12
|
-
Symbol
|
19
|
+
Symbol:
|
13
20
|
to_s: b
|
21
|
+
size: 1
|
14
22
|
encoding: !ruby/encoding US-ASCII
|
15
23
|
Value: Fixnum 0
|
16
24
|
Pair 1:
|
17
25
|
Key:
|
18
|
-
Symbol
|
26
|
+
Symbol:
|
19
27
|
to_s: c
|
28
|
+
size: 1
|
20
29
|
encoding: !ruby/encoding US-ASCII
|
21
30
|
Value: Fixnum 1
|
22
31
|
Pair 1:
|
23
32
|
Key:
|
24
|
-
Symbol
|
33
|
+
Symbol:
|
25
34
|
to_s: d
|
35
|
+
size: 1
|
26
36
|
encoding: !ruby/encoding US-ASCII
|
27
37
|
Value:
|
28
|
-
Hash
|
38
|
+
Hash:
|
39
|
+
size: 2
|
40
|
+
default:
|
41
|
+
default_proc:
|
29
42
|
Pair 0:
|
30
43
|
Key:
|
31
|
-
Symbol
|
44
|
+
Symbol:
|
32
45
|
to_s: e
|
46
|
+
size: 1
|
33
47
|
encoding: !ruby/encoding US-ASCII
|
34
48
|
Value: Fixnum 2
|
35
49
|
Pair 1:
|
36
50
|
Key:
|
37
|
-
Symbol
|
51
|
+
Symbol:
|
38
52
|
to_s: f
|
53
|
+
size: 1
|
39
54
|
encoding: !ruby/encoding US-ASCII
|
40
55
|
Value: Fixnum 3
|