https://github.com/ruby/find
This module supports top-down traversal of a set of file paths
https://github.com/ruby/find
ruby
Last synced: about 1 year ago
JSON representation
This module supports top-down traversal of a set of file paths
- Host: GitHub
- URL: https://github.com/ruby/find
- Owner: ruby
- License: other
- Created: 2020-05-22T11:09:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T02:06:45.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T03:56:36.102Z (about 1 year ago)
- Topics: ruby
- Language: Ruby
- Homepage:
- Size: 85 KB
- Stars: 16
- Watchers: 31
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Find
The +Find+ module supports the top-down traversal of a set of file paths.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'find'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install find
## Usage
For example, to total the size of all files under your home directory,
ignoring anything in a "dot" directory (e.g. $HOME/.ssh):
```ruby
require 'find'
total_size = 0
Find.find(ENV["HOME"]) do |path|
if FileTest.directory?(path)
if File.basename(path).start_with?('.')
Find.prune # Don't look any further into this directory.
else
next
end
else
total_size += FileTest.size(path)
end
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/find.