vimgolf 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in vimgolf.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    vimgolf (0.0.1)
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  thor
+  vimgolf!

data/README.md

@@ -0,0 +1,31 @@
+# [VimGolf.com](http://www.vimgolf.com) Client
+
+Real Vim ninjas count every keystroke - do you? Head on over to vimgolf.com, pick a challenge, and show us what you've got! The rules are simple:
+
+* Each challenge provides an input file, and an output file
+* Your goal is to modify the input file such that it matches the output
+* Once you install the vimgolf CLI, pick a challenge, open a prompt and put away!
+
+When you launch a challenge from the command line, it will be downloaded from the site and a local Vim session will be launched, which will log every keystroke you make. Once you're done, simply *:wq* (write and quit) the session and we will score your input and upload it back to the site!
+
+Let the games begin.
+
+## Setup & Play
+
+<pre>
+1. $> gem install vimgolf
+2. $> vimgolf setup (go to vimgolf.com, sign in, and grab your API key)
+3. Pick a challenge on vimgolf.com
+4. $> vimgolf put [challenge ID]
+</pre>
+
+## Todo's & Wishlist
+
+* At the moment, scoring is done based on the simplest possible model: bytesize of your Vim script file. Instead, we'd like to assign a score based on shortcuts and key-combinations used. Ex: visual mode gets you extra x points, etc.
+* Vim script parser - distinguish between different modes, keystrokes, etc.
+
+Other patches, tips & ideas are welcome!
+
+## License
+
+(MIT License) - Copyright (c) 2010 Ilya Grigorik

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/vimgolf

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'vimgolf'
+
+begin
+  VimGolf::CLI.start
+rescue VimGolf::Error => e
+  VimGolf.ui.print_exception(e)
+  exit(1)
+rescue Interrupt => e
+  puts
+  VimGolf.ui.print_exception(e)
+  VimGolf.ui.say("Quitting...")
+  exit(1)
+end

data/lib/vimgolf.rb

@@ -0,0 +1,9 @@
+require 'fileutils'
+require 'net/http'
+require 'json'
+require 'thor'
+
+require 'vimgolf/version'
+require 'vimgolf/config'
+require 'vimgolf/cli'
+require 'vimgolf/ui'

data/lib/vimgolf/cli.rb

