artaius 0.2.0

data/lib/artaius/plugins/mixer.rb

@@ -0,0 +1,335 @@
+module Artaius
+  module Plugins
+    # The plugins allows to create game mixes in IRC.
+    class Mixer
+      include Cinch::Plugin
+
+      # Internal: Create a new game.
+      #
+      # players - The Enumerable of players (Set or Array).
+      # limit   - The Integer, describes the needed quantity of players, in
+      #           order to start the game.
+      # time    - The Time, when the game was created.
+      #
+      # Returns Game Struct object.
+      Game = Struct.new(:players, :limit, :time)
+
+      # Internal: Create a new gamer. Gamer is a player, which wants to play a
+      # mix.
+      #
+      # irc_nick     - The String, representing gamer's IRC nickname.
+      # irc_authname - The String, representing gamer's IRC authname.
+      # role         - The Integer, representing KAG player's role
+      #
+      # Returns Gamer object.
+      Gamer = Struct.new(:irc_nick, :irc_authname, :premium?, :role)
+
+      # Internal: Limit to be used, when the op didn't specify the number of
+      # players in the mix.
+      DEFAULT_LIMIT = 10
+
+      # Internal: Minimal number of slots needed to be able to play the game.
+      MIN_SLOTS = 2
+
+      # Internal: Delay between the beginning of game and its ending (in
+      # seconds).
+      PENDING_DELAY = 300
+
+
+      set react_on: :channel
+
+      match /#{I18n.mixer.m.game}(\s([2-9]|[1-9][0-9]))?$/,
+            method:     :start_game,
+            use_suffix:  false
+
+      # Internal: Create new game and add the creator to that game, so he/she
+      # will be the first player in that game.
+      #
+      # m     - The recieved Message.
+      # limit - The Integer, which sets the limit of the players in the mix.
+      #
+      # Returns nothing.
+      def start_game(m, limit)
+        return if @game or !Player.exists?(m.user.authname)
+
+        @limit = if limit && !limit.empty?
+          limit.to_i
+        else
+          DEFAULT_LIMIT
+        end
+
+        @game = Game.new([], limit, Time.now)
+        @initiator = create_gamer(m)
+        add_player(m)
+      end
+
+      match /#{I18n.mixer.m.play}$/,
+            method:     :add_player,
+            use_suffix:  false
+
+      # Internal: Add a new player to the game.
+      #
+      # m - The recieved Message.
+      #
+      # Returns nothing.
+      def add_player(m)
+        return if !@game or !Player.exists?(m.user.authname)
+
+        unless @game.players.map(&:irc_authname).include?(m.user.authname)
+          @game.players << create_gamer(m)
+
+          need_players = @limit - @game.players.size
+
+          if ready_to_begin?
+            each_team { |blue, red| begin_game!(m, blue, red) }
+          else
+            m.reply I18n.mixer.players(show_players)
+            m.reply I18n.mixer.need_players(need_players)
+          end
+
+        end
+
+        @timer.stop if @timer
+
+        @timer = Timer(PENDING_DELAY, :shots => 1) do
+          @game = nil
+          Channel(m.channel.name).send I18n.mixer.game_cancelled
+        end
+      end
+
+      match /#{I18n.mixer.m.cancel}$/,
+            method:     :cancel,
+            use_suffix:  false
+
+      # Internal: Remove the user from the game. If the user is the last user in
+      # the game, automatically revoke that game.
+      #
+      # m - The recieved Message.
+      #
+      # Returns nothing.
+      def cancel(m)
+        player = @game.players.find { |p| p.irc_authname == m.user.authname}
+        @game.players.delete(player)
+
+        @initiator = @game.players[0]
+        m.reply I18n.mixer.cancel(m.user.nick)
+
+        unless @initiator
+          @timer.stop
+          @game = nil
+          m.reply I18n.mixer.last_left
+        else
+          m.reply I18n.mixer.new_initiator(@initiator.irc_nick)
+          m.reply show_players
+        end
+      end
+
+      match /#{I18n.mixer.m.roster}$/,
+            method:     :roster,
+            use_suffix:  false
+
+      # Internal: Send message about current roster in the mix, if there is any.
+      #
+      # m - The recieved Message.
+      #
+      # Returns nothing.
+      def roster(m)
+        return unless @game
+
+        m.reply I18n.mixer.roster(show_players)
+      end
+
+      match /#{I18n.mixer.m.start}$/,
+            method:     :force_start,
+            use_suffix:  false
+
+      # Internal: Start the game by all means.
+      #
+      # m - The recieved Message.
+      #
+      # Returns nothing.
+      def force_start(m)
+        return unless @game && m.user.authname == @initiator.irc_authname
+
+        each_team { |blue, red| begin_game!(m, blue, red) }
+      end
+
+      match /#{I18n.mixer.m.slot}(\+|-)(\s([2-9]|[1-9][0-9]))?$/,
+            method:     :slot_dispatcher,
+            use_suffix:  false
+
+      # Internal: Add or remove slot from the current game.
+      #
+      # m     - The recieved Message.
+      # sign  - The + or - sign, indicates adding on removing a slot
+      #         respectively.
+      # slots - The Integer, reperesenting number of slots to be added or
+      #         removed from the game.
+      #
+      def slot_dispatcher(m, sign, slots)
+        return unless @game && m.user.authname == @initiator.irc_authname
+
+        case sign
+        when '+'
+
+          if slots
+            slots.to_i.times { add_slot }
+            m.reply I18n.mixer.n_slots_added(slots, slots_message)
+          else
+            if @limit >= MIN_SLOTS
+              add_slot
+              m.reply I18n.mixer.slot_added(slots_message)
+            end
+          end
+
+        when '-'
+
+          if slots
+            removed_slots = 0
+            slots.to_i.times { |i|
+              remove_slot
+              removed_slots = i+1
+              break unless @limit > MIN_SLOTS
+            }
+            m.reply I18n.mixer.n_slots_removed(removed_slots, slots_message)
+          else
+            if @limit > MIN_SLOTS
+              remove_slot
+              m.reply I18n.mixer.slot_removed(slots_message)
+            end
+          end
+
+        end
+
+        if ready_to_begin?
+          each_team { |blue, red| begin_game!(m, blue, red) }
+        end
+      end
+
+      match /#{I18n.mixer.m.slots}$/,
+            method:     :slots,
+            use_suffix:  false
+
+      # Internal: Display information about slots of the current game.
+      #
+      # m - The recieved Message.
+      #
+      # Returns nothing.
+      def slots(m)
+        return unless @game
+
+        m.reply I18n.mixer.slot_stats(@game.players.size, @limit)
+      end
+
+      protected
+
+      # Internal: Show all players in the game. Colorize some nicks.
+      #
+      # Returns nothing.
+      def show_players
+        @game.players.map do |gamer|
+          colorize_nick(gamer)
+        end.join ', '
+      end
+
+      # Internal: Colorize the nick of given gamer. Based on role of the gamer.
+      # Golds are yellow, guards are green and normal are untouched.
+      #
+      # nick - The Gamer, which nick should be colorized.
+      #
+      # Returns colorized nick.
+      def colorize_nick(gamer)
+        if gamer[:premium?]
+          case gamer.role
+          when 2
+            Format(:green, gamer.irc_nick)
+          else
+            Format(:yellow, gamer.irc_nick)
+          end
+        else
+          gamer.irc_nick
+        end
+      end
+
+      # Internal: Iterate over each team.
+      #
+      # Yields the Array of the Red team and the Array of the Blue team
+      # respectively.
+      #
+      # Returns nothing.
+      def each_team
+        players = @game.players.shuffle
+
+        blue = players.pop(@limit / 2)
+        red  = players
+
+        yield blue, red
+      end
+
+      # Internal: Send messages with team rosters and destroy game object.
+      #
+      # m    - The recieved Message.
+      # blue - The Array of Blue team.
+      # red  - The Array of Red team.
+      #
+      # Returns nil.
+      def begin_game!(m, blue, red)
+        @timer.stop
+
+        blue = blue.map { |gamer| colorize_nick(gamer) }.join(', ')
+        red  = red.map { |gamer| colorize_nick(gamer) }.join(', ')
+
+        m.reply I18n.mixer.blue_team(blue)
+        m.reply I18n.mixer.red_team(red)
+        m.reply I18n.mixer.glhf
+
+        @game = nil
+      end
+
+      # Internal: Display slots used/overall number information.
+      #
+      # Returns String.
+      def slots_message
+        I18n.mixer.slots_overall(@limit)
+      end
+
+      # Internal: Increments game slot.
+      #
+      # Returns incremented Integer, representing limit.
+      def add_slot
+        @limit += 1
+      end
+
+      # Internal: Decrements game slot.
+      #
+      # Returns decremented Integer, representing limit.
+      def remove_slot
+        @limit -= 1
+      end
+
+      # Internal: Check if the quantity of players reached the limit. If so,
+      # that means, we can say "Let's get ready to rumble!".
+      #
+      # Returns true if the quantity of players, that are in game, equals to the
+      # slot limit or false otherwise.
+      def ready_to_begin?
+        @game.players.size == @limit
+      end
+
+      # Internal: Create a new gamer. Gamers are persons, that want to play mix.
+      #
+      # Returns Gamer object.
+      def create_gamer(m)
+        player = Player.filter(:irc_authname => m.user.authname).first
+
+        Gamer.new(
+          m.user.nick,
+          m.user.authname,
+          player[:premium],
+          player[:role]
+        )
+      end
+
+    end
+  end
+end

