rubiks-cli 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c637df3cabfd41e05567d2ea04f2dda7badd339f6f71074bbae2760e352728
-  data.tar.gz: 1654787c50b3927beab0e23bffe0e24628a11ce6afc606f7a0282e4900e5e7ea
+  metadata.gz: b31d0f5c4d03e00788128265b7dbb190583673563adce67252c202f9e114f0a5
+  data.tar.gz: 046d15a7724fa53739edf3c5dde5b226c925ab8ef419f50238b4b85515d732ff
 SHA512:
-  metadata.gz: 016ed9b7bd24db983bfef00b7c9879221bf512acc2f75812f2fcfbcc82a67fe32f08b73e7d0d13ff4b4f8a15801f612e7bd6c394dfb01cf5a2e4247078bfa1fe
-  data.tar.gz: a26afc05b890bbe5f7af0c6a5d1dcf676f47a2fec887cc0eee9caeafed6a67064bf42902cd266fbddda9a9e4a723a700ed7d7d8533474e0163a2432637bc3841
+  metadata.gz: 47d2f102cd05f55b0fc4cd36f47c1e3830c9541ec79e57b10121690a96f969b2a3fd1a50cd3975d2e2e5fe20b75dbce05989bb78097ff26b071f2f66a37a8f07
+  data.tar.gz: dc0b0fb6338108e15a47cb28752db0783ddd873ab71186c2ab8fdb33d41961780bc730217a28013207f68dc9232d8d1777a2393651a001402c8cf1aeb0e3d4b9

data/README.md

@@ -18,3 +18,4 @@ rubiks
 - Press any key to stop timing
 - Type 'n' for a new scramble  
 - Type 'q' to quit
+- Type 'h' or '?' for help (this message)

data/bin/rubiks

@@ -1,25 +1,49 @@
 #!/usr/bin/env ruby
-
+require 'optparse'
 require 'rubiks_cli'
 
