doomfire 0.1.0 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ed1e44013700ebc893171002841b1f5802e5a121d2a6d4d579bf20cacafc27c
-  data.tar.gz: 837787f8b5e1181da8e48768578f6fc10bb4c19e326c9578adc6046df8e8eec8
+  metadata.gz: ecbc683e034fa23927451cf7792b1b234ad41d45681a1eb59d05759f44b65304
+  data.tar.gz: 7823ae5ad2eb86a5d090bd914193ae7c56c9b92b19b411457e6c3600884fd2fd
 SHA512:
-  metadata.gz: 12ac8016527d22683f5d508f038bf6e73eab2b25965500f245ccfff200279cd87ec38ced3058ca1b268876fbae9f6b59ef69f8c4a426fc3997b158b29118aa63
-  data.tar.gz: 609370538cc94a64411f39921b615d624cd22e4fe267a74d2229c8040dc8a409effb374a26b1b4eb3adfe5aab9f9aa4edf221f0b30376aa0b6e1d4476a5361cc
+  metadata.gz: 41592477937ec6d1fc954646117f9044c76714701eaa5a6784d509b6d70a12386afd84a25cc64db3840c4fd11dac6db82ec40c8637b8f01c67760e45b8a57eed
+  data.tar.gz: 59087d4f46cb35fb1146a33f42cd43638d08c690a7cc2dd45456aa364c97d1fe5c8d77bdc3b0041a44b2ed3252b78452d98d7aa30f9c10553b9d5eeb794866ef

data/.travis.yml

@@ -3,5 +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

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 0.2.0
+
+Terminal class now only works in the terminal and the new Spinner class should be used in the rake tasks. That should actually be a major version update to be honest but in 0.x versions I assume it's expected things can break.
+
+- [x] Split Terminal class into `Base`, `Terminal` and `Spinner` classes
+- [x] Started work on SDL version
+- [x] Updated readme and example
+- [x] Update tests
+
+# 0.1.0
+
+Works both in terminal as a command and in long running rake tasks as a spinner/progress bar indicator (not really).
+
+- [x] Initial gem version published

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doomfire (0.1.0)
+    doomfire (0.2)
       paint
 
 GEM

data/README.md

