ripl 0.2.5 → 0.2.6

data/.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = "gabriel.horner@gmail.com"
   s.homepage    = "http://github.com/cldwlaker/ripl"
   s.summary =  "Ruby Interactive Print Loop - A light, modular alternative to irb"
-  s.description = "ripl is a light, modular alternative to irb. Like irb, it loads ~/.irbrc, has autocompletion and keeps history in ~/.irb_history.  Unlike irb, it is highly customizable via plugins and supports commands.  This customizability makes it easy to build custom shells (i.e. for a gem or application) and complex shells (i.e. for the web)."
+  s.description = "ripl is a light, modular alternative to irb. Like irb, it loads ~/.irbrc, has autocompletion and keeps history in ~/.irb_history.  Unlike irb, it is highly customizable via plugins and supports commands i.e. ripl-play.  This customizability makes it easy to build custom shells (i.e. for a gem or application) and complex shells (i.e. for the web)."
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = 'tagaholic'
   s.executables        = %w(ripl)

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.2.6
+* Add ctrl-c handling
+* Clean up api to extend options
+* Allow exit with 'quit'
+
 == 0.2.5
 * Add -F option
 * Extendable commandline options

data/README.rdoc

@@ -2,8 +2,9 @@
 
 ripl is a light, modular alternative to irb. Like irb, it loads ~/.irbrc, has autocompletion and
 keeps history in ~/.irb_history.  Unlike irb, it is highly customizable via plugins and supports
