ripl 0.2.6 → 0.2.7

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.2.7
+* Fix and (change order of) option parsing for ripl commands
+* Add default help for a ripl command
+
 == 0.2.6
 * Add ctrl-c handling
 * Clean up api to extend options

data/README.rdoc

@@ -77,7 +77,7 @@ modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
     {ripl-multi_line}[http://github.com/janlelis/ripl-multi_line]).
   * No irb subsessions or workspaces (though ripl has jumps via
     {ripl-commands}[http://github.com/cldwalker/ripl-commands])
-  * Some IRB.conf features aren't supported (see {ripl-irb}[http://github.com/cldwalker/ripl-irb]
+  * Some IRB.conf features aren't supported yet (see {ripl-irb}[http://github.com/cldwalker/ripl-irb]
     for details)
 
 Note: Irb features not in ripl can be implemented as plugins.
@@ -128,7 +128,7 @@ Creating and starting a custom shell is as simple as:
 Ripl.start takes options to customize your shell. For example if you wanted to
 start on a specific binding:
 
-    Ripl.start :binding => my_desired_binding
+    Ripl.start :binding => MyClass.instance_eval{ binding }
 
 == Create Commands
 

data/lib/ripl/runner.rb

@@ -16,11 +16,7 @@ module Ripl::Runner
 
   module API
     def run(argv=ARGV)
-      ENV['RIPLRC'] = 'false' if argv.delete('-F')
-      load_rc(Ripl.config[:riplrc]) unless ENV['RIPLRC'] == 'false'
-      @run = true
-      parse_options(argv)
-      argv[0] ? run_command(argv) : start
+      argv[0].to_s[/^[^-]/] ? run_command(argv) : start(:argv=>argv)
     end
 
     def parse_options(argv)
@@ -28,26 +24,24 @@ module Ripl::Runner
         case argv.shift
         when /-I=?(.*)/
           $LOAD_PATH.unshift(*($1.empty? ? argv.shift.to_s : $1).split(":"))
-        when /-r=?(.*)/
-          require $1.empty? ? argv.shift.to_s : $1
-        when '-d'
-          $DEBUG = true
-        when '-v', '--version'
-          puts Ripl::VERSION; exit
-        when '-f'
-          ENV['RIPL_IRBRC'] = 'false'
-        when '-h', '--help'
-          name_max = OPTIONS.map {|e| e[0].length }.max
-          desc_max = OPTIONS.map {|e| e[1].length }.max
-          puts "Usage: ripl [OPTIONS] [COMMAND] [ARGS]", "\nOptions:",
-            OPTIONS.map {|k,v| "  %-*s  %-*s" % [name_max, k, desc_max, v] }
-          exit
-        when /^(--?[^-]+)/
-          parse_option($1, argv)
+        when /-r=?(.*)/        then require($1.empty? ? argv.shift.to_s : $1)
+        when '-d'              then $DEBUG = true
+        when '-v', '--version' then puts(Ripl::VERSION); exit
+        when '-f'              then Ripl.config[:irbrc] = false
+        when '-h', '--help'    then puts(help); exit
+        when /^(--?[^-]+)/     then parse_option($1, argv)
         end
       end
     end
 
+    def help
+      return("ripl #{$1} [OPTIONS] [ARGS]") if $0[/ripl-(\w+)/]
+      name_max = OPTIONS.map {|e| e[0].length }.max
+      desc_max = OPTIONS.map {|e| e[1].length }.max
+      ["Usage: ripl [COMMAND] [OPTIONS] [ARGS]", "\nOptions:",
+        OPTIONS.map {|k,v| "  %-*s  %-*s" % [name_max, k, desc_max, v] }]
+    end
+
     def parse_option(option, argv)
       warn "ripl: invalid option `#{option.sub(/^-+/, '')}'"
     end
@@ -60,8 +54,9 @@ module Ripl::Runner
     end
 
     def start(options={})
-      load_rc(Ripl.config[:riplrc]) if !@run && ENV['RIPLRC'] != 'false'
-      Ripl.config[:irbrc] = ENV['RIPL_IRBRC'] != 'false' if ENV['RIPL_IRBRC']
+      argv = options.delete(:argv) || ARGV
+      load_rc(Ripl.config[:riplrc]) unless argv.delete('-F')
+      parse_options(argv) if $0[/ripl$|ripl-\w+$/]
       Ripl.shell(options).loop
     end
 

data/lib/ripl/shell.rb

@@ -34,7 +34,7 @@ class Ripl::Shell
     # initialize plugins and their instance variables.
     def before_loop
       Ripl::Runner.load_rc(@irbrc) if @irbrc
-      add_commands(loop_eval("self"))
+      add_commands(eval("self", @binding))
     end
 
     def add_commands(obj)

data/lib/ripl/version.rb

@@ -1,3 +1,3 @@
 module Ripl
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

data/man/ripl.1

@@ -10,7 +10,7 @@
 .
 .nf
 
-ripl [\-r|\-\-require] [\-I] [\-f] [\-d] [\-h|\-\-help] [\-v|\-\-version] COMMAND [ARGS]
+ripl [COMMAND] [\-r|\-\-require] [\-I] [\-f] [\-d] [\-h|\-\-help] [\-v|\-\-version] [ARGS]
 .
 .fi
 .
@@ -228,7 +228,7 @@ Ripl\.start takes the same config keys mentioned in the \fBCONFIGURATION\fR sect
 .
 .nf
 
-Ripl\.start :binding => MyClass\.send(:binding)
+Ripl\.start :binding => MyClass\.instance_eval{ binding }
 .
 .fi
 .
@@ -245,10 +245,10 @@ A ripl command is a command passed to ripl that loads a custom shell\. It\'s a c
 .nf
 
 # Load rails console without ~/\.irbrc
-$ ripl \-f rails
+$ ripl rails \-f
 
 # Load rails console with debugger
-$ ripl \-rrdebug rails
+$ ripl rails \-rrdebug
 .
 .fi
 .

data/man/ripl.1.html

@@ -80,7 +80,7 @@
 
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
 
-<pre><code>ripl [-r|--require] [-I] [-f] [-d] [-h|--help] [-v|--version] COMMAND [ARGS]
+<pre><code>ripl [COMMAND] [-r|--require] [-I] [-f] [-d] [-h|--help] [-v|--version] [ARGS]
 </code></pre>
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
@@ -230,7 +230,7 @@ Ripl.start
 <p>Ripl.start takes the same config keys mentioned in the <code>CONFIGURATION</code> section. For example if you wanted to
 start on a specific binding:</p>
 
-<pre><code>Ripl.start :binding =&gt; MyClass.send(:binding)
+<pre><code>Ripl.start :binding =&gt; MyClass.instance_eval{ binding }
 </code></pre>
 
 <p>Also, since all shells load ~/.riplrc, Ripl.start can be used to override undesirable global
@@ -243,10 +243,10 @@ package and invoke custom shells. A ripl command can take standard ripl options
 before the command:</p>
 
 <pre><code># Load rails console without ~/.irbrc
-$ ripl -f rails
+$ ripl rails -f
 
 # Load rails console with debugger
-$ ripl -rrdebug rails
+$ ripl rails -rrdebug
 </code></pre>
 
 <p>To create a ripl command, create an executable in the format ripl-command and make sure it's in your

data/man/ripl.1.ronn

@@ -3,7 +3,7 @@ ripl(1) -- Ruby Interactive Print Loop - A light, modular alternative to irb
 
 ## SYNOPSIS
 
-    ripl [-r|--require] [-I] [-f] [-d] [-h|--help] [-v|--version] COMMAND [ARGS]
+    ripl [COMMAND] [-r|--require] [-I] [-f] [-d] [-h|--help] [-v|--version] [ARGS]
 
 ## DESCRIPTION
 
@@ -155,7 +155,7 @@ Creating and starting a custom shell is as simple as:
 Ripl.start takes the same config keys mentioned in the `CONFIGURATION` section. For example if you wanted to
 start on a specific binding:
 
-    Ripl.start :binding => MyClass.send(:binding)
+    Ripl.start :binding => MyClass.instance_eval{ binding }
 
 Also, since all shells load ~/.riplrc, Ripl.start can be used to override undesirable global
 configuration for a custom shell.
@@ -167,10 +167,10 @@ package and invoke custom shells. A ripl command can take standard ripl options
 before the command:
 
     # Load rails console without ~/.irbrc
-    $ ripl -f rails
+    $ ripl rails -f
 
     # Load rails console with debugger
-    $ ripl -rrdebug rails
+    $ ripl rails -rrdebug
 
 To create a ripl command, create an executable in the format ripl-command and make sure it's in your
 shell's $PATH. For example, the file 'ripl-my_gem' would be invoked with 'ripl my_gem'. Any

data/test/runner_test.rb

@@ -44,22 +44,48 @@ describe "Runner" do
     end
 
     describe "with subcommand" do
-      it "that is valid gets invoked with arguments" do
-        mock(Runner).exec('ripl-rails', '--blah')
-        ripl("rails", '--blah')
+      def set_dollar_zero(val)
+        $progname = $0
+        alias $0 $progname
+        $0 = val
       end
 
-      it "has global option before it parsed" do
-        mock(Runner).exec('ripl-rails')
+      def mock_exec(*args)
+        mock(Runner).exec('ripl-rails', *args) do
+          set_dollar_zero 'ripl-rails'
+          ARGV.replace(args)
+          Ripl.start
+        end
+      end
+
+      it "gets invoked with arguments" do
+        mock_exec 'blah'
+        ripl("rails", 'blah')
+      end
+
+      it "has -F global option parsed" do
+        mock_exec '-F'
         dont_allow(Runner).load_rc(anything)
-        ripl("-F", "rails", :riplrc=>false)
-        ENV.delete('RIPLRC')
+        ripl("rails", "-F", :riplrc=>false)
+      end
+
+      it "has other global option parsed" do
+        mock_exec '-r=blah'
+        mock(Runner).require('blah')
+        ripl("rails", "-r=blah")
+      end
+
+      it "has automatic --help" do
+        mock_exec '--help'
+        mock(Runner).exit
+        ripl("rails", "--help").chomp.should == "ripl rails [OPTIONS] [ARGS]"
       end
 
       it "that is invalid aborts" do
         mock(Runner).abort("`zzz' is not a ripl command.")
-        ripl 'zzz'
+        ripl 'zzz', :riplrc => false, :loop => false
       end
+      after_all { set_dollar_zero 'ripl' }
     end
 
     describe "with -I option" do
@@ -67,33 +93,33 @@ describe "Runner" do
       after { $:.replace @old_load_path }
 
       it "and equal sign adds to $LOAD_PATH" do
-        ripl("-I=blah", :start=>true)
+        ripl("-I=blah")
         $:[0].should == 'blah'
       end
 
       it "and no equal sign adds to $LOAD_PATH" do
-        ripl("-Ispec", :start=>true)
+        ripl("-Ispec")
         $:[0].should == 'spec'
       end
 
       it "and whitespace delimited argument adds to $LOAD_PATH" do
-        ripl("-I", "spec", :start=>true)
+        ripl("-I", "spec")
         $:[0].should == 'spec'
       end
 
       it "containing multiple paths adds to $LOAD_PATH" do
-        ripl("-I=app:lib", :start=>true)
+        ripl("-I=app:lib")
         $:[0,2].should == ['app', 'lib']
       end
 
       it "called more than once adds to $LOAD_PATH" do
-        ripl("-Ilib", "-Ispec", :start=>true)
+        ripl("-Ilib", "-Ispec")
         $:[0,2].should == ['spec', 'lib']
       end
 
       it "with invalid argument doesn't add to $LOAD_PATH" do
         previous_size = $:.size
-        ripl("-I", :start=>true)
+        ripl("-I")
         $:.size.should == previous_size
       end
     end
@@ -101,40 +127,40 @@ describe "Runner" do
     describe "with -r option" do
       it "and equal sign requires path" do
         mock(Runner).require('rip')
-        ripl("-r=rip", :start=>true)
+        ripl("-r=rip")
       end
 
       it "and no equal sign requires path" do
         mock(Runner).require('rip')
-        ripl("-rrip", :start=>true)
+        ripl("-rrip")
       end
 
       it "and whitespace delimited argument requires path" do
         mock(Runner).require('rip')
-        ripl("-r", "rip", :start=>true)
+        ripl("-r", "rip")
       end
 
       it "called more than once requires paths" do
         mock(Runner).require('rip')
         mock(Runner).require('dude')
-        ripl("-rrip", "-rdude", :start=>true)
+        ripl("-rrip", "-rdude")
       end
 
       it "with invalid argument requires blank" do
         mock(Runner).require('')
-        ripl('-r', :start=>true)
+        ripl('-r')
       end
     end
 
     it "with -f option doesn't load irbrc" do
       reset_ripl
+      reset_config
       stub(Kernel).at_exit()
       mock_shell { |shell|
         mock(shell).loop_once { throw :ripl_exit }
         dont_allow(Runner).load_rc(anything)
       }
-      ripl("-f")
-      ENV.delete('RIPL_IRBRC')
+      ripl("-f", :loop => false)
       Ripl.config[:irbrc] = '~/.irbrc'
     end
 
@@ -146,31 +172,30 @@ describe "Runner" do
         mock(shell).before_loop
         mock(shell).loop_once { throw :ripl_exit }
       }
-      ripl("-F", :riplrc => false)
-      ENV.delete('RIPLRC')
+      ripl("-F", :riplrc => false, :loop => false)
     end
 
     it "with -d option sets $DEBUG" do
-      ripl("-d", :start=>true)
+      ripl("-d")
       $DEBUG.should == true
       $DEBUG = nil
     end
 
     it "with -v option prints version" do
       mock(Runner).exit
-      ripl("-v", :start=>true).chomp.should == Ripl::VERSION
+      ripl("-v").chomp.should == Ripl::VERSION
     end
 
     it "with -h option prints help" do
       mock(Runner).exit
-      actual = ripl("-h", :start=>true)
+      actual = ripl("-h")
       actual.should =~ /^Usage: ripl/
       actual.should =~ /Options:\n  -f/
     end
 
     it "with invalid options prints errors" do
       capture_stderr {
-        ripl('--blah', '-z', :start=>true)
+        ripl('--blah', '-z')
       }.chomp.should == "ripl: invalid option `blah'\nripl: invalid option `z'"
     end
 
@@ -186,17 +211,17 @@ describe "Runner" do
       end
 
       it "parses plugin option" do
-        ripl("--moo", :start=>true).chomp.should == 'MOOOO'
+        ripl("--moo").chomp.should == 'MOOOO'
       end
 
       it "displays plugin option in --help" do
         mock(Runner).exit
-        ripl("--help", :start=>true).should =~ /--moo\s*just moos/
+        ripl("--help").should =~ /--moo\s*just moos/
       end
 
       it "handles invalid option" do
         capture_stderr {
-          ripl('--blah', :start=>true)
+          ripl('--blah')
         }.chomp.should == "ripl: invalid option `blah'"
       end
     end

data/test/shell_test.rb

@@ -52,6 +52,7 @@ describe "Shell" do
 
   describe "#before_loop" do
     before_all { Ripl::Commands.send(:define_method, :ping) { 'pong' } }
+    before { reset_config }
     it "adds commands to main from Commands" do
       stub(Ripl::Runner).load_rc
       stub(Kernel).at_exit

data/test/test_helper.rb

@@ -10,7 +10,7 @@ module Helpers
   def ripl(*args)
     options = args[-1].is_a?(Hash) ? args.pop : {}
     mock_riplrc unless options[:riplrc] == false
-    mock(Runner).start if options[:start]
+    mock(Ripl.shell).loop unless options[:loop] == false
     capture_stdout { Ripl::Runner.run(args) }
   end
 
@@ -27,7 +27,11 @@ module Helpers
   end
 
   def reset_ripl
-    Ripl.instance_eval "@shell = @riplrc = nil"
+    Ripl.instance_eval "@config = @shell = @riplrc = nil"
+  end
+
+  def reset_config
+    Ripl.config.merge! :history => '~/.irb_history', :completion => {}
   end
 
   def capture_stdout(&block)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ripl
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-03 00:00:00 -05:00
+date: 2010-12-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency