MonkeyEngine 1.1.0 → 2.0.1

data/lib/Action/action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 
 # Defines a base action.
@@ -10,20 +12,17 @@ class Action
     @weight = weight
     @action_time = Time.now
     @action_completed = false
-
-    self
   end
 
   def action_completed?
     @action_completed
   end
 
-  def action_completed=(value)
-    @action_completed = value
-  end
+  attr_writer :action_completed
 
   protected
+
   def validate
     # throw if invalid state
   end
-end
+end

data/lib/Monkey/monkey.rb

@@ -1,4 +1,4 @@
-require 'thread'
+# frozen_string_literal: true
 
 require 'MonkeyActions'
 require 'MonkeyService'
@@ -27,10 +27,10 @@ class Monkey
   attr_reader :monkey_symbol, :action
 
   protected
+
   def initialize(monkey_symbol)
     @monkey_symbol = monkey_symbol
     @monkey_service = MonkeyEngine::MonkeyService.instance
-    self
   end
 
   public
@@ -43,6 +43,7 @@ class Monkey
   #
   def alive?
     return false if @thread.nil?
+
     @thread.alive?
   end
 
@@ -52,6 +53,7 @@ class Monkey
   #
   def current_action
     return MonkeyActionDead.new(self) unless alive?
+
     @action
   end
 
@@ -71,8 +73,11 @@ class Monkey
   # @return [Monkey, self]
   #
   def start
-    raise MonkeyEngine::Exceptions::InvalidOperationException.new "The monkey [#{@monkey_symbol}] thread is already started" \
-      if alive?
+    if alive?
+      raise MonkeyEngine::Exceptions::InvalidOperationException,
+        "The monkey [#{@monkey_symbol}] thread is already started"
+    end
+
     initialize_thread
     self
   end
@@ -81,28 +86,27 @@ class Monkey
   #
   # @return [Thread]
   #
-  def thread
-    @thread
-  end
+  attr_reader :thread
 
   protected
+
   def initialize_thread
-    @sleep_time = 1.0/250.0
+    @sleep_time = 1.0 / 250.0
     @kill_thread = false
 
-    @thread = Thread.new {
+    @thread = Thread.new do
       monkey_do
-    }
+    end
 
-    #@thread.freeze
+    # @thread.freeze
     @thread.abort_on_exception = true
   end
 
   def monkey_do
-    until @kill_thread do
+    until @kill_thread
       @action = @monkey_service.new_action(self) if @action.nil? || @action.action_completed?
       @monkey_service.monkey_do @action unless @monkey_service.action_eval! @action
       sleep(@sleep_time)
     end
   end
-end
+end

data/lib/Monkey.rb

@@ -1 +1,3 @@
-require_relative 'Monkey/monkey'
+# frozen_string_literal: true
+
+require_relative 'Monkey/monkey'

data/lib/MonkeyAction/monkey_action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'Action/action'
 
 # MonkeyAction.
@@ -8,7 +10,5 @@ class MonkeyAction < Action
     super value, weight
 
     @monkey = monkey
-
-    self
   end
-end
+end

data/lib/MonkeyAction/monkey_action_dead.rb

@@ -1,26 +1,26 @@
+# frozen_string_literal: true
+
 require_relative 'monkey_action'
 require 'MonkeyEngine/exceptions'
 
 # Monkey action:  dead (as in not alive)
 # The monkey has been killed - the thread is not running.
 class MonkeyActionDead < MonkeyAction
-
   WEIGHT = 100.0
-  VALID_VALUES = [ true ]
+  VALID_VALUES = [true].freeze
 
   def initialize(monkey)
-    super monkey, true , WEIGHT
+    super monkey, true, WEIGHT
 
     validate
-
-    self
   end
 
   protected
+
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException.new "Value '#{value}' is not a valid value"  \
-      if !VALID_VALUES.include?(@value)
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
+      unless VALID_VALUES.include?(@value)
   end
-end
+end

data/lib/MonkeyAction/monkey_action_eat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 
 require_relative 'monkey_action'
@@ -7,7 +9,6 @@ require 'MonkeyEngine/exceptions'
 # Monkey action:  eat (as in banana)
 # The monkey is eating.
 class MonkeyActionEat < MonkeyTimedAction
-
   WEIGHT = 2.0
   VALID_VALUES = (30..60) # 30 through 60 minutes
 
@@ -17,15 +18,14 @@ class MonkeyActionEat < MonkeyTimedAction
     @action_time_of_completion = @action_time + (value * 60)
 
     validate
-
-    self
   end
 
   protected
