buff-ignore 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/.travis.yml +7 -0
- data/Gemfile +16 -0
- data/Guardfile +25 -0
- data/LICENSE +201 -0
- data/README.md +84 -0
- data/Rakefile +21 -0
- data/buff-ignore.gemspec +26 -0
- data/lib/buff/ignore.rb +8 -0
- data/lib/buff/ignore/errors.rb +18 -0
- data/lib/buff/ignore/ignore_file.rb +81 -0
- data/lib/buff/ignore/version.rb +6 -0
- data/spec/lib/errors_spec.rb +22 -0
- data/spec/lib/ignore_file_spec.rb +74 -0
- data/spec/spec_helper.rb +26 -0
- data/spec/support/path_helpers.rb +26 -0
- metadata +148 -0
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
source 'https://rubygems.org'
|
2
|
+
gemspec
|
3
|
+
|
4
|
+
group :workstation do
|
5
|
+
gem 'fuubar', '~> 1.1'
|
6
|
+
|
7
|
+
gem 'guard', '~> 1.8'
|
8
|
+
gem 'guard-cane', '~> 0.1'
|
9
|
+
gem 'guard-bundler', '~> 1.0'
|
10
|
+
gem 'guard-rspec', '~> 3.0'
|
11
|
+
gem 'guard-spork', '~> 1.5'
|
12
|
+
gem 'guard-yard', '~> 2.1'
|
13
|
+
|
14
|
+
gem 'yard', '~> 0.8'
|
15
|
+
gem 'redcarpet', '~> 2.3'
|
16
|
+
end
|
data/Guardfile
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
guard :bundler do
|
2
|
+
watch('Gemfile')
|
3
|
+
watch('Gemfile.lock')
|
4
|
+
watch(%r{^.+\.gemspec})
|
5
|
+
end
|
6
|
+
|
7
|
+
guard :cane do
|
8
|
+
watch(%r{^lib/(.+)\.rb$})
|
9
|
+
end
|
10
|
+
|
11
|
+
guard :rspec, cli: '--color --drb --format Fuubar' do
|
12
|
+
watch(%r{^spec/.+_spec\.rb$})
|
13
|
+
watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
|
14
|
+
watch('spec/spec_helper.rb') { 'spec' }
|
15
|
+
end
|
16
|
+
|
17
|
+
guard :spork do
|
18
|
+
watch('Gemfile')
|
19
|
+
watch('Gemfile.lock')
|
20
|
+
watch('spec/spec_helper.rb') { :rspec }
|
21
|
+
end
|
22
|
+
|
23
|
+
guard :yard do
|
24
|
+
watch(%r{lib/.+\.rb})
|
25
|
+
end
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright 2013 Seth Vargo <sethvargo@gmail.com>
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
Buff Ignore
|
2
|
+
===========
|
3
|
+
[![Gem Version](https://badge.fury.io/rb/buff-ignore.png)](http://badge.fury.io/rb/buff-ignore)
|
4
|
+
[![Build Status](https://travis-ci.org/sethvargo/buff-ignore.png)](https://travis-ci.org/sethvargo/buff-ignore)
|
5
|
+
[![Dependency Status](https://gemnasium.com/sethvargo/buff-ignore.png)](https://gemnasium.com/sethvargo/buff-ignore)
|
6
|
+
[![Code Climate](https://codeclimate.com/github/sethvargo/buff-ignore.png)](https://codeclimate.com/github/sethvargo/buff-ignore)
|
7
|
+
|
8
|
+
Buff::Ignore is a Ruby helper library for parsing and managing an ignore file (such as a `.gitignore` or `chefignore`). It uses [`File#fnmatch`](http://www.ruby-doc.org/core-2.0/File.html#method-c-fnmatch). It includes helpful methods for apply ignores to a file list.
|
9
|
+
|
10
|
+
|
11
|
+
Installation
|
12
|
+
------------
|
13
|
+
Add buff-ignore to your `Gemfile`:
|
14
|
+
|
15
|
+
```Gemfile
|
16
|
+
gem 'buff-ignore'
|
17
|
+
```
|
18
|
+
|
19
|
+
And then execute the `bundle` command to install:
|
20
|
+
|
21
|
+
$ bundle
|
22
|
+
|
23
|
+
Or install buff-ignore directly:
|
24
|
+
|
25
|
+
$ gem install buff-ignore
|
26
|
+
|
27
|
+
|
28
|
+
Usage
|
29
|
+
-----
|
30
|
+
Buff::Ignore is designed to be used as a library. First, you must require it:
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
require 'buff/ignore'
|
34
|
+
```
|
35
|
+
|
36
|
+
Next, create an instance of an ignore file:
|
37
|
+
|
38
|
+
```ruby
|
39
|
+
ignore = Buff::Ignore::IgnoreFile.new('/path/to/ignore/file')
|
40
|
+
```
|
41
|
+
|
42
|
+
*(If the file does not exist, an exception will be raised)*
|
43
|
+
|
44
|
+
Finally, apply the `ignore` to a list of files:
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
list = Dir['**/*']
|
48
|
+
result = ignore.apply(list)
|
49
|
+
```
|
50
|
+
|
51
|
+
You can also destructively apply changes. This will modify the receiving argument `list`:
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
ignore.apply!(list)
|
55
|
+
```
|
56
|
+
|
57
|
+
Contributing
|
58
|
+
------------
|
59
|
+
1. Fork it
|
60
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
61
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
62
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
63
|
+
5. Create new Pull Request
|
64
|
+
|
65
|
+
|
66
|
+
License & Authors
|
67
|
+
-----------------
|
68
|
+
- Author: Seth Vargo (sethvargo@gmail.com)
|
69
|
+
|
70
|
+
```text
|
71
|
+
Copyright 2013 Seth Vargo <sethvargo@gmail.com>
|
72
|
+
|
73
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
74
|
+
you may not use this file except in compliance with the License.
|
75
|
+
You may obtain a copy of the License at
|
76
|
+
|
77
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
78
|
+
|
79
|
+
Unless required by applicable law or agreed to in writing, software
|
80
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
81
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
82
|
+
See the License for the specific language governing permissions and
|
83
|
+
limitations under the License.
|
84
|
+
```
|
data/Rakefile
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
require 'bundler/gem_tasks'
|
2
|
+
|
3
|
+
require 'rspec/core/rake_task'
|
4
|
+
require 'cane/rake_task'
|
5
|
+
|
6
|
+
namespace :test do
|
7
|
+
desc 'Run quality tests'
|
8
|
+
Cane::RakeTask.new(:quality)
|
9
|
+
|
10
|
+
desc 'Run unit tests'
|
11
|
+
RSpec::Core::RakeTask.new(:unit) do |t|
|
12
|
+
t.rspec_opts = '--color --format documentation'
|
13
|
+
end
|
14
|
+
|
15
|
+
task :all => [:quality, :unit]
|
16
|
+
end
|
17
|
+
|
18
|
+
desc 'Run all tests'
|
19
|
+
task :test => 'test:all'
|
20
|
+
|
21
|
+
task :default => :test
|
data/buff-ignore.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'buff/ignore/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'buff-ignore'
|
8
|
+
spec.version = '1.0.0'
|
9
|
+
spec.authors = ['Seth Vargo']
|
10
|
+
spec.email = ['sethvargo@gmail.com']
|
11
|
+
spec.description = 'Parse ignore files with Ruby'
|
12
|
+
spec.summary = 'A Ruby library for parsing lists of files and applying pattern matching exclusion (such as .gitignore)'
|
13
|
+
spec.homepage = 'https://github.com/sethvargo/buff-ignore'
|
14
|
+
spec.license = 'Apache 2.0'
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.add_development_dependency 'bundler', '~> 1.3'
|
22
|
+
spec.add_development_dependency 'cane', '~> 2.6'
|
23
|
+
spec.add_development_dependency 'rake'
|
24
|
+
spec.add_development_dependency 'rspec', '~> 2.13'
|
25
|
+
spec.add_development_dependency 'spork', '~> 0.9'
|
26
|
+
end
|
data/lib/buff/ignore.rb
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
module Buff::Ignore
|
2
|
+
# @abstract Exceptions from Buff::Ignore
|
3
|
+
class BuffIgnoreError < StandardError; end
|
4
|
+
|
5
|
+
# Raised when an ignore file cannot be found
|
6
|
+
class IgnoreFileNotFound < BuffIgnoreError
|
7
|
+
# @param [String] path
|
8
|
+
# the path where the ignore file was not found
|
9
|
+
def initialize(path)
|
10
|
+
@path = File.expand_path(path)
|
11
|
+
end
|
12
|
+
|
13
|
+
# @return [String]
|
14
|
+
def message
|
15
|
+
"No ignore file found at '#{@path}'!"
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
module Buff
|
2
|
+
module Ignore
|
3
|
+
# A Ruby representation of an ignore file
|
4
|
+
class IgnoreFile
|
5
|
+
# Regular expression to match comments or plain whitespace
|
6
|
+
#
|
7
|
+
# @return [Regexp]
|
8
|
+
COMMENT_OR_WHITESPACE = /^\s*(?:#.*)?$/.freeze
|
9
|
+
|
10
|
+
# The path to the ignore file
|
11
|
+
#
|
12
|
+
# @return [String]
|
13
|
+
attr_reader :filepath
|
14
|
+
|
15
|
+
# Create a new ignore file from the given filepath
|
16
|
+
#
|
17
|
+
# @raise [IgnoreFileNotFound]
|
18
|
+
# if the given filepath does not exist
|
19
|
+
#
|
20
|
+
# @param [#to_s] filepath
|
21
|
+
# the path to the ignore file
|
22
|
+
def initialize(filepath)
|
23
|
+
@filepath = File.expand_path(filepath.to_s)
|
24
|
+
raise IgnoreFileNotFound.new(filepath) unless File.exists?(filepath)
|
25
|
+
end
|
26
|
+
|
27
|
+
# Apply the ignore to the list, returning a new list of filtered files
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
# files = ['Gemfile', 'Gemfile.lock', 'bacon', 'eggs']
|
31
|
+
# ignore.apply(files) #=> ['bacon', 'eggs']
|
32
|
+
#
|
33
|
+
# @see IgnoreFile#apply!
|
34
|
+
#
|
35
|
+
# @param [Array] list
|
36
|
+
# the list of files to apply the ignore to
|
37
|
+
#
|
38
|
+
# @return [Array]
|
39
|
+
# the sanitized file list
|
40
|
+
def apply(list)
|
41
|
+
tmp = list.dup
|
42
|
+
apply!(tmp)
|
43
|
+
tmp
|
44
|
+
end
|
45
|
+
|
46
|
+
# Destructively remove all files from the given list
|
47
|
+
#
|
48
|
+
# @param [Array] list
|
49
|
+
# the list of files to apply the ignore to
|
50
|
+
#
|
51
|
+
# @return [Array, nil]
|
52
|
+
# the elements removed, or nil if none were removed
|
53
|
+
def apply!(list)
|
54
|
+
list.reject! do |item|
|
55
|
+
item.strip.empty? || ignored?(item)
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
private
|
60
|
+
# The parsed contents of the ignore file
|
61
|
+
#
|
62
|
+
# @return [Array]
|
63
|
+
def ignores
|
64
|
+
@ignores ||= File.readlines(filepath).reject do |line|
|
65
|
+
line.strip.empty? || line.strip =~ COMMENT_OR_WHITESPACE
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
# Helper boolean to determine if a given filename should be ignored
|
70
|
+
#
|
71
|
+
# @param [String] filename
|
72
|
+
# the file to match
|
73
|
+
#
|
74
|
+
# @return [Boolean]
|
75
|
+
# true if the file should be ignored, false otherwise
|
76
|
+
def ignored?(filename)
|
77
|
+
ignores.any? { |ignore| File.fnmatch?(ignore, filename) }
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe Buff::Ignore::BuffIgnoreError do
|
4
|
+
it 'inherits from StandardError' do
|
5
|
+
expect(subject).to be_a(StandardError)
|
6
|
+
end
|
7
|
+
end
|
8
|
+
|
9
|
+
describe Buff::Ignore::IgnoreFileNotFound do
|
10
|
+
let(:path) { '/path/to/file' }
|
11
|
+
subject { described_class.new(path) }
|
12
|
+
|
13
|
+
it 'accepts a filepath as the parameter' do
|
14
|
+
expect {
|
15
|
+
described_class.new(path)
|
16
|
+
}.to_not raise_error
|
17
|
+
end
|
18
|
+
|
19
|
+
it 'has the correct message' do
|
20
|
+
expect(subject.message).to eq("No ignore file found at '#{path}'!")
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,74 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe Buff::Ignore::IgnoreFile do
|
4
|
+
let(:ignores) { %w(Gemfile *.lock bacon) }
|
5
|
+
let(:path) { '~/fakepath' }
|
6
|
+
|
7
|
+
before do
|
8
|
+
File.stub(:exists?).with(path).and_return(true)
|
9
|
+
File.stub(:readlines).and_return(ignores)
|
10
|
+
end
|
11
|
+
|
12
|
+
subject { described_class.new(path) }
|
13
|
+
|
14
|
+
describe '.initialize' do
|
15
|
+
context 'when the filepath does not exist' do
|
16
|
+
before { File.stub(:exists?).and_return(false) }
|
17
|
+
|
18
|
+
it 'raises an exception' do
|
19
|
+
expect {
|
20
|
+
described_class.new('/lol/wtf?/really/no.rb')
|
21
|
+
}.to raise_error(Buff::Ignore::IgnoreFileNotFound)
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
context 'when the file exists' do
|
26
|
+
subject { described_class.new(path) }
|
27
|
+
|
28
|
+
it 'sets the filepath instance variable to the expanded path' do
|
29
|
+
filepath = subject.instance_variable_get(:@filepath)
|
30
|
+
expect(filepath).to eq(File.expand_path(path))
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
describe '#apply' do
|
36
|
+
let(:list) { ['Gemfile', 'Gemfile.lock', 'bacon', 'eggs'] }
|
37
|
+
|
38
|
+
it 'leaves the original array unmodified' do
|
39
|
+
original = list.dup
|
40
|
+
subject.apply(list)
|
41
|
+
expect(list).to eq(original)
|
42
|
+
end
|
43
|
+
|
44
|
+
it 'delegates to #apply!' do
|
45
|
+
subject.should_receive(:apply!).with(list).once
|
46
|
+
subject.apply(list)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
describe '#apply!' do
|
51
|
+
let(:list) { ['Gemfile', 'Gemfile.lock', 'bacon', 'eggs'] }
|
52
|
+
|
53
|
+
it 'removes standard files' do
|
54
|
+
subject.apply!(list)
|
55
|
+
expect(list).to_not include('Gemfile')
|
56
|
+
expect(list).to_not include('bacon')
|
57
|
+
end
|
58
|
+
|
59
|
+
it 'removes the globs' do
|
60
|
+
subject.apply!(list)
|
61
|
+
expect(list).to_not include('Gemfile.lock')
|
62
|
+
end
|
63
|
+
|
64
|
+
it 'does not remove a non-matching pattern' do
|
65
|
+
subject.apply!(list)
|
66
|
+
expect(list).to include('eggs')
|
67
|
+
end
|
68
|
+
|
69
|
+
it 'returns nil if nothing was removed' do
|
70
|
+
result = subject.apply!([])
|
71
|
+
expect(result).to be_nil
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
require 'bundler/setup'
|
2
|
+
require 'spork'
|
3
|
+
|
4
|
+
Spork.prefork do
|
5
|
+
require 'rspec'
|
6
|
+
|
7
|
+
# Require all supporting libraries
|
8
|
+
Dir['spec/support/**/*.rb'].each { |f| require File.expand_path(f) }
|
9
|
+
|
10
|
+
# RSpec configuration
|
11
|
+
RSpec.configure do |config|
|
12
|
+
config.include Buff::Ignore::RSpec::PathHelpers
|
13
|
+
|
14
|
+
config.expect_with(:rspec) { |c| c.syntax = :expect }
|
15
|
+
config.mock_with(:rspec)
|
16
|
+
config.treat_symbols_as_metadata_keys_with_true_values = true
|
17
|
+
config.filter_run(focus: true)
|
18
|
+
config.run_all_when_everything_filtered = true
|
19
|
+
|
20
|
+
config.before(:each) { clean_tmp_path! }
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
Spork.each_run do
|
25
|
+
require 'buff/ignore'
|
26
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
module Buff::Ignore
|
2
|
+
module RSpec
|
3
|
+
module PathHelpers
|
4
|
+
# The tmp path where testing support/workspaces are
|
5
|
+
#
|
6
|
+
# @return [Pathname]
|
7
|
+
def tmp_path
|
8
|
+
@_tmp_path ||= app_root.join('tmp').expand_path
|
9
|
+
end
|
10
|
+
|
11
|
+
private
|
12
|
+
# The "root" of berkshelf
|
13
|
+
#
|
14
|
+
# @return [Pathname]
|
15
|
+
def app_root
|
16
|
+
@_app_root ||= Pathname.new(File.expand_path('../../..', __FILE__))
|
17
|
+
end
|
18
|
+
|
19
|
+
# Clean the temporary directories
|
20
|
+
def clean_tmp_path!
|
21
|
+
FileUtils.rm_rf(tmp_path)
|
22
|
+
FileUtils.mkdir_p(tmp_path)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,148 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: buff-ignore
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Seth Vargo
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-06-30 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.3'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.3'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: cane
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ~>
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '2.6'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '2.6'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: rake
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: rspec
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ~>
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '2.13'
|
70
|
+
type: :development
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ~>
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '2.13'
|
78
|
+
- !ruby/object:Gem::Dependency
|
79
|
+
name: spork
|
80
|
+
requirement: !ruby/object:Gem::Requirement
|
81
|
+
none: false
|
82
|
+
requirements:
|
83
|
+
- - ~>
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0.9'
|
86
|
+
type: :development
|
87
|
+
prerelease: false
|
88
|
+
version_requirements: !ruby/object:Gem::Requirement
|
89
|
+
none: false
|
90
|
+
requirements:
|
91
|
+
- - ~>
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: '0.9'
|
94
|
+
description: Parse ignore files with Ruby
|
95
|
+
email:
|
96
|
+
- sethvargo@gmail.com
|
97
|
+
executables: []
|
98
|
+
extensions: []
|
99
|
+
extra_rdoc_files: []
|
100
|
+
files:
|
101
|
+
- .gitignore
|
102
|
+
- .travis.yml
|
103
|
+
- Gemfile
|
104
|
+
- Guardfile
|
105
|
+
- LICENSE
|
106
|
+
- README.md
|
107
|
+
- Rakefile
|
108
|
+
- buff-ignore.gemspec
|
109
|
+
- lib/buff/ignore.rb
|
110
|
+
- lib/buff/ignore/errors.rb
|
111
|
+
- lib/buff/ignore/ignore_file.rb
|
112
|
+
- lib/buff/ignore/version.rb
|
113
|
+
- spec/lib/errors_spec.rb
|
114
|
+
- spec/lib/ignore_file_spec.rb
|
115
|
+
- spec/spec_helper.rb
|
116
|
+
- spec/support/path_helpers.rb
|
117
|
+
homepage: https://github.com/sethvargo/buff-ignore
|
118
|
+
licenses:
|
119
|
+
- Apache 2.0
|
120
|
+
post_install_message:
|
121
|
+
rdoc_options: []
|
122
|
+
require_paths:
|
123
|
+
- lib
|
124
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
125
|
+
none: false
|
126
|
+
requirements:
|
127
|
+
- - ! '>='
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: '0'
|
130
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
131
|
+
none: false
|
132
|
+
requirements:
|
133
|
+
- - ! '>='
|
134
|
+
- !ruby/object:Gem::Version
|
135
|
+
version: '0'
|
136
|
+
requirements: []
|
137
|
+
rubyforge_project:
|
138
|
+
rubygems_version: 1.8.23
|
139
|
+
signing_key:
|
140
|
+
specification_version: 3
|
141
|
+
summary: A Ruby library for parsing lists of files and applying pattern matching exclusion
|
142
|
+
(such as .gitignore)
|
143
|
+
test_files:
|
144
|
+
- spec/lib/errors_spec.rb
|
145
|
+
- spec/lib/ignore_file_spec.rb
|
146
|
+
- spec/spec_helper.rb
|
147
|
+
- spec/support/path_helpers.rb
|
148
|
+
has_rdoc:
|