nlife 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb3319cf910fe04786b885de262b96e56f69e56d
-  data.tar.gz: e4cc2675fc16bcfb6e5b33d7cd48f6acc33f99ac
+  metadata.gz: 9c6e3e08c39d85b040029e683f60d34729949db3
+  data.tar.gz: bd91c74cf8e82a5eee043f09fd978e88f4ac091f
 SHA512:
-  metadata.gz: 49f7c216349321a856e2f9900bc00d9959ea5458d22cd2ffab0e8bf9ec3c69f7eecfa071268bc274549e93e7a18bd697085d0e03c1f0cabc2e2de0acb64f37d5
-  data.tar.gz: 40705b57e94c5a6b14c1ba640b60a057d7d08ac995eddf97a2e16c32d93ddfa33861da2d7c03e18cf2fb9ccba0227178964dc84b9bda84e194a010ac18e74806
+  metadata.gz: 9dc92b0822b1364a375792da53deb4b51a9351aa7b945d1b4f1f96d30973ce62afb1b29ec8d6508134a49030431b5971ff2adbcd671534695d8426e3eb18f1b3
+  data.tar.gz: aaa56266f27f2cd2cfe44df5961fb8925291653c711fde9ea5a95cc417537bd561df3695446e77187eab0b07aba44e0c8bd679e6c542193ed2cdcc7f610dc8f7

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change log
+
+##0.1.0
+- tests added
+- helper rule_from_golly modified
+- game surround accessor added
+
+## 0.0.1
+- first working version
+- pause/play/seed/quit functionality
+
+## 0.0.0
+- empty gem

data/TODO.md

@@ -1,14 +1,15 @@
 TODO
 ====
 
-### Tests
-- add rspec tests
-
 ### Game features
 - resizing grid
 - load/save file
 - set cell state
 - yank/paste/clear region
+- set speed
+- status line showing:
+  - iteration
+  - speed
 
 ### Render features
 - make render a separate class

data/bin/nlife

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require_relative "../lib/nlife"
+require_relative '../lib/nlife'
 
 NLife::UI.new.start

data/lib/nlife.rb

@@ -1 +1,4 @@
-require_relative "nlife/ui"
+require_relative 'nlife/game'
+require_relative 'nlife/helper'
+require_relative 'nlife/ui'
+require_relative 'nlife/version'

data/lib/nlife/game.rb

@@ -1,30 +1,31 @@
-require "narray"
-require "numru/fftw3"
+require 'narray'
+require 'numru/fftw3'
 include NumRu
 
-require_relative "./helper.rb"
+require_relative 'helper.rb'
 
 module NLife
+  # encapsulates game logic
   class Game
     attr_reader :state
-    attr_accessor :density
+    attr_reader :density
 
     def initialize(rows, cols, surround = nil, rule = nil)
-      @state = NArray.int(cols, rows)
-      @density = NArray.int(cols, rows)
+      @state = NArray.float(cols, rows)
+      @density = NArray.float(cols, rows)
       surround ||= default_surround(rows, cols)
-      @t_surround = FFTW3.fft(surround.to_f, -1) / surround.size
+      @fft_surround = FFTW3.fft(surround.to_f, -1) / surround.size
       @rule = rule || default_rule
     end
 
     def default_surround(rows, cols)
-      return Helper.surround_from_block(rows, cols) do |row, col|
-        [row.abs, col.abs].max == 1
+      Helper.surround_from_block(rows, cols) do |row, col|
+        [row.abs, col.abs].max == 1 ? 1 : 0
       end
     end
 
     def default_rule
-      return Helper.rule_from_golly("B3/S23")
+      Helper.rule_from_golly('B3/S23')
     end
 
     def seed
@@ -35,14 +36,16 @@ module NLife
       end
     end
 
-    def step
-      calc_density
-      calc_next_state
+    def step(count = 1)
+      count.times do
+        calc_density
+        calc_next_state
+      end
     end
 
     def calc_density
       t_state = FFTW3.fft(@state, -1)
