ripl 0.2.0 → 0.2.1

data/.gemspec

@@ -14,6 +14,9 @@ Gem::Specification.new do |s|
   s.rubyforge_project = 'tagaholic'
   s.executables        = %w(ripl)
   s.add_dependency 'bond', '~> 0.3.1'
+  s.add_development_dependency 'bacon', '>= 1.1.0'
+  s.add_development_dependency 'rr', '= 0.10.10'
+  s.add_development_dependency 'bacon-bits'
   s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
   s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
   s.license = 'MIT'

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 0.2.1
+* Add tests
+* Add more flexible -I and -r
+* Update Shell::API to be more plugin friendly
+* Handle invalid options
+
 == 0.2.0
 * Full support for plugins
 * Add history support for all shells

data/README.rdoc

@@ -26,7 +26,7 @@ Install the gem with:
   * Easy to create and invoke ripl subcommands
   * ~/.irbrc errors caught
 * Different from irb
-  * No multi-line evaluation
+  * No multi-line evaluation by default (there is a plugin. See Available Plugins below).
   * No irb subsessions or workspaces
   * No IRB.conf features i.e. preconfigured prompts and auto indent
 
@@ -68,6 +68,8 @@ extension, see Ripl::Shell::API and Ripl::Runner::API.
 If we want to add a config for this plugin, we can simply add a key to Ripl.config that matches the
 underscored version of the plugin name i.e. Ripl.config[:red_error].
 
+For available plugins, see Available Plugins below.
+
 == Create Custom Shells
 
 Creating and starting a custom shell is as simple as:
