iirc 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e4ac6446425ac435d2277035d20421968eb778ba3ff980adc1a81a77e9822ef
-  data.tar.gz: 4c19e2b02319359014d0d9f14a5a9d1f757a948bac14bcc5152635dbb7412e50
+  metadata.gz: 23bf3a78d1201f86c54b9d6409bb98d24b1dbeeb38bfa0d9173db4945ffab46b
+  data.tar.gz: b18ad6cde53fc59365e1dfc935d2c1d16e6e962d3168b5b7a64feb5ca30a786b
 SHA512:
-  metadata.gz: 1db175bc3db1cbc464652f8ba5e7153e087851bc803adccd4d8434420095d0431f4e41b2ff31122333ba29895d7c66f609ea3d11d6f7d76f1b0024dbbc55d8f4
-  data.tar.gz: a759db9e4264a582b373bc708948330ea58a26639e66e9610cc9258e3965f810de0101ad97acb6ca095c4a926de4899526e64cc53f46391b0ae91006a8b03114
+  metadata.gz: 9be4d722d3d609865e8a829197ea20a80ad14789e3809e746025414e61cc94df29b301969b6d1814a9fb4c63947243a65989d723fca2ef44c343df1f48e87574
+  data.tar.gz: 4767a7575a0ff58c2df94872322d8cc1440a2d18ff03ef1fc33b9350b1754246d9484b1ec3f7a125659f45effd76ae814056fb75b98b1d286038258763e8a47e

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [0.5.1] - 2022-03-29
+
+- [Batteries] Include ISupport
+- Add README example
+
+## [0.5.0] - 2022-03-29
+
+- [Batteries] is now a module. Please change `class Foo < IIRC::Batteries`
+    to `class Foo < IIRC::IRCv3Bot; include Batteries; end`
+
+- [Event] Add #nick method (equivalent to sender.nick)
+
+- Improved README
+
+## [0.4.2] - 2022-03-29
+
+- Fix example in README
+
 ## [0.4.1] - 2022-03-29
 
 - [ISupport] Add module to process RPL_ISUPPORT

data/README.md

@@ -1,17 +1,26 @@
 # Lean, mean IRC processing machine
 
+IIRC is a new IRC framework for Ruby.
+
+It supports IRCv3 features such as message tags, batch and labeled-response.
+
+It's based on composition, with code reload, extensibility and predictability in mind,
+
 ```ruby
 require 'iirc'
 
 class CoolBot < IIRC::IRCv3Bot
   include Verbs
+  include AutoJoin
+  include RegexHooks
+  include PrintIO
 
   def configure_coolness
     on /^!poke/, :poke_back
   end
 
   def poke_back(evt)
-    act "pokes #{evt.sender.nick} back!!!"
+    act reply_target(evt), "pokes #{evt.nick} back!!!"
   end
 
   def autojoin_channels
@@ -22,6 +31,104 @@ end
 CoolBot.run 'irc.libera.chat' if __FILE__ == $0
 ```
 
+```ruby
+require 'iirc'
+
+class SillyBot < IIRC::IRCv3Bot
+  include AcceptInvites
+  include Batteries # Verbs, Ambient, RegexHooks used here
+
+  def configure_silliness
+    on /^!uptime/, :say_uptime
+    on :part, :say_good_riddance
+  end
+
+  @@start_time ||= Time.now
+  def say_uptime
+    say "I've been up for #{((Time.now-@@start_time)/60/60).truncate(2)} hours"
+  end
+
+  def say_good_riddance
+    say 'Good riddance!'
+  end
+end
+
+SillyBot.run 'irc.libera.chat' if __FILE__ == $0
+```
+
+## Events
+
+Incoming lines are parsed as an IIRC::Event, and fired based on their verb.
+
+The Event structure and firing pattern is the same, no matter the verb.
+
+PRIVMSG fires :privmsg. NOTICE fires :notice. RPL_WELCOME (001) fires :"001".
+
+## Hooks
+
+Hooks are added using #on, and removed using #off.
+
+They are stored in a Set, so adding the same hook twice is idempotent.
+
+This supports code reloading.
+
+## Adding behaviour from classes and modules
+
+To set up behaviour from a class or module, write a configure method:
+
+```ruby
+module Greet
+  def configure_greeting
+    on :join, :do_greeting
+  end
+
+  def do_greeting evt
+    unless me === evt.nick
+      say reply_target(evt), "Hello #{evt.nick}!"
+    end
+  end
+end
+
+class MyBot < IIRC::IRCv3Bot
+  include Greet
+
+  def configure_some_feature
+    on :this, :do_that
+  end
+
+  def do_that(evt) end
+end
+```
+
+Configure methods are called automatically on a new instance, and can be run again with #configure!
+
+You might call configure! after reloading code, extending or including modules at runtime.
+
+## Hot reload
+
+For example:
+
+```ruby
+class CoolBot < IIRC::IRCv3Bot
+  include RegexHooks
+
+  def configure_reload
+    on /^=reload/, :reload!
+  end
+
+  def reload!
+    $LOADED_FEATURES
+      .filter { |file| file.start_with?(__dir__) }
+      .each   { |file| load file }
+    configure!
+  end
+end
+
+if __FILE__ == $0
+  CoolBot.run 'irc.libera.chat'
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -38,10 +145,6 @@ Or install it yourself as:
 
     $ gem install iirc
 
-## Usage
-
-TODO: Flesh out usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/facts.rb

@@ -1,6 +1,7 @@
 require "iirc"
 
 IIRC {
+  include IIRC::Bot::Batteries
   include IIRC::Bot::PrintIO
 
   def facts

data/examples/wolfram.rb

@@ -1,7 +1,8 @@
 require "net/https"
 require "iirc"
 
-class Wolfram < IIRC::Batteries
+class Wolfram < IIRC::IRCv3Bot
+  include Batteries
   include PrintIO
 
   def on_privmsg(evt)
@@ -36,4 +37,4 @@ class Wolfram < IIRC::Batteries
   end
 end
 
-Wolfram.run 'irc.libera.chat', nick: 'WolframBot'+rand(100).to_s
+Wolfram.run 'irc.libera.chat', nick: 'WolframBot'+rand(100).to_s

data/lib/iirc/event.rb

@@ -17,6 +17,10 @@ module IIRC
       @args = v || []
     end
 
+    def nick
+      sender&.nick
+    end
+
     def target
       args.first
     end
@@ -25,4 +29,4 @@ module IIRC
       args.last
     end
   end
-end
+end

data/lib/iirc/version.rb

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

data/lib/iirc.rb

@@ -66,7 +66,8 @@ module IIRC
     include IRCv3::LabeledRequests
   end
 
-  class Batteries < IRCv3Bot
+  # Batteries is a recommended set of modules for writing interactive bots.
+  module Bot::Batteries
     include Bot::Channels
     include Bot::Members
     include Bot::Formatting
@@ -74,6 +75,7 @@ module IIRC
     include Bot::Verbs
     include Bot::Ambient
     include Bot::RegexHooks
+    include Bot::ISupport
   end
 
   module SSL
@@ -128,5 +130,5 @@ module IIRC
 end
 
 def IIRC(*args, **kwargs, &blk)
-  Class.new(IIRC::Batteries, &blk)
+  Class.new(IIRC::IRCv3Bot, &blk)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iirc
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - mooff