@@ -1,3 +1,6 @@
+[![Build Status](https://travis-ci.com/marcinruszkiewicz/doomfire.svg?branch=master)](https://travis-ci.com/marcinruszkiewicz/doomfire)
+[![Gem Version](https://badge.fury.io/rb/doomfire.svg)](https://badge.fury.io/rb/doomfire)
+
 # Doomfire
 
 Put your terminal on fire.
@@ -39,7 +42,7 @@ require 'doomfire'
 
 desc 'some long running task'
 task :long do
-  fire = Doomfire::Terminal.new
+  fire = Doomfire::Spinner.new
   fire.run
 
   5.times do

data/examples/long.rake

@@ -2,7 +2,7 @@ require 'doomfire'
 
 desc 'some long running task'
 task :long do
-  fire = Doomfire::Terminal.new
+  fire = Doomfire::Spinner.new
   fire.run
 
   5.times do

data/examples/sdl_test.rb

@@ -0,0 +1,57 @@
+require 'fiddle'
+require 'fiddle/import'
+require 'pry'
+
+module SDL
+  extend Fiddle::Importer
+
+  dlload 'libSDL2.dylib'
+
+  typealias 'Uint32', :int
+  typealias 'Uint16', :int
+  typealias 'Uint8', :int
+
+  SDL_INIT_VIDEO = 0x00000020
+  SDL_WINDOW_OPENGL = 0x00000000
+  SDL_WINDOWPOS_UNDEFINED = 0x1FFF0000 | 0
+  SDL_WINDOWPOS_CENTERED = 0x2FFF0000 | 0
+  SDL_QUIT = 0x100
+  SDL_KEYDOWN = 0x300
+  SDL_PIXELFORMAT_ARGB8888 = 0
+  SDL_TEXTUREACCESS_STATIC = 0
+
+  SDL_Event = union [
+    'Uint32 type'
+  ]
+
+  extern 'int SDL_Init(Uint32 flags)'
+  extern 'void* SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)'
+  extern 'void* SDL_CreateRenderer(void* window, int index, Uint32 flags)'
+  extern 'void* SDL_CreateTexture(void* renderer, Uint32 format, int access, int w, int h)'
+  extern 'int SDL_WaitEvent(void* event)'
+  extern 'void SDL_Quit(void)'
+  extern 'void SDL_DestroyWindow(void* window)'
+  extern 'void SDL_DestroyRenderer(void* renderer)'
+  extern 'void SDL_DestroyTexture(void* texture)'
+end
+
+# https://dzone.com/articles/sdl2-pixel-drawing
+# http://wiki.libsdl.org/SDL_Init
+# https://github.com/davidsiaw/SDL2/blob/master/include/SDL_stdinc.h
+# http://ruby-doc.org/stdlib-2.6.3/libdoc/fiddle/rdoc/Fiddle.html#method-c-dlopen
+# https://www.honeybadger.io/blog/use-any-c-library-from-ruby-via-fiddle-the-ruby-standard-librarys-best-kept-secret/
+# https://bitbucket.org/dandago/gigilabs/src/master/Sdl2PixelDrawing/Sdl2PixelDrawing/main.cpp
+
+SDL.SDL_Init(SDL::SDL_INIT_VIDEO)
+window = SDL.SDL_CreateWindow("Doomfire.rb", SDL::SDL_WINDOWPOS_UNDEFINED, SDL::SDL_WINDOWPOS_UNDEFINED, 640, 480, SDL::SDL_WINDOW_OPENGL)
+renderer = SDL.SDL_CreateRenderer(window, -1, 0)
+texture = SDL.SDL_CreateTexture(renderer, SDL::SDL_PIXELFORMAT_ARGB8888, SDL::SDL_TEXTUREACCESS_STATIC, 640, 480)
+
+event = SDL::SDL_Event.malloc
+quit = false
+
+until quit
+  SDL.SDL_WaitEvent(event)
+
+  quit = true if event.type == SDL::SDL_QUIT
+end

data/exe/doomfire

@@ -5,4 +5,4 @@ require 'rubygems'
 require 'bundler/setup'
 require 'doomfire'
 
-Doomfire::Terminal.new(blocking: true).run
+Doomfire::Terminal.new.run

data/lib/doomfire/base.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Doomfire
+  # Base class for the fire algorithm
+  class Base
+    RGB = [
+      [0, 0, 0],
+      [7, 7, 7],
+      [31, 7, 7],
+      [47, 15, 7],
+      [87, 23, 7],
+      [103, 31, 7],
+      [119, 31, 7],
+      [143, 39, 7],
+      [159, 47, 7],
+      [175, 63, 7],
+      [191, 71, 7],
+      [199, 71, 7],
+      [223, 79, 7],
+      [223, 87, 7],
+      [223, 87, 7],
+      [215, 103, 15],
+      [207, 111, 15],
+      [207, 119, 15],
+      [207, 127, 15],
+      [207, 135, 23],
+      [199, 135, 23],
+      [199, 143, 23],
+      [199, 151, 31],
+      [191, 159, 31],
+      [191, 159, 31],
+      [191, 167, 39],
+      [191, 167, 39],
+      [191, 175, 47],
+      [183, 175, 47],
+      [183, 183, 47],
+      [183, 183, 55],
+      [207, 207, 111],
+      [223, 223, 159],
+      [239, 239, 199],
+      [255, 255, 255]
+    ].freeze
+
+    FIRE_HEIGHT = 35
+
+    attr_reader :exit_requested, :pixels, :fire_width
+
+    def initialize
+      @counter = 0
+      @thread = nil
+      @exit_requested = false
+
+      prepare_output
+
+      initialize_pixels
+    end
+
+    def run
+      raise NotImplementedError
+    end
+
+    def stop
+      raise NotImplementedError
+    end
+
+    private
+
+    def spread_fire(src)
+      if @pixels[src].zero?
+        @pixels[src - @fire_width] = 1
+      else
+        random = rand(10).round & 3
+        dst = src - rand(3) + 1
+        @pixels[dst - @fire_width] = @pixels[src] - (random & 1)
+      end
+    end
+
+    def stop_fire
+      @pixels.pop(@fire_width)
+      @pixels.concat [].fill(0, 0, @fire_width)
+    end
+
+    def update_pixels
+      (1...FIRE_HEIGHT).to_a.reverse.each do |x|
+        (0...@fire_width).each do |y|
+          spread_fire(x * @fire_width + y)
+        end
+      end
+    end
+
+    def initialize_pixels
+      @pixels = []
+      last_line = @fire_width * (FIRE_HEIGHT - 1)
+      @pixels.fill(0, 0...last_line)
+      @pixels.fill(34, last_line..(last_line + @fire_width))
+    end
+
+    def prepare_output
+      @fire_width = 80
+    end
+
+    def fire_loop
+      raise NotImplementedError
+    end
+
+    def clear
+      raise NotImplementedError
+    end
+
+    def clear_screen
+      raise NotImplementedError
+    end
+
+    def print_pixels
+      raise NotImplementedError
+    end
+  end
+end

data/lib/doomfire/spinner.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Doomfire
+  # Same output as the Terminal class, but this runs in a separate thread,
+  # so the main process can continue with its work
+  class Spinner < Terminal
+    def run
+      @thread = Thread.start { fire_loop }
+    end
+
+    def stop
+      @exit_requested = true
+      @thread.join
+    end
+
+    private
+
+    def prepare_output
+      @fire_width = Doomfire::WindowSize.new.terminal_width
+      Paint.mode = 0xFFFFFF
+      clear_screen
+    end
+  end
+end

data/lib/doomfire/terminal.rb

@@ -3,68 +3,14 @@
 require 'paint'
 
 module Doomfire
-  class Terminal
-    RGB = [
-      [0, 0, 0],
-      [7, 7, 7],
-      [31, 7, 7],
-      [47, 15, 7],
-      [87, 23, 7],
-      [103, 31, 7],
-      [119, 31, 7],
-      [143, 39, 7],
-      [159, 47, 7],
-      [175, 63, 7],
-      [191, 71, 7],
-      [199, 71, 7],
-      [223, 79, 7],
-      [223, 87, 7],
-      [223, 87, 7],
-      [215, 103, 15],
-      [207, 111, 15],
-      [207, 119, 15],
-      [207, 127, 15],
-      [207, 135, 23],
-      [199, 135, 23],
-      [199, 143, 23],
-      [199, 151, 31],
-      [191, 159, 31],
-      [191, 159, 31],
-      [191, 167, 39],
-      [191, 167, 39],
-      [191, 175, 47],
-      [183, 175, 47],
-      [183, 183, 47],
-      [183, 183, 55],
-      [207, 207, 111],
-      [223, 223, 159],
-      [239, 239, 199],
-      [255, 255, 255]
-    ].freeze
-
-    FIRE_HEIGHT = 35
-
-    def initialize(blocking: false)
-      @fire_width = Doomfire::WindowSize.new.terminal_width
-      @exit_requested = false
-      @counter = 0
-      @blocking = blocking
-      @thread = nil
-
-      Paint.mode = 0xFFFFFF
-      clear_screen
-      initialize_pixels
-
-      Kernel.trap('INT') { @exit_requested = true } if @blocking
-    end
-
+  # This class outputs the pixels into the terminal, using ANSI color codes
+  class Terminal < Base
     def run
-      @blocking ? fire_loop : @thread = Thread.start { fire_loop }
+      fire_loop
     end
 
     def stop
       @exit_requested = true
-      @thread.join unless @blocking
     end
 
     private
@@ -86,19 +32,11 @@ module Doomfire
       clear_screen
     end
 
-    def update_pixels
-      (1...FIRE_HEIGHT).to_a.reverse.each do |x|
-        (0...@fire_width).each do |y|
-          spread_fire(x * @fire_width + y)
-        end
-      end
-    end
-
-    def initialize_pixels
-      @pixels = []
-      last_line = @fire_width * (FIRE_HEIGHT - 1)
-      @pixels.fill(0, 0...last_line)
-      @pixels.fill(34, last_line..(last_line + @fire_width))
+    def prepare_output
+      @fire_width = Doomfire::WindowSize.new.terminal_width
+      Paint.mode = 0xFFFFFF
+      Kernel.trap('INT') { @exit_requested = true }
+      clear_screen
     end
 
     def clear
@@ -119,20 +57,5 @@ module Doomfire
       puts "\e[2J"
       puts "\e[H"
     end
-
-    def spread_fire(src)
-      if @pixels[src].zero?
-        @pixels[src - @fire_width] = 1
-      else
-        random = rand(10).round & 3
-        dst = src - rand(3) + 1
-        @pixels[dst - @fire_width] = @pixels[src] - (random & 1)
-      end
-    end
-
-    def stop_fire
-      @pixels.pop(@fire_width)
-      @pixels.concat [].fill(0, 0, @fire_width)
-    end
   end
 end

data/lib/doomfire/version.rb

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

data/lib/doomfire.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'doomfire/base'
 require 'doomfire/terminal'
+require 'doomfire/spinner'
 require 'doomfire/version'
 require 'doomfire/window_size'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doomfire
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '0.2'
 platform: ruby
 authors:
 - Marcin Ruszkiewicz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -91,6 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -98,9 +99,12 @@ files:
 - Rakefile
 - doomfire.gemspec
 - examples/long.rake
+- examples/sdl_test.rb
 - examples/terminal.png
 - exe/doomfire
 - lib/doomfire.rb
+- lib/doomfire/base.rb
+- lib/doomfire/spinner.rb
 - lib/doomfire/terminal.rb
 - lib/doomfire/version.rb
 - lib/doomfire/window_size.rb