MonkeyEngine 2.0.0 → 2.0.1

data/monkeyengine.gemspec

@@ -11,10 +11,14 @@ Gem::Specification.new do |spec|
   spec.version       = MonkeyEngine::VERSION
   spec.authors       = ['Gene M. Angelo, Jr.']
   spec.email         = ['public.gma@gmail.com']
-  spec.description   = "Have some fun! MonkeyEngine is a gem that allows virtual monkeys to tap away on a virtual keyboard! Can any of them complete a sentence? write a book? The sky's the limit! Add your own AI! Publish the results! Go...BANANAS!"
+  spec.description   = "Have some fun! MonkeyEngine is a gem that allows virtual monkeys " \
+    "to tap away on a virtual keyboard! Can any of them complete a sentence? " \
+    "write a book? The sky is the limit! Add your own AI! Publish the results! " \
+    "Go...BANANAS!"
   spec.summary       = 'The engine that drives my monkeys!'
   spec.homepage      = 'https://github.com/gangelo/monkeyengine'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.1'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/action_rules_spec.rb

@@ -8,14 +8,8 @@ require 'MonkeyActions'
 require_relative '../lib/MonkeyKeyboard/keyboard_input'
 
 describe 'ActionRules' do
-  before(:each) do
-  end
-
-  after(:all) do
-  end
-
   context 'get_next_action' do
-    it 'should throw an exception if the action is not completed' do
+    it 'throws an exception if the action is not completed' do
       monkey = MonkeyFactory.create :groucho
 
       monkey.extend(SpecHelpers::SetMonkeyAction)
@@ -26,24 +20,24 @@ describe 'ActionRules' do
       action = MonkeyActionType.new(monkey, keyboard_input)
       action.action_completed = false
 
-      monkey.set_action(action)
+      monkey.force_action(action)
 
       lambda {
         ActionRules.instance.get_next_action monkey
       }.should raise_error MonkeyEngine::Exceptions::InvalidOperationException
     end
 
-    it 'should get correct action if current action is nil?' do
+    it 'gets correct action if current action is nil?' do
       monkey = MonkeyFactory.create :groucho
 
       monkey.extend(SpecHelpers::SetMonkeyAction)
 
-      monkey.set_action(nil)
+      monkey.force_action(nil)
 
-      ActionRules.instance.get_next_action(monkey).is_a?(MonkeyActionWake).should == true
+      ActionRules.instance.get_next_action(monkey).is_a?(MonkeyActionWake).should be true
     end
 
-    it 'should get correct action if current action is MonkeyActionSleep' do
+    it 'gets correct action if current action is MonkeyActionSleep' do
       monkey = MonkeyFactory.create :groucho
 
       monkey.extend(SpecHelpers::SetMonkeyAction)
@@ -51,9 +45,9 @@ describe 'ActionRules' do
       action = MonkeyActionSleep.new(monkey, 6 * 60)
       action.action_completed = true
 
-      monkey.set_action(action)
+      monkey.force_action(action)
 
-      ActionRules.instance.get_next_action(monkey).is_a?(MonkeyActionWake).should == true
+      ActionRules.instance.get_next_action(monkey).is_a?(MonkeyActionWake).should be true
     end
   end
 end

data/spec/engine_spec.rb

@@ -5,46 +5,46 @@ require 'MonkeyActions'
 require 'MonkeyFactory'
 
 describe 'Engine' do
-  before(:each) do
+  before do
     @engine = MonkeyEngine::Engine.instance
     @monkey = MonkeyFactory.create :groucho
     @monkey.extend(SpecHelpers::SetMonkeyAction)
   end
 
   context 'action_eval!' do
-    it 'should return action completed if the action is completed' do
+    it 'returns action completed if the action is completed' do
       action = MonkeyActionPause.new(@monkey, 10)
       action.action_completed = false
       action.action_time_of_completion = action.action_time
 
-      @monkey.set_action(action)
+      @monkey.force_action(action)
 
-      @engine.action_eval!(action).should == true
+      @engine.action_eval!(action).should be true
     end
 
-    it 'should return action not completed if the action is not completed' do
+    it 'returns action not completed if the action is not completed' do
       action = MonkeyActionPause.new(@monkey, 60)
       action.action_completed = false
 
-      @monkey.set_action(action)
+      @monkey.force_action(action)
 
-      @engine.action_eval!(action).should == false
+      @engine.action_eval!(action).should be false
     end
   end
 
   context 'action_new' do
