gobstones-spec 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b3c5bb11b693ef447845a080987bf266ed91d49
+  data.tar.gz: 4ad74366f324d2280aba57682b946ee2e1989017
+SHA512:
+  metadata.gz: 7a8dec77ebcf4cfa31699442077bb7e0093c4539af95ae8e5419da9f89e5e838b8f29d1f81012131868ccca885260a265ce58db08b0a450d43b4ec53b53a91e7
+  data.tar.gz: 4eba581631c514205a2b2aa8e5d93600bedff21d09a89d89cba840bcf072265cf23265e1e87c26450c2089c2cb5d6ab9082bde5dcc28907e58a94d25dc9983c9

data/lib/extensions/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def init(n=1)
+    take size - n
+  end
+end

data/lib/gobstones.rb

@@ -0,0 +1,11 @@
+module Gobstones
+end
+
+require_relative 'gobstones/board'
+require_relative 'gobstones/cell'
+require_relative 'gobstones/gbb_parser'
+require_relative 'gobstones/position'
+require_relative 'gobstones/with_tempfile'
+require_relative 'gobstones/with_command_line'
+require_relative 'gobstones/spec'
+require_relative 'gobstones/version'

data/lib/gobstones/board.rb

@@ -0,0 +1,55 @@
+module Gobstones
+
+  class OutOfBoardError < RuntimeError
+  end
+
+  class Board
+    attr_reader :size, :cells, :head_position
+
+    def initialize(x, y)
+      @size = [x, y]
+      @cells = Hash.new(Cell.new)
+      @head_position = Position.new(0, 0)
+    end
+
+    def add_cell(position, cell)
+      @cells[position] = cell
+      self
+    end
+
+    def move_head_to(position)
+      check_is_within_bounds position
+      @head_position = position
+      self
+    end
+
+    def cell_at(position)
+      check_is_within_bounds position
+      @cells[position]
+    end
+
+    def ==(other)
+      self.class === other &&
+          other.size == @size &&
+          all_cells_equal?(other)
+    end
+
+    private
+
+    def within_bounds?(position)
+      @size[0] > position.x && @size[1] > position.y
+    end
+
+    def check_is_within_bounds(position)
+      raise OutOfBoardError unless within_bounds?(position)
+    end
+
+    def all_cells_equal?(other)
+      self.class.includes_cells?(self, other) && self.class.includes_cells?(other, self)
+    end
+
+    def self.includes_cells?(this, that)
+      this.cells.all? { |position, cell| that.cell_at(position) == cell }
+    end
+  end
+end

data/lib/gobstones/cell.rb

@@ -0,0 +1,30 @@
+module Gobstones
+  class Cell
+    attr_accessor :red, :green, :blue, :black
+
+    def initialize(red: 0, green: 0, blue: 0, black: 0)
+      @red = red
+      @green = green
+      @blue = blue
+      @black = black
+    end
+
+    def set(color, quantity)
+      send "#{color}=", quantity
+    end
+
+    def ==(other)
+      self.class === other &&
+          other.red == @red &&
+          other.green == @green &&
+          other.blue == @blue &&
+          other.black == @black
+    end
+
+    alias eql? ==
+
+    def hash
+      @red.hash ^ @green.hash ^ @blue.hash ^ @black.hash
+    end
+  end
+end

data/lib/gobstones/gbb_parser.rb

