rubiks-cli 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b31d0f5c4d03e00788128265b7dbb190583673563adce67252c202f9e114f0a5
-  data.tar.gz: 046d15a7724fa53739edf3c5dde5b226c925ab8ef419f50238b4b85515d732ff
+  metadata.gz: b01173da4ddca951dac1a67a9d4eb4a872162ffebd3751fc89d30b5512128eb0
+  data.tar.gz: fd61a5af3f725ad9d042514ba252ab206ad3ffce7758acc709c58f68ace07a69
 SHA512:
-  metadata.gz: 47d2f102cd05f55b0fc4cd36f47c1e3830c9541ec79e57b10121690a96f969b2a3fd1a50cd3975d2e2e5fe20b75dbce05989bb78097ff26b071f2f66a37a8f07
-  data.tar.gz: dc0b0fb6338108e15a47cb28752db0783ddd873ab71186c2ab8fdb33d41961780bc730217a28013207f68dc9232d8d1777a2393651a001402c8cf1aeb0e3d4b9
+  metadata.gz: 288fa531855f4e33f79bf991893019614068ac46f314a250f812124927fe1752c4f4ba0544f28061014e53632c9541970c49a3007e9ec58e6d32c048ebed483e
+  data.tar.gz: 79dfc148a7ffbe9292942346f51585f6560f45c1f2b7ed1c7dc766c3e828b9e2d043264af70cb61235b6e4a081fc54eb8b10835217743d18684589704c78f64c

data/bin/rubiks

@@ -2,48 +2,87 @@
 require 'optparse'
 require 'rubiks_cli'
 
-options = {
-  scramble: false,
-  time: false,
-  loop: true,
-  clear: false,
-  wipe: false,
-}
+options = {}
+
 OptionParser.new do |opts|
   opts.banner = "Usage: rubiks [options]"
 
-  opts.on("-s", "--scramble", "Generate scramble") do
-    options[:scramble] = true
+  opts.on("-c", "--clear", "Clear the screen before starting") do
+    options[:clear] = true
   end
 
-  opts.on("-t", "--time", "Start timer") do
-    options[:time] = true
+  opts.on("-i", "--inspection", "Include inspection time") do
+    options[:inspection] = true
   end
 
-  opts.on("-l", "--loop", "Loop forever (default)") do
+  opts.on("-l", "--loop", "Loop forever") do
     options[:loop] = true
   end
 
-  opts.on("-w", "--wipe", "Wipe output each loop iteration") do
-    options[:wipe] = true
+  opts.on("-s", "--scramble", "Generate scramble") do
+    options[:scramble] = true
   end
 
-  opts.on("-c", "--clear", "Clear the screen before starting (default for --loop)") do
-    options[:clear] = true
+  opts.on("-t", "--time", "Start timer") do
+    options[:time] = true
   end
+
 end.parse!
 
-if options[:clear]
-  RubiksCli::Clear.screen
+if options.values.none?
+  options[:scramble] = true
+  options[:time] = true
 end
 
-if options[:scramble] && options[:time]
-  RubiksCli::Solve.solve
-elsif options[:scramble]
-  puts RubiksCli::Scrambler.get_scramble
-elsif options[:time]
-  RubiksCli::Timer.time
+RubiksCli::Clear.screen if options[:clear]
+
+output_scramble = lambda { puts RubiksCli::Scrambler.get_scramble }
+start_timer = lambda { RubiksCli::Timer.start(options[:inspection]) }
+start_timer_then_output_scramble = lambda {
+  RubiksCli::Timer.start(options[:inspection])
+  puts "\n#{RubiksCli::Scrambler.get_scramble}"
+}
+
+if options[:loop]
+
+  if options[:time] && options[:scramble]
+    RubiksCli::Clear.screen
+    RubiksCli::Loop.build(
+      RubiksCli::Loop.create_action('', start_timer_then_output_scramble, "start solve"),
+      [ RubiksCli::Loop.create_action('n', output_scramble, "generate new scramble"), ]
+    ).start
+
+  elsif options[:scramble]
+    RubiksCli::Clear.screen
+    RubiksCli::Loop.build(
+      RubiksCli::Loop.create_action('', output_scramble, "generate a scramble"),
+      [ RubiksCli::Loop.create_action('t', start_timer_then_output_scramble, "start timer"), ]
+    ).start
+
+  elsif options[:time]
+    RubiksCli::Clear.screen
+    RubiksCli::Loop.build(
+      RubiksCli::Loop.create_action('', start_timer, "start timer"),
+      [ RubiksCli::Loop.create_action('n', output_scramble, "generate a scramble"), ]
+    ).start
+
+  else
+    puts "Invalid options for loop mode: must specify --time and/or --scramble"
+  end
 else
