File: logger_spec.rb

package info (click to toggle)
ruby-logify 0.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 128 kB
  • sloc: ruby: 408; makefile: 5
file content (253 lines) | stat: -rw-r--r-- 7,337 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
require 'spec_helper'

module Logify
  describe Logger do
    let(:io)     { StringIO.new }
    let(:klass)  { Class.new { include Logify } }
    let(:log)    { klass.new.log }
    let(:stdout) { io.rewind && io.read }

    before do
      Logify.level = :debug
      Logify.io = io
    end

    it 'accepts a string parameter' do
      expect { log.debug 'An informative message' }.to_not raise_error
      expect(stdout).to include('An informative message')
    end

    it 'accepts a block parameter' do
      expect {
        log.debug { String.new('An informative message') }
      }.to_not raise_error
      expect(stdout).to include('An informative message')
    end

    context 'when the log level is :debug' do
      it 'pretty aligns parameters' do
        log.info  'Starting some command...'
        log.debug 'x = 0'
        log.debug 'y = 99'
        log.warn  'x is 0'
        log.error 'Cannot divide by 0'
        log.fatal 'Ruby segfaulted'


        expect(stdout).to include('| ===> Starting some command...')
        expect(stdout).to include('|      x = 0')
        expect(stdout).to include('|      y = 99')
        expect(stdout).to include('| **** x is 0')
        expect(stdout).to include('| >>>> Cannot divide by 0')
        expect(stdout).to include('| !!!! Ruby segfaulted')
      end

      context 'when the class is < MAX_LENGTH' do
        it 'uses the full class name' do
          klass.stub(:name).and_return('Hello::Kitty')
          log.debug 'Helpful info'

          expect(stdout).to include('Hello::Kitty |      Helpful info')
        end
      end

      context 'when the class is MAX_LENGTH' do
        it 'uses the full class name' do
          klass.stub(:name).and_return('Hello::Kitty::Magical::Pony::Eye')
          log.debug 'Helpful info'

          expect(stdout).to include('Hello::Kitty::Magical::Pony::Eye |      Helpful info')
        end
      end

      context 'when the class is > MAX_LENGTH' do
        it 'shortens the name by namespace' do
          klass.stub(:name).and_return('Hello::Kitty::Magical::Ponies::Eye')
          log.debug 'Helpful info'

          expect(stdout).to include('Kitty::Magical::Ponies::Eye |      Helpful info')
        end

        it 'just pre-truncates long names' do
          klass.stub(:name).and_return('ReallyLongHelloKittyMagicalPoniesEye')
          log.debug 'Helpful info'

          expect(stdout).to include('gHelloKittyMagicalPoniesEye |      Helpful info')
        end
      end
    end

    context 'when the log level is not :debug' do
      before { Logify.level = :info }

      it 'uses the shortened syntax' do
        log.info  'Starting some command...'
        log.debug 'x = 0'
        log.debug 'y = 99'
        log.warn  'x is 0'
        log.error 'Cannot divide by 0'
        log.fatal 'Ruby segfaulted'


        expect(stdout).to include('I: Starting some command')
        expect(stdout).to include('W: x is 0')
        expect(stdout).to include('E: Cannot divide by 0')
        expect(stdout).to include('F: Ruby segfaulted')
      end
    end

    context 'when the log level is :info' do
      before { Logify.level = :info }

      it 'does not print :debug messages' do
        log.debug 'This is a debug'
        expect(stdout).to_not include('This is a debug')
      end

      it 'prints :info messages' do
        log.info 'This is info'
        expect(stdout).to include('This is info')
      end

      it 'prints :warn messages' do
        log.warn 'This is a warn'
        expect(stdout).to include('This is a warn')
      end

      it 'prints :error messages' do
        log.error 'This is an error'
        expect(stdout).to include('This is an error')
      end

      it 'prints :fatal messages' do
        log.fatal 'This is a fatal'
        expect(stdout).to include('This is a fatal')
      end
    end

    context 'when the log level is :warn' do
      before { Logify.level = :warn }

      it 'does not print :debug messages' do
        log.debug 'This is a debug'
        expect(stdout).to_not include('This is a debug')
      end

      it 'does not print :info messages' do
        log.info 'This is info'
        expect(stdout).to_not include('This is info')
      end

      it 'prints :warn messages' do
        log.warn 'This is a warn'
        expect(stdout).to include('This is a warn')
      end

      it 'prints :error messages' do
        log.error 'This is an error'
        expect(stdout).to include('This is an error')
      end

      it 'prints :fatal messages' do
        log.fatal 'This is a fatal'
        expect(stdout).to include('This is a fatal')
      end
    end

    context 'when the log level is :error' do
      before { Logify.level = :error }

      it 'does not print :debug messages' do
        log.debug 'This is a debug'
        expect(stdout).to_not include('This is a debug')
      end

      it 'does not print :info messages' do
        log.info 'This is info'
        expect(stdout).to_not include('This is info')
      end

      it 'does not print :warn messages' do
        log.warn 'This is a warn'
        expect(stdout).to_not include('This is a warn')
      end

      it 'prints :error messages' do
        log.error 'This is an error'
        expect(stdout).to include('This is an error')
      end

      it 'prints :fatal messages' do
        log.fatal 'This is a fatal'
        expect(stdout).to include('This is a fatal')
      end
    end

    context 'when the log level is :fatal' do
      before { Logify.level = :fatal }

      it 'does not print :debug messages' do
        log.debug 'This is a debug'
        expect(stdout).to_not include('This is a debug')
      end

      it 'does not print :info messages' do
        log.info 'This is info'
        expect(stdout).to_not include('This is info')
      end

      it 'does not print :warn messages' do
        log.warn 'This is a warn'
        expect(stdout).to_not include('This is a warn')
      end

      it 'does not print :error messages' do
        log.error 'This is an error'
        expect(stdout).to_not include('This is an error')
      end

      it 'prints :fatal messages' do
        log.fatal 'This is a fatal'
        expect(stdout).to include('This is a fatal')
      end
    end

    context 'when the log level is :none' do
      before { Logify.level = :none }

      it 'does not print :debug messages' do
        log.debug 'This is a debug'
        expect(stdout).to_not include('This is a debug')
      end

      it 'does not print :info messages' do
        log.info 'This is info'
        expect(stdout).to_not include('This is info')
      end

      it 'does not print :warn messages' do
        log.warn 'This is a warn'
        expect(stdout).to_not include('This is a warn')
      end

      it 'does not print :error messages' do
        log.error 'This is an error'
        expect(stdout).to_not include('This is an error')
      end

      it 'does not print :fatal messages' do
        log.fatal 'This is a fatal'
        expect(stdout).to_not include('This is a fatal')
      end
    end

    context 'with filter params' do
      before { Logify.filter('bacon') }

      it 'filters the parameter' do
        log.info 'The password is bacon'
        expect(stdout).to include('The password is [FILTERED]')
      end
    end
  end
end