0.01
No commit activity in last 3 years
No release in over 3 years
Detects additions of items on blacklist.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0

Runtime

~> 0.2
~> 0.9
 Project Readme

Gem Version CircleCI

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.