File: pathspec_spec.rb

package info (click to toggle)
ruby-pathspec 2.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 236 kB
  • sloc: ruby: 854; makefile: 9; sh: 5
file content (388 lines) | stat: -rw-r--r-- 9,956 bytes parent folder | download
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# frozen_string_literal: true

require 'spec_helper'
require 'fakefs/safe'
require 'pathspec'
require 'fakefs/spec_helpers'

describe PathSpec do
  shared_examples 'standard gitignore negation' do
    it { is_expected.not_to match('important.txt') }
    it { is_expected.not_to match('abc/important.txt') }
    it { is_expected.to match('bar/baz/') }
    it { is_expected.to match('foo/file') }
    it { is_expected.not_to match('foo/important.txt') }
    it { is_expected.to match('foo/subdir/file') }
  end

  # Specs that should be kept up to date with the README
  context 'README.md' do
    subject { PathSpec.from_filename 'spec/files/gitignore_readme' }

    it { is_expected.to match('abc/def.rb') }
    it { is_expected.not_to match('abc/important.txt') }
    it do
      expect(subject.match_paths(['/abc/123', '/abc/important.txt', '/abc/'])).to contain_exactly(
        '/abc/123',
        '/abc/'
      )
    end
  end

  context 'initialization' do
    context 'from multilines' do
      context '#new' do
        subject {
          PathSpec.new <<-IGNORELINES
!important.txt
foo/**
/bar/baz
IGNORELINES
        }

        it_behaves_like 'standard gitignore negation'
      end
    end

    context 'from a string with no newlines' do
      let(:str) { 'foo/**' }

      context '#new' do
        subject { PathSpec.new str }

        it { is_expected.to match('foo/important.txt') }
        it { is_expected.to match('foo/bar/') }
      end
    end

    context 'from a non-string/non-enumerable' do
      it 'throws an exception' do
        expect { PathSpec.new Object.new }.to raise_error(/Cannot make Pathspec/)
      end
    end

    context 'from array of gitignore strings' do
      let(:arr) { ['!important.txt', 'foo/**', '/bar/baz'] }

      context '#new' do
        subject { PathSpec.new arr }

        it_behaves_like 'standard gitignore negation'
      end

      context '#from_lines' do
        subject {
          PathSpec.from_lines(arr)
        }

        it_behaves_like 'standard gitignore negation'
      end

      context '#add array' do
        subject {
          ps = PathSpec.new []
          ps.add arr
        }

        it_behaves_like 'standard gitignore negation'
      end
    end

    context 'from linedelimited gitignore string' do
      let(:line) { "!important.txt\nfoo/**\n/bar/baz\n" }

      context '#new' do
        subject { PathSpec.new line }

        it_behaves_like 'standard gitignore negation'
      end

      context '#from_lines' do
        subject {
          PathSpec.from_lines(line)
        }

        it_behaves_like 'standard gitignore negation'
      end

      context '#add' do
        subject {
          ps = PathSpec.new
          ps.add line
        }

        it_behaves_like 'standard gitignore negation'
      end
    end

    context 'from a gitignore file' do
      include FakeFS::SpecHelpers

      let(:filename) { '.gitignore' }
      before(:each) do
        file = File.open(filename, 'w') { |f|
          f << "!important.txt\n"
          f << "foo/**\n"
          f << "/bar/baz\n"
        }
      end

      context '#new' do
        subject {
          PathSpec.new File.open(filename, 'r')
        }

        it_behaves_like 'standard gitignore negation'
      end

      context '#from_filename' do
        subject {
          PathSpec.from_filename(filename)
        }

        it_behaves_like 'standard gitignore negation'
      end
    end

    context 'from multiple gitignore files' do
      include FakeFS::SpecHelpers

      let(:filenames) { ['.gitignore', '.otherignore'] }
      before(:each) do
        file = File.open('.gitignore', 'w') { |f|
          f << "!important.txt\n"
          f << "foo/**\n"
          f << "/bar/baz\n"
        }

        file = File.open('.otherignore', 'w') { |f|
          f << "ban*na\n"
          f << "!banana\n"
        }
      end

      context '#new' do
        subject {
          arr = filenames.collect { |f| File.open(f, 'r') }
          PathSpec.new arr
        }

        it_behaves_like 'standard gitignore negation'

        it { is_expected.to_not match('banana') }
        it { is_expected.to match('banananananana') }
      end

      context '#add' do
        subject {
          arr = filenames.collect { |f| File.open(f, 'r') }
          ps = PathSpec.new
          ps.add arr
        }

        it_behaves_like 'standard gitignore negation'

        it { is_expected.to_not match('banana') }
        it { is_expected.to match('banananananana') }
      end
    end
  end

  context '#match_tree' do
    include FakeFS::SpecHelpers

    context 'unix' do
      let(:root) {'/tmp/project'}
      let(:gitignore) {
        <<-GITIGNORE
  !**/important.txt
  abc/**
  GITIGNORE
      }

      before(:each) {
        FileUtils.mkdir_p root
        FileUtils.mkdir_p "#{root}/abc"
        FileUtils.touch "#{root}/abc/1"
        FileUtils.touch "#{root}/abc/2"
        FileUtils.touch "#{root}/abc/important.txt"
      }

      subject {
        PathSpec.new(gitignore).match_tree(root)
      }

      it { is_expected.to include "#{root}/abc".to_s }
      it { is_expected.to include "#{root}/abc/1".to_s }
      it { is_expected.not_to include "#{root}/abc/important.txt".to_s }
      it { is_expected.not_to include root.to_s.to_s }
    end

    context 'windows' do
      let(:root) {'C:/project'}
      let(:gitignore) {
        <<-GITIGNORE
  !**/important.txt
  abc/**
  GITIGNORE
      }

      before(:each) {
        FileUtils.mkdir_p root
        FileUtils.mkdir_p "#{root}/abc"
        FileUtils.touch "#{root}/abc/1"
        FileUtils.touch "#{root}/abc/2"
        FileUtils.touch "#{root}/abc/important.txt"
      }

      subject {
        PathSpec.new(gitignore).match_tree(root)
      }

      it { is_expected.to include "#{root}/abc".to_s }
      it { is_expected.to include "#{root}/abc/1".to_s }
      it { is_expected.not_to include "#{root}/abc/important.txt".to_s }
      it { is_expected.not_to include root.to_s.to_s }
    end
  end

  context '#match_paths' do
    let(:gitignore) {
      <<-GITIGNORE
!**/important.txt
/abc/**
GITIGNORE
    }

    context 'with no root arg' do
      subject { PathSpec.new(gitignore).match_paths(['/abc/important.txt', '/abc/', '/abc/1']) }

      it { is_expected.to include '/abc/' }
      it { is_expected.to include '/abc/1' }
      it { is_expected.not_to include '/abc/important.txt' }
    end

    context 'relative to non-root dir' do
      subject {
        PathSpec.new(gitignore).match_paths([
                                              '/def/abc/important.txt',
                                              '/def/abc/',
                                              '/def/abc/1'
                                            ], '/def') }

      it { is_expected.to include '/def/abc/' }
      it { is_expected.to include '/def/abc/1' }
      it { is_expected.not_to include '/def/abc/important.txt' }
    end

    context 'relative to windows drive letter' do
      subject {
        PathSpec.new(gitignore).match_paths([
                                              'C:/def/abc/important.txt',
                                              'C:/def/abc/',
                                              'C:/def/abc/1'
                                            ], 'C:/def/') }

      it { is_expected.to include 'C:/def/abc/' }
      it { is_expected.to include 'C:/def/abc/1' }
      it { is_expected.not_to include 'C:/def/abc/important.txt' }
    end
  end

  # Example to exclude everything except a specific directory foo/bar (note
  # the /* - without the slash, the wildcard would also exclude everything
  # within foo/bar): (from git-scm.com)
  context 'very specific gitignore' do
    let(:gitignore) {
      <<-GITIGNORE
# exclude everything except directory foo/bar
/*
!/foo
/foo/*
!/foo/bar
GITIGNORE
    }

    subject { PathSpec.new(gitignore) }

    it { is_expected.not_to match('foo/bar') }
    it { is_expected.to match('anything') }
    it { is_expected.to match('foo/otherthing') }
  end

  context '#empty' do
    let(:gitignore) {
      <<-GITIGNORE
# A comment
GITIGNORE
    }

    subject { PathSpec.new gitignore }

    it 'is empty when there are no valid lines' do
      expect(subject.empty?).to be true
    end
  end

  context 'regex file' do
    let(:regexfile) {
      <<-REGEX
ab*a
REGEX
    }

    subject { PathSpec.new regexfile, :regex}

    it 'matches the regex' do
      expect(subject.match('anna')).to be false
      expect(subject.match('abba')).to be true
    end

    context '#from_filename' do
      it 'forwards the type argument' do
        io = double

        expect(File).to receive(:open).and_yield(io)
        expect(PathSpec).to receive(:from_lines).with(io, :regex)

        PathSpec.from_filename '/some/file', :regex
      end

      it 'reads a simple regex file' do
        spec = PathSpec.from_filename 'spec/files/regex_simple', :regex

        expect(spec.match('artifact.md')).to be true
        expect(spec.match('code.rb')).to be false
      end

      it 'reads a simple gitignore file' do
        spec = PathSpec.from_filename 'spec/files/gitignore_simple', :git

        expect(spec.match('artifact.md')).to be true
        expect(spec.match('code.rb')).to be false
      end

      it 'reads an example ruby gitignore file' do
        spec = PathSpec.from_filename 'spec/files/gitignore_ruby', :git

        expect(spec.match('coverage/')).to be true
        expect(spec.match('coverage/index.html')).to be true
        expect(spec.match('pathspec-0.0.1.gem')).to be true
        expect(spec.match('lib/pathspec')).to be false
        expect(spec.match('Gemfile')).to be false
      end
    end
  end

  context 'unsuppored spec type' do
    let(:file) {
      <<-REGEX
This is some kind of nonsense.
REGEX
    }

    it 'does not allow an unknown spec type' do
      expect { PathSpec.new file, :foo}.to raise_error(/Unknown/)
    end
  end
end