-HELP = "Press Enter to start timing\nPress any key to stop timing\nType 'q' to quit\nType 'n' for a new scramble"
+options = {
+  scramble: false,
+  time: false,
+  loop: true,
+  clear: false,
+  wipe: false,
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: rubiks [options]"
+
+  opts.on("-s", "--scramble", "Generate scramble") do
+    options[:scramble] = true
+  end
+
+  opts.on("-t", "--time", "Start timer") do
+    options[:time] = true
+  end
 
-cmd = 'n'
+  opts.on("-l", "--loop", "Loop forever (default)") do
+    options[:loop] = true
+  end
 
-while true
-  RubiksCli::Timer.clear_screen
-  if cmd == ''
-    RubiksCli::Timer.start
-    cmd = 'n'
+  opts.on("-w", "--wipe", "Wipe output each loop iteration") do
+    options[:wipe] = true
   end
 
-  if cmd == 'n'
-    puts RubiksCli::Scrambler.get_scramble
-  elsif cmd.downcase == 'q'
-    break
-  else
-    puts HELP
+  opts.on("-c", "--clear", "Clear the screen before starting (default for --loop)") do
+    options[:clear] = true
   end
+end.parse!
+
+if options[:clear]
+  RubiksCli::Clear.screen
+end
 
-  cmd = gets.chomp
+if options[:scramble] && options[:time]
+  RubiksCli::Solve.solve
+elsif options[:scramble]
+  puts RubiksCli::Scrambler.get_scramble
+elsif options[:time]
+  RubiksCli::Timer.time
+else
+  RubiksCli::Clear.screen
+  RubiksCli::Solve.loop(options[:wipe])
 end

data/lib/rubiks_cli/clear.rb

@@ -0,0 +1,11 @@
+module RubiksCli
+  class Clear
+    def self.screen
+      system("clear") || system("cls")
+    end
+
+    def self.line_above
+      print "\e[1A\e[K\n"
+    end
+  end
+end

data/lib/rubiks_cli/help.rb

@@ -0,0 +1,9 @@
+module RubiksCli
+  class Help
+    LOOP = "Press Enter to start timing\nPress any key to stop timing\nType 'n' for a new scramble\nType 'c' to clear the screen\nType 'h' or '?' for this message\nType 'q' to quit"
+
+    def self.loop
+      puts LOOP
+    end
+  end 
+end

data/lib/rubiks_cli/scrambler.rb

@@ -24,8 +24,9 @@ module RubiksCli
       moves.join(", ")
     end
 
+    private
     def self.get_move
       FACES.sample + SUFFIXES.sample
     end
   end
-end
+end

data/lib/rubiks_cli/solve.rb

@@ -0,0 +1,49 @@
+require_relative 'clear'
+require_relative 'help'
+require_relative 'timer'
+require_relative 'scrambler' 
+
+module RubiksCli
+  class Solve
+    def self.solve
+        puts Scrambler.get_scramble
+        gets
+        Clear.line_above
+        Timer.show
+    end
+
+    def self.loop(clear_screen)
+      Help.loop
+      Kernel.loop do
+        begin
+          input = gets.chomp
+          clear_screen ? Clear.screen : Clear.line_above
+          process_input(input)
+        rescue SystemExit
+          exit
+        end
+      end
+    end
+
+    private
+    def self.process_input(cmd)
+      case cmd.downcase
+      when 'n'
+        puts Scrambler.get_scramble
+      when 'c'
+        Clear.screen
+      when 'h', '?'
+        Help.loop
+      when 'q'
+        raise SystemExit
+      else
+        Timer.show
+        puts "\n#{Scrambler.get_scramble}"
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  RubiksCli::Solve.solve
+end

data/lib/rubiks_cli/timer.rb

@@ -1,10 +1,10 @@
 require 'io/console'
+require_relative 'clear'
 
 module RubiksCli
   class Timer
-
-    def self.clear_screen
-      system("clear") || system("cls")
+    def self.show
+      puts "\r#{self.time.round(3)}"
     end
 
     def self.time
@@ -20,12 +20,5 @@ module RubiksCli
 
       return Time.now - start
     end
-
-    def self.start
-      clear_screen
-      time = Timer.time
-      clear_screen
-      puts time.round(3)
-    end
   end
-end
+end

data/lib/rubiks_cli/version.rb

@@ -1,3 +1,3 @@
 module RubiksCli
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

data/lib/rubiks_cli.rb

@@ -1,6 +1,9 @@
 require_relative "rubiks_cli/version"
 require_relative "rubiks_cli/scrambler"
 require_relative "rubiks_cli/timer"
+require_relative "rubiks_cli/clear"                  
+require_relative "rubiks_cli/help"                   
+require_relative "rubiks_cli/solve"
 
 module RubiksCli
-end
+end

data/rubiks-cli.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["noah.scott.24@ucl.ac.uk"]
   
   spec.summary       = "A command-line Rubik's Cube timer"
-  spec.description   = "A simple CLI tool for timing Rubik's Cube solves"
+  spec.description   = "A CLI tool for generating scrambles and timing Rubik's Cube solves"
   spec.homepage      = "https://github.com/noahsc0tt/rubiks-cli"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 2.7.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubiks-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Noah Scott
@@ -9,7 +9,7 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: A simple CLI tool for timing Rubik's Cube solves
+description: A CLI tool for generating scrambles and timing Rubik's Cube solves
 email:
 - noah.scott.24@ucl.ac.uk
 executables:
@@ -22,7 +22,10 @@ files:
 - Rakefile
 - bin/rubiks
 - lib/rubiks_cli.rb
+- lib/rubiks_cli/clear.rb
+- lib/rubiks_cli/help.rb
 - lib/rubiks_cli/scrambler.rb
+- lib/rubiks_cli/solve.rb
 - lib/rubiks_cli/timer.rb
 - lib/rubiks_cli/version.rb
 - rubiks-cli.gemspec