doomfire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ed1e44013700ebc893171002841b1f5802e5a121d2a6d4d579bf20cacafc27c
+  data.tar.gz: 837787f8b5e1181da8e48768578f6fc10bb4c19e326c9578adc6046df8e8eec8
+SHA512:
+  metadata.gz: 12ac8016527d22683f5d508f038bf6e73eab2b25965500f245ccfff200279cd87ec38ced3058ca1b268876fbae9f6b59ef69f8c4a426fc3997b158b29118aa63
+  data.tar.gz: 609370538cc94a64411f39921b615d624cd22e4fe267a74d2229c8040dc8a409effb374a26b1b4eb3adfe5aab9f9aa4edf221f0b30376aa0b6e1d4476a5361cc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    doomfire (0.1.0)
+      paint
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    paint (2.1.0)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  doomfire!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Marcin Ruszkiewicz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Doomfire
+
+Put your terminal on fire.
+
+![terminal example](examples/terminal.png)
+
+This gem implements the [Doom fire algorithm](https://fabiensanglard.net/doom_fire_psx/) in Ruby, because why not, and outputs it into the terminal. Right now it requires the terminal to be able to display 24-bit colors, so it will either not work at all or not work properly on terminals that can't do that, for example on MacOS's default `Terminal.app` - in which case you should probably install a better terminal application (like [iTerm](https://www.iterm2.com) or whatever else you like).
+
+You can check the list of terminals supporting 24-bit color [here](https://github.com/termstandard/colors).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doomfire'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doomfire
+
+## Usage
+
+The most basic way to run this is to run it directly from the command line:
+
+    $ doomfire
+
+Pressing `CTRL`-`C` will stop the program gracefully after a few extra frames to let it end nicely.
+
+Alternatively you can use it for amusement while running some long rake tasks.
+
+```ruby
+require 'doomfire'
+
+desc 'some long running task'
+task :long do
+  fire = Doomfire::Terminal.new
+  fire.run
+
+  5.times do
+    sleep 1
+  end
+
+  fire.stop
+end
+```
+
+This will run the fire in a separate thread while your rake tasks works in the main thread, and at the end of the task it will gracefully extinguish the fire and clear the terminal.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcinruszkiewicz/doomfire.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+import 'examples/long.rake'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/doomfire.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doomfire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'doomfire'
+  spec.version       = Doomfire::VERSION
+  spec.authors       = ['Marcin Ruszkiewicz']
+  spec.email         = ['marcin.ruszkiewicz@polcode.net']
+
+  spec.summary       = 'Fire. In your console.'
+  spec.description   = 'Puts your console on fire. Use a truecolor console for best effect.'
+  spec.homepage      = 'https://github.com/marcinruszkiewicz/doomfire'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'paint'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/examples/long.rake

@@ -0,0 +1,13 @@
+require 'doomfire'
+
+desc 'some long running task'
+task :long do
+  fire = Doomfire::Terminal.new
+  fire.run
+
+  5.times do
+    sleep 1
+  end
+
+  fire.stop
+end

data/exe/doomfire

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+require 'doomfire'
+
+Doomfire::Terminal.new(blocking: true).run

data/lib/doomfire/terminal.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+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
+
+    def run
+      @blocking ? fire_loop : @thread = Thread.start { fire_loop }
+    end
+
+    def stop
+      @exit_requested = true
+      @thread.join unless @blocking
+    end
+
+    private
+
+    def fire_loop
+      loop do
+        if @exit_requested
+          stop_fire if @counter.zero?
+          break if @counter == FIRE_HEIGHT
+
+          @counter += 1
+        end
+
+        update_pixels
+        clear
+        print_pixels
+      end
+
+      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))
+    end
+
+    def clear
+      sleep 0.05
+      puts "\e[34f\e[f"
+    end
+
+    def print_pixels
+      (0...FIRE_HEIGHT).each do |x|
+        (0...@fire_width).each do |y|
+          print Paint[' ', nil, RGB[@pixels[x * @fire_width + y]]]
+        end
+        puts
+      end
+    end
+
+    def clear_screen
+      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

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

data/lib/doomfire/window_size.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Doomfire
+  class WindowSize
+    def terminal_width
+      return 80 unless unix?
+
+      result = dynamic_width
+      result < 20 ? 80 : result
+    rescue StandardError
+      80
+    end
+
+    # rubocop:disable Lint/DuplicateMethods
+    begin
+      require 'io/console'
+
+      def dynamic_width
+        if IO.console
+          dynamic_width_via_io_object
+        else
+          dynamic_width_via_system_calls
+        end
+      end
+    rescue LoadError
+      def dynamic_width
+        dynamic_width_via_system_calls
+      end
+    end
+    # rubocop:enable Lint/DuplicateMethods
+
+    def dynamic_width_via_io_object
+      _rows, columns = IO.console.winsize
+      columns
+    end
+
+    def dynamic_width_via_system_calls
+      dynamic_width_stty.nonzero? || dynamic_width_tput
+    end
+
+    def dynamic_width_stty
+      `stty size 2>/dev/null`.split[1].to_i
+    end
+
+    def dynamic_width_tput
+      `tput cols 2>/dev/null`.to_i
+    end
+
+    def unix?
+      RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+    end
+  end
+end

data/lib/doomfire.rb

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: doomfire
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcin Ruszkiewicz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Puts your console on fire. Use a truecolor console for best effect.
+email:
+- marcin.ruszkiewicz@polcode.net
+executables:
+- doomfire
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- doomfire.gemspec
+- examples/long.rake
+- examples/terminal.png
+- exe/doomfire
+- lib/doomfire.rb
+- lib/doomfire/terminal.rb
+- lib/doomfire/version.rb
+- lib/doomfire/window_size.rb
+homepage: https://github.com/marcinruszkiewicz/doomfire
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Fire. In your console.
+test_files: []