@@ -0,0 +1,161 @@
+module VimGolf
+
+  GOLFHOST = ENV['GOLFHOST'] || "http://vimgolf.com"
+
+  class Error
+  end
+
+  class UI
+    def debug(*); end
+  end
+
+  class << self
+    attr_accessor :ui
+
+    def ui
+      @ui ||= UI.new
+    end
+  end
+
+  class CLI < Thor
+    include Thor::Actions
+
+    def self.start(*)
+      Thor::Base.shell = VimGolf::CLI::UI
+      VimGolf.ui = VimGolf::CLI::UI.new
+      super
+    end
+
+    desc "setup", "configure your VimGolf credentials"
+    long_desc <<-DESC
+    To participate in the challenge please go to vimgolf.com and register an
+    account. Once signed in, you will get your API token, which you need to
+    setup the command client.
+
+      If you have the token, simply run the setup and paste in your token.
+      DESC
+
+    def setup
+      token = VimGolf.ui.ask "Please specify your VimGolf API token (register on vimgolf.com to get it):"
+
+      if token =~ /[\w\d]{1,32}/
+        FileUtils.mkdir_p Config.path
+        FileUtils.mkdir_p Config.put_path
+        Config.save({:key => token})
+
+        VimGolf.ui.info "Saved. Happy golfing!"
+      else
+        VimGolf.ui.error "Invalid token, please double check your token on vimgolf.com"
+      end
+    end
+
+    desc "put [ID]", "launch Vim session"
+    long_desc <<-DESC
+    Launch a VimGolf session for the specified challenge ID. To find a currently
+    active challenge ID, please visit vimgolf.com!
+    DESC
+
+    def put(id = nil)
+      VimGolf.ui.warn "Launching VimGolf session for challenge: #{id}"
+
+      type = download(id)
+
+      if !type.nil? && !type.empty?
+        # - n - no swap file, memory only editing
+        # - --noplugin - don't load any plugins, lets be fair!
+        # - +0 - always start on line 0
+        system("vim -n --noplugin +0 -W #{log(id)} #{input(id, type)}")
+
+        if $?.exitstatus.zero?
+          diff = `diff --strip-trailing-cr #{input(id, type)} #{output(id)}`
+
+          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!"
+            return
+          end
+
+          score = File.size(log(id))
+          VimGolf.ui.info "Success! Your output matches. Your score: #{score}"
+
+          if VimGolf.ui.yes? "Upload result to VimGolf? (yes / no)"
+            VimGolf.ui.warn "Uploading to VimGolf..."
+
+            if upload(id) == :ok
+              VimGolf.ui.info "Uploaded entry, thanks for golfing!"
+              VimGolf.ui.info "View the leaderboard: #{GOLFHOST}/challenges/#{id}"
+            else
+              VimGolf.ui.error "Uh oh, upload to VimGolf failed, please check your key."
+            end
+
+          else
+            VimGolf.ui.warn "Skipping upload. Thanks for playing. Give it another shot!"
+          end
+
+        else
+          error = <<-MSG
+          Uh oh, Vim did not exit properly. If the problem persists, please
+          report the error on github.com/igrigorik/vimgolf
+          MSG
+
+          VimGolf.ui.error error
+        end
+      end
+    end
+
+    private
+      def download(id)
+        begin
+          url = URI.parse("#{GOLFHOST}/challenges/#{id}.json")
+          req = Net::HTTP::Get.new(url.path)
+          res = Net::HTTP.start(url.host, url.port) {|http| http.request(req)}
+          data = JSON.parse(res.body)
+
+          if data['client'] != Vimgolf::VERSION
+            VimGolf.ui.error "Client version mismatch. Installed: #{Vimgolf::VERSION}, Required: #{data['client']}."
+            VimGolf.ui.error "\t gem install vimgolf"
+            raise
+          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']}
+
+          data['in']['type']
+
+        rescue Exception => e
+          VimGolf.ui.error "Uh oh, couldn't download or parse challenge, please verify your challenge id and client version."
+          nil
+        end
+      end
+
+      def upload(id)
+        begin
+          url = URI.parse("#{GOLFHOST}/entry.json")
+          http = Net::HTTP.new(url.host, url.port)
+          res = http.start do |conn|
+            key = Config.load['key']
+            data = "challenge_id=#{id}&entry=#{IO.read(log(id))}&apikey=#{key}"
+            head = {'Accept' => 'application/json'}
+
+            conn.post(url.path, data, head)
+          end
+
+          JSON.parse(res.body)['status'].to_sym
+
+        rescue Exception => e
+          VimGolf.ui.error "Uh oh, entry upload has failed, please check your key."
+        end
+      end
+
+      def input(id, type);  challenge(id) + ".#{type}"; end
+      def output(id); challenge(id) + ".output"; end
+      def log(id);    challenge(id) + ".log"; end
+
+      def challenge(id)
+        Config.put_path + "/#{id}"
+      end
+  end
+end

data/lib/vimgolf/config.rb

@@ -0,0 +1,25 @@
+module VimGolf
+  class Config
+    class << self
+      def path
+        "#{ENV['HOME']}/.vimgolf"
+      end
+
+      def put_path
+        path + "/put"
+      end
+
+      def save(conf)
+        File.open(path + '/config.json', 'w') do |f|
+          f.puts JSON.generate(conf)
+        end
+      end
+
+      def load
+        File.open(path + '/config.json', 'r') do |f|
+          JSON.parse(f.read)
+        end
+      end
+    end
+  end
+end

data/lib/vimgolf/ui.rb

@@ -0,0 +1,116 @@
+module VimGolf
+  class CLI
+    class UI < Thor::Base.shell
+
+      def error(name, message = nil)
+        begin
+          orig_out, $stdout = $stdout, $stderr
+          if message
+            say_status name, message, :red
+          elsif name
+            say name, :red
+          end
+        ensure
+          $stdout = orig_out
+        end
+      end
+
+      def warn(name, message = nil)
+        if message
+          say_status name, message, :yellow
+        elsif name
+          say name, :yellow
+        end
+      end
+
+      def info(name, message = nil)
+        if message
+          say_status name, message, :green
+        elsif name
+          say name, :green
+        end
+      end
+
+      def debug(name, message = nil)
+        return unless ENV["DEBUG"]
+
+        if message
+          message = message.inspect unless message.is_a?(String)
+          say_status name, message, :blue
+        elsif name
+          name = name.inspect unless name.is_a?(String)
+          say name, :cyan
+        end
+      end
+
+      def ask(message, password = false)
+        begin
+          require 'highline'
+          @hl ||= HighLine.new($stdin)
+          if not $stdin.tty?
+            @hl.ask(message)
+          elsif password
+            @hl.ask(message) {|q| q.echo = "*" }
+          else
+            @hl.ask(message) {|q| q.readline = true }
+          end
+        rescue EOFError
+          return ''
+        end
+      end
+
+      def print_envs(apps, default_env_name = nil, simple = false)
+        if simple
+          envs = apps.map{ |a| a.environments }
+          envs.flatten.map{|x| x.name}.uniq.each do |env|
+            puts env
+          end
+        else
+          apps.each do |app|
+            puts "#{app.name} (#{app.account.name})"
+            if app.environments.any?
+              app.environments.each do |env|
+                short_name = env.shorten_name_for(app)
+
+                icount = env.instances_count
+                iname = (icount == 1) ? "instance" : "instances"
+
+                default_text = env.name == default_env_name ? " [default]" : ""
+
+                puts "  #{short_name}#{default_text} (#{icount} #{iname})"
+              end
+            else
+              puts "  (This application is not in any environments; you can make one at #{EY.config.endpoint})"
+            end
+
+            puts ""
+          end
+        end
+      end
+
+      def print_exception(e)
+        if e.message.empty? || (e.message == e.class.to_s)
+          message = nil
+        else
+          message = e.message
+        end
+
+        if ENV["DEBUG"]
+          error(e.class, message)
+          e.backtrace.each{|l| say(" "*3 + l) }
+        else
+          error(message || e.class.to_s)
+        end
+      end
+
+      def print_help(table)
+        print_table(table, :ident => 2, :truncate => true, :colwidth => 20)
+      end
+
+      def set_color(string, color, bold=false)
+        ($stdout.tty? || ENV['THOR_SHELL']) ? super : string
+      end
+
+    end
+  end
+end

data/lib/vimgolf/version.rb

@@ -0,0 +1,3 @@
+module Vimgolf
+  VERSION = "0.1.0"
+end

data/spec/cli_spec.rb

@@ -0,0 +1,25 @@
+require "helper"
+
+describe VimGolf do
+  it "provides VimGolf errors" do
+    VimGolf::Error.should be
+  end
+
+  it "sets up VimGolf.ui" do
+    VimGolf.ui.should be_an(VimGolf::UI)
+    capture_stdout do
+      VimGolf::CLI.start(["help"])
+    end
+    VimGolf.ui.should be_an(VimGolf::CLI::UI)
+  end
+
+  it "provides a help prompt" do
+    out = capture_stdout do
+      VimGolf::CLI.start(["help"])
+    end
+
+    out.should include("setup")
+    out.should include("launch")
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require 'lib/vimgolf'
+
+require 'stringio'
+
+module Kernel
+  def capture_stdio(input = nil, &block)
+    org_stdin, $stdin = $stdin, StringIO.new(input) if input
+    org_stdout, $stdout = $stdout, StringIO.new
+    yield
+    return @out = $stdout.string
+  ensure
+    $stdout = org_stdout
+    $stdin = org_stdin
+  end
+  alias capture_stdout capture_stdio
+end
+
+RSpec.configure do |config|
+  # config.include RSpec::Helpers
+  # config.extend RSpec::Helpers::SemanticNames
+end

data/vimgolf.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "vimgolf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vimgolf"
+  s.version     = Vimgolf::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ilya Grigorik"]
+  s.email       = ["ilya@igvita.com"]
+  s.homepage    = "http://github.com/igrigorik/vimgolf"
+  s.summary     = "CLI client for vimgolf.com"
+  s.description = s.summary
+
+  s.rubyforge_project = "vimgolf"
+  s.add_dependency "thor"
+  s.add_dependency "json"
+
+  s.add_development_dependency "rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: vimgolf
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ilya Grigorik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: CLI client for vimgolf.com
+email: 
+- ilya@igvita.com
+executables: 
+- vimgolf
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/vimgolf
+- lib/vimgolf.rb
+- lib/vimgolf/cli.rb
+- lib/vimgolf/config.rb
+- lib/vimgolf/ui.rb
+- lib/vimgolf/version.rb
+- spec/cli_spec.rb
+- spec/helper.rb
+- vimgolf.gemspec
+has_rdoc: true
+homepage: http://github.com/igrigorik/vimgolf
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: vimgolf
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: CLI client for vimgolf.com
+test_files: 
+- spec/cli_spec.rb
+- spec/helper.rb