ssc.bot 0.1.1 → 0.2.0

data/lib/ssc.bot/chat_log/messages.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,41 +13,40 @@ require 'attr_bool'
 
 require 'ssc.bot/chat_log/message'
 
-
 module SSCBot
 class ChatLog
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class PlayerMessage < Message
     attr_reader :message
     attr_reader :name
-    
+
     def initialize(line,type:,name:,message:)
       super(line,type: type)
-      
+
       @message = message
       @name = name
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class ChatMessage < PlayerMessage
     attr_reader :channel
-    
+
     def initialize(line,channel:,name:,message:)
       super(line,type: :chat,name: name,message: message)
-      
+
       @channel = channel
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class FreqMessage < PlayerMessage
@@ -67,27 +54,27 @@ class ChatLog
       super(line,type: :freq,name: name,message: message)
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class KillMessage < Message
     attr_reader :bounty
     attr_reader :killed
     attr_reader :killer
-    
+
     def initialize(line,killed:,bounty:,killer:)
       super(line,type: :kill)
-      
+
       @bounty = bounty
       @killed = killed
       @killer = killer
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class PrivateMessage < PlayerMessage
@@ -95,9 +82,9 @@ class ChatLog
       super(line,type: type,name: name,message: message)
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class PubMessage < PlayerMessage
@@ -105,9 +92,9 @@ class ChatLog
       super(line,type: :pub,name: name,message: message)
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class QFindMessage < Message
@@ -119,10 +106,11 @@ class ChatLog
     attr_reader :player
     attr_reader? :private
     attr_reader :zone
-    
-    def initialize(line,find_type:,arena: nil,days: nil,hours: nil,more: false,player: nil,private: false,zone: nil)
-      super(line,type: %s{?find})
-      
+
+    def initialize(line,find_type:,arena: nil,days: nil,hours: nil,more: false,player: nil,private: false,
+                   zone: nil)
+      super(line,type: %s(?find))
+
       @arena = arena
       @days = days
       @find_type = find_type
@@ -133,55 +121,55 @@ class ChatLog
       @zone = zone
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class QLogMessage < Message
     attr_reader :filename
     attr_reader :log_type # [:open,:close]
-    
+
     def initialize(line,log_type:,filename: nil)
-      super(line,type: %s{?log})
-      
+      super(line,type: %s(?log))
+
       @filename = filename
       @log_type = log_type
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class QNamelenMessage < Message
     attr_reader :namelen
-    
+
     def initialize(line,namelen:)
-      super(line,type: %s{?namelen})
-      
+      super(line,type: %s(?namelen))
+
       @namelen = namelen
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class RemoteMessage < PrivateMessage
     attr_reader? :own
     attr_reader? :squad
-    
+
     def initialize(line,own:,squad:,name:,message:)
       super(line,type: :remote,name: name,message: message)
-      
+
       @own = own
       @squad = squad
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class TeamMessage < PlayerMessage

data/lib/ssc.bot/chat_log_file.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
 #++
 
 
@@ -28,25 +16,24 @@ require 'ssc.bot/chat_log/message_parsable'
 require 'ssc.bot/chat_log/message_parser'
 require 'ssc.bot/chat_log/messages'
 
-
 module SSCBot
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class ChatLogFile < SSCFile
     include ChatLog::MessageParsable
-    
-    def initialize(filename,mode=DEFAULT_MODE,parser: ChatLog::MessageParser.new(),**file_kargs)
+
+    def initialize(filename,mode=DEFAULT_MODE,parser: ChatLog::MessageParser.new,**file_kargs)
       super(filename,mode,**file_kargs)
-      
+
       @parser = parser
     end
-    
-    def parse_line()
-      line = get_line()
-      
-      return line.nil?() ? nil : parse(line)
+
+    def parse_line
+      line = read_uline
+
+      return line.nil? ? nil : parse(line)
     end
   end
 end

data/lib/ssc.bot/clu.rb

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+
+require 'forwardable'
+
+require 'ssc.bot/chat_log'
+require 'ssc.bot/user'
+
+module SSCBot
+  ###
+  # Chat Log + User
+  #
+  # @author Jonathan Bradley Whited
+  # @since  0.1.2
+  ###
+  class Clu
+    include Forwardable
+
+    attr_reader :bots
+    attr_reader :chat_log
+    attr_reader :msg_sender
+
+    def initialize(chat_log,msg_sender)
+      super()
+
+      @bots = {}
+      @chat_log = chat_log
+      @msg_sender = msg_sender
+
+      def_delegators(:@bots,:[])
+      def_delegator(:@bots,:key?,:bot?)
+      def_delegators(:@chat_log,*(@chat_log.public_methods - public_methods))
+      def_delegators(:@msg_sender,*(@msg_sender.public_methods - public_methods))
+    end
+
+    def add_bot(bot_class)
+      bot = @bots[bot_class]
+
+      if bot.nil?
+        bot = bot_class.new(self)
+        @bots[bot_class] = bot
+      end
+
+      return bot
+    end
+  end
+end

data/lib/ssc.bot/error.rb

@@ -1,59 +1,37 @@
-#!/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
 #++
 
 
 module SSCBot
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class Error < ::StandardError; end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class AbstractMethodError < Error
     def initialize(msg=nil)
