vimgolf 0.4.1 → 0.4.2

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "emacs/util/espuds"]
+	path = emacs/util/espuds
+	url = https://github.com/rejeep/espuds

data/emacs/features/emacs.feature

@@ -0,0 +1,24 @@
+Feature: VimGolf Browser
+  In order to browse and select VimGolf entries
+  As a user
+  I want to use the VimGolf browser
+  
+  Scenario: Press TAB on entry to view description
+    Given I open the vimgolf browser
+    Then I should not see "Continuing from the last challenge"
+    When I press "TAB"
+    Then I should see "Continuing from the last challenge"
+    When I press "TAB"
+    Then I should not see "Continuing from the last challenge"
+    
+  Scenario: Move through the browse list
+    Given I open the vimgolf browser
+    Then the cursor should be before "Compl"
+    When I press "n"
+    Then the cursor should be before "Make "
+    When I press "n"
+    Then the cursor should be before "Conve"
+    When I press "p"
+    Then the cursor should be before "Make "
+    When I press "p"
+    Then the cursor should be before "Compl"

data/emacs/features/step-definitions/emacs-steps.el

@@ -0,0 +1,53 @@
+;; This file contains your project specific step definitions. All
+;; files in this directory whose names end with "-steps.el" will be
+;; loaded automatically by Ecukes.
+
+(Given "^I open the vimgolf browser$"
+       (lambda ()
+         (setq *vimgolf-browse-list*
+                '(("50128129201f450002000027"
+                   "Complete the circuit grid!"
+                   "Continuing from the last challenge, add additional rows to the grid. Change each of the names from 'A1'...'A10' to 'B1'...'B10', 'C1'...'C10', etc, and for each new row add 0.7 to the X values in the (X Y) at the end of each line. ")
+                  ("50127eba201f450002000024"
+                   "Make the circuit grid!"
+                   "Copy this command for a circuit layout program to create 10 total smd commands. Increment the number in quotes to name each pad, and add 0.7 to each of the (X Y) coordinates at the end of each line.")
+                  ("500855e60599d90002000073"
+                   "Convert pandoc unordered list to a numbered list"
+                   "I know it's possible to use #. in pandoc to auto-generate numbered lists, but then it's not easy to tell how many items there are when reading it in Markdown. How fast can you make the switch?")
+                  ("4fe62f8a8b2f800001000043"
+                   "Cleanining up 80 column concatenated text"
+                   "1. Put the whole query on one line, remove the concatenation operators
+                  ("4d1b4ac3c58eaa2a8a0005c2"
+                   "Ruby 1.9 compat"
+                   "Remember when Ruby supported `when <expr> :`? Well, it doesn't in 1.9, so let's make sure we use `then`, without ruining our lovely new hash syntax!")
+                  ))
+         (vimgolf-browse)))
+
+(When "^I show the description$"
+      (lambda ()
+        (vimgolf-show-description)))
+
+(Given "^I have \"\\(.+\\)\"$"
+       (lambda (something)
+         ;; Do something
+         ))
+
+(When "^I have \"\\(.+\\)\"$"
+      (lambda (something)
+        ;; Do something
+        ))
+
+(Then "^I should have \"\\(.+\\)\"$"
+      (lambda (something)
+        ;; Do something
+        ))
+
+(And "^I have \"\\(.+\\)\"$"
+     (lambda (something)
+       ;; Do something
+       ))
+
+(But "^I should not have \"\\(.+\\)\"$"
+     (lambda (something)
+       ;; Do something
+       ))

data/emacs/features/support/env.el