-    it 'should return a new action if a the current action is completed' do
+    it 'returns a new action if a the current action is completed' do
       action = MonkeyActionSleep.new(@monkey, 60 * 8)
       action.action_completed = true
 
-      @monkey.set_action(action)
+      @monkey.force_action(action)
 
       @engine.new_action(@monkey).is_a?(MonkeyActionSleep).should_not == true
     end
   end
 
   context 'do_action' do
-    it 'should do something' do
+    it 'does something' do
       skip 'todo'
     end
   end

data/spec/keyboard_char_spec.rb

@@ -3,7 +3,7 @@
 require 'MonkeyKeyboardEnUs'
 
 describe 'KeyboardChar' do
-  it 'should return the proper char that it represents' do
+  it 'returns the proper char that it represents' do
     keyboard_char = KeyboardChar.new 'a'
 
     keyboard_char.char.should == 'a'

data/spec/keyboard_key_spec.rb

@@ -3,12 +3,12 @@
 require 'MonkeyKeyboardEnUs'
 
 describe 'KeyboardKey' do
-  it 'should should return correct properties' do
+  it 'shoulds return correct properties' do
     keyboard_key = KeyboardKey.new 'a', 'A', :left, 1
 
-    keyboard_key.keyboard_char.should == 'a'
-    keyboard_key.keyboard_shift_char.should == 'A'
-    keyboard_key.keyboard_key_section.should == :left
-    keyboard_key.keyboard_key_weight.should == 1
+    keyboard_key.keyboard_char.should eq 'a'
+    keyboard_key.keyboard_shift_char.should eq 'A'
+    keyboard_key.keyboard_key_section.should eq :left
+    keyboard_key.keyboard_key_weight.should eq 1
   end
 end

data/spec/monkey_action_eat_spec.rb

@@ -23,10 +23,10 @@ describe 'MonkeyActionEat' do
     MonkeyEngine::MonkeyManager.instance.join_all(10)
   end
 
-  it_should_behave_like 'MonkeyAction'
+  it_behaves_like 'MonkeyAction'
 
   it '@it should be the correct type' do
-    @it.is_a?(MonkeyActionEat).should == true
+    @it.is_a?(MonkeyActionEat).should be true
   end
 
   # Monkey
@@ -40,7 +40,7 @@ describe 'MonkeyActionEat' do
   end
 
   it '@value should be is_a? Integer' do
-    @it.value.is_a?(Integer).should == true
+    @it.value.is_a?(Integer).should be true
   end
 
   # Weight
@@ -49,34 +49,34 @@ describe 'MonkeyActionEat' do
   end
 
   # validate
-  it 'should not raise an error if value is within acceptable range' do
+  it 'does not raise an error if value is within acceptable range' do
     monkey = MonkeyFactory.create(:eating_monkey2)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionEat.new(monkey, 40) }.should_not raise_error
   end
 
-  it 'should raise an error if value is the wrong type' do
+  it 'raises an error if value is the wrong type' do
     monkey = MonkeyFactory.create(:eating_monkey3)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionEat.new(monkey, :wrong_type) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentTypeException
   end
 
-  it 'should raise an error if value is less than min acceptable range' do
+  it 'raises an error if value is less than min acceptable range' do
     monkey = MonkeyFactory.create(:eating_monkey4)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionEat.new(monkey, 29) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentValueException
   end
 
-  it 'should raise an error if value is greater than max acceptable range' do
+  it 'raises an error if value is greater than max acceptable range' do
     monkey = MonkeyFactory.create(:eating_monkey5)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionEat.new(monkey, 61) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentValueException
   end
 
-  it 'should raise an error if value is nil' do
+  it 'raises an error if value is nil' do
     monkey = MonkeyFactory.create(:eating_monkey6)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionEat.new(monkey, nil) }.should \

data/spec/monkey_action_pause_spec.rb

@@ -24,10 +24,10 @@ describe 'MonkeyActionPause' do
     MonkeyEngine::MonkeyManager.instance.join_all(10)
   end
 
-  it_should_behave_like 'MonkeyAction'
+  it_behaves_like 'MonkeyAction'
 
   it '@it should be the correct type' do
-    @it.is_a?(MonkeyActionPause).should == true
+    @it.is_a?(MonkeyActionPause).should be true
   end
 
   # Monkey
