rubysl-irb 1.0.2 → 2.0.3

data/lib/irb/ext/loader.rb

@@ -1,25 +1,29 @@
 #
-#   loader.rb - 
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   loader.rb -
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
-#   
+#
 #
 
 
-module IRB
+module IRB # :nodoc:
+  # Raised in the event of an exception in a file loaded from an Irb session
   class LoadAbort < Exception;end
 
+  # Provides a few commands for loading files within an irb session.
+  #
+  # See ExtendCommandBundle for more information.
   module IrbLoader
-    @RCS_ID='-$Id: loader.rb 11708 2007-02-12 23:01:19Z shyouhei $-'
+    @RCS_ID='-$Id$-'
 
     alias ruby_load load
     alias ruby_require require
 
+    # Loads the given file similarly to Kernel#load
     def irb_load(fn, priv = nil)
       path = search_file_from_ruby_path(fn)
       raise LoadError, "No such file to load -- #{fn}" unless path
@@ -27,7 +31,7 @@ module IRB
       load_file(path, priv)
     end
 
-    def search_file_from_ruby_path(fn)
+    def search_file_from_ruby_path(fn) # :nodoc:
       if /^#{Regexp.quote(File::Separator)}/ =~ fn
 	return fn if File.exist?(fn)
 	return nil
@@ -41,11 +45,14 @@ module IRB
       return nil
     end
 
+    # Loads a given file in the current session and displays the source lines
+    #
+    # See Irb#suspend_input_method for more information.
     def source_file(path)
       irb.suspend_name(path, File.basename(path)) do
 	irb.suspend_input_method(FileInputMethod.new(path)) do
 	  |back_io|
-	  irb.signal_status(:IN_LOAD) do 
+	  irb.signal_status(:IN_LOAD) do
 	    if back_io.kind_of?(FileInputMethod)
 	      irb.eval_input
 	    else
@@ -60,9 +67,12 @@ module IRB
       end
     end
 
+    # Loads the given file in the current session's context and evaluates it.
+    #
+    # See Irb#suspend_input_method for more information.
     def load_file(path, priv = nil)
       irb.suspend_name(path, File.basename(path)) do
-	
+
 	if priv
 	  ws = WorkSpace.new(Module.new)
 	else
@@ -71,7 +81,7 @@ module IRB
 	irb.suspend_workspace(ws) do
 	  irb.suspend_input_method(FileInputMethod.new(path)) do
 	    |back_io|
-	    irb.signal_status(:IN_LOAD) do 
+	    irb.signal_status(:IN_LOAD) do
 #	      p irb.conf
 	      if back_io.kind_of?(FileInputMethod)
 		irb.eval_input
@@ -88,7 +98,7 @@ module IRB
       end
     end
 
-    def old
+    def old # :nodoc:
       back_io = @io
       back_path = @irb_path
       back_name = @irb_name

data/lib/irb/ext/math-mode.rb

@@ -1,23 +1,33 @@
 #
-#   math-mode.rb - 
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   math-mode.rb -
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
-#   
+#
 #
 require "mathn"
 
 module IRB
   class Context
+    # Returns whether bc mode is enabled.
+    #
+    # See #math_mode=
     attr_reader :math_mode
+    # Alias for #math_mode
     alias math? math_mode
 
+    # Sets bc mode, which loads +lib/mathn.rb+ so fractions or matrix are
+    # available.
+    #
+    # Also available as the +-m+ command line option.
+    #
+    # See IRB@Command+line+options and the unix manpage <code>bc(1)</code> for
+    # more information.
     def math_mode=(opt)
-      if @math_mode == true && opt == false
+      if @math_mode == true && !opt
 	IRB.fail CantReturnToNormalMode
 	return
       end

data/lib/irb/ext/multi-irb.rb

@@ -1,56 +1,72 @@
 #
 #   irb/multi-irb.rb - multiple irb module
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
-#   
+#
 #
 IRB.fail CantShiftToMultiIrbMode unless defined?(Thread)
 require "thread"
 
 module IRB
-  # job management class
   class JobManager
-    @RCS_ID='-$Id: multi-irb.rb 11708 2007-02-12 23:01:19Z shyouhei $-'
+    @RCS_ID='-$Id$-'
 
+    # Creates a new JobManager object
     def initialize
       # @jobs = [[thread, irb],...]
       @jobs = []
       @current_job = nil
     end
 
+    # The active irb session
     attr_accessor :current_job
 
+    # The total number of irb sessions, used to set +irb_name+ of the current
+    # Context.
     def n_jobs
       @jobs.size
     end
 
+    # Returns the thread for the given +key+ object, see #search for more
+    # information.
     def thread(key)
-      th, irb = search(key)
+      th, = search(key)
       th
     end
 
+    # Returns the irb session for the given +key+ object, see #search for more
+    # information.
     def irb(key)