@@ -0,0 +1,52 @@
+require_relative '../extensions/array.rb'
+
+
+class MatchData
+  def to_position
+    Gobstones::Position.new self[1].to_i, self[2].to_i
+  end
+end
+
+module Gobstones
+  class GbbParser
+    COLORS = {'Azul' => :blue, 'Negro' => :black, 'Rojo' => :red, 'Verde' => :green}
+
+    def from_string(gbb_string)
+      board = nil
+
+      lines = gbb_string.lines.reject { |it| it.start_with? 'GBB', '%%' }
+
+      /size (\d+) (\d+)/.match(lines[0]) { |match| board = Board.new(match[1].to_i, match[2].to_i) }
+      /head (\d+) (\d+)/.match(lines.last) { |match| board.move_head_to match.to_position }
+
+      lines.drop(1).init.each do |cell_line|
+        position = get_position_from cell_line
+        cell = create_cell_from cell_line
+
+        board.add_cell position, cell
+      end
+
+      board
+    end
+
+    private
+
+    def get_position_from(cell_line)
+      /cell (\d+) (\d+)/.match(cell_line).to_position
+    end
+
+    def create_cell_from(cell_line)
+      cell = Cell.new
+
+      cell_line.scan(/(Azul|Negro|Rojo|Verde) (\d+)/) do |match|
+        cell.set to_color(match[0]), match[1].to_i
+      end
+
+      cell
+    end
+
+    def to_color(gbb_color_string)
+      COLORS[gbb_color_string]
+    end
+  end
+end

data/lib/gobstones/position.rb

@@ -0,0 +1,22 @@
+module Gobstones
+  class Position
+    attr_reader :x, :y
+
+    def initialize(x, y)
+      @x = x
+      @y = y
+    end
+
+    def ==(other)
+      self.class === other &&
+          other.x == @x &&
+          other.y == @y
+    end
+
+    alias eql? ==
+
+    def hash
+      @x.hash ^ @y.hash
+    end
+  end
+end

data/lib/gobstones/spec.rb

@@ -0,0 +1,8 @@
+module Gobstones
+  module Spec
+  end
+end
+
+require_relative './spec/error_message_parser'
+require_relative './spec/example'
+require_relative './spec/runner'

data/lib/gobstones/spec/error_message_parser.rb

@@ -0,0 +1,19 @@
+module Gobstones::Spec
+  class ErrorMessageParser
+    def remove_traceback (x)
+      x.take_while { |str| not str.start_with? 'Traceback' }
+    end
+
+    def remove_line_specification(x)
+      x.drop(3)
+    end
+
+    def remove_boom_line_specification(x)
+      x.take_while { |str| not str.strip.start_with? 'En:' }
+    end
+
+    def parse(result)
+      remove_boom_line_specification(remove_traceback(remove_line_specification(result.lines))).join.strip
+    end
+  end
+end

data/lib/gobstones/spec/example.rb

@@ -0,0 +1,81 @@
+module Gobstones::Spec
+  class Example
+    include Gobstones::WithTempfile
+
+    attr_reader :gobstones_path
+
+    def initialize(gobstones_path, check_head_position)
+      @gobstones_path = gobstones_path
+      @check_head_position = check_head_position
+    end
+
+    def start!(source_file, initial_board, final_board)
+      @source_file = source_file
+      @expected_final_board_gbb = final_board
+      @expected_final_board = Gobstones::GbbParser.new.from_string final_board
+
+      @html_output_file = Tempfile.new %w(gobstones.output .html)
+      @actual_final_board_file = Tempfile.new %w(gobstones.output .gbb)
+      @initial_board_file = write_tempfile initial_board, 'gbb'
+
+      "#{run_on_gobstones @source_file, @initial_board_file, @actual_final_board_file} 2>&1 &&" +
+          "#{run_on_gobstones @source_file, @initial_board_file, @html_output_file}"
+    end
+
+    def result
+      actual = Gobstones::GbbParser.new.from_string(@actual_final_board_file.read)
+
+      if matches_with_expected_board? actual
+        ["<div>#{@html_output_file.read}</div>", :passed]
+      else
+        initial_board_html = get_html_board @initial_board_file.open.read
+        expected_board_html = get_html_board @expected_final_board_gbb
+
+        output =
+"<div>
+  #{add_caption initial_board_html, 'Tablero inicial'}
+  #{add_caption @html_output_file.read, 'Tablero final obtenido'}
+  #{add_caption expected_board_html, 'Tablero final esperado'}
+</div>"
+
+        [output, :failed]
+      end
+    end
+
+    def parse_error_message(result)
+      ErrorMessageParser.new.parse(result)
+    end
+
+    def stop!
+      [@html_output_file, @actual_final_board_file, @initial_board_file].each { |it| it.unlink }
+    end
+
+    private
+
+    def matches_with_expected_board?(actual_board)
+      actual_board == @expected_final_board && (!@check_head_position || actual_board.head_position == @expected_final_board.head_position)
+    end
+
+    def run_on_gobstones(source_file, initial_board_file, final_board_file)
+      "#{gobstones_path} #{source_file.path} --from #{initial_board_file.path} --to #{final_board_file.path}"
+    end
+
+    def get_html_board(gbb_representation)
+      identity = write_tempfile 'program {}', '.gbs'
+
+      board = write_tempfile gbb_representation, '.gbb'
+
+      board_html = Tempfile.new %w(gobstones.board .html)
+
+      %x"#{run_on_gobstones(identity, board, board_html)}"
+
+      result = board_html.read
+      board_html.unlink
+      result
+    end
+
+    def add_caption(board_html, caption)
+      board_html.sub '<table class="gbs_board">', "<table class=\"gbs_board\">\n<caption>#{caption}</caption>"
+    end
+  end
+end

data/lib/gobstones/spec/runner.rb

@@ -0,0 +1,50 @@
+module Gobstones::Spec
+  class Runner
+    include Gobstones::WithCommandLine
+    include Gobstones::WithTempfile
+
+    attr_reader :gobstones_path
+
+    def initialize(gobstones_path)
+      @gobstones_path = gobstones_path
+    end
+
+    def run!(test_definition)
+      source_file = write_tempfile test_definition[:source], 'gbs'
+      results = test_definition[:examples].map do |example_definition|
+        example_definition[:check_head_position] = test_definition[:check_head_position]
+        run_example!(example_definition, source_file)
+      end
+      aggregate_results(results)
+    ensure
+      source_file.unlink
+    end
+
+    private
+
+    def run_example!(example_definition, source_file)
+      command = start_example(source_file, example_definition)
+      result, status = run_command command
+      post_process result, status
+    end
+
+    def aggregate_results(results)
+      [results.map { |it| it[0] }.join("\n<hr>\n"), results.all? { |it| it[1] == :passed } ? :passed : :failed]
+    end
+
+    def post_process(result, status)
+      if status == :passed
+        @example.result
+      else
+        [@example.parse_error_message(result), status]
+      end
+    ensure
+      @example.stop!
+    end
+
+    def start_example(source, example_definition)
+      @example = Gobstones::Spec::Example.new(gobstones_path, example_definition[:check_head_position])
+      @example.start!(source, example_definition[:initial_board], example_definition[:final_board])
+    end
+  end
+end

data/lib/gobstones/version.rb

@@ -0,0 +1,3 @@
+module Gobstones
+  VERSION = '0.2.0'
+end

data/lib/gobstones/with_command_line.rb

@@ -0,0 +1,7 @@
+module Gobstones
+  module WithCommandLine
+    def run_command(command)
+      [%x{#{command}}, $?.success? ? :passed : :failed]
+    end
+  end
+end

data/lib/gobstones/with_tempfile.rb

@@ -0,0 +1,13 @@
+require 'tempfile'
+
+module Gobstones
+  module WithTempfile
+
+    def write_tempfile(content, extension)
+      file = Tempfile.new %W(gobstones. .#{extension})
+      file.write content
+      file.close
+      file
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: gobstones-spec
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Federico Aloi
+- Franco Bulgarelli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
+description: Write Gobstones specs within Ruby
+email:
+- federico.aloi@gmail.com
+- flbulgarelli@yahoo.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gobstones/with_command_line.rb
+- lib/gobstones/with_tempfile.rb
+- lib/gobstones/gbb_parser.rb
+- lib/gobstones/position.rb
+- lib/gobstones/spec/error_message_parser.rb
+- lib/gobstones/spec/example.rb
+- lib/gobstones/spec/runner.rb
+- lib/gobstones/spec.rb
+- lib/gobstones/version.rb
+- lib/gobstones/cell.rb
+- lib/gobstones/board.rb
+- lib/gobstones.rb
+- lib/extensions/array.rb
+homepage: https://github.com/uqbar-project/gobstones-spec
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Minimal test framework for the Gobstones language
+test_files: []