ssc.bot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73c3de3d7f455e1f201f7285cc76d06a6213b6690566b7875d8770b32b0b7131
-  data.tar.gz: f9c4976dfab3bbb38fa5e5d92d4869c6dd9556b36650b90790fa6efa505d389f
+  metadata.gz: d1468b04f2b3b2b2e388b2ab044ad52e8bf55d53343d4ff75d2dd56c9387b843
+  data.tar.gz: f8ccc21500f7b394f3be858c24d59c18c453a333da03be6265e59a6224897ba0
 SHA512:
-  metadata.gz: d602f331f66f4361ed911320b58eeb485a144cc1b12ea921f585a6e9a0a817d1f9fd9780f4512479a4a8e55e13ec8314e9bb77ab250c2dde982881ca01fa4c25
-  data.tar.gz: bed3804f7a441d25e0ec622c1998f181dc18ebe7452d66f8c9dc59d5cd58a7b5194e5a11978ba086d7ca4e71ffc0dd066724129b8b569ca1677059d1a760c960
+  metadata.gz: 2fb0d8ed2cd691b5a40de2a103bcb3c050da49a4993e76bcd5a2b22e3fd8edf431e9de1be271bc71abadc28218721fc0fb8f1e30127743c08bc782e25b49b790
+  data.tar.gz: e0d5ad76f4ee548a4b6e5e191534badb10ef39e44644179a910e05b71b325963bed96b9892c82b25606ee78ff45dd32cac35ea247288225bd6f0bd6b7be40bc3

data/CHANGELOG.md

@@ -3,12 +3,31 @@
 All notable changes to this project will be documented in this file.
 
 Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
 
-## [[Unreleased]](https://github.com/esotericpig/ssc.bot/compare/v0.1.0...HEAD)
+## [[Unreleased]](https://github.com/esotericpig/ssc.bot/compare/v0.1.1...HEAD)
 -
 
+## [v0.1.1] - [2020-09-09](https://github.com/esotericpig/ssc.bot/compare/v0.1.0...v0.1.1)
+
+### Added
+- `ChatLog::Message`
+    - `type_<type>?()` for all `TYPES`
+        - `msg.type_chat?(); msg.type_pub?(); msg.type_q_log?()`
+    - `self.add_type(type)`
+
+### Changed
+- `ChatLog::MessageParser`
+    - Refactored & formatted code
+    - Added warn message to `parse_q_namelen` if namelen > max
+
+### Fixed
+- `Util.u_blank?(str)`
+
 ## [v0.1.0] - [2020-08-29](https://github.com/esotericpig/ssc.bot/tree/v0.1.0)
+
+First working version.
+
 ### Added
 - /
     - .gitignore

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

@@ -33,24 +33,44 @@ class ChatLog
   # @since  0.1.0
   ###
   class Message
+    # 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()
+      
+      return if TYPES.include?(type)
+      
+      TYPES.add(type)
+      
+      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::TYPES.add(:custom)
-    TYPES = Set[
-      # In order of F1 Help box.
-      *%i{
-        pub team private remote freq chat
-        ?lines ?namelen ?ignore ?nopubchat ?obscene ?away ?log ?logbuffer
-          ?kill kill ?enter enter ?leave leave ?message ?messages ?chat
-        ?status ?scorereset ?team ?spec ?target ?time ?flags ?score ?crown
-          ?best ?buy
-        ?owner ?password ?usage ?userid ?find ?ping ?packetloss ?lag ?music
-          ?sound ?alarm ?sheep ?getnews
-        ?squadowner ?squad ?squadlist ?loadmacro ?savemacro
-        unknown
-      },
-    ]
+    #   SSCBot::ChatLog::Message.add_type(:custom)
+    TYPES = Set.new()
+    
+    # In order of F1 Help box.
+    %i{
+      pub team private remote freq chat
+      ?lines ?namelen ?ignore ?nopubchat ?obscene ?away ?log ?logbuffer
+        ?kill kill ?enter enter ?leave leave ?message ?messages ?chat
+      ?status ?scorereset ?team ?spec ?target ?time ?flags ?score ?crown
+        ?best ?buy
+      ?owner ?password ?usage ?userid ?find ?ping ?packetloss ?lag ?music
+        ?sound ?alarm ?sheep ?getnews
+      ?squadowner ?squad ?squadlist ?loadmacro ?savemacro
+      unknown
+    }.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+

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

