vimgolf 0.3.0 → 0.4.0

data/lib/vimgolf.rb

@@ -7,5 +7,6 @@ require 'thor'
 require 'vimgolf/version'
 require 'vimgolf/config'
 require 'vimgolf/keylog'
+require 'vimgolf/challenge'
 require 'vimgolf/cli'
-require 'vimgolf/ui'
+require 'vimgolf/ui'

data/lib/vimgolf/challenge.rb

@@ -0,0 +1,108 @@
+module VimGolf
+  class Challenge
+    attr_reader :id, :type
+
+    def self.path(path)
+      @@path = path if path
+      @@path
+    end
+
+    def initialize(id)
+      @id = id
+    end
+
+    def download
+      begin
+        url = URI.parse("#{GOLFHOST}/challenges/#{@id}.yaml")
+        req = Net::HTTP::Get.new(url.path)
+
+        proxy_url, proxy_user, proxy_pass = get_proxy
+        proxy = Net::HTTP::Proxy(proxy_url.host, proxy_url.port, proxy_user, proxy_pass)
+        res = proxy.start(url.host, url.port) { |http| http.request(req) }
+
+        @data = YAML.load(res.body)
+
+        if !@data.is_a? Hash
+          raise
+
+        elsif @data['client'] != Vimgolf::VERSION
+          VimGolf.ui.error "Client version mismatch. Installed: #{Vimgolf::VERSION}, Required: #{@data['client']}."
+          VimGolf.ui.error "\t gem install vimgolf"
+          raise "Bad Version"
+        end
+
+        @type = @data['in']['type']
+        save
+        start
+      rescue Exception => e
+        debug(e)
+        raise "Uh oh, couldn't download or parse challenge, please verify your challenge id & client version."
+      end
+    end
+
+    def start
+      File.open(work_path, "w")  {|f| f.puts @data['in']['data']}
+    end
+
+    def save
+      File.open(input_path, "w")  {|f| f.puts @data['in']['data']}
+      File.open(output_path, "w") {|f| f.puts @data['out']['data']}
+      File.open(vimrc_path, "w")  {|f| f.puts @data['vimrc']}
+    end
+
+    def upload
+      begin
+        url = URI.parse("#{GOLFHOST}/entry.yaml")
+
+        proxy_url, proxy_user, proxy_pass = get_proxy
+        proxy = Net::HTTP::Proxy(proxy_url.host, proxy_url.port, proxy_user, proxy_pass)
+
+        proxy.start(url.host, url.port) do |http|
+          request = Net::HTTP::Post.new(url.request_uri)
+          request.set_form_data({"challenge_id" => @id, "apikey" => Config.load['key'], "entry" => IO.read(log_path)})
+          request["Accept"] = "text/yaml"
+
+          res = http.request(request)
+          res = YAML.load(res.body)
+
+          raise if !res.is_a? Hash
+          res['status'].to_sym
+
+        end
+      rescue Exception => e
+        debug(e)
+        raise "Uh oh, entry upload has failed, please check your key."
+      end
+    end
+
+    def input_path;  path + ".#{@type}"; end
+    def work_path;   path + ".work.#{@type}"; end
+    def output_path; path + ".output"; end
+    def log_path;    path + ".log";    end
+    def vimrc_path;  path + ".golfrc"; end
+
+    def path
+      @@path + "/#{@id}"
+    end
+
+    private
+      def get_proxy
+        begin
+          proxy_url = URI.parse(PROXY)
+        rescue Exception => e
+          VimGolf.ui.error "Invalid proxy uri in http_proxy environment variable - will try to run with out proxy"
+          proxy_url = URI.parse("");
+        end
+
+        proxy_url.port ||= 80
+        proxy_user, proxy_pass = proxy_url.userinfo.split(/:/) if proxy_url.userinfo
+
+        return proxy_url, proxy_user, proxy_pass
+      end
+
+      def debug(msg)
+        p [caller.first, msg] if GOLFDEBUG
+      end
+
+  end
+end

data/lib/vimgolf/cli.rb

@@ -1,14 +1,17 @@
 module VimGolf
 
