Pronto::Blacklist

Pronto runner to flag strings from a blacklist. What is Pronto?

This is useful for preventing use of deprecated classes.

Installation

Add this line to your application's Gemfile:

gem 'pronto-blacklist', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install pronto-blacklist

Usage

Create the following yaml file in the root of your codebase

.pronto-blacklist.yml

blacklist:
  - DeprecatedClass
  - cancelled
  - some other string
options:
  DeprecatedClass:
    exclude:
      - '**/*_spec.rb'
  cancelled:
    case_sensitive: false

Options

exclude: Accepts an array of paths in .gitignore format. It will not blacklist the string in matching files.

case_sensitive: Defaults to true if not set.

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pbstriker38/pronto-blacklist.