minecraft-server 0.0.1.pre.44 → 0.0.1.pre.45

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDU4ODEwZjI3NTY5MzhlOGY0NGZlZWZkODZlZDAzNTAyYWY3ZmFiYQ==
+    ZjUzOGMxNGQ3NjU4NjNhN2ZhNWUzN2E0MTQwN2RhZTMzOGY1N2E3YQ==
   data.tar.gz: !binary |-
-    N2ExMWMwMGNhODI2MDE2YWJiNDdkNzQ0YmU5NmQwMmQ5ZDQyNWE5Zg==
+    NmNjOTUyYWE3ZGU1NDBmMjcwNjcxNmY3ZTBhYWRjOTU2ZjUzOWQ0Mw==
 SHA512:
   metadata.gz: !binary |-
-    M2U1Mzg5ZGZlODZlY2M5ZjFlNmM4ODEwMDA3MTk2NjgxMmM1NTg2ODc1MjA0
-    ZDFkM2FiYjM2NmQ3NDU3YzA5ZTg5ODM1NGEzODdmMTNlMWJhZTEzNDQzYTVj
-    NDRhYjkxMGJhNmUxMmRmOWQzZmIxZjE1ZmQyM2IyZmU5YWVlNWM=
+    M2JiMmMxMDY2MWJlMmFjZWZkZGRkYjY0NjgzMTY3Yzg4ZTY2MmIwY2E3Yjk0
+    NDg5N2I2NDk2Njg4YzlmOGNlZTViMzBjNjk4YWJiMWU0ZjE2ZTk3NzY0NjAz
+    YWMyMGEyZDRiYTM3YWU3ZGY0OTFkNmEwZGE1MWZmMmUwNTE1MDI=
   data.tar.gz: !binary |-
-    Y2UyYjE3MWFkZjJiNmFiM2JmMTBmZjY4YTZhMjE2ODliYmJhZjFhYmNmMWE4
-    Zjg4ODU2N2Q2NTkwNjYyYmJiZTA3ZjI5MzllNGRhNDUyMDI1YjFjOTJmNTEz
-    ODZjZGZhYmRkYTdiNzJlNWQxM2MyNmY2MTJhNmEwMTVkN2VkMjQ=
+    NmRiYjQxM2E5MzI5N2UzYzRlZmU3M2RiMWIwYWE2NzBlYzc2YWNkZGFjMDli
+    ODg4ODU5NzQzZWU1Yjc5Y2Q2MWFlYTZjMTk1MzNhYmZjOTBmMGY0MDZkOWUy
+    Y2UzMDMzZDg4MWJlMGZlNWRlMzc5YjY1M2JjNmE4NjMyOWEzZGI=

data/lib/minecraft/server/config.rb

@@ -1,8 +1,18 @@
 module Minecraft
   class Server
+    # DSL with methods defining how the {Minecraft::Server} should run.
+    # Contains methods for APIs and network setting the {Minecraft::Server} should implement.
     class Config
+      # @!attribute [r] config
+      #   The current hash containing the configuration attributes this class is currently working with.
+      #   @return [Hash] The configuration attributes
       attr_reader :config
 
+      # Creates this instance so that the file in question will load against the DSL and load values into the config
+      #   hash.
+      # As well, runs each method before the file is fun so that if an attribute is not defined that default value can
+      #   loaded into the config hash.
+      # @param file [String, File] the file conforming to the DSL in this class
       def initialize(file)
         @config = {}
 
@@ -17,7 +27,7 @@ module Minecraft
         self.instance_eval(File.read(file), file)
       end
 
-      ## APIs being Implemented by the Server
+      # @!group APIs being Implemented by the Server
 
       # Representation of whether or not this instance of {Minecraft::Server} is compatible with the {Bukkit} API.
       # @return [Boolean] Whether or not this instance of {Minecraft::Server} is using the {Bukkit} API.
@@ -44,7 +54,9 @@ module Minecraft
         @config[:sponge] = boolean
       end
 
-      ## Network Settings
+      # @!endgroup
+
+      # @!group Network Settings
 
       # Representation of the port used for network communication.
       # @return [Integer] The port used for network communication
@@ -56,9 +68,13 @@ module Minecraft
         @config[:max_players] = players
       end
       alias_method :player_limit, :max_players
+
+      # #!endgroup
     end
 
+    # Creates a valid default config file with recommended defaults.
     class ConfigFile
+      # The default configuration file, each array entry is a separate line of the file.
       DEFAULT_FILE = [
           '## APIs being Implemented By Server',
           '',
@@ -73,6 +89,8 @@ module Minecraft
           'max_players 20'
       ]
 
+      # Creates a default configuration file.
+      # @param file [String] the location of the file you wish to file
       def initialize(file)
         File.open(file, 'w+') do |f|
           f.puts DEFAULT_FILE

data/lib/minecraft/server/logger.rb

@@ -2,7 +2,17 @@ require 'log4r'
 
 module Minecraft
   class Server
+    # Instance of Log4R's Logger which sets up a proper logging setup at initialization.
+    # Set's the Logger to log to the Shell session the {Minecraft::Server} is running in.
+    # As well creates and logs to two log files in the `logs` directory, under the current directory the server is running
+    #   from.
+    # One log is created simply under the name `latest.log` and is cleared and relogged to at each server start.
+    # Another log file is created with a name based from the date and time the server was started, under the format
+    #   `(Year)-(Month)-(Date)--(Hour)-(Minute)-(Second).log`.
     class Logger < Log4r::Logger
+      # Create an instance of Log4R's Logger which logs to the Shell Session, Latest Log File, and Timed Log File.
+      # @param title [String] Name to be applied to the instance of log, different instance can, and should, have
+      #   different names.
       def initialize(title = 'Minecraft Server')
         super title
         self.outputters << Log4r::Outputter.stdout

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minecraft-server
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.44
+  version: 0.0.1.pre.45
 platform: ruby
 authors:
 - Kepler Sticka-Jones