@@ -0,0 +1,37 @@
+;; This is an example of how you could set up this file. This setup
+;; requires a directory called util in the project root and that the
+;; util directory contains the testing tools ert and espuds.
+
+(let* ((features-directory
+        (file-name-directory
+         (directory-file-name (file-name-directory load-file-name))))
+       (project-directory
+        (file-name-directory
+         (directory-file-name features-directory))))
+  (setq emacs-root-path project-directory)
+  (setq emacs-util-path (expand-file-name "util" emacs-root-path)))
+
+(add-to-list 'load-path emacs-root-path)
+(add-to-list 'load-path (expand-file-name "espuds" emacs-util-path))
+(add-to-list 'load-path (expand-file-name "ert" emacs-util-path))
+
+(require 'vimgolf)
+(require 'espuds)
+(require 'ert)
+
+
+(Setup
+ ;; Before anything has run
+ )
+
+(Before
+ ;; Before each scenario is run
+ )
+
+(After
+ ;; After each scenario is run
+ )
+
+(Teardown
+ ;; After when everything has been run
+ )

data/emacs/todo.org

@@ -0,0 +1,45 @@
+* VimGolf TODO
+
+** Game Excersizes
+
+** Browser
+*** DONE Handle/fix character encoding
+    CLOSED: [2012-07-28 Sat 23:07]
+    :LOGBOOK:
+    - State "DONE"       from "TODO"       [2012-07-28 Sat 23:07] \\
+      Added a utility function to handling &lt, &gt, &amp, and &quot.
+    :END:
+    Things like < and >, etc.
+*** DONE Fix line endings
+    CLOSED: [2012-07-28 Sat 22:51]
+    :LOGBOOK:
+    - State "DONE"       from "TODO"       [2012-07-28 Sat 22:51] \\
+      Added a function to replace ^M with some replacement (default space).
+      Currently only running this function on entry descriptions.
+    :END:
+    Need to convert ^M characters
+*** DONE Add/fix line wrapping
+    CLOSED: [2012-07-28 Sat 22:04]
+    :LOGBOOK:
+    - State "DONE"       from "TODO"       [2012-07-28 Sat 22:04]
+    :END:
+    Can't assume that everyone's emacs will be set the same. Should really set a
+    particular fill-column and enforce it.
+*** DONE Truncate long titles
+    CLOSED: [2012-07-28 Sat 22:21]
+    :LOGBOOK:
+    - State "DONE"       from "IN PROGRESS" [2012-07-28 Sat 22:21]
+    - State "IN PROGRESS" from "TODO"       [2012-07-28 Sat 22:09]
+    :END:
+    Use ellipses to truncate titles that would normally be longer than the
+    fill-column width.
+*** DONE When first loading (via url-retrieve), list isn't showing after the call
+    CLOSED: [2012-07-28 Sat 23:11]
+    :LOGBOOK:
+    - State "DONE"       from "TODO"       [2012-07-28 Sat 23:11] \\
+      The list insertion was happening outside of the async callback. Now it happens
+      during the callback (if url-retrieve is used) and during the browse function
+      itself (if not).
+    :END:
+    I'm not sure if the call back isn't working or what. Manually refreshing
+    will display the list.

data/emacs/vimgolf.el

@@ -1,11 +1,10 @@
 ;;; vimgolf.el --- VimGolf interface for the One True Editor
-
 ;; Copyright (C) never, by no one
 
 ;;; Author: Tim Visher <tim.visher@gmail.com>
 ;;; Maintainer: Tim Visher <tim.visher@gmail.com>
 ;;; Created: 2011-11-02
-;;; Version: 0.9.2
+;;; Version: 0.9.3
 ;;; Keywords: games vimgolf vim
 
 ;; This file is not part of GNU Emacs
@@ -123,7 +122,8 @@ with `C-c C-v` prefixes to help in playing VimGolf.
                      universal-argument
                      universal-argument-other-key
                      universal-argument-minus
-                     universal-argument-more))
+                     universal-argument-more
+                     isearch-other-meta-char))
            (string-prefix-p "vimgolf-" (symbol-name this-command)))))
 
 (defun vimgolf-capturable-dangling-keystroke-p ()
@@ -152,6 +152,10 @@ unknown key sequence was entered).")
 (defun vimgolf-capture-dangling-keystroke ()
   (vimgolf-maybe-capture-keystroke 'vimgolf-capturable-dangling-keystroke-p))
 
+(defun vimgolf-get-keystrokes-as-string (&optional separator)
+  (unless separator (setq separator " "))
+  (mapconcat 'key-description (mapcar 'car vimgolf-keystrokes) separator))
+
 (defun vimgolf-refresh-keystroke-log ()
   "Refresh the contents of the keystrokes log buffer."
   (let ((deactivate-mark nil))
@@ -160,7 +164,7 @@ unknown key sequence was entered).")
       (erase-buffer)
       (insert (format "Challenge ID: %s\n%s\n\n" vimgolf-challenge (vimgolf-challenge-url vimgolf-challenge))
               (format "Keystrokes (%d):\n\n" (vimgolf-count-keystrokes))
-              (mapconcat 'key-description (mapcar 'car vimgolf-keystrokes) " ")
+              (vimgolf-get-keystrokes-as-string)
               "\n\nFull command log:\n\n")
       (when vimgolf-keystrokes
         (let* ((descrs-and-commands
@@ -328,12 +332,149 @@ unknown key sequence was entered).")
 
       (vimgolf-continue))))
 
+(defvar *vimgolf-browse-list* nil
+  "Holds a list of parsed VimGolf challenges.")
+
+(defun vimgolf-browse (&optional force-pull)
+  (interactive)
+  (if (or (eq *vimgolf-browse-list* nil)
+          force-pull)
+      (url-retrieve vimgolf-host 'vimgolf-parse-browse-html)
+    (vimgolf-browse-list)
+    (vimgolf-browse-next)))
+
+(defun vimgolf-browse-refresh ()
+  (interactive)
+  (vimgolf-browse t))
+
+(defun vimgolf-replace-control-m (string &optional replace)
+  (replace-regexp-in-string "
+
+(defun vimgolf-parse-html-entites (string)
+  (replace-regexp-in-string
+   "&lt;" "<"
+   (replace-regexp-in-string
+    "&gt;" ">"
+    (replace-regexp-in-string
+     "&amp;" "&"
+     (replace-regexp-in-string
+      "&quot" "\""
+      string)))))
+
+(defun vimgolf-parse-browse-html (status)
+  (with-current-buffer (current-buffer)
+    (let ((html (vimgolf-parse-html-entites
+                 (replace-regexp-in-string "\n" "" (buffer-string))))
+          (start 0))
+      (setq *vimgolf-browse-list* nil)
+      (while
+          (string-match
+           "<a href=\"/challenges/\\([a-zA-Z0-9]+\\)\">\\(.*?\\)</a>.*?<p>\\(.*?\\)</p>"
+           html)
+        (add-to-list '*vimgolf-browse-list*
+                     (cons (match-string 1 html)
+                           (list (match-string 2 html)
+                                 (vimgolf-replace-control-m
+                                  (match-string 3 html))))
+                     t)
+        (setq html (substring html (match-end 0))))
+      *vimgolf-browse-list*))
+  (vimgolf-browse-list)
+  (vimgolf-browse-next))
+
+(defun vimgolf-browse-list ()
+  (let ((browse-buffer (get-buffer-create "*VimGolf Browse*")))
+    (switch-to-buffer browse-buffer)
+    (setq buffer-read-only nil)
+    (kill-region (point-min) (point-max))
+    (insert "VimGolf Challenges")
+    (newline 2)
+    (dolist (challenge *vimgolf-browse-list*)
+      (let ((title (substring (cadr challenge)
+                              0
+                              (min (length (cadr challenge))
+                                   (- fill-column 3))))
+            (description (car (cdr (cdr challenge))))
+            (challenge-id (car challenge)))
+        (when (< (length title) (length (cadr challenge)))
+          (setq title (concat title "...")))
+        (insert-text-button title
+                            'action 'vimgolf-browse-select
+                            'follow-link t
+                            'challenge-id challenge-id 
+                            'help-echo description))
+      (newline)))
+  (beginning-of-buffer)
+  (vimgolf-browse-mode))
+
+(defun vimgolf-browse-select (arg)
+  (let ((challenge-id (get-text-property (point) 'challenge-id)))
+    (vimgolf challenge-id)))
+
+(defun vimgolf-message-title ()
+  (let ((challenge-id (get-text-property (point) 'challenge-id)))
+    (when challenge-id
+      (message (cadr (assoc challenge-id *vimgolf-browse-list*))))))
+
+(defun vimgolf-browse-next ()
+  (interactive)
+  (goto-char (next-single-property-change (point) 'challenge-id))
+  (unless (get-text-property (point) 'challenge-id)
+    (goto-char (next-single-property-change (point) 'challenge-id)))
+  (vimgolf-message-title))
+
+(defun vimgolf-browse-previous ()
+  (interactive)
+  (goto-char (previous-single-property-change (point) 'challenge-id))
+  (unless (get-text-property (point) 'challenge-id)
+    (goto-char (previous-single-property-change (point) 'challenge-id)))
+  (vimgolf-message-title))
+
+(defun vimgolf-show-description ()
+  (interactive)
+  (let ((challenge-id (get-text-property (point) 'challenge-id)))
+    (save-excursion
+      (setq buffer-read-only nil)
+      (if (text-property-any (point-min) (point-max) 'challenge-description challenge-id)
+          (progn
+            (beginning-of-buffer)
+            (while (not (eq (get-text-property (point) 'challenge-description) challenge-id))
+              (goto-char (next-single-property-change (point) 'challenge-description)))
+            (let ((start (point)))
+              (goto-char (next-single-property-change (point) 'challenge-description))
+              (delete-region start (point))
+              (delete-blank-lines)
+              (delete-blank-lines)))
+        (end-of-line)
+        (newline 3)
+        (forward-line -1)
+        (let ((start (point)))
+          (insert "  " (car (cddr (assoc challenge-id *vimgolf-browse-list*))))
+          (fill-region start (point))
+          (add-text-properties start (point) `(challenge-description ,challenge-id))))
+      (setq buffer-read-only t))))
+
 ;;;###autoload
 (defun vimgolf (challenge-id)
   "Open a VimGolf Challenge"
   (interactive (list (read-from-minibuffer "Challenge ID: " nil nil nil 'vimgolf-challenge-history)))
   (url-retrieve (vimgolf-challenge-url challenge-id) 'vimgolf-setup `(,challenge-id)))
 
+(defvar vimgolf-browse-mode-map (make-sparse-keymap)
+  "Keymap for vimgolf-mode.")
+
+(define-derived-mode vimgolf-browse-mode special-mode "vimgolf browse"
+  "A major mode for completing vimgolf challenges.
+
+\\{vimgolf-browse-mode-map}"
+  (define-key vimgolf-browse-mode-map (kbd "TAB") 'vimgolf-show-description)
+  (define-key vimgolf-browse-mode-map "g" 'vimgolf-browse-refresh)
+  (define-key vimgolf-browse-mode-map "n" 'vimgolf-browse-next)
+  (define-key vimgolf-browse-mode-map "p" 'vimgolf-browse-previous)
+)
+
+(put 'vimgolf-mode 'mode-class 'special)
+
 (provide 'vimgolf)
 
 ;;; Local Variables:

data/lib/vimgolf/ui.rb

@@ -1,5 +1,7 @@
 require 'highline'
 
+HighLine.track_eof = false
+
 module VimGolf
   class CLI
     class UI < Thor::Base.shell
@@ -58,7 +60,9 @@ module VimGolf
           end
           @hl.ask(message, options[:choices] || [], &details)
         rescue EOFError
-          return ''
+          # be sure to exit, don't loop
+          error "Argh! Forced quit due to EOF error. Please report this problem so we can fix it!"
+          return :quit
         end
       end
 

data/lib/vimgolf/version.rb

@@ -1,3 +1,3 @@
 module Vimgolf
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vimgolf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-17 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2157019460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *2157019460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.6
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &2157018980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157018980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157018480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157018480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157017900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157017900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: CLI client for vimgolf.com
 email:
 - ilya@igvita.com
@@ -64,6 +84,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .gitmodules
 - .rspec
 - Gemfile
 - Gemfile.lock
@@ -72,6 +93,10 @@ files:
 - bin/vimgolf
 - emacs/README.md
 - emacs/ROADMAP.md
+- emacs/features/emacs.feature
+- emacs/features/step-definitions/emacs-steps.el
+- emacs/features/support/env.el
+- emacs/todo.org
 - emacs/vimgolf.el
 - lib/vimgolf.rb
 - lib/vimgolf/challenge.rb
@@ -96,7 +121,7 @@ post_install_message: ! '
 
   ------------------------------------------------------------------------------
 
-  Thank you for installing vimgolf-0.4.1.
+  Thank you for installing vimgolf-0.4.2.
 
 
   0.1.3: custom vimgolf .vimrc file to help level the playing field
@@ -133,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: vimgolf
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: CLI client for vimgolf.com