orb 0.0.6 → 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1,4 @@
+- MiniTest/RSpec support
+- Writing back to files
+- Readme
+- Screencast

data/lib/orb.rb

@@ -1,154 +1,4 @@
-# ORB is a tool to write tests interactively. 
-
-# Most ruby programmers, even the ones with extensive test suites, frequently 
-# find themselves in IRB, trying snippets of code here and there.
-# It's not uncommon to run some code in IRB, then copy parts of it almost
-# verbatim into a test file for use as a test. ORB makes this a much more smooth
-# process. 
-
-# The basic workflow with ORB is: 
-
-# 1. Add `ORB{}` to each new test, at the point where you'd like to insert code.
-# 2. Run your test suite with `orb` loaded. See `adapters/rspec.rb`.
-# 3. Use the REPL provided for each call to ORB to create a new test.
-
-# When a call to `ORB` is encountered, you'll be dropped to to a REPL with full
-# access to the test's context (much like a debugger). You can run code, and 
-# interact with the context however you like. When you're ready to write your 
-# test, you simply run the commands, then add them to a buffer. Once your 
-# buffer contains the code you'd like to save as a test, you can write
-# it back to the file in place of the call to `ORB` with just two keystrokes.
-
-# The REPL uses readline for line editing.
-require 'readline'
-
-# Adapters are near-trivial to write, and provide test-framework integration.
-require 'orb/adapters/rspec'
-
-class ORB
-  @@index=0
-  
-  # Once ORB is called, the user is presented with a minimal IRB-like REPL,
-  # where they can evaluate arbitrary ruby code or execute a set of built-in
-  # commands to build up a test and save it back to the test file. 
-  def orb_it_up
-    while line = Readline.readline(prompt, true)
-      case line
-        
-        # The `a` command appends one or more recent lines to the test buffer.
-      when /^a\s?(\d*)$/
-        append_to_buffer($1.to_i)
-        next
-
-        # The `h` command shows this session's history. Each line starts with 
-        # a coloured space. A red space indicates that this line is not in
-        # the buffer, and a green space indicates that this line is in the 
-        # buffer, and will be written back to the file when the test is saved.
-      when "h"
-        red   = "\x1B[41m \x1B[m"
-        green = "\x1B[42m \x1B[m"
-        @hist.each do |line, in_buf|
-          print in_buf ? green : red
-          print ' '
-          puts line
-        end 
-        next 
-
-        # The `p` command prints the current contents of the buffer. If the test
-        # is written back to the file right now, this is what will be inserted.
-      when "p"
-        puts @buf
-        next 
-        
-        # The `q` command exits this session without writing a test. Next time
-        # the suite is run, you'll get a REPL here again.
-      when "q"
-        break
-        
-        # The `s` command writes the contents of the buffer out to the file.
-      when "s"
-        write_buf_to_file
-        break
-        
-        # If this line wasn't a command, evaluate it in the context of the code 
-        # that called `ORB{}`. We're stealing that context from the block.
-        # There are other, trickier tricks to get it without requiring a block,
-        # but they haven't been reliable since ruby 1.8.5.
-      else 
-        @hist << [line,false]
-        begin
-          this = @binding.eval("self")
-          ret = this.send(:eval, line, @binding)
-        rescue => e
-          puts e.message
-        else 
-          puts ret.inspect
-        end 
-      end 
-      
-    end 
-  end   
-  
-  # It's up to the adapters to figure out the context we need to evaluate code
-  # in. Typically, they'll grab it from an empty block. Adapters call this 
-  # intializer with a `Binding`, and we set a few instance variables for the 
-  # REPL to use. Notably, `@line` and `@file` are the location of the call
-  # to ORB, where we should insert our code when the test is written out.
-  def initialize(bind)
-    @@index += 1
-    @binding = bind
-    @buf, @hist = [], []
-    @line, @file = bind.eval("[__LINE__, __FILE__]")
-
-    # This is normally used for the test's description. It's not a strict 
-    # requirement of an adapter, but will be set and shown if present.
-    @header = ORB::Adapter.header(bind) if ORB::Adapter.respond_to?(:header)
-    puts "\n\n[[ #{@header} ]]" if @header
-    
-    # Gentlemen, start your REPLs.
-    orb_it_up
-  end 
-
-  private
-
-  # Append some number of recent lines to the test buffer. This is triggered
-  # by the command `a` or `a <n>`, eg. `a 3`. If called with no number, just
-  # appends the last command run, otherwise, appends n lines.
-  def append_to_buffer(n=1)
-    @hist.last[1] = true
-    @buf << @hist.last[0]
-  end 
-  
-  # When this command is run, ORB will save the contents of the test buffer
-  # back into the file where `ORB{}` was called from. It does this by reading
-  # in the entire file, then rewriting it with ORB{} replaced by the buffer.
-  def write_buf_to_file
-    lines = File.read(@file).lines.to_a
-     
-    File.open(@file,"w") do |f|
-      f.puts lines[0...@line-1]
-     
-      orbline = lines[@line-1]
-      indentation = orbline.index(/[^\s]/)
-
-      # Here we're indenting the inserted code to the same level as `ORB{}` 
-      # was indented.
-      @buf.each do |bufline|
-        f.print " "*indentation
-        f.puts bufline
-      end 
-      
-      f.puts lines[@line..-1]
-    end   
-  end 
-  
-  # ORB's prompt looks like `1:0 >>`. The first number is the index of this 
-  # test, starting at one, and incrementing with each test during an 
-  # ORB-enhanced run of your test suite. The second number is the current size 
-  # of the test buffer; that is, the number of lines that will be written to 
-  # the file if the test is saved right now.
-  def prompt
-    "#{@@index}:#{@buf.size} >> "
-  end 
-
-end 
+require 'orb/test_buffer'
+require 'orb/pry_extensions'
+require 'orb/drivers/test-unit'
+require 'orb/runner'