-  GOLFHOST  = ENV['GOLFHOST'] || "http://vimgolf.com"
-  GOLFDEBUG = ENV['GOLFDEBUG'].to_sym rescue false
-  GOLFDIFF  = ENV['GOFLDIFF'] || 'diff'
-  GOLFVIM   = ENV['GOLFVIM'] || 'vim'
-  PROXY     = ENV['http_proxy'] || ''
+  GOLFDEBUG    = ENV['GOLFDEBUG'].to_sym rescue false
+  GOLFHOST     = ENV['GOLFHOST']     || "http://vimgolf.com"
+  GOLFDIFF     = ENV['GOLFDIFF']     || 'diff'
+  GOLFSHOWDIFF = ENV['GOLFSHOWDIFF'] || 'vim -d -n'
+  GOLFVIM      = ENV['GOLFVIM']      || 'vim'
+  PROXY        = ENV['http_proxy']   || ''
 
   class Error
   end
 
+  class RetryException < Exception; end
+
   class UI
     def debug(*); end
   end
@@ -60,39 +63,53 @@ module VimGolf
     DESC
 
     def put(id = nil)
-      VimGolf.ui.warn "Launching VimGolf session for challenge: #{id}"
+      VimGolf.ui.warn "Downloading Vimgolf challenge: #{id}"
+      VimGolf::Challenge.path(Config.put_path)
+      challenge = Challenge.new(id)
+      challenge.download
 
       begin
-        type = download(id)
-
+        VimGolf.ui.warn "Launching VimGolf session for challenge: #{id}"
         # - n - no swap file, memory only editing
         # - +0 - always start on line 0
         # - --noplugin - don't load any plugins, lets be fair!
         # -i NONE - don't load .viminfo (for saved macros and the like)
         # - u - load vimgolf .vimrc to level the playing field
-        vimcmd = "#{GOLFVIM} -n --noplugin -i NONE +0 -u \"#{vimrc(id)}\" -W \"#{log(id)}\" \"#{input(id, type)}\""
+        vimcmd = "#{GOLFVIM} -Z -n --noplugin -i NONE +0 -u \"#{vimrc(id)}\" -W \"#{log(id)}\" \"#{input(id, type)}\""
         debug(vimcmd)
         system(vimcmd)
 
         if $?.exitstatus.zero?
-          diff = `#{GOLFDIFF} \"#{input(id, type)}\" \"#{output(id)}\"`
-          score = Keylog.score(IO.read(log(id)))
+          diff_files = "\"#{challenge.work_path}\" \"#{challenge.output_path}\""
+          diff = `#{GOLFDIFF} #{diff_files}`
+          log = Keylog.new(IO.read(challenge.log_path))
 
           if diff.size > 0
-            VimGolf.ui.warn "Uh oh, looks like your entry does not match the desired output:"
-            VimGolf.ui.warn "#"*50
-            puts diff
-            VimGolf.ui.warn "#"*50
-            VimGolf.ui.warn "Please try again! Your score for this (failed) attempt was: #{score}"
-            return
+            VimGolf.ui.warn "Uh oh, looks like your entry does not match the desired output."
+            loop do
+              case VimGolf.ui.ask_question "Would you like to see a [d]iff or [r]etry or [q]uit ?",
+                                  :type      => :warn,
+                                  :choices   => [:diff, :retry, :quit]
+              when :diff
+                VimGolf.ui.warn "Showing vimdiff of your attempt (left) and correct output (right)"
+                system("#{GOLFSHOWDIFF} #{diff_files}")
+              when :retry
+                VimGolf.ui.warn "Your score for this (failed) attempt was: #{log.score}. Let's try again!!\n#{'#'*50}"
+                challenge.start
+                raise RetryException
+              when :quit
+                VimGolf.ui.warn "Please try again! Your score for this (failed) attempt was: #{log.score}"
+                return
+              end
+            end
           end
 
-          VimGolf.ui.info "Success! Your output matches. Your score: #{score}"
+          VimGolf.ui.info "Success! Your output matches. Your score: #{log.score}"
 
           if VimGolf.ui.yes? "Upload result to VimGolf? (yes / no)"
             VimGolf.ui.warn "Uploading to VimGolf..."
 
-            if upload(id) == :ok
+            if challenge.upload == :ok
               VimGolf.ui.info "Uploaded entry, thanks for golfing!"
               VimGolf.ui.info "View the leaderboard: #{GOLFHOST}/challenges/#{id}"
             else
