terminal_game_of_life 0.2.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf5383033cdfa94863a1ffed02d61b746689d927821350042ada2bd3727ac031
-  data.tar.gz: 9e5c119a3d6b70ef61fc80db8fdc740f3233624e4284da35539fbd1c06e61ba5
+  metadata.gz: 63ab48e83b28420afc50509a439c9901cafa84de7acc4d8c53923513b8cc3631
+  data.tar.gz: 635c4f76918e9a38b9026f53f296302e78798379632e5df54a524efef4122393
 SHA512:
-  metadata.gz: 94b939ec472b19c6d7d38ec0f38ada21d24756c752fba4bb99da96c79c4e2b5a170a46884611ae57eb83d9a6093d81edaa529cfe58feffdee8d7d4d2f609faa4
-  data.tar.gz: bdc9a52b4f4040c22c72a7583ecb2c0685a031804ad5cb28abadd89465f60a3bd431b3ba8aa424f959e75884c69d2f370865be6d918d52823685a68a8c6eb160
+  metadata.gz: 8a3fae98670de950efd9febad455530b4278b98d89155d6157c7c3ceaa99adb01f132b1536cb15ee672b033316601071080d163289dd8e89cc401066fedfedf8
+  data.tar.gz: 7f0218b35225633c2e73113080abe520bbc3f509b19e6f5f927a42cdcffd95ef9436926d4a0f978c914bb9d091d651bf2974668d406aa070bbb982e3b14b15e8

data/.yardopts

@@ -0,0 +1,8 @@
+lib/**/*.rb
+
+--readme README.md
+--markup markdown
+--markup-provider redcarpet
+--protected
+--private
+--tag smell:"Code smells"

data/README.md

@@ -9,44 +9,50 @@ $ 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.
 
 ```
+Commands:
   game-of-life --version, -v    # Prints the Game of Life version information
   game-of-life help [COMMAND]   # Describe available commands or one specific command
-  game-of-life start [OPTIONS]  # Start the Game of Life simulations (default command)
+  game-of-life start [OPTIONS]  # Start the Game of Life simulations
 
 Options:
   -s, [--seed=SEED]            # Specify the seed number to use as an initial state (default to random).
   -i, [--input=VALUE]          # Specify the path/URL for the file to use as an initial state. (used instead of seed)
-  -w, [--width=WIDTH]          # Specify the width of generated universe. (default to terminal width)
-  -h, [--height=HEIGHT]        # Specify the hight of generated universe. (default to terminal height)
+      [--width=WIDTH]          # Specify the width of generated universe. (default to terminal width)
+      [--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
+                               # Default:  
+      [--live-cell=CHAR]       # Specify the live-cell representation
                                # Default: █
   -d, [--delay=Milli-Seconds]  # Specify the introduced delay between each generation
                                # Default: 50
 ```
 
 ## Demo
-[![asciicast](https://asciinema.org/a/h7G2EUAXRfwlBVLZjQuXjoTnp.svg)](https://asciinema.org/a/h7G2EUAXRfwlBVLZjQuXjoTnp)
+[![asciicast](https://asciinema.org/a/PsKzaWaNwUq3ZEfrFATqMw0yF.svg)](https://asciinema.org/a/PsKzaWaNwUq3ZEfrFATqMw0yF)
 
 ## Development
 
 - 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`
@@ -55,7 +61,7 @@ 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)

data/bin/game-of-life

@@ -3,7 +3,6 @@
 
 require "game_of_life"
 require "thor"
-require "io/console"
 
 class CLI < Thor
   map %w[-v --version] => :version
@@ -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

data/game_of_life.gemspec

@@ -10,17 +10,19 @@ 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.4.0"
+  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://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/CHANGELOG.md"
 
   spec.executables   = ["game-of-life"]
   spec.require_paths = ["lib"]
-  spec.files         = Dir["README.md", "game_of_life.gemspec", "bin/game-of-life", "lib/**/*.rb"]
+  spec.files         = Dir["README.md", "game_of_life.gemspec", "bin/game-of-life", "lib/**/*.rb", ".yardopts"]
 
   spec.add_dependency "thor", "~> 1.0"
 
@@ -29,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
@@ -49,9 +102,9 @@ module GameOfLife
       end
     end
 
-    # Private method to do the terminal screen/scrollback buffer cleaning
+    # render method to do the terminal screen/scrollback buffer cleaning
     # and rendering of the current universe/banner info
-    # based on the delay configured by the user
+    # 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

data/lib/game_of_life/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal_game_of_life
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.3
 platform: ruby
 authors:
 - a14m
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-01-30 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
@@ -130,6 +172,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - README.md
 - bin/game-of-life
 - game_of_life.gemspec
@@ -140,14 +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/
-post_install_message: 
+  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://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -163,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Game of Life CLI
 test_files: []