-      th, irb = search(key)
+      _, irb = search(key)
       irb
     end
 
+    # Returns the top level thread.
     def main_thread
       @jobs[0][0]
     end
 
+    # Returns the top level irb session.
     def main_irb
       @jobs[0][1]
     end
 
+    # Add the given +irb+ session to the jobs Array.
     def insert(irb)
       @jobs.push [Thread.current, irb]
     end
 
+    # Changes the current active irb session to the given +key+ in the jobs
+    # Array.
+    #
+    # Raises an IrbAlreadyDead exception if the given +key+ is no longer alive.
+    #
+    # If the given irb session is already active, an IrbSwitchedToCurrentThread
+    # exception is raised.
     def switch(key)
       th, irb = search(key)
       IRB.fail IrbAlreadyDead unless th.alive?
@@ -61,16 +77,36 @@ module IRB
       @current_job = irb(Thread.current)
     end
 
+    # Terminates the irb sessions specified by the given +keys+.
+    #
+    # Raises an IrbAlreadyDead exception if one of the given +keys+ is already
+    # terminated.
+    #
+    # See Thread#exit for more information.
     def kill(*keys)
       for key in keys
-	th, irb = search(key)
+	th, _ = search(key)
 	IRB.fail IrbAlreadyDead unless th.alive?
 	th.exit
       end
-    end    
+    end
 
+    # Returns the associated job for the given +key+.
+    #
+    # If given an Integer, it will return the +key+ index for the jobs Array.
+    #
+    # When an instance of Irb is given, it will return the irb session
+    # associated with +key+.
+    #
+    # If given an instance of Thread, it will return the associated thread
+    # +key+ using Object#=== on the jobs Array.
+    #
+    # Otherwise returns the irb session with the same top-level binding as the
+    # given +key+.
+    #
+    # Raises a NoSuchJob exception if no job can be found with the given +key+.
     def search(key)
-      case key
+      job = case key
       when Integer
 	@jobs[key]
       when Irb
@@ -78,12 +114,13 @@ module IRB
       when Thread
 	@jobs.assoc(key)
       else
-	assoc = @jobs.find{|k, v| v.context.main.equal?(key)}
-	IRB.fail NoSuchJob, key if assoc.nil?
-	assoc
+	@jobs.find{|k, v| v.context.main.equal?(key)}
       end
+      IRB.fail NoSuchJob, key if job.nil?
+      job
     end
 
+    # Deletes the job at the given +key+.
     def delete(key)
       case key
       when Integer
@@ -107,6 +144,7 @@ module IRB
       @jobs.push assoc
     end
 
+    # Outputs a list of jobs, see the irb command +irb_jobs+, or +jobs+.
     def inspect
       ary = []
       @jobs.each_index do
@@ -124,8 +162,8 @@ module IRB
 	  t_status = "exited"
 	end
 	ary.push format("#%d->%s on %s (%s: %s)",
-			i, 
-			irb.context.irb_name, 
+			i,
+			irb.context.irb_name,
 			irb.context.main,
 			th,
 			t_status)
@@ -136,22 +174,27 @@ module IRB
 
   @JobManager = JobManager.new
 
+  # The current JobManager in the session
   def IRB.JobManager
     @JobManager
   end
 
+  # The current Context in this session
   def IRB.CurrentContext
     IRB.JobManager.irb(Thread.current).context
   end
 
-  # invoke multi-irb 
+  # Creates a new IRB session, see Irb.new.
+  #
+  # The optional +file+ argument is given to Context.new, along with the
+  # workspace created with the remaining arguments, see WorkSpace.new
   def IRB.irb(file = nil, *main)
     workspace = WorkSpace.new(*main)
     parent_thread = Thread.current
     Thread.start do
       begin
 	irb = Irb.new(workspace, file)
-      rescue 
+      rescue
 	print "Subirb can't start with context(self): ", workspace.main.inspect, "\n"
 	print "return to main irb\n"
 	Thread.pass
@@ -173,12 +216,14 @@ module IRB
       ensure
 	unless system_exit
 	  @JobManager.delete(irb)
-	  if parent_thread.alive?
-	    @JobManager.current_job = @JobManager.irb(parent_thread)
-	    parent_thread.run
-	  else
-	    @JobManager.current_job = @JobManager.main_irb
-	    @JobManager.main_thread.run
+	  if @JobManager.current_job == irb
+	    if parent_thread.alive?
+	      @JobManager.current_job = @JobManager.irb(parent_thread)
+	      parent_thread.run
+	    else
+	      @JobManager.current_job = @JobManager.main_irb
+	      @JobManager.main_thread.run
+	    end
 	  end
 	end
       end

data/lib/irb/ext/save-history.rb