@@ -41,11 +41,11 @@ describe 'MonkeyActionPause' do
   end
 
   it '@value should be is_a? Integer' do
-    @it.value.is_a?(Integer).should == true
+    @it.value.is_a?(Integer).should be true
   end
 
   it '@value should >= 1' do
-    (@it.value >= 1).should == true
+    (@it.value >= 1).should be true
   end
 
   # Weight
@@ -54,34 +54,34 @@ describe 'MonkeyActionPause' do
   end
 
   # validate
-  it 'should not raise an error if value is within acceptable range' do
+  it 'does not raise an error if value is within acceptable range' do
     monkey = MonkeyFactory.create(:pausing_monkey2)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionPause.new(monkey, 5) }.should_not raise_error
   end
 
-  it 'should raise an error if value is the wrong type' do
+  it 'raises an error if value is the wrong type' do
     monkey = MonkeyFactory.create(:pausing_monkey3)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionPause.new(monkey, :wrong_type) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentTypeException
   end
 
-  it 'should raise an error if value is less than min acceptable range' do
+  it 'raises an error if value is less than min acceptable range' do
     monkey = MonkeyFactory.create(:pausing_monkey4)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionPause.new(monkey, -1) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentValueException
   end
 
-  it 'should raise an error if value is greater than max acceptable range' do
+  it 'raises an error if value is greater than max acceptable range' do
     monkey = MonkeyFactory.create(:pausing_monkey5)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionPause.new(monkey, 61) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentValueException
   end
 
-  it 'should raise an error if value is nil' do
+  it 'raises an error if value is nil' do
     monkey = MonkeyFactory.create(:pausing_monkey6)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionPause.new(monkey, nil) }.should \

data/spec/monkey_action_sleep_spec.rb

@@ -23,10 +23,10 @@ describe 'MonkeyActionSleep' do
     MonkeyEngine::MonkeyManager.instance.join_all(10)
   end
 
-  it_should_behave_like 'MonkeyAction'
+  it_behaves_like 'MonkeyAction'
 
   it '@it should be the correct type' do
-    @it.is_a?(MonkeyActionSleep).should == true
+    @it.is_a?(MonkeyActionSleep).should be true
   end
 
   # Monkey
@@ -40,11 +40,11 @@ describe 'MonkeyActionSleep' do
   end
 
   it '@value should be is_a? Integer' do
-    @it.value.is_a?(Integer).should == true
+    @it.value.is_a?(Integer).should be true
   end
 
   it '@value should equal 60 * 8' do
-    (@it.value == 60 * 8).should == true
+    (@it.value == 60 * 8).should be true
   end
 
   # Weight
@@ -53,34 +53,34 @@ describe 'MonkeyActionSleep' do
   end
 
   # validate
-  it 'should not raise an error if value is within acceptable range' do
+  it 'does not raise an error if value is within acceptable range' do
     monkey = MonkeyFactory.create(:sleeping_monkey2)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionSleep.new(monkey, 60 * 8) }.should_not raise_error
   end
 
-  it 'should raise an error if value is the wrong type' do
+  it 'raises an error if value is the wrong type' do
     monkey = MonkeyFactory.create(:sleeping_monkey3)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionSleep.new(monkey, :wrong_type) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentTypeException
   end
 
-  it 'should raise an error if value is less than min acceptable range' do
+  it 'raises an error if value is less than min acceptable range' do
     monkey = MonkeyFactory.create(:sleeping_monkey4)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionSleep.new(monkey, 60 * 5) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentValueException
   end
 
-  it 'should raise an error if value is greater than max acceptable range' do
+  it 'raises an error if value is greater than max acceptable range' do
     monkey = MonkeyFactory.create(:sleeping_monkey5)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionSleep.new(monkey, 60 * 9) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentValueException
   end
 
-  it 'should raise an error if value is nil' do
+  it 'raises an error if value is nil' do
     monkey = MonkeyFactory.create(:sleeping_monkey6)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionSleep.new(monkey, nil) }.should \

data/spec/monkey_action_type_spec.rb

@@ -28,10 +28,10 @@ describe 'MonkeyActionType' do
     MonkeyEngine::MonkeyManager.instance.join_all(10)
   end
 
-  it_should_behave_like 'MonkeyAction'
+  it_behaves_like 'MonkeyAction'
 
   it '@it should be the correct type' do
-    @it.is_a?(MonkeyActionType).should == true
+    @it.is_a?(MonkeyActionType).should be true
   end
 
   # Monkey
