- 3.1 (Stable, Tested)
- 3.2 (Stable, Tested)
- 3.3 (Stable, Tested)
Match Path Specifications, such as .gitignore, in Ruby!
Follows .gitignore syntax defined on gitscm
.gitignore functionality ported from Python pathspec by @cpburnz
gem install pathspec
➜ cat .gitignore
*.swp
/coverage/
➜ bundle exec pathspec-rb specs_match "coverage/foo"
/coverage/
➜ bundle exec pathspec-rb specs_match "file.swp"
*.swp
➜ bundle exec pathspec-rb match "file.swp"
➜ echo $?
0
➜ ls
Gemfile Gemfile.lock coverage file.swp source.rb
➜ bundle exec pathspec-rb tree .
./coverage
./coverage/index.html
./file.swp
require 'pathspec'
# Create a .gitignore-style Pathspec by giving it newline separated gitignore
# lines, an array of gitignore lines, or any other enumable object that will
# give strings matching the .gitignore-style (File, etc.)
gitignore = PathSpec.from_filename('spec/files/gitignore_readme')
# Our .gitignore in this example contains:
# !**/important.txt
# abc/**
# true, matches "abc/**"
gitignore.match 'abc/def.rb'
# CLI equivalent: pathspec.rb -f spec/files/gitignore_readme match 'abc/def.rb'
# false, because it has been negated using the line "!**/important.txt"
gitignore.match 'abc/important.txt'
# CLI equivalent: pathspec.rb -f spec/files/gitignore_readme match 'abc/important.txt'
# Give a path somewhere in the filesystem, and the Pathspec will return all
# matching files underneath.
# Returns ['/src/repo/abc/', '/src/repo/abc/123']
gitignore.match_tree '/src/repo'
# CLI equivalent: pathspec.rb -f spec/files/gitignore_readme tree /src/repo
# Give an enumerable of paths, and Pathspec will return the ones that match.
# Returns ['/abc/123', '/abc/']
gitignore.match_paths ['/abc/123', '/abc/important.txt', '/abc/']
# There is no CLI equivalent to this.
lib = File.expand_path("lib", __dir__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "gemspec_pathspec_test/version"
require 'pathspec'
Gem::Specification.new do |spec|
spec.name = "gemspec_pathspec_test"
spec.version = GemspecPathspecTest::VERSION
spec.authors = ["Brandon High"]
spec.email = ["highb@users.noreply.github.com"]
spec.summary = "whatever"
spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
ps = PathSpec.from_filename('.gitignore')
spec.files = Dir['lib/*.rb'].reject { |f| ps.match(f) }
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]
spec.add_development_dependency "bundler", "~> 2.0"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "rspec", "~> 3.0"
end
git clone git@github.com:highb/pathspec-ruby.git
cd pathspec-ruby && bash ./build_from_source.sh
Pull requests, bug reports, and feature requests welcome! 😄 I've tried to write exhaustive tests but who knows what cases I've missed.
This is mainly a reminder to myself but the release process is:
- Make sure CI is passing
- Update the CHANGELOG with relevant changes to Gem consumers
- Update version in gemspec with correct SemVer bump for scope of changes
- Tag/release using GitHub UI and the Build & Push workflow should do the rest.