doomfire 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89b6b146226294362b53ab49479381e4fd58ebba7481ecfd1c8f2106ad8e1714
-  data.tar.gz: 9141d2f4f5ffcf4be8b4a3447db05a8b08158b916c9914184d3a48a4e26e4b21
+  metadata.gz: 50b120f19271148a98f1d664ae43dbbfe315d02f2068a3c141212b83c50a6c54
+  data.tar.gz: ca769631b3439bd67deacec8fb3b645b6331752f49bde68864a17533ef196d50
 SHA512:
-  metadata.gz: 45a8f024ba820a3aca42ae5a64e6bef4a2cb2388f17a2f7174da05d4aa56cda344dcbea2b802275569969e6110f53097d5a1d3b8fa82d1c41da405812cdcd623
-  data.tar.gz: 16362cf09982cc961aab53e7034c2f0060a0272539300db4a08f6583635a1030e26d9047cd723033dd13027ad869697bb3f98c675bae5b17eba7d3ff80afacdb
+  metadata.gz: '04094f13813531214de2cc074a92c493f75d4be9bb5832dd22a53254de981669eb3723eeb6fc27380aa95107d894707b50660d7e4ec0145af6cbc712b89263a7'
+  data.tar.gz: 1a757de3d7a851b9d5f21d04d1df96dcc9b28893ab423b206f5f12b726277479d8f478d4c9d4baa645ef50d141efa8ee0e6876fc4047776fa4553bd0594d2421

data/.travis.yml

@@ -3,8 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.5
-  - 2.6.2
-before_install: gem install bundler -v 2.0.1
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/Gemfile.lock

@@ -1,43 +1,45 @@
 PATH
   remote: .
   specs:
-    doomfire (0.3.1)
+    doomfire (0.3.2)
       paint
 
 GEM
   remote: https://rubygems.org/
   specs:
+    benchmark-ips (2.7.2)
     coderay (1.1.2)
     diff-lcs (1.3)
     method_source (0.9.2)
-    paint (2.1.0)
+    paint (2.1.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  benchmark-ips
+  bundler
   doomfire!
   pry
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake
+  rspec
 
 BUNDLED WITH
-   2.0.1
+   2.1.2

data/README.md

@@ -69,6 +69,15 @@ Then you can run the executable:
 
 And the output should be shown in a separate window. Closing the window will end the program after a few seconds of the ending animation.
 
+![SDL example](examples/sdl.png)
+
+If running on a Ruby interpreter on the JVM, you will need the `-XstartOnFirstThread` option.
+
+## Benchmarks
+
+    $ bundle exec bench/micro.rb
+    $ bundle exec bench/macro.rb
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/marcinruszkiewicz/doomfire.

data/bench/macro.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'doomfire'
+require 'doomfire/ffi_sdl'
+require 'doomfire/sdl'
+
+# Benchmark of the whole of Doomfire running in SDL mode. Prints FPS to
+# the screen every second. Manually observe the warmup curve before taking
+# a reading.
+
+puts 'Wait for FPS to stabilise before taking a reading...'
+
+class Bench < Doomfire::SDL
+
+  def print_pixels
+    super
+    record_frame
+  end
+
+  def record_frame
+    time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+    if @start.nil?
+      @start = time
+      @frames = 0
+    end
+
+    @frames += 1
+    elapsed = time - @start
+
+    if elapsed > 1
+      printf "%.2f fps\n", @frames / elapsed
+      @start = time
+      @frames = 0
+    end
+  end
+
+end
+
+Bench.new.run

data/bench/micro.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require 'fiddle'
+require 'fiddle/import'
+
+require 'doomfire'
+require 'doomfire/ffi_sdl'
+require 'doomfire/sdl'
+
+require 'benchmark/ips'
+
+class BaseBench < Doomfire::Base
+
+  public :spread_fire, :update_pixels
+
+  def prepare_output
+    @fire_width = 80
+    @fire_height = 35
+  end
+
+  def bench_spread_fire
+    spread_fire(14 * @fire_width + 16)
+  end
+
+end
+
+base_bench = BaseBench.new
+
+module LibM
+  extend Fiddle::Importer
+  dlload 'libSystem.B.dylib'
+  extern 'double floor(double)'
+end
+
+string = 'x' * 80 * 35
+
+class SDLBench < Doomfire::SDL
+
+  def initialize
+    super
+    @texdata = texdata
+  end
+
+  def prepare_output
+    @fire_width = 80
+    @fire_height = 35
+  end
+
+  def texdata
+    @pixels.map { |val| ARGB[val] }
+  end
+
+  def texptr
+    Fiddle::Pointer[@texdata.pack('L*')]
+  end
+
+end
+
+sdl_bench = SDLBench.new
+
+Benchmark.ips do |x|
+
+  x.iterations = 3
+
+  x.report('spread_fire') do
+    base_bench.bench_spread_fire
+  end
+
+  x.report('update_pixels') do
+    base_bench.update_pixels
+  end
+
+  x.report('call') do
+    LibM.floor(14.2)
+  end
+
+  x.report('pointer') do
+    Fiddle::Pointer[string]
+  end
+
+  x.report('texdata') do
+    sdl_bench.texdata
+  end
+  
+  x.report('texptr') do
+    sdl_bench.texptr
+  end
+
+end

data/doomfire.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'paint'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/doomfire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Doomfire
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doomfire
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Marcin Ruszkiewicz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-31 00:00:00.000000000 Z
+date: 2019-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -24,20 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -56,30 +70,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Puts your console on fire. Use a truecolor console for best effect.
 email:
 - marcin.ruszkiewicz@polcode.net
@@ -97,8 +111,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/macro.rb
+- bench/micro.rb
 - doomfire.gemspec
 - examples/long.rake
+- examples/sdl.png
 - examples/terminal.png
 - exe/doomfire
 - lib/doomfire.rb