rrb-common 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a89ece581da2c2543310b1bee958c9add7263270b4a95dfdb385fc3f38bf0c8a
-  data.tar.gz: 1ab02fc38ef1ef87aa339da23325f0773faa10dd9113b73f07192ce585bf58c0
+  metadata.gz: 6c0ce773dfdfb39eebd3eca206e2f583acc855bbbd4a00677d7bc0e4e7f3d228
+  data.tar.gz: e7054853f2f0f99977ecb8a64fa18cfcd6159b07af9cf4815ad08988275d6353
 SHA512:
-  metadata.gz: 49d5cb0360eccc6cff918d8802507143c0fa29a5e215f5143caf17e455ae4d88f91bccf96b90319f9867f7328a8a9e89d56b75bec09fb3781827b7fd6f09762e
-  data.tar.gz: 896f914849b9fdde81daee2e3c6d8bc33d37b891f85961a35c2046edc4615f9f13c5251e08c4191c6ca485041fe7bd6b69da0e18eaff85cf7c3930f322812d13
+  metadata.gz: 9a8566a6cccb99f6c084c2fb012e38b8d47893173de6305d4c48dd01cf07bbad3404e1e969512728c4358c41cf73fdb8d8e887d20d636e5f2a0a8cebb2546119
+  data.tar.gz: '024422087af5f9646086bda2549af7cbac08facf82eb3cb76df32665136fc0dabcdb8bcf5d983e89dbe374811dcbbbb817a7f9d51fe20f040127e8ab2958f46c'

data/lib/rune/common.rb

@@ -1,5 +1,11 @@
 Dir[File.dirname(__FILE__)].each { |file| $LOAD_PATH.unshift(file) if File.directory? file }
 
+require 'console'
+require 'dry/configurable'
+require 'dry/container'
+require 'securerandom'
+require 'singleton'
+
 # A game server written in Ruby targeting the 2006 era (or the 317-377 protocols) of the popular MMORPG, RuneScape.
 #
 # @title RuneRb
