How might we improve the default filter configuration?

[stevepolitodesign]

It can be cumbersome and brittle to ensure the filter keys matches an existing default filter. For example:

new_email_filter = TopSecret::Filters::Regex.new(label: "EMAIL_ADDRESS", regex: /\b\w+\[at\]\w+\.\w+\b/)

TopSecret::Text.filter("Ralph can be reached at ralph[at]thoughtbot.com", filters: {
  email_filter: new_email_filter,
})

There are a few problems with this approach:

1. You need to know what the default filters are.
2. You could accidentally create a new filter instead of overriding one (see below)

new_email_filter = TopSecret::Filters::Regex.new(label: "EMAIL_ADDRESS", regex: /\b\w+\[at\]\w+\.\w+\b/)

TopSecret::Text.filter("Ralph can be reached at ralph[at]thoughtbot.com", filters: {
  # Note the typo
  email_fillter: new_email_filter,
})

[stevepolitodesign]

Maybe instead we want this:

module TopSecret
  include ActiveSupport::Configurable

  config_accessor :model_path, default: "ner_model.dat"
  config_accessor :min_confidence_score, default: MIN_CONFIDENCE_SCORE

  config_accessor :custom_filters do
    ActiveSupport::OrderedOptions.new
  end

  config_accessor :credit_card_filter, default: TopSecret::Filters::Regex.new(label: "CREDIT_CARD", regex: CREDIT_CARD_REGEX)
  config_accessor :email_filter, default: TopSecret::Filters::Regex.new(label: "EMAIL", regex: EMAIL_REGEX)
  config_accessor :phone_number_filter, default:TopSecret::Filters::Regex.new(label: "PHONE_NUMBER", regex: PHONE_REGEX)
  config_accessor :ssn_filter, default:TopSecret::Filters::Regex.new(label: "SSN", regex: SSN_REGEX)
  config_accessor :people_filter, default: TopSecret::Filters::NER.new(label: "PERSON", tag: :person)
  config_accessor :location_filter, default: TopSecret::Filters::NER.new(label: "LOCATION", tag: :location)
end

new_email_filter = TopSecret::Filters::Regex.new(label: "EMAIL_ADDRESS", regex: /\b\w+\[at\]\w+\.\w+\b/)

# Override a default filter with a keyword argument
TopSecret::Text.filter("Ralph can be reached at ralph[at]thoughtbot.com",  email_filter: new_email_filter)

# Add custom filters
language_filter = TopSecret::Filters::NER.new(
  label: "LANGUAGE",
  tag: :language,
  min_confidence_score: 0.75
)
TopSecret::Text.filter("Ralph can be reached at ralph[at]thoughtbot.com",  custom_filters: [language_filter])

[stevepolitodesign]

This was addressed in #53