Class: Blur::Network::Channel

Inherits:

Object

• Object
• Blur::Network::Channel

show all

Defined in:

library/blur/network/channel.rb

Overview

Instance Attribute Summary (collapse)

• - (Encryption::Fish) encryption

  The channel encryption, if any.

• - (String) modes

  All the modes set on the channel.

• - (String) name

  The channels name.

• - (Network) network

  A reference to the network.

• - (String) topic

  The channels topic.

• - (Array) users

  A list of users in the channel.

Instance Method Summary (collapse)

• - (Boolean) encrypted?

  Check whether or not this is an encrypted channel.

• - (Channel) initialize(name, network = nil, users = []) constructor

  Instantiate a user with a nickname, a network and a user list.

• - (Object) inspect

  Convert it to a debug-friendly format.

• - (Object) merge_modes(modes)

  Merge the channels mode corresponding to the leading character (+ or -).

• - (Object) say(message)

  Send a message to the channel.

• - (Object) to_s

  Get the channels name.

• - (Object) to_yaml(options = {})

  Called when YAML attempts to save the object, which happens when a scripts cache contains this user and the script is unloaded.

• - (Object) user_by_nick(nick)

  Find a user with nick as its nickname.

33
34
35
36
37
38
39
40

# File 'library/blur/network/channel.rb', line 33

def initialize name, network = nil, users = []
  @name    = name
  @users   = users
  @modes   = ""
  @network = network

  users.each { |user| user.channel = self }
end

27
28
29

# File 'library/blur/network/channel.rb', line 27

def encryption
  @encryption
end

23
24
25

# File 'library/blur/network/channel.rb', line 23

def modes
  @modes
end

17
18
19

# File 'library/blur/network/channel.rb', line 17

def name
  @name
end

25
26
27

# File 'library/blur/network/channel.rb', line 25

def network
  @network
end

21
22
23

# File 'library/blur/network/channel.rb', line 21

def topic
  @topic
end

19
20
21

# File 'library/blur/network/channel.rb', line 19

def users
  @users
end

30

# File 'library/blur/network/channel.rb', line 30

def encrypted?; not @encryption.nil? end

75
76
77

# File 'library/blur/network/channel.rb', line 75

def inspect
  %{#<#{self.class.name} @name=#{@name.inspect} @users=#{@users.inspect}}
end

45
46
47
48
49
50
51
52
53
54
55
56
57
58

# File 'library/blur/network/channel.rb', line 45

def merge_modes modes
  addition = true

  modes.each_char do |char|
    case char
    when ?+
      addition = true
    when ?-
      addition = false
    else
      addition ? @modes.concat(char) : @modes.delete!(char)
    end
  end
end

63
64
65

# File 'library/blur/network/channel.rb', line 63

def say message
  @network.say self, message
end

86
87
88

# File 'library/blur/network/channel.rb', line 86

def to_s
  @name
end

81
82
83

# File 'library/blur/network/channel.rb', line 81

def to_yaml options = {}
  @name.to_yaml options
end

70
71
72

# File 'library/blur/network/channel.rb', line 70

def user_by_nick nick
  @users.find { |user| user.nick == nick }
end