debug_logging 1.0.16 → 3.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (23) hide show
  1. checksums.yaml +5 -5
  2. data/.rubocop.yml +99 -0
  3. data/.rubocop_todo.yml +133 -0
  4. data/.travis.yml +34 -5
  5. data/Gemfile +8 -2
  6. data/README.md +160 -55
  7. data/Rakefile +5 -3
  8. data/bin/console +4 -3
  9. data/debug_logging.gemspec +24 -20
  10. data/lib/debug_logging.rb +41 -11
  11. data/lib/debug_logging/active_support_notifications.rb +6 -0
  12. data/lib/debug_logging/argument_printer.rb +82 -36
  13. data/lib/debug_logging/class_logger.rb +38 -10
  14. data/lib/debug_logging/class_notifier.rb +64 -0
  15. data/lib/debug_logging/configuration.rb +74 -63
  16. data/lib/debug_logging/instance_logger.rb +7 -1
  17. data/lib/debug_logging/instance_logger_modulizer.rb +34 -6
  18. data/lib/debug_logging/instance_notifier.rb +18 -0
  19. data/lib/debug_logging/instance_notifier_modulizer.rb +66 -0
  20. data/lib/debug_logging/log_subscriber.rb +43 -0
  21. data/lib/debug_logging/version.rb +3 -1
  22. data/lib/simple_debug_logging.rb +9 -5
  23. metadata +91 -37
data/lib/debug_logging/version.rb CHANGED
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module DebugLogging
2
- VERSION = "1.0.16"
4
+ VERSION = '3.1.1'
3
5
  end
data/lib/simple_debug_logging.rb CHANGED
@@ -1,9 +1,11 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Simpler version of what the sibling DebugLogging library does. Included as a bauble.
2
4
  #
3
5
  ############# THIS IS A BAUBLE
4
6
  ############# FOR EXAMINING SEVERAL OF THE WONDERS OF RUBY
5
7
  ############# TO ACCOMPLISH SOMETHING PRACTICAL
6
- ############# For a more robust implementation use the gem debug_logging itself,
8
+ ############# For a more robust implementation use the gem debug_logging itself,
7
9
  ############# which makes use of these same principles.
8
10
  #
9
11
  # Automatically log Class.method(arguments) as they are called at runtime (instance or singleton)!
@@ -19,8 +21,6 @@
19
21
  # logged :a_class_method
20
22
  # end
21
23
  #
22
- # Make sure you have the latest debug_logging gem (>= 1.0.10) installed for this to work
23
- #
24
24
  # In an irb session:
25
25
  # >> require_relative 'unobtrusively_logged'
26
26
  # => true
@@ -39,13 +39,16 @@ require 'benchmark'
39
39
 
40
40
  class SimpleDebugLogging < Module
41
41
  def initialize(i_methods: nil)
42
+ super()
42
43
  @instance_methods_to_log = Array(i_methods) if i_methods
43
44
  end
45
+
44
46
  def included(base)
45
47
  instance_method_logger = InstanceMethodLoggerModulizer.to_mod(@instance_methods_to_log)
46
48
  base.send(:prepend, instance_method_logger)
47
49
  base.send(:extend, ClassMethodLogger)
48
50
  end
51
+
49
52
  module ClassMethodLogger
50
53
  def logged(*methods_to_log)
51
54
  methods_to_log.each do |method_to_log|
@@ -54,7 +57,7 @@ class SimpleDebugLogging < Module
54
57
  define_method(method_to_log.to_sym) do |*args|
55
58
  method_return_value = nil
56
59
  invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if args
57
- puts "#{self}.#{method_to_log}(#{args.map {|x| x.inspect}.join(", ")})#{invocation_id}"
60
+ puts "#{self}.#{method_to_log}(#{args.map(&:inspect).join(', ')})#{invocation_id}"
58
61
  elapsed = Benchmark.realtime do
59
62
  method_return_value = original_method.call(*args)
60
63
  end
@@ -65,6 +68,7 @@ class SimpleDebugLogging < Module
65
68
  end
66
69
  end
67
70
  end
71
+
68
72
  module InstanceMethodLoggerModulizer
