ssc.bot 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1468b04f2b3b2b2e388b2ab044ad52e8bf55d53343d4ff75d2dd56c9387b843
-  data.tar.gz: f8ccc21500f7b394f3be858c24d59c18c453a333da03be6265e59a6224897ba0
+  metadata.gz: 988c653f2db596a5d3b9b0e1537f2443e6c41f65842df5ba6a4283a564f7d916
+  data.tar.gz: a272071c621d71f278761f77a34dc787984a86f10ef15fabe48668e7c4d342bf
 SHA512:
-  metadata.gz: 2fb0d8ed2cd691b5a40de2a103bcb3c050da49a4993e76bcd5a2b22e3fd8edf431e9de1be271bc71abadc28218721fc0fb8f1e30127743c08bc782e25b49b790
-  data.tar.gz: e0d5ad76f4ee548a4b6e5e191534badb10ef39e44644179a910e05b71b325963bed96b9892c82b25606ee78ff45dd32cac35ea247288225bd6f0bd6b7be40bc3
+  metadata.gz: a5525a87c8cb6ca2186ee20d596c44c76f6a85e6fb3996b94e314c10510dd4195837c29154951a6afd78251fce6861bf501b77e869320c41880a9da71f376f99
+  data.tar.gz: 7ba1b91a451d94cf01a1f1fab8de7e5892da04cffbca0d3085b162538c58c3b90aca99fcabf00f28e5734844c9fbaf72c51a439767096eb2fe6086e3a588101f

data/.yardopts

@@ -0,0 +1,3 @@
+--files 'CHANGELOG.md,LICENSE.txt'
+--protected
+--readme 'README.md'

data/CHANGELOG.md

