ssc.bot 0.1.1 → 0.2.0

data/lib/ssc.bot/chat_log/message.rb

@@ -1,64 +1,54 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of SSC.Bot.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# SSC.Bot is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# SSC.Bot is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
+require 'attr_bool'
 require 'set'
 
-
 module SSCBot
 class ChatLog
   ###
   # The base class of all parsed messages from a chat log file.
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class Message
+    extend AttrBool::Ext
+
     # Adds +type+ to the list of valid {TYPES}
     # and creates a boolean method for it ending with a +?+.
-    # 
+    #
     # @param type [Symbol,String] the new type to add
     def self.add_type(type)
-      type = type.to_sym()
-      
+      type = type.to_sym
+
       return if TYPES.include?(type)
-      
+
       TYPES.add(type)
-      
-      name = type.to_s().sub('?','q_')
-      
+
+      name = type.to_s.sub('?','q_')
+
       define_method(:"type_#{name}?") do
         return @type == type
       end
     end
-    
+
     # Valid types of messages.
-    # 
+    #
     # You can add your own custom type(s) that you parse manually:
     #   SSCBot::ChatLog::Message.add_type(:custom)
-    TYPES = Set.new()
-    
+    TYPES = Set.new
+
     # In order of F1 Help box.
-    %i{
+    %i[
       pub team private remote freq chat
       ?lines ?namelen ?ignore ?nopubchat ?obscene ?away ?log ?logbuffer
         ?kill kill ?enter enter ?leave leave ?message ?messages ?chat
@@ -68,38 +58,38 @@ class ChatLog
         ?sound ?alarm ?sheep ?getnews
       ?squadowner ?squad ?squadlist ?loadmacro ?savemacro
       unknown
-    }.each() do |type|
+    ].each do |type|
       add_type(type)
     end
-    
+
     # @param  type [Symbol] the type to check if valid
     # @return [Boolean] +true+ if +type+ is one of {TYPES}, else +false+
     def self.valid_type?(type)
       return TYPES.include?(type)
     end
-    
+
     attr_reader :line # @return [String] the raw (unparsed) line from the file
     attr_reader :type # @return [Symbol] what type of message this is; one of {TYPES}
-    
+
     # @param line [String] the raw (unparsed) line from the file
     # @param type [Symbol] what type of message this is; must be one of {TYPES}
     def initialize(line,type:)
-      type = type.to_sym()
-      
-      raise ArgumentError,"invalid line{#{line.inspect()}}" if line.nil?()
-      raise ArgumentError,"invalid type{#{type.inspect()}}" if !self.class.valid_type?(type)
-      
+      type = type.to_sym
+
+      raise ArgumentError,"invalid line{#{line.inspect}}" if line.nil?
+      raise ArgumentError,"invalid type{#{type.inspect}}" if !self.class.valid_type?(type)
+
       @line = line
       @type = type
     end
-    
+
     # A convenience method for comparing anything that responds to
     # +:to_sym():+, like +String+.
-    # 
+    #
     # @param  type [String,Symbol] the type to convert & compare against
     # @return [Boolean] +true+ if this message is of type +type+, else +false+
     def type?(type)
-      return @type == type.to_sym()
+      return @type == type.to_sym
     end
   end
 end

data/lib/ssc.bot/chat_log/message_parsable.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of SSC.Bot.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# SSC.Bot is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# SSC.Bot is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -25,38 +13,26 @@ require 'forwardable'
 
 require 'ssc.bot/chat_log/message_parser'
 
-
 module SSCBot
 class ChatLog
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   module MessageParsable
     extend Forwardable
-    
+
     MAX_NAMELEN = MessageParser::MAX_NAMELEN
-    
-    def_delegators(:@parser,
-      :autoset_namelen?,:autoset_namelen=,
-      :check_history_count,:check_history_count=,
-      :commands,
-      :messages,
-      :namelen,:namelen=,
-      :regex_cache,
-      :store_history?,:store_history=,
-      :strict?,:strict=,
-      
-      :parse,
-      
-      :clear_history,
-      :reset_namelen,
-      :store_command,
-      
-      :command?,
-    )
-    
+
     attr_reader :parser
