Class: Cinch::Target

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/cinch/target.rb

Overview

Since:

  • 2.0.0

Direct Known Subclasses

Channel, User

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, bot) ⇒ Target

Returns a new instance of Target

Since:

  • 2.0.0


10
11
12
13
# File 'lib/cinch/target.rb', line 10

def initialize(name, bot)
  @name = name
  @bot  = bot
end

Instance Attribute Details

#botBot (readonly)

Since:

  • 2.0.0


9
10
11
# File 'lib/cinch/target.rb', line 9

def bot
  @bot
end

#nameString (readonly)

Since:

  • 2.0.0


7
8
9
# File 'lib/cinch/target.rb', line 7

def name
  @name
end

Instance Method Details

#<=>(other) ⇒ -1, ...

Since:

  • 2.0.0


158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/cinch/target.rb', line 158

def <=>(other)
  casemapping = @bot.irc.isupport["CASEMAPPING"]
  left = @name.irc_downcase(casemapping)

  if other.is_a?(Target)
    left <=> other.name.irc_downcase(casemapping)
  elsif other.is_a?(String)
    left <=> other.irc_downcase(casemapping)
  else
    nil
  end
end

#action(text)

This method returns an undefined value.

Invoke an action (/me) in/to the target.

See Also:

Since:

  • 2.0.0


114
115
116
117
# File 'lib/cinch/target.rb', line 114

def action(text)
  line = text.to_s.each_line.first.chomp
  @bot.irc.send("PRIVMSG #@name :\001ACTION #{line}\001")
end

#concretizeObject

Since:

  • 2.0.0


143
144
145
146
147
148
149
# File 'lib/cinch/target.rb', line 143

def concretize
  if @bot.isupport["CHANTYPES"].include?(@name[0])
    @bot.channel_list.find_ensured(@name)
  else
    @bot.user_list.find_ensured(@name)
  end
end

#ctcp(message)

This method returns an undefined value.

Send a CTCP to the target.

Since:

  • 2.0.0


139
140
141
# File 'lib/cinch/target.rb', line 139

def ctcp(message)
  send "\001#{message}\001"
end

#eql?(other) ⇒ Boolean

Since:

  • 2.0.0


152
153
154
# File 'lib/cinch/target.rb', line 152

def eql?(other)
  self == other
end

#notice(text)

This method returns an undefined value.

Sends a NOTICE to the target.

See Also:

Since:

  • 2.0.0


20
21
22
# File 'lib/cinch/target.rb', line 20

def notice(text)
  send(text, true)
end

#safe_action(text)

This method returns an undefined value.

Like #action, but remove any non-printable characters from text. The purpose of this method is to send text from untrusted sources, like other users or feeds.

Note: this will break any mIRC color codes embedded in the string. For more fine-grained control, use Helpers#Sanitize and Formatting.unformat directly.

See Also:

Since:

  • 2.0.0


131
132
133
# File 'lib/cinch/target.rb', line 131

def safe_action(text)
  action(Cinch::Helpers.sanitize(text))
end

#safe_notice(text) ⇒ Object

Like #safe_msg but for notices.

See Also:

Since:

  • 2.0.0


105
106
107
# File 'lib/cinch/target.rb', line 105

def safe_notice(text)
  safe_send(text, true)
end

#safe_privmsg(*args) ⇒ Object

Deprecated.

Since:

  • 2.0.0


93
94
95
# File 'lib/cinch/target.rb', line 93

def safe_send(text, notice = false)
  send(Cinch::Helpers.sanitize(text), notice)
end

#safe_send(text, notice = false) Also known as: safe_msg

This method returns an undefined value.

Like #send, but remove any non-printable characters from text. The purpose of this method is to send text of untrusted sources, like other users or feeds.

Note: this will break any mIRC color codes embedded in the string. For more fine-grained control, use Helpers#Sanitize and Formatting.unformat directly.

See Also:

Since:

  • 2.0.0


78
79
80
# File 'lib/cinch/target.rb', line 78

def safe_send(text, notice = false)
  send(Cinch::Helpers.sanitize(text), notice)
end

#send(text, notice = false) Also known as: msg, privmsg

Note:

The aliases msg and privmsg are deprecated and will be removed in a future version.

This method returns an undefined value.

Sends a PRIVMSG to the target.

See Also:

Since:

  • 2.0.0


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/cinch/target.rb', line 32

def send(text, notice = false)
  # TODO deprecate `notice` argument, put splitting into own
  # method
  text = text.to_s
  split_start = @bot.config.message_split_start || ""
  split_end   = @bot.config.message_split_end   || ""
  command = notice ? "NOTICE" : "PRIVMSG"
  prefix = ":#{@bot.mask} #{command} #{@name} :"

  text.lines.map(&:chomp).each do |line|
    splitted = split_message(line, prefix, split_start, split_end)

    splitted[0, (@bot.config.max_messages || splitted.size)].each do |string|
      @bot.irc.send("#{command} #@name :#{string}")
    end
  end
end