dir_glob_ignore 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c187778eb8d46752513894cbd924cecad89e7127
4
+ data.tar.gz: 5bbf53c5e6cc6052032e07c8e518d0c5e53e6995
5
+ SHA512:
6
+ metadata.gz: e98faea1ee9df484070a00f6304dac1e32e9cbe7fa8413b045a2c71133d9612a88df4d25890dcbdb191e947f33aded068efb7bf4ab098600451cf845d97534b5
7
+ data.tar.gz: b7b130a4a385a030b947862ba6c27f53ae7d9e45cd3d5bc7b1f00c7bf4d73b78fd55324b1420ba5797dddd4f887709d56b8c8e73e8fd3e4e50531728817adefc
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ /.idea/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.4
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at lbnetid+gh@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in dir_glob_ignore.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Laurent B.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,48 @@
1
+ # DirGlobIgnore
2
+
3
+ Enable file globbing with a-la-git ignore files management.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'dir_glob_ignore'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install dir_glob_ignore
20
+
21
+ ## Usage
22
+
23
+ Once required this gem patches the `Dir` Ruby core class by adding a new method `glob_with_ignore_file`
24
+ which allows to specify _a-la-git_ ignore files
25
+
26
+ Like with Git, there can be multiple ignore files in sub-directories
27
+
28
+ ```ruby
29
+ require 'dir_glob_ignore'
30
+
31
+ Dir.glob_with_ignore_file '.my_ignore_file', '/a/root/directory', *standard_glob_options
32
+ ```
33
+
34
+ * The first parameter specifies the name of the ignore files to look for.
35
+ * The second parameter specifies a root directory for ignore files. This is not a root directory
36
+ for the glob function but actually defines where to search ignore files.
37
+ * Then the remaining parameters are identical to the ones you could pass to `Dir::glob`
38
+
39
+
40
+ ## Contributing
41
+
42
+ Bug reports and pull requests are welcome on GitHub at https://github.com/lbriais/dir_glob_ignore. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
43
+
44
+
45
+ ## License
46
+
47
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
48
+
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'dir_glob_ignore'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'dir_glob_ignore/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'dir_glob_ignore'
8
+ spec.version = DirGlobIgnore::VERSION
9
+ spec.authors = ['Laurent B.']
10
+ spec.email = ['lbnetid+gh@gmail.com']
11
+
12
+ spec.summary = %q{An extension to Ruby Dir.glob with filtering options.}
13
+ spec.description = %q{An extension to Ruby Dir.glob with git-like "ignore" files.}
14
+ spec.homepage = 'https://github.com/lbriais/dir_glob_ignore.git'
15
+ spec.license = 'MIT'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = 'exe'
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ['lib']
21
+
22
+ spec.add_development_dependency 'bundler', '~> 1.11'
23
+ spec.add_development_dependency 'rake', '~> 10.0'
24
+ spec.add_development_dependency 'rspec', '~> 3.0'
25
+ end
@@ -0,0 +1,7 @@
1
+ require 'dir_glob_ignore/version'
2
+ require 'dir_glob_ignore/ignore_file_list'
3
+ require 'dir_glob_ignore/dir_patch'
4
+
5
+ module DirGlobIgnore
6
+ # Your code goes here...
7
+ end
@@ -0,0 +1,17 @@
1
+ class Dir
2
+
3
+ def self.glob_with_ignore_file(ignore_file, base_dir, *glob_args, &block)
4
+ filter = DirGlobIgnore::IgnoreFileList.new base_dir
5
+ filter.ignore_file_name =ignore_file
6
+ filter.load_ignore_files
7
+ Dir.glob(*glob_args).reject do |file|
8
+ if filter.ignore_list.include? File.expand_path(file)
9
+ true
10
+ else
11
+ yield file if block_given?
12
+ false
13
+ end
14
+ end
15
+ end
16
+
17
+ end
@@ -0,0 +1,66 @@
1
+ module DirGlobIgnore
2
+
3
+ class IgnoreFileList
4
+
5
+ DEFAULT_FILE_NAME = '.ignore'.freeze
6
+
7
+ attr_writer :ignore_file_name, :base_dir
8
+ attr_reader :ignore_list
9
+
10
+ def initialize(base_dir = nil)
11
+ self.base_dir = base_dir
12
+ end
13
+
14
+ def ignore_file_name
15
+ @ignore_file_name ||= DEFAULT_FILE_NAME
16
+ end
17
+
18
+ def base_dir
19
+ @base_dir ||= Dir.pwd
20
+ end
21
+
22
+ def load_ignore_files
23
+ @cache = {}
24
+ ignore_files.each do |ignore_file|
25
+ cache[File.expand_path File.dirname ignore_file] = load_ignore_file ignore_file
26
+ end
27
+ build_ignore_list
28
+ end
29
+
30
+ private
31
+
32
+ attr_reader :cache
33
+
34
+ def build_ignore_list
35
+ ignore_list = []
36
+ cache.each do |dir, patterns|
37
+ patterns.each do |pattern|
38
+ ignore_list.concat Dir.glob(File.join(dir, pattern), File::FNM_DOTMATCH)
39
+ end
40
+ end
41
+ @ignore_list = ignore_list.sort.uniq
42
+ end
43
+
44
+ def load_ignore_file(ignore_file)
45
+ File.readlines(ignore_file).map(&:chomp).reject do |entry|
46
+ if entry =~ /^\s*#/
47
+ # Ignore commented lines
48
+ true
49
+ elsif entry =~ /^\s*$/
50
+ # Ignore empty lines
51
+ true
52
+ else
53
+ false
54
+ end
55
+ end
56
+ end
57
+
58
+ def ignore_files
59
+ file_pattern = File.join base_dir, '**', ignore_file_name
60
+ Dir.glob file_pattern
61
+ end
62
+
63
+
64
+ end
65
+
66
+ end
@@ -0,0 +1,3 @@
1
+ module DirGlobIgnore
2
+ VERSION = '0.1.0'.freeze
3
+ end
metadata ADDED
@@ -0,0 +1,101 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dir_glob_ignore
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Laurent B.
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-12-29 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: An extension to Ruby Dir.glob with git-like "ignore" files.
56
+ email:
57
+ - lbnetid+gh@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - dir_glob_ignore.gemspec
73
+ - lib/dir_glob_ignore.rb
74
+ - lib/dir_glob_ignore/dir_patch.rb
75
+ - lib/dir_glob_ignore/ignore_file_list.rb
76
+ - lib/dir_glob_ignore/version.rb
77
+ homepage: https://github.com/lbriais/dir_glob_ignore.git
78
+ licenses:
79
+ - MIT
80
+ metadata: {}
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubyforge_project:
97
+ rubygems_version: 2.5.1
98
+ signing_key:
99
+ specification_version: 4
100
+ summary: An extension to Ruby Dir.glob with filtering options.
101
+ test_files: []