rrb 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41791058f4c6b1f6c6295182df8f1edae27a3aa6e89655bc11530863d7d136b5
+  data.tar.gz: 5457ead97de7f07f2bb09bdbd3254eaf6dc4ded42b08943f9fba860ad0af9149
+SHA512:
+  metadata.gz: d1f5a2425a35ab452d24442399c31ea3e3bb1acb20dba030e6cc85458e929b6199de6074e02132f313f843fc3169af7c282038e2605f196dabe3e2221d32291c
+  data.tar.gz: 5f39f2186da44056283a23921b252b30efbb27a0c0dd3ada6b0f1875f4e8ecd30d8a45e36c1c7a740b058698cf92f977649eeef789494cc793877851b77b473e

data/app/rrb/patches/integer.rb

@@ -0,0 +1,104 @@
+# Overflow behavior for Integers that attempts to mimic the behavior of Java primitive overflow behavior.
+module RuneRb::Patches::IntegerRefinements
+
+  refine Integer do
+    # Adjusts the value of the Integer to be unsigned.
+    # @param type [Symbol] the type of primitive the value will be returned as
+    def unsigned(type)
+      return 0 if negative?
+
+      case type
+      when :Byte, :byte, :b, :B then to_i > 0xFF ? 0xFF : to_i
+      when :Short, :short, :s, :S then to_i > 0xFFFF ? 0xFFFF : to_i
+      when :Integer, :Int, :int, :integer, :i, :I then to_i > 0xFFFFFFFF ? 0xFFFFFFFF : to_i
+      when :Long, :long, :l, :L then to_i > 0xFFFFFFFFFFFFFFFF ? 0xFFFFFFFFFFFFFFFF : to_i
+      else unsigned(:int)
+      end
+    end
+
+    alias_method :u, :unsigned
+
+    # Adjusts the value of the Integer to be signed.
+    # @param type [Symbol] the type of primitive the value will be returned as
+    def signed(type)
+      case type
+      when :Byte, :byte, :b, :B then adjust(:byte)
+      when :Short, :short, :s, :S then adjust(:short)
+      when :Integer, :Int, :int, :integer, :i, :I then adjust(:integer)
+      when :Long, :long, :l, :L then adjust(:long)
+      else adjust(:integer)
+      end
+    end
+
+    alias_method :s, :signed
+
+    def nibble
+      adjust(:nibble)
+    end
+
+    # Returns a string with a formatted representation of the Integer as a timestamp.
+    def to_ftime
+      mm, ss = divmod(60)
+      hh, mm = mm.divmod(60)
+      dd, hh = hh.divmod(24)
+      format('%d days, %d hours, %d minutes, and %d seconds', dd, hh, mm, ss)
+    end
+
+    private
+
+    # Adjusts the integer based on the passed type
+    # @param type [Symbol] the type of adjustment to make to the integer.
+    def adjust(type)
+      case type
+      when :Byte, :byte, :b, :B
+        primitive_max = 2**7 - 1
+        primitive_min = -2**7
+      when :Short, :short, :s, :S
+        primitive_max = 2**15 - 1
+        primitive_min = -2**15
+      when :Integer, :Int, :int, :i, :I
+        primitive_max = 2**31 - 1
+        primitive_min = -2**31
+      when :Long, :long, :l, :L
+        primitive_max = 2**63 - 1
+        primitive_min = -2**63
+      when :Nibble, :nibble, :n, :N
+        primitive_max = 2**4
+        primitive_min = -2**4
+      else
+        primitive_max = 2**31 - 1
+        primitive_min = -2**31
+      end
+      self < -primitive_max ? -1 * (-self & primitive_max) : self
+      self > primitive_min ? (self & primitive_max) : self
+    end
+  end
+end
+
+# Copyright (c) 2022, 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/app/rrb/patches/set.rb

@@ -0,0 +1,43 @@
+# Refinements made to the Set class of the ruby Core module.
+module RuneRb::Patches::SetRefinements
+  refine Set do
+    # Consumes elements as they're passed to execution block.
+    # @param _ [Proc] the execution block
+    def each_consume(&_)
+      raise 'Nil block passed to Set#each_consume.' unless block_given?
+
+      each do |item|
+        yield(item)
+        delete(item)
+      end
+    end
+  end
+end
+
+# Copyright (c) 2022, 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/app/rrb/patches/string.rb