data/lib/orb/drivers/test-unit.rb

@@ -0,0 +1,26 @@
+require 'test/unit/testcase'
+
+class Test::Unit::TestCase
+  def self.orb!
+    define_method("test_orb_#{rand 100000}") { orb!(self) }
+  end
+
+  def orb!(ctx)
+    with_immediate_asserts(ctx) { Orb::Runner.new(ctx).run }
+  end
+
+  def with_immediate_asserts(ctx)
+    class << self
+      alias_method :_original_wrap_assertion, :_wrap_assertion
+      def _wrap_assertion ; yield ; end
+    end
+
+    yield
+
+    class << self
+      alias_method :_wrap_assertion, :_original_wrap_assertion
+    end
+  end
+
+end
+

data/lib/orb/pry_extensions.rb

@@ -0,0 +1,48 @@
+require 'pry'
+
+Pry.config.prompt = proc { |_, _, pry|  "orb[#{pry.instance_variable_get("@orb_test_buffer")}]> " }
+
+class Pry
+  attr_accessor :orb_test_buffer
+
+  module Helpers::CommandHelpers
+    def orb_test_buffer
+      _pry_.instance_variable_get("@orb_test_buffer")
+    end
+  end
+end
+
+module Orb
+  Commands = Pry::CommandSet.new do
+    command ",a", "Append the previous line to the buffer" do |*code|
+      if code.empty?
+        orb_test_buffer << _pry_.input_array[-1].chomp
+      else
+        orb_test_buffer << code.join(" ")
+      end
+    end
+
+    command ",p", "Print contents of buffer" do
+      puts orb_test_buffer
+    end
+
+    command ",e", "Edit contents of buffer" do
+      orb_test_buffer.edit_contents!
+    end
+
+    command ",n", "Name or rename the current test" do |*name|
+      orb_test_buffer.name = name.join(" ")
+    end
+
+    command ",r", "Run contents of buffer" do
+      orb_test_buffer.run
+    end
+
+    command ",w", "Write the buffer to file" do
+      orb_test_buffer.write
+    end
+  end
+end
+
+Pry.config.commands.import Orb::Commands
+

data/lib/orb/runner.rb

@@ -0,0 +1,35 @@
+require 'pry'
+
+module Orb
+  class Runner
+    attr_reader :test_buffer
+    class << self
+      attr_accessor :current
+    end
+
+    def initialize(context)
+      @context = context
+      @test_buffer = TestBuffer.new
+      setup_pry
+      Orb::Runner.current = self
+    end
+
+    def setup_pry
+      Pry.instance_eval do
+        if initial_session?
+          load_rc       if Pry.config.should_load_rc
+          # load_plugins  if Pry.config.plugins.enabled
+          load_requires if Pry.config.should_load_requires
+          load_history  if Pry.config.history.should_load
+        end
+      end
+      @pry = Pry.new
+      @pry.instance_variable_set("@orb_test_buffer", @test_buffer)
+    end
+
+    def run
+      @pry.repl(@context)
+    end
+
+  end
+end

data/lib/orb/test_buffer.rb

@@ -0,0 +1,39 @@
+require 'tempfile'
+
+class TestBuffer < Array
+  attr_accessor :name
+
+  def edit_contents!
+    path = "#{Dir::tmpdir}/orb-#{Kernel.rand 1000000}.rb"
+    begin
+      File.open(path, "w") do |f|
+        f.write(join('\n'))
+        f.flush
+        system("#{ENV['EDITOR'] || '/usr/bin/vim'} #{f.path}")
+        replace(File.read(f.path).lines.map(&:chomp))
+      end
+    ensure
+      File.unlink(path)
+    end
+  end
+
+  def run
+    each do |line|
+      eval(line)
+    end
+  end
+
+  def write
+    str = "".tap do |test|
+      test << "test \"#{name}\" do\n"
+      each do |line|
+        test << "  " << line << "\n"
+      end
+      test << "end\n"
+    end
+
+    puts str
+  end
+
+end
+

data/lib/orb/version.rb

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

data/orb.gemspec

@@ -1,18 +1,21 @@
-Gem::Specification.new do |gem|
-  gem.name    = 'orb'
-  gem.version = "0.0.6"
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "orb/version"
 