@@ -112,97 +129,19 @@ module VimGolf
           VimGolf.ui.error error
         end
 
-      rescue Exception => e
-        VimGolf.ui.error "Uh oh, something went wrong! Error: #{e}"
-        VimGolf.ui.error "If the error persists, please report it to github.com/igrigorik/vimgolf"
-      end
-    end
-
-    no_tasks do
-      def download(id)
-        begin
-          url = URI.parse("#{GOLFHOST}/challenges/#{id}.yaml")
-          req = Net::HTTP::Get.new(url.path)
-
-          proxy_url, proxy_user, proxy_pass = get_proxy
-          proxy = Net::HTTP::Proxy(proxy_url.host, proxy_url.port, proxy_user, proxy_pass)
-          res = proxy.start(url.host, url.port) { |http| http.request(req) }
-
-          data = YAML.load(res.body)
-
-          if !data.is_a? Hash
-            raise
-
-          elsif data['client'] != Vimgolf::VERSION
-            VimGolf.ui.error "Client version mismatch. Installed: #{Vimgolf::VERSION}, Required: #{data['client']}."
-            VimGolf.ui.error "\t gem install vimgolf"
-            raise "Bad Version"
-          end
-
-          File.open(Config.put_path + "/#{id}.#{data['in']['type']}", "w") {|f| f.puts data['in']['data']}
-          File.open(Config.put_path + "/#{id}.output", "w") {|f| f.puts data['out']['data']}
-          File.open(Config.put_path + "/#{id}.golfrc", "w") {|f| f.puts data['vimrc']}
-
-          data['in']['type']
-
-        rescue Exception => e
-          debug(e)
-          raise "Uh oh, couldn't download or parse challenge, please verify your challenge id & client version."
-        end
+      rescue RetryException => e
+        retry
       end
 
-      def upload(id)
-        begin
-          url = URI.parse("#{GOLFHOST}/entry.yaml")
-
-          proxy_url, proxy_user, proxy_pass = get_proxy
-          proxy = Net::HTTP::Proxy(proxy_url.host, proxy_url.port, proxy_user, proxy_pass)
-
-          proxy.start(url.host, url.port) do |http|
-            request = Net::HTTP::Post.new(url.request_uri)
-            request.set_form_data({"challenge_id" => id, "apikey" => Config.load['key'], "entry" => IO.read(log(id))})
-            request["Accept"] = "text/yaml"
-
-            res = http.request(request)
-            res = YAML.load(res.body)
-
-            raise if !res.is_a? Hash
-            res['status'].to_sym
-
-          end
-        rescue Exception => e
-          debug(e)
-          raise "Uh oh, entry upload has failed, please check your key."
-        end
-      end
+    rescue Exception => e
+      VimGolf.ui.error "Uh oh, something went wrong! Error: #{e}"
+      VimGolf.ui.error "If the error persists, please report it to github.com/igrigorik/vimgolf"
     end
 
     private
-      def input(id, type);  challenge(id) + ".#{type}"; end
-      def output(id); challenge(id) + ".output"; end
-      def log(id);    challenge(id) + ".log";    end
-      def vimrc(id);  challenge(id) + ".golfrc"; end
-
-      def challenge(id)
-        Config.put_path + "/#{id}"
-      end
-
-      def get_proxy
-        begin
-          proxy_url = URI.parse(PROXY)
-        rescue Exception => e
-          VimGolf.ui.error "Invalid proxy uri in http_proxy environment variable - will try to run with out proxy"
-          proxy_url = URI.parse("");
-        end
-
-        proxy_url.port ||= 80
-        proxy_user, proxy_pass = proxy_url.userinfo.split(/:/) if proxy_url.userinfo
-
-        return proxy_url, proxy_user, proxy_pass
-      end
-
       def debug(msg)
         p [caller.first, msg] if GOLFDEBUG
       end
   end
-end
+
+end

data/lib/vimgolf/keylog.rb

@@ -1,29 +1,20 @@
 module VimGolf
-  class Session < Array
-    def to_s(sep = '')
-      @log.join(sep)
-    end
-  end
-
   class Keylog
-    def self.parse(input)
-      session = Session.new
-      scan(input) {|s| session << s }
-      session
-    end
+    include Enumerable
+
+    alias_method :convert , :to_s
+    alias_method :score   , :count
 
