iirc 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 393add51d4c945dfa67c0459aee623d0cd0611ebd891a67dba43179fdfc71010
-  data.tar.gz: 9cc245c08ecb2aa1dd3ba29992620fa611d6fb021a300fae7476f26a02cfcc2a
+  metadata.gz: 853f0b25a9eb334db23bca0fb64366ad9ed147efc9851d1ece86b5e3c2fd17af
+  data.tar.gz: ee32c34c25ac79024ab6e6a00b1460a6c894f6de101d05d2f57e28badcf338ce
 SHA512:
-  metadata.gz: 61bc31ca365d0ad70a84d7ad32352c5feb9ba656f594011c1693d6a43c4e0a54ac31524e8ea8826a1ce19a2e18c079b7edc58c3e083216413cccf268fb2d98ad
-  data.tar.gz: a772002465744f4325b5d2dd3c2f8d412b6d09f35743ea93da6e2490396c4f1d90f8d9a1924dcd6eb14030ab0bce76a937524bd4dc5b94b5ec97b6e19b9bf024
+  metadata.gz: f63b32da94e064e2b614ddf01d8e965991fdc7a4603a6f27628583df1b1eccbac0b9caa93bf7b5d871a024e18cd54fd827e5f0af9da8661f05c696df2b95a262
+  data.tar.gz: 840c5505aa89eff5a7890607de7cfda3e468b3c1ae3bf9cb61266eccfe46f14b37c0a4459af59df2594b8e5cf29d142410efe90306b7f91bc02c0d9fcd3323f4

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [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

data/README.md

@@ -1,17 +1,26 @@
 # Lean, mean IRC processing machine
 
+IIRC is a new IRC framework for Ruby.
+
+IRCv3 features such as message tags, batch and labeled-response are supported.
+
+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 reply_target(evt), "pokes #{evt.sender.nick} back!!!"
+    act reply_target(evt), "pokes #{evt.nick} back!!!"
   end
 
   def autojoin_channels
@@ -22,6 +31,79 @@ end
 CoolBot.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 +120,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.2"
+  VERSION = "0.5.0"
 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
@@ -128,5 +129,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.2
+  version: 0.5.0
 platform: ruby
 authors:
 - mooff