battlesnake 0.1.0

data/lib/battlesnake/location.rb

@@ -0,0 +1,142 @@
+require 'json'
+
+module Battlesnake
+  ##
+  # Represents a pair of (x,y) coordinates, and provides helper methods
+  # for managing distance and direction.
+  class Location
+    # @return [Integer] a positive integer representing the distance from the
+    #   left side of the board.
+    attr_reader :x
+
+    # @return [Integer] a positive integer representing the distance from the
+    #   bottom of the board.
+    attr_reader :y
+
+    # @return [Hash] coordinates as a hash, for integration with other objects.
+    attr_reader :as_json
+
+    # Valid directions.
+    DIRECTIONS = ['up', 'down', 'right', 'left']
+
+    ##
+    # Instantiates with the given (x,y) coordinates. Coordinates can be:
+    # * a hash containing "x" and "y" keys
+    # * a JSON string that parses to such a hash
+    # * an array containing (x,y) coordinates
+    # * two separate (x,y) parameters
+    #
+    # @param coordinates [Hash, Array, String] the coordinates
+    #
+    # @return [Location] a new location object with (x,y) coordinates set.
+    def initialize(*coordinates)
+      set_xy(*coordinates)
+
+      @as_json = {'x' => x, 'y' => y}
+    end
+
+    ##
+    # Convenience method to return (x,y) coordinates as an array.
+    #
+    # @return [Array]
+    def coords
+      return @coords if defined?(@coords)
+      @coords = [x, y]
+    end
+
+    ##
+    # Calculate the distance from this instance to another.
+    #
+    # @param location [Location] another Location instance.
+    #
+    # @return [Integer] the number of blocks away, in "manhattan distance".
+    def distance(location)
+      [delta_x(location).abs, delta_y(location).abs].reduce(:+)
+    end
+
+    ##
+    # Determine the most prominent orthoganal direction [see DIRECTIONS]
+    # toward another location.
+    #
+    # @note Returns _nil_ if the locations are the same. Favors "up" or "down"
+    #   if horizontal and vertical distances are the same.
+    #
+    # @param location [Location] another location instance.
+    #
+    # @return [one of DIRECTIONS]
+    def direction(location)
+      return nil if distance(location) == 0
+
+      dx = delta_x(location)
+      dy = delta_y(location)
+
+      if dx.abs <= dy.abs
+        dy > 0 ? 'up' : 'down'
+      elsif dx.abs > dy.abs
+        dx > 0 ? 'right' : 'left'
+      end
+    end
+
+    ##
+    # Return a new location instance with coordinates moved one step in the requested direction.
+    #
+    # @note Returns _nil_ if the requested direction is not recognized.
+    #
+    # @param requested_direction [one of DIRECTIONS]
+    #
+    # @return [Location] a new location instance.
+    def move(requested_direction)
+      return nil unless DIRECTIONS.include?(requested_direction)
+
+      new_x = x
+      new_y = y
+
+      case requested_direction
+      when 'right'
+        new_x += 1
+      when 'left'
+        new_x -= 1
+      when 'up'
+        new_y += 1
+      when 'down'
+        new_y -= 1
+      end
+
+      self.class.new(new_x, new_y)
+    end
+
+    private
+
+    def set_xy(*coordinates)
+      unless coordinates.is_a?(Array) && coordinates.size == 2
+        coordinates = coordinates.first
+      end
+
+      case coordinates
+      when Hash
+        hash_to_xy(coordinates)
+      when String
+        hash_to_xy(JSON.parse(coordinates))
+      when Array
+        array_to_xy(coordinates)
+      end
+    end
+
+    def hash_to_xy(coordinates)
+      @x = coordinates['x']
+      @y = coordinates['y']
+    end
+
+    def array_to_xy(coordinates)
+      @x, @y = coordinates
+    end
+
+    def delta_x(location)
+      location.x - x
+    end
+
+    def delta_y(location)
+      location.y - y
+    end
+  end
+end

