glimmer_snake 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d1bec8cd2eac33a2b2546c9a852007b7fb58d26556ee207a9c2ba0966775311
-  data.tar.gz: ebe57fdb0c8c69eace44d740d3972c3793932839807a3db87269833acb9d35d8
+  metadata.gz: b0d5030c25633669f6aa7430e9afb02b1b9a9a7850b73b3739e3f9c3e55298e1
+  data.tar.gz: d3f3096c49d1f504fb0abdd203c0e192288d601a1e0aec8fb5922eb065c13a69
 SHA512:
-  metadata.gz: 4d0e241b9fdeba7328906c739364d06dc518f45c279340775e5f85b305652b8c6da3d32f7a990f3fedf6dceeaf04dc4b4f8ea1093a0a6d043046eda4e2c0e9fe
-  data.tar.gz: 6c7775a38e281cfc373ee5b070803d9d65d75eb03316ea97a9ea2a84b1e617dfbe729d93c361d9f375c78aa390c815e818cd8f7fe6f9aaefad4c819d1e536441
+  metadata.gz: f955857df6a0162a03bb433193ca1c20d2cc055e644e4b79236421c7543105769d125c742b3143fc731d54f93c168868045a7ce9f7558a477ef98e7720c5478f
+  data.tar.gz: e30a1e398ca0761e87d3d4c0202cc574b08f0cda51d053b324d84b6a815e8e2b97388bdec1a36c65232fa44c3bf55fb8f26d15bab6b2bcbd62cdceb201de047a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 1.0.1
+
+- Change snake direction on key press instead of key release to be more responsive for players who are not used to releasing pressed keys quickly
+- Fix issue with detecting collision too soon if a snake fills the entire space horizontally or vertically
+- Add unit tests for the Model layer
+- Refactor `GlimmerSnake::Model::Snake` to be more readable like high-level game domain rules (especially `move` method)
+
 ## 1.0.0
 
 - Initial Glimmer Snake implementation

data/README.md

@@ -1,4 +1,4 @@
-# <img alt="Glimmer Tetris Icon" src="https://raw.githubusercontent.com/AndyObtiva/glimmer_snake/master/icons/linux/Glimmer%20Snake.png" height=85 /> Glimmer Snake 1.0.0
+# <img alt="Glimmer Tetris Icon" src="https://raw.githubusercontent.com/AndyObtiva/glimmer_snake/master/icons/linux/Glimmer%20Snake.png" height=85 /> Glimmer Snake 1.0.1
 ## [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 /> Glimmer DSL for LibUI Application](https://github.com/AndyObtiva/glimmer-dsl-libui)
 [![Gem Version](https://badge.fury.io/rb/glimmer_snake.svg)](http://badge.fury.io/rb/glimmer_snake)
 
@@ -28,7 +28,7 @@ Mac | Windows | Linux
 ----|---------|------
 ![glimmer-dsl-libui-mac-snake.png](/screenshots/glimmer-dsl-libui-mac-snake.png) ![glimmer-dsl-libui-mac-snake-game-over.png](/screenshots/glimmer-dsl-libui-mac-snake-game-over.png) | ![glimmer-dsl-libui-windows-snake.png](/screenshots/glimmer-dsl-libui-windows-snake.png) ![glimmer-dsl-libui-windows-snake-game-over.png](/screenshots/glimmer-dsl-libui-windows-snake-game-over.png) | ![glimmer-dsl-libui-linux-snake.png](/screenshots/glimmer-dsl-libui-linux-snake.png) ![glimmer-dsl-libui-linux-snake-game-over.png](/screenshots/glimmer-dsl-libui-linux-snake-game-over.png)
 
-The goal is for the green snake to eat the red apple and to survive for as long as possible. Every time it eats an apple, it grows by 1 block (the size of the apple). If the snake hits its own body (especially after enlargement), it dies.
+The goal of the game is for the green snake to eat the red apple and to survive for as long as possible. The snake always moves forward at a fixed speed. You can change the direction of the snake using arrow keys (Up is North, Right is East, Down is South, Left is West). Every time the snake eats an apple, it grows by 1 block (the size of the apple), and the apple regenerates somewhere else. If the snake hits its own body (especially after enlargement), it dies. Pressing the spacebar pauses/unpauses the game.
 
 The game remembers the highest score by storing in `~/.glimmer-snake`. You can delete that file if you want to reset the highest score.
 

data/TODO.md

@@ -1,3 +1,3 @@
 # TODO
 
-N/A
+- Increase the speed of the snake slightly every time it eats an apple

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/app/glimmer_snake/model/snake.rb

@@ -47,10 +47,33 @@ class GlimmerSnake
         self.joins.clear
       end
       
+      def turn_right
+        head.orientation = RIGHT_TURN_MAP[head.orientation]
+      end
+      
+      def turn_left
+        head.orientation = LEFT_TURN_MAP[head.orientation]
+      end
+      
       def move
-        @old_tail = tail.dup
+        create_new_head
+        remove_old_tail
+        if detect_collision?
+          collide_and_die
+        else
+          append_new_head
+          eat_apple if detect_apple?
+        end
+      end
+      
+      def remove_old_tail
+        @old_tail = tail.dup # save in case of growing and keeping old tail
+        @vertebrae.delete(tail)
+      end
+      
+      def create_new_head
         @new_head = head.dup
-        case @new_head.orientation
+        case head.orientation
         when :east
           @new_head.column = (@new_head.column + 1) % @game.width
         when :west
@@ -60,25 +83,28 @@ class GlimmerSnake
         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]
+      def append_new_head
+        @vertebrae.append(@new_head)
       end
       
-      def turn_left
-        head.orientation = LEFT_TURN_MAP[head.orientation]
+      def detect_collision?
+        @vertebrae.map {|v| [v.row, v.column]}.include?([@new_head.row, @new_head.column])
+      end
+      
+      def collide_and_die
+        self.collided = true
+        @game.over = true
+      end
+      
+      def detect_apple?
+        head.row == @game.apple.row && head.column == @game.apple.column
+      end
+      
+      def eat_apple
+        grow
+        @game.apple.generate
       end
       
       def grow

data/app/glimmer_snake/{model → presenter}/grid.rb

@@ -5,7 +5,7 @@ require_relative 'cell'
 class GlimmerSnake
   module Presenter
     class Grid
-      include Glimmer
+      include Glimmer # used only for observer support (`observe` method only, not GUI)
       
       attr_reader :game, :cells
       

data/app/glimmer_snake/view/glimmer_snake.rb

@@ -1,4 +1,4 @@
-require 'glimmer_snake/model/grid'
+require 'glimmer_snake/presenter/grid'
 
 class GlimmerSnake
   module View
@@ -38,13 +38,17 @@ class GlimmerSnake
                     square(0, 0, CELL_SIZE) {
                       fill <= [@grid.cells[row][column], :color] # data-bind square fill to grid cell color
                     }
-                    
-                    on_key_up do |area_key_event|
+                
+                    on_key_down do |area_key_event|
+                      handled = true # assume we will handle the event
                       if area_key_event[:key] == ' '
                         @game.toggle_pause
-                      else
+                      elsif %i[up right down left].include?(area_key_event[:ext_key])
                         @keypress_queue << area_key_event[:ext_key]
+                      else
+                        handled = false # we won't handle the event after all
                       end
+                      handled
                     end
                   }
                 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer_snake
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer-dsl-libui
@@ -66,8 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Glimmer Snake game desktop application built with Glimmer DSL for LibUI.
-  Gem ships with a glimmer_snake binary script for launching the game.
+description: Glimmer Snake game cross-platform desktop GUI application built with
+  Glimmer DSL for LibUI to run on Mac, Windows, and Linux. Gem ships with glimmer_snake
+  script for launching game.
 email: andy.am@gmail.com
 executables:
 - glimmer_snake
