glimmer-dsl-libui 0.2.21 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47a6ef9ebfc0564ae4489dc2981baad90d307aa8beaf0b109c8830370db4f02b
-  data.tar.gz: 3752be2f3972bc7ab9c054444ff99934d4e1e2cb47bb7724059e69b96d6793b0
+  metadata.gz: 9ed417f87bfb329535969efe60a61a444d59c7b0e2bdb68196ecf29642b9d628
+  data.tar.gz: b0cb2a08fe3ef7d666408bc2dbfa9f6a7ada5151257b55aca2cd11abda09253d
 SHA512:
-  metadata.gz: e20361b29c5ccbe1f7a9de7a4929c7384d3db8ca8deafe016ee35e1f239dd2152500018919586e4ad173bb67bfb746fc2a062db449817d33a745a8871b82d455
-  data.tar.gz: 98b75a7e30e0d05f79b7669e26d3f4afeeeaf19ed57e1acfb56a760c5eb052739f4f4d890840c47eb43b2b841e849f44dd727d0ba0bc06189cfea606cec38380
+  metadata.gz: 12e49121d599a00cdf5c3e6638081c8c3d2c6aea263428a1966ce221949d8602fe27c5a03f7506809e5ce877465c5b4b03b909909b8e8c2bba39e698b25f25da
+  data.tar.gz: c0e345c1c9e3d1348a6add04910ecd6a4b58934094d2b688253688e8aa860af00613a0c275aac6ace4a97e46f7341b66dc2eebeec511eaa6e36feb4bcfe8d19b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.2.22
+
+- examples/snake.rb implemented test-first
+
 ## 0.2.21
 
 - examples/tic_tac_toe.rb

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.2.21
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.2.22
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -218,9 +218,10 @@ NOTE: [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) is fe
 Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interested in:
 - [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (JRuby Desktop Development GUI Framework)
 - [glimmer-dsl-opal](https://github.com/AndyObtiva/glimmer-dsl-opal): Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps)
+- [glimmer-dsl-tk](https://github.com/AndyObtiva/glimmer-dsl-tk): Glimmer DSL for Tk (MRI Ruby Desktop Development GUI Library)
+- [glimmer-dsl-gtk](https://github.com/AndyObtiva/glimmer-dsl-gtk): Ruby-GNOME Desktop Development GUI Library
 - [glimmer-dsl-xml](https://github.com/AndyObtiva/glimmer-dsl-xml): Glimmer DSL for XML (& HTML)
 - [glimmer-dsl-css](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS
-- [glimmer-dsl-tk](https://github.com/AndyObtiva/glimmer-dsl-tk): Glimmer DSL for Tk (MRI Ruby Desktop Development GUI Library)
 
 ## Table of Contents
 
@@ -279,6 +280,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Method-Based Custom Keyword](#method-based-custom-keyword)
     - [Tetris](#tetris)
     - [Tic Tac Toe](#tic-tac-toe)
+    - [Snake](#snake)
   - [Applications](#applications)
     - [Manga2PDF](#manga2pdf)
     - [Befunge98 GUI](#befunge98-gui)
@@ -371,7 +373,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.2.21'
+gem 'glimmer-dsl-libui', '~> 0.2.22'
 ```
 
 Add `require 'glimmer-dsl-libui'` at the top, and then `include Glimmer` into the top-level main object for testing or into an actual class for serious usage.
@@ -1221,7 +1223,7 @@ class MetaExample
   
   def run_example(example)
     Thread.new do
-      command = "ruby -r #{glimmer_dsl_libui_file} #{example} 2>&1"
+      command = "#{RbConfig.ruby} -r #{glimmer_dsl_libui_file} #{example} 2>&1"
       result = ''
       IO.popen(command) do |f|
         sleep(0.0001) # yield to main thread
@@ -6765,6 +6767,125 @@ end
 TicTacToe.new.launch
 ```
 
+### Snake
+
+Snake provides an example of building a desktop application [test-first](/spec/examples/snake/model/game_spec.rb) following the MVP ([Model](/examples/snake/model/game.rb) / [View](/examples/snake.rb) / [Presenter](/examples/snake/presenter/grid.rb)) architectural pattern.
+
+[examples/snake.rb](examples/snake.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/snake.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/snake'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-snake.png](images/glimmer-dsl-libui-mac-snake.png)
+
+![glimmer-dsl-libui-mac-snake-game-over.png](images/glimmer-dsl-libui-mac-snake-game-over.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+require 'glimmer/data_binding/observer'
+
+require_relative 'snake/presenter/grid'
+
+class Snake
+  CELL_SIZE = 15
+  SNAKE_MOVE_DELAY = 0.1
+  include Glimmer
+  
+  def initialize
+    @game = Model::Game.new
+    @grid = Presenter::Grid.new(@game)
+    @game.start
+    create_gui
+    register_observers
+  end
+  
+  def launch
+    @main_window.show
+  end
+  
+  def register_observers
+    @game.height.times do |row|
+      @game.width.times do |column|
+        Glimmer::DataBinding::Observer.proc do |new_color|
+          @cell_grid[row][column].fill = new_color
+        end.observe(@grid.cells[row][column], :color)
+      end
+    end
+    
+    Glimmer::DataBinding::Observer.proc do |game_over|
+      Glimmer::LibUI.queue_main do
+        if game_over
+          msg_box('Game Over!', "Score: #{@game.score}")
+          @game.start
+        end
+      end
+    end.observe(@game, :over)
+    
+    Glimmer::LibUI.timer(SNAKE_MOVE_DELAY) do
+      unless @game.over?
+        @game.snake.move
+        @main_window.title = "Glimmer Snake (Score: #{@game.score})"
+      end
+    end
+  end
+  
+  def create_gui
+    @cell_grid = []
+    @main_window = window('Glimmer Snake', @game.width * CELL_SIZE, @game.height * CELL_SIZE) {
+      resizable false
+      
+      vertical_box {
+        padded false
+        
+        @game.height.times do |row|
+          @cell_grid << []
+          horizontal_box {
+            padded false
+            
+            @game.width.times do |column|
+              area {
+                @cell_grid.last << path {
+                  square(0, 0, CELL_SIZE)
+                  
+                  fill Presenter::Cell::COLOR_CLEAR
+                }
+                
+                on_key_up do |area_key_event|
+                  orientation_and_key = [@game.snake.head.orientation, area_key_event[:ext_key]]
+                  case orientation_and_key
+                  in [:north, :right] | [:east, :down] | [:south, :left] | [:west, :up]
+                    @game.snake.turn_right
+                  in [:north, :left] | [:west, :down] | [:south, :right] | [:east, :up]
+                    @game.snake.turn_left
+                  else
+                    # No Op
+                  end
+                end
+              }
+            end
+          }
+        end
+      }
+    }
+  end
+end
+
+Snake.new.launch
+```
+
 ## Applications
 
 Here are some applications built with [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui)

data/VERSION

@@ -1 +1 @@
-0.2.21
+0.2.22

data/examples/meta_example.rb

@@ -43,7 +43,7 @@ class MetaExample
   
   def run_example(example)
     Thread.new do
-      command = "ruby -r #{glimmer_dsl_libui_file} #{example} 2>&1"
+      command = "#{RbConfig.ruby} -r #{glimmer_dsl_libui_file} #{example} 2>&1"
       result = ''
       IO.popen(command) do |f|
         sleep(0.0001) # yield to main thread

data/examples/snake/model/apple.rb

@@ -0,0 +1,33 @@
+class Snake
+  module Model
+    class Apple
+      attr_reader :game
+      attr_accessor :row, :column
+      
+      def initialize(game)
+        @game = game
+      end
+      
+      # generates a new location from scratch or via dependency injection of what cell is (for testing purposes)
+      def generate(initial_row: nil, initial_column: nil)
+        if initial_row && initial_column
+          self.row, self.column = initial_row, initial_column
+        else
+          self.row, self.column = @game.height.times.zip(@game.width.times).reject do |row, column|
+            @game.snake.vertebrae.map {|v| [v.row, v.column]}.include?([row, column])
+          end.sample
+        end
+      end
+      
+      def remove
+        self.row = nil
+        self.column = nil
+      end
+    
+      # inspect is overridden to prevent printing very long stack traces
+      def inspect
+        "#{super[0, 120]}... >"
+      end
+    end
+  end
+end

data/examples/snake/model/game.rb

@@ -0,0 +1,52 @@
+require 'fileutils'
+
+require_relative 'snake'
+require_relative 'apple'
+
+class Snake
+  module Model
+    class Game
+      WIDTH_DEFAULT = 40
+      HEIGHT_DEFAULT = 40
+      FILE_HIGH_SCORE = File.expand_path(File.join(Dir.home, '.glimmer-snake'))
+      
+      attr_reader :width, :height
+      attr_accessor :snake, :apple, :over, :score, :high_score
+      alias over? over
+      # TODO implement scoring on snake eating apples
+      
+      def initialize(width = WIDTH_DEFAULT, height = HEIGHT_DEFAULT)
+        @width = width
+        @height = height
+        @snake = Snake.new(self)
+        @apple = Apple.new(self)
+        FileUtils.touch(FILE_HIGH_SCORE)
+        @high_score = File.read(FILE_HIGH_SCORE).to_i rescue 0
+      end
+      
+      def score=(new_score)
+        @score = new_score
+        self.high_score = @score if @score > @high_score
+      end
+      
+      def high_score=(new_high_score)
+        @high_score = new_high_score
+        File.write(FILE_HIGH_SCORE, @high_score.to_s)
+      rescue => e
+        puts e.full_message
+      end
+      
+      def start
+        self.over = false
+        self.score = 0
+        self.snake.generate
+        self.apple.generate
+      end
+      
+      # inspect is overridden to prevent printing very long stack traces
+      def inspect
+        "#{super[0, 75]}... >"
+      end
+    end
+  end
+end

data/examples/snake/model/snake.rb

@@ -0,0 +1,95 @@
+require_relative 'vertebra'
+  
+class Snake
+  module Model
+    class Snake
+      SCORE_EAT_APPLE = 50
+      RIGHT_TURN_MAP = {
+        north: :east,
+        east: :south,
+        south: :west,
+        west: :north
+      }
+      LEFT_TURN_MAP = RIGHT_TURN_MAP.invert
+      
+      attr_accessor :collided
+      alias collided? collided
+      
+      attr_reader :game
+      # vertebrae and joins are ordered from tail to head
+      attr_accessor :vertebrae
+      
+      def initialize(game)
+        @game = game
+      end
+      
+      # generates a new snake location and orientation from scratch or via dependency injection of what head_cell and orientation are (for testing purposes)
+      def generate(initial_row: nil, initial_column: nil, initial_orientation: nil)
+        self.collided = false
+        initial_vertebra = Vertebra.new(snake: self, row: initial_row, column: initial_column, orientation: initial_orientation)
+        self.vertebrae = [initial_vertebra]
+      end
+      
+      def length
+        @vertebrae.length
+      end
+      
+      def head
+        @vertebrae.last
+      end
+      
+      def tail
+        @vertebrae.first
+      end
+      
+      def remove
+        self.vertebrae.clear
+        self.joins.clear
+      end
+      
+      def move
+        @old_tail = tail.dup
+        @new_head = head.dup
+        case @new_head.orientation
+        when :east
+          @new_head.column = (@new_head.column + 1) % @game.width
+        when :west
+          @new_head.column = (@new_head.column - 1) % @game.width
+        when :south
+          @new_head.row = (@new_head.row + 1) % @game.height
+        when :north
+          @new_head.row = (@new_head.row - 1) % @game.height
+        end
+        if @vertebrae.map {|v| [v.row, v.column]}.include?([@new_head.row, @new_head.column])
+          self.collided = true
+          @game.over = true
+        else
+          @vertebrae.append(@new_head)
+          @vertebrae.delete(tail)
+          if head.row == @game.apple.row && head.column == @game.apple.column
+            grow
+            @game.apple.generate
+          end
+        end
+      end
+      
+      def turn_right
+        head.orientation = RIGHT_TURN_MAP[head.orientation]
+      end
+      
+      def turn_left
+        head.orientation = LEFT_TURN_MAP[head.orientation]
+      end
+      
+      def grow
+        @game.score += SCORE_EAT_APPLE
+        @vertebrae.prepend(@old_tail)
+      end
+      
+      # inspect is overridden to prevent printing very long stack traces
+      def inspect
+        "#{super[0, 150]}... >"
+      end
+    end
+  end
+end

data/examples/snake/model/vertebra.rb

@@ -0,0 +1,22 @@
+class Snake
+  module Model
+    class Vertebra
+      ORIENTATIONS = %i[north east south west]
+      # orientation is needed for snake occuppied cells (but not apple cells)
+      attr_reader :snake
+      attr_accessor :row, :column, :orientation
+      
+      def initialize(snake: , row: , column: , orientation: )
+        @row = row || rand(snake.game.height)
+        @column = column || rand(snake.game.width)
+        @orientation = orientation || ORIENTATIONS.sample
+        @snake = snake
+      end
+      
+      # inspect is overridden to prevent printing very long stack traces
+      def inspect
+        "#{super[0, 150]}... >"
+      end
+    end
+  end
+end

data/examples/snake/presenter/cell.rb

@@ -0,0 +1,27 @@
+class Snake
+  module Presenter
+    class Cell
+      COLOR_CLEAR = :white
+      COLOR_SNAKE = :green
+      COLOR_APPLE = :red
+    
+      attr_reader :row, :column, :grid
+      attr_accessor :color
+      
+      def initialize(grid: ,row: ,column: )
+        @row = row
+        @column = column
+        @grid = grid
+      end
+      
+      def clear
+        self.color = COLOR_CLEAR unless color == COLOR_CLEAR
+      end
+      
+      # inspect is overridden to prevent printing very long stack traces
+      def inspect
+        "#{super[0, 150]}... >"
+      end
+    end
+  end
+end

data/examples/snake/presenter/grid.rb

@@ -0,0 +1,47 @@
+require 'glimmer/data_binding/observer'
+require_relative '../model/game'
+require_relative 'cell'
+
+class Snake
+  module Presenter
+    class Grid
+      attr_reader :game, :cells
+      
+      def initialize(game = Model::Game.new)
+        @game = game
+        @cells = @game.height.times.map do |row|
+          @game.width.times.map do |column|
+            Cell.new(grid: self, row: row, column: column)
+          end
+        end
+        Glimmer::DataBinding::Observer.proc do |new_vertebrae|
+          occupied_snake_positions = @game.snake.vertebrae.map {|v| [v.row, v.column]}
+          @cells.each_with_index do |row_cells, row|
+            row_cells.each_with_index do |cell, column|
+              if [@game.apple.row, @game.apple.column] == [row, column]
+                cell.color = Cell::COLOR_APPLE
+              elsif occupied_snake_positions.include?([row, column])
+                cell.color = Cell::COLOR_SNAKE
+              else
+                cell.clear
+              end
+            end
+          end
+        end.observe(@game.snake, :vertebrae)
+      end
+      
+      def clear
+        @cells.each do |row_cells|
+          row_cells.each do |cell|
+            cell.clear
+          end
+        end
+      end
+      
+      # inspect is overridden to prevent printing very long stack traces
+      def inspect
+        "#{super[0, 75]}... >"
+      end
+    end
+  end
+end

data/examples/snake.rb

@@ -0,0 +1,90 @@
+require 'glimmer-dsl-libui'
+require 'glimmer/data_binding/observer'
+
+require_relative 'snake/presenter/grid'
+
+class Snake
+  CELL_SIZE = 15
+  SNAKE_MOVE_DELAY = 0.1
+  include Glimmer
+  
+  def initialize
+    @game = Model::Game.new
+    @grid = Presenter::Grid.new(@game)
+    @game.start
+    create_gui
+    register_observers
+  end
+  
+  def launch
+    @main_window.show
+  end
+  
+  def register_observers
+    @game.height.times do |row|
+      @game.width.times do |column|
+        Glimmer::DataBinding::Observer.proc do |new_color|
+          @cell_grid[row][column].fill = new_color
+        end.observe(@grid.cells[row][column], :color)
+      end
+    end
+    
+    Glimmer::DataBinding::Observer.proc do |game_over|
+      Glimmer::LibUI.queue_main do
+        if game_over
+          msg_box('Game Over!', "Score: #{@game.score} | High Score: #{@game.high_score}")
+          @game.start
+        end
+      end
+    end.observe(@game, :over)
+    
+    Glimmer::LibUI.timer(SNAKE_MOVE_DELAY) do
+      unless @game.over?
+        @game.snake.move
+        @main_window.title = "Glimmer Snake (Score: #{@game.score} | High Score: #{@game.high_score})"
+      end
+    end
+  end
+  
+  def create_gui
+    @cell_grid = []
+    @main_window = window('Glimmer Snake', @game.width * CELL_SIZE, @game.height * CELL_SIZE) {
+      resizable false
+      
+      vertical_box {
+        padded false
+        
+        @game.height.times do |row|
+          @cell_grid << []
+          horizontal_box {
+            padded false
+            
+            @game.width.times do |column|
+              area {
+                @cell_grid.last << path {
+                  square(0, 0, CELL_SIZE)
+                  
+                  fill Presenter::Cell::COLOR_CLEAR
+                }
+                
+                on_key_up do |area_key_event|
+                  orientation_and_key = [@game.snake.head.orientation, area_key_event[:ext_key]]
+                  case orientation_and_key
+                  in [:north, :right] | [:east, :down] | [:south, :left] | [:west, :up]
+                    @game.snake.turn_right
+                  in [:north, :left] | [:west, :down] | [:south, :right] | [:east, :up]
+                    @game.snake.turn_left
+                  else
+                    # No Op
+                  end
+                end
+              }
+            end
+          }
+        end
+      }
+    }
+  end
+end
+
+Snake.new.launch

data/examples/tetris/model/game.rb

@@ -113,7 +113,7 @@ class Tetris
       end
       
       def tetris_dir
-        @tetris_dir ||= File.join(File.expand_path('~'), '.glimmer-tetris')
+        @tetris_dir ||= File.join(Dir.home, '.glimmer-tetris')
       end
       
       def tetris_high_score_file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.22
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -252,6 +252,13 @@ files:
 - examples/method_based_custom_keyword.rb
 - examples/midi_player.rb
 - examples/simple_notepad.rb
+- examples/snake.rb
+- examples/snake/model/apple.rb
+- examples/snake/model/game.rb
+- examples/snake/model/snake.rb
+- examples/snake/model/vertebra.rb
+- examples/snake/presenter/cell.rb
+- examples/snake/presenter/grid.rb
 - examples/tetris.rb
 - examples/tetris/model/block.rb
 - examples/tetris/model/game.rb