+
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException.new "Value '#{value}' is not a valid value"  \
-      if !VALID_VALUES.include?(@value)
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
+      unless VALID_VALUES.include?(@value)
   end
-end
+end

data/lib/MonkeyAction/monkey_action_pause.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 
 require_relative 'monkey_action'
@@ -7,7 +9,6 @@ require 'MonkeyEngine/exceptions'
 # Monkey action:  pause (as in take a break)
 # The monkey paused, usually from typing.
 class MonkeyActionPause < MonkeyTimedAction
-
   WEIGHT = 2.0
   VALID_VALUES = (0..60) # Seconds (0 - 60 seconds)
 
@@ -17,16 +18,14 @@ class MonkeyActionPause < MonkeyTimedAction
     @action_time_of_completion = @action_time + value
 
     validate
-
-    self
   end
 
   protected
+
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException.new "Value '#{value}' is not a valid value"  \
-      if !VALID_VALUES.include?(@value)
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
+      unless VALID_VALUES.include?(@value)
   end
-
-end
+end

data/lib/MonkeyAction/monkey_action_sleep.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 
 require_relative 'monkey_action'
@@ -7,7 +9,6 @@ require 'MonkeyEngine/exceptions'
 # Monkey action:  sleep (as in take a snooze)
 # The monkey is a sleep.
 class MonkeyActionSleep < MonkeyTimedAction
-
   WEIGHT = 10.0
   VALID_VALUES = ((60 * 6)..(60 * 8)) # 6 through 8 hours
 
@@ -17,15 +18,14 @@ class MonkeyActionSleep < MonkeyTimedAction
     @action_time_of_completion = @action_time + (value * (60 * 60))
 
     validate
-
-    self
   end
 
   protected
+
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException.new "Value '#{value}' is not a valid value"  \
-      if !VALID_VALUES.include?(@value)
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
+      unless VALID_VALUES.include?(@value)
   end
-end
+end

data/lib/MonkeyAction/monkey_action_type.rb

@@ -1,40 +1,43 @@
+# frozen_string_literal: true
+
 require_relative 'monkey_action'
 require 'MonkeyEngine/exceptions'
 
 # Monkey action:  type (as in keyboard)
 # The monkey typed something on the keyboard.
 class MonkeyActionType < MonkeyAction
-
   attr_reader :keyboard_input
 
   WEIGHT = 5.0
 
   def initialize(monkey, keyboard_input)
-    raise MonkeyEngine::Exceptions::NilArgumentException.new "keyboard_input '#{keyboard_input}' cannot be nil"  \
+    raise MonkeyEngine::Exceptions::NilArgumentException, "keyboard_input '#{keyboard_input}' cannot be nil" \
       if keyboard_input.nil?
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "keyboard_input '#{keyboard_input}' is not a valid argument type"  \
-      unless keyboard_input.is_a?(KeyboardInput)
+    unless keyboard_input.is_a?(KeyboardInput)
+      raise MonkeyEngine::Exceptions::InvalidArgumentTypeException,
+        "keyboard_input '#{keyboard_input}' is not a valid argument type"
+    end
 
     @keyboard_input = keyboard_input
 
     super monkey, @keyboard_input.input, WEIGHT
 
     validate
-
-    self
   end
 
   protected
-  def validate
 
-    raise MonkeyEngine::Exceptions::NilArgumentException.new "Value '#{value}' cannot be nil"  \
+  def validate
+    raise MonkeyEngine::Exceptions::NilArgumentException, "Value '#{value}' cannot be nil" \
       if @value.nil?
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "Value '#{value}' is not a valid argument type (#{value.class.name})"  \
-      unless @value.is_a?(Array)
+    unless @value.is_a?(Array)
+      raise MonkeyEngine::Exceptions::InvalidArgumentTypeException,
+        "Value '#{value}' is not a valid argument type (#{value.class.name})"
+    end
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException.new "Value '#{value}' cannot be empty"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' cannot be empty" \
       if @value.empty?
   end
-end
+end

data/lib/MonkeyAction/monkey_action_wake.rb

@@ -1,26 +1,26 @@
+# frozen_string_literal: true
+
 require_relative 'monkey_action'
 require 'MonkeyEngine/exceptions'
 
 # Monkey action:  wake (as in from sleep)
 # The monkey has awakened from sleep.
 class MonkeyActionWake < MonkeyAction
-
   WEIGHT = 2.0
-  VALID_VALUES = [ true ]
+  VALID_VALUES = [true].freeze
 
   def initialize(monkey)
-    super monkey, true , WEIGHT
+    super monkey, true, WEIGHT
 
     validate
-
-    self
   end
 
   protected