@@ -1,10 +1,7 @@
-#!/usr/local/bin/ruby
-#
 #   save-history.rb -
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
-#   	by Keiju ISHITSUKAkeiju@ruby-lang.org)
+#   	$Release Version: 0.9.6$
+#   	$Revision$
+#   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
@@ -14,57 +11,110 @@
 require "readline"
 
 module IRB
-  class Context
-    def init_save_history
-      hist = IRB.conf[:HISTORY_FILE]
-      hist = IRB.rc_file("_history") unless hist
-      if File.exist?(hist)
-        open(hist) do |f|
-          f.each {|l| Readline::HISTORY << l.chomp}
-        end
-      end
-
-      at_exit do
-        if num = IRB.conf[:SAVE_HISTORY] and (num = num.to_i) > 0
-          if hf = IRB.conf[:HISTORY_FILE]
-            file = File.expand_path(hf)
-          end
-          file = IRB.rc_file("_history") unless file
-
-          open(file, 'w' ) do |f|
-            prev_line = nil
-            Readline::HISTORY.each do |line|
-              unless line == prev_line
-                f.puts line
-              end
+  module HistorySavingAbility # :nodoc:
+    @RCS_ID='-$Id$-'
+  end
 
-              prev_line = line
-            end
-          end
-        end
+  class Context
+    def init_save_history# :nodoc:
+      unless (class<<@io;self;end).include?(HistorySavingAbility)
+	@io.extend(HistorySavingAbility)
       end
     end
 
+    # A copy of the default <code>IRB.conf[:SAVE_HISTORY]</code>
     def save_history
       IRB.conf[:SAVE_HISTORY]
     end
 
+    # Sets <code>IRB.conf[:SAVE_HISTORY]</code> to the given +val+ and calls
+    # #init_save_history with this context.
+    #
+    # Will store the number of +val+ entries of history in the #history_file
+    #
+    # Add the following to your +.irbrc+ to change the number of history
+    # entries stored to 1000:
+    #
+    #     IRB.conf[:SAVE_HISTORY] = 1000
     def save_history=(val)
       IRB.conf[:SAVE_HISTORY] = val
       if val
-        main_context = IRB.conf[:MAIN_CONTEXT]
-        main_context = self unless main_context
-        main_context.init_save_history
+	main_context = IRB.conf[:MAIN_CONTEXT]
+	main_context = self unless main_context
+	main_context.init_save_history
       end
     end
 
+    # A copy of the default <code>IRB.conf[:HISTORY_FILE]</code>
     def history_file
       IRB.conf[:HISTORY_FILE]
     end
 
+    # Set <code>IRB.conf[:HISTORY_FILE]</code> to the given +hist+.
     def history_file=(hist)
       IRB.conf[:HISTORY_FILE] = hist
     end
   end
-end
 
+  module HistorySavingAbility # :nodoc:
+    include Readline
+
+#     def HistorySavingAbility.create_finalizer
+#       proc do
+# 	if num = IRB.conf[:SAVE_HISTORY] and (num = num.to_i) > 0
+# 	  if hf = IRB.conf[:HISTORY_FILE]
+# 	    file = File.expand_path(hf)
+# 	  end
+# 	  file = IRB.rc_file("_history") unless file
+# 	  open(file, 'w' ) do |f|
+# 	    hist = HISTORY.to_a
+# 	    f.puts(hist[-num..-1] || hist)
+# 	  end
+# 	end
+#       end
+#     end
+
+    def HistorySavingAbility.extended(obj)
+#      ObjectSpace.define_finalizer(obj, HistorySavingAbility.create_finalizer)
+      IRB.conf[:AT_EXIT].push proc{obj.save_history}
+      obj.load_history
+      obj
+    end
+
+    def load_history
+      if history_file = IRB.conf[:HISTORY_FILE]
+	history_file = File.expand_path(history_file)
+      end
+      history_file = IRB.rc_file("_history") unless history_file
+      if File.exist?(history_file)
+	open(history_file) do |f|
+	  f.each {|l| HISTORY << l.chomp}
+	end
+      end
+    end
+
+    def save_history
+      if num = IRB.conf[:SAVE_HISTORY] and (num = num.to_i) > 0
+	if history_file = IRB.conf[:HISTORY_FILE]
+	  history_file = File.expand_path(history_file)
+	end
+	history_file = IRB.rc_file("_history") unless history_file
+
+	# Change the permission of a file that already exists[BUG #7694]
+	begin
+	  if File.stat(history_file).mode & 066 != 0
+	    File.chmod(0600, history_file)
+	  end
+	rescue Errno::ENOENT
+	rescue
+	  raise
+	end
+
+	open(history_file, 'w', 0600 ) do |f|
+	  hist = HISTORY.to_a
+	  f.puts(hist[-num..-1] || hist)
+	end
+      end
+    end
+  end
+end