ripl 0.2.2 → 0.2.3

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.2.3
+* Add Shell docs
+* Sync shell binding with completion binding
+* Removed Shell#options
+
 == 0.2.2
 * Add man page
 

data/README.rdoc

@@ -61,7 +61,7 @@ modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
   * 6 common commandline options: -f, -r, -I, -d, -h, -v
   * IRB.conf -> Ripl.config
 * Enhancements over irb
-  * ~200 lines vs irb's 5000+ lines
+  * ~230 lines vs irb's 5000+ lines
   * Easily extendable with plugins
   * Tests and documentation!
   * Customizable completion and completion of method arguments (from bond)
@@ -83,7 +83,9 @@ loading them as early as possible and allowing them to extend most of ripl's fun
 
 As an example plugin, let's color error messages red:
 
-    # Place in ~/.riplrc
+    require 'ripl'
+
+    # To try place in ~/.riplrc
     module Ripl
       module RedError
         def format_error(error)

data/deps.rip

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

data/lib/ripl/completion.rb

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

data/lib/ripl/shell.rb

@@ -1,5 +1,5 @@
 class Ripl::Shell
-  OPTIONS = {:name=>'ripl', :line=>1, :result_prompt=>'=> ', :prompt=>'>> ',
+  OPTIONS = {:name=>'ripl', :result_prompt=>'=> ', :prompt=>'>> ',
     :binding=>TOPLEVEL_BINDING, :irbrc=>'~/.irbrc'}
 
   def self.create(options={})
@@ -10,13 +10,15 @@ class Ripl::Shell
     new(options)
   end
 
-  attr_accessor :line, :binding, :result_prompt, :result, :options
+  attr_accessor :line, :binding, :result_prompt, :result, :name
   def initialize(options={})
-    @options = OPTIONS.merge options
-    @name, @binding, @line = @options.values_at(:name, :binding, :line)
-    @irbrc = @options[:irbrc]
+    options = OPTIONS.merge options
+    @name, @binding = options.values_at(:name, :binding)
+    @prompt, @result_prompt = options.values_at(:prompt, :result_prompt)
+    @irbrc, @line = options[:irbrc], 1
   end
 
+  # Loops shell until user exits
   def loop
     before_loop
     catch(:ripl_exit) { while(true) do; loop_once; end }
@@ -25,56 +27,72 @@ class Ripl::Shell
 
   def config; Ripl.config; end
 
+  # Runs through one loop iteration: gets input, evals and prints result
+  def loop_once
+    @error_raised = nil
+    @input = get_input
+    throw(:ripl_exit) if !@input || @input == 'exit'
+    eval_input(@input)
+    print_result(@result)
+  end
+
+  # Sets @result to result of evaling input and print unexpected errors
+  def eval_input(input)
+    @result = loop_eval(input)
+    eval("_ = Ripl.shell.result", @binding)
+  rescue Exception => e
+    @error_raised = true
+    print_eval_error(e)
+  ensure
+    @line += 1
+  end
+
   module API
+    # Sets up shell before looping by loading ~/.irbrc. Can be extended to
+    # initialize plugins and their instance variables.
     def before_loop
       Ripl::Runner.load_rc(@irbrc) if @irbrc
     end
 
-    def loop_once
-      @error_raised = nil
-      @input = get_input
-      throw(:ripl_exit) if !@input || @input == 'exit'
-      eval_input(@input)
-      print_result(@result)
-    end
-
+    # @return [String, nil] Prints #prompt and returns input given by user
     def get_input
       print prompt
       $stdin.gets.chomp
     end
 
+    # @return [String]
     def prompt
-      @options[:prompt].respond_to?(:call) ? @options[:prompt].call : @options[:prompt]
-    end
-
-    def eval_input(input)
-      @result = loop_eval(input)
-      eval("_ = Ripl.shell.result", @binding)
-    rescue Exception => e
-      @error_raised = true
-      print_eval_error(e)
-    ensure
-      @line += 1
+      @prompt.respond_to?(:call) ? @prompt.call : @prompt
     end
 
+    # Evals user input using @binding, @name and @line
     def loop_eval(str)
       eval(str, @binding, "(#{@name})", @line)
     end
 
+    # Prints error formatted by #format_error to STDERR. Could be extended to
+    # handle certain exceptions.
+    # @param [Exception]
     def print_eval_error(err)
       warn format_error(err)
     end
 
+    # Prints result using #format_result
     def print_result(result)
       puts(format_result(result)) unless @error_raised
     end
 
+    # Formats errors raised by eval of user input
+    # @param [Exception]
+    # @return [String]
     def format_error(err); Ripl::Runner.format_error(err); end
 
+    # @return [String] Formats result using result_prompt
     def format_result(result)
-      @options[:result_prompt] + result.inspect
+      @result_prompt + result.inspect
     end
 
+    # Called after shell finishes looping.
     def after_loop; end
   end
   include API

data/lib/ripl/version.rb

@@ -1,3 +1,3 @@
 module Ripl
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/man/ripl.1

@@ -112,7 +112,9 @@ For an example shell plugin, let\'s color error messages red:
 .
 .nf
 
-# Place in ~/\.riplrc
+require \'ripl\'
+
+# To try place in ~/\.riplrc
 module Ripl
   module RedError
     def format_error(error)
@@ -136,7 +138,7 @@ Points to consider when creating plugins:
 When adding functionality to a method, make sure to call \fBsuper\fR to preserve existing functionality\.
 .
 .IP "\(bu" 4
-When replacing functionality for a method, make sure the method\'s expectations are met i\.e\. setting a specific instance variable\. Failure to do so, will \fBbreak\fR ripl for you and anyone else who uses your plugin!
+When replacing functionality for a method, make sure the method\'s expectations are met i\.e\. setting a specific instance variable or calling certain methods\. Failure to do so can \fBbreak\fR ripl for you and anyone else who uses your plugin!
 .
 .IP "\(bu" 4
 Plugins can setup and teardown anything around a shell by extending Shell#before_loop and Shell#after_loop:
@@ -150,14 +152,12 @@ module Ripl::MyPlugin
 
 def before_loop
   super
-  Ripl\.config[:my_plugin] ||= :web_scale
+  # Open file, open connection \.\.\.
 end
 
 def after_loop
   super
-  # Write to files
-  # close a connection
-  # \.\.\.
+  # Write to file, close a connection \.\.\.
 end
 .
 .fi
@@ -168,7 +168,7 @@ end
 end
 .
 .IP "\(bu" 4
-To add configuration for a plugin, add a key to Ripl\.config that matches the underscored version of the plugin name i\.e\. Ripl::RedError \-> Ripl\.config[:red_error]\. To set a default config value, see the previous example\.
+To add configuration for a plugin, add a key to Ripl\.config that matches the underscored version of the plugin name i\.e\. Ripl::RedError \-> Ripl\.config[:red_error]\. To set a default config value, just set it after including the plugin into Ripl::Shell\.
 .
 .IP "\(bu" 4
 For more examples of plugins, see gems I\'ve made that start with \'ripl\-\'\.

data/man/ripl.1.ronn

@@ -84,7 +84,9 @@ be required in ~/.irbrc.
 
 For an example shell plugin, let's color error messages red:
 
-    # Place in ~/.riplrc
+    require 'ripl'
+
+    # To try place in ~/.riplrc
     module Ripl
       module RedError
         def format_error(error)
@@ -102,28 +104,26 @@ Points to consider when creating plugins:
 * When adding functionality to a method, make sure to call `super` to preserve existing functionality.
 
 * When replacing functionality for a method, make sure the method's expectations are met i.e.
-setting a specific instance variable. Failure to do so, will `break` ripl for you and anyone else
-who uses your plugin!
+setting a specific instance variable or calling certain methods. Failure to do so can `break` ripl
+for you and anyone else who uses your plugin!
 
 * Plugins can setup and teardown anything around a shell by extending Shell#before_loop and Shell#after_loop:
 
     module Ripl::MyPlugin
       def before_loop
         super
-        Ripl.config[:my_plugin] ||= :web_scale
+        # Open file, open connection ...
       end
 
       def after_loop
         super
-        # Write to files
-        # close a connection
-        # ...
+        # Write to file, close a connection ...
       end
     end
 
 * To add configuration for a plugin, add a key to Ripl.config that matches the underscored version
-of the plugin name i.e. Ripl::RedError -> Ripl.config[:red_error]. To set a default config value, see
-the previous example.
+of the plugin name i.e. Ripl::RedError -> Ripl.config[:red_error]. To set a default config value, just set it
+after including the plugin into Ripl::Shell.
 
 * For more examples of plugins, see gems I've made that start with 'ripl-'.
 

data/test/runner_test.rb

@@ -10,18 +10,18 @@ describe "Runner" do
       Ripl.start
     end
 
-    it "sets a shell's options" do
+    it "sets a shell's variables" do
       mock_riplrc
       mock(Shell).create(anything) {|e| shell = Shell.new(e); mock(shell).loop; shell }
-      Ripl.start(:prompt=>'$')
-      Ripl.shell.options[:prompt].should == '$'
+      Ripl.start(:name=>'shh')
+      Ripl.shell.name.should == 'shh'
     end
 
-    it "overrides options set in riplrc" do
-      mock_riplrc { Ripl.config[:readline] = false }
+    it "overrides config set in riplrc" do
+      mock_riplrc { Ripl.config[:name] = 'blah' }
       mock(Shell).create(anything) {|e| shell = Shell.new(e); mock(shell).loop; shell }
-      Ripl.start(:readline=>true)
-      Ripl.shell.options[:readline].should == true
+      Ripl.start(:name=>'dude')
+      Ripl.shell.name.should == 'dude'
     end
   end
 
@@ -29,11 +29,11 @@ describe "Runner" do
     describe "riplrc" do
       before { reset_ripl }
 
-      it "sets a shell's options" do
+      it "sets config" 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
+        Ripl.config[:blah].should == true
       end
 
       it "catches and prints error" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ripl
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-14 00:00:00 -05:00
+date: 2010-11-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency