boca-golf 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,88 @@
+== Boca Golf
+
+A simple command line utility for playing ruby golf with problems defined via RSpec examples.
+
+In ruby golf, you need to write a function that passes the provided specs in the fewest characters you can.
+
+== Install
+
+gem install boca-golf
+
+== Get Some Problems
+
+git clone git://github.com/flipstone/boca-golf-problems.git
+
+== Write a File
+
+in my_solution.rb:
+
+  def sanitize(word, string)
+    ... your implementation ...
+  end
+
+then:
+
+  boca-golf my_solution.rb boca-golf-problems/sanitize/spec.rb
+
+
+and see:
+
+  Testing my_solution.rb against specs:
+    - boca-golf-problems/sanitize/spec.rb
+
+  ...
+
+  Finished in 0.0007 seconds
+  3 examples, 0 failures
+
+  Code:
+  def sanitize(word, string)
+    ... your implementation ...
+  end
+
+  Score:
+  <# of characters in your solution>
+
+
+== Upload your answer
+
+Go to https://gist.github.com and create a gist with your solution
+
+then someone can run it with:
+
+  boca-golf <your gist url> boca-golf-problems/sanitize/spec.rb
+
+== Create your own problems!
+
+Simply create an rspec examples file, decide on what coders should
+name the method, and call it!
+
+in my_spec.rb:
+
+  describe "reverse" do
+    it "reverses the string" do
+      reverse("foo").should == "oof"
+    end
+  end
+
+then:
+
+  boca-golf solution.rb my_spec.rb
+
+And send your problems in and we'll give you credit in the boca-golf-problems
+repo!
+
+Happy Golfing!
+
+== Security
+
+boca-golf runs all code from potential solutions at $SAFE = 4, so you
+don't need to worry about someone's gist wrecking your system.  That
+being said, we are not liable for any damage caused to your system by
+untrusted code.  Always run untrusted code at your own risk.
+
+Problem definitions, on the other hand, are run at $SAFE = 0, so you
+can access any part of ruby you want within the RSpec examples you
+write for your problems.  That also means you should be sure you trust
+whomever is defining the problems you're running with boca-golf.
+

data/boca-golf.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["david@flipstone.com"]
   s.homepage    = "https://github.com/flipstone/boca-golf"
   s.summary     = %q{A simple rspec-based engine for playing ruby golf coding problems}
-  s.description = %q{boca-golf with securely load and run from the filesystem or a gist url,
+  s.description = %q{boca-golf securely loads and runs code from the filesystem or a gist url,
 execute a user-specified set of rspec examples against it, and also print of the score
 (# number of charaters - lower == better!).  It was built for playing ruby golf at the
 Boca Ruby Meetup sessions.

data/lib/boca_golf/command_line.rb

@@ -3,6 +3,14 @@ class BocaGolf
     def run(args, stdout, stderr)
       ::Rspec::Core::Runner.disable_autorun!
 
+      if args.size > 1
+        run_with_checked_args args, stdout, stderr
+      else
+        show_usage stdout, stderr
+      end
+    end
+
+    def run_with_checked_args(args, stdout, stderr)
       gist_location, *specs = *args
       stdout.puts "Testing #{gist_location} against specs:"
       specs.each do |spec|
@@ -16,6 +24,12 @@ class BocaGolf
       stdout.puts result.gist.code
       stdout.puts "\nScore:"
       stdout.puts result.score
+    rescue => e
+      stderr.puts e.message
+    end
+
+    def show_usage(stdout, stderr)
+      stderr.puts "Usage: boca-golf file_or_gist_url spec_file ..."
     end
   end
 end

data/lib/boca_golf/version.rb

@@ -1,3 +1,3 @@
 class BocaGolf
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/command_line_spec.rb

@@ -24,4 +24,22 @@ def reverse\(a\) a.reverse; end
 Score:
 29|
   end
+
+  it "prints usage when not enough arguments are supplied" do
+    stdout, stderr = StringIO.new, StringIO.new
+    sandboxed do
+      BocaGolf::CommandLine.new.run([], stdout, stderr)
+    end
+
+    stderr.string.should =~ %r{Usage: boca-golf file_or_gist_url spec_file \.\.\.}
+  end
+
+  it "prints useful error when file does not exist" do
+    stdout, stderr = StringIO.new, StringIO.new
+    sandboxed do
+      BocaGolf::CommandLine.new.run(["boca-golf-foobar.rb", "spec/infrastructure/reverse_specs/spec.rb"], stdout, stderr)
+    end
+
+    stderr.string.should =~ %r{No such file or directory - boca-golf-foobar.rb}
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Vollbracht
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -05:00
+date: 2011-01-08 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: "boca-golf with securely load and run from the filesystem or a gist url,\n\
+description: "boca-golf securely loads and runs code from the filesystem or a gist url,\n\
   execute a user-specified set of rspec examples against it, and also print of the score\n\
   (# number of charaters - lower == better!).  It was built for playing ruby golf at the\n\
   Boca Ruby Meetup sessions.\n  "
@@ -34,6 +34,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- README.rdoc
 - Rakefile
 - bin/boca-golf
 - boca-golf.gemspec