RequireSmasher

Leia esta documentação em Português do Brasil.

This project was born just to solve a problem: require ruby files recursively in a directory. However it grew up and learned to solve other simple problems:

require ruby files recursively in a directory and its sub-directories, trying to resolve interdependent files (require_dir)
require ruby files recursively in a list of directories and their sub-directories, trying to resolve interdependent files (require_dirs)
require a gem (require_gem)
require a list of gems (require_gems)
require a ruby file (require_file)
require a list of ruby files (require_files)
require a list of gems, ruby files in a list of directories and their sub-directories and a list of files with just one command (require_all)

Installation

Add this line to your application's Gemfile:

gem 'require_smasher'

And then execute:

$ bundle

Or install it yourself as:

$ gem install require_smasher

Usage

Require All

require_all 'directory_1', 'directory_2/sub-directory', 'gem_1', 'gem_2', 'directory_3/filename_1', 'filename_2'

This command will require all ruby files found in directory directory_1 and its sub-directories, all ruby files in directory directory_2/sub-directory and in its sub-directories, gem gem_1 and gem gem_2, and files directory_3/filename_1.rb and filename_2.rb.

Note: the order of elements is not important, because Require Smasher will try to resolve any dependences among them.

Require Dir

require_dir 'directory_1'

This command will require all ruby files found in directory directory_1 and in its sub-directories.

Require Dirs

require_dirs 'directory_1', 'directory_2/sub-directory'

This command accept a list of directories and it will require all ruby files found in directory directory_1 and in its sub-directories, all ruby files in directory directory_2/sub-directory and in its sub-directories.

Require Gem

require_gem 'gem'

This command will require the informed gem.

Require Gems

require_gems 'gem_1', 'gem_2'

This command accept a list of gems and it will require gems gem_1 and gem_2.

Require File

require_file 'filename'

This command will require the file filename.rb. You don't have to inform Ruby extension file (rb), if you want.

Require Files

require_files 'filename_1', 'directory/filename_2', 'directory/filename_3.rb'

This command accept a list of files and it will require files filename_1.rb, directory/filename_2.rb and directory/filename_3.rb. You don't have to inform Ruby extension file (rb), if you want.

Development

Locally

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Using Docker and Docker Compose

You can develop this gem without many installation tools or library using Docker and Docker Compose features. So, install Docker, Docker Compose and follow the next steps.

1 - Build docker containers

docker-compose build

2 - Ingress on app container

docker-compose run --rm app sh

3 - Execute tests: Outside docker container

docker-compose run --rm app bundle exec rspec

Inside docker container

bundle exec rspec

4 - Execute Code Analizer Outside docker container

docker-compose run --rm app bundle exec rubocop

Inside docker container

bundle exec rubocop

More information about stop, start, restart, run containers and so on, read Docker Compose Documentation and Docker Documentation.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jrjoacir/require-smasher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the RequireSmasher project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.