@@ -45,7 +45,7 @@ describe 'MonkeyActionType' do
   end
 
   it '@value should be is_a? Array' do
-    @it.value.is_a?(Array).should == true
+    @it.value.is_a?(Array).should be true
   end
 
   it '@value should not be nil?' do
@@ -58,7 +58,7 @@ describe 'MonkeyActionType' do
   end
 
   # validate
-  it 'should not raise an error if value is valid' do
+  it 'does not raise an error if value is valid' do
     monkey = MonkeyFactory.create(:typing_monkey2)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
 
@@ -68,14 +68,14 @@ describe 'MonkeyActionType' do
     -> { MonkeyActionType.new(monkey, keyboard_input) }.should_not raise_error
   end
 
-  it 'should raise an error if value is the wrong type' do
+  it 'raises an error if value is the wrong type' do
     monkey = MonkeyFactory.create(:typing_monkey3)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionType.new(monkey, :wrong_type) }.should \
       raise_error MonkeyEngine::Exceptions::InvalidArgumentTypeException
   end
 
-  it 'should raise an error if value is empty?' do
+  it 'raises an error if value is empty?' do
     monkey = MonkeyFactory.create(:typing_monkey4)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
 
@@ -86,7 +86,7 @@ describe 'MonkeyActionType' do
       raise_error MonkeyEngine::Exceptions::InvalidArgumentValueException
   end
 
-  it 'should raise an error if value is nil' do
+  it 'raises an error if value is nil' do
     monkey = MonkeyFactory.create(:typing_monkey5)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionType.new(monkey, nil) }.should \

data/spec/monkey_action_wake_spec.rb

@@ -23,10 +23,10 @@ describe 'MonkeyActionWake' do
     MonkeyEngine::MonkeyManager.instance.join_all(10)
   end
 
-  it_should_behave_like 'MonkeyAction'
+  it_behaves_like 'MonkeyAction'
 
   it '@it should be the correct type' do
-    @it.is_a?(MonkeyActionWake).should == true
+    @it.is_a?(MonkeyActionWake).should be true
   end
 
   # Monkey
@@ -36,11 +36,11 @@ describe 'MonkeyActionWake' do
 
   # Value
   it '@value should return the right value' do
-    @it.value.should == true
+    @it.value.should be true
   end
 
   it '@value should be is_a? TrueClass' do
-    @it.value.is_a?(TrueClass).should == true
+    @it.value.is_a?(TrueClass).should be true
   end
 
   # Weight
@@ -49,7 +49,7 @@ describe 'MonkeyActionWake' do
   end
 
   # validate
-  it 'should not raise an error if value is within acceptable range' do
+  it 'does not raise an error if value is within acceptable range' do
     monkey = MonkeyFactory.create(:waking_monkey2)
     MonkeyEngine::MonkeyManager.instance.add(monkey)
     -> { MonkeyActionWake.new(monkey) }.should_not raise_error

data/spec/monkey_factory_spec.rb

@@ -3,20 +3,12 @@
 require 'MonkeyFactory'
 
 describe 'MonkeyFactory' do
-  before(:all) do
-  end
-
-  after(:all) do
-  end
-
   context 'create' do
-    it 'should instantiate an object from the factory' do
-      monkey = MonkeyFactory.create(:harpo)
-      monkey.nil?.should == false
-      monkey.is_a?(Monkey).should == true
+    it 'instantiates an object from the factory' do
+      MonkeyFactory.create(:harpo).is_a?(Monkey).should be true
     end
 
-    it 'should not instantiate an object without using the factory' do
+    it 'does not instantiate an object without using the factory' do
       -> { Monkey.new :groucho }.should raise_error NoMethodError
     end
   end

data/spec/monkey_keyboard_en_us_spec.rb

@@ -7,14 +7,11 @@ describe 'MonkeyKeyboardEnUs' do
     @it = MonkeyEngine::MonkeyKeyboardEnUs.instance
   end
 
-  context 'keys' do
-  end
-
   context 'left_keys' do
-    it 'should have the correct amount of keyboard entries on the left side of the keyboard' do
+    it 'has the correct amount of keyboard entries on the left side of the keyboard' do
       key_count = 0
 
-      @it.keys.each do |key|
+      @it.keys.each do |key| # rubocop:disable Style/HashEachMethods
         key_count += key.keyboard_key_weight if key.keyboard_key_section == :left
       end
 