@@ -75,42 +75,32 @@ class ChatLog
         @regex_cache[type_name] = cached_regex
       end
       
-      if use_namelen && !@namelen.nil?()
-        regex = cached_regex[@namelen]
+      use_namelen &&= !@namelen.nil?()
+      key = use_namelen ? @namelen : :no_namelen
+      regex = cached_regex[key]
+      
+      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 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)
-          
-          # Be careful to not use spaces ' ', but to use '\\ ' (or '\s') instead
-          # because of the '/x' option.
-          regex = /
-            \A#{type_prefix}
-            #{name_prefix}(?<name>.{#{@namelen}})#{name_suffix}
-            (?<message>.*)\z
-          /x
-          
-          cached_regex[@namelen] = regex
+        if use_namelen
+          name = /.{#{@namelen}}/
+        else
+          name = /.*?\S/
         end
-      else
-        regex = cached_regex[:no_namelen]
         
-        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)
-          
-          # Be careful to not use spaces ' ', but to use '\\ ' (or '\s') instead
-          # because of the '/x' option.
-          regex = /
-            \A#{type_prefix}
-            #{name_prefix}(?<name>.*?\S)#{name_suffix}
-            (?<message>.*)\z
-          /x
-          
-          cached_regex[:no_namelen] = regex
-        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 = /
+          \A#{type_prefix}
+          #{name_prefix}(?<name>#{name})#{name_suffix}
+          (?<message>.*)\z
+        /x
+        
+        cached_regex[key] = regex
       end
       
       return regex.match(line)
@@ -263,7 +253,7 @@ class ChatLog
       cmd = Util.u_strip(player.message).downcase()
       
       if cmd.start_with?('?find')
-        store_command(:pub,%s{?find})
+        store_command(:pub,%s{?find}) # See: match_q_find?()
       end
       
       return PubMessage.new(line,name: player.name,message: player.message)
@@ -353,6 +343,8 @@ class ChatLog
         else
           return nil
         end
+      elsif namelen > MAX_NAMELEN
+        warn("namelen{#{namelen}} > max{#{MAX_NAMELEN}} for ?namelen message{#{line}}",uplevel: 0)
       end
       
       if @autoset_namelen
@@ -367,7 +359,7 @@ class ChatLog
     #   'P :Self.Name:Message'
     #   'P (Name)>Message'
     def parse_remote(line,match:)
-      player = parse_player(line,type_name: 'remote private',match: match)
+      player = parse_player(line,type_name: %s{remote.private},match: match)
       
       return nil if player.nil?()
       
@@ -468,31 +460,20 @@ class ChatLog
       
       if line.start_with?('  Not online, last seen ')
         match = line.match(/(?<more>more) than (?<days>\d+) days ago\z/)
-        
-        if match.nil?()
-          match = line.match(/(?<days>\d+) days? ago\z/)
-        end
-        
-        if match.nil?()
-          match = line.match(/(?<hours>\d+) hours? ago\z/)
-        end
+        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/)
-        
-        if match.nil?()
-          match = line.match(/\A  (?<player>.+) - (?<arena>.+)\z/)
-        end
+        match = line.match(/\A  (?<player>.+) - (?<arena>.+)\z/) if match.nil?()
         
         if match
           caps = match.named_captures
           
           player = caps['player']
           
-          if player.length > MAX_NAMELEN
-            return false
-          end
+          return false if player.length > MAX_NAMELEN
           
           if caps.key?('arena')
             area = caps['arena']
@@ -502,6 +483,8 @@ class ChatLog
             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|
             if c =~ /[[:space:]]/
               return false
@@ -522,10 +505,7 @@ class ChatLog
       return false if line.length < 17
       
       match = /\A  Log file open: (?<filename>.+)\z/.match(line)
-      
-      if match.nil?()
-        match = /\A  Log file closed\z/.match(line)
-      end
+      match = /\A  Log file closed\z/.match(line) if match.nil?()
       
       return match
     end

data/lib/ssc.bot/util.rb

@@ -66,7 +66,7 @@ module SSCBot
     
     # Universally, is +str+ empty after stripping or +nil+?
     def self.u_blank?(str)
-      return str.nil?() || strip(str).empty?()
+      return str.nil?() || u_strip(str).empty?()
     end
     
     # Universally, left strip +str+'s leading (head) space.

data/lib/ssc.bot/version.rb

@@ -22,5 +22,5 @@
 
 
 module SSCBot
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssc.bot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-29 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_bool