-commands.  This customizability makes it easy to build custom shells (i.e. for a gem or application)
-and complex shells (i.e. for the {web}[http://github.com/cldwalker/nirvana]).
+commands i.e. {ripl-play}[http://github.com/cldwalker/ripl-play].  This customizability makes it
+easy to build custom shells (i.e. for a gem or application) and complex shells (i.e. for the
+{web}[http://github.com/cldwalker/nirvana]).
 
 == Install
 
@@ -57,22 +58,27 @@ modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
   * Appends to ~/.irb_history on exit
   * Autocompletion (from bond)
   * _ for last result
-  * Type 'exit' or Ctrl-D to exit
+  * Type 'exit', 'quit' or press Ctrl-D to exit
   * 6 common commandline options: -f, -r, -I, -d, -h, -v
   * IRB.conf -> Ripl.config
+  * Handles Ctrl-C quietly
 * Enhancements over irb
-  * ~250 lines (doc included) vs irb's 5000+ lines
+  * ~260 lines (doc included) vs irb's 5000+ lines
   * Easily extendable with plugins
   * Tests and documentation!
   * Customizable completion and completion of method arguments (from bond)
   * Easy to create custom shells for gems and apps i.e. Ripl.start
   * Easy to create and invoke ripl commands
   * Create console commands in a simple, modular way
+  * Custom commandline options can be added via a plugin
   * ~/.irbrc errors caught
 * Different from irb
-  * 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
+  * No multi-line evaluation by default (but there is a plugin,
+    {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]
+    for details)
 
 Note: Irb features not in ripl can be implemented as plugins.
 
@@ -103,7 +109,7 @@ 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.
+For available plugins, see Ripl Plugins below.
 
 == Configuration
 
@@ -132,22 +138,31 @@ $PATH. For example, the file 'ripl-my_gem' would be invoked with `ripl my_gem`.
 command you can take arguments and parse your options as you please. For an example command,
 see {ripl-rails}[http://github.com/cldwalker/ripl-rails].
 
-== Available Plugins
+== Credits
+* janlelis for bug fix and tweaks
+
+== Ripl 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-multi_line}[http://github.com/janlelis/ripl-multi_line] : evaluate multiple lines
+* {ripl-play}[http://github.com/cldwalker/ripl-play] : play back and record input into ripl
 * {ripl-after_rc}[http://github.com/cldwalker/ripl-after_rc] : provide blocks to run after ~/.irbrc is loaded
 * {ripl-irb}[http://github.com/cldwalker/ripl-irb] : smooths transition from irb
 * {ripl-commands}[http://github.com/cldwalker/ripl-commands] : adds ripl commands similar to irb's commands
 * {ripl-color_streams}[http://github.com/janlelis/ripl-color_streams] : colorizes stderr + stdout
 * {ripl-color_result}[http://github.com/janlelis/ripl-color_result] : colorizes results
-* {nirvana}[http://github.com/cldwalker/nirvana]: Not a plugin but rather a web shell built on top of ripl
+* {ripl-auto_indent}[http://github.com/janlelis/ripl-auto_indent] : auto indents multi-line input
+* {ripl-hirb}[http://github.com/cldwalker/hirb] : comes with hirb to make it a proper riplzen
+* {ripl-misc}[http://github.com/cldwalker/ripl-misc] : a playground for ripl plugins
 
-== Credits
-* janlelis for bug fix and tweaks
+== Ripl Shells
+Shells built on top of ripl:
+
+* {nirvana}[http://github.com/cldwalker/nirvana]: A ruby web shell complete with autocomplete
+* {fresh}[http://github.com/janlelis/fresh]: An interesting ruby/system hybrid shell
 
-== irb alternatives
+== Irb Alternatives
 Some other irb alternatives to check out:
 
 * {ir}[http://github.com/raggi/ir]: nice and light

data/lib/ripl/runner.rb

@@ -9,9 +9,12 @@ module Ripl::Runner
     ['-h, --help', 'Print help']
   ]
 
-  module API
-    def options; OPTIONS; end
+  # Adds commandline options for --help
+  def self.add_options(*options)
+    OPTIONS.concat(options)
+  end
 
+  module API
     def run(argv=ARGV)
       ENV['RIPLRC'] = 'false' if argv.delete('-F')
       load_rc(Ripl.config[:riplrc]) unless ENV['RIPLRC'] == 'false'
@@ -34,18 +37,18 @@ module Ripl::Runner
         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
+          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] }
+            OPTIONS.map {|k,v| "  %-*s  %-*s" % [name_max, k, desc_max, v] }
           exit
         when /^(--?[^-]+)/
-          invalid_option($1, argv)
+          parse_option($1, argv)
         end
       end
     end
 
-    def invalid_option(option, argv)
+    def parse_option(option, argv)
       warn "ripl: invalid option `#{option.sub(/^-+/, '')}'"
     end
 

data/lib/ripl/shell.rb

@@ -1,6 +1,7 @@
 class Ripl::Shell
   OPTIONS = {:name=>'ripl', :result_prompt=>'=> ', :prompt=>'>> ',
     :binding=>TOPLEVEL_BINDING, :irbrc=>'~/.irbrc'}
+  EXIT_WORDS = [nil, 'exit', 'quit']
 
   def self.create(options={})
     require 'ripl/readline' if options[:readline]
@@ -45,11 +46,16 @@ class Ripl::Shell
     def loop_once
       @error_raised = nil
       @input = get_input
-      throw(:ripl_exit) if !@input || @input == 'exit'
+      throw(:ripl_exit) if EXIT_WORDS.include?(@input)
       eval_input(@input)
       print_result(@result)
+    rescue Interrupt
+      handle_interrupt
     end
 
+    # Handles interrupt (Control-C) by printing a newline
+    def handle_interrupt; puts; end
+
     # Sets @result to result of evaling input and print unexpected errors
     def eval_input(input)
       @result = loop_eval(input)

data/lib/ripl/version.rb

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

data/man/ripl.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "RIPL" "1" "November 2010" "CLDWALKER" "Ripl Manual"
+.TH "RIPL" "1" "December 2010" "CLDWALKER" "Ripl Manual"
 .
 .SH "NAME"
 \fBripl\fR \- Ruby Interactive Print Loop \- A light, modular alternative to irb
@@ -87,7 +87,7 @@ An example ~/\.riplrc:
 .IP "" 0
 .
 .SH "PLUGINS"
-A ripl plugin is a module that is included into Ripl::Shell or Ripl::Runner\. Being simply modules, they can be packaged as gems and reused across shells as needed\. ripl highly encourages plugins by loading them as early as possible and allowing them to extend most of ripl\'s functionality\. As mentioned in the \fBCONFIGURATION\fR section, a plugin can be configured via Ripl\.config\.
+A ripl plugin is a module that is included into Ripl::Shell or extended into Ripl::Runner\. Being simply modules, they can be packaged as gems and reused across shells as needed\. ripl highly encourages plugins by loading them as early as possible and allowing them to extend most of ripl\'s functionality\. As mentioned in the \fBCONFIGURATION\fR section, a plugin can be configured via Ripl\.config\.
 .
 .P
 To always use a plugin, require it in ~/\.riplrc\. To sometimes use it, require it from the commandline:

data/man/ripl.1.html

@@ -134,10 +134,11 @@ a plugin start with an underscored version of its name i.e. Ripl::ColorError ->
 
 <h2 id="PLUGINS">PLUGINS</h2>
 
-<p>A ripl plugin is a module that is included into Ripl::Shell or Ripl::Runner.  Being simply modules,
-they can be packaged as gems and reused across shells as needed.  ripl highly encourages plugins by
-loading them as early as possible and allowing them to extend most of ripl's functionality. As
-mentioned in the <code>CONFIGURATION</code> section, a plugin can be configured via Ripl.config.</p>
+<p>A ripl plugin is a module that is included into Ripl::Shell or extended into Ripl::Runner.  Being
+simply modules, they can be packaged as gems and reused across shells as needed.  ripl highly
+encourages plugins by loading them as early as possible and allowing them to extend most of ripl's
+functionality. As mentioned in the <code>CONFIGURATION</code> section, a plugin can be configured via
+Ripl.config.</p>
 
 <p>To always use a plugin, require it in ~/.riplrc. To sometimes use it, require it from
 the commandline:</p>
@@ -269,7 +270,7 @@ arguments. For an example command, see <a href="http://github.com/cldwalker/ripl
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'>CLDWALKER</li>
-    <li class='tc'>November 2010</li>
+    <li class='tc'>December 2010</li>
     <li class='tr'>ripl(1)</li>
   </ol>
 

data/man/ripl.1.ronn

@@ -66,10 +66,11 @@ An example ~/.riplrc:
 
 ## PLUGINS
 
-A ripl plugin is a module that is included into Ripl::Shell or Ripl::Runner.  Being simply modules,
-they can be packaged as gems and reused across shells as needed.  ripl highly encourages plugins by
-loading them as early as possible and allowing them to extend most of ripl's functionality. As
-mentioned in the `CONFIGURATION` section, a plugin can be configured via Ripl.config.
+A ripl plugin is a module that is included into Ripl::Shell or extended into Ripl::Runner.  Being
+simply modules, they can be packaged as gems and reused across shells as needed.  ripl highly
+encourages plugins by loading them as early as possible and allowing them to extend most of ripl's
+functionality. As mentioned in the `CONFIGURATION` section, a plugin can be configured via
+Ripl.config.
 
 To always use a plugin, require it in ~/.riplrc. To sometimes use it, require it from
 the commandline:

data/test/runner_test.rb

@@ -157,15 +157,15 @@ describe "Runner" do
     end
 
     it "with -v option prints version" do
-      should.raise(SystemExit) { ripl("-v").should == Ripl::VERSION }
+      mock(Runner).exit
+      ripl("-v", :start=>true).chomp.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/
-      }
+      mock(Runner).exit
+      actual = ripl("-h", :start=>true)
+      actual.should =~ /^Usage: ripl/
+      actual.should =~ /Options:\n  -f/
     end
 
     it "with invalid options prints errors" do
@@ -173,5 +173,32 @@ describe "Runner" do
         ripl('--blah', '-z', :start=>true)
       }.chomp.should == "ripl: invalid option `blah'\nripl: invalid option `z'"
     end
+
+    describe "with plugin" do
+      before_all do
+        Moo = Module.new do
+          def parse_option(option, argv)
+            option == '--moo' ? puts("MOOOO") : super
+          end
+        end
+        Runner.extend Moo
+        Runner.add_options ['--moo', 'just moos']
+      end
+
+      it "parses plugin option" do
+        ripl("--moo", :start=>true).chomp.should == 'MOOOO'
+      end
+
+      it "displays plugin option in --help" do
+        mock(Runner).exit
+        ripl("--help", :start=>true).should =~ /--moo\s*just moos/
+      end
+
+      it "handles invalid option" do
+        capture_stderr {
+          ripl('--blah', :start=>true)
+        }.chomp.should == "ripl: invalid option `blah'"
+      end
+    end
   end
 end

data/test/shell_test.rb

@@ -15,6 +15,12 @@ describe "Shell" do
       shell.loop
     end
 
+    it "exits with quit" do
+      mock(shell).get_input { 'quit' }
+      dont_allow(shell).eval_input
+      shell.loop
+    end
+
     it "exits with Control-D" do
       mock(shell).get_input { nil }
       dont_allow(shell).eval_input
@@ -22,6 +28,12 @@ describe "Shell" do
     end
   end
 
+  it "#loop_once handles Control-C" do
+    mock(shell).get_input { raise Interrupt }
+    dont_allow(shell).eval_input
+    capture_stdout { shell.loop_once }.should == "\n"
+  end
+
   describe "#prompt" do
     it "from a string" do
       shell(:prompt=>'> ').prompt.should == '> '

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ripl
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-24 00:00:00 -05:00
+date: 2010-12-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,7 +80,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: ripl is a light, modular alternative to irb. Like irb, it loads ~/.irbrc, has autocompletion and keeps history in ~/.irb_history.  Unlike irb, it is highly customizable via plugins and supports commands.  This customizability makes it easy to build custom shells (i.e. for a gem or application) and complex shells (i.e. for the web).
+description: ripl is a light, modular alternative to irb. Like irb, it loads ~/.irbrc, has autocompletion and keeps history in ~/.irb_history.  Unlike irb, it is highly customizable via plugins and supports commands i.e. ripl-play.  This customizability makes it easy to build custom shells (i.e. for a gem or application) and complex shells (i.e. for the web).
 email: gabriel.horner@gmail.com
 executables: 
 - ripl