ripl 0.2.8 → 0.2.9

data/.gemspec

@@ -13,10 +13,11 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = 'tagaholic'
   s.executables        = %w(ripl)
-  s.add_dependency 'bond', '~> 0.3.3'
+  s.add_dependency 'bond', '~> 0.3.4'
   s.add_development_dependency 'bacon', '>= 1.1.0'
   s.add_development_dependency 'rr', '>= 1.0.0'
   s.add_development_dependency 'bacon-bits'
+  s.add_development_dependency 'bacon-rr'
   s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
   s.files += Dir.glob('man/*')
   s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.2.9
+* Add autoloaded plugin completions
+* Make Shell#include public for plugins
+* Rescue LoadError in .rc files
+
 == 0.2.8
 * Allow completion to be optional
 * Save commandline args to Ripl::Runner.argv

data/README.rdoc

@@ -43,7 +43,7 @@ To view ripl's man page:
 When first trying ripl, you may experience errors in your ~/.irbrc due to an irb-specific
 configuration. In order to have ripl and irb coexist peacefully, you should silence these errors.
 To silence them without touching your ~/.irbrc, install the ripl-irb gem. This ripl plugin fakes
-irb's existence, effectively ignoring irb-specific configuration. Otherwise, if you don't mind
+irb's existence and points to ripl equivalents for your irb configurations. Otherwise, if you don't mind
 modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
 
     if defined? IRB
@@ -63,7 +63,7 @@ modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
   * IRB.conf -> Ripl.config
   * Handles Ctrl-C quietly
 * Enhancements over irb
-  * ~260 lines (doc included) vs irb's 5000+ lines
+  * ~270 lines (doc included) vs irb's 5000+ lines
   * Easily extendable with plugins
   * Tests and documentation!
   * Customizable completion and completion of method arguments (from bond)
@@ -100,7 +100,7 @@ As an example plugin, let's color error messages red:
         end
       end
     end
-    Ripl::Shell.send :include, Ripl::RedError
+    Ripl::Shell.include Ripl::RedError
 
 Note this plugin extends format_error() by invoking the original format_error() with super. This is
 possible for any method that is available for extension by plugins. To see what methods are available for