69
73
  def self.to_mod(methods_to_log = [])
70
74
  Module.new do
@@ -72,7 +76,7 @@ class SimpleDebugLogging < Module
72
76
  define_method(method_to_log.to_sym) do |*args, &block|
73
77
  method_return_value = nil
74
78
  invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if args
75
- puts "#{self.class}##{method_to_log}(#{args.map {|x| x.inspect}.join(", ")})#{invocation_id}"
79
+ puts "#{self.class}##{method_to_log}(#{args.map(&:inspect).join(', ')})#{invocation_id}"
76
80
  elapsed = Benchmark.realtime do
77
81
  method_return_value = super(*args, &block)
78
82
  end
metadata CHANGED
@@ -1,113 +1,161 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: debug_logging
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.16
4
+ version: 3.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Peter Boling
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-01-16 00:00:00.000000000 Z
11
+ date: 2020-12-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: colorize
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.8'
19
+ version: '0'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: '0.8'
26
+ version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
- name: rspec-pending_for
28
+ name: activesupport
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '5.2'
31
34
  - - ">="
32
35
  - !ruby/object:Gem::Version
33
- version: '0'
36
+ version: 5.2.4.4
34
37
  type: :development
35
38
  prerelease: false
36
39
  version_requirements: !ruby/object:Gem::Requirement
37
40
  requirements:
41
+ - - "~>"
42
+ - !ruby/object:Gem::Version
43
+ version: '5.2'
38
44
  - - ">="
39
45
  - !ruby/object:Gem::Version
40
- version: '0'
46
+ version: 5.2.4.4
41
47
  - !ruby/object:Gem::Dependency
42
48
  name: bundler
43
49
  requirement: !ruby/object:Gem::Requirement
44
50
  requirements:
45
- - - "~>"
51
+ - - ">="
46
52
  - !ruby/object:Gem::Version
47
- version: '1.14'
53
+ version: '2'
48
54
  type: :development
49
55
  prerelease: false
50
56
  version_requirements: !ruby/object:Gem::Requirement
51
57
  requirements:
52
- - - "~>"
58
+ - - ">="
53
59
  - !ruby/object:Gem::Version
54
- version: '1.14'
60
+ version: '2'
55
61
  - !ruby/object:Gem::Dependency
56
- name: coveralls
62
+ name: byebug
57
63
  requirement: !ruby/object:Gem::Requirement
58
64
  requirements:
59
- - - "~>"
65
+ - - ">="
60
66
  - !ruby/object:Gem::Version
61
- version: '0.8'
67
+ version: '11'
62
68
  type: :development
63
69
  prerelease: false
64
70
  version_requirements: !ruby/object:Gem::Requirement
65
71
  requirements:
66
- - - "~>"
72
+ - - ">="
67
73
  - !ruby/object:Gem::Version
68
- version: '0.8'
74
+ version: '11'
69
75
  - !ruby/object:Gem::Dependency
70
76
  name: rake
71
77
  requirement: !ruby/object:Gem::Requirement
72
78
  requirements:
73
- - - "~>"
79
+ - - ">="
74
80
  - !ruby/object:Gem::Version
75
- version: '12.2'
81
+ version: '13'
76
82
  type: :development
77
83
  prerelease: false
78
84
  version_requirements: !ruby/object:Gem::Requirement
79
85
  requirements:
80
- - - "~>"
86
+ - - ">="
81
87
  - !ruby/object:Gem::Version
82
- version: '12.2'
88
+ version: '13'
83
89
  - !ruby/object:Gem::Dependency
84
90
  name: rspec
85
91
  requirement: !ruby/object:Gem::Requirement
86
92
  requirements:
87
- - - "~>"
93
+ - - ">="
88
94
  - !ruby/object:Gem::Version
89
- version: '3.0'
95
+ version: '3'
90
96
  type: :development
91
97
  prerelease: false
92
98
  version_requirements: !ruby/object:Gem::Requirement
93
99
  requirements:
94
- - - "~>"
100
+ - - ">="
95
101
  - !ruby/object:Gem::Version
96
- version: '3.0'
102
+ version: '3'
97
103
  - !ruby/object:Gem::Dependency