-  gem.author, gem.email = 'Burke Libbey', "burke@burkelibbey.org"
+Gem::Specification.new do |s|
+  s.name        = "orb"
+  s.version     = Orb::VERSION
+  s.authors     = ["Burke Libbey"]
+  s.email       = ["burke.libbey@shopify.com"]
+  s.homepage    = ""
+  s.summary     = %q{REPL-driven testing for ruby}
+  s.description = %q{REPL-driven testing for ruby -- integrates with pry and lets you build tests incrementally in the REPL}
 
-  gem.summary     = "ORB is a tool to write tests interactively"
-  gem.description = "ORB is a tool to write tests interactively. Add ORB{} to one of your tests, then when you run your test suite, you'll get dropped to a REPL, where you can explore the test's context and build an implementation for the test, before automatically writing it out to the file and replacing the ORB{} call."
+  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"]
 
-gem.has_rdoc = false
-
-  gem.files = %w[
-    LICENSE
-    README.md
-    lib
-    orb.gemspec
-  ] + Dir["**/*.rb"]
+  s.add_runtime_dependency 'pry', '0.9.8.2'
+  s.add_runtime_dependency 'test-unit'
 end

metadata

@@ -1,66 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: orb
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Burke Libbey
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-02 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
-description: ORB is a tool to write tests interactively. Add ORB{} to one of your tests, then when you run your test suite, you'll get dropped to a REPL, where you can explore the test's context and build an implementation for the test, before automatically writing it out to the file and replacing the ORB{} call.
-email: burke@burkelibbey.org
+date: 2012-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70298440802600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70298440802600
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &70298440801600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70298440801600
+description: REPL-driven testing for ruby -- integrates with pry and lets you build
+  tests incrementally in the REPL
+email:
+- burke.libbey@shopify.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- LICENSE
-- README.md
-- orb.gemspec
-- lib/orb/adapters/rspec.rb
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- TODO
 - lib/orb.rb
-has_rdoc: true
-homepage: 
+- lib/orb/drivers/test-unit.rb
+- lib/orb/pry_extensions.rb
+- lib/orb/runner.rb
+- lib/orb/test_buffer.rb
+- lib/orb/version.rb
+- orb.gemspec
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: ORB is a tool to write tests interactively
+summary: REPL-driven testing for ruby
 test_files: []
-

data/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2010 Burke Libbey <burke@burkelibbey.org>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/README.md

@@ -1,33 +0,0 @@
-# ORB
-
-# What is it?
-
-ORB is a tool to write tests interactively. Add `ORB{}` to one of your
-tests, then when you run your test suite, you'll get dropped to a
-REPL, where you can explore the test's context and build an
-implementation for the test, before automatically writing it out to 
-the file and replacing the `ORB{}` call.
-
-# Wait... What?
-
-[Watch the video](#) (Coming Soon).
-
-# I just want to use it with Rspec. How?
-
-Add `ORB{}` to a pending example, then run your spec suite with 
-`-r orb`, for example, `spec -rorb spec/**/*_spec.rb`, or add it to `spec_opts`.
-
-# Can I use this with \#{framework}?
-
-Probably. Have a look at `lib/orb/adapters/rspec.rb`. It's a pretty simple
-format. 
-
-# Why do I have to call ORB with an empty block?
-
-Ruby 1.8.6 and onward doesn't have a reliable way to evaluate code in
-the context that calls a method without explicitly passing it, or
-grabbing the binding from a block. The block is easier to type.
-
-# I have a great idea...
-
-Great! Let me know, or even better, send me a pull request.

data/lib/orb/adapters/rspec.rb

@@ -1,40 +0,0 @@
-### ORB RSpec Adapter
-# This integrates ORB with RSpec. To run your test suite with ORB enabled,
-# run `spec` with `-rorb`, or add `-rorb` to `spec_opts`, or simply 
-# `require 'orb'` in your `spec_helper.rb`.
-
-# ORB's requirements of an adapter are minimal:
-
-# - (optional) Some convenient way to start an ORB session. 
-# - (optional) A header describing this specific instance.
-# Each RSpec example has a description that's printed when it fails.
-# We re-create that here to provide context when an ORB session is started.
-class ORB
-  module Adapters
-    module RSpec
-      def self.header(bind)
-        this = bind.eval("self")
-        ancestry = [this.class, this]
-        ancestry.map(&:description).join(" ")
-      end 
-    end 
-  end 
-end 
-
-# Initially, I wanted to override `pending` as the method to start ORB,
-# but as it turns out, the Object hackery I need to do to make ORB work
-# requires a block. Requiring that pending be called with a block seems like
-# an odd design choice, so instead I've made the method ORB, 
-# called like `ORB{}`.
-module Spec
-  module Example
-    module Pending
-      def ORB(&block)
-        ORB.new(block.binding)
-      end 
-    end 
-  end 
-end 
-
-# Finally, now that the RSpec Adapter is defined, set ORB's default Adapter.
-ORB::Adapter = ORB::Adapters::RSpec