MonkeyEngine 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b7e24ee3c17b88e0c4f772fa86fe917e6d481d8a9ee2215ddd10aab1702fc15
-  data.tar.gz: e16ca7bda19a747153ecae1b19a84accb916a6d48c0f3ed7e00bc645fd745463
+  metadata.gz: e6999ecf2d6d8a4c2f0db40d32f38d619a40c55ce53e6616c381650f650500d3
+  data.tar.gz: 21b27a1563e5c59d980c980e4e6c3a6d5bf2c79c0d6c607109a0f165566126dd
 SHA512:
-  metadata.gz: f82982d32dbbb02c011e029386d7ce52df2f85b95f8ef0bfcd88062b5be94a1b118ed6b4dd2bfd9ce48ad2db846e398bd160a89227af96aafbff98dda4f46262
-  data.tar.gz: 7644666c7517d63232da357eda0cc1c95262395ea0680e059e151de5f3a65c6367f70fe65335318a8f39ec479630361faa8582cd69b8c15f21a7a897091716f1
+  metadata.gz: 0c2f2e708dbc90200c22f3d54267724ccaa881d16a21f6628249b11c02a465ae3442b05d8d9a5161ea7b9b02ca66b386f1c4ce378ecd34020effd98795fd99fd
+  data.tar.gz: 02fb5c756fd169cd9c5f4c90d578c7fcac045a0a2406e4c4e202fe154ecf2270ebaab9103470269de1e861851da9ff53cf01e3b816a28154bcfa0c369dd0dc71

data/.rubocop.yml

@@ -0,0 +1,192 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0.1
+  NewCops: enable
+  Exclude:
+    - '.git/**/*'
+    - '.idea/**/*'
+    - 'init/*'
+    - 'Rakefile'
+    - '*.gemspec'
+#    - 'spec/**/*'
+    - 'vendor/**/*'
+    - 'scratch*.rb'
+    - 'snippets*.rb'
+
+# Align the elements of a hash literal if they span more than one line.
+Layout/HashAlignment:
+  EnforcedLastArgumentHashStyle: always_ignore
+
+# Alignment of parameters in multi-line method definition.
+#   The `with_fixed_indentation` style aligns the following lines with one
+#   level of indentation relative to the start of the line with the method
+#   definition.
+#
+#   def my_method(a,
+#     b)
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# Alignment of parameters in multi-line method call.
+#   The `with_fixed_indentation` style aligns the following lines with one
+#   level of indentation relative to the start of the line with the method call.
+#
+#   my_method(a,
+#     b)
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# a = case n
+# when 0
+#   x * 2
+# else
+#   y / 3
+# end
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# Enforces a configured order of definitions within a class body
+Layout/ClassStructure:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+#   assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+# The `consistent` style enforces that the first element in an array
+#   literal where the opening bracket and the first element are on
+#   seprate lines is indented the same as an array literal which is not
+#   defined inside a method call.
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+# The `consistent` style enforces that the first key in a hash
+#   literal where the opening brace and the first key are on
+#   seprate lines is indented the same as a hash literal which is not
+#   defined inside a method call.
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Indent multi-line methods instead of aligning with periods
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Allow `debug` in tasks for now
+Lint/Debugger:
+  Exclude:
+    - 'RakeFile'
+
+# A calculated magnitude based on number of assignments, branches, and
+#   conditions.
+# NOTE: This is temporarily disabled until we can eliminate existing Rubocop
+#   complaints
+Metrics/AbcSize:
+  Enabled: false
+
+# Avoid long blocks with many lines.
+Metrics/BlockLength:
+  Exclude:
+    - 'RakeFile'
+    - 'db/seeds.rb'
+    - 'spec/**/*.rb'
+
+# Avoid classes longer than 100 lines of code.
+# NOTE: This is temporarily disabled until we can eliminate existing Rubocop
+#   complaints
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'spec/**/*.rb'
+
+# A complexity metric that is strongly correlated to the number of test cases
+#   needed to validate a method.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Limit lines to 80 characters
+Layout/LineLength:
+  Exclude:
+    - 'RakeFile'
+    - 'spec/**/*.rb'
+
+# Avoid methods longer than 15 lines of code.
+Metrics/MethodLength:
+  Max: 20
+  AllowedMethods:
+    - swagger_path
+    - operation
+
+
+# A complexity metric geared towards measuring complexity for a human reader.
+Metrics/PerceivedComplexity:
+  Max: 10
+
+NestedGroups:
+  Max: 4
+
+# Naming/FileName:
+#  Exclude:
+#    - 'lib/file.rb'
+
+# Allow `downcase == ` instead of forcing `casecmp`
+Performance/Casecmp:
+  Enabled: false
+
+# Require children definitions to be nested or compact in classes and modules
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Document classes and non-namespace modules.
+#   (Disabled for now, may revisit later)
+Style/Documentation:
+  Enabled: false
+
+# Checks the formatting of empty method definitions.
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Add the frozen_string_literal comment to the top of files to help transition
+#   to frozen string literals by default.
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+# Check for conditionals that can be replaced with guard clauses
+Style/GuardClause:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+    - 'RakeFile'
+
+# Avoid multi-line method signatures.
+Style/MultilineMethodSignature:
+  Enabled: true
+
+# Don't use option hashes when you can use keyword arguments.
+Style/OptionHash:
+  Enabled: true
+
+# Use return instead of return nil.
+Style/ReturnNil:
+  Enabled: true
+
+# Allow code like `return x, y` as it's occasionally handy.
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# Prefer symbols instead of strings as hash keys.
+Style/StringHashKeys:
+  Enabled: true
+
+# Checks if configured preferred methods are used over non-preferred.
+Style/StringMethods:
+  Enabled: true
+
+# Checks for use of parentheses around ternary conditions.
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex

data/CHANGELOG.md

@@ -1,6 +1,14 @@
+### Version 2.0.2 2023-11-01
+- Update ruby gems.
+
+### Version 2.0.1
+- Update ruby gems.
+- Various refactors.
+
 ### Version 2.0.0
-* Use LittleWeasel gem for dictionary.
-* Gem update to patch CVEs.
+- Use LittleWeasel gem for dictionary.
+- Gem update to patch CVEs.
+
 ### Version 1.1.0
-* Made some changes to the sample rake task $ bundle exec rake engine:run
-* Added this CHANGELOG.md file
+- Made some changes to the sample rake task $ bundle exec rake engine:run
+- Added this CHANGELOG.md file

data/Gemfile.lock

@@ -1,65 +1,62 @@
 PATH
   remote: .
   specs:
-    MonkeyEngine (2.0.0)
+    MonkeyEngine (2.0.2)
       LittleWeasel (~> 5.0, >= 5.0.3)
       ProtectedConstructor (~> 2.0, >= 2.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    LittleWeasel (5.0.3)
-      activesupport (~> 6.1, >= 6.1.3.2)
-    ProtectedConstructor (2.1.3)
-    activesupport (6.1.7.3)
+    LittleWeasel (5.0.7)
+      activesupport (~> 7.0.8)
+    ProtectedConstructor (2.1.5)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     byebug (11.1.3)
     coderay (1.1.3)
     colorize (0.8.1)
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.18.0)
+    minitest (5.20.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    rake (13.0.6)
+    rake (13.1.0)
     redcarpet (2.3.0)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    zeitwerk (2.6.7)
+    yard (0.9.34)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-21
 
 DEPENDENCIES
   MonkeyEngine!
-  bundler (~> 2.3, >= 2.3.20)
+  bundler (~> 2.4, >= 2.4.21)
   colorize (~> 0.8.1)
   pry-byebug (~> 3.9)
   rake (~> 13.0, >= 13.0.6)
@@ -68,4 +65,4 @@ DEPENDENCIES
   yard (~> 0.9.28)
 
 BUNDLED WITH
-   2.3.20
+   2.4.21

data/lib/Action/action.rb

@@ -12,8 +12,6 @@ class Action
     @weight = weight
     @action_time = Time.now
     @action_completed = false
-
-    self
   end
 
   def action_completed?

data/lib/Monkey/monkey.rb

@@ -31,7 +31,6 @@ class Monkey
   def initialize(monkey_symbol)
     @monkey_symbol = monkey_symbol
     @monkey_service = MonkeyEngine::MonkeyService.instance
-    self
   end
 
   public
@@ -76,7 +75,7 @@ class Monkey
   def start
     if alive?
       raise MonkeyEngine::Exceptions::InvalidOperationException,
-            "The monkey [#{@monkey_symbol}] thread is already started"
+        "The monkey [#{@monkey_symbol}] thread is already started"
     end
 
     initialize_thread

data/lib/MonkeyAction/monkey_action.rb

@@ -10,7 +10,5 @@ class MonkeyAction < Action
     super value, weight
 
     @monkey = monkey
-
-    self
   end
 end

data/lib/MonkeyAction/monkey_action_dead.rb

@@ -13,8 +13,6 @@ class MonkeyActionDead < MonkeyAction
     super monkey, true, WEIGHT
 
     validate
-
-    self
   end
 
   protected
@@ -22,7 +20,7 @@ class MonkeyActionDead < MonkeyAction
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
       unless VALID_VALUES.include?(@value)
   end
 end

data/lib/MonkeyAction/monkey_action_eat.rb

@@ -18,8 +18,6 @@ class MonkeyActionEat < MonkeyTimedAction
     @action_time_of_completion = @action_time + (value * 60)
 
     validate
-
-    self
   end
 
   protected
@@ -27,7 +25,7 @@ class MonkeyActionEat < MonkeyTimedAction
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
       unless VALID_VALUES.include?(@value)
   end
 end

data/lib/MonkeyAction/monkey_action_pause.rb

@@ -18,8 +18,6 @@ class MonkeyActionPause < MonkeyTimedAction
     @action_time_of_completion = @action_time + value
 
     validate
-
-    self
   end
 
   protected
@@ -27,7 +25,7 @@ class MonkeyActionPause < MonkeyTimedAction
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
       unless VALID_VALUES.include?(@value)
   end
 end

data/lib/MonkeyAction/monkey_action_sleep.rb

@@ -18,8 +18,6 @@ class MonkeyActionSleep < MonkeyTimedAction
     @action_time_of_completion = @action_time + (value * (60 * 60))
 
     validate
-
-    self
   end
 
   protected
@@ -27,7 +25,7 @@ class MonkeyActionSleep < MonkeyTimedAction
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
       unless VALID_VALUES.include?(@value)
   end
 end

data/lib/MonkeyAction/monkey_action_type.rb

@@ -11,12 +11,12 @@ class MonkeyActionType < MonkeyAction
   WEIGHT = 5.0
 
   def initialize(monkey, keyboard_input)
-    raise MonkeyEngine::Exceptions::NilArgumentException, "keyboard_input '#{keyboard_input}' cannot be nil"  \
+    raise MonkeyEngine::Exceptions::NilArgumentException, "keyboard_input '#{keyboard_input}' cannot be nil" \
       if keyboard_input.nil?
 
     unless keyboard_input.is_a?(KeyboardInput)
       raise MonkeyEngine::Exceptions::InvalidArgumentTypeException,
-            "keyboard_input '#{keyboard_input}' is not a valid argument type"
+        "keyboard_input '#{keyboard_input}' is not a valid argument type"
     end
 
     @keyboard_input = keyboard_input
@@ -24,22 +24,20 @@ class MonkeyActionType < MonkeyAction
     super monkey, @keyboard_input.input, WEIGHT
 
     validate
-
-    self
   end
 
   protected
 
   def validate
-    raise MonkeyEngine::Exceptions::NilArgumentException, "Value '#{value}' cannot be nil"  \
+    raise MonkeyEngine::Exceptions::NilArgumentException, "Value '#{value}' cannot be nil" \
       if @value.nil?
 
     unless @value.is_a?(Array)
       raise MonkeyEngine::Exceptions::InvalidArgumentTypeException,
-            "Value '#{value}' is not a valid argument type (#{value.class.name})"
+        "Value '#{value}' is not a valid argument type (#{value.class.name})"
     end
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' cannot be empty"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' cannot be empty" \
       if @value.empty?
   end
 end

data/lib/MonkeyAction/monkey_action_wake.rb

@@ -13,8 +13,6 @@ class MonkeyActionWake < MonkeyAction
     super monkey, true, WEIGHT
 
     validate
-
-    self
   end
 
   protected
@@ -22,7 +20,7 @@ class MonkeyActionWake < MonkeyAction
   def validate
     super
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value"  \
+    raise MonkeyEngine::Exceptions::InvalidArgumentValueException, "Value '#{value}' is not a valid value" \
       unless VALID_VALUES.include?(@value)
   end
 end

data/lib/MonkeyAction/monkey_timed_action.rb

@@ -13,17 +13,15 @@ class MonkeyTimedAction < MonkeyAction
     @action_time_of_completion = nil
 
     validate
-
-    self
   end
 
   protected
 
   def validate
-    raise MonkeyEngine::Exceptions::NilArgumentException, "Value '#{value}' cannot be nil"  \
+    raise MonkeyEngine::Exceptions::NilArgumentException, "Value '#{value}' cannot be nil" \
       if @value.nil?
 
-    raise MonkeyEngine::Exceptions::InvalidArgumentTypeException, "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

data/lib/MonkeyEngine/action_rules.rb

@@ -17,7 +17,7 @@ class ActionRules
   def get_next_action(monkey)
     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"
+        "The action [#{monkey.action.class.name}] for Monkey [#{monkey.monkey_symbol}] must be completed before calling get_next_action"
     end
 
     # current_action = monkey.action

data/lib/MonkeyEngine/monkey_engine.rb

@@ -13,12 +13,6 @@ module MonkeyEngine
     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
@@ -27,7 +21,7 @@ module MonkeyEngine
     def do_action(action)
       if action.action_completed?
         raise MonkeyEngine::Exceptions::InvalidOperationException,
-              "The action [#{action.class.name}] for Monkey [#{action.monkey.monkey_symbol}] is already completed"
+          "The action [#{action.class.name}] for Monkey [#{action.monkey.monkey_symbol}] is already completed"
       end
 
       do_action_type(action) if action.is_a? MonkeyActionType
@@ -47,7 +41,7 @@ module MonkeyEngine
     def new_action(monkey)
       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"
+          "The action [#{monkey.action.class.name}] for Monkey [#{monkey.monkey_symbol}] must be completed before calling new_action"
       end
 
       ActionRules.instance.get_next_action monkey

data/lib/MonkeyEngine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MonkeyEngine
-  VERSION = '2.0.0'
+  VERSION = '2.0.2'
 end

data/lib/MonkeyKeyboard/keyboard_char.rb

@@ -6,6 +6,5 @@ class KeyboardChar
 
   def initialize(char)
     @char = char
-    self
   end
 end

data/lib/MonkeyKeyboard/keyboard_key.rb

@@ -6,6 +6,15 @@ require_relative 'keyboard_char'
 class KeyboardKey
   attr_reader :keyboard_char, :keyboard_shift_char, :keyboard_key_section, :keyboard_key_weight
 
+  def self.make_key(char, shift_char, keyboard_key_section, keyboard_key_weight)
+    # TODO: Check keyboard_key_section is :left or :right
+
+    keyboard_char = KeyboardChar.new char
+    keyboard_shift_char = KeyboardChar.new shift_char
+
+    KeyboardKey.new keyboard_char, keyboard_shift_char, keyboard_key_section, keyboard_key_weight
+  end
+
   def initialize(keyboard_char, keyboard_shift_char, keyboard_key_section, keyboard_key_weight)
     # TODO: Check keyboard_char is_a? KeyboardChar
     # TODO: Check keyboard_shift_char is_a? KeyboardChar
@@ -16,13 +25,4 @@ class KeyboardKey
     @keyboard_key_section = keyboard_key_section
     @keyboard_key_weight = keyboard_key_weight
   end
-
-  def self.make_key(char, shift_char, keyboard_key_section, keyboard_key_weight)
-    # TODO: Check keyboard_key_section is :left or :right
-
-    keyboard_char = KeyboardChar.new char
-    keyboard_shift_char = KeyboardChar.new shift_char
-
-    KeyboardKey.new keyboard_char, keyboard_shift_char, keyboard_key_section, keyboard_key_weight
-  end
 end

data/lib/MonkeyKeyboard/keyboard_key_evaluator.rb

@@ -10,7 +10,7 @@ class KeyboardKeyEvaluator
     @shift_on = !@shift_on if keyboard_key.keyboard_char.char == :shift
     @caps_on = !@shift_on if keyboard_key.keyboard_char.char == :caps
 
-    return nil if keyboard_key.keyboard_char.char.is_a? Symbol
+    return if keyboard_key.keyboard_char.char.is_a? Symbol
 
     return keyboard_key.keyboard_shift_char.char if @shift_on
 

data/lib/MonkeyKeyboard/monkey_keyboard_en_us.rb

@@ -16,7 +16,7 @@ module MonkeyEngine
     attr_reader :keys, :left_keys, :right_keys
 
     def initialize
-      LittleWeasel.configure do |config| end
+      LittleWeasel.configure { |config| }
 
       @keys = [
         # Row 1 of 5
@@ -124,7 +124,7 @@ module MonkeyEngine
       # Take the keys until we hit a key that terminates a word...
       keyboard_input.input = keys.take_while do |key|
         !keyboard_char_ends_word?(key.keyboard_char.char)
-      end.collect { |key| keyboard_key_evaluator.get_char(key) }.compact
+      end.filter_map { |key| keyboard_key_evaluator.get_char(key) }
 
       # Keep going until we get something...
       keyboard_input = get_keyboard_input if keyboard_input.input.empty?

data/lib/MonkeyManager/monkey_manager.rb

@@ -82,15 +82,15 @@ module MonkeyEngine
     # @raise [MonkeyEngine::Exceptions::InvalidArgumentTypeException] if parameter monkey is not a Monkey, Symbol, or String object.
     #
     def get(monkey)
-      return nil if @monkeys.empty?
+      return if @monkeys.empty?
 
       # TODO: This seems inefficient.
-      return @monkeys.select { |m| m.monkey_symbol == monkey }.first if monkey.is_a? Symbol
-      return @monkeys.select { |m| m.monkey_symbol == monkey.to_sym }.first if monkey.is_a? String
-      return @monkeys.select { |m| m.monkey_symbol == monkey.monkey_symbol }.first if monkey.is_a? Monkey
+      return @monkeys.find { |m| m.monkey_symbol == monkey } if monkey.is_a? Symbol
+      return @monkeys.find { |m| m.monkey_symbol == monkey.to_sym } if monkey.is_a? String
+      return @monkeys.find { |m| m.monkey_symbol == monkey.monkey_symbol } if monkey.is_a? Monkey
 
       raise MonkeyEngine::Exceptions::InvalidArgumentTypeException,
-            "Parameter 'monkey' is not a Symbol, String or Monkey object"
+        "Parameter 'monkey' is not a Symbol, String or Monkey object"
     end
 
     # Returns a duplicate Array of Monkey objects managed by this MonkeyManager.