ripl 0.3.6 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.4.0
+* Support internationalization
+* Allow #history to be overridden easily
+
 == 0.3.6
 * Add Ripl.started?
 

data/README.rdoc

@@ -75,7 +75,7 @@ modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
   * IRB.conf -> Ripl.config
   * Handles Ctrl-C quietly
 * Enhancements over irb
-  * ~270 lines (doc included) vs irb's 5000+ lines
+  * ~290 lines (doc included) vs irb's 5000+ lines
   * Easily extendable with plugins
   * Tests and documentation!
   * Customizable completion and completion of method arguments (from bond)
@@ -84,6 +84,7 @@ modifying ~/.irbrc, wrap your irb-specific configuration in a block as follow:
   * Create console commands in a simple, modular way
   * Custom commandline options can be added via a plugin
   * ~/.irbrc errors caught
+  * Well-integrated internationalization (see {ripl-i18n}[http://github.com/cldwalker/ripl-i18n])
 * Different from irb
   * No multi-line evaluation by default (but there is a plugin,
     {ripl-multi_line}[http://github.com/janlelis/ripl-multi_line]).
@@ -151,8 +152,8 @@ command you can take arguments and parse your options as you please. For an exam
 see {ripl-rails}[http://github.com/cldwalker/ripl-rails].
 
 == Credits
-* janlelis for bug fix and tweaks
-* godfat and JoshCheek for bug fixes
+* janlelis and godfat for bug fix and tweaks
+* JoshCheek for bug fixes
 
 == Ripl Plugins
 
@@ -164,6 +165,7 @@ see {ripl-rails}[http://github.com/cldwalker/ripl-rails].
 * {ripl-debug}[http://github.com/cldwalker/ripl-debug] : automatically debugs a failed eval
 * {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-i18n}[http://github.com/cldwalker/ripl-i18n] : translates ripl to your language
 * {ripl-commands}[http://github.com/cldwalker/ripl-commands] : adds ripl commands similar to irb's commands
 * {ripl-color_error}[http://github.com/cldwalker/ripl-color_error] : colorize errors
 * {ripl-color_streams}[http://github.com/janlelis/ripl-color_streams] : colorizes stderr + stdout

data/lib/ripl/history.rb

@@ -3,14 +3,13 @@ module Ripl::History
     @history_file ||= File.expand_path(config[:history])
   end
 
-  def history; @history; end
+  def history() @history ||= [] end
 
   def get_input
     (@history << super)[-1]
   end
 
   def before_loop
-    @history = []
     super
     File.exists?(history_file) &&
       IO.readlines(history_file).each {|e| history << e.chomp }
@@ -19,7 +18,7 @@ module Ripl::History
   def write_history
     File.open(history_file, 'w') {|f| f.write Array(history).join("\n") }
   end
-  def after_loop; write_history; end
+  def after_loop() write_history end
 end
 Ripl::Shell.include Ripl::History
 Ripl.config[:history] = '~/.irb_history'

data/lib/ripl/readline.rb

@@ -3,6 +3,6 @@ module Ripl::Readline
     Readline.readline prompt, true
   end
 
-  def history; Readline::HISTORY; end
+  def before_loop() @history = Readline::HISTORY; super end
 end
 Ripl::Shell.include Ripl::Readline

data/lib/ripl/runner.rb

@@ -1,19 +1,30 @@
 class Ripl::Runner
-  OPTIONS = [
-    ['-f', 'Suppress loading ~/.irbrc'],
-    ['-F', 'Suppress loading ~/.riplrc'],
-    ['-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')"],
-    ['-v, --version', 'Print version'],
-    ['-h, --help', 'Print help']
-  ]
+  OPTIONS_ARR = %w{-f -F -d -I -r -v -h}
+  OPTIONS = {
+    '-f' => ['-f', 'Suppress loading ~/.irbrc'],
+    '-F' => ['-F', 'Suppress loading ~/.riplrc'],
+    '-d' => ['-d, --debug', "Set $DEBUG to true (same as `ruby -d')"],
+    '-I' => ['-I PATH', "Add to front of $LOAD_PATH. Delimit multiple paths with ':'"],
+    '-r' => ['-r, --require FILE', "Require file (same as `ruby -r')"],
+    '-v' => ['-v, --version', 'Print version'],
+    '-h' => ['-h, --help', 'Print help']
+  }
+  MESSAGES = {
+    'run_command' => "`%s' is not a %s command.",
+    'start' => "Unused arguments",
+    'load_rc' => 'Error while loading %s',
+    'parse_option' => 'invalid option'
+  }
+
   class <<self; attr_accessor :argv, :app; end
   self.app = 'ripl'
 
   # Adds commandline options for --help
   def self.add_options(*options)
-    OPTIONS.concat(options)
+    options.each {|e|
+      OPTIONS[e[0][/-\w+/]] = e
+      OPTIONS_ARR << e[0][/-\w+/]
+    }
   end
 
   def self.run(argv=ARGV)
@@ -24,7 +35,7 @@ class Ripl::Runner
     exec "#{app}-#{argv.shift}", *argv
   rescue Errno::ENOENT
     raise unless $!.message =~ /No such file or directory.*#{app}-(\w+)/
-    abort "`#{$1}' is not a #{app} command."
+    abort MESSAGES['run_command'] % [$1, app]
   end
 
   def self.start(options={})
@@ -33,14 +44,14 @@ class Ripl::Runner
     load_rc(Ripl.config[:riplrc]) unless argv.delete('-F') || options[:riplrc] == false
     argv.each {|e| e[/^-/] ? break : argv.shift } if $0[/#{app}-\w+$/]
     parse_options(argv) if $0[/#{app}$|#{app}-\w+$/]
-    warn "#{app}: Unused arguments: #{argv.inspect}" if !argv.empty?
+    warn "#{app}: #{MESSAGES['start']}: #{argv.inspect}" if !argv.empty?
     Ripl.shell(options).loop
   end
 
   def self.load_rc(file)
     load file if File.exists?(File.expand_path(file))
   rescue StandardError, SyntaxError, LoadError
-    warn "#{app}: Error while loading #{file}:\n"+ format_error($!)
+    warn "#{app}: #{MESSAGES['load_rc'] % file}:\n"+ format_error($!)
   end
 
   module API
@@ -61,14 +72,14 @@ class Ripl::Runner
 
     def help
       return("#{app} #{$1} [ARGS] [OPTIONS]") if $0[/#{app}-(\w+)/]
-      name_max = OPTIONS.map {|e| e[0].length }.max
-      desc_max = OPTIONS.map {|e| e[1].length }.max
-      ["Usage: #{app} [COMMAND] [ARGS] [OPTIONS]", "\nOptions:",
-        OPTIONS.map {|k,v| "  %-*s  %-*s" % [name_max, k, desc_max, v] }]
+      name_max = OPTIONS.values.map {|e| e[0].length }.max
+      desc_max = OPTIONS.values.map {|e| e[1].length }.max
+      ["Usage: #{app} [COMMAND] [ARGS] [OPTIONS]", "\nOptions:", OPTIONS_ARR.
+        map {|e| n,d = OPTIONS[e]; "  %-*s  %-*s" % [name_max, n, desc_max, d] }]
     end
 
     def parse_option(option, argv)
-      warn "#{app}: invalid option `#{option.sub(/^-+/, '')}'"
+      warn "#{app}: #{MESSAGES['parse_option']} `#{option.sub(/^-+/, '')}'"
     end
 
     def format_error(err)

data/lib/ripl/shell.rb

@@ -27,13 +27,16 @@ class Ripl::Shell
   # Loops shell until user exits
   def loop
     before_loop
-    catch(:ripl_exit) { while(true) do; loop_once; end }
+    catch(:ripl_exit) { loop_once while(true) }
     after_loop
   end
 
-  def config; Ripl.config; end
+  def config() Ripl.config end
 
   module API
+    MESSAGES = {'prompt' => 'Error while creating prompt',
+      'print_result' => 'Error while printing result'}
+
     attr_accessor :prompt, :result_prompt
     # Sets up shell before looping by loading ~/.irbrc. Can be extended to
     # initialize plugins and their instance variables.
@@ -59,7 +62,7 @@ class Ripl::Shell
     end
 
     # Handles interrupt (Control-C) by printing a newline
-    def handle_interrupt; puts; end
+    def handle_interrupt() puts end
 
     # Sets @result to result of evaling input and print unexpected errors
     def eval_input(input)
@@ -84,7 +87,7 @@ class Ripl::Shell
     def prompt
       @prompt.respond_to?(:call) ? @prompt.call : @prompt
     rescue StandardError, SyntaxError
-      warn "ripl: Error while creating prompt:\n"+ format_error($!)
+      warn "ripl: #{MESSAGES['prompt']}:\n"+ format_error($!)
       OPTIONS[:prompt]
     end
 
@@ -104,13 +107,13 @@ class Ripl::Shell
     def print_result(result)
       puts(format_result(result)) unless @error_raised
     rescue StandardError, SyntaxError
-      warn "ripl: Error while printing result:\n"+ format_error($!)
+      warn "ripl: #{MESSAGES['print_result']}:\n"+ format_error($!)
     end
 
     # Formats errors raised by eval of user input
     # @param [Exception]
     # @return [String]
-    def format_error(err); Ripl::Runner.format_error(err); end
+    def format_error(err) Ripl::Runner.format_error(err) end
 
     # @return [String] Formats result using result_prompt
     def format_result(result)

data/lib/ripl/version.rb

@@ -1,3 +1,3 @@
 module Ripl
-  VERSION = '0.3.6'
+  VERSION = '0.4.0'
 end

data/lib/ripl.rb

@@ -3,8 +3,8 @@ module Ripl
     @config ||= {:readline => true, :riplrc => '~/.riplrc', :completion => {}}
   end
 
-  def self.start(*args); Runner.start(*args); end
-  def self.started?; instance_variable_defined? :@shell; end
+  def self.start(*args) Runner.start(*args) end
+  def self.started?()   instance_variable_defined?(:@shell) end
 
   def self.plugins
     file =  File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__

data/test/history_test.rb

@@ -44,4 +44,18 @@ describe "History with readline" do
     shell.after_loop
     shell.history.should == ['pong_write_history']
   end
+
+  it "#history is overridable in #write_history when readline is enabled" do
+    stub(Shell).include(is_a(Module)){} # try to avoid side-effect...
+    require 'ripl/readline'
+    SandboxShell = Shell.dup
+    SandboxShell.send :include, Ripl::Readline
+    sandbox_shell = SandboxShell.create(:readline => true)
+
+    mod = Module.new { def write_history() @history = ['updated_history']  end }
+    SandboxShell.send :include, mod
+
+    sandbox_shell.after_loop
+    sandbox_shell.history.should == ['updated_history']
+  end
 end

data/test/runner_test.rb

@@ -294,6 +294,16 @@ describe "Runner" do
         Runner.send(meth).should == "pong_#{meth}"
       end
     end
+
+    it "Runner::MESSAGES only calls #[]" do
+      str = File.read(File.dirname(__FILE__)+'/../lib/ripl/runner.rb')
+      str.scan(/MESSAGES\S+/).all? {|e| e[/MESSAGES\[/] }.should == true
+    end
+
+    it "Runner::OPTIONS only calls #[] and values" do
+      str = File.read(File.dirname(__FILE__)+'/../lib/ripl/runner.rb')
+      str.scan(/OPTIONS[^_\] ]\S+/).all? {|e| e[/OPTIONS(\[|\.values)/] }.should == true
+    end
     after_all { Runner.extend Runner::API }
   end
 end

data/test/shell_test.rb

@@ -136,5 +136,10 @@ describe "Shell" do
         shell.send(meth).should == "pong_#{meth}"
       end
     end
+
+    it "Shell::MESSAGES only calls #[]" do
+      str = File.read(File.dirname(__FILE__)+'/../lib/ripl/shell.rb')
+      str.scan(/MESSAGES\S+/).all? {|e| e[/MESSAGES\[/] }.should == true
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ripl
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 6
-  version: 0.3.6
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-24 00:00:00 -04:00
+date: 2011-05-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency