terminal_game_of_life 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b949e4ff807eb374946cc0c2647f9aa5cf3f79b2427cab818b492ecdbb9a3b24
-  data.tar.gz: b0e82c40b3c53972f52382728281cc2b83219835ffe1ad65c89f9e446beadf02
+  metadata.gz: 2f01833ac38b2fcfb9f8ea6581642e2d95a9f40521d79773178c5499e23a2530
+  data.tar.gz: 5f8540b420def7ca4eb0a9371140419bd47489089bed0c5f68f204a266d9946c
 SHA512:
-  metadata.gz: 96e1fd3c329a3d775a7d332351303c53a2767857ccef421ad372ec8abbebae7bd4f7d07ae2ad23210cd360d889d21fa7ccafc6c9dc08388a6ffb967dd44afa52
-  data.tar.gz: 8674f279918813b3cf8c4ee1ed9a2d257c48755a3c06e687a2f5f17cdf6707e85509277042e3176d6eaa5e7c69ae143bc5d4e996572a55fa73900c2bc8e9ac1d
+  metadata.gz: 3fbf0db73b5fb37de4b2565813f4ba5ab5500930630fea8151f627b972ed7ef1bdfd95253675da6160451734b9d24d688802e92a36532140b1920fdb4b45d00e
+  data.tar.gz: ec4959be702a801f10229c9f85edcd148326d60d919c6b099c1bcd0b06a8f2b1efb24fa225121d14ab28f6239583ab05aacde14c659e74c77ff2262e7b466e8f

data/README.md

@@ -9,7 +9,11 @@ $ gem install terminal_game_of_life
 
 ## Usage
 
-Run `$game-of-life -i https://gitlab.com/a14m --live-cell +`
+```bash
+$game-of-life -i https://meta.sr.ht/~a14m.keys --live-cell +
+$game-of-life -i /path/to/file.txt --height 35 --width 35
+$game-of-life -s 1337 --delay 250
+```
 
 Check `game-of-life --help` for usage info.
 
@@ -26,7 +30,7 @@ Options:
       [--height=HEIGHT]        # Specify the hight of generated universe. (default to terminal height)
       [--dead-cell=CHAR]       # Specify the dead-cell representation
                                # Default:  
-      [--live-cell=CHAR]       # Specify the dead-cell representation
+      [--live-cell=CHAR]       # Specify the live-cell representation
                                # Default: █
   -d, [--delay=Milli-Seconds]  # Specify the introduced delay between each generation
                                # Default: 50
@@ -40,14 +44,15 @@ Options:
 - Clone the repo.
 - Navigate to the ruby CLI implementation `cd game-of-life/CLI/ruby`.
 - run `bundle install` to install dependencies.
-- run `bundle rake build` to build the gem/CLI into the `pkg` directory.
-- run `bundle rake install` to build and install gem/CLI into system gems.
+- you can run `bundle rake build` to build the gem/CLI into the `pkg` directory.
+- you can run `bundle rake install` to build and install gem/CLI into system gems.
+- you can run `bundle exec ./bin/game-of-life` to run the code for development/testing purposes
 
 ## Linting
 Run `bundle exec rubocop`
 
 ## Testing
-Run `bundle exec rspec` or `bundle exec rake spec`
+Run `bundle exec rspec`
 
 ## Documentation
 Run `bundle exec yard`
@@ -56,12 +61,12 @@ Run `bundle exec yard`
 - Update the [version](./lib/game_of_live/version.rb) number
 - Run `bundle install` and commit changes
 - Update the [CHANGELOG](./CHANGELOG.md)
-- Create a git(lab) tag `ruby/v#{version_number}` ex: `ruby/v0.1.1-pre`
+- Create a git tag `ruby/v#{version_number}` ex: `ruby/v0.1.1-pre`
 
 The tag will automatically trigger the release workflow after successful build/test
 and release the changes to [rubygems.org](https://rubygems.org/gems/terminal_game_of_life)
 
 ## Extra information
-### [Contributing](https://gitlab.com/a14m/game-of-life/-/blob/master/CONTRIBUTING.md)
-### [License](https://gitlab.com/a14m/game-of-life/-/blob/master/LICENSE.md)
-### [Code of Conduct](https://gitlab.com/a14m/game-of-life/-/blob/master/CODE_OF_CONDUCT.md)
+### [Contributing](../../CONTRIBUTING.md)
+### [License](../../LICENSE.md)
+### [Code of Conduct](../../CODE_OF_CONDUCT.md)

data/bin/game-of-life

@@ -3,13 +3,12 @@
 
 require "game_of_life"
 require "thor"
-require "io/console"
 
 class CLI < Thor
   map %w[-v --version] => :version
   desc "--version, -v", "Prints the Game of Life version information"
   def version
-    puts "Game of Life version #{GameOfLife::VERSION}"
+    print "Game of Life version #{GameOfLife::VERSION}"
   end
 
   default_task :start
@@ -30,35 +29,14 @@ class CLI < Thor
                             desc: "Specify the dead-cell representation"
 
   class_option "live-cell", type: :string, banner: :CHAR, default: "\u2588",
-                            desc: "Specify the dead-cell representation"
+                            desc: "Specify the live-cell representation"
 
   class_option "delay", aliases: "-d", type: :numeric, banner: "Milli-Seconds", default: 50,
                         desc: "Specify the introduced delay between each generation"
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def start
-    max_height = IO.console.winsize[0] - 2
-    max_width  = IO.console.winsize[1]
-    if options["width"]&.> max_width
-      fail GameOfLife::Error, "Invalid --width value, must not exceed current terminal width: #{max_width}"
-    end
-    if options["height"]&.> max_height
-      fail GameOfLife::Error, "Invalid --height value, must not exceed current terminal height: #{max_height}"
-    end
-
-    options_with_console_defaults = {
-      # Defaults the hight to less then the height of the terminal to allow banner info
-      # and an extra emtpy line to avoid triggering terminal scroll while flushing
-      "height" => max_height,
-      "width" => max_width,
-      "seed" => rand(100_000),
-    }.merge(options)
-
-    universe = GameOfLife.generate(options_with_console_defaults)
+    universe = GameOfLife.generate(GameOfLife.parsed_options(options))
     GameOfLife.run(universe)
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 
   class << self
     # Allow exit with status 1 on failure
@@ -72,8 +50,10 @@ end
 begin
   CLI.start(ARGV)
 rescue SystemExit, Interrupt
-  "Do nothing when user exits with Interrupt (CMD/Ctrl + C)"
+  # Print Seed/File used in previous run when  user exits with Interrupt (CMD/Ctrl + C)
+  print "\e[?1049l"
+  print "#{GameOfLife::BANNER}\n\e[0m"
 rescue NotImplementedError, GameOfLife::Error => e
-  puts e.message
+  print e.message
   exit(-1)
 end

data/game_of_life.gemspec

@@ -10,15 +10,15 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Game of Life CLI"
   spec.description   = "Conway's game of life implementation as a CLI ruby gem."
-  spec.homepage      = "https://gitlab.com/a14m/game-of-life"
+  spec.homepage      = "https://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/README.md"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 2.5.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["homepage_uri"]      = spec.homepage
-  spec.metadata["source_code_uri"]   = "https://gitlab.com/a14m/game-of-life/-/tree/master/CLI/ruby/"
+  spec.metadata["source_code_uri"]   = "https://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby"
   spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/terminal_game_of_life"
-  spec.metadata["changelog_uri"]     = "https://gitlab.com/a14m/game-of-life/-/blob/master/CLI/ruby/CHANGELOG.md"
+  spec.metadata["changelog_uri"]     = "https://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/CHANGELOG.md"
 
   spec.executables   = ["game-of-life"]
   spec.require_paths = ["lib"]
@@ -31,6 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  # Code Coverage dependencies
+  spec.add_development_dependency "codecov"
+  spec.add_development_dependency "simplecov"
   # Documentation dependencies
   spec.add_development_dependency "redcarpet"
   spec.add_development_dependency "yard"

data/lib/game_of_life.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "io/console"
 require "game_of_life/version"
 require "game_of_life/plane"
 require "game_of_life/universe"
@@ -11,6 +12,58 @@ module GameOfLife
   class Error < StandardError; end
 
   class << self
+    # Validate and parse the CLI options and set defaults for the dynamic options.
+    # @param options [Hash] CLI options to generate initial conditions
+    # @option options [String | nil] "input" path to a local file or URL to open
+    # @option options [Numeric | nil] "seed" number to use if no "input" is provided
+    # @option options [Numeric] "width" of the universe
+    # @option options [Numeric] "height" of the universe
+    # @option options [Numeric] "delay" introduced after each cycle
+    # @option options [String] "live-cell" representation
+    # @option options [String] "dead-cell" representation
+    # @smell AbcSize, MethodLenght, Cyclomatic and Perceived Complexity needed for parsing and validating options
+    #   rubocop:disable Metrics/AbcSize
+    #   rubocop:disable Metrics/MethodLength
+    #   rubocop:disable Metrics/CyclomaticComplexity
+    #   rubocop:disable Metrics/PerceivedComplexity
+    # return [Hash] of the parsed options with dynamic defaults based on window size and kernel random
+    def parsed_options(options)
+      max_height = IO.console.winsize[0] - 2
+      max_width  = IO.console.winsize[1]
+
+      if options["delay"].to_i.negative?
+        fail GameOfLife::Error, "Invalid --delay value. must be positive value (sadly this is how time works -so far-)"
+      end
+      if (options["width"]&.< 1) || (options["width"]&.> max_width)
+        fail GameOfLife::Error, "Invalid --width value. " \
+          "must be between 1 and #{max_width} (current terminal width)"
+      end
+      if (options["height"]&.< 1) || (options["height"]&.> max_height)
+        fail GameOfLife::Error, "Invalid --height value. " \
+          "must be between 1 and #{max_height} (current terminal height)"
+      end
+
+      fail GameOfLife::Error, "Invalid --live-cell value. must be a single character" if options["live-cell"].length > 1
+
+      fail GameOfLife::Error, "Invalid --dead-cell value. must be a single character" if options["dead-cell"].length > 1
+
+      if options["dead-cell"] == options["live-cell"]
+        fail GameOfLife::Error, "Invalid --dead-cell value. must be a different character than --live-cell"
+      end
+
+      {
+        # Defaults the hight to less then the height of the terminal to allow banner info
+        # and an extra emtpy line to avoid triggering terminal scroll while flushing
+        "height" => max_height,
+        "width" => max_width,
+        "seed" => rand(100_000),
+      }.merge(options)
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+
     # Generate a universe based on the options (from an input file/URI) or using a random/passed seed
     # This method also sets the Classes/Modules constants for the run defining the options for
     # Cell (Dead/Live) state representations, and the delay introduced after rendering each universe/generation
@@ -53,9 +106,13 @@ module GameOfLife
     # and rendering of the current universe/banner info
     # based on the delay/cell configured by the user
     def render(universe)
-      puts "\33c\e[3J" # Clears the screen and scrollback buffer.
-      puts universe.to_s
-      puts BANNER
+      # Use Alternate Screen (\e[?1049h) and move cursor to top left (\e[H)
+      # Ref: https://github.com/ruby/ruby/blob/ruby_2_7/lib/irb/easter-egg.rb#L112-L131
+      # Ref: https://stackoverflow.com/questions/11023929/using-the-alternate-screen-in-a-bash-script
+      # Ref: https://superuser.com/questions/122911/what-commands-can-i-use-to-reset-and-clear-my-terminal
+      print "\e[?1049h\e[H"
+      print universe.to_s
+      print "\n #{BANNER}"
       sleep(DELAY / 1000.0)
     end
   end

data/lib/game_of_life/version.rb

@@ -2,5 +2,5 @@
 
 module GameOfLife
   # Game of life version number
-  VERSION = "1.0.0"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal_game_of_life
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - a14m
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: codecov
+  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: simplecov
+  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: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -141,16 +183,16 @@ files:
 - lib/game_of_life/plane.rb
 - lib/game_of_life/universe.rb
 - lib/game_of_life/version.rb
-homepage: https://gitlab.com/a14m/game-of-life
+homepage: https://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/README.md
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://gitlab.com/a14m/game-of-life
-  source_code_uri: https://gitlab.com/a14m/game-of-life/-/tree/master/CLI/ruby/
+  homepage_uri: https://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/README.md
+  source_code_uri: https://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby
   documentation_uri: https://rubydoc.info/gems/terminal_game_of_life
-  changelog_uri: https://gitlab.com/a14m/game-of-life/-/blob/master/CLI/ruby/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,8 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Game of Life CLI
 test_files: []