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,28 @@
|
|
1
|
+
#### Named Captures
|
2
|
+
|
3
|
+
This example shows a ```Regexp``` with named captures.
|
4
|
+
|
5
|
+
```show.rb```:
|
6
|
+
```ruby
|
7
|
+
require 'debug_helper'
|
8
|
+
|
9
|
+
regexp = Regexp.new(/(?<a>.)(?<b>.)/)
|
10
|
+
DebugHelper.show(regexp, 'My regexp with named captures')
|
11
|
+
```
|
12
|
+
|
13
|
+
The output shows details of the ```Regexp```.
|
14
|
+
|
15
|
+
```show.yaml```:
|
16
|
+
```yaml
|
17
|
+
---
|
18
|
+
Regexp (message='My regexp with named captures'):
|
19
|
+
to_s: "(?-mix:(?<a>.)(?<b>.))"
|
20
|
+
casefold?: false
|
21
|
+
named_captures:
|
22
|
+
a:
|
23
|
+
- 1
|
24
|
+
b:
|
25
|
+
- 2
|
26
|
+
encoding: !ruby/encoding US-ASCII
|
27
|
+
fixed_encoding?: false
|
28
|
+
```
|
@@ -0,0 +1,24 @@
|
|
1
|
+
#### Simple Regexp
|
2
|
+
|
3
|
+
This example shows a simple ```Regexp```.
|
4
|
+
|
5
|
+
```show.rb```:
|
6
|
+
```ruby
|
7
|
+
require 'debug_helper'
|
8
|
+
|
9
|
+
regexp = Regexp.new(/\w+/)
|
10
|
+
DebugHelper.show(regexp, 'My simple regexp')
|
11
|
+
```
|
12
|
+
|
13
|
+
The output shows details of the ```Regexp```.
|
14
|
+
|
15
|
+
```show.yaml```:
|
16
|
+
```yaml
|
17
|
+
---
|
18
|
+
Regexp (message='My simple regexp'):
|
19
|
+
to_s: "(?-mix:\\w+)"
|
20
|
+
casefold?: false
|
21
|
+
named_captures: {}
|
22
|
+
encoding: !ruby/encoding US-ASCII
|
23
|
+
fixed_encoding?: false
|
24
|
+
```
|
@@ -22,8 +22,10 @@ The circular reference is not followed.
|
|
22
22
|
```show.yaml```:
|
23
23
|
```yaml
|
24
24
|
---
|
25
|
-
Set (message='My circular sets'
|
25
|
+
Set (message='My circular sets'):
|
26
|
+
size: 1
|
26
27
|
Element 0:
|
27
|
-
Set
|
28
|
+
Set:
|
29
|
+
size: 1
|
28
30
|
Element 0: 'Set #<Set: {#<Set: {#<Set: {...}>}>}>'
|
29
31
|
```
|
@@ -17,16 +17,19 @@ The output shows details of the set.
|
|
17
17
|
```show.yaml```:
|
18
18
|
```yaml
|
19
19
|
---
|
20
|
-
Set (message='My mixed set'
|
20
|
+
Set (message='My mixed set'):
|
21
|
+
size: 3
|
21
22
|
Element 0: Fixnum 0
|
22
23
|
Element 1:
|
23
|
-
String
|
24
|
+
String:
|
24
25
|
to_s: one
|
26
|
+
size: 3
|
25
27
|
encoding: !ruby/encoding UTF-8
|
26
28
|
ascii_only?: true
|
27
29
|
bytesize: 3
|
28
30
|
Element 2:
|
29
|
-
Symbol
|
31
|
+
Symbol:
|
30
32
|
to_s: two
|
33
|
+
size: 3
|
31
34
|
encoding: !ruby/encoding US-ASCII
|
32
35
|
```
|
@@ -1,13 +1,16 @@
|
|
1
1
|
---
|
2
|
-
Set (message='My mixed set'
|
2
|
+
Set (message='My mixed set'):
|
3
|
+
size: 3
|
3
4
|
Element 0: Fixnum 0
|
4
5
|
Element 1:
|
5
|
-
String
|
6
|
+
String:
|
6
7
|
to_s: one
|
8
|
+
size: 3
|
7
9
|
encoding: !ruby/encoding UTF-8
|
8
10
|
ascii_only?: true
|
9
11
|
bytesize: 3
|
10
12
|
Element 2:
|
11
|
-
Symbol
|
13
|
+
Symbol:
|
12
14
|
to_s: two
|
15
|
+
size: 3
|
13
16
|
encoding: !ruby/encoding US-ASCII
|
@@ -21,14 +21,17 @@ The output shows details of the sets.
|
|
21
21
|
```show.yaml```:
|
22
22
|
```yaml
|
23
23
|
---
|
24
|
-
Set (message='My nested sets'
|
24
|
+
Set (message='My nested sets'):
|
25
|
+
size: 3
|
25
26
|
Element 0: Fixnum 0
|
26
27
|
Element 1:
|
27
|
-
Set
|
28
|
+
Set:
|
29
|
+
size: 2
|
28
30
|
Element 0: Fixnum 1
|
29
31
|
Element 1: Fixnum 2
|
30
32
|
Element 2:
|
31
|
-
Set
|
33
|
+
Set:
|
34
|
+
size: 2
|
32
35
|
Element 0: Fixnum 3
|
33
36
|
Element 1: Fixnum 4
|
34
37
|
```
|
@@ -1,11 +1,14 @@
|
|
1
1
|
---
|
2
|
-
Set (message='My nested sets'
|
2
|
+
Set (message='My nested sets'):
|
3
|
+
size: 3
|
3
4
|
Element 0: Fixnum 0
|
4
5
|
Element 1:
|
5
|
-
Set
|
6
|
+
Set:
|
7
|
+
size: 2
|
6
8
|
Element 0: Fixnum 1
|
7
9
|
Element 1: Fixnum 2
|
8
10
|
Element 2:
|
9
|
-
Set
|
11
|
+
Set:
|
12
|
+
size: 2
|
10
13
|
Element 0: Fixnum 3
|
11
14
|
Element 1: Fixnum 4
|
@@ -18,10 +18,11 @@ The output shows details of the string.
|
|
18
18
|
```show.yaml```:
|
19
19
|
```yaml
|
20
20
|
---
|
21
|
-
String (message='My multiline string'
|
21
|
+
String (message='My multiline string'):
|
22
22
|
to_s: |
|
23
23
|
Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
|
24
24
|
sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
|
25
|
+
size: 122
|
25
26
|
encoding: !ruby/encoding UTF-8
|
26
27
|
ascii_only?: true
|
27
28
|
bytesize: 122
|
@@ -1,8 +1,9 @@
|
|
1
1
|
---
|
2
|
-
String (message='My multiline string'
|
2
|
+
String (message='My multiline string'):
|
3
3
|
to_s: |
|
4
4
|
Lorem Ipsum dolor sit amet,consectetur adipisicing elit,
|
5
5
|
sed doeiusmod tempor incididunt ut laboreet dolore magna aliqua.
|
6
|
+
size: 122
|
6
7
|
encoding: !ruby/encoding UTF-8
|
7
8
|
ascii_only?: true
|
8
9
|
bytesize: 122
|
@@ -15,8 +15,9 @@ The output shows details of the string.
|
|
15
15
|
```show.yaml```:
|
16
16
|
```yaml
|
17
17
|
---
|
18
|
-
String (message='My simple string'
|
18
|
+
String (message='My simple string'):
|
19
19
|
to_s: Lorem ipsum
|
20
|
+
size: 11
|
20
21
|
encoding: !ruby/encoding UTF-8
|
21
22
|
ascii_only?: true
|
22
23
|
bytesize: 11
|
@@ -21,25 +21,51 @@ The circular reference is not followed.
|
|
21
21
|
```show.yaml```:
|
22
22
|
```yaml
|
23
23
|
---
|
24
|
-
MyStruct (message='My circular struct'
|
24
|
+
MyStruct (message='My circular struct'):
|
25
|
+
size: 3
|
25
26
|
Member 0:
|
26
|
-
Name:
|
27
|
+
Name:
|
28
|
+
Symbol:
|
29
|
+
to_s: a
|
30
|
+
size: 1
|
31
|
+
encoding: !ruby/encoding US-ASCII
|
27
32
|
Value:
|
28
|
-
MyStruct
|
33
|
+
MyStruct:
|
34
|
+
size: 3
|
29
35
|
Member 0:
|
30
|
-
Name:
|
36
|
+
Name:
|
37
|
+
Symbol:
|
38
|
+
to_s: a
|
39
|
+
size: 1
|
40
|
+
encoding: !ruby/encoding US-ASCII
|
31
41
|
Value: 'MyStruct #<struct MyStruct a=#<struct MyStruct a=#<struct MyStruct:...>,
|
32
42
|
b=4, c=5>, b=1, c=2>'
|
33
43
|
Member 1:
|
34
|
-
Name:
|
44
|
+
Name:
|
45
|
+
Symbol:
|
46
|
+
to_s: b
|
47
|
+
size: 1
|
48
|
+
encoding: !ruby/encoding US-ASCII
|
35
49
|
Value: Fixnum 4
|
36
50
|
Member 2:
|
37
|
-
Name:
|
51
|
+
Name:
|
52
|
+
Symbol:
|
53
|
+
to_s: c
|
54
|
+
size: 1
|
55
|
+
encoding: !ruby/encoding US-ASCII
|
38
56
|
Value: Fixnum 5
|
39
57
|
Member 1:
|
40
|
-
Name:
|
58
|
+
Name:
|
59
|
+
Symbol:
|
60
|
+
to_s: b
|
61
|
+
size: 1
|
62
|
+
encoding: !ruby/encoding US-ASCII
|
41
63
|
Value: Fixnum 1
|
42
64
|
Member 2:
|
43
|
-
Name:
|
65
|
+
Name:
|
66
|
+
Symbol:
|
67
|
+
to_s: c
|
68
|
+
size: 1
|
69
|
+
encoding: !ruby/encoding US-ASCII
|
44
70
|
Value: Fixnum 2
|
45
71
|
```
|
@@ -1,22 +1,48 @@
|
|
1
1
|
---
|
2
|
-
MyStruct (message='My circular struct'
|
2
|
+
MyStruct (message='My circular struct'):
|
3
|
+
size: 3
|
3
4
|
Member 0:
|
4
|
-
Name:
|
5
|
+
Name:
|
6
|
+
Symbol:
|
7
|
+
to_s: a
|
8
|
+
size: 1
|
9
|
+
encoding: !ruby/encoding US-ASCII
|
5
10
|
Value:
|
6
|
-
MyStruct
|
11
|
+
MyStruct:
|
12
|
+
size: 3
|
7
13
|
Member 0:
|
8
|
-
Name:
|
14
|
+
Name:
|
15
|
+
Symbol:
|
16
|
+
to_s: a
|
17
|
+
size: 1
|
18
|
+
encoding: !ruby/encoding US-ASCII
|
9
19
|
Value: 'MyStruct #<struct MyStruct a=#<struct MyStruct a=#<struct MyStruct:...>,
|
10
20
|
b=4, c=5>, b=1, c=2>'
|
11
21
|
Member 1:
|
12
|
-
Name:
|
22
|
+
Name:
|
23
|
+
Symbol:
|
24
|
+
to_s: b
|
25
|
+
size: 1
|
26
|
+
encoding: !ruby/encoding US-ASCII
|
13
27
|
Value: Fixnum 4
|
14
28
|
Member 2:
|
15
|
-
Name:
|
29
|
+
Name:
|
30
|
+
Symbol:
|
31
|
+
to_s: c
|
32
|
+
size: 1
|
33
|
+
encoding: !ruby/encoding US-ASCII
|
16
34
|
Value: Fixnum 5
|
17
35
|
Member 1:
|
18
|
-
Name:
|
36
|
+
Name:
|
37
|
+
Symbol:
|
38
|
+
to_s: b
|
39
|
+
size: 1
|
40
|
+
encoding: !ruby/encoding US-ASCII
|
19
41
|
Value: Fixnum 1
|
20
42
|
Member 2:
|
21
|
-
Name:
|
43
|
+
Name:
|
44
|
+
Symbol:
|
45
|
+
to_s: c
|
46
|
+
size: 1
|
47
|
+
encoding: !ruby/encoding US-ASCII
|
22
48
|
Value: Fixnum 2
|
@@ -16,22 +16,37 @@ The output shows details of the struct.
|
|
16
16
|
```show.yaml```:
|
17
17
|
```yaml
|
18
18
|
---
|
19
|
-
MyStruct (message='My mixed struct'
|
19
|
+
MyStruct (message='My mixed struct'):
|
20
|
+
size: 3
|
20
21
|
Member 0:
|
21
|
-
Name:
|
22
|
+
Name:
|
23
|
+
Symbol:
|
24
|
+
to_s: a
|
25
|
+
size: 1
|
26
|
+
encoding: !ruby/encoding US-ASCII
|
22
27
|
Value: Fixnum 0
|
23
28
|
Member 1:
|
24
|
-
Name:
|
29
|
+
Name:
|
30
|
+
Symbol:
|
31
|
+
to_s: b
|
32
|
+
size: 1
|
33
|
+
encoding: !ruby/encoding US-ASCII
|
25
34
|
Value:
|
26
|
-
String
|
35
|
+
String:
|
27
36
|
to_s: one
|
37
|
+
size: 3
|
28
38
|
encoding: !ruby/encoding UTF-8
|
29
39
|
ascii_only?: true
|
30
40
|
bytesize: 3
|
31
41
|
Member 2:
|
32
|
-
Name:
|
42
|
+
Name:
|
43
|
+
Symbol:
|
44
|
+
to_s: c
|
45
|
+
size: 1
|
46
|
+
encoding: !ruby/encoding US-ASCII
|
33
47
|
Value:
|
34
|
-
Symbol
|
48
|
+
Symbol:
|
35
49
|
to_s: two
|
50
|
+
size: 3
|
36
51
|
encoding: !ruby/encoding US-ASCII
|
37
52
|
```
|