rubiks-cli 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72146381cce3abc1d2944045ca47fe73d75065fc31a51e2ce1cc1d219a7e1c6f
-  data.tar.gz: afd5ba94c045ab5c6acb9a1845f8b0c7695f85028beddd945bd21cf9e53d5359
+  metadata.gz: 94d7e949c32e1c1a2d7bb2b31da2e6ff4f99a54fcd61e1b2e973787501c7ccf3
+  data.tar.gz: b44f919f1db21605a46bf69809da069e8b322aa4ceda216dc94fe6d9a074c45f
 SHA512:
-  metadata.gz: 8d924fd2eafcc87b24ebe44b84045fedfefa1abea045cc1bebd45e83e9dfcc311d32fafaedd00bf608349c1566e3a141ad70f3c26f2df1f0057cbad4030c98cc
-  data.tar.gz: 66e7ac7bb6e1f382c641a1e201e5d27ca58d66b89a8429c8fb4e1d6ea8ab178edfe2ba36d996cc0def8934a24b8a541e518529a2ee0c7fcca354b3bda047c83e
+  metadata.gz: cd3db42e118df490e9336e9261da8a164ab574b0683117cd49fceb75d2a20876ce0b97d0bf593ed7de7214268dbcaaa37cef27d379e25b58a213bb2065db2a07
+  data.tar.gz: a7675552b1ed9c8734876fd37889bce8c500b7ec9fe5a4c18e1fe122a03e0aee3231d6165ac3581ddf327553955eb09e3cc65f215a738d74154f49ccba711bde

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,53 @@
 #!/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\nType 'h' or '?' for this message"
+options = {
+  clear: false,
+  inspection: false,
+  loop: true,
+  scramble: false,
+  time: false,
+  wipe: false,
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: rubiks [options]"
+
+  opts.on("-c", "--clear", "Clear the screen before starting") do
+    options[:clear] = true
+  end
 
-cmd = 'n'
+  opts.on("-i", "--inspection", "Include inspection time") do
+    options[:inspection] = true
+  end
 
-while true
-  RubiksCli::Timer.clear_screen
+  opts.on("-l", "--loop", "Loop forever") do
+    options[:loop] = true
+  end
 
-  case cmd.downcase
-  when 'n'
-    puts RubiksCli::Scrambler.get_scramble
-  when 'q'
-    break
-  when 'h', '?'
-    puts HELP
-  else
-    RubiksCli::Timer.start
-    puts RubiksCli::Scrambler.get_scramble
+  opts.on("-s", "--scramble", "Generate scramble") do
+    options[:scramble] = true
   end
 
-  cmd = gets.chomp
+  opts.on("-t", "--time", "Start timer") do
+    options[:time] = true
+  end
+
+  opts.on("-w", "--wipe", "Wipe output each loop iteration") do
+    options[:wipe] = true
+  end
+
+end.parse!
+
+RubiksCli::Clear.screen if options[:clear]
+
+if options[:scramble] && options[:time]
+  RubiksCli::Solve.solve(options[:inspection])
+elsif options[:scramble]
+  puts RubiksCli::Scrambler.get_scramble
+elsif options[:time]
+  RubiksCli::Timer.start(options[:inspection])
+else
+  RubiksCli::Clear.screen
+  RubiksCli::Solve.loop(options[:wipe], options[:inspection])
 end

data/lib/rubiks_cli/clear.rb

@@ -0,0 +1,15 @@
+module RubiksCli
+  class Clear
+    def self.screen
+      system("clear") || system("cls")
+    end
+
+    def self.current_line
+      print "\r\e[K"
+    end
+
+    def self.line_above
+      print "\e[1A\r\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(inspection)
+        puts Scrambler.get_scramble
+        gets
+        Clear.line_above
+        Timer.start(inspection)
+    end
+
+    def self.loop(clear_screen, inspection)
+      Help.loop
+      Kernel.loop do
+        begin
+          input = gets.chomp
+          clear_screen ? Clear.screen : Clear.line_above
+          process_input(input, inspection)
+        rescue SystemExit
+          exit
+        end
+      end
+    end
+
+    private
+    def self.process_input(cmd, inspection)
+      case cmd.downcase
+      when 'n'
+        puts Scrambler.get_scramble
+      when 'c'
+        Clear.screen
+      when 'h', '?'
+        Help.loop
+      when 'q'
+        raise SystemExit
+      else
+        Timer.start(inspection)
+        puts "\n#{Scrambler.get_scramble}"
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  RubiksCli::Solve.loop(true, false)
+end

data/lib/rubiks_cli/timer.rb

@@ -1,10 +1,16 @@
 require 'io/console'
+require_relative 'clear'
 
 module RubiksCli
   class Timer
+    INSPECTION_TIME = 15
 
-    def self.clear_screen
-      system("clear") || system("cls")
+    def self.start(inspection)
+      if inspection
+        self.inspection
+      end
+      Clear.current_line
+      puts "\r#{self.time.round(3)}"
     end
 
     def self.time
@@ -12,20 +18,35 @@ module RubiksCli
 
       STDIN.raw do
         loop do
-          print "\r#{(Time.now - start).round(1)}"
-          break if STDIN.wait_readable(0.01)
+          elapsed = Time.now - start
+          print "\r#{elapsed.round(1)}"
+          return elapsed if STDIN.wait_readable(0.1)
         end
-        STDIN.read_nonblock(1) rescue nil
+      ensure
+        STDIN.getch rescue nil
       end
-
-      return Time.now - start
     end
 
-    def self.start
-      clear_screen
-      time = Timer.time
-      clear_screen
-      puts time.round(3)
+    def self.inspection
+      STDIN.raw do
+        (0...INSPECTION_TIME).each do |i|
+          print "\rInspection: #{i}"
+          return if STDIN.wait_readable(1)
+        end
+
+        print "\r+2"
+        2.times do
+          return if STDIN.wait_readable(1)
+        end
+        
+        print "\rDNF"
+      ensure
+        STDIN.getch rescue nil
+      end
     end
   end
-end
+end
+
+if __FILE__ == $0
+  RubiksCli::Timer.start(true)
+end

data/lib/rubiks_cli/version.rb

@@ -1,3 +1,3 @@
 module RubiksCli
-  VERSION = "1.1.0"
+  VERSION = "1.3.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.1.0
+  version: 1.3.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