@@ -156,14 +156,23 @@ see {ripl-rails}[http://github.com/cldwalker/ripl-rails].
 * {ripl-color_result}[http://github.com/janlelis/ripl-color_result] : colorizes results
 * {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-hijack}[http://github.com/cldwalker/ripl-hijack] : ripl console to a ruby process
 * {ripl-misc}[http://github.com/cldwalker/ripl-misc] : a playground for ripl plugins
 * {ripl-profiles}[https://github.com/janlelis/ripl-profiles]: load ripl profiles with a --profile option
+* {ripl-short_errors}[https://github.com/janlelis/ripl-misc/blob/master/lib/ripl/short_errors.rb]:
+  display short backtrace
 
 == 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
+* {ripl-johnson}[http://github.com/cldwalker/ripl-johnson]: A js shell based on johnson (firefox tracemonkey)
+
+== More Ripl Links
+
+* {ripl screencast}[http://www.rubypulse.com/ep0.51_ripl.html]
+* {overview of ripl features}[http://rbjl.net/44-ripl-why-should-you-use-an-irb-alternative]
 
 == Irb Alternatives
 Some other irb alternatives to check out:

data/deps.rip

@@ -1 +1 @@
-bond ~>0.3.3
+bond ~>0.3.4

data/lib/ripl.rb

@@ -5,10 +5,19 @@ module Ripl
 
   def self.start(*args); Runner.start(*args); end
 
+  def self.plugins
+    file =  File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+    $".map {|e| e[/ripl\/[^\/]+$/] }.compact -
+      Dir["#{File.dirname(file)}/ripl/*.rb"].map {|e| e[/ripl\/[^\/]+$/] }
+  end
+
   def self.shell(options={})
     @shell ||= Shell.create(config.merge!(options))
   end
-  module Commands; end
+
+  module Commands
+    class<<self; public :include; end
+  end
 end
 
 require 'ripl/shell'

data/lib/ripl/completion.rb

@@ -3,8 +3,9 @@ require 'bond'
 module Ripl::Completion
   def before_loop
     super
+    (config[:completion][:gems] ||= []).concat Ripl.plugins
     Bond.restart config[:completion]
   end
 end
-Ripl::Shell.send :include, Ripl::Completion
+Ripl::Shell.include Ripl::Completion
 Ripl.config[:completion][:eval_binding] = lambda { Ripl.shell.binding }

data/lib/ripl/history.rb

@@ -21,5 +21,5 @@ module Ripl::History
     File.open(history_file, 'w') {|f| f.write Array(history).join("\n") }
   end
 end
-Ripl::Shell.send :include, Ripl::History
+Ripl::Shell.include Ripl::History
 Ripl.config[:history] = '~/.irb_history'

data/lib/ripl/readline.rb

@@ -6,4 +6,4 @@ module Ripl::Readline
 
   def history; Readline::HISTORY; end
 end
-Ripl::Shell.send :include, Ripl::Readline
+Ripl::Shell.include Ripl::Readline

data/lib/ripl/runner.rb

@@ -64,7 +64,7 @@ module Ripl::Runner
 
     def load_rc(file)
       load file if File.exists?(File.expand_path(file))
-    rescue StandardError, SyntaxError
+    rescue StandardError, SyntaxError, LoadError
       warn "ripl: Error while loading #{file}:\n"+ format_error($!)
     end
 

data/lib/ripl/shell.rb

@@ -1,8 +1,4 @@
 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]
     require 'ripl/completion' if options[:completion]
@@ -11,6 +7,12 @@ class Ripl::Shell
     new(options)
   end
 
+  class <<self; public :include; end
+
+  OPTIONS = {:name=>'ripl', :result_prompt=>'=> ', :prompt=>'>> ',
+    :binding=>TOPLEVEL_BINDING, :irbrc=>'~/.irbrc'}
+  EXIT_WORDS = [nil, 'exit', 'quit']
+
   attr_accessor :line, :binding, :result, :name
   def initialize(options={})
     options = OPTIONS.merge options

data/lib/ripl/version.rb

@@ -1,3 +1,3 @@
 module Ripl
-  VERSION = '0.2.8'
+  VERSION = '0.2.9'
 end

data/man/ripl.1

@@ -18,7 +18,7 @@ ripl [COMMAND] [\-r|\-\-require] [\-I] [\-f] [\-d] [\-h|\-\-help] [\-v|\-\-versi
 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)\.
 .
 .SH "COMING FROM IRB"
-When first trying ripl, you may experience errors in your ~/\.irbrc due to an irb\-specific configuration\. In order to have ripl and irb coexist peacefully, you should silence these errors\. To silence them without touching your ~/\.irbrc, install the ripl\-irb gem\. This ripl plugin fakes irb\'s existence, effectively ignoring irb\-specific configuration\. Otherwise, if you don\'t mind modifying ~/\.irbrc, wrap your irb\-specific configuration in a block as follow:
+When first trying ripl, you may experience errors in your ~/\.irbrc due to an irb\-specific configuration\. In order to have ripl and irb coexist peacefully, you should silence these errors\. To silence them without touching your ~/\.irbrc, install the ripl\-irb gem\. This ripl plugin fakes irb\'s existence and points to ripl equivalents for your irb configurations\. Otherwise, if you don\'t mind modifying ~/\.irbrc, wrap your irb\-specific configuration in a block as follow:
 .
 .IP "" 4
 .
@@ -122,7 +122,7 @@ module Ripl
     end
   end
 end
-Ripl::Shell\.send :include, Ripl::RedError
+Ripl::Shell\.include Ripl::RedError
 .
 .fi
 .
@@ -196,12 +196,18 @@ end
 end
 .
 .IP
-Ripl::Commands\.send :include, Ripl::SuperHistory::Commands
+Ripl::Commands\.include Ripl::SuperHistory::Commands
 .
 .IP
 >> history # use command in ripl
 .
 .IP "\(bu" 4
+To define custom autocompletion for a plugin and its commands, create a completion file in lib/ripl/completions/plugin_name i\.e\. ripl\-super_history plugin \-> lib/ripl/completions/super_history\.rb\. The syntax of this file is explained in bond\'s docs \fIhttp://tagaholic\.me/bond/doc/Bond/Rc\.html\fR\. To autocomplete a console command, define a :method completion\. For an example plugin that uses this, see ripl\-commands \fIhttp://github\.com/cldwalker/ripl\-commands\fR\.
+.
+.IP "\(bu" 4
+For plugins with console commands, commands aren\'t immediately recognized if the plugin is required within ripl\. To fix this: Ripl\.shell\.add_commands(self)\.
+.
+.IP "\(bu" 4
 For more examples of plugins, see gems I\'ve made that start with \'ripl\-\'\.
 .
 .IP "" 0

data/man/ripl.1.html

@@ -95,7 +95,7 @@ and complex shells (i.e. for the web).</p>
 <p>When first trying ripl, you may experience errors in your ~/.irbrc due to an irb-specific
 configuration. In order to have ripl and irb coexist peacefully, you should silence these errors.
 To silence them without touching your ~/.irbrc, install the ripl-irb gem. This ripl plugin fakes
-irb's existence, effectively ignoring irb-specific configuration. Otherwise, if you don't mind
+irb's existence and points to ripl equivalents for your irb configurations. Otherwise, if you don't mind
 modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:</p>
 
 <pre><code>if defined? IRB
@@ -164,7 +164,7 @@ module Ripl
     end
   end
 end
-Ripl::Shell.send :include, Ripl::RedError
+Ripl::Shell.include Ripl::RedError
 </code></pre>
 
 <p>Note this plugin extends format_error() by invoking the original format_error() with super. To see
@@ -211,9 +211,16 @@ end
 
 <p>  end</p>
 
-<p>  Ripl::Commands.send :include, Ripl::SuperHistory::Commands</p>
+<p>  Ripl::Commands.include Ripl::SuperHistory::Commands</p>
 
 <p>  >> history # use command in ripl</p></li>
+<li><p>To define custom autocompletion for a plugin and its commands, create a completion file in
+lib/ripl/completions/plugin_name i.e. ripl-super_history plugin -> lib/ripl/completions/super_history.rb.
+The syntax of this file is explained <a href="http://tagaholic.me/bond/doc/Bond/Rc.html">in bond's docs</a>.
+To autocomplete a console command, define a :method completion. For an example plugin that uses this, see
+<a href="http://github.com/cldwalker/ripl-commands">ripl-commands</a>.</p></li>
+<li><p>For plugins with console commands, commands aren't immediately recognized if the plugin is required within ripl.
+To fix this: Ripl.shell.add_commands(self).</p></li>
 <li><p>For more examples of plugins, see gems I've made that start with 'ripl-'.</p></li>
 </ul>
 

data/man/ripl.1.ronn

@@ -17,7 +17,7 @@ and complex shells (i.e. for the web).
 When first trying ripl, you may experience errors in your ~/.irbrc due to an irb-specific
 configuration. In order to have ripl and irb coexist peacefully, you should silence these errors.
 To silence them without touching your ~/.irbrc, install the ripl-irb gem. This ripl plugin fakes
-irb's existence, effectively ignoring irb-specific configuration. Otherwise, if you don't mind
+irb's existence and points to ripl equivalents for your irb configurations. Otherwise, if you don't mind
 modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
 
     if defined? IRB
@@ -95,7 +95,7 @@ For an example shell plugin, let's color error messages red:
         end
       end
     end
-    Ripl::Shell.send :include, Ripl::RedError
+    Ripl::Shell.include Ripl::RedError
 
 Note this plugin extends format_error() by invoking the original format_error() with super. To see
 what methods are available for extension, see Ripl::Shell::API and Ripl::Runner::API.
@@ -138,10 +138,19 @@ Points to consider when creating plugins:
       end
     end
 
-    Ripl::Commands.send :include, Ripl::SuperHistory::Commands
+    Ripl::Commands.include Ripl::SuperHistory::Commands
 
     \>\> history # use command in ripl
 
+* To define custom autocompletion for a plugin and its commands, create a completion file in
+  lib/ripl/completions/plugin_name i.e. ripl-super_history plugin -> lib/ripl/completions/super_history.rb.
+  The syntax of this file is explained [in bond's docs](http://tagaholic.me/bond/doc/Bond/Rc.html).
+  To autocomplete a console command, define a :method completion. For an example plugin that uses this, see
+  [ripl-commands](http://github.com/cldwalker/ripl-commands).
+
+* For plugins with console commands, commands aren't immediately recognized if the plugin is required within ripl.
+  To fix this: Ripl.shell.add_commands(self).
+
 * For more examples of plugins, see gems I've made that start with 'ripl-'.
 
 ## CREATE CUSTOM SHELLS

data/test/completion_test.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe "Completion" do
+  describe "#before_loop" do
+    before_all do
+      require 'ripl/completion'
+      @shell = Object.new.extend(
+        Module.new {
+          attr_accessor :config
+          def before_loop; end
+      }).extend Ripl::Completion
+    end
+
+    before { @shell.config = {:completion => {}} }
+    after { $".pop }
+
+    it "adds gem plugin to config" do
+      $" << '/dir/ripl/some_plugin.rb'
+      mock(Bond).restart(:gems =>['ripl/some_plugin.rb'])
+      @shell.before_loop
+    end
+
+    it "doesn't add local plugin to config" do
+      $" << '/dir/ripl/completion.rb'
+      mock(Bond).restart(:gems =>[])
+      @shell.before_loop
+    end
+  end
+end

data/test/deps.rip

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

data/test/runner_test.rb

@@ -49,11 +49,17 @@ describe "Runner" do
         Ripl.config[:blah].should == true
       end
 
-      it "catches and prints error" do
+      it "rescues and prints SyntaxError" do
         mock(Runner).load(anything) { raise SyntaxError }
         mock_shell
         capture_stderr { Runner.run([]) }.should =~ %r{^ripl: Error while loading ~/.riplrc:\nSyntaxError:}
       end
+
+      it "rescues and prints LoadError" do
+        mock(Runner).load(anything) { raise LoadError }
+        mock_shell
+        capture_stderr { Runner.run([]) }.should =~ %r{^ripl: Error while loading ~/.riplrc:\nLoadError:}
+      end
     end
 
     describe "with subcommand" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ripl
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 2
-  - 8
-  version: 0.2.8
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 -05:00
+date: 2010-12-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,12 +26,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 27
         segments: 
         - 0
         - 3
-        - 3
-        version: 0.3.3
+        - 4
+        version: 0.3.4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -80,6 +80,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bacon-rr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 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: 
@@ -97,6 +111,7 @@ files:
 - lib/ripl/shell.rb
 - lib/ripl/version.rb
 - lib/ripl.rb
+- test/completion_test.rb
 - test/runner_test.rb
 - test/shell_test.rb
 - test/test_helper.rb