iirc 0.2.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d6ae434bb4e2301cffa91ad030d6a1a154ad0d9fc402fea6baad7ee3840011
-  data.tar.gz: 1bb87fe5fa933ed85884c677617646daab7a98fdd691392d87e738132b4ea5eb
+  metadata.gz: 89d3e4727f759400cf52bf6a8cb23b365d62259ef32fd977c6fcaab0d542fa53
+  data.tar.gz: fc476e509a2ca6e620d6b93bbde705113136926e574860b05bc5508c332f8e51
 SHA512:
-  metadata.gz: '090d2add141ab9a775e22d216d5b7baeef87a5f19026ede39d0717954a9c1df3cc5c63df68b169f4925654bea04c25f50aaf5a503471be153b9f86c3dbfbab59'
-  data.tar.gz: 9770fb0e1eb3a491e9978f95331468349a5554f1b621c7bad1487b14d6251df2ebd5b0fd0b940afbd91412442a9dec22de5b27ca34c84d4927cd3f572bf0acfb
+  metadata.gz: c9cbf42882b4aeb2ae080266750d540d5f834a6c55be22d8b75541c7ca4b521492eacae055c21a3bdb716ca691e3db8a685c79d918c353df324ed8f42b9f168d
+  data.tar.gz: 98d82cf28be02e06e32dd8c6978eb0470ca486c6b9f898fb0642e244e2edbaa99f2c0df9aa9fc4491610968d72736cfae05aba8dfddd1fe04fcdf72681389503

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## [0.4.0] - 2022-03-27
+
+- [Numerics] Add module with constants imported from ircdocs.horse
+  - Run `rake numerics` to re-import.
+
+- [IIRC.run,IIRC.dial] Support passing a symbol as ssl_context
+	- e.g. ssl_context: :no_verify instead of ssl_context: IIRC::SSL.no_verify
+
+- The AmbientEvents modules have been reorganised
+  - AmbientVerbs is now Ambient::Verbs
+  - AmbientEvents => Ambient::Events
+  - AmbientEvents::{LabeledRequests,ReplyTarget} => Ambient::{LabeledRequests,ReplyTarget}
+
+- #ambient_reply_target() has been replaced with #reply_target(evt=ambient_event)
+
+- [Bot.run] Set nick to class name if no param is given
+  - `MyBot.run('irc.libera.chat')` is enough to connect to Libera as 'MyBot'
+
+## [0.3.0] - 2022-03-26
+
+- [Bot] Include ReplyTarget
+- [Hooks] Refactor
+- Add AcceptInvites module
+- Improve Greeter example
+- [IIRC.run,IIRC.dial] now accept local_host, local_port keyword arguments
+
+## [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,68 @@ 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 :numerics do
+  require 'yaml'
+  require 'open-uri'
+
+  data = YAML.load URI.open('https://raw.githubusercontent.com/ircdocs/irc-defs/gh-pages/_data/numerics.yaml')
+  revision = data['file']['revision']
+
+  puts "Loaded numerics.yaml revision #{revision}"
+
+  open(File.join(__dir__, 'lib/iirc/numerics.rb'), 'w+') do |out|
+    out << <<~HEADER
+      module IIRC
+        # Definitions imported from ircdocs.horse
+        # @version #{revision}
+        # @see https://raw.githubusercontent.com/ircdocs/irc-defs/gh-pages/_data/numerics.yaml
+        # @see https://defs.ircdocs.horse/defs/numerics.html
+        module Numerics
+    HEADER
+
+    values = data['values'].reject { |v| v['obsolete'] }
+    counts = values.map { |v| v['name'] }.tally
+
+    constants = {}
+
+    for row in values
+      out << "    # #{row['comment'].squeeze(' ').tr("\r", '').gsub("\n", ' ').strip}\n" if row['comment']
+      out << "    # @format #{row['numeric']} #{row['format'].strip}\n" if row['format']
+
+      name = row['name']
+      if counts[name] > 1 and row['origin']
+        name += '_' + row['origin'].gsub(/[^[:alnum:]]/, '_').gsub(/_{2,}/, '_').sub(/_$/, '').upcase
+      end
+      if constants[name]
+        name += '_ALT'
+        if constants[name]
+          fail <<~MSG
+            Couldn't derive a unique name for #{name}.
+            Previous source: #{constants[name].inspect}
+          MSG
+        end
+      end
+
+      constants[name] = row
+
+      out << "    #{name} = #{row['numeric'].to_sym.inspect}"
+      out << "\n"
+    end
+
+    out << <<~FOOTER
+        end
+      end
+    FOOTER
+  end
+
+  puts "%d numerics." % data['values'].count
+  system('wc', File.join(__dir__, 'lib/iirc/numerics.rb'))
+end
+
 task default: :test
+

data/examples/greeter.rb

@@ -3,9 +3,10 @@ require "iirc"
 class Greeter < IIRC::Bot
   include AutoJoin
   include Verbs
+  include PrintIO
 
   def on_join(evt)
-    say evt.target, "Hello #{evt.sender.nick}!"
+    say evt.target, "Hello #{evt.sender.nick}!" unless me === evt.sender
   end
 
   def autojoin_channels

data/lib/iirc/bot/accept_invites.rb