@@ -5,9 +5,18 @@ 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 v2.0.0](https://semver.org/spec/v2.0.0.html).
 
-## [[Unreleased]](https://github.com/esotericpig/ssc.bot/compare/v0.1.1...HEAD)
+## [[Unreleased]](https://github.com/esotericpig/ssc.bot/compare/v0.2.0...HEAD)
 -
 
+
+## [v0.2.0] - [2021-06-22](https://github.com/esotericpig/ssc.bot/compare/v0.1.1...v0.2.0)
+### Changed
+- Renamed `SSCBot::SSCFile#get_line()` to `read_uline()` due to RuboCop complaining about using `get_`.
+- Formatted all code with RuboCop.
+- Formatted all files.
+- Updated dev Gems.
+
+
 ## [v0.1.1] - [2020-09-09](https://github.com/esotericpig/ssc.bot/compare/v0.1.0...v0.1.1)
 
 ### Added
@@ -24,6 +33,7 @@ and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec
 ### Fixed
 - `Util.u_blank?(str)`
 
+
 ## [v0.1.0] - [2020-08-29](https://github.com/esotericpig/ssc.bot/tree/v0.1.0)
 
 First working version.

data/Gemfile

@@ -1,24 +1,6 @@
 # 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/>.
-#++
-
 
 source 'https://rubygems.org'
 

data/README.md

@@ -12,48 +12,15 @@ It's currently in development and only offers limited functionality.
 
 ## Contents
 
-- [Setup](#-setup)
 - [Using](#-using)
 - [Hacking](#-hacking)
 - [License](#-license)
 
-## [//](#contents) Setup
-
-Pick your poison...
-
-In your Gemspec (*<project>*.gemspec):
-
-```Ruby
-  # Pick one...
-  spec.add_runtime_dependency 'ssc.bot', '~> X.X'
-  spec.add_development_dependency 'ssc.bot', '~> X.X'
-```
-
-In your Gemfile:
-
-```Ruby
-  # Pick one...
-  gem 'ssc.bot', '~> X.X'
-  gem 'ssc.bot', '~> X.X', group: :development
-  gem 'ssc.bot', git: 'https://github.com/esotericpig/ssc.bot.git', tag: 'vX.X.X'
-```
-
-With the RubyGems package manager:
-
-```
-  $ gem install ssc.bot
-```
+## [//](#contents) Using
 
-Manually:
+Gem name: `ssc.bot`
 
-```
-  $ git clone 'https://github.com/esotericpig/ssc.bot.git'
-  $ cd ssc.bot
-  $ bundle install
-  $ bundle exec rake install:local
-```
-
-## [//](#contents) Using
+See [SSC.Nob](https://github.com/esotericpig/ssc.nob) for example usage.
 
 TODO: readme.using
 
@@ -86,20 +53,28 @@ $ bundle exec rake install:local
 
 ### Releasing
 
-1. Update *CHANGELOG.md* & *version.rb*
-    - `$ raketary bump -v`
-2. Check for updates
+1. Check for updates
+    - `$ git pull`
     - `$ bundle update`
     - `$ bundle outdated`
-    - `$ git pull`
-3. `$ bundle exec rake release`
+2. Update *CHANGELOG.md* & *version.rb*
+    - `$ raketary bump -v`
+    - `$ raketary bump --patch`
+    - `$ bundle update`
+3. Release to *GitHub* & *GitHub Packages*
+    - `$ bundle exec rake clobber build`
+    - `$ gh release create v0.0.0 pkg/*.gem`
+    - `$ git fetch --tags origin`
+    - `$ raketary github_pkg`
+4. Release to *RubyGems*
+    - `$ bundle exec rake release`
 
 ## [//](#contents) License
 
 [GNU LGPL v3+](LICENSE.txt)
 
 > SSC.Bot (<https://github.com/esotericpig/ssc.bot>)  
-> Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)  
+> Copyright (c) 2020-2021 Jonathan Bradley Whited  
 > 
 > 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  

data/Rakefile

@@ -1,52 +1,35 @@
 # 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/>.
-#++
-
 
 require 'bundler/gem_tasks'
 
+require 'yard'
+
 require 'rake/clean'
 require 'rake/testtask'
-require 'yard'
 
 require 'ssc.bot/version'
 
-
 CLEAN.exclude('{.git,stock}/**/*')
 CLOBBER.include('doc/')
 
 task default: [:test]
 
 desc 'Generate documentation'
-task :doc => [:yard] do |task|
+task doc: [:yard] do |task|
 end
 
-Rake::TestTask.new() do |task|
+Rake::TestTask.new do |task|
   task.libs = ['lib','test']
   task.pattern = File.join('test','**','*_test.rb')
   task.description += ": '#{task.pattern}'"
+  task.options = '--pride'
   task.verbose = false
   task.warning = true
 end
 
-YARD::Rake::YardocTask.new() do |task|
+YARD::Rake::YardocTask.new do |task|
   #task.options.push('--template-path',File.join('yard','templates'))
   task.options.push('--title',"SSC.Bot v#{SSCBot::VERSION} Doc")
 end

data/lib/ssc.bot.rb

@@ -1,30 +1,20 @@
-#!/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/chat_log'
 require 'ssc.bot/chat_log_file'
+require 'ssc.bot/clu'
 require 'ssc.bot/error'
 require 'ssc.bot/ssc_file'
+require 'ssc.bot/user'
 require 'ssc.bot/util'
 require 'ssc.bot/version'
 
@@ -35,9 +25,8 @@ require 'ssc.bot/chat_log/messages'
 
 require 'ssc.bot/user/message_sender'
 
-
 ###
-# @author Jonathan Bradley Whited (@esotericpig)
+# @author Jonathan Bradley Whited
 # @since  0.1.0
 ###
 module SSCBot

data/lib/ssc.bot/chat_log.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
 #++
 
 
@@ -31,15 +19,15 @@ 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 ChatLog
+    extend AttrBool::Ext
     include MessageParsable
-    
+
     attr_reader? :alive
     attr_accessor :file_mode
     attr_reader :file_opt
@@ -47,10 +35,10 @@ module SSCBot
     attr_accessor :idle_secs
     attr_reader :observers
     attr_reader :thread
-    
+
     def initialize(filename,file_mode: 'rt',file_opt: {},idle_secs: 0.250,**parser_kargs)
       super()
-      
+
       @alive = false
       @file_mode = file_mode
       @file_opt = file_opt
@@ -58,224 +46,212 @@ module SSCBot
       @idle_secs = idle_secs
       @observers = {}
       @parser = MessageParser.new(**parser_kargs)
-      @semaphore = Mutex.new()
+      @semaphore = Mutex.new
       @thread = nil
     end
-    
+
     def add_observer(observer=nil,*funcs,type: :any,&block)
-      if observer.nil?() && block.nil?()
+      if observer.nil? && block.nil?
         raise ArgumentError,'no observer'
       end
-      
+
       check_type(type)
-      
+
       type_observers = fetch_observers(type: type)
-      
-      if !observer.nil?()
-        funcs << :call if funcs.empty?()
-        
+
+      if !observer.nil?
+        funcs << :call if funcs.empty?
+
         type_observers << Observer.new(observer,*funcs)
       end
-      
-      if !block.nil?()
+
+      if !block.nil?
         type_observers << Observer.new(block,:call)
       end
     end
-    
+
     def add_observers(*observers,type: :any,func: :call,&block)
-      if observers.empty?() && block.nil?()
+      if observers.empty? && block.nil?
         raise ArgumentError,'no observer'
       end
-      
+
       check_type(type)
-      
+
       type_observers = fetch_observers(type: type)
-      
-      observers.each() do |observer|
+
+      observers.each do |observer|
         type_observers << Observer.new(observer,func)
       end
-      
-      if !block.nil?()
+
+      if !block.nil?
         type_observers << Observer.new(block,:call)
       end
     end
-    
+
     def check_type(type,nil_ok: false)
-      if type.nil?()
+      if type.nil?
         if !nil_ok
-          raise ArgumentError,"invalid type{#{type.inspect()}}"
+          raise ArgumentError,"invalid type{#{type.inspect}}"
         end
       else
         if type != :any && !Message.valid_type?(type)
-          raise ArgumentError,"invalid type{#{type.inspect()}}"
+          raise ArgumentError,"invalid type{#{type.inspect}}"
         end
       end
     end
-    
-    def clear_content()
+
+    def clear_content
       SSCFile.clear(@filename)
     end
-    
+
     def count_observers(type: nil)
       check_type(type,nil_ok: true)
-      
+
       count = 0
-      
-      if type.nil?()
-        @observers.each_value() do |type_observers|
+
+      if type.nil?
+        @observers.each_value do |type_observers|
           count += type_observers.length
         end
       else
         type_observers = @observers[type]
-        
-        if !type_observers.nil?()
+
+        if !type_observers.nil?
           count += type_observers.length
         end
       end
-      
+
       return count
     end
-    
+
     def delete_observer(observer,type: nil)
       delete_observers(observer,type: type)
     end
-    
+
     def delete_observers(*observers,type: nil)
       check_type(type,nil_ok: true)
-      
-      if observers.empty?()
-        if type.nil?()
-          @observers.clear()
+
+      if observers.empty?
+        if type.nil?
+          @observers.clear
         else
-          type_observers = @observers[type]
-          
-          if !type_observers.nil?()
-            type_observers.clear()
-          end
+          @observers[type]&.clear
         end
       else
-        observers = observers.to_set()
-        
-        if type.nil?()
-          @observers.each_value() do |type_observers|
-            type_observers.delete_if() do |observer|
+        observers = observers.to_set
+
+        if type.nil?
+          @observers.each_value do |type_observers|
+            type_observers.delete_if do |observer|
               observers.include?(observer.object)
             end
           end
         else
-          type_observers = @observers[type]
-          
-          if !type_observers.nil?()
-            type_observers.delete_if() do |observer|
-              observers.include?(observer.object)
-            end
+          @observers[type]&.delete_if do |observer|
+            observers.include?(observer.object)
           end
         end
       end
     end
-    
+
     def fetch_observers(type: :any)
       check_type(type)
-      
+
       type_observers = @observers[type]
-      
-      if type_observers.nil?()
+
+      if type_observers.nil?
         type_observers = []
         @observers[type] = type_observers
       end
-      
+
       return type_observers
     end
-    
+
     def notify_observers(message)
       any_observers = @observers[:any]
       type_observers = @observers[message.type]
-      
-      if !any_observers.nil?()
-        any_observers.each() do |observer|
-          observer.notify(self,message)
-        end
+
+      any_observers&.each do |observer|
+        observer.notify(self,message)
       end
-      
-      if !type_observers.nil?()
-        type_observers.each() do |observer|
-          observer.notify(self,message)
-        end
+
+      type_observers&.each do |observer|
+        observer.notify(self,message)
       end
     end
-    
+
     def run(seek_to_end: true)
-      @semaphore.synchronize() do
+      @semaphore.synchronize do
         return if @alive # Already running
       end
-      
-      stop() # Justin Case
-      
-      @semaphore.synchronize() do
+
+      stop # Justin Case
+
+      @semaphore.synchronize do
         @alive = true
-        
-        soft_touch() # Create the file if it doesn't exist
-        
-        @thread = Thread.new() do
+
+        soft_touch # Create the file if it doesn't exist
+
+        @thread = Thread.new do
           SSCFile.open(@filename,@file_mode,**@file_opt) do |fin|
-            fin.seek_to_end() if seek_to_end
-            
+            fin.seek_to_end if seek_to_end
+
             while @alive
-              while !(line = fin.get_line()).nil?()
+              while !(line = fin.read_uline).nil?
                 message = @parser.parse(line)
-                
+
                 notify_observers(message)
               end
-              
+
               sleep(@idle_secs)
             end
           end
         end
       end
     end
-    
-    def soft_touch()
+
+    def soft_touch
       SSCFile.soft_touch(@filename)
     end
-    
+
     def stop(wait_secs=5)
-      @semaphore.synchronize() do
+      @semaphore.synchronize do
         @alive = false
-        
-        if !@thread.nil?()
-          if @thread.alive?()
+
+        if !@thread.nil?
+          if @thread.alive?
             # First, try to kill it gracefully (waiting X secs).
             @thread.join(@idle_secs + wait_secs)
-            
+
             # Die!
-            @thread.kill() if @thread.alive?()
+            @thread.kill if @thread.alive?
           end
-          
+
           @thread = nil
         end
       end
     end
-    
+
     ###
-    # @author Jonathan Bradley Whited (@esotericpig)
+    # @author Jonathan Bradley Whited
     # @since  0.1.0
     ###
     class Observer
       attr_reader :funcs
       attr_reader :object
-      
+
       def initialize(object,*funcs)
         super()
-        
-        raise ArgumentError,'empty funcs' if funcs.empty?()
-        
+
+        raise ArgumentError,'empty funcs' if funcs.empty?
+
         @funcs = funcs
         @object = object
       end
-      
-      def notify(chatlog,message)
-        @funcs.each() do |func|
-          @object.__send__(func,chatlog,message)
+
+      def notify(chat_log,message)
+        @funcs.each do |func|
+          @object.__send__(func,chat_log,message)
         end
       end
     end