+
+    (MessageParser.public_instance_methods - Class.public_instance_methods).each do |method|
+      name = method.to_s
+
+      next if name.start_with?('match_') || name.start_with?('parse_')
+
+      def_delegator(:@parser,method)
+    end
   end
 end
 end

data/lib/ssc.bot/chat_log/message_parser.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of SSC.Bot.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# SSC.Bot is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# SSC.Bot is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -30,16 +18,17 @@ require 'ssc.bot/util'
 require 'ssc.bot/chat_log/message'
 require 'ssc.bot/chat_log/messages'
 
-
 module SSCBot
 class ChatLog
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class MessageParser
+    extend AttrBool::Ext
+
     MAX_NAMELEN = 24
-    
+
     attr_accessor? :autoset_namelen
     attr_accessor :check_history_count
     attr_reader :commands
@@ -48,10 +37,10 @@ class ChatLog
     attr_reader :regex_cache
     attr_accessor? :store_history
     attr_accessor? :strict
-    
+
     def initialize(autoset_namelen: true,check_history_count: 5,namelen: nil,store_history: true,strict: true)
       super()
-      
+
       @autoset_namelen = autoset_namelen
       @check_history_count = check_history_count
       @commands = {}
@@ -61,37 +50,37 @@ class ChatLog
       @store_history = store_history
       @strict = strict
     end
-    
+
     # The Ruby interpreter should cache the args' default values,
     # so no reason to manually cache them unless a variable is involved inside.
-    # 
+    #
     # @example Default Format
     #   'X Name> Message'
-    def match_player(line,type_name:,name_prefix: '',name_suffix: '> ',type_prefix: %r{..},use_namelen: true)
+    def match_player(line,type_name:,name_prefix: '',name_suffix: '> ',type_prefix: /../,use_namelen: true)
       cached_regex = @regex_cache[type_name]
-      
-      if cached_regex.nil?()
+
+      if cached_regex.nil?
         cached_regex = {}
         @regex_cache[type_name] = cached_regex
       end
-      
-      use_namelen &&= !@namelen.nil?()
+
+      use_namelen &&= !@namelen.nil?
       key = use_namelen ? @namelen : :no_namelen
       regex = cached_regex[key]
-      
-      if regex.nil?()
+
+      if regex.nil?
         name_prefix = Util.quote_str_or_regex(name_prefix)
         name_suffix = Util.quote_str_or_regex(name_suffix)
         type_prefix = Util.quote_str_or_regex(type_prefix)