-    def self.convert(input)
-      parse(input).join('')
+    def initialize(input)
+      @input = input
     end
 
-    def self.score(input)
-      keys = 0
-      scan(input) {|s| keys += 1 }
-      keys
+    def to_s(sep = '')
+      to_a.join(sep)
     end
 
-    def self.scan(input)
-      scanner = StringScanner.new(input)
+    def each
+      scanner = StringScanner.new(@input)
       output = ""
 
       until scanner.eos?
@@ -37,9 +28,9 @@ module VimGolf
           when 0x80
             code = scanner.get_byte + scanner.get_byte
 
-            # This list has been populated by experimentation so far,
-            # because I haven't bothered looking for a more authoritative
-            # source.
+            # This list has been populated by looking at
+            # :h terminal-options and vim source files:
+            # keymap.h and misc2.c
             case code
               when "k1"; "<F1>"
               when "k2"; "<F2>"
@@ -53,6 +44,38 @@ module VimGolf
               when "k;"; "<F10>"
               when "F1"; "<F11>"
               when "F2"; "<F12>"
+              when "F3"; "<F13>"
+              when "F4"; "<F14>"
+              when "F5"; "<F15>"
+              when "F6"; "<F16>"
+              when "F7"; "<F17>"
+              when "F8"; "<F18>"
+              when "F9"; "<F19>"
+
+              when "%1"; "<Help>"
+              when "&8"; "<Undo>"
+              when "#2"; "<S-Home>"
+              when "*7"; "<S-End>"
+              when "K1"; "<kHome>"
+              when "K4"; "<kEnd>"
+              when "K3"; "<kPageUp>"
+              when "K5"; "<kPageDown>"
+              when "K6"; "<kPlus>"
+              when "K7"; "<kMinus>"
+              when "K8"; "<kDivide>"
+              when "K9"; "<kMultiply>"
+              when "KA"; "<kEnter>"
+              when "KB"; "<kPoint>"
+              when "KC"; "<k0>"
+              when "KD"; "<k1>"
+              when "KE"; "<k2>"
+              when "KF"; "<k3>"
+              when "KG"; "<k4>"
+              when "KH"; "<k5>"
+              when "KI"; "<k6>"
+              when "KJ"; "<k7>"
+              when "KK"; "<k8>"
+              when "KL"; "<k9>"
 
               when "kP"; "<PageUp>"
               when "kN"; "<PageDown>"
@@ -70,7 +93,104 @@ module VimGolf
               when "%i"; "<S-Right>"
 
               when "kB"; "<S-Tab>"