@@ -23,10 +20,10 @@ describe 'MonkeyKeyboardEnUs' do
   end
 
   context 'right_keys' do
-    it 'should have the correct amount of keyboard entries on the right side of the keyboard' do
+    it 'has the correct amount of keyboard entries on the right side of the keyboard' do
       key_count = 0
 
-      @it.keys.each do |key|
+      @it.keys.each do |key| # rubocop:disable Style/HashEachMethods
         key_count += key.keyboard_key_weight if key.keyboard_key_section == :right
       end
 

data/spec/monkey_manager_spec.rb

@@ -3,7 +3,7 @@
 describe 'MonkeyManager' do
   before { skip 'todo' }
 
-  it 'should do something' do
+  it 'does something' do
     skip 'todo'
   end
 end

data/spec/monkey_service_spec.rb

@@ -24,26 +24,26 @@ describe 'MonkeyService' do
     @it.join_all(10)
   end
 
-  def update(time, action, param)
+  def update(time, action, _param)
     # puts "Time: [#{time}], Action: [#{action}], Param: [#{param}]"
     puts "Time: [#{time}], Action: [#{action}], Param: <not shown>"
   end
 
   context 'initialization' do
-    it 'it should have 3 monkeys' do
+    it 'has 3 monkeys' do
       @it.count.should == 3
     end
 
-    it 'should have monkey harpo' do
-      @it.exists?(:harpo).should == true
+    it 'has monkey harpo' do
+      @it.exists?(:harpo).should be true
     end
 
-    it 'should have monkey groucho' do
-      @it.exists?(:groucho).should == true
+    it 'has monkey groucho' do
+      @it.exists?(:groucho).should be true
     end
 
-    it 'should have monkey chico' do
-      @it.exists?(:chico).should == true
+    it 'has monkey chico' do
+      @it.exists?(:chico).should be true
     end
   end
 
@@ -59,7 +59,7 @@ describe 'MonkeyService' do
     end
 
     it "'any_alive?' should return objects that are alive" do
-      @it.any_alive?.should == true
+      @it.any_alive?.should be true
     end
   end
 
@@ -71,7 +71,7 @@ describe 'MonkeyService' do
       # Give them a little bit to finish.
       @it.join_all(10)
 
-      @it.any_alive?.should == false
+      @it.any_alive?.should be false
     end
 
     it 'kill_all! should return all monkeys killed' do
@@ -87,7 +87,7 @@ describe 'MonkeyService' do
 
       monkey_service.join_all(10)
 
-      (monkeys == killed_monkeys).should == true
+      (monkeys == killed_monkeys).should be true
     end
   end
 end

data/spec/monkey_spec.rb

@@ -3,7 +3,7 @@
 describe 'Monkey' do
   before { skip 'todo' }
 
-  it 'should do something' do
+  it 'does something' do
     skip 'todo'
   end
 end

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ require 'pry-byebug'
 
 module SpecHelpers
   module SetMonkeyAction
-    def set_action(action)
+    def force_action(action)
       @action = action
     end
   end

data/spec/support/shared_examples.rb

@@ -2,27 +2,27 @@
 
 # Shared for monkey action.
 shared_examples_for 'MonkeyAction' do
-  it 'should have read access to monkey' do
-    @it.respond_to?(:monkey).should == true
+  it 'has read access to monkey' do
+    @it.respond_to?(:monkey).should be true
   end
 
-  it 'should not have write access to monkey' do
+  it 'does not have write access to monkey' do
     @it.respond_to?(:monkey=).should_not == true
   end
 
-  it_should_behave_like 'Action'
+  it_behaves_like 'Action'
 end
 
 # Action
 shared_examples_for 'Action' do
-  it 'should respond_to? :value' do
+  it 'respond_to?s :value' do
     # "Value: #{@it.value}"
-    @it.respond_to?(:value).should == true
+    @it.respond_to?(:value).should be true
   end
 
-  it 'should respond_to? :weight' do
+  it 'respond_to?s :weight' do
     # "Weight: #{@it.weight}"
-    @it.respond_to?(:weight).should == true
+    @it.respond_to?(:weight).should be true
   end
 
   # value
@@ -36,6 +36,6 @@ shared_examples_for 'Action' do
   end
 
   it '@weight should be is_a? Float' do
-    @it.weight.is_a?(Float).should == true
+    @it.weight.is_a?(Float).should be true
   end
 end