Class: Cinch::Ban

Inherits:

Object

• Object
• Cinch::Ban

show all

Defined in:

lib/cinch/ban.rb

Overview

Instance Attribute Summary (collapse)

• - (User^?) by readonly

  The user who created the ban.

• - (Time) created_at readonly
• - (Boolean) extended readonly

  Whether this is an extended ban (as used by for example Freenode).

• - (Mask, String) mask readonly

Instance Method Summary (collapse)

• - (Ban) initialize(mask, by, at) constructor

  A new instance of Ban.

• - (Boolean) match(user) (also: #=~)

  True if the ban matches user.

• - (String) to_s

25
26
27
28
29
30
31
32
33
34

# File 'lib/cinch/ban.rb', line 25

def initialize(mask, by, at)
  @by, @created_at = by, at
  if mask =~ /^[\$~]/
    @extended = true
    @mask     = mask
  else
    @extended = false
    @mask = Mask.from(mask)
  end
end

14
15
16

# File 'lib/cinch/ban.rb', line 14

def by
  @by
end

17
18
19

# File 'lib/cinch/ban.rb', line 17

def created_at
  @created_at
end

20
21
22

# File 'lib/cinch/ban.rb', line 20

def extended
  @extended
end

7
8
9

# File 'lib/cinch/ban.rb', line 7

def mask
  @mask
end

39
40
41
42

# File 'lib/cinch/ban.rb', line 39

def match(user)
  raise UnsupportedFeature, "extended bans are not supported yet" if @extended
  @mask =~ user
end

46
47
48

# File 'lib/cinch/ban.rb', line 46

def to_s
  @mask.to_s
end