data/lib/battlesnake/snake.rb

@@ -0,0 +1,74 @@
+require 'json'
+
+module Battlesnake
+  ##
+  # Represents a single Battlesnake player.
+  class Snake
+    # @return [Hash] snake as a data structure usable by other objects.
+    attr_reader :as_json
+
+    # @return [String] unique string which identifies the player.
+    attr_reader :id
+
+    # @return [String] name of the player.
+    attr_reader :name
+
+    # @return [Array<Location>] locations occupied by the body of the snake.
+    attr_reader :body
+
+    # @return [Integer] latency of given player's API, _nil_ if not provided.
+    attr_reader :latency
+
+    # @return [Integer] health value between 0 and 100.
+    attr_reader :health
+
+    # @return [Location] location of snake head. Should be the same as body[0].
+    attr_reader :head
+
+    # @return [Integer] number of locations occupied by snake body.
+    attr_reader :length
+
+    # @return [String] message to other players.
+    attr_reader :shout
+
+    # @return [String] squad identifer for games played with teams.
+    attr_reader :squad
+
+    # @return [Hash] display customizations.
+    attr_reader :customizations
+
+    ##
+    # Returns a new instance of Snake.
+    #
+    # @param json_or_hash [String,Hash] can be a hash of attributes, or a JSON string which
+    #   represents such a structure.
+    #
+    # @return [Snake]
+    def initialize(json_or_hash)
+      @as_json = json_or_hash.is_a?(String) ? JSON.parse(json_or_hash) : json_or_hash
+
+      @id = @as_json['id']
+      @name = @as_json['name']
+      @latency = @as_json['latency'].empty? ? nil : @as_json['latency'].to_i
+      @health = @as_json['health']
+      @length = @as_json['length']
+      @shout = @as_json['shout']
+      @squad = @as_json['squad']
+      @customizations = @as_json['customizations']
+
+      @body = @as_json['body'].map{ |coords| Location.new(coords) }
+      @head = Location.new(@as_json['head'])
+    end
+
+    ##
+    # The current direction the snake is facing, based on the first two segments
+    # of the body. If snake only has a head, no direction can be determined, so
+    # _nil_ is returned.
+    #
+    # @return [String] one of (up, down, left, right)
+    def direction
+      return @direction if defined?(@direction)
+      @direction = length > 1 ? body[1].direction(head) : nil
+    end
+  end
+end

data/lib/battlesnake/version.rb

@@ -0,0 +1,4 @@
+module Battlesnake
+  # The current version of the driver.
+  VERSION = "0.1.0"
+end

data/lib/battlesnake.rb

@@ -0,0 +1,11 @@
+require "battlesnake/version"
+require 'battlesnake/location'
+require 'battlesnake/snake'
+
+##
+# Primary namespace for the battlesnake gem.
+module Battlesnake
+  ##
+  # Default error class for Battlesnake.
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: battlesnake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaime Bellmyer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.30.0
+description: Focus on strategy, rather than the low-level mapping of JSON objects.
+email:
+- ruby@bellmyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- battlesnake.gemspec
+- bin/console
+- bin/setup
+- docs/Battlesnake.html
+- docs/Battlesnake/Error.html
+- docs/Battlesnake/Location.html
+- docs/Battlesnake/Snake.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
+- lib/battlesnake.rb
+- lib/battlesnake/location.rb
+- lib/battlesnake/snake.rb
+- lib/battlesnake/version.rb
+homepage: https://github.com/bellmyer/battlesnake
+licenses: []
+metadata:
+  homepage_uri: https://github.com/bellmyer/battlesnake
+  source_code_uri: https://github.com/bellmyer/battlesnake
+  changelog_uri: https://github.com/bellmyer/battlesnake/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Object modeling and helpful methods for building Battlesnake players.
+test_files: []