xenos-enigma 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f9f61779f252a914d06bd33dcb744b4077b0eff04c7fbe59a383d9373e2fd5f
+  data.tar.gz: 0b44c9aad8ba9ac1ee81f41f467bb85eb509884e738e86e52fbcad4051840335
+SHA512:
+  metadata.gz: 810f480098060ab33000490998d81551d73cd3cd1c1b2df0a6ee7269b8d4d62a568d09aaae6edadeed5620459c05471f95ace4a5b4284e75143500a38f47963f
+  data.tar.gz: e63c6eb11e3a310e66a2334bce37be61b4a46ae14a2cfe6dc56d3d10cd43b6ac2aab245c8feec2716086929da984e6a322318c71cd14f674465dd568eeb95ca6

data/CHANGELOG

@@ -0,0 +1,6 @@
+== 1.0.0 / 13-07-2021
+  * ability to detect multiple xenos ships in radar data
+  * ability to easily extend xenos supported detection
+  * ability to read radar data from file
+  * agnostic to dimensions of radar data
+  * rspec added

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Haris Krajina
+
+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,159 @@
+# Xenos Enigma
+
+## Description:
+
+In the grim dark future of 40k, there is only war and humanity is under threat again. There are Xenos forces emerging from deep space and the order of Adeptus Mechanicus has been tasked with creating advanced radar systems to detect these threats before it is too late.
+
+## Installation
+
+```bash
+gem install xenos-enigma
+```
+
+## Run
+
+```
+xenos-enigma --help
+Usage: bin/run [--path FILE]
+--help  	 show help
+--path FILE 	 set path to radar data file, uses default data if no file provided
+```
+
+## Development
+
+```ruby
+bundle install            # install development dependencies
+bin/xenos-enigma          # run executable
+rspec                     # run test suite
+```
+
+## Known xenos:
+#### Tau
+~~~~
+--o-----o--
+---o---o---
+--ooooooo--
+-oo-ooo-oo-
+ooooooooooo
+o-ooooooo-o
+o-o-----o-o
+---oo-oo---
+~~~~
+#### Aeldari
+~~~~
+---oo---
+--oooo--
+-oooooo-
+oo-oo-oo
+oooooooo
+--o--o--
+-o-oo-o-
+o-o--o-o
+~~~~
+
+#### Radar sample:
+~~~~
+----o--oo----o--ooo--ooo--o------o---oo-o----oo---o--o---------o----o------o-------------o--o--o--o-
+--o-o-----oooooooo-oooooo---o---o----o------ooo-o---o--o----o------o--o---ooo-----o--oo-o------o----
+--o--------oo-ooo-oo-oo-oo-----O------------ooooo-----oo----o------o---o--o--o-o-o------o----o-o-o--
+-------o--oooooo--o-oo-o--o-o-----oo--o-o-oo--o-oo-oo-o--------o-----o------o-ooooo---o--o--o-------
+------o---o-ooo-ooo----o-----oo-------o---oo-ooooo-o------o----o--------o-oo--ooo-oo-------------o-o
+-o--o-----o-o---o-ooooo-o-------oo---o---------o-----o-oo-----------oo----ooooooo-ooo-oo------------
+o-------------ooooo-o--o--o--o-------o--o-oo-oo-o-o-o----oo------------o--oooo--ooo-o----o-----o--o-
+--o-------------------------oo---------oo-o-o--ooo----oo----o--o--o----o--o-o-----o-o------o-o------
+-------------------o----------o------o--o------o--------o--------o--oo-o-----oo-oo---o--o---o-----oo
+----------o----------o---o--------------o--o----o--o-o------------oo------o--o-o---o-----o----------
+------o----o-o---o-----o-o---o-----oo-o--------o---------------------------------o-o-o--o-----------
+---------------o-------o-----o-------o-------------------o-----o---------o-o-------------o-------oo-
+-o--o-------------o-o-----o--o--o--oo-------------o----ooo----o-------------o----------oo----o---o-o
+-o--o-------------o----oo------o--o-------o--o-----o-----o----o-----o--o----o--oo-----------o-------
+-o-----oo-------o------o----o----------o--o----o-----o-----o-------o-----------o---o-o--oooooo-----o
+-o--------o-----o-----o---------oo----oo---o-o---------o---o--oooo-oo--o-------o------oo--oo--o-----
+------------o---------o---------o----oooo-------------oo-oo-----ooo-oo-----o-------o-oo-oooooooo---o
+----------------------o------------oooooooo---o-----o-------o--oooooo-o------------o-o-ooooooo-o----
+------------o------o---o---o-------oo-oo--o--o---------o--o-o-o-ooooo-o--------------oo-o----o-oo-o-
+---o-o----------oo-------oo----o----oooooooo-------o----o-o-o-o-----o-o-----o----------ooo-oo--o---o
+-o-o---------o-o---------------o--o--o--ooo---ooo-------o------oo-oo------------o--------o--o-o--o--
+-------oo---------------------------o-oo----------o------o-o-------o-----o----o-----o-oo-o-----o---o
+---o--------o-----o-------o-oo-----oo--oo-o----oo----------o--o---oo------oo----o-----o-------o-----
+---o--ooo-o---------o-o----o------------o---------o----o--o-------o----o--------o----------------oo-
+---o------o----------------o----o------o------o---oo-----------o-------------o----------oo---------o
+--oo---------------o--o------o---o-----o--o-------------o------o-------o-----o-----o----o------o--o-
+-o-------o----------o-o-o-------o-----o--o-o-----------o-oo-----------o------o---------o-----o-o----
+----------o----o-------o----o--o------o------------o---o---------------oo----o-----ooo--------------
+----o--------oo----o-o----o--o------ooo----o-oooo---o--o-oo--------o-oo-----o-o---o-o--o-----oo-----
+------o--------o-ooooo----o---o--o-----o---------------o-o-------o-----o----------------------------
+o-------oo----o--oooooo-o---o--o------oooo----------o-oo-------o---o----------o------oo-------------
+-o---o----------o--oo-oo-o---o-----o-o-----------------------oo--o------o------o--------------------
+-----oo-o-o-o---ooooooooo----o----o--------o--o---oo---o------------o----------o-o---o------o-o--oo-
+------o------o---ooo-o---------------------------o--o---o---o----o--o-------o-----o------o----o----o
+-------o----------ooo-o-----o----o---o--o-oo--o--o-o--o------o--o-oo---ooo------------------------o-
+-o-------o------o-o--ooo--o---o---oo-----o----o-------------o----o-ooo-o------o--o-o------o-o-------
+---oo--o---o-o---------o---o--------------o--o-----o-------o-----o--o---o-oo--------o----o----o-----
+o------o----oo-o-----------oo--o---o--------o-o------o-------o-o------o-oo---------o-----oo---------
+----o--o---o-o-----------o---o------------o-------o----o--o--o--o-o---------------o-----------------
+-------oo--o-o-----o-----o----o-o--o----------------------o-------o------o----oo----ooo---------o---
+o-----oo-------------------o--o-----o-----------o------o-------o----o-----------o----------------o--
+--o---o-------o------------o--------------------o----o--o-------------oo---o---------oo--------o----
+--o--------o---------o------------o------o-------o------------o-------o---o---------ooooo-----------
+------o--------------o-o-o---------o---o-------o--o-----o-------o-o----------o-----oo-ooo----------o
+--o---------------o----o--oo-------------o---------o-------------------oo---------oo-o-ooo----------
+-o-----------o------ooo----o----------------ooo-----o--------o--o---o-----------o-o-oooooo--------oo
+-o---o-------o---o-oooo-----o-------------------o----oo-----------------o--o--------o--o------o--o--
+-------o---o------oooooo--o----ooo--o--------o-------o----------------------------oo-oo-o--o--------
+o--oo------o-----oo--o-oo------------oo--o------o--o-------------oo----o------------oooo-o------oo--
+-----o----------ooooooooo--------------oo--------------oo-----o-----o-o--o------o----------o----o---
+~~~~
+#### Radar echo:
+~~~~
+--------------------oooo---------------------oo-----------------------------------------------------
+-------------------oooooo-------------------oooo----------------------------o-----o-----------------
+------------------oo-oo-oo-----------------oooooo----------------------------o---o------------------
+------------------oooooooo----------------oo-oo-oo--------------------------ooooooo-----------------
+--------------------o--o------------------oooooooo-------------------------oo-ooo-oo----------------
+-------------------o-oo-o-------------------o--o--------------------------ooooooooooo---------------
+------------------o-o--o-o-----------------o-oo-o-------------------------o-ooooooo-o---------------
+------------------------------------------o-o--o-o------------------------o-o-----o-o---------------
+-----------------------------------------------------------------------------oo-oo------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+---------------------------------------------------------------------------------------o-----o------
+--------------------------------------------------------------o-----o-------------------o---o-------
+---------------------------------------------------------------o---o-------------------ooooooo------
+--------------------------------------oo----------------------ooooooo-----------------oo-ooo-oo-----
+-------------------------------------oooo--------------------oo-ooo-oo---------------ooooooooooo----
+------------------------------------oooooo------------------ooooooooooo--------------o-ooooooo-o----
+-----------------------------------oo-oo-oo-----------------o-ooooooo-o--------------o-o-----o-o----
+-----------------------------------oooooooo-----------------o-o-----o-o-----------------oo-oo-------
+-------------------------------------o--o----------------------oo-oo--------------------------------
+------------------------------------o-oo-o----------------------------------------------------------
+-----------------------------------o-o--o-o---------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+-------------------oo-------------------------------------------------------------------------------
+------------------oooo------------------------------------------------------------------------------
+-----------------oooooo-----------------------------------------------------------------------------
+----------------oo-oo-oo----------------------------------------------------------------------------
+----------------oooooooo----------------------------------------------------------------------------
+------------------o--o------------------------------------------------------------------------------
+-----------------o-oo-o-----------------------------------------------------------------------------
+----------------o-o--o-o----------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------oo-------------
+------------------------------------------------------------------------------------oooo------------
+-----------------------------------------------------------------------------------oooooo-----------
+----------------------------------------------------------------------------------oo-oo-oo----------
+--------------------oo------------------------------------------------------------oooooooo----------
+-------------------oooo-------------------------------------------------------------o--o------------
+------------------oooooo-----------------------------------------------------------o-oo-o-----------
+-----------------oo-oo-oo---------------------------------------------------------o-o--o-o----------
+-----------------oooooooo---------------------------------------------------------------------------
+~~~~

