rich_engine 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37c9f68ab1fdc4951d70810a301758262203c270d81855259c04920194f44e21
+  data.tar.gz: f2848e8b2cfb1e99437aa99d4622f16e077b68e8866815192731b2f74160d9d2
+SHA512:
+  metadata.gz: '01282dcff859e81e0cd7ac4ad4b266e450d317826e521f63603481d2c51a62ea4227582297db1abe26e1bfd05c8172e11f94706656a05e25552eb26009b4dad0'
+  data.tar.gz: 929a78668eff88fce37a81e2df06d310dd305b54000175423e0f032195c074cc1d64372cefde49ab3a8e79090d5c41ab6e84408d8c446ba789ce4ad213e7b70f

data/.github/workflows/tests-and-linter.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake
+      - name: Linter
+        run: bundle exec standardrb

data/.gitignore

@@ -0,0 +1 @@
+coverage/

data/.standard.yml

@@ -0,0 +1 @@
+format: progress

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "standardrb"
+  gem "solargraph"
+end
+
+group :test do
+  gem "guard"
+  gem "guard-minitest", require: false
+  gem "minitest"
+  gem "minitest-focus"
+  gem "minitest-reporters"
+  gem "rake"
+  gem "simplecov", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,196 @@
+PATH
+  remote: .
+  specs:
+    rich_engine (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.3)
+    backport (1.2.0)
+    benchmark (0.4.1)
+    builder (3.3.0)
+    coderay (1.1.3)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    formatador (1.1.0)
+    guard (2.19.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      logger (~> 1.6)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      ostruct (~> 0.6)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    jaro_winkler (1.6.1)
+    json (2.12.2)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    lumberjack (1.2.10)
+    method_source (1.1.0)
+    minitest (5.25.5)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.7.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    nenv (0.3.0)
+    nokogiri (1.18.8-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-musl)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    observer (0.1.2)
+    ostruct (0.6.1)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.9.4)
+      logger
+    regexp_parser (2.10.0)
+    reverse_markdown (3.0.0)
+      nokogiri
+    rexml (3.4.1)
+    rubocop (1.75.8)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    solargraph (0.54.5)
+      backport (~> 1.2)
+      benchmark (~> 0.4)
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      jaro_winkler (~> 1.6, >= 1.6.1)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      logger (~> 1.6)
+      observer (~> 0.1)
+      ostruct (~> 0.6)
+      parser (~> 3.0)
+      rbs (~> 3.3)
+      reverse_markdown (~> 3.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+      yard-solargraph (~> 0.1)
+    standard (1.50.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.75.5)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.8.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.25.0)
+    standardrb (1.0.1)
+      standard
+    thor (1.3.2)
+    tilt (2.6.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yard (0.9.37)
+    yard-solargraph (0.1.0)
+      yard (~> 0.9)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  guard
+  guard-minitest
+  minitest
+  minitest-focus
+  minitest-reporters
+  rake
+  rich_engine!
+  simplecov
+  solargraph
+  standardrb
+
+BUNDLED WITH
+   2.6.8

data/Guardfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)/?(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$}) { "test" }
+end
+
+notification :off

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matheus Richard
+
+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,40 @@
+# RichEngine
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rich_engine`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rich_engine'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rich_engine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rich_engine.
+
+
+## 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,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+task :guard do
+  system "bundle exec guard"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rich_engine'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/background.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "rich_engine"
+
+class BgExample < RichEngine::Game
+  using RichEngine::StringColors
+
+  def on_create
+    @timer = RichEngine::Timer.new
+    @canvas.bg = RichEngine::UI::Textures.solid.blue
+    @clouds = 5.times.map { |i| Cloud.new(x: -(i + 1) * 20) }
+    @sun = Sun.new
+  end
+
+  def on_update(elapsed_time, key)
+    quit! if key == :q
+
+    @timer.update(elapsed_time)
+    @clouds.each { |cloud|
+      cloud.update(elapsed_time)
+
+      if cloud.x > @config[:screen_width]
+        @clouds.delete(cloud)
+        @clouds << Cloud.new
+      end
+    }
+
+    @canvas.clear
+
+    @sun.draw(@canvas)
+    @clouds.each { _1.draw(@canvas) }
+
+    draw_ground
+  end
+
+  def draw_ground
+    @canvas.draw_rect(
+      x: 0,
+      y: @config[:screen_height] - 1,
+      width: @config[:screen_width],
+      height: 1,
+      color: :black
+    )
+  end
+end
+
+class Sun
+  attr_accessor :x, :y
+
+  def initialize
+    @x = 0
+    @y = 0
+  end
+
+  def update(elapsed_time)
+  end
+
+  def draw(canvas)
+    canvas.draw_sprite(sprite, x: @x, y: @y, fg: :yellow)
+  end
+
+  def sprite
+    <<~SUN
+      ████
+      ████
+    SUN
+  end
+end
+
+class Cloud
+  attr_accessor :x, :y
+
+  def initialize(x: -rand(5..300))
+    @x = x
+    @y = rand(0..4)
+    @color = [:white, :bright_white].sample
+    @sprite = cloud_sprites.sample
+    @speed = rand(1..10)
+  end
+
+  def update(elapsed_time)
+    @x += elapsed_time * @speed
+  end
+
+  def draw(canvas)
+    canvas.draw_sprite(
+      @sprite,
+      x: @x,
+      y: @y,
+      fg: @color
+    )
+  end
+
+  def cloud_sprites
+    [
+      shape1,
+      shape2,
+      shape3,
+      shape4,
+      shape5
+    ]
+  end
+
+  def shape1
+    <<~CLOUD
+        ██
+      ██████
+    CLOUD
+  end
+
+  def shape2
+    <<~CLOUD
+       ███ ████
+      ██████████
+    CLOUD
+  end
+
+  def shape3
+    <<~CLOUD
+       ███
+      █████
+    CLOUD
+  end
+
+  def shape4
+    <<~CLOUD
+      ███
+    CLOUD
+  end
+
+  def shape5
+    <<~CLOUD
+      █████
+    CLOUD
+  end
+end
+
+BgExample.play

data/examples/grains_of_sand.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "rich_engine"
+
+class GrainsOfSandExample < RichEngine::Game
+  using RichEngine::StringColors
+
+  def on_create
+    @canvas.bg = RichEngine::UI::Textures.solid.fg(:yellow)
+    @world = World.new(
+      grains_of_sand: [
+        GrainOfSand.new(x: @config[:screen_width] / 2 - rand(-10..10), y: -1),
+        GrainOfSand.new(x: @config[:screen_width] / 2, y: -@config[:screen_height] / 2)
+      ],
+      game_config: @config
+    )
+  end
+
+  def on_update(elapsed_time, key)
+    quit! if key == :q
+
+    @world.update(elapsed_time, key)
+
+    @canvas.clear
+
+    @world.draw(@canvas)
+  end
+end
+
+class World
+  def initialize(grains_of_sand:, game_config:)
+    @grains_of_sand = grains_of_sand
+    @game_config = game_config
+    @tiles = RichEngine::Matrix.new(width: width, height: height, fill_with: :empty)
+    @drop_timer = RichEngine::Timer.every(seconds: 0.05)
+  end
+
+  def update(elapsed_time, _key)
+    @drop_timer.update(elapsed_time)
+    @drop_timer.when_ready do
+      results = @grains_of_sand.map { |grain_of_sand|
+        next :not_moved if locked?(grain_of_sand)
+
+        if fits?(*grain_of_sand.try_move(:down).position)
+          grain_of_sand.move_down
+          :moved
+        elsif fits?(*grain_of_sand.try_move(:down).try_move(:left).position)
+          grain_of_sand.move_down.move_left
+          :moved
+        elsif fits?(*grain_of_sand.try_move(:down).try_move(:right).position)
+          grain_of_sand.move_down.move_right
+          :moved
+        else
+          lock_drop(grain_of_sand)
+          :not_moved
+        end
+      }
+
+      if results.none?(:moved)
+        raise RichEngine::Game::Exit
+      elsif has_available_space?
+        @grains_of_sand << GrainOfSand.new(x: (@game_config[:screen_width] / 2) + rand(-20..20), y: 0)
+      end
+    end
+  end
+
+  def draw(canvas)
+    @grains_of_sand.each { _1.draw(canvas) }
+  end
+
+  private
+
+  def locked?(grain_of_sand)
+    @tiles[grain_of_sand.x, grain_of_sand.y] == :filled
+  end
+
+  def fits?(x, y)
+    x >= 0 && x < width && y < height && @tiles[x, y] != :filled
+  end
+
+  def lock_drop(grain_of_sand)
+    @tiles[grain_of_sand.x, grain_of_sand.y] = :filled
+  end
+
+  def has_available_space?
+    @tiles.any? { |tile| tile == :empty }
+  end
+
+  def width
+    @game_config[:screen_width]
+  end
+
+  def height
+    @game_config[:screen_height]
+  end
+end
+
+class GrainOfSand
+  using RichEngine::StringColors
+
+  attr_reader :x, :y
+
+  def initialize(x:, y:)
+    @x = x
+    @y = y
+  end
+
+  def try_move(move)
+    copy = dup
+
+    if move == :down
+      copy.move_down
+    elsif move == :left
+      copy.move_left
+    elsif move == :right
+      copy.move_right
+    else
+      raise "Unknown move: #{move}"
+    end
+  end
+
+  def position
+    [@x, @y]
+  end
+
+  def move_down
+    @y += 1
+
+    self
+  end
+
+  def move_left
+    @x -= 1
+
+    self
+  end
+
+  def move_right
+    @x += 1
+
+    self
+  end
+
+  def draw(canvas)
+    canvas.write_string("•", x: @x, y: @y, fg: :black, bg: :yellow)
+  end
+end
+
+GrainsOfSandExample.play(width: 60, height: 20)

data/examples/noise.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rich_engine"
+
+class NoiseExample < RichEngine::Game
+  def on_create
+    @end_timer = RichEngine::Timer.new
+    @change_timer = RichEngine::Timer.every(seconds: 0.1)
+  end
+
+  def on_update(elapsed_time, key)
+    quit! if key == :q
+
+    @end_timer.update(elapsed_time)
+    @change_timer.update(elapsed_time)
+
+    @change_timer.when_ready do
+      @canvas.clear
+      @canvas.each_coord do |x, y|
+        @canvas[x, y] = RichEngine::Chance.of_one_in(2) ? "█" : " "
+      end
+      @canvas.write_string(elapsed_time, x: 1, y: 1)
+    end
+
+    quit! if @end_timer.get > 10
+  end
+end
+
+NoiseExample.play(width: 80, height: 40)