terminal_game_of_life 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e653045a66a53af6c2b4c5b58f0330ec18d8125e7ce70b2b9c8803e8d7f67b2a
-  data.tar.gz: 75ffbbd48c0b9cb883a2cd1aab1f0b7e7606856223a18e88c4dd0a9916a5afc6
+  metadata.gz: b949e4ff807eb374946cc0c2647f9aa5cf3f79b2427cab818b492ecdbb9a3b24
+  data.tar.gz: b0e82c40b3c53972f52382728281cc2b83219835ffe1ad65c89f9e446beadf02
 SHA512:
-  metadata.gz: a4ae52be24a7bbadf45997c129b1e4b407f3b6f47ecc1cb6c6c63c002d57add5f6ac231581ef024458f366189555f73fad4995a279d4b9b92c0fc5e2d5721141
-  data.tar.gz: b3f717f56369f87ed173a57ff9f79364e3400af441c543c58a64a244fa8b9a328304fd00a9de8d82593fbb6aeb0795f81d15ceb67b29a698d1b0ebe0133ff1ea
+  metadata.gz: 96e1fd3c329a3d775a7d332351303c53a2767857ccef421ad372ec8abbebae7bd4f7d07ae2ad23210cd360d889d21fa7ccafc6c9dc08388a6ffb967dd44afa52
+  data.tar.gz: 8674f279918813b3cf8c4ee1ed9a2d257c48755a3c06e687a2f5f17cdf6707e85509277042e3176d6eaa5e7c69ae143bc5d4e996572a55fa73900c2bc8e9ac1d

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,26 +9,32 @@ $ gem install terminal_game_of_life
 
 ## Usage
 
+Run `$game-of-life -i https://gitlab.com/a14m --live-cell +`
+
 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:
+                               # Default:  
       [--live-cell=CHAR]       # Specify the dead-cell representation
                                # Default: █
   -d, [--delay=Milli-Seconds]  # Specify the introduced delay between each generation
                                # Default: 50
 ```
 
+## Demo
+[![asciicast](https://asciinema.org/a/PsKzaWaNwUq3ZEfrFATqMw0yF.svg)](https://asciinema.org/a/PsKzaWaNwUq3ZEfrFATqMw0yF)
+
 ## Development
 
 - Clone the repo.
@@ -46,7 +52,16 @@ Run `bundle exec rspec` or `bundle exec rake spec`
 ## Documentation
 Run `bundle exec yard`
 
+## Release
+- 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`
+
+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](../../CONTRIBUTING.md)
-### [License](../../LICENSE.md)
-### [Code of Conduct](../../CODE_OF_CONDUCT.md)
+### [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)

data/bin/game-of-life

@@ -20,10 +20,10 @@ class CLI < Thor
   class_option "input", aliases: "-i", type: :string, banner: :VALUE,
                         desc: "Specify the path/URL for the file to use as an initial state. (used instead of seed)"
 
-  class_option "width", aliases: "-w", type: :numeric, banner: :WIDTH,
+  class_option "width", type: :numeric, banner: :WIDTH,
                         desc: "Specify the width of generated universe. (default to terminal width)"
 
-  class_option "height", aliases: "-h", type: :numeric, banner: :HEIGHT,
+  class_option "height", type: :numeric, banner: :HEIGHT,
                          desc: "Specify the hight of generated universe. (default to terminal height)"
 
   class_option "dead-cell", type: :string, banner: :CHAR, default: "\s",
@@ -34,18 +34,31 @@ class CLI < Thor
 
   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" => IO.console.winsize[0] - 3,
-      "width" => IO.console.winsize[1],
+      "height" => max_height,
+      "width" => max_width,
       "seed" => rand(100_000),
     }.merge(options)
 
     universe = GameOfLife.generate(options_with_console_defaults)
     GameOfLife.run(universe)
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
   class << self
     # Allow exit with status 1 on failure
@@ -60,6 +73,7 @@ begin
   CLI.start(ARGV)
 rescue SystemExit, Interrupt
   "Do nothing when user exits with Interrupt (CMD/Ctrl + C)"
-rescue NotImplementedError
-  puts "Seed option isn't implemented yet, please use --input option"
+rescue NotImplementedError, GameOfLife::Error => e
+  puts e.message
+  exit(-1)
 end

data/game_of_life.gemspec

@@ -12,15 +12,17 @@ Gem::Specification.new do |spec|
   spec.description   = "Conway's game of life implementation as a CLI ruby gem."
   spec.homepage      = "https://gitlab.com/a14m/game-of-life"
   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["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.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"
 

data/lib/game_of_life.rb

@@ -7,6 +7,9 @@ require "game_of_life/cell"
 
 # Game of Life module entry point
 module GameOfLife
+  # Base Error class
+  class Error < StandardError; end
+
   class << self
     # 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
@@ -46,9 +49,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/generators/input.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "open-uri"
+require "socket"
 
 module GameOfLife
   module Generators
@@ -13,28 +14,46 @@ module GameOfLife
         # @option options [Numeric] "width" (floored) and used as the width of the universe
         # @option options [Numeric] "height" (floored) and used as the height of the universe
         # @return [GameOfLife::Universe] populated with the parsed input
+        # @see ::GameOfLife::Generators::Input.generate_input_data
         # @see ::GameOfLife::Generators::Input.populate
         def new(options)
+          width  = options["width"].to_i
+          height = options["height"].to_i
+          uri    = options["input"]
+          input  = generate_input_data(uri: uri)
+          populate(input: input, width: width, height: height)
+        end
+
+        # Generate the seeding data for populating the {GameOfLife::Universe} from input URI
+        # @param uri [String] inputh path to local file or URL to open
+        # @return [Array<Array<True|False>>] covering the defined size of universe
+        # @see ::GameOfLife::Generators::Input.populate
+        private def generate_input_data(uri:)
           # By design, it's intentional that we use URI.open to to allow seamless file and url access
-          raw = URI.open(options["input"]).read.split("\n") # rubocop:disable Security/Open
+          raw = URI.open(uri).read.split("\n") # rubocop:disable Security/Open
 
           # Parse the file and convert it to a boolean 2D array
           # where any alpha numeric character is considered a living cell (true)
           raw.map! { |row| row.chars.map { |char| char.match?(/[[:alnum:]]/) } }
-          populate(parsed_input: raw, width: options["width"].to_i, height: options["height"].to_i)
+        rescue ::OpenURI::HTTPError, ::SocketError
+          raise GameOfLife::Error, "URL isn't avaialable, please check it again and make sure the URL is correct"
+        rescue ::Errno::ENOENT
+          raise GameOfLife::Error,
+                "File isn't avaialable, please check it again and make sure the path to the input file is correct"
         end
 
         # Populate the {GameOfLife::Universe} with reference to the parsed input 2D array (True/False)
-        # @param parsed_input [Array<Array<True|False>>]
+        # @param input [Array<Array<True|False>>]
         # @param width [Integer] width of the generated cyclic universe
         # @param height [Integer] height of the generated cyclic universe
         # @return [GameOfLife::Universe] populated with the parsed input
-        private def populate(parsed_input:, width:, height:)
+        # @see ::GameOfLife::Generators::Input.generate_input_data
+        private def populate(input:, width:, height:)
           # Generate a universe based on the parsed raw file and fill it with the cells
           universe = GameOfLife::Universe.new(height: height, width: width)
           (0...height).each do |i|
             (0...width).each do |j|
-              cell = { x: j, y: i, alive: parsed_input.fetch(i, nil)&.fetch(j, nil) }
+              cell = { x: j, y: i, alive: input.fetch(i, nil)&.fetch(j, nil) }
               universe[i][j] = ::GameOfLife::Cell.new(cell)
             end
           end

data/lib/game_of_life/generators/seed.rb

@@ -11,8 +11,47 @@ module GameOfLife
         # @option options [Numeric] "width" (floored) and used as the width of the universe
         # @option options [Numeric] "height" (floored) and used as the height of the universe
         # @return [GameOfLife::Universe] populated with the parsed input
+        # @see ::GameOfLife::Generators::Seed.generate_seed_data
+        # @see ::GameOfLife::Generators::Seed.populate
         def new(options)
-          fail NotImplementedError
+          width  = options["width"].to_i
+          height = options["height"].to_i
+          seed   = options["seed"].to_i
+          input  = generate_seed_data(seed: seed, width: width, height: height)
+          populate(input: input, width: width, height: height)
+        end
+
+        # Generate the seeding data for populating the {GameOfLife::Universe}
+        # @param seed [Integer] used to generate {Array<"0"|"1">} using Std ruby Random
+        # @param width [Integer] width of the generated cyclic universe
+        # @param height [Integer] height of the generated cyclic universe
+        # @return [Array<Array<True|False>>] covering the defined size of universe
+        # @see ::GameOfLife::Generators::Seed.populate
+        # @see https://ruby-doc.org/core-2.4.0/Random.html
+        private def generate_seed_data(seed:, width:, height:)
+          # Create a pseudo(stable) random generator from the seed
+          # Generate a sequence of bytes to cover the Game of Life Universe plane
+          # each byte can be unpacked into binary data string (ex. "01101011")
+          raw = Random.new(seed).bytes(width * height).unpack1("B*").split("").each_slice(width)
+          raw.map { |row| row.map { |char| char.eql?("1") } }
+        end
+
+        # Populate the {GameOfLife::Universe} with reference to the parsed input 2D array (True/False)
+        # @param input [Array<Array<True|False>>]
+        # @param width [Integer] width of the generated cyclic universe
+        # @param height [Integer] height of the generated cyclic universe
+        # @return [GameOfLife::Universe] populated with the parsed input
+        # @see ::GameOfLife::Generators::Seed.generate_seed_data
+        private def populate(input:, width:, height:)
+          # Generate a universe based on the parsed raw file and fill it with the cells
+          universe = GameOfLife::Universe.new(height: height, width: width)
+          (0...height).each do |i|
+            (0...width).each do |j|
+              cell = { x: j, y: i, alive: input.fetch(i, nil)&.fetch(j, nil) }
+              universe[i][j] = ::GameOfLife::Cell.new(cell)
+            end
+          end
+          universe
         end
       end
     end

data/lib/game_of_life/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module GameOfLife
-  VERSION = "0.1.0"
+  # Game of life version number
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal_game_of_life
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - a14m
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -130,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - README.md
 - bin/game-of-life
 - game_of_life.gemspec
@@ -147,7 +148,9 @@ 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:
+  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: 
 rdoc_options: []
 require_paths:
 - lib
@@ -155,15 +158,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.2.0
+signing_key: 
 specification_version: 4
 summary: Game of Life CLI
 test_files: []