@@ -0,0 +1,172 @@
+# Convenience functions to be used when a string is behaving as a buffer..
+module RuneRb::Patches::StringRefinements
+  VALID_CHARS = %w{_ a b c d e f g h i j k l m n o p q r s t u v w x y z 0 1 2 3 4 5 6 7 8 9 ! @ # $ % ^ & * ( ) - + = : ; . > < , " [ ] | ? / `}.freeze
+
+  refine String do
+    using RuneRb::Patches::IntegerRefinements
+
+    # returns the next byte.
+    def next_byte
+      slice!(0)&.unpack1('c')
+    end
+
+    # Returns the next x amount of byte values.
+    # @param amount [Integer] the amount of bytes.
+    def next_bytes(amount)
+      amount.times.inject('') { |str| str << slice!(0) }.unpack('c*')
+    end
+
+    # returns the next byte from the provided position.
+    # @param position [Integer] the offset/position to begin reading from.
+    def byte_from(position)
+      slice!(position).unpack1('c')
+    end
+
+    # Returns x amount of bytes from a given position.
+    # @param position [Integer] the offset/position to begin reading from.
+    # @param amount [Integer] the amount of bytes to read.
+    def bytes_from(position, amount)
+      amount.times.inject('') { |str| str << slice!(position) }.unpack('c*')
+    end
+
+    # returns the next short.
+    def next_short
+      slice!(0..1).unpack1('n')
+    end
+
+    # Returns the next x amount of short values.
+    # @param amount [Integer] the amount of shorts.
+    def next_shorts(amount)
+      amount.times.inject('') { |str| str << slice!(0..1) }.unpack('n*')
+    end
+
+    # returns the next short from the provided position.
+    # @param position [Integer] the offset/position to begin reading from.
+    def short_from(position)
+      slice!(position..(position + 1)).unpack1('n')
+    end
+
+    # Returns x amount of shorts from a given position
+    # @param position [Integer] the offset/position to begin reading from.
+    # @param amount [Integer] the amount of shorts to read.
+    def shorts_from(position, amount)
+      amount.times.inject('') { |str| str << slice!(position..(position + 1)) }.unpack('n*')
+    end
+
+    # returns the next integer.
+    def next_int
+      slice!(0..3).unpack1('i')
+    end
+
+    # Returns the next x amount of integer values.
+    # @param amount [Integer] the amount of integers.
+    def next_ints(amount)
+      amount.times.inject('') { |str| str << slice!(0..3) }.unpack('l*')
+    end
+
+    # returns the next int from the provided position.
+    # @param position [Integer] the offset/position to begin reading from.
+    def int_from(position)
+      slice!(position..(position + 3)).unpack1('l')
+    end
+
+    # Returns x amount of integers from a given position
+    # @param position [Integer] the offset/position to begin reading from.
+    # @param amount [Integer] the amount of integers to read.
+    def ints_from(position, amount)
+      amount.times.inject('') { |str| str << slice!(position..(position + 3)) }.unpack('l*')
+    end
+
+    # returns the next long.
+    def next_long
+      slice!(0..7).unpack1('q')
+    end
+
+    # Returns the next x amount of long values.
+    # @param amount [Integer] the amount of longs.
+    def next_longs(amount)
+      amount.times.inject('') { |str| str << slice!(0..7) }.unpack('q*')
+    end
+
+    # returns the next long from the provided position.
+    # @param position [Integer] the offset/position to begin reading from.
+    def long_from(position)
+      slice!(position..(position + 7)).unpack1('q')
+    end
+
+    # Returns x amount of longs from a given position.
+    # @param position [Integer] the offset/position to begin reading from.
+    # @param amount [Integer] the amount of longs to read.
+    def longs_from(position, amount)
+      amount.times.inject('') { |str| str << slice!(position..(position + 7)) }.unpack('q*')
+    end
+
+    # Returns the next terminated string.
+    def next_tstring
+      val = ''
+      while (res = slice!(0))
+        break if res == "\n"
+
+        val << res
+      end
+      val
+    end
+
+    # Returns a base37 numeric representation of the String.
+    # @return [Integer] a base37 number representing the String
+    def to_base37
+      l = 0
+      (0...length).each do |i|
+        c = self[i].chr
+        l *= 37
+        l += (1  + self[i].bytes.first) - 65 if (c >= 'A') && (c <= 'Z')
+        l += (1  + self[i].bytes.first) - 97 if (c >= 'a') && (c <= 'z')
+        l += (27 + self[i].bytes.first) - 48 if (c >= '0') && (c <= '9')
+      end
+      l /= 37 while (l % 37).zero? && l != 0
+      l
+    end
+
+    # Returns a string from the provided b37 numeric
+    # @param base37 [Integer] the base_37 numeric to build a string from.
+    def from_base37(base37)
+      return self unless empty?
+
+      while base37 != 0
+        original = base37.signed(:long)
+        base37 = (base37 / 37).signed(:long)
+        self << RuneRb::Patches::StringRefinements::VALID_CHARS[(original - base37 * 37).signed(:int)]
+      end
+
+      reverse!
+    end
+  end
+end
+
+# Copyright (c) 2022, 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/app/rrb/utils/controller.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require 'rrb_data'
+require 'rrb_game'
+require 'rrb_net'
+
+# Utility objects and modules.
+module RuneRb::Utils
+
+  # The Controller instance facilitates the deployment of game world and server instances.
+  class Controller
+    using RuneRb::Patches::IntegerRefinements
+
+    include RuneRb::Utils::Logging
+
+    include Singleton
+
+    # @!attribute [r] sessions
+    # @return [Hash] a collection of sessions.
+    attr :sessions
+
+    # @!attribute [r] servers
+    # @return [Hash] a collection of server objects and signatures.
+    attr :servers
+
+    # @!attribute [r] worlds
+    # @return [Array] a map of World instances.
+    attr :worlds
+
+    # Constructs a new Controller object
+    def initialize
+      @queue = Queue.new
+      @servers = {}
+      @worlds = {}
+      @start = { time: Process.clock_gettime(Process::CLOCK_MONOTONIC), stamp: Time.now }
+
+      setup_trapping
+    end
+
+    def autorun(em: false)
+      EventMachine.run do
+        setup_queue
+
+        # Deploy a game world instance.
+        deploy_world
+        # deploy_world.run
+
+        # Deploy a server.
+        deploy_server(host: '0.0.0.0', em: em).run
+
+        # Deploy a console
+        # deploy_console
+      end
+    end
+
+    # Logs information about the worlds, servers, and session states.
+    def about
+      log COLORS.green("[Sessions]:\n#{@sessions.each(&:inspect)}")
+      log COLORS.green("[Servers]:\n#{@servers.each(&:inspect)}")
+      log COLORS.green("[Worlds]:\n#{@worlds.each(&:inspect)}")
+    end
+
+    # Deploys a single TCP Socket Server.
+    # @param host [String] the host address
+    # @param port [Integer] the port
+    # @param em [Boolean] should this be an EventMachine server?
+    # @param label [String, Integer] the label
+    # @return [Integer, RunRb::Network::Server] the constructed Server or a signature identifying the server.
+    def deploy_server(host: 'localhost', port: 43_594, em: false, label: @servers[ENV['RRB_NET_TARGET']] ? Druuid.gen : ENV['RRB_NET_TARGET'])
+      @servers[label] = if em
+                          EventMachine.start_server(host, port, RuneRb::Network::SessionEM) do
+                            if ENV['RRB_NET_TARGET'] == 'default'
+                              raise 'No default server instance available to receive session!' if @servers.empty?
+
+                              @servers.values.first.sessions[_1.sig] = _1
+                            else
+                              raise "No Server instance associated with label: #{ENV['RRB_NET_TARGET']}!" unless @servers[ENV['RRB_NET_TARGET']]
+
+                              @servers[ENV['RRB_NET_TARGET']].sessions[_1.sig] = _1
+                            end
+                          end
+                        else
+                          RuneRb::Network::Server.new(host: host, port: port, controller: self)
+                        end
+      log! "Deployed new Server instance. [label: #{label}]"
+      @servers[label]
+    end
+
+    # Deploys a singe instance of {RuneRb::Game::World}
+    # @param label [Integer, String] the label
+    # @return [RuneRb::Game::World] the constructed World
+    def deploy_world(label: @worlds[ENV['RRB_GAME_TARGET']] ? Druuid.gen : ENV['RRB_GAME_TARGET'])
+      @worlds[label] = RuneRb::Game::World.new
+      log! "Deployed new World instance. [label: #{label}]"
+      @worlds[label]
+    end
+
+    # Registers a session.
+    # @param req [RuneRb::Network::Gateway::Request] the request.
+    def enqueue(req)
+      @queue.push(req)
+    end
+
+    # Stop all server instances and close all connected sessions.
+    def shutdown(graceful: true)
+      return if @closed
+
+      @servers.each_value do |item|
+        case item
+        when Integer then EventMachine.stop_server(item) if EventMachine.reactor_running?
+        when RuneRb::Network::Server then graceful ? item.shutdown : item.worker.kill
+        else next
+        end
+      end
+      log! COLORS.red.bold("Closed #{@servers.length} server instances.")
+
+      @worlds.each_value { _1.shutdown(graceful: graceful) }
+      log! COLORS.red.bold("Closed #{@worlds.length} game instances.")
+
+      log! COLORS.blue.bold("Total Controller Up-time: #{up_time.to_i.to_ftime}")
+    ensure
+      @servers.clear
+      @closed = true
+    end
+
+    # The current up-time for the server.
+    def up_time
+      (Process.clock_gettime(Process::CLOCK_MONOTONIC) - @start[:time]).round(3)
+    end
+
+    def deploy_console
+      Pry.start
+    end
+
+    private
+
+    def setup_trapping
+      # Trap Interrupt (INT) signals.
+      Signal.trap('INT') do
+        Thread.new do
+          log! COLORS.red('Caught INTERRUPT!')
+          log! COLORS.red.bold('Shutting Down...')
+        ensure
+          shutdown
+        end.join
+      end
+
+      # Trap Termination (TERM) signals.
+      Signal.trap('TERM') do
+        Thread.new do
+          log! COLORS.red('Caught TERMINATION!')
+          log! COLORS.red.bold('Shutting Down...')
+        ensure
+          shutdown
+        end.join
+      end
+    end
+
+    def setup_queue
+      @queue = Queue.new
+      EventMachine.add_periodic_timer(0.600) do
+        until @queue.empty?
+          new_request = @queue.pop
+
+          if ENV['RRB_GAME_TARGET'] == 'default'
+            raise 'No default World instance available to register context!' if @worlds.empty?
+
+
+            @worlds.values.first.receive(new_request.session, new_request.profile, new_request.profile.nil?)
+          else
+            raise "No World instance associated with label: #{ENV['RRB_GAME_TARGET']}!" unless @worlds[ENV['RRB_GAME_TARGET']]
+
+            @worlds[ENV['RRB_GAME_TARGET']].receive(new_request.session, new_request.profile, new_request.profile.nil?)
+          end
+        end
+      rescue StandardError => e
+        err 'An error occurred while processing session queue!', e.message, e.backtrace&.join("\n")
+      end
+    end
+  end
+end
+
+# Copyright (c) 2021, 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/app/rrb/utils/environment.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# A module responsible for loading environmental vars..
+module RuneRb::Utils::Environment
+
+  # Loads environmental variables and creates necessary directories.
+  def init_env(fetch: false, force: false)
+    FileUtils.mkdir_p('data') unless File.exist?('data')
+    FileUtils.mkdir_p('data/logs') unless File.exist?('data/logs')
+    FileUtils.touch(RuneRb::Utils::Logging::LOG_FILE_PATH) unless File.exist?(RuneRb::Utils::Logging::LOG_FILE_PATH)
+    Dir['data/*.env'].each { FileUtils.rm(_1) } if force
+
+    if File.exist?('data/rrb.env') || File.exist?('data/sample-rrb.env')
+      Dotenv.load(File.exist?('data/rrb.env') ? 'data/rrb.env' : 'data/sample-rrb.env')
+    elsif fetch
+      IO.copy_stream(URI.open('https://git.repos.pw/rune.rb/app/-/snippets/1/raw/main/sample-rrb.env'), 'data/sample-rrb.env')
+      init_env(fetch: false)
+    else
+      raise(StandardError, 'No rrb.env file found!')
+    end
+    nil
+  end
+end
+
+# Copyright (c) 2022, 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/app/rrb/utils/logging.rb

@@ -0,0 +1,114 @@
+module RuneRb::Utils::Logging
+
+  # @!attribute [r] COLORS
+  # @return [Pastel] provides String coloring functions.
+  COLORS ||= RuneRb::COLORS ||= Pastel.new
+
+  # @!attribute [r] STDOUT
+  # @return [Logger] logger that writes to {$stdout}.
+  LOG_STDOUT ||= RuneRb::STDOUT ||= Logger.new($stdout)
+  LOG_STDOUT.formatter = proc do |sev, date, _prog, msg|
+    "#{COLORS.cyan("[#{date.strftime('%H:%M')}]")}|#{COLORS.blue("[#{sev}]")} -> #{msg}\n"
+  end
+
+  LOG_FILE_PATH = "#{ENV['RRB_LOG_PATH'] || 'data/logs'}/rune.rb-#{Time.now.strftime('%Y-%m-%d').chomp}.log".freeze
+
+  # @!attribute [r] LOG_FILE
+  # @return [Logger] logger that writes to a file.
+  LOG_FILE ||= RuneRb::LOG_FILE ||= Logger.new(LOG_FILE_PATH, progname: "rune.rb")
+
+  # The class name, un-nested, as a symbol
+  # @return [Symbol] the class name.
+  def class_name
+    self.class.name.split('::').last.to_sym
+  end
+
+  # Log info lines
+  # @param lines [Array] lines of text that are passed to the logger.
+  # @param app_name [String] the name of the application.
+  # @param to_file [Boolean] should the line be written to the Logging#LOG_FILE?
+  # @param to_stdout [Boolean] should the line(s) be written to $STDOUT?
+  def log(*lines, app_name: @label || 'rune.rb', to_file: true, to_stdout: true)
+    lines.each do |line|
+      LOG_STDOUT.info(COLORS.white("[#{class_name}] -> #{line}")) if to_stdout
+      LOG_FILE.info(app_name) { "[#{Time.now.strftime('%H:%M')}] #{COLORS.strip(line)}" } if to_file
+    end
+    nil
+  end
+
+  alias info log
+
+  # Log warning lines
+  # @param lines [Array] lines of text that are passed to the RuneRb::GLOBAL[:LOGGER].
+  # @param app_name [String] the name of the application.
+  # @param to_file [Boolean] should the line be written to the Logging#LOG_FILE?
+  # @param to_stdout [Boolean] should the line(s) be written to $STDOUT?
+  def log!(*lines, app_name: @label || 'rune.rb', to_file: true, to_stdout: true)
+    lines.each do |line|
+      LOG_STDOUT.warn(COLORS.yellow("[#{class_name}] -> #{line}")) if to_stdout
+      LOG_FILE.warn(app_name) { "[#{Time.now.strftime('%H:%M')}] #{COLORS.strip(line)}" } if to_file
+    end
+    nil
+  end
+
+  alias debug log!
+  alias warn log!
+
+  # Log error lines
+  # @param lines [Array] lines of text that are passed to the RuneRb::GLOBAL[:LOGGER].
+  # @param app_name [String] the name of the application.
+  # @param to_file [Boolean] should the line be written to the Logging#LOG_FILE?
+  # @param to_stdout [Boolean] should the line(s) be written to $STDOUT?
+  def err(*lines, app_name: @label || 'rune.rb', to_file: true, to_stdout: true)
+    lines.each do |line|
+      LOG_STDOUT.error(COLORS.magenta.bold("[#{class_name}] ~> #{line}")) if to_stdout
+      LOG_FILE.error(app_name) { "[#{Time.now.strftime('%H:%M')}] #{COLORS.strip(line)}" } if to_file
+    end
+    nil
+  end
+
+  alias error err
+
+  # Log fatal lines
+  # @param lines [Array] lines of text that are passed to the RuneRb::GLOBAL[:LOGGER].
+  # @param app_name [String] the name of the application.
+  # @param to_file [Boolean] should the line be written to the Logging#LOG_FILE?
+  # @param to_stdout [Boolean] should the line(s) be written to $STDOUT?
+  def err!(*lines, app_name: @label || 'rune.rb', to_file: true, to_stdout: true)
+    lines.each do |line|
+      LOG_STDOUT.error(COLORS.red.bold("[#{class_name}] ~> #{line}")) if to_stdout
+      LOG_FILE.fatal(app_name) { "[#{Time.now.strftime('%H:%M')}] #{COLORS.strip(line)}" } if to_file
+    end
+    nil
+  end
+
+  alias fatal err!
+end
+
+# Copyright (c) 2022, 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/app/rrb/utils/version.rb

@@ -0,0 +1,53 @@
+module RuneRb::Utils
+
+  # Functions to retrieve version data for the Rune.rb project.
+  module Version
+    # The version.
+    # @return [String] the Rune.rb project version.
+    def version
+      raw[:version]
+    end
+
+    # The build string for the project.
+    # @return [String] the build string for the Rune.rb project.
+    def build
+      "#{version}-#{raw[:build]}"
+    end
+
+    private
+
+    # The raw version data.
+    # @return [Hash] the raw version data for the Rune.rb project.
+    def raw
+      Oj.load(URI.open("http://db.objects.pw:32960/api/v1/project/#{ENV['RRB_PROJECT_SIGNATURE'] || '13360515828940800000'}").read)
+    end
+  end
+end
+
+# Copyright (c) 2022, 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/app/rrb.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+Dir[File.dirname(__FILE__)].each { |file| $LOAD_PATH.unshift(file) if File.directory? file }
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'dotenv'
+require 'druuid'
+require 'eventmachine'
+require 'logger'
+require 'oj'
+require 'open-uri'
+require 'pastel'
+require 'pry'
+require 'singleton'
+require 'set'
+
+##
+# RuneRb -
+#  A gameserver framework written in Ruby targeting the 2006 era (or the 317-377 protocols) of the popular MMORPG, RuneScape.
+#
+# @author Patrick W.
+# @since 0.0.1
+module RuneRb
+
+  # Utility objects and modules.
+  module Utils
+    autoload :Controller,                       'rrb/utils/controller'
+    autoload :Environment,                      'rrb/utils/environment'
+    autoload :Logging,                          'rrb/utils/logging'
+    autoload :Version,                          'rrb/utils/version'
+  end
+
+  # Refinements to provide special functionality and behavior(s) to specific objects.
+  module Patches
+    autoload :IntegerRefinements,               'rrb/patches/integer'
+    autoload :StringRefinements,                'rrb/patches/string'
+    autoload :SetRefinements,                   'rrb/patches/set'
+  end
+
+  RuneRb.extend(RuneRb::Utils::Version)
+  RuneRb.extend(RuneRb::Utils::Environment)
+end
+
+# Copyright (c) 2022, 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.

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: rrb
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Patrick W.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: druuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.10
+- !ruby/object:Gem::Dependency
+  name: open-uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+description:
+email: Sickday@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/rrb.rb
+- app/rrb/patches/integer.rb
+- app/rrb/patches/set.rb
+- app/rrb/patches/string.rb
+- app/rrb/utils/controller.rb
+- app/rrb/utils/environment.rb
+- app/rrb/utils/logging.rb
+- app/rrb/utils/version.rb
+homepage: https://git.repos.pw/rune.rb/app
+licenses:
+- BSD-3-Clause
+metadata:
+  source_code_uri: https://git.repos.pw/rune.rb/app
+post_install_message:
+rdoc_options: []
+require_paths:
+- app
+- app/rrb
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A gameserver framework written in Ruby targeting the 2006 era (or the 317-377
+  protocols) of the popular MMORPG, RuneScape.
+test_files: []