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

#bot ⇒ Bot (readonly)

Returns:

Since:

  • 2.0.0



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

def bot
  @bot
end

#name ⇒ String (readonly)

Returns:

Since:

  • 2.0.0



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

def name
  @name
end

Instance Method Details

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

Parameters:

Returns:

  • (-1, 0, 1, nil)

Since:

  • 2.0.0



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

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.

Parameters:

  • text (#to_s) —

    the message to send

See Also:

Since:

  • 2.0.0



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

def action(text)
  @bot.irc.send("PRIVMSG #@name :\001ACTION #{text}\001")
end

#concretize ⇒ Object

Since:

  • 2.0.0



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

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.

Parameters:

  • message (#to_s) —

    the ctcp message

Since:

  • 2.0.0



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

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 2.0.0



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

def eql?(other)
  self == other
end

#notice(text)

This method returns an undefined value.

Sends a NOTICE to the target.

Parameters:

  • text (#to_s) —

    the message to send

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.

Parameters:

  • text (#to_s) —

    the message to send

See Also:

Since:

  • 2.0.0



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

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.

Parameters:

  • text (#to_s) —

    the message to send

  • notice (Boolean) (defaults to: false) —

    Use NOTICE instead of PRIVMSG?

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.

Parameters:

  • text (#to_s) —

    the message to send

  • notice (Boolean) (defaults to: false) —

    Use NOTICE instead of PRIVMSG?

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