-              when "\xffX"; "<C-Space>"
+              when "\xffX"; "<C-@>"
+
+              when "\xfd\x4"; "<S-Up>"
+              when "\xfd\x5"; "<S-Down>"
+              when "\xfd\x6"; "<S-F1>"
+              when "\xfd\x7"; "<S-F2>"
+              when "\xfd\x8"; "<S-F3>"
+              when "\xfd\x9"; "<S-F4>"
+              when "\xfd\xa"; "<S-F5>"
+              when "\xfd\xb"; "<S-F6>"
+              when "\xfd\xc"; "<S-F7>"
+              when "\xfd\xd"; "<S-F9>"
+              when "\xfd\xe"; "<S-F10>"
+              when "\xfd\xf"; "<S-F10>"
+              when "\xfd\x10"; "<S-F11>"
+              when "\xfd\x11"; "<S-F12>"
+              when "\xfd\x12"; "<S-F13>"
+              when "\xfd\x13"; "<S-F14>"
+              when "\xfd\x14"; "<S-F15>"
+              when "\xfd\x15"; "<S-F16>"
+              when "\xfd\x16"; "<S-F17>"
+              when "\xfd\x17"; "<S-F18>"
+              when "\xfd\x18"; "<S-F19>"
+              when "\xfd\x19"; "<S-F20>"
+              when "\xfd\x1a"; "<S-F21>"
+              when "\xfd\x1b"; "<S-F22>"
+              when "\xfd\x1c"; "<S-F23>"
+              when "\xfd\x1d"; "<S-F24>"
+              when "\xfd\x1e"; "<S-F25>"
+              when "\xfd\x1f"; "<S-F26>"
+              when "\xfd\x20"; "<S-F27>"
+              when "\xfd\x21"; "<S-F28>"
+              when "\xfd\x22"; "<S-F29>"
+              when "\xfd\x23"; "<S-F30>"
+              when "\xfd\x24"; "<S-F31>"
+              when "\xfd\x25"; "<S-F32>"
+              when "\xfd\x26"; "<S-F33>"
+              when "\xfd\x27"; "<S-F34>"
+              when "\xfd\x28"; "<S-F35>"
+              when "\xfd\x29"; "<S-F36>"
+              when "\xfd\x2a"; "<S-F37>"
+              when "\xfd\x2b"; "<Mouse>"
+              when "\xfd\x2c"; "<LeftMouse>"
+              when "\xfd\x2d"; "<LeftDrag>"
+              when "\xfd\x2e"; "<LeftRelease>"
+              when "\xfd\x2f"; "<MiddleMouse>"
+              when "\xfd\x30"; "<MiddleDrag>"
+              when "\xfd\x31"; "<MiddleRelease>"
+              when "\xfd\x32"; "<RightMouse>"
+              when "\xfd\x33"; "<RightDrag>"
+              when "\xfd\x34"; "<RightRelease>"
+              #when "\xfd\x35"; "KE_IGNORE"
+              #when "\xfd\x36"; "KE_TAB"
+              #when "\xfd\x37"; "KE_S_TAB_OLD"
+              #when "\xfd\x38"; "KE_SNIFF"
+              #when "\xfd\x39"; "KE_XF1"
+              #when "\xfd\x3a"; "KE_XF2"
+              #when "\xfd\x3b"; "KE_XF3"
+              #when "\xfd\x3c"; "KE_XF4"
+              #when "\xfd\x3d"; "KE_XEND"
+              #when "\xfd\x3e"; "KE_ZEND"
+              #when "\xfd\x3f"; "KE_XHOME"
+              #when "\xfd\x40"; "KE_ZHOME"
+              #when "\xfd\x41"; "KE_XUP"
+              #when "\xfd\x42"; "KE_XDOWN"
+              #when "\xfd\x43"; "KE_XLEFT"
+              #when "\xfd\x44"; "KE_XRIGHT"
+              #when "\xfd\x45"; "KE_LEFTMOUSE_NM"
+              #when "\xfd\x46"; "KE_LEFTRELEASE_NM"
+              #when "\xfd\x47"; "KE_S_XF1"
+              #when "\xfd\x48"; "KE_S_XF2"
+              #when "\xfd\x49"; "KE_S_XF3"
+              #when "\xfd\x4a"; "KE_S_XF4"
+              when "\xfd\x4b"; "<MouseDown>"
+              when "\xfd\x4c"; "<MouseUp>"
+              when "\xfd\x4d"; "<MouseLeft>"
+              when "\xfd\x4e"; "<MouseRight>"
+              #when "\xfd\x4f"; "KE_KINS"
+              #when "\xfd\x50"; "KE_KDEL"
+              #when "\xfd\x51"; "KE_CSI"
+              #when "\xfd\x52"; "KE_SNR"
+              #when "\xfd\x53"; "KE_PLUG"
+              #when "\xfd\x54"; "KE_CMDWIN"
+              when "\xfd\x55"; "<C-Left>"
+              when "\xfd\x56"; "<C-Right>"
+              when "\xfd\x57"; "<C-Home>"
+              when "\xfd\x58"; "<C-End>"
+              #when "\xfd\x59"; "KE_X1MOUSE"
+              #when "\xfd\x5a"; "KE_X1DRAG"
+              #when "\xfd\x5b"; "KE_X1RELEASE"
+              #when "\xfd\x5c"; "KE_X2MOUSE"
+              #when "\xfd\x5d"; "KE_X2DRAG"
+              #when "\xfd\x5e"; "KE_X2RELEASE"
+              #when "\xfd\x5f"; "KE_DROP"
+              #when "\xfd\x5e"; "KE_CURSORHOLD"
+              #when "\xfd\x61"; "KE_NOP"
+              when "\xfd\x62"; nil # Focus Gained (GVIM)
+              when "\xfd\x63"; nil # Focus Lost (GVIM)
 
               else
                 #puts "Unknown Vim code: #{code.inspect}"
@@ -98,7 +218,7 @@ module VimGolf
 
         end
 
-        yield out_char
+        yield out_char if out_char
       end
     end
   end