+
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException.new "Value '#{value}' is not a valid value"  \
-      if !VALID_VALUES.include?(@value)
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
+      unless VALID_VALUES.include?(@value)
   end
-end
+end

data/lib/MonkeyAction/monkey_timed_action.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'monkey_action'
 require 'MonkeyEngine/exceptions'
 
 # Monkey action:  one that is timed based on an Integer.
 class MonkeyTimedAction < MonkeyAction
-
   attr_accessor :action_time_of_completion
 
   def initialize(monkey, value, weight)
@@ -12,16 +13,15 @@ class MonkeyTimedAction < MonkeyAction
     @action_time_of_completion = nil
 
     validate
-
-    self
   end
 
   protected
+
   def validate
-    raise MonkeyEngine::Exceptions::NilArgumentException.new "Value '#{value}' cannot be nil"  \
+    raise MonkeyEngine::Exceptions::NilArgumentException, "Value '#{value}' cannot be nil" \
       if @value.nil?
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "Value '#{value}' is not a valid argument type"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, "Value '#{value}' is not a valid argument type" \
       unless @value.is_a?(Integer)
   end
-end
+end

data/lib/MonkeyActions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'MonkeyAction/monkey_action_dead'
 require_relative 'MonkeyAction/monkey_action_eat'
 require_relative 'MonkeyAction/monkey_action_pause'

data/lib/MonkeyEngine/action_rules.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 require 'singleton'
 
@@ -8,14 +10,15 @@ require 'MonkeyKeyboardEnUs'
 class ActionRules
   include Singleton
 
-# Retrieves tne next action for the monkey
-#
-# @param [monkey] the monkey whose next action is to be retrieved
-# @return [MonkeyAction] the next monkey action
+  # Retrieves tne next action for the monkey
+  #
+  # @param [monkey] the monkey whose next action is to be retrieved
+  # @return [MonkeyAction] the next monkey action
   def get_next_action(monkey)
-    raise MonkeyEngine::Exceptions::InvalidOperationException.new \
-        "The action [#{monkey.action.class.name}] for Monkey [#{monkey.monkey_symbol}] must be completed before calling get_next_action" \
-          unless monkey.action.nil? || monkey.action.action_completed?
+    unless monkey.action.nil? || monkey.action.action_completed?
+      raise MonkeyEngine::Exceptions::InvalidOperationException,
+        "The action [#{monkey.action.class.name}] for Monkey [#{monkey.monkey_symbol}] must be completed before calling get_next_action"
+    end
 
     # current_action = monkey.action
 
@@ -34,15 +37,15 @@ class ActionRules
 
     keyboard_input = MonkeyEngine::MonkeyKeyboardEnUs.instance.get_keyboard_input
 
-    return MonkeyActionType.new monkey, keyboard_input
+    MonkeyActionType.new monkey, keyboard_input
   end
 
   # Evaluates an action and sets it to completed if the criteria for completion is met.
   def action_eval!(action)
-    raise MonkeyEngine::Exceptions::NilArgumentException.new "The [action] to be evaluated cannot be nil" \
+    raise MonkeyEngine::Exceptions::NilArgumentException, 'The [action] to be evaluated cannot be nil' \
         if action.nil?
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "The [action] is not the correct type" \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, 'The [action] is not the correct type' \
         unless action.is_a? Action
 
     action_eval_eat(action) if action.is_a?(MonkeyActionEat)
@@ -61,28 +64,28 @@ class ActionRules
   # Action evaluation methods
 
   def action_eval_eat(action)
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "The [action] is not the correct type" \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, 'The [action] is not the correct type' \
         unless action.is_a? MonkeyActionEat
 
     action_eval_timed_action action
   end
 
   def action_eval_pause(action)
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "The [action] is not the correct type" \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, 'The [action] is not the correct type' \
         unless action.is_a? MonkeyActionPause
 
     action_eval_timed_action action
   end
 
   def action_eval_sleep(action)
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "The [action] is not the correct type" \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, 'The [action] is not the correct type' \
         unless action.is_a? MonkeyActionSleep
 
     action_eval_timed_action action
   end
 
   def action_eval_type(action)
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "The [action] is not the correct type" \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, 'The [action] is not the correct type' \
         unless action.is_a? MonkeyActionType
 
     # TODO: How do I evaluate this?
@@ -91,7 +94,7 @@ class ActionRules
   end
 
   def action_eval_wake(action)
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "The [action] is not the correct type" \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, 'The [action] is not the correct type' \
         unless action.is_a? MonkeyActionWake
 
     action.action_completed = true
@@ -100,12 +103,11 @@ class ActionRules
   end
 
   def action_eval_timed_action(action)
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "The [action] is not the correct type" \
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, 'The [action] is not the correct type' \
         unless action.is_a? MonkeyTimedAction
 
     action.action_completed = true if action.action_time_of_completion <= Time.now
 
     action
   end
-
-end
+end

data/lib/MonkeyEngine/exceptions.rb

@@ -1,21 +1,21 @@
-require 'test/unit/assertions'
+# frozen_string_literal: true
 
 module MonkeyEngine
   module Exceptions
-    class InvalidArgumentValueException < ArgumentError;
+    class InvalidArgumentValueException < ArgumentError
     end
 
-    class InvalidArgumentTypeException < ArgumentError;
+    class InvalidArgumentTypeException < ArgumentError
     end
 
-    class NilArgumentException < ArgumentError;
+    class NilArgumentException < ArgumentError
     end
 
     # The object must be unique.
-    class UniqueObjectException < ArgumentError;
+    class UniqueObjectException < ArgumentError
     end
 
-    class InvalidOperationException < ArgumentError;
+    class InvalidOperationException < ArgumentError
     end
   end
-end
+end

data/lib/MonkeyEngine/monkey_engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'observer'
 require 'singleton'
 require 'time'
@@ -6,26 +8,21 @@ require 'MonkeyActions'
 require_relative 'action_rules'
 
 module MonkeyEngine
-
   # Assigns, executes and evaluates actions.
   class Engine
     include Singleton
     include Observable
 
-    private
-    def initialize
-    end
-
-    public
-
     # Evaluates whether or not the action is completed.
     def action_eval!(action)
       ActionRules.instance.action_eval! action
     end
 
     def do_action(action)
-      raise MonkeyEngine::Exceptions::InvalidOperationException.new \
-        "The action [#{action.class.name}] for Monkey [#{action.monkey.monkey_symbol}] is already completed" if action.action_completed?
+      if action.action_completed?
+        raise MonkeyEngine::Exceptions::InvalidOperationException,
+          "The action [#{action.class.name}] for Monkey [#{action.monkey.monkey_symbol}] is already completed"
+      end
 
       do_action_type(action) if action.is_a? MonkeyActionType
 
@@ -42,12 +39,12 @@ module MonkeyEngine
 
     # Returns a new action.
     def new_action(monkey)
-      raise MonkeyEngine::Exceptions::InvalidOperationException.new \
-        "The action [#{monkey.action.class.name}] for Monkey [#{monkey.monkey_symbol}] must be completed before calling new_action" \
-          unless monkey.action.nil? || monkey.action.action_completed?
+      unless monkey.action.nil? || monkey.action.action_completed?
+        raise MonkeyEngine::Exceptions::InvalidOperationException,
+          "The action [#{monkey.action.class.name}] for Monkey [#{monkey.monkey_symbol}] must be completed before calling new_action"
+      end
 
-      return ActionRules.instance.get_next_action monkey
+      ActionRules.instance.get_next_action monkey
     end
-
   end
 end

data/lib/MonkeyEngine/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MonkeyEngine
-  VERSION = "1.1.0"
+  VERSION = '2.0.1'
 end

data/lib/MonkeyEngine.rb

@@ -1 +1,3 @@
-require_relative 'MonkeyEngine/monkey_engine'
+# frozen_string_literal: true
+
+require_relative 'MonkeyEngine/monkey_engine'

data/lib/MonkeyFactory/monkey_factory.rb

@@ -1,14 +1,13 @@
+# frozen_string_literal: true
+
 require 'Monkey'
 
 module MonkeyFactory
-
   class << self
-
-    public
     def create(monkey_symbol)
       # Call the protected constructor - monkeys can only be created
       # via the MonkeyFactory.
       Monkey.send(:new, monkey_symbol)
     end
   end
-end
+end

data/lib/MonkeyFactory.rb

@@ -1 +1,3 @@
-require_relative 'MonkeyFactory/monkey_factory'
+# frozen_string_literal: true
+
+require_relative 'MonkeyFactory/monkey_factory'

data/lib/MonkeyKeyboard/keyboard_char.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 # Represents a keyboard character.
 class KeyboardChar
-
   attr_reader :char
 
   def initialize(char)
     @char = char
-    self
   end
-end
+end

data/lib/MonkeyKeyboard/keyboard_input.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 # Represents keyboard input.
 class KeyboardInput
-
   attr_accessor :is_word, :input
 
   def initialize
     @is_word = false
-    @input = Array.new
+    @input = []
   end
 
   def input_to_s
     @input.join.to_s
   end
-end
+end