@@ -85,13 +86,12 @@ files:
 - app/glimmer_snake.rb
 - app/glimmer_snake/launch.rb
 - app/glimmer_snake/model/apple.rb
-- app/glimmer_snake/model/cell.rb
 - app/glimmer_snake/model/game.rb
-- app/glimmer_snake/model/grid.rb
 - app/glimmer_snake/model/snake.rb
 - app/glimmer_snake/model/vertebra.rb
+- app/glimmer_snake/presenter/cell.rb
+- app/glimmer_snake/presenter/grid.rb
 - app/glimmer_snake/view/glimmer_snake.rb
-- app/glimmer_snake/view/snake.rb
 - bin/glimmer_snake
 - glimmer_snake.gemspec
 - icons/linux/Glimmer Snake.png
@@ -104,7 +104,8 @@ metadata: {}
 post_install_message:
 - |2+
 
-  Glimmer Snake 1.0.0 was installed!
+  Glimmer Snake 1.0.1
+   was installed!
   Play by running:
 
   glimmer_snake

data/app/glimmer_snake/view/snake.rb

@@ -1,91 +0,0 @@
-require 'glimmer-dsl-libui'
-
-require_relative 'snake/presenter/grid'
-
-class Snake
-  include Glimmer
-  
-  CELL_SIZE = 15
-  SNAKE_MOVE_DELAY = 0.1
-  
-  def initialize
-    @game = Model::Game.new
-    @grid = Presenter::Grid.new(@game)
-    @game.start
-    @keypress_queue = []
-    create_gui
-    register_observers
-  end
-  
-  def launch
-    @main_window.show
-  end
-  
-  def register_observers
-    observe(@game, :over) 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
-    
-    Glimmer::LibUI.timer(SNAKE_MOVE_DELAY) do
-      unless @game.paused? || @game.over?
-        process_queued_keypress
-        @game.snake.move
-      end
-    end
-  end
-  
-  def process_queued_keypress
-    # key press queue ensures one turn per snake move to avoid a double-turn resulting in instant death (due to snake illogically going back against itself)
-    key = @keypress_queue.shift
-    case [@game.snake.head.orientation, 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
-  
-  def create_gui
-    @main_window = window {
-      # data-bind window title to game score, converting it to a title string on read from the model
-      title <= [@game, :score, on_read: -> (score) {"Snake (Score: #{@game.score})"}]
-      content_size @game.width * CELL_SIZE, @game.height * CELL_SIZE
-      resizable false
-      
-      vertical_box {
-        padded false
-        
-        @game.height.times do |row|
-          horizontal_box {
-            padded false
-            
-            @game.width.times do |column|
-              area {
-                square(0, 0, CELL_SIZE) {
-                  fill <= [@grid.cells[row][column], :color] # data-bind square fill to grid cell color
-                }
-                
-                on_key_up do |area_key_event|
-                  if area_key_event[:key] == ' '
-                    @game.toggle_pause
-                  else
-                    @keypress_queue << area_key_event[:ext_key]
-                  end
-                end
-              }
-            end
-          }
-        end
-      }
-    }
-  end
-end
-
-Snake.new.launch