-      t_density = t_state * @t_surround
+      t_density = t_state * @fft_surround
       @density = FFTW3.fft(t_density, 1).real.round
     end
 
@@ -56,11 +59,20 @@ module NLife
 
     # use for debug only
     def print
-      puts "#" * (@state.shape[0] + 2)
+      puts '#' * (@state.shape[0] + 2)
       @state.shape[1].times do |i|
-        puts "#" + @state[true, i].each.map { |e| e > 0 ? "*" : " " }.join + "#"
+        print_row(i)
       end
-      puts "#" * (@state.shape[0] + 2)
+      puts '#' * (@state.shape[0] + 2)
+    end
+
+    # use for debug only
+    def print_row(row)
+      puts '#' + @state[true, row].each.map { |e| e > 0 ? '*' : ' ' }.join + '#'
+    end
+
+    def surround
+      FFTW3.fft(@fft_surround, 1).real
     end
 
     def rows
@@ -70,5 +82,5 @@ module NLife
     def cols
       @state.shape[0]
     end
-  end
-end
+  end # class Game
+end # module NLife

data/lib/nlife/helper.rb

@@ -1,34 +1,47 @@
-require "narray"
+require 'narray'
 
 module NLife
+  # miscellaneous functions for state/surround gereration
   module Helper
-    def self.surround_from_block(rows, cols)
-      result = NArray.int(cols, rows)
+    module_function
+
+    # surround is calculated for rectangle centered at (0, 0)
+    def surround_from_block(rows, cols)
+      result = NArray.float(cols, rows)
       result.shape[1].times do |row|
         result.shape[0].times do |col|
           result[col, row] = yield((row + rows / 2) % rows - rows / 2,
-                                   (col + cols / 2) % cols - cols / 2) ? 1 : 0
+                                   (col + cols / 2) % cols - cols / 2)
         end
       end
       result
     end
 
-    # constructs rules from two arrays, birth/survival densities
-    def self.rule_from_arrays(birth, survival)
+    # constructs rules from two arrays: birth, survival densities
+    def rule_from_arrays(birth, survival)
+      unless birth.size == survival.size
+        fail ArgumentError 'params sizes not match'
+      end
+      max_density = birth.size
       proc do |state, density|
-        birth[density.round] || state > 0 && survival[density.round] ? 1 : 0
+        fail ArgumentError 'density too high' if density > max_density
+        result = (state == 0 ? birth : survival)[density.round]
+        result ? 1.0 : 0.0
       end
     end
 
-    # constructs rules from string, describing birth/survival densities
-    def self.rule_from_golly(string)
-      match = /^B([0-8]*)\/S([0-8]*)$/.match(string)
-      Raise ArgumentError "Wrong input format" unless match
-      birth = Array.new(9, false)
+    def golly_to_array(string)
+      match = %r{^B([0-8]*)\/S([0-8]*)$}.match(string)
+      raise ArgumentError 'wrong input format' unless match
+      birth = (0..8).map { |i| match[1].include? i.to_s }
       survival = Array.new(9, false)
