MonkeyEngine 1.0.0

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in monkeyengine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gene M. Angelo, Jr.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# MonkeyEngine
+
+Have some fun! MonkeyEngine is a gem that allows virtual monkeys to tap away on a virtual keyboard. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'MonkeyEngine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install MonkeyEngine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require File.expand_path('../lib/tasks/engine.rb', __FILE__)
+

data/lib/Action/action.rb

@@ -0,0 +1,29 @@
+require 'time'
+
+# Defines a base action.
+class Action
+  attr_reader :value, :weight
+  attr_accessor :action_time
+
+  def initialize(value, weight)
+    @value = value
+    @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
+
+  protected
+  def validate
+    # throw if invalid state
+  end
+end

data/lib/Monkey.rb

@@ -0,0 +1 @@
+require_relative 'Monkey/monkey'

data/lib/Monkey/monkey.rb

@@ -0,0 +1,108 @@
+require 'thread'
+
+require 'MonkeyActions'
+require 'MonkeyService'
+require 'ProtectedConstructor'
+
+# Monkey class.
+#
+# @note The Monkey class represents a virtual monkey that performs particular _actions_
+#   that may or may not be typical of a real monkey.  Monkey _actions_ are derived from class _MonkeyAction_.
+#
+# @note The constructor for this class is protected; to instantiate a managed _Monkey_, use
+#   MonkeyEngine::MonkeyService#add; to instantiate an unmanaged _Monkey_, use MonkeyFactory::create.
+#
+# @see MonkeyAction
+# @see MonkeyEngine::MonkeyService#add
+# @see MonkeyFactory::create
+#
+class Monkey
+  include ProtectedConstructor
+
+  # @!attribute [r] monkey_symbol
+  #   @return [Symbol] the _Symbol_ that identifies this Monkey.
+  # @!attribute [r] action
+  #   @return [MonkeyAction] the current _MonkeyAction_ that this _Monkey_ is engaged in.
+  #
+  attr_reader :monkey_symbol, :action
+
+  protected
+  def initialize(monkey_symbol)
+    @monkey_symbol = monkey_symbol
+    @monkey_service = MonkeyEngine::MonkeyService.instance
+    self
+  end
+
+  public
+
+  # Determines if the Monkey is alive.
+  #
+  # @note The Monkey is considered alive if the Monkey#thread.alive? is true.
+  #
+  # @return [Boolean] true if the Monkey is alive, false otherwise.
+  #
+  def alive?
+    return false if @thread.nil?
+    @thread.alive?
+  end
+
+  # Retrieves the current _Action_ that this Monkey is engaged in.
+  #
+  # @return [MonkeyAction] The _MonkeyAction_.
+  #
+  def current_action
+    return MonkeyActionDead.new(self) unless alive?
+    @action
+  end
+
+  # Kills this Monkey.
+  #
+  # @note The Monkey#monkey_do method executed continually by Monkey#thread is
+  #  terminated.
+  #
+  def kill
+    @kill_thread = true
+  end
+
+  # Starts this Monkey.
+  #
+  # @raise [MonkeyEngine::Exceptions::InvalidOperationException] if Monkey#thread is already alive? (started).
+  #
+  # @return [Monkey, self]
+  #
+  def start
+    raise MonkeyEngine::Exceptions::InvalidOperationException.new "The monkey [#{@monkey_symbol}] thread is already started" \
+      if alive?
+    initialize_thread
+    self
+  end
+
+  # The thread that this Monkey uses to perform its actions.
+  #
+  # @return [Thread]
+  #
+  def thread
+    @thread
+  end
+
+  protected
+  def initialize_thread
+    @sleep_time = 1.0/250.0
+    @kill_thread = false
+
+    @thread = Thread.new {
+      monkey_do
+    }
+
+    #@thread.freeze
+    @thread.abort_on_exception = true
+  end
+
+  def monkey_do
+    until @kill_thread do
+      @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

data/lib/MonkeyAction/monkey_action.rb

@@ -0,0 +1,14 @@
+require 'Action/action'
+
+# MonkeyAction.
+class MonkeyAction < Action
+  attr_reader :monkey
+
+  def initialize(monkey, value, weight)
+    super value, weight
+
+    @monkey = monkey
+
+    self
+  end
+end

data/lib/MonkeyAction/monkey_action_dead.rb

@@ -0,0 +1,26 @@
+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 ]
+
+  def initialize(monkey)
+    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)
+  end
+end

data/lib/MonkeyAction/monkey_action_eat.rb

@@ -0,0 +1,31 @@
+require 'time'
+
+require_relative 'monkey_action'
+require_relative 'monkey_timed_action'
+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
+
+  def initialize(monkey, value)
+    super monkey, value, WEIGHT
+
+    @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)
+  end
+end

data/lib/MonkeyAction/monkey_action_pause.rb

@@ -0,0 +1,32 @@
+require 'time'
+
+require_relative 'monkey_action'
+require_relative 'monkey_timed_action'
+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)
+
+  def initialize(monkey, value)
+    super monkey, value, WEIGHT
+
+    @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)
+  end
+
+end

data/lib/MonkeyAction/monkey_action_sleep.rb

@@ -0,0 +1,31 @@
+require 'time'
+
+require_relative 'monkey_action'
+require_relative 'monkey_timed_action'
+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
+
+  def initialize(monkey, value)
+    super monkey, value, WEIGHT
+
+    @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)
+  end
+end

data/lib/MonkeyAction/monkey_action_type.rb

@@ -0,0 +1,40 @@
+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"  \
+      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)
+
+    @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"  \
+      if @value.nil?
+
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "Value '#{value}' is not a valid argument type (#{value.class.name})"  \
+      unless @value.is_a?(Array)
+
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException.new "Value '#{value}' cannot be empty"  \
+      if @value.empty?
+  end
+end

data/lib/MonkeyAction/monkey_action_wake.rb

@@ -0,0 +1,26 @@
+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 ]
+
+  def initialize(monkey)
+    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)
+  end
+end

data/lib/MonkeyAction/monkey_timed_action.rb

@@ -0,0 +1,27 @@
+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)
+    super monkey, value, weight
+
+    @action_time_of_completion = nil
+
+    validate
+
+    self
+  end
+
+  protected
+  def validate
+    raise MonkeyEngine::Exceptions::NilArgumentException.new "Value '#{value}' cannot be nil"  \
+      if @value.nil?
+
+    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException.new "Value '#{value}' is not a valid argument type"  \
+      unless @value.is_a?(Integer)
+  end
+end