oxo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57d6bbd4f6bdd8eefcd5c93ec1db4645b9ee8cc3
+  data.tar.gz: 1a5f97f7dbb659b20951af02d1bddc5852b518f3
+SHA512:
+  metadata.gz: 31d6af29d95dfd648649b8f55906d1909b86fa4b8f1ef1fa9ce8160c36fc75b3cebb7eafa2e7a2f4171742e48be48ad380ee618e7e2971594fdddb3e9b016302
+  data.tar.gz: 475eb3b11dc66209b9c5d4ca76be472dbdd7de717f081191b6de95057f20f349f41e85ec263a12151cb9a7c3af07b27ef7951a6739f705e46cc651be5807377e

data/README.md

@@ -0,0 +1,42 @@
+oxo
+===
+
+`oxo` is a command line Tic-tac-toe game written in [Ruby][ruby].
+
+## Getting Started
+
+Start a game with
+
+``` sh
+$ oxo
+```
+
+and have fun!
+
+## Documentation
+
+Use `oxo --help` to display a brief help message.
+
+## Installation
+
+Use `gem install oxo` to install from RubyGems.org.
+
+## Requirements
+
+- [Ruby][ruby] 2.0.0 or higher
+
+## Reporting Bugs
+
+Report bugs on the `oxo` home page: <https://github.com/stomar/oxo/>
+
+## License
+
+Copyright &copy; 2016 Marcus Stollsteimer
+
+`oxo` is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License version 3 or later (GPLv3+),
+see [www.gnu.org/licenses/gpl.html](http://www.gnu.org/licenses/gpl.html).
+There is NO WARRANTY, to the extent permitted by law.
+
+
+[ruby]: https://www.ruby-lang.org/

data/Rakefile

@@ -0,0 +1,27 @@
+require "rake/testtask"
+
+
+def gemspec_file
+  "oxo.gemspec"
+end
+
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/test_*.rb"
+  t.verbose = true
+  t.warning = true
+end
+
+
+desc "Build gem"
+task :build do
+  sh "gem build #{gemspec_file}"
+end
+
+
+desc "Remove generated files"
+task :clean do
+  FileUtils.rm(Dir.glob("*.gem"))
+end

data/bin/oxo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "oxo"
+
+OXO::Application.new.run

data/lib/oxo.rb

@@ -0,0 +1,175 @@
+require "optparse"
+
+require "oxo/version"
+require "oxo/board"
+require "oxo/computer"
+require "oxo/human"
+
+# == Name
+#
+# oxo - a command line Tic-tac-toe game
+#
+# == See also
+#
+# Use <tt>oxo --help</tt> to display a brief help message.
+#
+# The full documentation for +oxo+ is available on the
+# project home page.
+#
+# == Author
+#
+# Copyright (C) 2016 Marcus Stollsteimer
+#
+# License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+#
+module OXO
+
+  PROGNAME  = "oxo"
+
+  COPYRIGHT = <<-copyright.gsub(/^ +/, "")
+    Copyright (C) 2016 Marcus Stollsteimer.
+    License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
+    This is free software: you are free to change and redistribute it.
+    There is NO WARRANTY, to the extent permitted by law.
+  copyright
+
+
+  class Optionparser
+
+    # Parses the command line options from +argv+.
+    # (+argv+ is cleared).
+    # Might print out help or version information.
+    #
+    # +argv+ - array with the command line options
+    #
+    # Returns a hash containing the option parameters.
+    def self.parse!(argv)
+
+      options = {
+        :delay => 0
+      }
+
+      opt_parser = OptionParser.new do |opt|
+        opt.banner = "Usage: #{PROGNAME} [options]"
+        opt.separator %q{
+          oxo is a command line Tic-tac-toe game.
+
+          Options:
+        }.gsub(/^ +/, "")
+
+        # process --version and --help first,
+        # exit successfully (GNU Coding Standards)
+        opt.on_tail("-h", "--help", "Print a brief help message and exit.") do
+          puts opt_parser
+          puts "\nReport bugs on the #{PROGNAME} home page: <#{HOMEPAGE}>"
+          exit
+        end
+
+        opt.on_tail("-v", "--version",
+                    "Print a brief version information and exit.") do
+          puts "#{PROGNAME} #{VERSION}"
+          puts COPYRIGHT
+          exit
+        end
+
+        opt.on("-d", "--delay SECONDS", Float,
+               "Set delay time for oxo's moves.") do |d|
+          options[:delay] = d
+        end
+
+        opt.separator ""
+      end
+      opt_parser.parse!(argv)
+
+      # nothing should be left in argv
+      raise(ArgumentError, "wrong number of arguments")  unless argv.empty?
+
+      options
+    end
+  end
+
+
+  class Application
+
+    ERRORCODE = {:general => 1, :usage => 2}
+
+    def initialize
+      begin
+        options = Optionparser.parse!(ARGV)
+      rescue => e
+        usage_fail(e.message)
+      end
+
+      @delay = options[:delay]
+    end
+
+    def run
+      board = Board.new
+
+      case beginning_side
+      when :quit
+        return
+      when :human
+        players = [Human.new(:X), Computer.new(:O, delay: @delay)]
+        puts board
+      when :computer
+        players = [Computer.new(:X, delay: @delay), Human.new(:O)]
+      end
+
+      game_over = false
+
+      until game_over
+        player = players.first
+        move = player.make_move(board)
+
+        break  if move == :quit
+
+        board.place(player.color, move[0], move[1])
+
+        puts board
+        puts "Move of #{player.name} was: #{(move[0] - 1) * 3 + move[1]}"
+
+        if board.win?(player.color)
+          puts "#{player.name} wins!"
+          game_over = true
+        elsif board.full?
+          puts "It's a draw."
+          game_over = true
+        end
+
+        players.rotate!
+      end
+    end
+
+    private
+
+    def beginning_side
+      choices = {
+        "1" => :human, "" => :human,
+        "2" => :computer,
+        "0" => :quit, "q" => :quit
+      }
+
+      answer = nil
+      until choices.keys.include?(answer)
+        print "Beginning side (1=Human, 2=Computer, 0/q=quit)? "
+        answer = gets.chomp
+      end
+
+      choices[answer]
+    end
+
+    # Prints an error message and exits.
+    def general_fail(message)
+      warn "#{PROGNAME}: #{message}"
+      exit ERRORCODE[:general]
+    end
+
+    # Prints an error message and a short help information, then exits.
+    def usage_fail(message)
+      warn "#{PROGNAME}: #{message}"
+      warn "Use `#{PROGNAME} --help' for valid options."
+      exit ERRORCODE[:usage]
+    end
+  end
+end

data/lib/oxo/board.rb

@@ -0,0 +1,72 @@
+module OXO
+  class Board
+
+    attr_accessor :rows, :cols
+
+    def initialize
+      @rows, @cols = 3, 3
+      @board = Array.new(@rows) { Array.new(@cols) }
+    end
+
+    def legal_move?(row, col)
+      on_board?(row, col) && !piece_at(row, col)
+    end
+
+    def place(color, row, col)
+      return  unless  legal_move?(row, col)
+      @board[row-1][col-1] = color
+    end
+
+    def legal_moves
+      empty_squares = []
+
+      1.upto(rows) do |row|
+        1.upto(cols) do |col|
+          empty_squares << [row, col]  unless piece_at(row, col)
+        end
+      end
+
+      empty_squares
+    end
+
+    def full?
+      !@board.flatten.include? nil
+    end
+
+    def win?(color)
+      @board.each {|row| return true  if row.uniq == [color] }
+      @board.transpose.each {|col| return true  if col.uniq == [color] }
+      return true  if @board.flatten.values_at(0, 4, 8).uniq == [color]
+      return true  if @board.flatten.values_at(2, 4, 6).uniq == [color]
+
+      false
+    end
+
+    def to_s
+      output = "\n"
+      hline = "+---" * @cols << "+\n"
+
+      characters = @board.map {|row| row.map {|pos| pos.to_s.ljust(1) } }
+
+      output << hline
+      characters.each do |row|
+        output << "| " << row.join(" | ") << " |" << "\n"
+        output << hline
+      end
+
+      output + "\n"
+    end
+
+    private
+
+    def on_board?(row, col)
+      (1..@rows).include?(row) && (1..@cols).include?(col)
+    end
+
+    def piece_at(row, col)
+      return  unless on_board?(row, col)
+
+      @board[row-1][col-1]
+    end
+  end
+end

data/lib/oxo/computer.rb

@@ -0,0 +1,21 @@
+module OXO
+  class Computer
+
+    attr_reader :color
+
+    def initialize(color, delay: 0)
+      @color = color
+      @delay = delay
+    end
+
+    def name
+      "oxo"
+    end
+
+    def make_move(board)
+      sleep @delay
+
+      board.legal_moves.sample
+    end
+  end
+end

data/lib/oxo/human.rb

@@ -0,0 +1,46 @@
+module OXO
+  class Human
+
+    attr_reader :color
+
+    def initialize(color)
+      @color = color
+    end
+
+    def name
+      "Human"
+    end
+
+    def make_move(board)
+      move = :illegal
+
+      while move == :illegal
+        print "Your move (1...9, 0/q=quit)? "
+        answer = gets.chomp
+
+        move = parse_answer(answer, board)
+
+        puts "Illegal move: #{answer}"  if move == :illegal
+      end
+
+      move
+    end
+
+    private
+
+    def parse_answer(answer, board)
+      case answer
+      when "0", "q", "quit"
+        :quit
+      when /\d/
+        number = answer.to_i
+        row = (number - 1) / board.rows + 1
+        col = (number - 1) % board.cols + 1
+
+        board.legal_move?(row, col) ? [row, col] : :illegal
+      else
+        :illegal
+      end
+    end
+  end
+end

data/lib/oxo/version.rb

@@ -0,0 +1,5 @@
+module OXO
+  VERSION  = "0.1.0"
+  DATE     = "2016-04-27"
+  HOMEPAGE = "https://github.com/stomar/oxo/"
+end

data/oxo.gemspec

@@ -0,0 +1,40 @@
+require_relative "lib/oxo/version"
+
+version  = OXO::VERSION
+date     = OXO::DATE
+homepage = OXO::HOMEPAGE
+
+Gem::Specification.new do |s|
+  s.name              = "oxo"
+  s.version           = version
+  s.date              = date
+
+  s.summary = "oxo is a command line Tic-tac-toe game."
+  s.description = s.summary
+
+  s.authors = ["Marcus Stollsteimer"]
+  s.email = "sto.mar@web.de"
+  s.homepage = homepage
+
+  s.license = "GPL-3.0"
+
+  s.required_ruby_version = ">= 2.0.0"
+
+  s.add_development_dependency "rake", "~> 11.1"
+  s.add_development_dependency "minitest", "~> 5.8"
+
+  s.executables = ["oxo"]
+  s.bindir = "bin"
+
+  s.require_paths = ["lib"]
+
+  s.files = %w[
+      oxo.gemspec
+      README.md
+      Rakefile
+    ] +
+    Dir.glob("{bin,lib,test}/**/*")
+
+  s.extra_rdoc_files = %w[README.md]
+  s.rdoc_options = ["--charset=UTF-8", "--main=README.md"]
+end

data/test/test_board.rb

@@ -0,0 +1,15 @@
+require "minitest/autorun"
+require "oxo/board"
+
+
+describe OXO::Board do
+
+  before do
+    @board = OXO::Board.new
+  end
+
+  it "should have the correct size" do
+    @board.rows.must_equal 3
+    @board.cols.must_equal 3
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: oxo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcus Stollsteimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: oxo is a command line Tic-tac-toe game.
+email: sto.mar@web.de
+executables:
+- oxo
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Rakefile
+- bin/oxo
+- lib/oxo.rb
+- lib/oxo/board.rb
+- lib/oxo/computer.rb
+- lib/oxo/human.rb
+- lib/oxo/version.rb
+- oxo.gemspec
+- test/test_board.rb
+homepage: https://github.com/stomar/oxo/
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+- "--main=README.md"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: oxo is a command line Tic-tac-toe game.
+test_files: []