Class: Despamilator::Filter

Inherits:

Object

• Object
• Despamilator::Filter

Defined in:

lib/despamilator/filter.rb

Overview

This class is the base class of all the despamilator filters.

EXAMPLE:

This example is to detect the letter “a”. Put the code in lib/despamilator/filter/detect_letter_a.rb:

require 'despamilator/filter_base'

module DespamilatorFilter

  class DetectLetterA < Despamilator::FilterBase

    def name
      'Detecting the letter A'
    end

    def description
      'Detects the letter "a" in a string for no reason other than a demo'
    end

    def parse text
      if text.downcase.scan(/a/)
      # add 0.1 to the score of the text
      self.append_score = 0.1
    end
  end
end

Direct Known Subclasses

DespamilatorFilter::GtubsTestFilter, DespamilatorFilter::HtmlTags, DespamilatorFilter::IPAddressURL, DespamilatorFilter::LongWords, DespamilatorFilter::MixedCase, DespamilatorFilter::NaughtyWords, DespamilatorFilter::NoVowels, DespamilatorFilter::NumbersAndWords, DespamilatorFilter::ObfuscatedURLs, DespamilatorFilter::Prices, DespamilatorFilter::ScriptTag, DespamilatorFilter::Shouting, DespamilatorFilter::SpammyTLDs, DespamilatorFilter::SquareBrackets, DespamilatorFilter::TrailingNumber, DespamilatorFilter::URLs, DespamilatorFilter::UnusualCharacters, DespamilatorFilter::VeryLongDomainName, DespamilatorFilter::WeirdPunctuation

Instance Method Summary

• #description ⇒ Object

  The nice description of the filter.

• #name ⇒ Object

  The one or two word name for the filter.

• #parse(text) ⇒ Object

  This method parses some text.

Instance Method Details

#description ⇒ Object

The nice description of the filter. Usually no more than a sentence.

# File 'lib/despamilator/filter.rb', line 36

def description
  raise "No description defined for #{self.class}"
end

#name ⇒ Object

The one or two word name for the filter.

# File 'lib/despamilator/filter.rb', line 48

def name
  raise "No name defined for #{self.class}"
end

#parse(text) ⇒ Object

This method parses some text. The score is assigned to the same instance.

# File 'lib/despamilator/filter.rb', line 42

def parse text
  raise "No parser defined for #{self.class}"
end