OrderlyGarden

A set of tools for Rake and Ruby workflows, to help keep things neat and tidy.

  • parent_task: Automatically run all sub-tasks in a namespace when the namespace-named task is run.
  • Limit the number of Rake threads to a sane number by default.
  • Lint metric for code volume if cloc is installed.
  • Ruby style enforcement, and slightly saner Rubocop defaults.
  • Dependency checking with bundler-audit, and bundle outdated.
  • with_tempfile: Manage a temp file for you, and optionally replace a destination path with it upon success.
  • write_file: Write an array of strings to a file ensuring they're joined by newlines and have a trailing newline.

Installation

Add this line to your application's Gemfile:

gem "orderly_garden", require: false, git: "[email protected]:MrJoy/orderly_garden.git"

And then execute:

bundle

Or install it yourself as:

gem install orderly_garden

Usage

Setup

  1. In Rakefile, add this -- replacing the domain name with the URL of your private Docker registry: ruby require "rubygems" require "bundler/setup" Bundler.require(:default, :development, :test) require "orderly_gardem" OrderlyGarden.init!
  2. Create a file named .rubocop.local.yml with your own Rubocop rules / configuration.
    • This will be merged with the saner defaults provided by orderly_garden when running rake lint:rubocop.
  3. Add /.rubocop.yml to your .gitignore file, as this will be auto-generated.

Running The Tools

rake -T
# rake lint                # Run all lint checks against the code
# rake lint:bundler        # Check for outdated gems
# rake lint:bundler-audit  # Run bundler-audit against the Gemfile
# rake lint:cloc           # Show LOC metrics for project using cloc
# rake lint:rubocop        # Run Rubocop against the codebase

Using the DSL constructs (such as with_tempfile, write_file...) should be pretty self-explanatory if you take a peek at the source.

Custom Lint Tasks

To add a task that gets executed when you run rake lint, simply create it in the lint namespace:

namespace :lint do
  desc "Some sort of lint check for your project.  Will be included in `rake lint` automatically."
  task :my_check do
  end
end

Making Your Own Auto-Discovery Task Groups

desc "Run all `my_group:*` tasks."
parent_task :my_group

namespace :my_group do
  desc "Some task to include in `rake my_group`."
  task :some_task do
  end
end

Contributing

  1. Fork it ( https://github.com/MrJoy/orderly_garden/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request