tic-tac-toe-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fc892ec07147aa303cc7bd17d4c6c18519ce938
+  data.tar.gz: 800d2eda86be8a1502d37a942682c42fb3e68ea0
+SHA512:
+  metadata.gz: 9f632dbe6cea72d57d0f3de6403d9e720ea04893996ac6d69dc118cd98863a9e8865b2dcea129477d8e275153e9e8bfd445ed6048b68ef380f231bb533ac86ed
+  data.tar.gz: 67735825fc81fda8cd6564af3f3f12d4fdcb36e5274acecb162b435fcdb517d160274bc6cd27a4df9f1e3f58b626ca8843b6a3eab0971d690f89ef4c153ef7d0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Janko Marohnić
+
+MIT License
+
+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,38 @@
+# Tic-tac-toe
+
+Play a game of tic-tac-toe in your Terminal.
+
+![Tic-tac-toe preview](/preview.png)
+
+## Installation
+
+```sh
+$ gem install tic-tac-toe-ruby
+```
+
+## Usage
+
+```sh
+$ tic-tac-toe --size 10 --players 3 --goal 4
+```
+```
+$ tic-tac-toe --help
+USAGE: tic-tac-toe [options]
+
+Moving: Arrow keys or h/j/k/l
+Placing symbol: <Space>
+Exit: Ctrl-C
+
+    -n, --size N               Size of the board (default: 3)
+    -p, --players N            The number of players (default: 2, max: 5)
+    -g, --goal N               The number symbols in a row is required (default: 3)
+```
+
+## Implementation
+
+The game was implemented in Ruby using the [`curses`](https://github.com/ruby/curses)
+gem, which binds to Curses C library.
+
+## License
+
+MIT.

data/bin/tic-tac-toe

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+
+options = {}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<-EOS
+USAGE: tic-tac-toe [options]
+
+Moving: Arrow keys or h/j/k/l
+Placing symbol: <Space>
+Exit: Ctrl-C
+
+  EOS
+
+  opts.on("-n", "--size N", "Size of the board (default: 3)") do |n|
+    options[:size] = Integer(n)
+  end
+
+  opts.on("-p", "--players N", "The number of players (default: 2, max: 5)") do |n|
+    options[:number_of_players] = Integer(n)
+  end
+
+  opts.on("-g", "--goal N", "The number symbols in a row is required (default: 3)") do |n|
+    options[:goal] = Integer(n)
+  end
+end
+
+opt_parser.parse!(ARGV)
+
+require "tic_tac_toe"
+
+TicTacToe.new(options).start

data/lib/tic_tac_toe.rb

@@ -0,0 +1,69 @@
+require "tic_tac_toe/board"
+require "tic_tac_toe/player"
+require "tic_tac_toe/cursor"
+require "tic_tac_toe/rules"
+require "tic_tac_toe/tui"
+
+class TicTacToe
+  def initialize(size: 3, number_of_players: 2, goal: 3)
+    @board   = TicTacToe::Board.new(size)
+    @players = TicTacToe::PlayerList.new(number_of_players)
+    @cursor  = TicTacToe::Cursor.new(@board)
+    @rules   = TicTacToe::Rules.new(goal)
+  end
+
+  def start
+    @tui = TicTacToe::TUI.new
+    setup
+
+    @tui.listen do |key|
+      handle_keypress(key) unless game_over?
+    end
+  end
+
+  private
+
+  def setup
+    @tui.board!(@board.to_s)
+    @tui.cursor!(@cursor.field)
+    @tui.status!(@players.to_a, @players.current)
+  end
+
+  def handle_keypress(key)
+    case key
+    when :UP, :DOWN, :RIGHT, :LEFT
+      move(key.downcase)
+    when "h", "j", "k", "l"
+      direction = {"h" => :left, "j" => :down, "k" => :up, "l" => :right}[key]
+      move(direction)
+    when " "
+      mark
+      if game_over?
+        @tui.cursor!(@cursor.field, hidden: true)
+        @tui.status!(@players.to_a)
+      end
+    when :RESIZE
+      @tui.clear
+      setup
+    end
+  end
+
+  def move(direction)
+    @cursor = @cursor.move(direction)
+    @tui.cursor!(@cursor.field)
+  end
+
+  def mark
+    return if @board.marked?(@cursor.field)
+
+    @board = @board.mark(@cursor.field, @players.current.symbol)
+    @tui.board!(@board.to_s)
+
+    @players.next!
+    @tui.status!(@players.to_a, @players.current)
+  end
+
+  def game_over?
+    @rules.game_over?(@board, @players)
+  end
+end

data/lib/tic_tac_toe/board.rb

@@ -0,0 +1,73 @@
+require "matrix"
+require "tty"
+
+class TicTacToe
+  class Board
+    BLANK_SYMBOL = " "
+
+    def initialize(matrix_or_size)
+      @matrix =
+        case matrix_or_size
+        when Matrix  then matrix_or_size
+        when Integer then Matrix.build(matrix_or_size) { BLANK_SYMBOL }
+        end
+    end
+
+    def fields
+      @matrix.each_with_index.map { |_, *field| field }
+    end
+
+    def size
+      @matrix.row_count
+    end
+
+    def mark(field, symbol)
+      new_matrix = @matrix.dup
+      new_matrix.send(:[]=, *field, symbol)
+      TicTacToe::Board.new(new_matrix)
+    end
+
+    def marked?(field)
+      @matrix[*field] != BLANK_SYMBOL
+    end
+
+    def to_s
+      table = TTY::Table.new(@matrix.to_a)
+      table.render(:unicode) do |renderer|
+        renderer.border.separator = :each_row
+        renderer.padding = [0, 1, 0, 1]
+      end
+    end
+
+    def rows
+      @matrix.to_a
+    end
+
+    def columns
+      @matrix.transpose.to_a
+    end
+
+    def diagonals
+      (right_diagonals + left_diagonals)
+        .map { |diagonal| diagonal.map { |field| @matrix[*field] } }
+    end
+
+    private
+
+    # - - - -
+    # x - - -
+    # - x - -
+    # - - x -
+    def right_diagonals
+      fields.group_by { |x, y| x - y }.values
+    end
+
+    # - - x -
+    # - x - -
+    # x - - -
+    # - - - -
+    def left_diagonals
+      fields.group_by { |x, y| x + y }.values
+    end
+  end
+end

data/lib/tic_tac_toe/cursor.rb

@@ -0,0 +1,41 @@
+class TicTacToe
+  class Cursor
+    OutOfBounds = Class.new(StandardError)
+
+    attr_reader :field
+
+    def initialize(field = nil, board)
+      @field  = field || board.fields.first
+      @board  = board
+
+      raise OutOfBounds unless @board.fields.include?(@field)
+    end
+
+    def move(direction)
+      send(direction)
+    rescue TicTacToe::Cursor::OutOfBounds
+      self
+    end
+
+    private
+
+    def up
+      TicTacToe::Cursor.new([x - 1, y], @board)
+    end
+
+    def down
+      TicTacToe::Cursor.new([x + 1, y], @board)
+    end
+
+    def right
+      TicTacToe::Cursor.new([x, y + 1], @board)
+    end
+
+    def left
+      TicTacToe::Cursor.new([x, y - 1], @board)
+    end
+
+    def x; field[0]; end
+    def y; field[1]; end
+  end
+end

data/lib/tic_tac_toe/player.rb

@@ -0,0 +1,38 @@
+class TicTacToe
+  Player = Struct.new(:symbol, :color)
+
+  class PlayerList
+    AVAILABLE_PLAYERS = [
+      Player.new("x", :red),
+      Player.new("○", :blue),
+      Player.new("△", :yellow),
+      Player.new("□", :green),
+      Player.new("◇", :magenta),
+    ]
+
+    include Enumerable
+
+    def initialize(number)
+      @players     = AVAILABLE_PLAYERS.first(number)
+      @current_idx = 0
+    end
+
+    def each(&block)
+      @players.each(&block)
+    end
+
+    def current
+      @players[@current_idx]
+    end
+
+    def next!
+      @current_idx = (@current_idx + 1) % @players.count
+    end
+
+    def colors
+      @players.inject({}) do |colors, player|
+        colors.update(player.symbol => player.color)
+      end
+    end
+  end
+end

data/lib/tic_tac_toe/rules.rb

@@ -0,0 +1,27 @@
+class TicTacToe
+  class Rules
+    def initialize(goal)
+      @goal = goal
+    end
+
+    def game_over?(board, players)
+      players.any? { |player| player_won?(player, board) } or board_full?(board)
+    end
+
+    private
+
+    def board_full?(board)
+      board.fields.all? { |field| board.marked?(field) }
+    end
+
+    def player_won?(player, board)
+      (board.rows + board.columns + board.diagonals).any? do |sequence|
+        winning_adjacency?(player.symbol, sequence)
+      end
+    end
+
+    def winning_adjacency?(symbol, sequence)
+      /#{symbol}{#{@goal},}/ === sequence.join
+    end
+  end
+end

data/lib/tic_tac_toe/tui.rb

@@ -0,0 +1,57 @@
+require "curses"
+
+require "tic_tac_toe/tui/setup"
+require "tic_tac_toe/tui/board"
+require "tic_tac_toe/tui/cursor"
+require "tic_tac_toe/tui/status"
+
+class TicTacToe
+  class TUI # Textual User Inteface
+    def initialize
+      TUI::Setup.call
+    end
+
+    def listen
+      loop do
+        key = getch
+        yield key
+      end
+    rescue Interrupt
+    end
+
+    def board!(*args)
+      @board ||= TUI::Board.new(*args)
+      @board.update(*args)
+    end
+
+    def cursor!(*args)
+      @cursor ||= TUI::Cursor.new(@board.window)
+      @cursor.update(*args)
+    end
+
+    def status!(*args)
+      @status ||= TUI::Status.new(@board.window)
+      @status.update(*args)
+    end
+
+    def clear
+      @board.window.close
+      Curses.clear
+      Curses.refresh
+
+      @board = @cursor = @status = nil
+    end
+
+    private
+
+    def getch
+      case key = @board.window.getch
+      when String  # printable character
+        key
+      when Integer # special key
+        Curses::Key.constants
+          .find { |name| Curses::Key.const_get(name) == key }
+      end
+    end
+  end
+end

data/lib/tic_tac_toe/tui/board.rb

@@ -0,0 +1,72 @@
+require "strscan"
+
+class TicTacToe
+  class TUI
+    class Board
+      SYMBOL_COLORS = {
+        "x" => Curses::COLOR_RED,
+        "○" => Curses::COLOR_BLUE,
+        "△" => Curses::COLOR_YELLOW,
+        "□" => Curses::COLOR_GREEN,
+        "◇" => Curses::COLOR_MAGENTA,
+      }
+      COLOR_GRAY = 8
+
+      attr_reader :window
+
+      def initialize(board)
+        @window = new_window(board)
+        update(board)
+      end
+
+      def update(board)
+        symbols = SYMBOL_COLORS.keys
+        scanner = StringScanner.new(board)
+
+        redraw do
+          loop do
+            box_part = scanner.scan_until(/(?=#{Regexp.union(*symbols, /\Z/)})/)
+            write_box(box_part)
+
+            break if scanner.eos?
+
+            symbol = scanner.getch
+            write_symbol(symbol, SYMBOL_COLORS.fetch(symbol))
+          end
+        end
+      end
+
+      private
+
+      def new_window(board)
+        height = board.lines.count
+        width  = board.lines.first.length
+        top    = (Curses.lines / 2) - (height / 2)
+        left   = (Curses.cols / 2) - (width / 2)
+
+        Curses::Window.new(height, width, top, left).tap do |window|
+          window.keypad(true)
+        end
+      end
+
+      def write_box(string)
+        @window.attron(Curses.color_pair(COLOR_GRAY)) do
+          @window.addstr(string)
+        end
+      end
+
+      def write_symbol(symbol, color)
+        @window.attron(Curses.color_pair(color)) do
+          @window.addstr(symbol)
+        end
+      end
+
+      def redraw
+        cursor_position = [@window.cury, @window.curx]
+        @window.clear
+        yield
+        @window.setpos(*cursor_position)
+      end
+    end
+  end
+end

data/lib/tic_tac_toe/tui/cursor.rb

@@ -0,0 +1,34 @@
+class TicTacToe
+  class TUI
+    class Cursor
+      X_SPACING = 2
+      X_MARGIN  = 1
+
+      Y_SPACING = 4
+      Y_MARGIN  = 2
+
+      def initialize(window)
+        @window = window
+      end
+
+      def update(field, hidden: false)
+        update_position(field)
+        update_visibility(hidden)
+      end
+
+      private
+
+      def update_position(field)
+        x, y = field
+        position = [x * X_SPACING + X_MARGIN, y * Y_SPACING + Y_MARGIN]
+        @window.setpos(*position)
+      end
+
+      def update_visibility(hidden)
+        if hidden
+          Curses.curs_set(0)
+        end
+      end
+    end
+  end
+end

data/lib/tic_tac_toe/tui/setup.rb

@@ -0,0 +1,39 @@
+class TicTacToe
+  class TUI
+    class Setup
+      def self.call
+        Curses.init_screen
+        at_exit { Curses.close_screen }
+
+        setup_keypress_input!
+        enable_colors!
+        setup_basic_colors!
+      end
+
+      private
+
+      def self.setup_keypress_input!
+        Curses.cbreak              # listen for single keypresses (instead of newline)
+        Curses.noecho              # don't echo the entered keys
+
+        Curses.nonl                # recognize the "return" key
+        Curses.stdscr.keypad(true) # recognize special keys (e.g. arrow keys)
+      end
+
+      def self.enable_colors!
+        Curses.start_color         # enable colors
+        Curses.use_default_colors  # use terminal's default colors (e.g. background)
+      end
+
+      def self.setup_basic_colors!
+        Curses.init_pair(Curses::COLOR_RED,     Curses::COLOR_RED,     -1)
+        Curses.init_pair(Curses::COLOR_BLUE,    Curses::COLOR_BLUE,    -1)
+        Curses.init_pair(Curses::COLOR_GREEN,   Curses::COLOR_GREEN,   -1)
+        Curses.init_pair(Curses::COLOR_YELLOW,  Curses::COLOR_YELLOW,  -1)
+        Curses.init_pair(Curses::COLOR_MAGENTA, Curses::COLOR_MAGENTA, -1)
+        Curses.init_pair(Curses::COLOR_CYAN,    Curses::COLOR_CYAN,    -1)
+        Curses.init_pair(8,                     235,                   -1) # gray
+      end
+    end
+  end
+end

data/lib/tic_tac_toe/tui/status.rb

@@ -0,0 +1,51 @@
+require "strscan"
+
+class TicTacToe
+  class TUI
+    class Status
+      def initialize(window)
+        @window = window
+      end
+
+      def update(players, current_player = nil)
+        cursor_position = [@window.cury, @window.curx]
+        do_update(players, current_player)
+        Curses.refresh
+        @window.setpos(*cursor_position)
+      end
+
+      private
+
+      def do_update(players, current_player = nil)
+        max_cols = (Curses.lines / 2 - @window.maxy / 2)
+        start = (max_cols - (players.count * 2 - 1)) / 2
+
+        players.each.with_index do |player, idx|
+          line = "Player #{player.symbol}".center(Curses.cols)[1..-1]
+          scanner = StringScanner.new(line)
+
+          Curses.setpos(start + idx * 2, 0)
+
+          Curses.attron(Curses::A_BOLD) if player == current_player
+
+          text = scanner.scan_until(/(?=#{player.symbol})/)
+          Curses.addstr(text)
+
+          write_symbol(scanner.getch, player.color)
+
+          text = scanner.scan_until(/\Z/)
+          Curses.addstr(text)
+
+          Curses.attroff(Curses::A_BOLD) if player == current_player
+        end
+      end
+
+      def write_symbol(symbol, color_name)
+        color = Curses.const_get("COLOR_#{color_name.upcase}")
+        Curses.attron(Curses.color_pair(color)) do
+          Curses.addstr(symbol)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: tic-tac-toe-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.17
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.17
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Play the tic-tac-toe game in the Terminal. Supports fields of any size,
+  and can be played with up to 5 players.
+email:
+- janko.marohnic@gmail.com
+executables:
+- tic-tac-toe
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/tic-tac-toe
+- lib/tic_tac_toe.rb
+- lib/tic_tac_toe/board.rb
+- lib/tic_tac_toe/cursor.rb
+- lib/tic_tac_toe/player.rb
+- lib/tic_tac_toe/rules.rb
+- lib/tic_tac_toe/tui.rb
+- lib/tic_tac_toe/tui/board.rb
+- lib/tic_tac_toe/tui/cursor.rb
+- lib/tic_tac_toe/tui/setup.rb
+- lib/tic_tac_toe/tui/status.rb
+homepage: https://github.com/janko-m/tic-tac-toe
+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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Play the tic-tac-toe game in the Terminal.
+test_files: []
+has_rdoc: