terminal_game_of_life 0.1.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac2c8c38b2299e6eb97af42e51429af726ad8b3e71707a77ab9af261a736e7c
-  data.tar.gz: 9d733ec099d7494fe862efc6c8cac5609a82e775c12523bbf7acfe70deca0147
+  metadata.gz: 2c26cd26c1b4aa435be502ab5d4490f9aac0c9b7213349daa3c7c74ff284a62b
+  data.tar.gz: bb7b96d7d61c2d77bb0d23fc900abe6484553f8f8aff384033fa9cba3b2b9d6e
 SHA512:
-  metadata.gz: 25a07b67279a9843072a1667dfc8be1ba73ef8ae6e6c38d6ccd837e5f77adbf9685d2a6693083fe0b0cb21ea5ccd4723f008e1615f9a666483efdf029cff6921
-  data.tar.gz: 5062f9fbc8ce2d3c74af9692b7639cda2f3ff98f3a77e8430bc453130bd313c9ba27eef34f4573ee41a6d9a5cdce8a08ca27a24a882045f16295ea1cf7da7e48
+  metadata.gz: 400bfb3d4e758c4b610bbbee25d839969ea9ee2c1e68c5c0d3a29e51d90e3e4cd42d113c2d8f80ab2c89e539c7091220abdbd8cc70fe66c9c9209f163fc8cdbb
+  data.tar.gz: af2edea622e9325201e4c9380b9fea8ebeedb749d6b0cbaaa6b59d154568c5049dac14033c6843cb18242f472a272904eaaa18db7de175e070341e86b2a6db46

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`

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
@@ -20,30 +19,22 @@ 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",
                             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"
   def start
-    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],
-      "seed" => rand(100_000),
-    }.merge(options)
-
-    universe = GameOfLife.generate(options_with_console_defaults)
+    universe = GameOfLife.generate(GameOfLife.parsed_options(options))
     GameOfLife.run(universe)
   end
 

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,50 @@ 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
+
+      {
+        # 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 +94,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

@@ -14,15 +14,27 @@ 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
@@ -31,16 +43,17 @@ module GameOfLife
         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, "Seed option isn't implemented yet, please use --input option"
+          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.2"
+  # Game of life version number
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal_game_of_life
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.2
 platform: ruby
 authors:
 - a14m
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2020-12-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
@@ -130,6 +172,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - README.md
 - bin/game-of-life
 - game_of_life.gemspec
@@ -140,13 +183,15 @@ 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://git.sr.ht/~a14m/game-of-life/tree/master/CLI/ruby/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -155,14 +200,14 @@ 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
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Game of Life CLI