@@ -0,0 +1,22 @@
+module IIRC
+  module Bot::AcceptInvites
+    # Override this to decide whether we should accept a given invite.
+    # By default, all invites are accepted.
+    # @param [Event]
+    # @return [true] if we should join the channel
+    def accept_invite?(evt)
+      true
+    end
+
+    private
+      def configure_accept_invites
+        on :invite, :accept_invites
+      end
+
+      def accept_invites(evt)
+        if me === evt.target and accept_invite?(evt)
+          join evt.args[1]
+        end
+      end
+  end
+end

data/lib/iirc/bot/ambient.rb

@@ -1,50 +1,61 @@
+require_relative "reply_target"
+
 module IIRC
-  module Bot::AmbientEvents
-    private
-      def configure_ambient_events
-        hook :set_ambient_event
-      end
+  module Bot::Ambient
+    module Events
+      private
+        def configure_ambient_events
+          hook :set_ambient_event
+        end
 
-      def ambient_event
-        Thread.current[:ambient_event]
-      end
+        def ambient_event
+          Thread.current[:ambient_event]
+        end
 
-      def ambient_target; ambient_event&.target; end
-      def ambient_sender; ambient_event&.sender; end
+        def ambient_target; ambient_event&.target; end
+        def ambient_sender; ambient_event&.sender; end
 
-      def set_ambient_event(evt)
-        Thread.current[:ambient_event] = evt
-      end
+        def set_ambient_event(evt)
+          Thread.current[:ambient_event] = evt
+        end
+
+        def with_ambient_event(evt)
+          initial_event = ambient_event
+          set_ambient_event(evt)
+          begin
+            yield evt
+          ensure
+            set_ambient_event(initial_event)
+          end
+        end
+    end
 
-      def with_ambient_event(evt)
-        initial_event = ambient_event
-        set_ambient_event(evt)
-        begin
-          yield evt
-        ensure
-          set_ambient_event(initial_event)
+    module LabeledRequests
+      def labeled_request(*)
+        initial_evt = ambient_event
+        super do |reply|
+          with_ambient_event(initial_evt) { yield reply }
         end
       end
-  end
+    end
 
-  module Bot::AmbientVerbs
-    include Bot::AmbientEvents
+    module ReplyTarget
+      def reply_target(evt=ambient_event) super end
+    end
 
-    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 Verbs
+      include Events
+      include ReplyTarget
 
-  module Bot::AmbientEvents::LabeledRequests
-    def labeled_request(*)
-      initial_evt = ambient_event
-      super do |reply|
-        with_ambient_event(initial_evt) { yield reply }
-      end
+      def join(channel=reply_target) super end
+      def part(channel=reply_target, reason='') super end
+      def msg(target=reply_target, msg) super end
+      def act(target=reply_target, msg) super end
+      def cycle(channel=reply_target, reason='') super end
+      def mode(target=reply_target, mode) super end
+      alias :say :msg
     end
+
+    include Verbs
   end
-end
+end

data/lib/iirc/bot/hooks.rb

@@ -4,6 +4,18 @@ module IIRC
       @hooks ||= Hash.new { |h,v| h[v] = Set.new }
     end
 
+    def run
+      lines { |line|
+        begin
+          evt = parse(line)
+          fire! evt.verb, evt
+        rescue Exception => ex
+          puts ex.message
+          puts ex.backtrace
+        end
+      }
+    end
+
     def on verb=nil, action=nil, &blk
       if action and blk
         define_singleton_method(action, blk)
@@ -17,10 +29,6 @@ module IIRC
       end
     end
 
-    def hook action=nil, &blk
-      on nil, action, &blk
-    end
-
     def off verb, action=nil, &blk
       action ||= blk
       if action
@@ -30,14 +38,12 @@ module IIRC
       end
     end
 
+    def hook action=nil, &blk
+      on nil, action, &blk
+    end
+
     def fire! verb, *args, **kwargs
-      for action in hooks[nil]
-        call action, *args, **kwargs
-      end
-      if respond_to? :"on_#{verb}"
-        send(:"on_#{verb}", *args, **kwargs)
-      end
-      for action in hooks[verb]
+      for action in hook_seq(verb)
         call action, *args, **kwargs
       end
     rescue StopIteration
@@ -54,16 +60,9 @@ module IIRC
       end
     end
 
-    def run
-      lines { |line|
-        begin
-          evt = parse(line)
-          fire! evt.verb, evt
-        rescue Exception => ex
-          puts ex.message
-          puts ex.backtrace
-        end
-      }
-    end
+    protected
+      def hook_seq(verb)
+        [*hooks[nil], (:"on_#{verb}" if respond_to?(:"on_#{verb}")), *hooks[verb]].compact
+      end
   end
-end
+end

data/lib/iirc/bot/ircv3/parsing.rb

@@ -4,7 +4,7 @@ module IIRC
       autoload :IRCParser, 'ircparser'
 
       def parse(line)
-        msg = IRCParser::Message.parse(line.chomp)
+        msg = IRCParser::Message.parse(line.tr("\r", '').chomp)
 
         Event.new.tap { |evt|
           evt.sender = IRCParser::RFCWireFormat.__stringify_prefix(msg.prefix) if msg.prefix

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/bot.rb

@@ -30,7 +30,7 @@ module IIRC
     end
 
     private def ensure_registration_info!
-      me.username ||= me.nick.downcase
+      me.username ||= me.nick&.downcase
       me.realname ||= me.nick
       raise ArgumentError.new('no nick given') unless me.nick && !me.nick.empty?
     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)