Rake Tasks are cumbersome. They are often written as one-offs, then have to wait for CI/CD before deploying, and finally being able to run your code through terminal access. After all of that- the task itself is rarely deleted after running, leaving stale code that litters your code base. Sometimes it's useful to be able to find these tasks again for future reference, but digging through version control isn't ideal. This process leaves a lot to be desired. It has very low visibility and is not easy to audit or verify.
This CommandProposal gem offers a solution: A mountable Rails Engine that provides a UI for devs to enter their task, get it approved by another developer, and then run. Results are stored and can be used for future reference to see that the task was executed as expected. It can always be run again if need be and each iteration will store the code as it was and the results it gave.
Requiring approval from another member of the team allows the code to still go through a review process. This also encourages pairing on the code to make sure it's safe to run against a production environment.
Add this line to your application's Gemfile:
gem 'command_proposal'And then execute:
$ bundle install
Or install it yourself as:
$ gem install command_proposal
Install and run the migrations:
rails generate command_proposal:install
rails db:migrate
Include assets:
# In application.js
//= require command_proposal
# In application.css
*= require command_proposal
Mount the engine in your routes:
mount ::CommandProposal::Engine => "/commands"
Ensure your environment files have a host set:
config.action_mailer.default_url_options = {
host: "localhost",
port: 3000
}
Visit /commands to begin using
After checking out the repo, run bin/setup to install dependencies. 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 the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/rockster160/command_proposal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
- Pagination on various pages. (paginate tasks on tasks#index, paginate history on tasks#show)
- Ability for devs to leave comments on individual lines of code.
- Diff buttons - should be able to compare history with other iterations.
- Top level users that can bypass approval
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the CommandProposal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.