-      match[1].split(//).map(&:to_i).each { |i| birth[i] = true }
       match[2].split(//).map(&:to_i).each { |i| survival[i] = true }
-      return rule_from_arrays(birth, survival)
+      return birth, survival
+    end
+
+    # constructs rules from string, describing birth/survival densities
+    def rule_from_golly(string)
+      rule_from_arrays(*golly_to_array(string))
     end
   end
 end

data/lib/nlife/ui.rb

@@ -1,10 +1,10 @@
 require 'curses'
 
-require_relative "./game.rb"
+require_relative 'game.rb'
 
 module NLife
   class UI
-    RENDER_DEAD = " "
+    RENDER_DEAD = ' '
     RENDER_LIVE = "\u2588"
 
     def initialize
@@ -20,7 +20,7 @@ module NLife
       @window_lines = Curses.lines
       @window_cols = Curses.cols
       @window = Curses::Window.new(@window_lines, @window_cols, 0, 0)
-      @window.box("|", "-")
+      @window.box('|', '-')
       @window.timeout = 0
     end
 
@@ -45,22 +45,20 @@ module NLife
 
     def dispatch_key(key)
       case key
-      when "p" then @pause = !@pause
-      when "s" then @life.seed
-      when "q" then return false
+      when 'p' then @pause = !@pause
+      when 's' then @life.seed
+      when 'q' then return false
       end
-      return true
+      true
     end
 
     def step
-      unless @pause
-        @life.step
-      end
+      @life.step unless @pause
     end
 
     def render
       @life.rows.times do |i|
-        string = ""
+        string = ''
         @life.cols.times do |j|
           string += @life.state[j, i] > 0 ? RENDER_LIVE : RENDER_DEAD
         end

data/lib/nlife/version.rb

@@ -1,3 +1,3 @@
 module NLife
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/nlife.gemspec

@@ -4,17 +4,19 @@ Gem::Specification.new do |s|
   s.name        = 'nlife'
   s.version     = NLife::VERSION
   s.licenses    = ['LGPL-3.0']
-  s.authors     = ["Oleg Zubchenko"]
+  s.authors     = ['Oleg Zubchenko']
   s.email       = 'RedGreenBlueDiamond@gmail.com'
-  s.homepage    = 'http://rubygems.org/gems/nlife'
-  s.summary     = "Generalized Game of Life"
-  s.description = "Customizable Game of Life with ncurses viewer"
-  s.files       = Dir["lib/**/*.rb"] + Dir["bin/*"] + Dir["*.md"] + 
-                  Dir["*.gemspec"]
+  s.homepage    = 'https://github.com/rgbd/ruby-nlife'
+  s.summary     = 'Generalized Game of Life'
+  s.description = 'Game of Life with customizable rules on ncurses viewer'
+  s.files       = Dir['**/*.rb'] + Dir['bin/*'] + Dir['*.md'] +
+    Dir['*.gemspec']
   s.executables << 'nlife'
 
   s.add_runtime_dependency 'curses', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'narray', '~>0.6.1'
-  s.add_runtime_dependency 'numru-misc', '~>0.1.2'
-  s.add_runtime_dependency 'ruby-fftw3', '~>0.4.2'
+  s.add_runtime_dependency 'narray', '~> 0.6.1', '>= 0.6.1.1'
+  s.add_runtime_dependency 'numru-misc', '~> 0.1.2'
+  s.add_runtime_dependency 'ruby-fftw3', '~> 0.4.2'
+
+  s.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
 end

data/spec/nlife/game_spec.rb

@@ -0,0 +1,93 @@
+require 'narray'
+
+describe NLife::Game do
+  before do
+    @rows = 8
+    @cols = 8
+    @game = described_class.new(@rows, @cols)
+  end
+
+  context 'classic defauts' do
+    before do
+      # classic surround
+      @surround = NArray.int(@rows, @cols)
+      @surround[(-1..1).to_a, (-1..1).to_a] = 1
+      @surround[0, 0] = 0
+      @rule_length = 8
+      # ruler------012345678
+      @birth    = '...X.....'.split(//).map { |e| e == 'X' }
+      @survival = '..XX.....'.split(//).map { |e| e == 'X' }
+      @rule = proc do |s, d|
+        result = s == 0 ? @birth[d] : @survival[d]
+        result ? 1 : 0
+      end
+    end
+
+    it 'should have classic default surround' do
+      expect(@game.surround.round).to eq(@surround)
+    end
+
+    it 'should have classic default rules' do
+      game_rule = @game.instance_variable_get(:@rule)
+      [0, 1].each do |s|
+        0.upto(8) do |d|
+          expect(@rule.call(s, d)).to eq(game_rule.call(s, d))
+        end
+      end
+    end
+  end # context 'classic defauts'
+
+  context 'stepping' do
+    before do
+      # glider
+      @state = NArray.to_na([
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 1, 0, 0, 0, 0],
+        [0, 0, 0, 0, 1, 0, 0, 0],
+        [0, 0, 1, 1, 1, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0]
+      ]).to_f
+      @density = NArray.to_na([
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 1, 1, 1, 0, 0, 0],
+        [0, 0, 1, 1, 2, 1, 0, 0],
+        [0, 1, 3, 5, 3, 2, 0, 0],
+        [0, 1, 1, 3, 2, 2, 0, 0],
+        [0, 1, 2, 3, 2, 1, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0]
+      ]).to_f
+      @next_state = NArray.to_na([
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 1, 0, 1, 0, 0, 0],
+        [0, 0, 0, 1, 1, 0, 0, 0],
+        [0, 0, 0, 1, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 0, 0, 0]
+      ]).to_f
+      @game.instance_variable_set(:@state, @state)
+      @game.instance_variable_set(:@density, NArray.float(@rows, @cols))
+    end # before
+
+    it '.calc_density' do
+      @game.send(:calc_density)
+      expect(@game.instance_variable_get(:@density)).to eq(@density)
+    end
+
+    it '.calc_nest_state' do
+      @game.instance_variable_set(:@density, @density)
+      @game.send(:calc_next_state)
+      expect(@game.instance_variable_get(:@state)).to eq(@next_state)
+    end
+
+    it '.step' do
+      @game.step
+      expect(@game.instance_variable_get(:@state)).to eq(@next_state)
+    end
+  end # context 'stepping'
+end # describe NLife::Game

data/spec/nlife/helper_spec.rb

@@ -0,0 +1,51 @@
+require 'narray'
+
+describe NLife::Helper do
+  before do
+    @rows = 8
+    @cols = 8
+  end
+
+  context 'surround generation' do
+    before do
+      # classic surround
+      @surround = NArray.int(@rows, @cols)
+      @surround[(-1..1).to_a, (-1..1).to_a] = 1
+      @surround[0, 0] = 0
+    end
+
+    it '.surround_from_block' do
+      shape = @surround.shape.reverse
+      got_surround = described_class.surround_from_block(*shape) do |row, col|
+        [row, col].map(&:abs).max == 1 ? 1 : 0
+      end
+      expect(got_surround).to eq(@surround)
+    end
+  end
+
+  context 'rule generation' do
+    before do
+      @rule_length = 8
+      # ruler------012345678
+      @birth    = '...X..X..'.split(//).map { |e| e == 'X' }
+      @survival = '..XX.....'.split(//).map { |e| e == 'X' }
+      @golly = 'B36/S23'
+    end
+
+    it '.golly_to_array' do
+      expect(described_class.golly_to_array(@golly)).to eq([@birth, @survival])
+    end
+
+    it '.rule_from_arrays' do
+      rule = described_class.rule_from_arrays(@birth, @survival)
+      0.upto(@rule_length) do |i|
+        expect(rule.call(0, i) > 0).to eq(@birth[i])
+        expect(rule.call(1, i) > 0).to eq(@survival[i])
+      end
+    end
+
+    it '.rule_from_golly' do
+      expect(described_class).to respond_to(:rule_from_golly)
+    end
+  end
+end

data/spec/nlife/version_spec.rb

@@ -0,0 +1,3 @@
+describe NLife do
+  it { should be_const_defined(:VERSION) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/nlife.rb'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nlife
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Oleg Zubchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -37,6 +37,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +47,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1.1
 - !ruby/object:Gem::Dependency
   name: numru-misc
   requirement: !ruby/object:Gem::Requirement
@@ -72,13 +78,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
-description: Customizable Game of Life with ncurses viewer
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Game of Life with customizable rules on ncurses viewer
 email: RedGreenBlueDiamond@gmail.com
 executables:
 - nlife
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - TODO.md
 - bin/nlife
@@ -88,7 +115,12 @@ files:
 - lib/nlife/ui.rb
 - lib/nlife/version.rb
 - nlife.gemspec
-homepage: http://rubygems.org/gems/nlife
+- spec/nlife/game_spec.rb
+- spec/nlife/helper_spec.rb
+- spec/nlife/ui_spec.rb
+- spec/nlife/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rgbd/ruby-nlife
 licenses:
 - LGPL-3.0
 metadata: {}