[![Build Status](https://travis-ci.org/apiology/quality.png)](https://travis-ci.org/apiology/quality)
[![Coverage Status](https://coveralls.io/repos/apiology/quality/badge.png?branch=master)](https://coveralls.io/r/apiology/quality?branch=master)


# Quality -- code quality ratchet for Ruby

##Overview

Quality is a tool that runs quality checks on Ruby code using cane,
reek, flog, flay and rubocop and makes sure your numbers don't get any
worse over time.

## Why

See [this post](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html) or [these slides](https://docs.google.com/presentation/d/1Op4FH34-enm8luEIuAAVLkuAJ-sB4LKaMm57RJzvfeI/edit#slide) for more information on the problem the quality gem solves.

##How to use

```bash
$ gem install quality
```

or in your Gemfile:

```ruby
group :development do
  gem 'quality'
end
```
and then:

```bash
$ bundle install
```

Once you have the gem, configure your Rakefile like this:

```ruby
require 'quality/rake/task'

Quality::Rake::Task.new
```

Then run:

```bash
$ rake quality
```

If you want to ratchet up the quality and force yourself to improve
code, run:

```bash
$ rake ratchet
```

## Configuration options

```ruby
Quality::Rake::Task.new { |t|
  # Name of quality task.
  # Defaults to :quality.
  t.quality_name = "quality"

  # Name of ratchet task.
  # Defaults to :ratchet.
  t.ratchet_name = "ratchet"

  # Array of strings describing tools to be skipped--e.g., ["cane"]
  #
  # Defaults to []
  t.skip_tools = []

  # Log command executation
  #
  # Defaults to false
  t.verbose = false

  # Array of directory names which contain ruby files to analyze.
  #
  # Defaults to %w(app lib test spec feature), which translates to *.rb in the base directory, as well as those directories.
  t.ruby_dirs = %w(app lib test spec feature)

  # Array of directory names which contain any type of source files to analyze.
  #
  # Defaults to t.ruby_dirs
  t.source_dirs.concat(%w(MyProject MyProjectTests))

  # Pick any extra files that are source files, but may not have
  # extensions--defaults to %w(Rakefile Dockerfile)
  t.extra_source_files = ['tools/check-script', 'Rakefile']

  # Pick any extra files that are source files, but may not have
  # extensions--defaults to %w(Rakefile)
  t.extra_ruby_files = ['Rakefile']

  # Exclude the specified list of files--defaults to ['db/schema.rb']
  t.exclude_files = ['lib/whatever/imported_file.rb', 'lib/vendor/someone_else_fault.rb']

  # Extensions for Ruby language files--defaults to 'rb,rake'
  t.ruby_file_extensions_glob = 'rb,rake'

  # Extensions for all source files--defaults to
  # 'rb,rake,swift,cpp,c,java,py,clj,cljs,scala,js,yml,sh,json'
  t.source_file_extensions_glob =
    'rb,rake,swift,cpp,c,java,py,clj,cljs,scala,js,yml,sh,json'

  # Relative path to output directory where *_high_water_mark
  # files will be read/written
  #
  # Defaults to 'metrics'
  t.output_dir = 'metrics'

  # Pipe-separated regexp string describing what to look for in
  # files as 'todo'-like 'punchlist' comments.
  #
  # Defaults to 'XXX|TODO'
  t.punchlist_regexp = 'XXX|TODO'
}
```

## Code coverage

You can pull a similar trick with code coverage using SimpleCov in Ruby--put 'simplecov' in your Gemfile, and add the code below into your test_helper.rb or spec_helper.rb.

```
require 'simplecov'
SimpleCov.start
SimpleCov.refuse_coverage_drop
```

After your first run, check in your coverage/.last_run.json.

## Maturity

Quality uses [semantic versioning](http://semver.org/)--any incompatible changes will come out as major number updates.

## Supported Ruby Versions

Tested against Ruby >=2.0--does not support Ruby 1.9.x.

## Contributing

* Fork the repo
* Create a feature branch
* Submit a github pull request

Many thanks to all contributors, especially [@andyw8](https://github.com/andyw8), who has contributed some great improvements.

### Dependencies

Quality makes use of the following other gems, which do the actual checking:

* [reek](https://github.com/troessner/reek)
* [cane](https://github.com/square/cane)
* [flog](https://github.com/seattlerb/flog)
* [flay](https://github.com/seattlerb/flay)
* [rubocop](https://github.com/bbatsov/rubocop)
* [bigfiles](https://github.com/apiology/bigfiles)
* [punchlist](https://github.com/apiology/punchlist)

### Learn More

* Browse the code or install the latest development version from [https://github.com/apiology/quality/tree](https://github.com/apiology/quality/tree)

## License

Licensed under the MIT license.