data/lib/artaius/version.rb

@@ -0,0 +1,3 @@
+module Artaius
+  VERSION = '0.2.0'
+end

data/spec/lib/artaius/bot_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../../spec_helper'
+
+describe Artaius::Bot do
+  let(:bot) { Artaius::Bot.new }
+
+  describe 'bot IRC configuration' do
+
+    it 'must have correct nick' do
+      bot.config.nick.must_equal 'Artaius'
+    end
+
+    it 'must have correct realname' do
+      bot.config.realname.must_equal 'Artaius Lucius'
+    end
+
+    it 'must have correct username' do
+      bot.config.user.must_equal 'Artaius Lucius'
+    end
+
+    it 'must have correct server to join' do
+      bot.config.server.must_equal 'irc.quakenet.org'
+    end
+
+    it 'must have correct port of a server' do
+      bot.config.port.must_equal 6667
+    end
+
+    it 'must have correct channels to join' do
+      bot.config.channels.must_equal %w{ #kag2d.ru }
+    end
+
+    describe 'plugins' do
+
+      describe 'identify plugin' do
+        it 'must contain identify' do
+          bot.config.plugins.plugins.must_include Artaius::Plugins::Identify
+        end
+
+        it 'must have correct username option' do
+          bot.config.plugins
+          .options[Artaius::Plugins::Identify][:username].must_equal 'Artaius'
+        end
+
+        it 'must have password option' do
+          bot.config.plugins
+          .options[Artaius::Plugins::Identify][:password]
+          .must_be_instance_of String
+        end
+      end
+
+    end # plugins
+
+  end
+end

data/spec/lib/artaius/plugins/archivarius_spec.rb

@@ -0,0 +1,59 @@
+require_relative '../../../spec_helper'
+
+describe Artaius::Plugins::Archivarius do
+
+  Archivarius = Artaius::Plugins::Archivarius
+
+  it 'must include required modules' do
+    Archivarius.must_include Cinch::Plugin
+  end
+
+  it "must use correct plugin's name" do
+    Archivarius.plugin_name.must_equal 'archivarius'
+  end
+
+  it 'must react on private messages' do
+    Archivarius.react_on.must_equal :private
+  end
+
+  describe 'matchers' do
+    let(:reg) { Archivarius.matchers.find { |m| m.method == :sign_up } }
+
+    it 'must have correct number of matchers' do
+      Archivarius.matchers.size.must_equal 1
+    end
+
+    describe 'reg matcher' do
+      it 'must exist' do
+        reg.wont_be_nil
+      end
+
+      it 'must match the pattern' do
+        reg.pattern.must_match 'reg lol'
+        reg.pattern.must_match 'reg nick'
+        reg.pattern.must_match 'reg nickname'
+        reg.pattern.must_match 'reg awesomenick'
+        reg.pattern.must_match 'reg 10nicks'
+        reg.pattern.must_match 'reg nicks10'
+        reg.pattern.must_match 'reg ni10cks'
+        reg.pattern.must_match 'reg yadda_yadda'
+        reg.pattern.must_match 'reg IaMiDiOt'
+
+        reg.pattern.wont_match 'reg  blah'
+        reg.pattern.wont_match 'reg me'
+        reg.pattern.wont_match 'reg i'
+        reg.pattern.wont_match 'reg averylongnicknamereally'
+        reg.pattern.wont_match 'reg supernick '
+        reg.pattern.wont_match 'reg fancy 10'
+        reg.pattern.wont_match 'reg ps[E]udo_player'
+        reg.pattern.wont_match "reg don'ttellmymother"
+        reg.pattern.wont_match 'reg yadda-yadda'
+      end
+
+      it 'does not have suffix' do
+        reg.suffix.must_be_nil
+      end
+    end
+
+  end
+end