data/bin/xenos-enigma

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/xenos_enigma'
+
+XenosEnigma::Runner.start

data/lib/xenos_enigma.rb

@@ -0,0 +1 @@
+require_relative 'xenos_enigma/runner'

data/lib/xenos_enigma/default_data.rb

@@ -0,0 +1,56 @@
+module XenosEnigma
+  module DefaultData
+    SCAN_DATA = <<~DATA.freeze
+      ----o--oo----o--ooo--ooo--o------o---oo-o----oo---o--o---------o----o------o-------------o--o--o--o-
+      --o-o-----oooooooo-oooooo---o---o----o------ooo-o---o--o----o------o--o---ooo-----o--oo-o------o----
+      --o--------oo-ooo-oo-oo-oo-----O------------ooooo-----oo----o------o---o--o--o-o-o------o----o-o-o--
+      -------o--oooooo--o-oo-o--o-o-----oo--o-o-oo--o-oo-oo-o--------o-----o------o-ooooo---o--o--o-------
+      ------o---o-ooo-ooo----o-----oo-------o---oo-ooooo-o------o----o--------o-oo--ooo-oo-------------o-o
+      -o--o-----o-o---o-ooooo-o-------oo---o---------o-----o-oo-----------oo----ooooooo-ooo-oo------------
+      o-------------ooooo-o--o--o--o-------o--o-oo-oo-o-o-o----oo------------o--oooo--ooo-o----o-----o--o-
+      --o-------------------------oo---------oo-o-o--ooo----oo----o--o--o----o--o-o-----o-o------o-o------
+      -------------------o----------o------o--o------o--------o--------o--oo-o-----oo-oo---o--o---o-----oo
+      ----------o----------o---o--------------o--o----o--o-o------------oo------o--o-o---o-----o----------
+      ------o----o-o---o-----o-o---o-----oo-o--------o---------------------------------o-o-o--o-----------
+      ---------------o-------o-----o-------o-------------------o-----o---------o-o-------------o-------oo-
+      -o--o-------------o-o-----o--o--o--oo-------------o----ooo----o-------------o----------oo----o---o-o
+      -o--o-------------o----oo------o--o-------o--o-----o-----o----o-----o--o----o--oo-----------o-------
+      -o-----oo-------o------o----o----------o--o----o-----o-----o-------o-----------o---o-o--oooooo-----o
+      -o--------o-----o-----o---------oo----oo---o-o---------o---o--oooo-oo--o-------o------oo--oo--o-----
+      ------------o---------o---------o----oooo-------------oo-oo-----ooo-oo-----o-------o-oo-oooooooo---o
+      ----------------------o------------oooooooo---o-----o-------o--oooooo-o------------o-o-ooooooo-o----
+      ------------o------o---o---o-------oo-oo--o--o---------o--o-o-o-ooooo-o--------------oo-o----o-oo-o-
+      ---o-o----------oo-------oo----o----oooooooo-------o----o-o-o-o-----o-o-----o----------ooo-oo--o---o
+      -o-o---------o-o---------------o--o--o--ooo---ooo-------o------oo-oo------------o--------o--o-o--o--
+      -------oo---------------------------o-oo----------o------o-o-------o-----o----o-----o-oo-o-----o---o
+      ---o--------o-----o-------o-oo-----oo--oo-o----oo----------o--o---oo------oo----o-----o-------o-----
+      ---o--ooo-o---------o-o----o------------o---------o----o--o-------o----o--------o----------------oo-
+      ---o------o----------------o----o------o------o---oo-----------o-------------o----------oo---------o
+      --oo---------------o--o------o---o-----o--o-------------o------o-------o-----o-----o----o------o--o-
+      -o-------o----------o-o-o-------o-----o--o-o-----------o-oo-----------o------o---------o-----o-o----
+      ----------o----o-------o----o--o------o------------o---o---------------oo----o-----ooo--------------
+      ----o--------oo----o-o----o--o------ooo----o-oooo---o--o-oo--------o-oo-----o-o---o-o--o-----oo-----
+      ------o--------o-ooooo----o---o--o-----o---------------o-o-------o-----o----------------------------
+      o-------oo----o--oooooo-o---o--o------oooo----------o-oo-------o---o----------o------oo-------------
+      -o---o----------o--oo-oo-o---o-----o-o-----------------------oo--o------o------o--------------------
+      -----oo-o-o-o---ooooooooo----o----o--------o--o---oo---o------------o----------o-o---o------o-o--oo-
+      ------o------o---ooo-o---------------------------o--o---o---o----o--o-------o-----o------o----o----o
+      -------o----------ooo-o-----o----o---o--o-oo--o--o-o--o------o--o-oo---ooo------------------------o-
+      -o-------o------o-o--ooo--o---o---oo-----o----o-------------o----o-ooo-o------o--o-o------o-o-------
+      ---oo--o---o-o---------o---o--------------o--o-----o-------o-----o--o---o-oo--------o----o----o-----
+      o------o----oo-o-----------oo--o---o--------o-o------o-------o-o------o-oo---------o-----oo---------
+      ----o--o---o-o-----------o---o------------o-------o----o--o--o--o-o---------------o-----------------
+      -------oo--o-o-----o-----o----o-o--o----------------------o-------o------o----oo----ooo---------o---
+      o-----oo-------------------o--o-----o-----------o------o-------o----o-----------o----------------o--
+      --o---o-------o------------o--------------------o----o--o-------------oo---o---------oo--------o----
+      --o--------o---------o------------o------o-------o------------o-------o---o---------ooooo-----------
+      ------o--------------o-o-o---------o---o-------o--o-----o-------o-o----------o-----oo-ooo----------o
+      --o---------------o----o--oo-------------o---------o-------------------oo---------oo-o-ooo----------
+      -o-----------o------ooo----o----------------ooo-----o--------o--o---o-----------o-o-oooooo--------oo
+      -o---o-------o---o-oooo-----o-------------------o----oo-----------------o--o--------o--o------o--o--
+      -------o---o------oooooo--o----ooo--o--------o-------o----------------------------oo-oo-o--o--------
+      o--oo------o-----oo--o-oo------------oo--o------o--o-------------oo----o------------oooo-o------oo--
+      -----o----------ooooooooo--------------oo--------------oo-----o-----o-o--o------o----------o----o---
+    DATA
+  end
+end

data/lib/xenos_enigma/hit_collector.rb

@@ -0,0 +1,62 @@
+module XenosEnigma
+  # HitCollector will consume all ship hits, and cache their data and coordinates
+  class HitCollector
+    def initialize
+      @hit_matrix_cache = {}
+    end
+
+    def detection_data(position_x, position_y)
+      get_cache(position_x, position_y)
+    end
+
+    def already_detected?(position_x, position_y)
+      !get_cache(position_x, position_y).nil?
+    end
+
+    def push(xeno_hit, scan_position_x, scan_position_y)
+      xeno_hit.radar_x_position = scan_position_x
+      xeno_hit.radar_y_position = scan_position_y
+
+      consume(xeno_hit)
+    end
+
+    private
+
+    def consume(xeno_hit)
+      xeno_data = xeno_hit.xeno_instance.xeno_signature
+
+      xeno_data.each_with_index do |xeno_row_data, xeno_y|
+        next if xeno_y < xeno_hit.xeno_y_start
+
+        xeno_row = xeno_row_data.split(//)
+        xeno_row.each_with_index do |xeno_char, xeno_x|
+          global_x = xeno_hit.radar_x_position + xeno_x
+          global_y = xeno_hit.radar_y_position + xeno_y - xeno_hit.xeno_y_start
+
+          @hit_matrix_cache[cache_key(global_x, global_y)] = xeno_char
+        end
+      end
+    end
+
+    def get_cache(position_x, position_y)
+      @hit_matrix_cache[cache_key(position_x, position_y)]
+    end
+
+    def cache_key(position_x, position_y)
+      "#{position_x}::#{position_y}"
+    end
+  end
+
+  # Hit is placeholder for ship detection information
+  class Hit
+    attr_accessor :radar_x_position,
+                  :radar_y_position,
+                  :xeno_instance,
+                  :xeno_y_start
+
+    def initialize(xeno_instance, xeno_y_start = 0)
+      @xeno_instance = xeno_instance
+      @xeno_y_start = xeno_y_start
+    end
+  end
+end

data/lib/xenos_enigma/radar.rb

@@ -0,0 +1,67 @@
+require_relative 'default_data'
+require_relative 'hit_collector'
+Dir[File.expand_path('xenos/*.rb', File.dirname(__FILE__))].each do |file|
+  require_relative file
+end
+
+module XenosEnigma
+  # Radar will orchestrate scan of radar data, xenos detection and echo of those findings
+  class Radar
+    include DefaultData
+
+    def initialize(data = nil)
+      @data = (data || SCAN_DATA).split(/\n/)
+      @known_xenos = load_all_known_xenos
+      @hit_collector = XenosEnigma::HitCollector.new
+    end
+
+    def scan
+      @data.each_with_index do |scan_row, scan_position_y|
+        (0..scan_row.length).each do |scan_position_x|
+          next if @hit_collector.already_detected?(scan_position_x, scan_position_y)
+
+          @known_xenos.each do |xeno|
+            partial = scan_row_partial(scan_row, scan_position_x, xeno.ship_width)
+            hit = xeno.analyze?(partial, look_ahead_data(scan_position_x, scan_position_y, xeno))
+            @hit_collector.push(hit, scan_position_x, scan_position_y) if hit
+          end
+        end
+      end
+    end
+
+    def echo
+      echo_width  = @data.first.size - 1
+      echo_height = @data.size - 1
+      print "\033[33m"
+
+      (0..echo_height).each do |echo_y|
+        (0..echo_width).each do |echo_x|
+          hit_data = @hit_collector.detection_data(echo_x, echo_y)
+          print hit_data || '-'
+        end
+        puts
+      end
+    end
+
+    private
+
+    def look_ahead_data(position_x, position_y, xeno)
+      results = []
+      scan_to_y = [(position_y + xeno.ship_height), @data.size].min - 1
+      (position_y..scan_to_y).each do |scan_y|
+        partial = scan_row_partial(@data[scan_y], position_x, xeno.ship_width)
+        results.push(partial)
+      end
+      results
+    end
+
+    def scan_row_partial(scan_row, position_x, x_offset)
+      scan_row[position_x..(position_x + x_offset - 1)]
+    end
+
+    def load_all_known_xenos
+      xenox_clazzes = XenosEnigma::Xenos.constants.reject { |xc| xc.downcase.eql?(:base) }
+      xenox_clazzes.collect { |xc| XenosEnigma::Xenos.const_get(xc).new }
+    end
+  end
+end

data/lib/xenos_enigma/runner.rb

@@ -0,0 +1,34 @@
+require_relative 'radar'
+require 'getoptlong'
+
+module XenosEnigma
+  # Runner is responsable for end user interaction via console
+  class Runner
+    def self.start
+      radar_data = nil
+
+      opts = GetoptLong.new(['--help', '-h', GetoptLong::NO_ARGUMENT], ['--path', GetoptLong::OPTIONAL_ARGUMENT])
+      opts = Hash[*opts.get_option]
+
+      if opts['--help']
+        puts 'Usage: bin/run [--path FILE]'
+        puts "--help  \t show help"
+        puts "--path FILE \t set path to radar data file, uses default data if no file provided"
+        exit(0)
+      end
+
+      if (file_provided = opts['--path'])
+        unless File.exist?(file_provided)
+          warn "File #{file_provided} not found"
+          exit(1)
+        end
+
+        radar_data = File.read(file_provided)
+      end
+
+      radar = XenosEnigma::Radar.new(radar_data)
+      radar.scan
+      radar.echo
+    end
+  end
+end

data/lib/xenos_enigma/version.rb

@@ -0,0 +1,3 @@
+module XenosEnigma
+  VERSION = '1.0.0'
+end

data/lib/xenos_enigma/xenos/aeldari.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module XenosEnigma
+  module Xenos
+    class Aeldari < Base
+      SIGNATURE = <<~SIGNATURE.freeze
+        --o-----o--
+        ---o---o---
+        --ooooooo--
+        -oo-ooo-oo-
+        ooooooooooo
+        o-ooooooo-o
+        o-o-----o-o
+        ---oo-oo---
+      SIGNATURE
+    end
+  end
+end

data/lib/xenos_enigma/xenos/base.rb

@@ -0,0 +1,61 @@
+module XenosEnigma
+  module Xenos
+    # Base class holds all the logic for correctly detecting xenos ships
+    class Base
+      attr_reader :ship_width, :ship_height, :xeno_signature
+
+      SHIP_DETECTION = { tolerance: 2, compound_tolerance: 1.6, min_segments: 3 }.freeze
+
+      def initialize
+        raise 'This is an abstract class' if instance_of?(XenosEnigma::Xenos::Base)
+
+        @xeno_signature = self.class::SIGNATURE.split(/\n/)
+        @ship_width  = @xeno_signature.first.size
+        @ship_height = @xeno_signature.size
+      end
+
+      def analyze?(radar_partial, look_ahead_radar_data)
+        return if radar_partial.size < ship_width
+
+        hit = nil
+
+        @xeno_signature.each_with_index do |xeno_row, xeno_y_position|
+          if possible_match?(xeno_row, radar_partial)
+            hit = full_scan(xeno_y_position, look_ahead_radar_data)
+            break if hit
+          end
+        end
+
+        hit
+      end
+
+      private
+
+      def full_scan(xeno_y_position, look_ahead_radar_data)
+        compound_match_score = 0
+        lines_scanned = 0
+
+        (xeno_y_position..(ship_height - 1)).each do |y_scan|
+          break if look_ahead_radar_data[y_scan - xeno_y_position].nil?
+
+          compound_match_score += pattern_difference(@xeno_signature[y_scan], look_ahead_radar_data[y_scan - xeno_y_position])
+          lines_scanned += 1
+        end
+
+        is_detection_cofirmed = (lines_scanned * SHIP_DETECTION[:compound_tolerance] >= compound_match_score)
+
+        if lines_scanned >= SHIP_DETECTION[:min_segments] && is_detection_cofirmed
+          XenosEnigma::Hit.new(self, xeno_y_position)
+        end
+      end
+
+      def possible_match?(xeno_row, radar_partial)
+        pattern_difference(xeno_row, radar_partial) <= SHIP_DETECTION[:tolerance]
+      end
+
+      def pattern_difference(data1, data2)
+        DidYouMean::Levenshtein.distance(data1, data2)
+      end
+    end
+  end
+end

data/lib/xenos_enigma/xenos/tau.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module XenosEnigma
+  module Xenos
+    class Tau < Base
+      SIGNATURE = <<~SIGNATURE.freeze
+        ---oo---
+        --oooo--
+        -oooooo-
+        oo-oo-oo
+        oooooooo
+        --o--o--
+        -o-oo-o-
+        o-o--o-o
+      SIGNATURE
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,61 @@
+require_relative '../lib/xenos_enigma/xenos/tau'
+require_relative 'helpers/randomize'
+
+RSpec.configure do |config|
+  config.include Randomize
+end
+
+RSpec.describe XenosEnigma::Xenos::Base do
+  describe 'instance methods' do
+    let(:tau)     { XenosEnigma::Xenos::Tau.new }
+    let(:data)    { tau.xeno_signature }
+
+    it 'should not allow class to be instanced' do
+      expect { XenosEnigma::Xenos::Base.new }.to raise_exception(RuntimeError, 'This is an abstract class')
+    end
+
+    it 'should match pattern as a possible match' do
+      expect(tau.send(:possible_match?, '---oo---', '---o-o--')).to be true
+      expect(tau.send(:possible_match?, '---oo---', '--o-o---')).to be true
+    end
+
+    it 'should not match pattern as a possible match' do
+      expect(tau.send(:possible_match?, '---oo---', '-----o--')).to be false
+      expect(tau.send(:possible_match?, '---oo---', '--o-----')).to be false
+    end
+
+    it 'should analyze data correctly and return exact hit' do
+      rdata = randomize_data(data)
+      result = tau.analyze?(rdata[0], rdata)
+
+      expect(result).to be_a XenosEnigma::Hit
+      expect(result.xeno_y_start).to eq 0
+    end
+
+    it 'should analyze data correctly and return partial hit from top of the ship' do
+      rdata = randomize_data(data.take(5))
+      result = tau.analyze?(rdata[0], rdata)
+
+      expect(result).to be_a XenosEnigma::Hit
+      expect(result.xeno_y_start).to eq 0
+    end
+
+    it 'should analyze data correctly and return partial hit from bottom of the ship' do
+      ship_segments = 4
+
+      partial_data = data.dup[ship_segments..-1]
+      rdata = randomize_data(partial_data)
+      result = tau.analyze?(rdata[0], rdata)
+
+      expect(result).to be_a XenosEnigma::Hit
+      expect(result.xeno_y_start).to eq ship_segments
+    end
+
+    it 'should analyze data and not return a hit' do
+      rdata = randomize_data(['--------'] * 8)
+      result = tau.analyze?(rdata[0], rdata)
+
+      expect(result).to be_falsey
+    end
+  end
+end

data/spec/helpers/randomize.rb

@@ -0,0 +1,9 @@
+module Randomize
+  def randomize_data(data)
+    data.collect do |row|
+      random_index = rand(0..(row.size - 1))
+      row[random_index] = 'o'.eql?(row[random_index]) ? '-' : 'o'
+      row
+    end
+  end
+end

data/spec/hit_collector_spec.rb

@@ -0,0 +1,37 @@
+require_relative '../lib/xenos_enigma/hit_collector'
+require_relative '../lib/xenos_enigma/xenos/aeldari'
+
+RSpec.describe XenosEnigma::HitCollector do
+  describe 'instance methods' do
+    subject       { XenosEnigma::HitCollector.new }
+    let(:aeldari) { XenosEnigma::Xenos::Aeldari.new }
+
+    before(:each) do
+      @hit = XenosEnigma::Hit.new(aeldari)
+      subject.push(@hit, 0, 0)
+    end
+
+    it 'should correctly process a new hit and each coordinate' do
+      (0..aeldari.ship_width - 1).each do |position_x|
+        (0..aeldari.ship_height - 1).each do |position_y|
+          expect(subject.already_detected?(position_x, position_y)).to be true
+        end
+      end
+    end
+
+    it 'should correctly process a new hit and mark each ship segment' do
+      scanned_data = []
+      (0..aeldari.ship_width - 1).each do |position_x|
+        (0..aeldari.ship_height - 1).each do |position_y|
+          scanned_data << subject.detection_data(position_x, position_y)
+        end
+      end
+
+      ship_signiture = @hit.xeno_instance.xeno_signature.collect do |row|
+        row.split(//)
+      end.flatten.sort
+
+      expect(ship_signiture).to eq scanned_data.sort
+    end
+  end
+end

data/spec/radar_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../lib/xenos_enigma/radar'
+
+RSpec.describe XenosEnigma::Radar do
+  describe 'when working with default data' do
+    subject   { XenosEnigma::Radar.new }
+    let(:tau) { XenosEnigma::Xenos::Tau.new }
+    let(:expected_data) do
+      <<~DATA.freeze
+        ----o--o
+        --o-o---
+        --o-----
+        -------o
+        ------o-
+        -o--o---
+        o-------
+        --o-----
+      DATA
+    end
+
+    it 'collect all known xenos' do
+      xenos = subject.instance_variable_get(:@known_xenos)
+
+      expect(xenos).to be_a Array
+      expect(xenos).not_to be_empty
+    end
+
+    it 'make sure that each xenos is analyzed' do
+      expect_any_instance_of(XenosEnigma::Xenos::Tau).to receive(:analyze?).at_least(:once)
+      expect_any_instance_of(XenosEnigma::Xenos::Aeldari).to receive(:analyze?).at_least(:once)
+
+      subject.scan
+    end
+
+    it 'returns correct scan ahead data' do
+      data = subject.send(:look_ahead_data, 0, 0, tau)
+
+      expect(data).to eq expected_data.split(/\n/)
+      expect(data.first.size).to eq(tau.ship_width)
+      expect(data.size).to eq(tau.ship_height)
+    end
+
+    it 'returns correct data partial' do
+      data = subject.send(:scan_row_partial, expected_data, 0, 5)
+      expect(data).to eq '----o'
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: xenos-enigma
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Haris Krajina
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description:
+email:
+- haris.krajina@gmail.com
+executables:
+- xenos-enigma
+extensions: []
+extra_rdoc_files:
+- CHANGELOG
+- LICENSE
+- README.md
+files:
+- CHANGELOG
+- LICENSE
+- README.md
+- bin/xenos-enigma
+- lib/xenos_enigma.rb
+- lib/xenos_enigma/default_data.rb
+- lib/xenos_enigma/hit_collector.rb
+- lib/xenos_enigma/radar.rb
+- lib/xenos_enigma/runner.rb
+- lib/xenos_enigma/version.rb
+- lib/xenos_enigma/xenos/aeldari.rb
+- lib/xenos_enigma/xenos/base.rb
+- lib/xenos_enigma/xenos/tau.rb
+- spec/base_spec.rb
+- spec/helpers/randomize.rb
+- spec/hit_collector_spec.rb
+- spec/radar_spec.rb
+homepage: http://github.com/hkraji/xenos-enigma
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Space invaders radar set in the world of 40k
+test_files:
+- spec/hit_collector_spec.rb
+- spec/radar_spec.rb
+- spec/helpers/randomize.rb
+- spec/base_spec.rb