98
- name: activesupport
104
+ name: rspec-pending_for
99
105
  requirement: !ruby/object:Gem::Requirement
100
106
  requirements:
101
- - - "~>"
107
+ - - ">="
102
108
  - !ruby/object:Gem::Version
103
- version: '5.1'
109
+ version: '0'
104
110
  type: :development
105
111
  prerelease: false
106
112
  version_requirements: !ruby/object:Gem::Requirement
107
113
  requirements:
108
- - - "~>"
114
+ - - ">="
115
+ - !ruby/object:Gem::Version
116
+ version: '0'
117
+ - !ruby/object:Gem::Dependency
118
+ name: rubocop
119
+ requirement: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">="
122
+ - !ruby/object:Gem::Version
123
+ version: '0.92'
124
+ type: :development
125
+ prerelease: false
126
+ version_requirements: !ruby/object:Gem::Requirement
127
+ requirements:
128
+ - - ">="
129
+ - !ruby/object:Gem::Version
130
+ version: '0.92'
131
+ - !ruby/object:Gem::Dependency
132
+ name: rubocop-rspec
133
+ requirement: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - ">="
136
+ - !ruby/object:Gem::Version
137
+ version: '1'
138
+ type: :development
139
+ prerelease: false
140
+ version_requirements: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - ">="
143
+ - !ruby/object:Gem::Version
144
+ version: '1'
145
+ - !ruby/object:Gem::Dependency
146
+ name: silent_stream
147
+ requirement: !ruby/object:Gem::Requirement
148
+ requirements:
149
+ - - ">="
150
+ - !ruby/object:Gem::Version
151
+ version: '1'
152
+ type: :development
153
+ prerelease: false
154
+ version_requirements: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - ">="
109
157
  - !ruby/object:Gem::Version
110
- version: '5.1'
158
+ version: '1'
111
159
  description: |2
112
160
 
113
161
  Unobtrusive debug logging for Ruby. NO LITTERING.
@@ -121,6 +169,8 @@ files:
121
169
  - ".coveralls.yml"
122
170
  - ".gitignore"
123
171
  - ".rspec"
172
+ - ".rubocop.yml"
173
+ - ".rubocop_todo.yml"
124
174
  - ".travis.yml"
125
175
  - Gemfile
126
176
  - README.md
@@ -129,18 +179,23 @@ files:
129
179
  - bin/setup
130
180
  - debug_logging.gemspec
131
181
  - lib/debug_logging.rb
182
+ - lib/debug_logging/active_support_notifications.rb
132
183
  - lib/debug_logging/argument_printer.rb
133
184
  - lib/debug_logging/class_logger.rb
185
+ - lib/debug_logging/class_notifier.rb
134
186
  - lib/debug_logging/configuration.rb
135
187
  - lib/debug_logging/instance_logger.rb
136
188
  - lib/debug_logging/instance_logger_modulizer.rb
189
+ - lib/debug_logging/instance_notifier.rb
190
+ - lib/debug_logging/instance_notifier_modulizer.rb
191
+ - lib/debug_logging/log_subscriber.rb
137
192
  - lib/debug_logging/version.rb
138
193
  - lib/simple_debug_logging.rb
139
194
  homepage: https://github.com/pboling/debug_logging
140
195
  licenses:
141
196
  - MIT
142
197
  metadata: {}
143
- post_install_message:
198
+ post_install_message:
144
199
  rdoc_options: []
145
200
  require_paths:
146
201
  - lib
@@ -148,16 +203,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
148
203
  requirements:
149
204
  - - ">="
150
205
  - !ruby/object:Gem::Version
151
- version: 2.0.0
206
+ version: 2.4.0
152
207
  required_rubygems_version: !ruby/object:Gem::Requirement
153
208
  requirements:
154
209
  - - ">="
155
210
  - !ruby/object:Gem::Version
156
211
  version: '0'
157
212
  requirements: []
158
- rubyforge_project:
159
- rubygems_version: 2.6.12
160
- signing_key:
213
+ rubygems_version: 3.1.4
214
+ signing_key:
161
215
  specification_version: 4
162
216
  summary: Drop-in debug logging useful when a call stack gets unruly
163
217
  test_files: []