-      if msg.nil?()
-        method_name = caller[1]
-        
-        if !method_name.nil?()
-          index = method_name.rindex('`')
-          
-          if !index.nil?() && (index += 1) < method_name.length
-            method_name = method_name[index..-2]
-            
-            msg = "abstract method{#{method_name}(...)} not implemented"
-          end
-        end
+      if msg.is_a?(Symbol)
+        msg = "abstract method not implemented: #{msg}(...)"
       end
-      
+
       super(msg)
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class ParseError < Error

data/lib/ssc.bot/jruby.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+
+begin
+  require 'java'
+rescue LoadError => e
+  raise e.exception('Must use JRuby for Java-related files')
+end
+
+require 'ssc.bot/user/jrobot_message_sender'
+
+module SSCBot
+  ###
+  # Require this file to include all JRuby (Java-related) files.
+  # Must be using JRuby.
+  #   require 'ssc.bot/jruby'
+  #
+  # @author Jonathan Bradley Whited
+  # @since  0.1.2
+  ###
+  module JRuby
+  end
+end

data/lib/ssc.bot/ssc_file.rb

@@ -1,131 +1,120 @@
-#!/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 'ssc.bot/util'
 
-
 module SSCBot
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class SSCFile < ::File
     DEFAULT_BUFFER_LEN = 520
     DEFAULT_ENCODING = 'Windows-1252:UTF-8'
     DEFAULT_MODE = 'rt'
-    DEFAULT_SEPARATOR = /\r?\n|\r/ # Instead, could use +/\R/+ for Ruby v2.0+
-    
+    DEFAULT_SEPARATOR = /\r?\n|\r/.freeze # Instead, could use +/\R/+ for Ruby v2.0+.
+
     # Clear (truncate) the contents of +filename+.
-    # 
+    #
     # @param filename [String] the file to clear
     # @param strip [Boolean] +true+ to strip +filename+ to help prevent fat-fingering, else +false+ to not
     def self.clear_content(filename,strip: true,textmode: true,**opt)
       filename = Util.u_strip(filename) if strip
-      
-      return if filename.empty?()
-      return if !File.file?(filename) # Also checks if exists
-      
+
+      return if filename.empty?
+      return unless File.file?(filename) # Also checks if exists.
+
       # Clear the file.
       # - Do NOT call truncate() as it's not available on all platforms.
-      open(filename,'w',textmode: textmode,**opt) do |file|
+      self.open(filename,'w',textmode: textmode,**opt) do |file|
       end
     end
-    
+
     # If +filename+ exists, then it does nothing (does *not* update time),
     # else, it creates the file.
-    # 
+    #
     # I just prefer this over +FileUtils.touch+.
-    # 
+    #
     # @param filename [String] the file to soft touch
     # @param strip [Boolean] +true+ to strip +filename+ to help prevent fat-fingering, else +false+ to not
     def self.soft_touch(filename,strip: true,textmode: true,**opt)
       filename = Util.u_strip(filename) if strip
-      
-      return if filename.empty?()
+
+      return if filename.empty?
       return if File.exist?(filename)
-      
+
       # Create the file.
-      open(filename,'a',textmode: textmode,**opt) do |file|
+      self.open(filename,'a',textmode: textmode,**opt) do |file|
       end
     end
-    
-    def initialize(filename,mode=DEFAULT_MODE,buffer_len: DEFAULT_BUFFER_LEN,encoding: DEFAULT_ENCODING,separator: DEFAULT_SEPARATOR,**opt)
+
+    def initialize(filename,mode=DEFAULT_MODE,buffer_len: DEFAULT_BUFFER_LEN,encoding: DEFAULT_ENCODING,
+                   separator: DEFAULT_SEPARATOR,**opt)
       super(filename,mode,encoding: encoding,**opt)
-      
+
       @sscbot_buffer = nil
       @sscbot_buffer_len = buffer_len
       @sscbot_separator = separator
     end
-    
-    def get_line()
-      if @sscbot_buffer.nil?()
+
+    # Read a universal line.
+    def read_uline
+      if @sscbot_buffer.nil?
         # See comment at loop below.
         # - Use gets() instead of eof?() because of this method's name.
         line = gets(nil,@sscbot_buffer_len)
-        
-        return nil if line.nil?() # Still EOF?
-        
+
+        return nil if line.nil? # Still EOF?
+
         @sscbot_buffer = line
       end
-      
+
       lines = @sscbot_buffer.split(@sscbot_separator,2)
-      
+
       # Will only have 2 if there was a separator.
       if lines.length == 2
         @sscbot_buffer = lines[1]
-        
+
         return lines[0]
       end
-      
+
       # - Use a separator of nil to get all of the different types of newlines.
       # - Use gets() [instead of read(), etc.] to work probably with text (e.g., UTF-8)
       #   and to not throw an error at EOF (returns nil).
-      while !(line = gets(nil,@sscbot_buffer_len)).nil?()
+      while !(line = gets(nil,@sscbot_buffer_len)).nil?
         lines = line.split(@sscbot_separator,2)
-        
+
         # Will only have 2 if there was a separator.
         if lines.length == 2
           line = "#{@sscbot_buffer}#{lines[0]}"
           @sscbot_buffer = lines[1]
-          
+
           return line
         else
           @sscbot_buffer << line
         end
       end
-      
+
       # EOF reached with text in the buffer.
       line = @sscbot_buffer
       @sscbot_buffer = nil
-      
+
       return line
     end
-    
-    def seek_to_end()
+
+    def seek_to_end
       result = seek(0,:END)
-      
-      get_line() # Justin Case
-      
+
+      read_uline # Justin Case
+
       return result
     end
   end