-  RubiksCli::Clear.screen
-  RubiksCli::Solve.loop(options[:wipe])
+  if options[:time] && options[:scramble]
+    output_scramble.call
+    gets
+    RubiksCli::Clear.line_above
+    start_timer.call
+
+  elsif options[:scramble]
+    output_scramble.call
+
+  elsif options[:time]
+    start_timer.call
+
+  else
+  end
+
 end

data/lib/rubiks_cli/clear.rb

@@ -1,11 +1,15 @@
 module RubiksCli
-  class Clear
+  module 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\e[K\n"
+      print "\e[1A\r\e[K\n"
     end
   end
 end

data/lib/rubiks_cli/loop/action.rb

@@ -0,0 +1,19 @@
+require_relative '../clear'
+
+module RubiksCli
+  module Loop
+    class Action < Data.define(:command, :function, :help)
+      private_class_method :new
+    end
+
+    def self.create_action(command, function, description)
+        help = "Press '#{command}' to #{description}"
+        Action.send(:new, command, function, help)
+    end
+
+    DEFAULT_ACTIONS = [
+      create_action('c', RubiksCli::Clear.method(:screen), 'clear the screen'),
+      create_action('q', lambda { raise SystemExit }, 'quit'),
+    ]
+  end
+end

data/lib/rubiks_cli/loop/builder.rb

@@ -0,0 +1,16 @@
+require_relative 'action'
+require_relative 'engine'
+
+module RubiksCli
+  module Loop
+    private
+    def self.build_help_message(actions)
+      actions.map { |action| action.help }.join("\n")
+    end
+
+    def self.build(on_enter, actions)
+      help_action = create_action('h', -> { puts build_help_message(actions) }, "show this message")
+      Loop::Engine.send(:new, on_enter, actions += DEFAULT_ACTIONS << help_action)
+    end
+  end
+end

data/lib/rubiks_cli/loop/engine.rb

@@ -0,0 +1,40 @@
+require_relative '../clear'
+
+module RubiksCli
+  module Loop
+    class Engine
+      private_class_method :new
+
+      def initialize(action_on_enter, other_actions)
+        commands = other_actions.map { |action| action.command }
+        if commands.uniq.size != commands.size
+          raise ArgumentError, "Duplicate command"
+        end
+
+        @actions = Hash.new(action_on_enter.function)
+        other_actions.each { |action| @actions[action.command] = action.function }
+      end
+
+      def start
+        @actions['h'].call
+        loop do
+          input = gets.chomp.downcase
+          Clear.line_above
+          @actions[input].call
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  require_relative 'builder'
+
+  on_enter = lambda { puts "You pressed Enter!" }
+  actions = [
+    RubiksCli::Loop.build_action('x', -> { puts "Action X executed" }, "execute action X"),
+    RubiksCli::Loop.build_action('y', -> { puts "Action Y executed" }, "execute action Y"),
+  ]
+  loop_instance = RubiksCli::Loop.build_loop(on_enter, actions)
+  loop_instance.start
+end

data/lib/rubiks_cli/timer.rb

@@ -2,8 +2,14 @@ require 'io/console'
 require_relative 'clear'
 
 module RubiksCli
-  class Timer
-    def self.show
+  module Timer
+    INSPECTION_TIME = 15
+
+    def self.start(inspection)
+      if inspection
+        self.inspection
+      end
+      Clear.current_line
       puts "\r#{self.time.round(3)}"
     end
 
@@ -12,13 +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
+    end
+
+    def self.inspection
+      STDIN.raw do
+        (0...INSPECTION_TIME).each do |i|
+          print "\rInspection: #{i}"
+          return if STDIN.wait_readable(1)
+        end
 
-      return Time.now - start
+        print "\r+2"
+        2.times do
+          return if STDIN.wait_readable(1)
+        end
+        
+        print "\rDNF"
+      ensure
+        STDIN.getch rescue nil
+      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.2.0"
+  VERSION = "1.4.0"
 end

data/lib/rubiks_cli.rb

@@ -2,8 +2,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"
+require_relative "rubiks_cli/loop/builder"
+require_relative "rubiks_cli/loop/action"
+require_relative "rubiks_cli/loop/engine"
 
 module RubiksCli
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubiks-cli
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Noah Scott
@@ -23,9 +23,10 @@ files:
 - bin/rubiks
 - lib/rubiks_cli.rb
 - lib/rubiks_cli/clear.rb
-- lib/rubiks_cli/help.rb
+- lib/rubiks_cli/loop/action.rb
+- lib/rubiks_cli/loop/builder.rb
+- lib/rubiks_cli/loop/engine.rb
 - lib/rubiks_cli/scrambler.rb
-- lib/rubiks_cli/solve.rb
 - lib/rubiks_cli/timer.rb
 - lib/rubiks_cli/version.rb
 - rubiks-cli.gemspec

data/lib/rubiks_cli/help.rb

@@ -1,9 +0,0 @@
-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/solve.rb

@@ -1,49 +0,0 @@
-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