@@ -7,13 +13,16 @@ Dir[File.dirname(__FILE__)].each { |file| $LOAD_PATH.unshift(file) if File.direc
 # @since 0.1.0
 module RuneRb
 
-  # The Network module contains all common network related classes and modules.
-  module Network
-    autoload :Buffer,             'rune/network/buffer'
-    autoload :Constants,          'rune/network/constants'
-    autoload :ISAAC,              'rune/network/isaac'
-    autoload :Readable,           'rune/network/readable'
-    autoload :Writeable,          'rune/network/writeable'
+  # The Core module contains the core classes and modules of the Rune.rb framework.
+  module Core
+    autoload :Identifiable,       'rune/core/identifiable'
+    autoload :Logging,            'rune/core/logging'
+    autoload :Unit,               'rune/core/unit'
+    autoload :Buffer,             'rune/core/buffer'
+    autoload :Constants,          'rune/core/constants'
+    autoload :ISAAC,              'rune/core/isaac'
+    autoload :ReadableBuffer,     'rune/core/readable_buffer'
+    autoload :WriteableBuffer,    'rune/core/writeable_buffer'
 
     include Constants
   end
@@ -23,4 +32,10 @@ module RuneRb
     autoload :IntegerRefinements, 'rune/patches/integer_refinements'
     autoload :SetRefinements,     'rune/patches/set_refinements'
   end
+
+  # The Logger utility for the RuneRb framework.
+  # @return [Console::Logger] the logger instance.
+  def self.logger
+    Console.logger
+  end
 end

data/lib/rune/{network → core}/buffer.rb

@@ -1,4 +1,4 @@
-module RuneRb::Network
+module RuneRb::Core
 
   # A Buffer encapsulates raw data in a String instance. Depending on the mode, the buffer can be read from or written to.
   class Buffer
@@ -20,6 +20,12 @@ module RuneRb::Network
       @data.dup
     end
 
+    # Is the {Buffer#data} empty?
+    # @return [Boolean] true if the {Buffer#data} is empty, false otherwise.
+    def empty?
+      @data.empty?
+    end
+
     # Returns the limit of the buffer.
     # @return [Integer] the limit of the buffer.
     def length
@@ -61,14 +67,14 @@ module RuneRb::Network
 
     # Enables read functions on the buffer instance. Bit Access is disabled by default. Sets the bit position to 0.
     def enable_readable
-      singleton_class.include(RuneRb::Network::Readable)
+      singleton_class.include(RuneRb::Core::ReadableBuffer)
       @bit_access = false
       @bit_position = 0
     end
 
     # Enables write functions on the buffer instance.
     def enable_writeable
-      singleton_class.include(RuneRb::Network::Writeable)
+      singleton_class.include(RuneRb::Core::WriteableBuffer)
     end
   end
 end

data/lib/rune/{network → core}/constants.rb

@@ -1,4 +1,4 @@
-module RuneRb::Network::Constants
+module RuneRb::Core::Constants
   # Acceptable byte orders in which multi-byte values can be read.
   # @return [Array<Symbol>]
   BYTE_ORDERS = %i[BIG MIDDLE INVERSE_MIDDLE LITTLE].freeze

data/lib/rune/core/identifiable.rb

@@ -0,0 +1,47 @@
+module RuneRb::Core::Identifiable
+  # @!attribute [r] id
+  # @return [String, Integer, Symbol] - The identifier of the object.
+  attr_reader :identifier
+
+  # The identifier of the object.
+  # @return [String, Integer, Symbol] - The identifier of the object.
+  def identifier
+    @identifier ||= SecureRandom.uuid
+    @identifier
+  end
+
+  alias id identifier
+  alias signature identifier
+end
+
+############################################################################################################
+#  Copyright (c) 2023, Patrick W.                                                                          #
+#  All rights reserved.                                                                                    #
+#                                                                                                          #
+#  Redistribution and use in source and binary forms, with or without                                      #
+#  modification, are permitted provided that the following conditions are met:                             #
+#                                                                                                          #
+#  * Redistributions of source code must retain the above copyright notice, this                           #
+#    list of conditions and the following disclaimer.                                                      #
+#                                                                                                          #
+#  * Redistributions in binary form must reproduce the above copyright notice,                             #
+#    this list of conditions and the following disclaimer in the documentation                             #
+#    and/or other materials provided with the distribution.                                                #
+#                                                                                                          #
+#  * Neither the name of the copyright holder nor the names of its                                         #
+#    contributors may be used to endorse or promote products derived from                                  #
+#    this software without specific prior written permission.                                              #
+#                                                                                                          #
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"                             #
+#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE                               #
+#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE                          #
+#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE                            #
+#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL                              #
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR                              #
+#  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER                              #
+#  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,                           #
+#  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE                           #
+#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                                    #
+#                                                                                                          #
+############################################################################################################
+

data/lib/rune/{network → core}/isaac.rb

@@ -1,4 +1,4 @@
-module RuneRb::Network
+module RuneRb::Core
   # An implementation of an ISAAC cipher used to generate random numbers for message interchange.
   class ISAAC
     using RuneRb::Patches::IntegerRefinements

data/lib/rune/core/logging.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# A module responsible for setting up logging functions.
+module RuneRb::Core::Logging
+
+  # Write information to the log.
+  # @param lines [Array, String] the lines to write to the log.
+  def log(*lines)
+    RuneRb.logger.info(self.class.name) { lines.join("\n") }
+  end
+
+  alias info log
+
+  # Write a warning to the log.
+  # @param lines [Array, String] the lines to write to the log.
+  def log!(*lines)
+    RuneRb.logger.warn(self.class.name) { lines.join("\n") }
+  end
+
+  alias warn log!
+
+  # Write an error to the log.
+  # @param lines [Array, String] the lines to write to the log.
+  def err(*lines)
+    RuneRb.logger.error(self.class.name) { lines.join("\n") }
+  end
+
+  alias error err
+
+  # Write a fatal error to the log.
+  # @param lines [Array, String] the lines to write to the log.
+  def err!(*lines)
+    RuneRb.logger.fatal(self.class.name) { lines.join("\n") }
+  end
+
+  alias fatal err!
+end
+
+############################################################################################################
+#  Copyright (c) 2023, Patrick W.                                                                          #
+#  All rights reserved.                                                                                    #
+#                                                                                                          #
+#  Redistribution and use in source and binary forms, with or without                                      #
+#  modification, are permitted provided that the following conditions are met:                             #
+#                                                                                                          #
+#  * Redistributions of source code must retain the above copyright notice, this                           #
+#    list of conditions and the following disclaimer.                                                      #
+#                                                                                                          #
+#  * Redistributions in binary form must reproduce the above copyright notice,                             #
+#    this list of conditions and the following disclaimer in the documentation                             #
+#    and/or other materials provided with the distribution.                                                #
+#                                                                                                          #
+#  * Neither the name of the copyright holder nor the names of its                                         #
+#    contributors may be used to endorse or promote products derived from                                  #
+#    this software without specific prior written permission.                                              #
+#                                                                                                          #
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"                             #
+#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE                               #
+#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE                          #
+#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE                            #
+#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL                              #
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR                              #
+#  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER                              #
+#  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,                           #
+#  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE                           #
+#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                                    #
+#                                                                                                          #
+############################################################################################################
+

data/lib/rune/{network/readable.rb → core/readable_buffer.rb}

@@ -1,5 +1,5 @@
 # The Readable module contains the functions used to read data from a {Buffer} object.
-module RuneRb::Network::Readable
+module RuneRb::Core::ReadableBuffer
   using RuneRb::Patches::IntegerRefinements
 
   # @!attribute [r] bit_access

data/lib/rune/core/unit.rb

@@ -0,0 +1,28 @@
+module RuneRb::Core
+  # A Unit is a {Dry::Container} that encapsulates specific logic for a given system. Units are used to construct and run certain parts of the game. All {Unit} instances should include the {Singletons}.
+  # @abstract
+  class Unit
+    extend Dry::Configurable
+    include Dry::Container::Mixin
+    include RuneRb::Core::Logging
+    include Singleton
+
+    # Constructs a new instance of {Unit} and sets the name to the class name.
+    def initialize
+      @name = self.class.name.split('::')[-2]
+      super
+    end
+
+    # Prepares the unit for use. Providers are loaded and imported based on the configuration.
+    def prepare
+      info "Preparing #{@name} unit."
+
+      # Determine directory based on the class of the current instance
+      class_directory = File.dirname(self.class.instance_method(:prepare).source_location.first)
+      providers_directory = File.join(class_directory, 'providers', '*.rb')
+
+      # Load providers
+      Dir[providers_directory].sort.each { |provider| require provider }
+    end
+  end
+end

data/lib/rune/{network/writeable.rb → core/writeable_buffer.rb}

@@ -1,5 +1,5 @@
 # The Writeable module contains functions for writing data to a {Buffer} object.
-module RuneRb::Network::Writeable
+module RuneRb::Core::WriteableBuffer
 
   # Write data to the payload.
   # @param value [Integer, String, Message, Array] the value to write.
@@ -107,11 +107,11 @@ module RuneRb::Network::Writeable
   def write_long(value, mutation: :STD, signed: false, order: :BIG)
     case order
     when :BIG
-      (RuneRb::Network::BYTE_SIZE * 7).downto(0) { |div| ((div % 8).zero? and div.positive?) ? write_byte(value >> div) : next }
+      (RuneRb::Core::BYTE_SIZE * 7).downto(0) { |div| ((div % 8).zero? and div.positive?) ? write_byte(value >> div) : next }
       write_byte(value, mutation: mutation, signed: signed)
     when :LITTLE
       write_byte(value, mutation: mutation, signed: signed)
-      (0).upto(RuneRb::Network::BYTE_SIZE * 7) { |div| ((div % 8).zero? and div.positive?) ? write_byte(value >> div) : next }
+      (0).upto(RuneRb::Core::BYTE_SIZE * 7) { |div| ((div % 8).zero? and div.positive?) ? write_byte(value >> div) : next }
     else raise "Unrecognized byte order: #{order}"
     end
   end
@@ -141,8 +141,7 @@ module RuneRb::Network::Writeable
   def write_bytes(values)
     case values
     when Array then values.each { |byte| write_byte(byte.to_i) }
-    when RuneRb::Network::Packet then send(:put, values.snapshot)
-    when RuneRb::Network::Buffer then send(:put, values)
+    when RuneRb::Core::Buffer then send(:put, values)
     when String then send(:<<, values)
     end
   end
@@ -173,8 +172,8 @@ module RuneRb::Network::Writeable
 
     while amount > bit_offset
       @buffer[byte_pos] = [0].pack('c') if @buffer[byte_pos].nil?
-      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') & ~RuneRb::Network::BIT_MASK_OUT[bit_offset])].pack('c')
-      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') | (value >> (amount - bit_offset)) & RuneRb::Network::BIT_MASK_OUT[bit_offset])].pack('c')
+      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') & ~RuneRb::Core::BIT_MASK_OUT[bit_offset])].pack('c')
+      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') | (value >> (amount - bit_offset)) & RuneRb::Core::BIT_MASK_OUT[bit_offset])].pack('c')
       byte_pos += 1
       amount -= bit_offset
       bit_offset = 8
@@ -183,11 +182,11 @@ module RuneRb::Network::Writeable
     @buffer[byte_pos] = [0].pack('c') if @buffer[byte_pos].nil?
 
     if amount == bit_offset
-      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') & ~RuneRb::Network::BIT_MASK_OUT[bit_offset])].pack('c')
-      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') | (value & Rune::Network::BIT_MASK_OUT[bit_offset]))].pack('c')
+      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') & ~RuneRb::Core::BIT_MASK_OUT[bit_offset])].pack('c')
+      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') | (value & RuneRb::Core::BIT_MASK_OUT[bit_offset]))].pack('c')
     else
-      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') & ~(RuneRb::Network::BIT_MASK_OUT[amount] << (bit_offset - amount)))].pack('c')
-      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') | ((value & RuneRb::Network::BIT_MASK_OUT[amount]) << (bit_offset - amount)))].pack('c')
+      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') & ~(RuneRb::Core::BIT_MASK_OUT[amount] << (bit_offset - amount)))].pack('c')
+      @buffer[byte_pos] = [(@buffer[byte_pos].unpack1('c') | ((value & RuneRb::Core::BIT_MASK_OUT[amount]) << (bit_offset - amount)))].pack('c')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rrb-common
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Patrick W.
@@ -24,6 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: singleton
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: benchmark
   requirement: !ruby/object:Gem::Requirement
@@ -101,11 +157,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rune/common.rb
-- lib/rune/network/buffer.rb
-- lib/rune/network/constants.rb
-- lib/rune/network/isaac.rb
-- lib/rune/network/readable.rb
-- lib/rune/network/writeable.rb
+- lib/rune/core/buffer.rb
+- lib/rune/core/constants.rb
+- lib/rune/core/identifiable.rb
+- lib/rune/core/isaac.rb
+- lib/rune/core/logging.rb
+- lib/rune/core/readable_buffer.rb
+- lib/rune/core/unit.rb
+- lib/rune/core/writeable_buffer.rb
 - lib/rune/patches/integer_refinements.rb
 - lib/rune/patches/set_refinements.rb
 homepage: