conway_deathmatch 0.3.2.3 → 0.3.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac3920dc44bcb59aa54aa67bc61792ff6b70d9a7
-  data.tar.gz: 5869724d143ac0bdb2ba130b73507c1e55fc1196
+  metadata.gz: 0c2b0b7a5f1a97dd224542429ceb5d288e61ed2f
+  data.tar.gz: 77d40e41599218e8e315a4661e77e37130a7187a
 SHA512:
-  metadata.gz: 0cda457bd8139a741f9334cce9bebc1841c7e9b15bb0347c059a7ae180d926bcb1c596e92b45644603b4cd40e2e50cb12674e2720ee8513b4e38c56fc63e6ba6
-  data.tar.gz: 8825b9dcb08171c0a28033d5032fe6603e3c8c7dc204a17a3e37f7f1732dd862a7548f390bfebde49179ef016f32a12421546c1a27fdf6a28096f0924bdd0006
+  metadata.gz: 5686348c544509c2843456d23e3f296a77e38dd66705851b916a2998cc86e01bcf3310c7f3e86a4642e8a7bb47b8e20ecf2419b296068f6f125ad270e4195be1
+  data.tar.gz: d56b0a39e7a10760eef7abb8a13e6da5a24af3f3080def4e58d9c9bbafc3990a7be5e257d0d4487d967aabd7d53f82af682a918e0e24a1784c4594e69557fbe4

data/README.md

@@ -0,0 +1,114 @@
+[![Build Status](https://travis-ci.org/rickhull/conway_deathmatch.svg?branch=master)](https://travis-ci.org/rickhull/conway_deathmatch)
+[![Gem Version](https://badge.fury.io/rb/conway_deathmatch.svg)](http://badge.fury.io/rb/conway_deathmatch)
+[![Code Climate](https://codeclimate.com/github/rickhull/conway_deathmatch/badges/gpa.svg)](https://codeclimate.com/github/rickhull/conway_deathmatch)
+[![Dependency Status](https://gemnasium.com/rickhull/conway_deathmatch.svg)](https://gemnasium.com/rickhull/conway_deathmatch)
+[![Security Status](https://hakiri.io/github/rickhull/conway_deathmatch/master.svg)](https://hakiri.io/github/rickhull/conway_deathmatch/master)
+
+Introduction
+===
+
+[Conway's Game of Life](http://en.wikipedia.org/wiki/Conway%27s_Game_of_Life)
+is a small, simple set of rules for
+[cellular automata](http://en.wikipedia.org/wiki/Cellular_automaton).
+Operating like a simulation, there is a starting state where certain points on
+a 2 dimensional board are populated, and the rules of the game determine the
+next state, generating interesting, unpredictable, and ultimately lifelike
+patterns over time.
+
+This project was inspired by http://gameoflifetotalwar.com/ (hereafter CGOLTW).
+You should check it out.  It updates the classic set of rules, which support
+only a single population, for multiple populations which are able to compete
+for space and population.
+
+This project exists not to compete with CGOLTW but as a supplementary
+project for exploration and learning.  My initial motivation was to make a
+"proving ground" for searching for simple shapes and patterns with high birth
+rates for determining successful CGOLTW strategies. 
+
+Usage
+===
+
+Requirements
+---
+
+* Ruby 2.0 or newer (`__dir__` is used in the gemspec and for shape loading)
+
+
+Install
+---
+
+    gem install conway_deathmatch
+
+Demo
+---
+
+    # defaults to 70x40 board and an acorn shape
+    conway_deathmatch
+    
+    # multiplayer
+    conway_deathmatch --one "acorn 30 30" --two "die_hard 20 10"
+
+Available Shapes
+---
+
+[Definitions](https://github.com/rickhull/conway_deathmatch/blob/master/lib/conway_deathmatch/data/shapes.yaml)
+
+* acorn
+* beacon
+* beehive
+* blinker
+* block
+* block_engine_count (block engine, minimal point count)
+* block_engine_space (block engine, minimal footprint)
+* block_engine_stripe (block engine, 1 point tall)
+* boat
+* die_hard
+* glider
+* loaf
+* lwss (lightweight spaceship)
+* rpent (R-pentomino)
+* swastika
+* toad
+
+Implementation
+===
+
+Just one file, aside from shape loading: [Have a look-see](https://github.com/rickhull/conway_deathmatch/blob/master/lib/conway_deathmatch/board_state.rb)
+
+This implementation emphasizes simplicity and ease of understanding.  Currently
+there are no performance optimizations.  I would like to use this project
+to demonstrate the process of optimization, ideally adding optimization on
+an optional, parallel, or otherwise non-permanent basis -- i.e. maintain the
+simple, naive implementation for reference and correctness.
+
+Inspiration
+---
+Coming into this project, I had significant background knowledge concerning
+Conway's Game of Life, but I could not have recited the basic rules in any
+form. After being inspired by competing in CGOLTW, I read their [one background
+page](http://gameoflifetotalwar.com/how-to-play) and then the
+[wikipedia page](http://en.wikipedia.org/wiki/Conway%27s_Game_of_Life).  I
+deliberately avoided any knowledge of any other implementations,
+considering this project's implementation as of November 24 (2014) to be the
+naive, simple approach.
+
+Researched optimizations are now an immediate priority.
+
+Caveats
+---
+
+### Boundaries
+
+As currently implemented, this project uses fixed boundaries, and boundary
+behavior is not standardized to my knowledge.  For this project, points out of
+bounds are treated as always-dead and unable-to-be-populated.
+
+### Multiplayer
+
+The rules for multiplayer are not standardized.  I read about the CGOLTW
+approach, and this project's approach is similar but different.  In CGOLTW,
+there are always 3 populations, and one population (civilians) is special, in
+that civilians are born where there is birthright contention.  Birthright
+contention happens when a new cell must be generated, but none of the
+neighboring parents have a unique plurality.  For this project, birthright
+contention is resolved with a random selection (TODO).

data/Rakefile

@@ -0,0 +1,23 @@
+require 'buildar'
+
+Buildar.new do |b|
+  b.gemspec_file = 'conway_deathmatch.gemspec'
+  b.version_file = 'VERSION'
+end
+
+task default: %w[test bench]
+
+require 'rake/testtask'
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.name = "test"
+  t.pattern = "test/test_*.rb"
+  # t.warning = true
+end
+
+desc "Run benchmarks"
+Rake::TestTask.new do |t|
+  t.name = "bench"
+  t.pattern = "test/bench_*.rb"
+  # t.warning = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.2.5

data/conway_deathmatch.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name        = 'conway_deathmatch'
+  s.version     = File.read(File.join(__dir__, 'VERSION')).chomp
+  s.summary     = "Conway's Game of Life"
+  s.description = "Deathmatch"
+  s.authors     = ["Rick Hull"]
+  s.homepage    = 'https://github.com/rickhull/conway_deathmatch'
+  s.license     = 'GPL'
+  s.files       = [
+    'conway_deathmatch.gemspec',
+    'VERSION',
+    'Rakefile',
+    'README.md',
+    'lib/conway_deathmatch.rb',
+    'lib/conway_deathmatch/board_state.rb',
+    'lib/conway_deathmatch/shapes.rb',
+    'lib/conway_deathmatch/data/shapes.yaml',
+    'bin/conway_deathmatch',
+    'test/bench_board_state.rb',
+    'test/spec_helper.rb',
+    'test/test_board_state.rb',
+    'test/test_shapes.rb',
+  ]
+  s.executables = ['conway_deathmatch']
+  s.add_development_dependency "buildar", "~> 2"
+  s.add_development_dependency "minitest", "~> 5"
+  s.required_ruby_version = "~> 2"
+end

data/lib/conway_deathmatch/board_state.rb

@@ -60,8 +60,8 @@ class ConwayDeathmatch::BoardState
     (x-1..x+1).each { |xn|
       next if outer_ring and !xn.between?(0, @x_len - 1)
       (y-1..y+1).each { |yn|
-        next if outer_ring and !yn.between?(0, @y_len - 1)
-        next if xn == x and yn == y # don't count self
+        next if (outer_ring and !yn.between?(0, @y_len - 1)) or
+          (xn == x and yn == y)
         neighbors[@state[xn][yn]] += 1
       }
     }
@@ -85,8 +85,7 @@ class ConwayDeathmatch::BoardState
     else
       count = 0
       neighbor_population(x, y).each { |sym, cnt|
-        next if sym == DEAD
-        count += cnt
+        count += cnt unless sym == DEAD
       }
       [count, ALIVE]
     end

data/test/bench_board_state.rb

@@ -0,0 +1,31 @@
+require 'minitest/autorun'
+require 'minitest/benchmark'
+
+require 'conway_deathmatch'
+
+include ConwayDeathmatch
+
+BENCH_NEW_THRESH = (ENV['BENCH_NEW_THRESH'] || 0.9).to_f
+BENCH_TICK_THRESH = (ENV['BENCH_TICK_THRESH'] || 0.9995).to_f
+
+describe "BoardState.new Benchmark" do
+  bench_range do
+    bench_exp 9, 9999, 3
+  end
+
+  bench_performance_linear "width*height", BENCH_NEW_THRESH do |n|
+    BoardState.new(n, n)
+  end
+end
+
+describe "BoardState#tick Benchmark" do
+  bench_range do
+    bench_exp 1, 100, 3
+  end
+
+  bench_performance_linear "acorn demo", BENCH_TICK_THRESH do |n|
+    b = BoardState.new(70, 40)
+    Shapes.add(b, "acorn 50 18")
+    n.times { b.tick }
+  end
+end

data/test/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'conway_deathmatch'
+
+include ConwayDeathmatch
+
+DEAD = BoardState::DEAD
+ALIVE = BoardState::ALIVE
+
+SHAPE = "acorn"
+SHAPE_STR = "#{SHAPE} 0 0"
+POINTS_COUNT = 7
+SHAPE_TICK_POINTS = [
+  [0, 1],
+  [1, 1],
+  [2, 1],
+  [4, 1],
+  [4, 2],
+  [5, 1],
+  [5, 2],
+  [5, 3],
+]

data/test/test_board_state.rb

@@ -0,0 +1,53 @@
+require_relative './spec_helper'
+
+describe BoardState do
+  describe "an empty board" do
+    before do
+      @x = 5
+      @y = 5
+      @board = BoardState.new(@x, @y)
+    end
+    
+    it "must have dead population" do
+      @board.population[DEAD].must_equal @x * @y
+      @board.population.keys.length.must_equal 1
+    end
+
+    it "must still be dead after a tick" do
+      @board.tick.population[DEAD].must_equal @x*@y
+      @board.population.keys.length.must_equal 1
+    end
+
+    it "must accept a block" do
+      @board.populate 1,1
+      @board.populate 1,2
+      @board.populate 2,1
+      @board.populate 2,2
+
+      @board.population[DEAD].must_equal @x * @y - 4
+      @board.population[ALIVE].must_equal 4
+    end
+  end
+
+  describe "adding shapes" do
+    before do
+      @board = BoardState.new(40, 40)
+      Shapes.add(@board, SHAPE_STR)
+    end
+
+    it "must recognize \"#{SHAPE_STR}\"" do
+      Shapes.known.fetch(SHAPE).each { |xy_ary|
+        @board.value(*xy_ary).must_equal ALIVE
+      }
+      @board.population.fetch(ALIVE).must_equal POINTS_COUNT
+    end
+
+    it "must tick correctly" do
+      @board.tick
+      SHAPE_TICK_POINTS.each { |xy_ary|
+        @board.value(*xy_ary).must_equal ALIVE
+      }
+      @board.population.fetch(ALIVE).must_equal SHAPE_TICK_POINTS.length
+    end
+  end
+end

data/test/test_shapes.rb

@@ -0,0 +1,15 @@
+require_relative './spec_helper'
+
+describe Shapes do
+  it "must recognize #{SHAPE}" do
+    Shapes.known.fetch(SHAPE).must_be_instance_of Array
+  end
+
+  it "must confirm #{SHAPE} on the board" do
+    @board = BoardState.new(20, 20)
+    Shapes.add(@board, SHAPE_STR)
+    Shapes.known.fetch(SHAPE).each { |xy_ary|
+      @board.value(*xy_ary).must_equal ALIVE
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conway_deathmatch
 version: !ruby/object:Gem::Version
-  version: 0.3.2.3
+  version: 0.3.2.5
 platform: ruby
 authors:
 - Rick Hull
@@ -45,11 +45,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
+- VERSION
 - bin/conway_deathmatch
+- conway_deathmatch.gemspec
 - lib/conway_deathmatch.rb
 - lib/conway_deathmatch/board_state.rb
 - lib/conway_deathmatch/data/shapes.yaml
 - lib/conway_deathmatch/shapes.rb
+- test/bench_board_state.rb
+- test/spec_helper.rb
+- test/test_board_state.rb
+- test/test_shapes.rb
 homepage: https://github.com/rickhull/conway_deathmatch
 licenses:
 - GPL
@@ -60,7 +68,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement