lemmibot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b106002c756748ac7852fdb8b8b616d2dd4f72f
+  data.tar.gz: dbd17187abff6a25faa338b4fd45fc3d6114688b
+SHA512:
+  metadata.gz: 77ac2d3a783f676071c553ca15e1c2e3ae5948182260d31aeaa01dcb0c63bfaf064b6b8a89f870b4d52b23b5492162b8004cd673caae39285ce13e68ee41e1fc
+  data.tar.gz: fea7929b621aca80379f15ea6fde93f035574edf5ef23a5a5ce6ae7ed078be4468d9dce76f651bb799e8c22f62eb45f7a2a323e1ddae2f121257bdb12bd571ff

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+# Do not prefix writer method names with set_
+Style/AccessorMethodName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lemmibot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Effy Elden
+
+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,41 @@
+# Lemmibot
+
+A toy robot simulator with more self-preservation instincts than a real lemming.
+
+## Installation
+
+Install the gem from [RubyGems](https://rubygems.org/):
+
+    $ gem install lemmibot
+
+## Usage
+
+Once installed, start an interactive bot interface:
+
+    $ lemmibot
+
+Congratulations! You've now created your very own Lemmibot.
+
+The bot will accept the following commands:
+
+* `PLACE X,Y,F` (e.g. `PLACE 2,1,NORTH`) - Places the bot at the specified coordinates on the table top, facing the specified position.
+* `MOVE` - Moves the bot one unit in the currently facing direction.
+* `LEFT` - Rotates the bot 90 degrees left, changing the faced direction but not moving the bot.
+* `RIGHT` - Rotates the bot 90 degrees right, changing the faced direction but not moving the bot.
+* `REPORT` - Outputs a report of the bot's current position and direction, in the format `0,1,NORTH`.
+
+The bot must be placed before it will accept any other commands.
+
+Any erroneous commands (including unrecognised commands and malformed commands) will be silently ignored.
+
+Any commands that would result in this bot's untimely demise
+(e.g. placing it off the edge of the table, or attempting to move the bot off the edge of the table)
+will be silently ignored.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ineffyble/lemmibot.
+
+## License
+
+Lemmibot is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:cop)
+
+task default: %i[spec cop]

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/lemmibot

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'lemmibot'
+
+interface = Lemmibot::CommandInterface.new
+interface.start

data/lemmibot.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lemmibot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lemmibot'
+  spec.version       = Lemmibot::VERSION
+  spec.authors       = ['Effy Elden']
+  spec.email         = ['git@effy.is']
+
+  spec.summary       = 'A toy robot simulator'
+  spec.homepage      = 'https://github.com/ineffyble/lemmibot'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+end

data/lib/lemmibot/bot.rb

@@ -0,0 +1,90 @@
+module Lemmibot
+  # A simulated toy robot on a table top
+  class Bot
+    DIRECTIONS = %i[west north east south].freeze
+    attr_reader :pos_x
+    attr_reader :pos_y
+    attr_reader :direction
+    attr_reader :placed
+
+    def initialize
+      # Set the bot's position when instantiated
+      @pos_x = 0
+      @pos_y = 0
+      @direction = :north
+      @placed = false
+    end
+
+    def valid_direction?(direction)
+      DIRECTIONS.include? direction
+    end
+
+    def set_direction(direction)
+      # Set the bot to be facing a specified valid direction
+      return false unless valid_direction? direction
+      @direction = direction
+      true
+    end
+
+    def valid_position?(position)
+      position >= 0 && position <= 4
+    end
+
+    def set_position(axis, position)
+      # Set the bot to a specified valid position on specified axis
+      return false unless valid_position? position
+      if axis == :x
+        @pos_x = position
+      else
+        @pos_y = position
+      end
+      true
+    end
+
+    def change_position(axis, value)
+      # Alter the bot's position on the table top
+      new_position = if axis == :x
+                       @pos_x + value
+                     else
+                       @pos_y + value
+                     end
+      set_position(axis, new_position)
+    end
+
+    def turn(relative_direction)
+      # Rotate the bot 90 degrees to face another direction
+      # TODO: Find a nicer way to find the new direction
+      return false unless @placed
+      change = if relative_direction == :left
+                 -1
+               else
+                 1
+               end
+      next_direction_index = DIRECTIONS.index(@direction) + change
+      next_direction_index = 0 if next_direction_index > DIRECTIONS.count - 1
+      new_direction = DIRECTIONS[next_direction_index]
+      set_direction(new_direction)
+    end
+
+    def move
+      # Move the bot one unit in the direction it is facing
+      # TODO: Find a more elegant solution for this
+      return false unless @placed
+      case @direction
+      when :north then return change_position(:y, 1)
+      when :south then return change_position(:y, -1)
+      when :east then return change_position(:x, 1)
+      when :west then return change_position(:x, -1)
+      end
+    end
+
+    def place(x, y, direction)
+      # Places the bot at a specified position, facing specified direction
+      return false unless set_position(:x, x) &&
+                          set_position(:y, y) &&
+                          set_direction(direction)
+      @placed = true
+      true
+    end
+  end
+end

data/lib/lemmibot/command_interface.rb

@@ -0,0 +1,45 @@
+module Lemmibot
+  # An interface for issuing commands to a Lemmibot via CLI/STDIN
+  class CommandInterface
+    def initialize
+      @bot = Lemmibot::Bot.new
+    end
+
+    def start
+      puts 'Lemmibot is awaiting your commands'
+      loop do
+        command = gets
+        return unless command
+        process_command(command.chomp)
+      end
+    end
+
+    def process_command(command)
+      case command.upcase
+      when /PLACE/
+        args = place_arguments(command)
+        @bot.place(args[:x], args[:y], args[:dir])
+      when /MOVE/ then @bot.move
+      when /LEFT/ then @bot.turn(:left)
+      when /RIGHT/ then @bot.turn(:right)
+      when /REPORT/ then report
+      end
+    end
+
+    # Parses arguments for a PLACE command and returns them as a hash
+    def place_arguments(command)
+      params_string = command.split(' ')[1]
+      params = params_string.split(',')
+      {
+        x: params[0].to_i,
+        y: params[1].to_i,
+        dir: params[2].downcase.to_sym
+      }
+    end
+
+    # Outputs a report of the bot's current position and direction
+    def report
+      puts "#{@bot.pos_x},#{@bot.pos_y},#{@bot.direction.upcase}"
+    end
+  end
+end

data/lib/lemmibot/version.rb

@@ -0,0 +1,3 @@
+module Lemmibot
+  VERSION = '0.1.0'.freeze
+end

data/lib/lemmibot.rb

@@ -0,0 +1,7 @@
+require 'lemmibot/version'
+require 'lemmibot/bot'
+require 'lemmibot/command_interface'
+
+# A toy robot simulator
+module Lemmibot
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: lemmibot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Effy Elden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: 
+email:
+- git@effy.is
+executables:
+- lemmibot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- exe/lemmibot
+- lemmibot.gemspec
+- lib/lemmibot.rb
+- lib/lemmibot/bot.rb
+- lib/lemmibot/command_interface.rb
+- lib/lemmibot/version.rb
+homepage: https://github.com/ineffyble/lemmibot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A toy robot simulator
+test_files: []