Class: NaughtyWords::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/naughty_words/config.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.allow_overrides ⇒ Object (readonly)

Returns the value of attribute allow_overrides.



7
8
9
 
# File 'lib/naughty_words/config.rb', line 7

def allow_overrides
  @allow_overrides
end

.deny_overrides ⇒ Object (readonly)

Returns the value of attribute deny_overrides.



7
8
9
 
# File 'lib/naughty_words/config.rb', line 7

def deny_overrides
  @deny_overrides
end

.minimum_severity ⇒ Object

Returns the value of attribute minimum_severity.



6
7
8
 
# File 'lib/naughty_words/config.rb', line 6

def minimum_severity
  @minimum_severity
end

.use_built_in_lists ⇒ Object

Returns the value of attribute use_built_in_lists.



6
7
8
 
# File 'lib/naughty_words/config.rb', line 6

def use_built_in_lists
  @use_built_in_lists
end

.word_boundaries ⇒ Object

Returns the value of attribute word_boundaries.



6
7
8
 
# File 'lib/naughty_words/config.rb', line 6

def word_boundaries
  @word_boundaries
end

Class Method Details

.allow_word(word) ⇒ Object

override a word from the deny list to allow it



22
23
24
25
26
27
 
# File 'lib/naughty_words/config.rb', line 22

def allow_word(word)
  word = word.to_s.strip
  return if word.empty?
  @allow_overrides << word.downcase
  @allow_overrides.uniq!
end

.configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



9
10
11
 
# File 'lib/naughty_words/config.rb', line 9

def configure
  yield self
end

.deny_word(word) ⇒ Object

override a word from the allow list to deny it



30
31
32
33
34
35
 
# File 'lib/naughty_words/config.rb', line 30

def deny_word(word)
  word = word.to_s.strip
  return if word.empty?
  @deny_overrides << word.downcase
  @deny_overrides.uniq!
end

.remove_override(word) ⇒ Object 



37
38
39
40
41
 
# File 'lib/naughty_words/config.rb', line 37

def remove_override(word)
  word = word.to_s.strip.downcase
  @allow_overrides.delete(word)
  @deny_overrides.delete(word)
end

.reset! ⇒ Object 



13
14
15
16
17
18
19
 
# File 'lib/naughty_words/config.rb', line 13

def reset!
  @word_boundaries = true
  @use_built_in_lists = true
  @minimum_severity = nil  # nil means check all severities
  @allow_overrides = []
  @deny_overrides = []
end