-        
+
         if use_namelen
           name = /.{#{@namelen}}/
         else
           name = /.*?\S/
         end
-        
+
         name = Util.quote_str_or_regex(name)
-        
+
         # Be careful to not use spaces ' ', but to use '\\ ' (or '\s') instead
         #   because of the '/x' option.
         regex = /
@@ -99,25 +88,25 @@ class ChatLog
           #{name_prefix}(?<name>#{name})#{name_suffix}
           (?<message>.*)\z
         /x
-        
+
         cached_regex[key] = regex
       end
-      
+
       return regex.match(line)
     end
-    
+
     def parse(line)
-      if line.nil?()
+      if line.nil?
         if @strict
-          raise ArgumentError,"invalid line{#{line.inspect()}}"
+          raise ArgumentError,"invalid line{#{line.inspect}}"
         else
           line = ''
         end
       end
-      
+
       message = nil
-      
-      if !line.empty?()
+
+      if !line.empty?
         case line[0]
         when 'C'
           message = parse_chat(line)
@@ -151,64 +140,64 @@ class ChatLog
           end
         end
       end
-      
-      if message.nil?()
+
+      if message.nil?
         message = Message.new(line,type: :unknown)
       end
-      
+
       if @store_history
         @messages << message
       end
-      
+
       return message
     end
-    
+
     # @example Format
     #   # NOT affected by namelen.
     #   'C 1:Name> Message'
     def parse_chat(line)
-      match = match_player(line,type_name: :chat,name_prefix: %r{(?<channel>\d+)\:},use_namelen: false)
+      match = match_player(line,type_name: :chat,name_prefix: /(?<channel>\d+)\:/,use_namelen: false)
       player = parse_player(line,type_name: :chat,match: match)
-      
-      return nil if player.nil?()
-      
-      channel = match[:channel].to_i()
-      
+
+      return nil if player.nil?
+
+      channel = match[:channel].to_i
+
       return ChatMessage.new(line,channel: channel,name: player.name,message: player.message)
     end
-    
+
     # @example Format
     #   'E Name> Message'
     def parse_freq(line)
       player = parse_player(line,type_name: :freq)
-      
-      return nil if player.nil?()
-      
+
+      return nil if player.nil?
+
       return FreqMessage.new(line,name: player.name,message: player.message)
     end
-    
+
     # @example Format
     #   '  Killed.Name(100) killed by: Killer.Name'
     def parse_kill(line,match:)
-      if match.nil?()
+      if match.nil?
         if @strict
           raise ParseError,"invalid kill message{#{line}}"
         else
           return nil
         end
       end
-      
+
       killed = match[:killed]
-      bounty = match[:bounty].to_i()
+      bounty = match[:bounty].to_i
       killer = match[:killer]
-      
+
       return KillMessage.new(line,killed: killed,bounty: bounty,killer: killer)
     end
-    
+
     # @example Default Format
     #   'X Name> Message'
     def parse_player(line,type_name:,match: :default)
-      if match.nil?()
+      if match.nil?
         if @strict
           raise ParseError,"invalid #{type_name} message{#{line}}"
         else
@@ -218,47 +207,47 @@ class ChatLog
         # Use type_name of :player (not passed in param) for regex_cache.
         match = match_player(line,type_name: :player)
       end
-      
+
       name = Util.u_lstrip(match[:name])
       message = match[:message]
-      
-      if name.empty?() || name.length > MAX_NAMELEN
+
+      if name.empty? || name.length > MAX_NAMELEN
         if @strict
           raise ParseError,"invalid player name for #{type_name} message{#{line}}"
         else
           return nil
         end
       end
-      
+
       return PlayerMessage.new(line,type: :unknown,name: name,message: message)
     end
-    
+
     # @example Format
     #   'P Name> Message'
     def parse_private(line)
       player = parse_player(line,type_name: :private)
-      
-      return nil if player.nil?()
-      
+
+      return nil if player.nil?
+
       return PrivateMessage.new(line,name: player.name,message: player.message)
     end
-    
+
     # @example Format
     #   '  Name> Message'
     def parse_pub(line,match:)
       player = parse_player(line,type_name: :pub,match: match)
-      
-      return nil if player.nil?()
-      
-      cmd = Util.u_strip(player.message).downcase()
-      
+
+      return nil if player.nil?
+
+      cmd = Util.u_strip(player.message).downcase
+
       if cmd.start_with?('?find')
-        store_command(:pub,%s{?find}) # See: match_q_find?()
+        store_command(:pub,%s(?find)) # See: match_q_find?()
       end
-      
+
       return PubMessage.new(line,name: player.name,message: player.message)
     end
-    
+
     # @example Format
     #   '  Not online, last seen more than 10 days ago'
     #   '  Not online, last seen 9 days ago'
@@ -269,74 +258,74 @@ class ChatLog
     #   '  Name is in SSCJ Devastation'
     #   '  Name is in SSCC Metal Gear CTF'
     def parse_q_find(line,match:)
-      if match.nil?()
+      if match.nil?
         if @strict
           raise ParseError,"invalid ?find message{#{line}}"
         else
           return nil
         end
       end
-      
+
       caps = match.named_captures
       q_find = nil
-      
+
       if (days = caps['days'])
         more = caps.key?('more')
-        days = days.to_i()
-        
+        days = days.to_i
+
         q_find = QFindMessage.new(line,find_type: :days,more: more,days: days)
       elsif (hours = caps['hours'])
-        hours = hours.to_i()
-        
+        hours = hours.to_i
+
         q_find = QFindMessage.new(line,find_type: :hours,hours: hours)
       elsif (player = caps['player'])
         if (arena = caps['arena'])
           private = (arena == '(Private arena)')
-          
+
           q_find = QFindMessage.new(line,find_type: :arena,player: player,arena: arena,private: private)
         elsif (zone = caps['zone'])
           q_find = QFindMessage.new(line,find_type: :zone,player: player,zone: zone)
         end
       end
-      
-      if q_find.nil?() && @strict
+
+      if q_find.nil? && @strict
         raise ParseError,"invalid ?find message{#{line}}"
       end
-      
+
       return q_find
     end
-    
+
     # @example Format
     #   '  Log file open: session.log'
     #   '  Log file closed'
     def parse_q_log(line,match:)
-      if match.nil?()
+      if match.nil?
         if @strict
           raise ParseError,"invalid ?log message{#{line}}"
         else
           return nil
         end
       end
-      
+
       filename = match.named_captures['filename']
-      log_type = filename.nil?() ? :close : :open
-      
+      log_type = filename.nil? ? :close : :open
+
       return QLogMessage.new(line,log_type: log_type,filename: filename)
     end
-    
+
     # @example Format
     #   '  Message Name Length: 24'
     def parse_q_namelen(line,match:)
-      if match.nil?()
+      if match.nil?
         if @strict
           raise ParseError,"invalid ?namelen message{#{line}}"
         else
           return nil
         end
       end
-      
-      namelen = match[:namelen].to_i()
-      
+
+      namelen = match[:namelen].to_i
+
       if namelen < 1
         if @strict
           raise ParseError,"invalid namelen for ?namelen message{#{line}}"
@@ -346,105 +335,105 @@ class ChatLog
       elsif namelen > MAX_NAMELEN
         warn("namelen{#{namelen}} > max{#{MAX_NAMELEN}} for ?namelen message{#{line}}",uplevel: 0)
       end
-      
+
       if @autoset_namelen
         @namelen = namelen
       end
-      
+
       return QNamelenMessage.new(line,namelen: namelen)
     end
-    
+
     # @example Format
     #   # NOT affected by namelen.
     #   'P :Self.Name:Message'
     #   'P (Name)>Message'
     def parse_remote(line,match:)
-      player = parse_player(line,type_name: %s{remote.private},match: match)
-      
-      return nil if player.nil?()
-      
+      player = parse_player(line,type_name: %s(remote.private),match: match)
+
+      return nil if player.nil?
+
       own = (line[2] == ':')
       squad = (player.name[0] == '#')
-      
+
       return RemoteMessage.new(line,
         own: own,squad: squad,
         name: player.name,message: player.message,
       )
     end
-    
+
     # @example Format
     #   'T Name> Message'
     def parse_team(line)
       player = parse_player(line,type_name: :team)
-      
-      return nil if player.nil?()
-      
+
+      return nil if player.nil?
+
       return TeamMessage.new(line,name: player.name,message: player.message)
     end
-    
-    def clear_history()
-      @messages.clear()
+
+    def clear_history
+      @messages.clear
     end
-    
-    def reset_namelen()
+
+    def reset_namelen
       @namelen = nil
     end
-    
+
     def store_command(type,name)
       type_hash = @commands[type]
-      
-      if type_hash.nil?()
+
+      if type_hash.nil?
         type_hash = {}
         @commands[type] = type_hash
       end
-      
+
       type_hash[name] = @messages.length # Index of when command was found/stored
     end
-    
+
     def command?(type,name,delete: true)
       return true if @check_history_count < 1
-      
+
       type_hash = @commands[type]
-      
-      if !type_hash.nil?()
+
+      if !type_hash.nil?
         index = type_hash[name]
-        
-        if !index.nil?() && (@messages.length - index) <= @check_history_count
+
+        if !index.nil? && (@messages.length - index) <= @check_history_count
           type_hash.delete(name) if delete
-          
+
           return true
         end
       end
-      
+
       return false
     end
-    
+
     # @example Format
     #   '  Killed.Name(100) killed by: Killer.Name'
     def match_kill?(line)
       return false if line.length < 19 # '  N(0) killed by: N'
-      
+
       return /\A  (?<killed>.*?\S)\((?<bounty>\d+)\) killed by: (?<killer>.*?\S)\z/.match(line)
     end
-    
+
     # @example Format
     #   '  Name> Message'
     def match_pub?(line)
       return false if line.length < 5 # '  N> '
-      
+
       match = match_player(line,type_name: :pub,type_prefix: '  ')
-      
-      if !match.nil?()
+
+      if !match.nil?
         name = Util.u_lstrip(match[:name])
-        
-        if name.empty?() || name.length > MAX_NAMELEN
+
+        if name.empty? || name.length > MAX_NAMELEN
           return false
         end
       end
-      
+
       return match
     end
-    
+
     # @example Format
     #   '  Not online, last seen more than 10 days ago'
     #   '  Not online, last seen 9 days ago'
@@ -456,25 +445,25 @@ class ChatLog
     #   '  Name is in SSCC Metal Gear CTF'
     def match_q_find?(line)
       return false if line.length < 7 # '  N - A'
-      return false unless command?(:pub,%s{?find})
-      
+      return false unless command?(:pub,%s(?find))
+
       if line.start_with?('  Not online, last seen ')
         match = line.match(/(?<more>more) than (?<days>\d+) days ago\z/)
-        match = line.match(/(?<days>\d+) days? ago\z/) if match.nil?()
-        match = line.match(/(?<hours>\d+) hours? ago\z/) if match.nil?()
-        
+        match = line.match(/(?<days>\d+) days? ago\z/) if match.nil?
+        match = line.match(/(?<hours>\d+) hours? ago\z/) if match.nil?
+
         return match
       else
         match = line.match(/\A  (?<player>.+) is in (?<zone>.+)\z/)
-        match = line.match(/\A  (?<player>.+) - (?<arena>.+)\z/) if match.nil?()
-        
+        match = line.match(/\A  (?<player>.+) - (?<arena>.+)\z/) if match.nil?
+
         if match
           caps = match.named_captures
-          
+
           player = caps['player']
-          
+
           return false if player.length > MAX_NAMELEN
-          
+
           if caps.key?('arena')
             area = caps['arena']
           elsif caps.key?('zone')
@@ -482,59 +471,59 @@ class ChatLog
           else
             return false
           end
-          
+
           # If do /\A  (?<player>[^[[:space:]]].+[^[[:space:]])/, then it won't
           #   capture names/zones/arenas that are only 1 char long, so do this.
-          [player[0],player[-1],area[0],area[-1]].each() do |c|
+          [player[0],player[-1],area[0],area[-1]].each do |c|
             if c =~ /[[:space:]]/
               return false
             end
           end
-          
+
           return match
         end
       end
-      
+
       return false
     end
-    
+
     # @example Format
     #   '  Log file open: session.log'
     #   '  Log file closed'
     def match_q_log?(line)
       return false if line.length < 17
-      
+
       match = /\A  Log file open: (?<filename>.+)\z/.match(line)
-      match = /\A  Log file closed\z/.match(line) if match.nil?()
-      
+      match = /\A  Log file closed\z/.match(line) if match.nil?
+
       return match
     end
-    
+
     # @example Format
     #   '  Message Name Length: 24'
     def match_q_namelen?(line)
       return false if line.length < 24 # '...: 0'
       return false if line[21] != ':'
-      
+
       return /\A  Message Name Length: (?<namelen>\d+)\z/.match(line)
     end
-    
+
     # @example Format
     #   # NOT affected by namelen.
     #   'P :Self.Name:Message'
     #   'P (Name)>Message'
     def match_remote?(line)
       return false if line.length < 5 # 'P :N:'
-      
+
       case line[2]
       when ':'
-        return match_player(line,type_name: %s{remote.out},
+        return match_player(line,type_name: %s(remote.out),
           name_prefix: ':',name_suffix: ':',use_namelen: false)
       when '('
-        return match_player(line,type_name: %s{remote.in},
+        return match_player(line,type_name: %s(remote.in),
           name_prefix: '(',name_suffix: ')>',use_namelen: false)
       end
-      
+
       return false
     end
   end