@@ -95,6 +97,13 @@ Since ripl is highly customizable, it loads ~/.riplrc before it does anything. T
 require and/or define plugins. Any ripl configurations via Ripl.config should also be done here.
 For an example riplrc, see {mine}[http://github.com/cldwalker/dotfiles/tree/master/.riplrc].
 
+== Available Plugins
+
+* {ripl-rails}[http://github.com/cldwalker/ripl-rails] : script/console for ripl
+* {ripl-color_error}[http://github.com/cldwalker/ripl-color_error] : colorize errors
+* {ripl-after_rc}[http://github.com/cldwalker/ripl-after_rc] : provide blocks to run after ~/.irbrc is loaded
+* {ripl-multi_line}[http://github.com/janlelis/ripl-multi_line] : evaluate multiple lines
+
 == Credits
 * janlelis for bug fix and tweaks
 
@@ -104,6 +113,3 @@ Some other irb alternatives to check out:
 * {ir}[http://github.com/raggi/ir]: nice and light
 * {irb2}[http://github.com/wycats/irb2]: yehuda katz's partial attempt at rewriting irb
 * {dietrb}[http://github.com/alloy/dietrb]: mac and ruby 1.9 specific
-
-== Todo
-* Everything (tests especially)!

data/lib/ripl/completion.rb

@@ -2,8 +2,8 @@ require 'bond'
 
 module Ripl::Completion
   def before_loop
+    Bond.start(config[:completion] || {})
     super
-    Bond.start(config[:completion] || {}) unless Bond.started?
   end
 end
 Ripl::Shell.send :include, Ripl::Completion

data/lib/ripl/runner.rb

@@ -4,20 +4,20 @@ module Ripl::Runner
   end
 
   module API
-    def run
+    def run(argv=ARGV)
       load_rc(Ripl.config[:riplrc])
       @riplrc = true
-      parse_options(ARGV)
-      ARGV[0] ? run_command(ARGV) : start
+      parse_options(argv)
+      argv[0] ? run_command(argv) : start
     end
 
     def parse_options(argv)
       while argv[0] =~ /^-/
         case argv.shift
         when /-I=?(.*)/
-          $LOAD_PATH.unshift(*$1.split(":"))
+          $LOAD_PATH.unshift(*($1.empty? ? argv.shift.to_s : $1).split(":"))
         when /-r=?(.*)/
-          require $1
+          require $1.empty? ? argv.shift.to_s : $1
         when '-d'
           $DEBUG = true
         when '-v', '--version'
@@ -26,6 +26,8 @@ module Ripl::Runner
           ENV['RIPL_IRBRC'] = 'false'
         when '-h', '--help'
           puts IO.readlines(__FILE__).grep(/^#/).map {|e| e.sub(/^#\s/,'') }; exit
+        when /^--?([^-]+)/
+          warn "ripl: invalid option `#{$1}'"
         end
       end
     end
@@ -61,7 +63,7 @@ __END__
 # Options:
 #   -f                  Supress loading ~/.irbrc
 #   -d, --debug         Set $DEBUG to true (same as `ruby -d')
-#   -I=PATH             Add to front of $LOAD_PATH. Delimit multiple paths with ':'
-#   -r, --require=FILE  Require file (same as `ruby -r')
+#   -I PATH             Add to front of $LOAD_PATH. Delimit multiple paths with ':'
+#   -r, --require FILE  Require file (same as `ruby -r')
 #   -v, --version       Print ripl version
 #   -h, --help          Print help

data/lib/ripl/shell.rb

@@ -10,7 +10,7 @@ class Ripl::Shell
     new(options)
   end
 
-  attr_accessor :line, :binding, :result_prompt, :last_result
+  attr_accessor :line, :binding, :result_prompt, :result, :options
   def initialize(options={})
     @options = OPTIONS.merge options
     @name, @binding, @line = @options.values_at(:name, :binding, :line)
@@ -19,7 +19,7 @@ class Ripl::Shell
 
   def loop
     before_loop
-    during_loop
+    catch(:ripl_exit) { while(true) do; loop_once; end }
     after_loop
   end
 
@@ -30,14 +30,12 @@ class Ripl::Shell
       Ripl::Runner.load_rc(@irbrc) if @irbrc
     end
 
-    def during_loop
-      while true do
-        @error_raised = nil
-        input = get_input
-        break if !input || input == 'exit'
-        loop_once(input)
-        puts(format_result(@last_result)) unless @error_raised
-      end
+    def loop_once
+      @error_raised = nil
+      @input = get_input
+      throw(:ripl_exit) if !@input || @input == 'exit'
+      eval_input(@input)
+      print_result(@result)
     end
 
     def get_input
@@ -49,9 +47,9 @@ class Ripl::Shell
       @options[:prompt].respond_to?(:call) ? @options[:prompt].call : @options[:prompt]
     end
 
-    def loop_once(input)
-      @last_result = loop_eval(input)
-      eval("_ = Ripl.shell.last_result", @binding)
+    def eval_input(input)
+      @result = loop_eval(input)
+      eval("_ = Ripl.shell.result", @binding)
     rescue Exception => e
       @error_raised = true
       print_eval_error(e)
@@ -67,6 +65,10 @@ class Ripl::Shell
       warn format_error(err)
     end
 
+    def print_result(result)
+      puts(format_result(result)) unless @error_raised
+    end
+
     def format_error(err); Ripl::Runner.format_error(err); end
 
     def format_result(result)

data/lib/ripl/version.rb

@@ -1,3 +1,3 @@
 module Ripl
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/test/deps.rip

@@ -0,0 +1,3 @@
+bacon >=1.1.0
+rr =0.10.10
+bacon-bits >=0

data/test/runner_test.rb

@@ -0,0 +1,163 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe "Runner" do
+  describe ".start" do
+    before { reset_ripl }
+
+    it "loads riplrc" do
+      mock_riplrc
+      mock(Ripl).shell(anything) { shell = Shell.new; mock(shell).loop; shell }
+      Ripl.start
+    end
+
+    it "sets a shell's options" do
+      mock_riplrc
+      mock(Shell).create(anything) {|e| shell = Shell.new(e); mock(shell).loop; shell }
+      Ripl.start(:prompt=>'$')
+      Ripl.shell.options[:prompt].should == '$'
+    end
+
+    it "overrides options set in riplrc" do
+      mock_riplrc { Ripl.config[:readline] = false }
+      mock(Shell).create(anything) {|e| shell = Shell.new(e); mock(shell).loop; shell }
+      Ripl.start(:readline=>true)
+      Ripl.shell.options[:readline].should == true
+    end
+  end
+
+  describe ".run" do
+    describe "riplrc" do
+      before { reset_ripl }
+
+      it "sets a shell's options" do
+        mock_riplrc { Ripl.config[:blah] = true }
+        mock(Shell).create(anything) {|e| shell = Shell.new(e); mock(shell).loop; shell }
+        Runner.run([])
+        Ripl.shell.options[:blah].should == true
+      end
+
+      it "catches and prints error" do
+        mock(Runner).load(anything) { raise SyntaxError }
+        mock(Ripl).shell(anything) { shell = Shell.new; mock(shell).loop; shell }
+        capture_stderr { Runner.run([]) }.should =~ %r{^Error while loading ~/.riplrc:\nSyntaxError:}
+      end
+    end
+
+    describe "with subcommand" do
+      it "that is valid gets invoked with arguments" do
+        mock(Runner).exec('ripl-rails', '--blah')
+        ripl("rails", '--blah')
+      end
+
+      it "has global options before it parsed" do
+        mock(Runner).parse_options(anything) {|e| e.shift }
+        mock(Runner).exec('ripl-rails')
+        ripl("-f", "rails")
+      end
+
+      it "that is invalid aborts" do
+        mock(Runner).abort("`zzz' is not a ripl command.")
+        ripl 'zzz'
+      end
+    end
+
+    describe "with -I option" do
+      before { @old_load_path = $:.dup }
+      after { $:.replace @old_load_path }
+
+      it "and equal sign adds to $LOAD_PATH" do
+        ripl("-I=blah", :start=>true)
+        $:[0].should == 'blah'
+      end
+
+      it "and no equal sign adds to $LOAD_PATH" do
+        ripl("-Ispec", :start=>true)
+        $:[0].should == 'spec'
+      end
+
+      it "and whitespace delimited argument adds to $LOAD_PATH" do
+        ripl("-I", "spec", :start=>true)
+        $:[0].should == 'spec'
+      end
+
+      it "containing multiple paths adds to $LOAD_PATH" do
+        ripl("-I=app:lib", :start=>true)
+        $:[0,2].should == ['app', 'lib']
+      end
+
+      it "called more than once adds to $LOAD_PATH" do
+        ripl("-Ilib", "-Ispec", :start=>true)
+        $:[0,2].should == ['spec', 'lib']
+      end
+
+      it "with invalid argument doesn't add to $LOAD_PATH" do
+        previous_size = $:.size
+        ripl("-I", :start=>true)
+        $:.size.should == previous_size
+      end
+    end
+
+    describe "with -r option" do
+      it "and equal sign requires path" do
+        mock(Runner).require('rip')
+        ripl("-r=rip", :start=>true)
+      end
+
+      it "and no equal sign requires path" do
+        mock(Runner).require('rip')
+        ripl("-rrip", :start=>true)
+      end
+
+      it "and whitespace delimited argument requires path" do
+        mock(Runner).require('rip')
+        ripl("-r", "rip", :start=>true)
+      end
+
+      it "called more than once requires paths" do
+        mock(Runner).require('rip')
+        mock(Runner).require('dude')
+        ripl("-rrip", "-rdude", :start=>true)
+      end
+
+      it "with invalid argument requires blank" do
+        mock(Runner).require('')
+        ripl('-r', :start=>true)
+      end
+    end
+
+    it "with -f option doesn't load irbrc" do
+      reset_ripl
+      mock(Shell).create(anything) {|e|
+        shell = Shell.new(e)
+        mock(shell).loop_once { throw :ripl_exit }
+        dont_allow(Runner).load_rc(anything)
+        shell
+      }
+      ripl("-f")
+    end
+
+    it "with -d option sets $DEBUG" do
+      ripl("-d", :start=>true)
+      $DEBUG.should == true
+      $DEBUG = nil
+    end
+
+    it "with -v option prints version" do
+      should.raise(SystemExit) { ripl("-v").should == Ripl::VERSION }
+    end
+
+    it "with -h option prints help" do
+      should.raise(SystemExit) {
+        actual = ripl("-v")
+        actual.should =~ /^Usage: ripl/
+        actual.should =~ /Options:\n  -f/
+      }
+    end
+
+    it "with invalid options prints errors" do
+      capture_stderr {
+        ripl('--blah', '-z', :start=>true)
+      }.chomp.should == "ripl: invalid option `blah'\nripl: invalid option `z'"
+    end
+  end
+end

data/test/shell_test.rb

@@ -0,0 +1,72 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe "Shell" do
+  before { reset_ripl }
+
+  def shell(options={})
+    Ripl.shell(options)
+  end
+
+  describe "#loop" do
+    before { mock(shell).before_loop }
+    it "exits with exit" do
+      mock(shell).get_input { 'exit' }
+      dont_allow(shell).eval_input
+      shell.loop
+    end
+
+    it "exits with Control-D" do
+      mock(shell).get_input { nil }
+      dont_allow(shell).eval_input
+      shell.loop
+    end
+  end
+
+  describe "#prompt" do
+    it "as a string" do
+      shell(:prompt=>'> ').prompt.should == '> '
+    end
+
+    it "as a lambda" do
+      shell(:prompt=>lambda { "#{10 + 10}> " }).prompt.should == '20> '
+    end
+  end
+
+  describe "#eval_input" do
+    before { @line = shell.line; shell.eval_input("10 ** 2") }
+
+    describe "normally" do
+      it "sets result" do
+        shell.result.should == 100
+      end
+
+      it "sets _" do
+        shell.eval_input('_')
+        shell.result.should == 100
+      end
+
+      it "increments line" do
+        shell.line.should == @line + 1
+      end
+    end
+
+    describe "with error" do
+      before {
+        @line = shell.line
+        @stderr = capture_stderr { shell.eval_input('{') }
+      }
+
+      it "prints it" do
+        @stderr.should =~ /^SyntaxError: compile error/
+      end
+
+      it "sets @error_raised" do
+        shell.instance_variable_get("@error_raised").should == true
+      end
+
+      it "increments line" do
+        shell.line.should == @line + 1
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,48 @@
+require 'bacon'
+require 'bacon/bits'
+require 'rr'
+require 'bacon/rr'
+require 'stringio'
+require 'ripl'
+include Ripl
+
+module Helpers
+  def ripl(*args)
+    options = args[-1].is_a?(Hash) ? args.pop : {}
+    mock(Runner).load_rc(Ripl.config[:riplrc])
+    mock(Runner).start if options[:start]
+    capture_stdout { Ripl::Runner.run(args) }
+  end
+
+  def mock_riplrc(&block)
+    mock(Runner).load_rc(Ripl.config[:riplrc]) { block.call if block }
+  end
+
+  def reset_ripl
+    Ripl.instance_eval "@shell = @riplrc = nil"
+  end
+
+  def capture_stdout(&block)
+    original_stdout = $stdout
+    $stdout = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stdout = original_stdout
+    end
+    fake.string
+  end
+
+  def capture_stderr(&block)
+    original_stderr = $stderr
+    $stderr = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stderr = original_stderr
+    end
+    fake.string
+  end
+end
+
+Bacon::Context.send :include, Helpers

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ripl
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 -05:00
+date: 2010-11-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,6 +34,52 @@ dependencies:
         version: 0.3.1
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 10
+        - 10
+        version: 0.10.10
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bacon-bits
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Ruby Interactive Print Loop - A light, modular alternative to irb
 email: gabriel.horner@gmail.com
 executables: 
@@ -51,11 +97,15 @@ files:
 - lib/ripl/shell.rb
 - lib/ripl/version.rb
 - lib/ripl.rb
+- test/runner_test.rb
+- test/shell_test.rb
+- test/test_helper.rb
 - bin/ripl
 - LICENSE.txt
 - CHANGELOG.rdoc
 - README.rdoc
 - deps.rip
+- test/deps.rip
 - Rakefile
 - .gemspec
 has_rdoc: true