iirc 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d6ae434bb4e2301cffa91ad030d6a1a154ad0d9fc402fea6baad7ee3840011
-  data.tar.gz: 1bb87fe5fa933ed85884c677617646daab7a98fdd691392d87e738132b4ea5eb
+  metadata.gz: 2b3e9c48299d3d224743658cf8f5ccb1fa350fa748c8319fccd0d1a2c7154f81
+  data.tar.gz: 7675b9b55b30fb8a66c96aaccae46a4cd60c1381d8d79a1d4b9e1fdd13ccc6e9
 SHA512:
-  metadata.gz: '090d2add141ab9a775e22d216d5b7baeef87a5f19026ede39d0717954a9c1df3cc5c63df68b169f4925654bea04c25f50aaf5a503471be153b9f86c3dbfbab59'
-  data.tar.gz: 9770fb0e1eb3a491e9978f95331468349a5554f1b621c7bad1487b14d6251df2ebd5b0fd0b940afbd91412442a9dec22de5b27ca34c84d4927cd3f572bf0acfb
+  metadata.gz: 7f5f6743fd668c3da81091b5ae865e32bc83685166d4802bccd3bcd19c8dc2aebff176cb41b0cbb986b8b01c0e8ebeef527bdc4f099b6d327a4cca15e43ec6a9
+  data.tar.gz: df2a11d9936e4744581fa0cf8196a424692272f72f439acf18384ebb9afb122835637475e7d97618a81a5f291efe37f42dca378021d18b7b0246722dc86b564a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.2.9] - 2022-03-24
+
+- Add reply target concept (Bot::ReplyTarget)
+  - The reply target of an event is the sender's nick when we are its target,
+    and equal to the regular target otherwise.
+  - The ambient verb methods now target the reply target of the ambient event by default.
+  - Should make writing actions more convenient.
+
 ## [0.2.8] - 2022-03-22
 
 - Add MIT license

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rdoc/task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,9 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+RDoc::Task.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.options = ["--all"]
+end
+
 task default: :test

data/lib/iirc/bot/ambient.rb

@@ -1,3 +1,5 @@
+require_relative "reply_target"
+
 module IIRC
   module Bot::AmbientEvents
     private
@@ -27,18 +29,6 @@ module IIRC
       end
   end
 
-  module Bot::AmbientVerbs
-    include Bot::AmbientEvents
-
-    def join(channel=ambient_target) super end
-    def part(channel=ambient_target, reason='') super end
-    def msg(channel=ambient_target, msg) super end
-    def act(channel=ambient_target, msg) super end
-    def cycle(channel=ambient_target, reason='') super end
-    def mode(channel=ambient_target, mode) super end
-    alias :say :msg
-  end
-
   module Bot::AmbientEvents::LabeledRequests
     def labeled_request(*)
       initial_evt = ambient_event
@@ -47,4 +37,24 @@ module IIRC
       end
     end
   end
+
+  module Bot::AmbientEvents::ReplyTarget
+    include Bot::ReplyTarget
+    def ambient_reply_target
+      reply_target(ambient_event)
+    end
+  end
+
+  module Bot::AmbientVerbs
+    include Bot::AmbientEvents
+    include Bot::AmbientEvents::ReplyTarget
+
+    def join(channel=ambient_reply_target) super end
+    def part(channel=ambient_reply_target, reason='') super end
+    def msg(channel=ambient_reply_target, msg) super end
+    def act(channel=ambient_reply_target, msg) super end
+    def cycle(channel=ambient_reply_target, reason='') super end
+    def mode(channel=ambient_reply_target, mode) super end
+    alias :say :msg
+  end
 end

data/lib/iirc/bot/reply_target.rb

@@ -0,0 +1,14 @@
+module IIRC
+  module Bot::ReplyTarget
+    # The +reply_target+ of an event is the sender's nickname when _we_ are the
+    # +target+. Otherwise, it returns the regular +target+.
+    #
+    # It lets us reply to events without having to repeat the `(me ===
+    # target) ? sender.nick : target` logic used to make sure we don't message
+    # ourselves when we receive a direct PRIVMSG, NOTICE, etc.
+
+    def reply_target(evt)
+      (me === evt.target) ? evt.sender.nick : evt.target
+    end
+  end
+end

data/lib/iirc/event.rb

@@ -10,8 +10,7 @@ module IIRC
     end
 
     def sender=(v)
-      v.extend Sender if v
-      @sender = v
+      @sender = IIRC::Sender(v)
     end
 
     def args=(v)

data/lib/iirc/sender.rb

@@ -1,7 +1,26 @@
 module IIRC
+  # A mixin which adds IRC hostmask introspection methods to strings.
+  #
+  # *CoolNick*, *:NickName*, <b>:nick!user@host</b>, *:server.name*, *another.server.name* forms are supported.
+  #
+  # A leading colon may be present in the string, and will be ignored.
+  #
+  # @example nick!user@example.com
+  #   sender = "nick!user@example.com".extend(IIRC::Sender)
+  #   sender.user? # => true
+  #   sender.host  # => "example.com"
+  # @example :irc.server
+  #   sender = ":irc.server".extend(IIRC::Sender)
+  #   sender.server? # => true
+  #   sender.host    # => "irc.server"
+  # @example JimBob
+  #   sender = "JimBob".extend(IIRC::Sender)
+  #   sender.user? # => true
+  #   sender.nick  # => "JimBob"
+
   module Sender
     def user
-      @user ||= User.from_sender(self)
+      @user ||= User.from_source(self)
     end
 
     def server?
@@ -14,16 +33,37 @@ module IIRC
 
     def nick; user&.nick end
     def username; user&.username end
-    def host; user&.host end
+    def host; server? ? without_leading_colon : user.host end
 
     def to_prefix
       ":#{self}"
     end
 
-    def to_s
+    def without_leading_colon
       delete_prefix(':')
     end
 
+    alias :to_s :without_leading_colon
     alias :inspect :to_prefix
   end
+
+  module_function
+    # Extends and returns a source string with the IIRC::Sender mixin.
+    # Duplicates first if the string is frozen. Returns nil if source is nil.
+    #
+    # @example :nick!user@host
+    #   v = IIRC.Sender(":JimmyWales!jim@wikipedia.org") # => "JimmyWales!jim@wikipedia.org"
+    #   v.nick    # => "JimmyWales"
+    #   v.host    # => "wikipedia.org"
+    #   v.user?   # => true
+    # @example server.name
+    #   IIRC.Sender("services.libera.chat").server? # => true
+
+    def Sender(source)
+      if source.nil?
+        nil
+      else
+        (source.frozen? ? source.dup : source).extend(Sender)
+      end
+    end
 end

data/lib/iirc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IIRC
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

data/lib/iirc.rb

@@ -19,6 +19,7 @@ require_relative "iirc/bot/print_io"
 require_relative "iirc/bot/reading"
 require_relative "iirc/bot/redis"
 require_relative "iirc/bot/regex_hooks"
+require_relative "iirc/bot/reply_target"
 require_relative "iirc/bot/track_own_nick"
 require_relative "iirc/bot/verbs"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iirc
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - mooff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ircparser
@@ -64,6 +64,7 @@ files:
 - lib/iirc/bot/reading.rb
 - lib/iirc/bot/redis.rb
 - lib/iirc/bot/regex_hooks.rb
+- lib/iirc/bot/reply_target.rb
 - lib/iirc/bot/track_own_nick.rb
 - lib/iirc/bot/verbs.rb
 - lib/iirc/event.rb