irt 1.2.1 → 1.2.2

data/README.markdown

@@ -19,8 +19,8 @@ that will make your life a lot easier.
 - recording of session steps with filtering
 - easy testing based on recorded steps
 - easy in place opening of backtraced files
-- in place editing with syntax highlight
-- visual comparing tool and navigation aids
+- in place editing of objects and files with syntax highlight
+- visual comparing tool, navigation and inspecting aids
 - system and session shortcuts... and much more
 
 ### Testing made easy
@@ -148,7 +148,7 @@ It works also from the rails code, while the server is running. (See Rails)
 The 'self' of the new session will be the 'self' at the line you called it, so you can play with local variables
 and methods as you would do it at that line.
 
-If you use 'nano' or 'vi' in a binding session you will open the file that contains the 'irt binding'
+If you use 'nano', 'emacs' or 'vi' in a binding session you will open the file that contains the 'irt binding'
 call at that line: very handy to edit your code in place.
 
 When you close the session with 'exit' (or 'x' or 'q'), IRT will not pass back anything from the binding session.
@@ -191,7 +191,7 @@ or if your system supports it you can use 'copy_lines' (or 'cl') and have them r
 You can also do the same with all the session lines using 'print_all_lines' (or 'pll')
 or copy them all 'copy_all_lines' (or 'cll').
 
-That 'pl'-copy or 'cl' plus the 'vi' or 'nano' irt command (or the 'cnn' and 'cvi' commands)
+That 'pl'-copy or 'cl' plus the 'vi', 'nano' or 'emacs' irt command (or the 'cnn' and 'cvi' commands)
 are a very time saver combination. See the [IRT Tutorial](https://github.com/ddnexus/irt/raw/master/irt-tutorial.pdf "IRT Tutorial") for details.
 
 ## Testing
@@ -222,7 +222,7 @@ IRT.tail_on_irt = true for automatic tail) so you have an instant feedback about
 failure comes from. It also opens an interactive session at that point with all
 the variables loaded, so you can immediately and interactively try and fix what went wrong.
 
-If you want to edit the running file, just type 'nano' or  'vi' without any argument and you will open
+If you want to edit the running file, just type 'nano, 'emacs' or 'vi' without any argument and you will open
 the file at the current line. Edit, save and exit from the editor, and you will continue your session
 from the point you left. You can also 'rerun' the same file (or 'rr') when you need to reload the whole code.
 
@@ -240,9 +240,9 @@ a fresh loaded environment.
 
 ## Editing Tools
 
-### In Place Editing
+### In Place Editing of Files
 
-You can open the current executed file at the current line by just typing 'nano' or 'vi'
+You can open the current executed file at the current line by just typing 'nano, 'emacs' or 'vi'
 and the editor with that name will be opened (in insert mode). Paste and/or edit and save what
 you want and 'rerun' (or 'rr') the file to try/test the changes.
 
@@ -253,16 +253,24 @@ If you don't like the default editor, you have just to set the IRT.edit_command_
 You will also find the info about how to automatically have your files syntax highlighted when opened in vi
 or nano. See "Goodies" below.
 
+### In Place Editing of Object
+
+With just calling your preferred CLI editor on any object, you can edit the yaml-dumped object and have it
+returned in your console:
+
+    >> {:a => 2}.vi  # opens the yaml-dump with vi
+    #=> {:an_edited => 'value'}
+
 ### Copy-Open
 
 You can combine the copy to clipboard feature, with the in place edit feature by using one of the
-commands 'cnano', 'cvi' or 'cedit', so saving a lot of boring steps. It use the copy_to_clipboard
+commands 'cnano', 'cemacs' 'cvi' or 'cedit', so saving a lot of boring steps. It use the copy_to_clipboard
 command from your system. see below.
 
 ### Copy to Clipboard Command
 
 IRT provides a few commands that will use an external command of your system to copy the
-last lines to the clipboard: 'copy_lines' (or 'cl'), 'cnano', 'cvi', 'cedit' use that command
+last lines to the clipboard: 'copy_lines' (or 'cl'), 'cnano', 'cemacs', 'cvi', 'cedit' use that command
 avoiding you the boring task to select the output from the terminal and copy it.
 
 It uses 'pbcopy' on MacOS (which should be already installed on any mac),
@@ -276,7 +284,7 @@ the stdin to the clipboard.
 
 I have never been a big fan of CLI editors like vi or nano, but I really appreciate them
 when combined with IRT. Having the file I need to edit, opened at the right line at the touch of a 2 letter
-command ('nn' or 'vi') is really fast and powerful.
+command ('nn', 'vi' or 'em') is really fast and powerful.
 
 You have just to know a few very basic commands
 like paste, save, quit, and eventually a couple of other, and you will save a lot of time and steps.
@@ -311,6 +319,41 @@ For those (like me) that are not used to CLI editors here's a quick reference fo
     paste (line)    [Esc (return to command mode)]
                     type 'p'
 
+    EMACS
+    paste from clipboard with your usual OS command
+    quit            Ctrl-X Ctrl-C
+                    type 'y'<enter> confirming that you want also to save
+                    type 'n' confirming that you don't want to save
+    Editing
+    copy (line)     Ctrl-A Ctrl-SPACE Ctrl-N Alt-w
+    cut (line)      Ctrl-K
+    uncut (paste)   Ctrl-Y
+
+
+### Note about IDEs
+
+If you prefer to inspect/edit your files with your preferred IDE, you should add a line to
+the ~/.irtrc file (create it if you don't have one) indicating the command format for your IDE,
+in order to open a file at a certain line.
+
+These are exaples of a few setups for different IDEs:
+
+    # Plain Eclipse on Mac X (opens the file but misses the line number)
+    IRT.edit_command_format = %(open -a "/Applications/eclipse/Eclipse.app" %1$s)
+
+    # Eclipse with installed EclipseCall plugin (platform independent, file and line number ok)
+    # Eclipse should be running
+    # http://www.jaylib.org/pmwiki/pmwiki.php/EclipsePlugins/EclipseCall
+    # update site: http://www.jaylib.org/eclipsecall
+    IRT.edit_command_format = %(java -jar eclipsecall.jar %1$s -G%2$s)
+
+    # NetBeans
+    IRT.edit_command_format = %(netbeans --open %1$s:%2$s)
+
+You will use the 'edit' (or 'ed') command to inspect/edit your file with the IDE you setup.
+If you create a format for any IDE not listed in the example, please, send it to me, so I will
+add it to the list for other users. Thank you.
+
 ## Inspecting Tools
 
 ### Call irt from your code
@@ -362,7 +405,7 @@ are also enhanced a bit: when invoked with no arguments, they use the last value
 When an error occurs, IRT shows you an indexed exception backtrace: each file:line in the backtrace
 has an index number (in brackets) that you can use to open that file at that line with your preferred in-place editor.
 
-You have just to type '&lt;editor&gt; &lt;index&gt;' (&lt;editor&gt; is one of 'vi', 'nano' (or 'nn') 'edit' (or 'ed'),
+You have just to type '&lt;editor&gt; &lt;index&gt;' (&lt;editor&gt; is one of 'vi', 'nano' (or 'nn'), 'emacs' (or 'em'), 'edit' (or 'ed'),
 and &lt;index&gt; is the index number shown in the backtrace), and you will open it in insert mode. Example:
 
     # backtraced line: from /Users/dd/dev/hobo3/hobo/lib/hobo/controller/model.rb:57:in `each' [3]
@@ -382,8 +425,9 @@ the wanted line. Example:
 
 ### Contextual ri doc with autocompletion
 
-IRT offers the 'ri' command, (implemented with fastri for RUBY_VERSION < 1.9.2, or 'bri' for RUBY_VERSION >= 1.9.2)
-See also the IRT.ri_command_format option if you want to change it.
+IRT offers the 'ri' command implemented with fastri for RUBY_VERSION < 1.9.2, or 'bri' for RUBY_VERSION >= 1.9.2:
+you must install the right gem for your ruby version in order to make it work.
+See also the IRT.ri_command_format option if you want to customize it.
 
 In its basic form the 'ri' command can accept a string as the system ri command does (you can even omit the quotes).
 
@@ -427,6 +471,12 @@ Example:
          Returns true if array and other are the same object, or are both
          arrays with the same content.
 
+If you want to search a literal string (i.e. not interpreted) you must use single or double quotes
+and the string will be passed verbatim to the system ri command.
+
+If you have a long documentation coming from the ri search, or even if you want just to keep your screen clean,
+you can use the 'pri' (i.e. paged ri). It works exactly like 'ri', but uses the pager to show any result from the ri search.
+
 ### IRT Help
 
 The IRT Commands are the methods that you can call from any IRT console session, while the Directives are
@@ -449,6 +499,18 @@ You can use the 'sh' as an alias of 'system' with the difference that you don't
     >> sh git rebase -i HEAD~5
     >> sh cat #{file_path}
 
+### Pager
+
+When you have any long string to inspect, or some code printing a lot of text to stdout
+you can use the 'pager' (or 'pg') command, and the output will be managed by the pager
+('less' by default, but you can change it with the pager\_format\_command option).
+
+    # with a string
+    pg some_long_string
+
+    # with a block of code printing to stdout
+    pg { irt_help }
+
 ### FileUtils
 
 All the FileUtils methods are included as commands: just call them in the session
@@ -530,6 +592,9 @@ which should work quite well without any change:
     # the format to build the command to launch vi
     # IRT.vi_command_format = %(vi "%1$s" +%2$d)
 
+    # the format to build the command to lauch emacs
+    # IRT.emacs_command_format = %(emacs +%2$d "%1$s")
+
     # the format to build the command to launch the ri tool
     # if RUBY_VERSION < 1.9.2 uses qri (from fastri) else bri
     # IRT.ri_command_format = %(qri -f #{Dye.color? ? 'ansi' : 'plain'} "%s")
@@ -672,12 +737,23 @@ You must add the gem to your Gemfile, to make the bundler happy:
 eventually adding it only to the group that you prefer. Anyway, if the irt executable detects that you don't have it set,
 it will ask and eventually add it for you.
 
-## Known Issue
+## Known Issues
+
+### Yaml serialization
 
 IRT uses yaml serialization, and inherits its limits (e.g.: Yaml cannot dump anonymous classes, MatchData, object that contains binding, etc.)
 so if you stumble upon on one of them, you have just to test the subparts of the object that you cannot dump. For example, instead of testing one whole anonymous
 class, (which is however a bad idea) you can add tests for the values returned by its methods or variables.
 
+### Irb jobs
+
+IRT disables the traditionals irb jobs. You can still open any session like you do with the standard irb,
+but the new session is not created as a new thread, therefore the 'jobs' related commands are useless.
+In practice the only real limitation is that you have to exit from an inspecting or binding session
+in order to switch back to an interactive session, while threaded sessions would allow you to switch and kill the thread
+indipendently. This will probably be addressed in a next version of irt.
+Please, send me a line if this issue is bugging you, so I will try to fix it faster.
+
 ## Copyright
 
 Copyright (c) 2010-2011 Domizio Demichelis. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.2.2

data/bin/irt

@@ -7,7 +7,7 @@ require 'fileutils'
 require 'optparse'
 require 'irt/utils'
 
-copy = IRT::Utils.copyright
+copy = IRT.copyright
 
 options = {}
 
@@ -45,7 +45,7 @@ EOB
    end
 
   opts.on( '-v', '--version', 'Shows the version and exits' ) do
-    puts IRT::Utils.version
+    puts IRT.version
     exit
   end
 
@@ -63,7 +63,7 @@ puts copy
 
 paths = if ARGV.empty?
           options[:interactive_eof] = true
-          [ IRT::Utils.create_tmp_file ]
+          [ IRT.create_tmp_file ]
         else
           ARGV.map {|p| File.expand_path(p) }
         end
@@ -92,7 +92,7 @@ cmd_format = if File.exists?('./config/environment.rb') && !options[:no_rails]
                    IRT::Prompter.say_warning %(The Gemfile doesn't look to include any 'gem "irt"' statement.\nIRT will probably not work until you add it!)
                    IRT::Prompter.yes?("Do you want to add irt to your Gemfile?", :hint => '[enter=y|n]', :default => 'y') do
                      File.open('Gemfile', 'a') do |f|
-                       f.puts %(gem "irt")
+                       f.puts %(\ngem "irt")
                      end
                    end
                  end

data/irt.gemspec

@@ -14,15 +14,21 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('differ', [">= 0.1.1"])
   s.add_runtime_dependency('dye', [">= 0.1.3"])
   s.add_runtime_dependency('prompter', [">= 0.1.4"])
-  if IRT::RubyVersion >= '1.9.2'
-    s.add_runtime_dependency('bri', [">= 0.1.5"])
-  else
-    s.add_runtime_dependency('fastri', [">= 0.3.1.1"])
-  end
+  s.requirements << "In order to use the IRT contextual ri command you must install the gem 'bri' (ruby >=1.9.2) or 'fastri' (ruby < 1.9.2)"
 
   s.executables = ['irt', 'irt_irb', 'irt_rails2']
   s.files = `git ls-files -z`.split("\0") - %w[irt-tutorial.pdf]
+  s.post_install_message = <<EOM
 
+********************************************************************************
+
+  In order to use the IRT contextual ri command you must also install the gem:
+  "bri"    if you run ruby >= 1.9.2
+  "fastri" if you run ruby  < 1.9.2
+
+********************************************************************************
+
+EOM
   s.name = name
   s.version = version
   s.date = Date.today.to_s

data/irtrc

@@ -32,6 +32,9 @@
 # the format to build the command to launch vi
 # IRT.vi_command_format = %(vi "%1$s" +%2$d)
 
+# the format to build the command to lauch emacs
+# IRT.emacs_command_format = %(emacs +%2$d "%1$s")
+
 # the format to build the command to launch the ri tool
 # if RUBY_VERSION < 1.9.2 uses qri (from fastri) else bri
 # IRT.ri_command_format = %(qri -f #{Dye.color? ? 'ansi' : 'plain'} "%s")

data/lib/irt/commands/core.rb

@@ -57,6 +57,17 @@ module IRT
         system *args
       end
 
+      def pager(arg=nil, &block)
+        ensure_session
+        raise ArgumentError, "You must pass an arguent or a block" if arg.nil? && block.nil?
+        # in case of a block we will just capture in memory its whole output to stdout
+        output = arg || capture(&block)
+        IO.popen(IRT.pager_command, 'w') do |io|
+          io.puts output
+        end
+      end
+      alias_method :pg, :pager
+
     end
   end
 end

data/lib/irt/commands/edit.rb

@@ -14,30 +14,26 @@ module IRT
       end
       alias_method :cll, :copy_all_lines
 
-      [:vi, :nano, :edit].each do |n|
+      IRT::EDITORS.each_pair do |name, short|
 
-        define_method(n) do |*args|
+        define_method(name) do |*args|
           ensure_session
-          run_editor(n, *args)
+          run_editor(name, *args)
         end
 
-        define_method(:"c#{n}") do |*args|
+        define_method(:"c#{name}") do |*args|
           ensure_session
           copy_lines
-          send n, *args
+          send name, *args
         end
 
+        alias_method short, name if short
+        alias_method :"c#{short}", :"c#{name}" if short
       end
-      alias_method :nn, :nano
-      alias_method :ed, :edit
-      alias_method :cnn, :cnano
-      alias_method :ced, :cedit
 
     private
 
       def run_editor(cmd, *args)
-        cmd_format = IRT.send("#{cmd}_command_format".to_sym)
-        raise IRT::NotImplementedError, "#{cmd}_command_format missing" unless cmd_format
         arg = args.first if args.size == 1
         file, line = case
                      when args.empty?
@@ -66,7 +62,7 @@ module IRT
                      else
                        args
                      end
-        system sprintf(cmd_format, file, line||0)
+        IRT.edit_with(cmd, file, line)
       end
 
       def copy_to_clipboard(cmd)

data/lib/irt/commands/help.rb

@@ -24,7 +24,7 @@ module IRT
     print_all_lines|pll     Like print_line but prints all the sessions lines
 
 #{label " In Place Editing Commands ", :interactive_color}
-    (<editor> can be 'vi', 'nano|nn', 'edit|ed')
+    (<editor> can be 'vi', 'nano|nn', 'emacs|em', 'edit|ed')
     <editor>                Uses <editor> to open the current evalued file at
                             the current evalued line for in place edit
     <editor> file[, line]   Uses <editor> to open file [at line] for in place
@@ -38,11 +38,9 @@ module IRT
                             the backtraced line
 
 #{label( " Copy-Edit Commands ", :interactive_color ) + IRT.dye(" (use copy_to_clipboard_command)", :interactive_color, :bold)}
-    copy_lines|cl           Copy the last session lines
-    copy_all_lines|cll      Copy the lines of all the sessions
-    cnano|cnn               Like nano, but copy the last session lines first
-    cvi                     Like vi, but copy the last session lines first
-    cedit|ced               Like edit, but copy the last session lines first
+    copy_lines|cl           Copies the last session lines to the clipboard
+    copy_all_lines|cll      Copies all the sessions' lines to the clipboard
+    c<editor>               Like `copy_lines` and <editor> in just one step
 
 #{label(" Test Commands ", :interactive_color) + IRT.dye(" (only available in interactive sessions)", :interactive_color, :bold)}
     add_desc|dd desc        Adds a description for the test in the log
@@ -57,13 +55,20 @@ module IRT
     (e.g. pwd, touch, mkdir, mv, cp, rm, rm_rf, compare_files, ...)
 
 #{label " Documentation Commands ", :interactive_color}
-    ri to_search            Search the ri doc for to_search (no quotes needed)
+    ri "string_to_search"   Search the ri doc for the literal string_to_search
+    ri to_search            Search the ri doc for to_search (without quote)
+                            If to_search represents any object in your code
+                            it looks for the obj.class documentation
+                            e.g.: ri arr #=> (where arr=[]) ri doc for Array
+                                  ri ""  #=> ri doc for String
     ri obj.any_method       Search the method.owner ri doc for of any_method
                             (no quotes needed, and completion available)
                             e.g.: ri "".eql?  #=> ri doc for String#eql?
                                   ri [].eql?  #=> ri doc for Array#eql?
     ri n                    Search the ri doc for the method n in a multiple
                             choices list
+    pri ...                 Like the above commands for `ri ...` but uses the
+                            pager to show the result
 
 #{label(" Rails Commands ", :interactive_color) + IRT.dye(" (only available for Rails Apps)", :interactive_color, :bold)}
     rails_log_on            Turn the rails log-in-console ON
@@ -82,6 +87,8 @@ module IRT
                             rerun the current file
     irt_help|hh             Shows this screen
     sh command              Alias for system("command") (no quotes needed)
+    pager|pg string|block   Uses the pager to show a long string or executes
+                            block and shows its captured stdout
 
 #{label " Session Directives ", :file_color}
     irt                     Opens an interactive session which retains the
@@ -104,6 +111,11 @@ module IRT
                             captured stdout
     Object#own_methods      Returns the methods implemented by the receiver
                             itself (not inherited)
+    Object#<editor>         (<editor> can be 'vi', 'nano|nn', 'emacs|em')
+                            Yaml-dump the object in a tmp.yml file and opens it
+                            with <editor>. After your editing and save returns
+                            the evaluated yaml file
+                            e.g.: {:a => 2}.vi  #=> {:an_edited => 'value'}
     Method#location         When possible, it returns file and line where the
                             method is defined. It is uitable to be passed to the
                             in place editing commands.

data/lib/irt/commands/ri.rb

@@ -8,50 +8,85 @@ module IRT
         @@choices_map = {}
       end
 
-      def ri(arg)
+      def ri(arg, literal=false)
         ensure_session
         raise IRT::NotImplementedError, "No available ri_command_format for this system." unless IRT.ri_command_format
         case
-        when arg.nil?, arg.empty?
-          return puts('nil')
+
         when arg.match(/^\d+$/)
           if @@choices_map.key?(arg)
             to_search = @@choices_map[arg]
           else
             raise IndexError, "No such method index -- [#{arg}]"
           end
+
+        when literal
+          if output = process_ri(arg)
+            puts(output)
+            return
+          end
+
+        when arg !~ /\./
+          begin
+            obj = eval arg, IRB.CurrentContext.workspace.binding
+            to_search = obj.class
+          rescue NameError
+            if output = process_ri(arg)
+              puts(output)
+              return
+            end
+            raise
+          end
+
         else
           segm = arg.split('.')
           to_search = segm.pop
-          unless segm.empty?
-            begin
-              meth = eval "#{segm.join('.')}.method(:#{to_search})", IRB.CurrentContext.workspace.binding
-              to_search = "#{meth.owner.name}##{meth.name}"
-            rescue
-              raise NoMethodError, %(undefined method "#{to_search}" for "#{segm.join('.')}")
-            end
+          receiver = eval segm.join('.'), IRB.CurrentContext.workspace.binding
+          raise NoMethodError, %(undefined method '#{to_search}' for #{receiver.inspect}:#{receiver.class}) \
+            unless receiver.respond_to? to_search.to_sym
+          meth = receiver.method(to_search.to_sym).inspect
+          meth = meth.match(/^\#<Method: (.+)>$/)[1]
+          if m = meth.match(/\((.+)\)(.+)/)
+            to_search = m[1] + m[2]
+          else
+            to_search = meth
           end
         end
-        process_ri to_search
+
+        puts process_ri(to_search) || 'Nothing found!'
+      end
+
+      def pri(arg)
+        pager { ri arg }
       end
 
     private
 
       def process_ri(to_search)
         ri = `#{sprintf(IRT.ri_command_format, to_search)}`
-         if m = ri.match(/^(-+.*Multiple choices:.*\n\n)(.+)/m)
-           output, methods = m.captures
-           IRT::Commands::Ri.reset_choices_map
-           fmt = "%+7s  %s\n"
-           methods.gsub(/\s+/, '').split(',').each_with_index do |m, i|
-             @@choices_map[(i+1).to_s] = m
-             output << sprintf( fmt, "#{i+1}", m )
-           end
-           output << "\n"
-         else
-           output = ri
-         end
-        puts output
+        ri_problem unless $?.to_i == 0
+        return if ri.match(/^(nil|No matching results found)$/)
+        if m = ri.match(/^(-+.*Multiple choices:.*\n\n)(.+)/m)
+          output, methods = m.captures
+          IRT::Commands::Ri.reset_choices_map
+          fmt = "%+7s  %s\n"
+          methods.gsub(/\s+/, '').split(',').each_with_index do |m, i|
+            @@choices_map[(i+1).to_s] = m
+            output << sprintf( fmt, "#{i+1}", m )
+          end
+          output << "\n"
+        else
+          output = ri
+        end
+        output
+      end
+
+      def ri_problem
+        ri_gem = IRT::RubyVersion >= '1.9.2' ? 'bri' : 'fastri'
+        message = system("#{required} -v") ?
+                    "Bad ri_command_format for this system." :
+                    %(You must install the "#{ri_gem}" gem to use this command with ruby #{RUBY_VERSION}.)
+        raise IRT::NotImplementedError, message
       end
 
     end

data/lib/irt/commands/test.rb

@@ -45,7 +45,7 @@ module IRT
       alias_method :tt, :add_test
 
       def save_as(file_path)
-        IRT::Utils.save_as(file_path)
+        IRT.save_as(file_path)
       end
       alias_method :sa, :save_as
 

data/lib/irt/extensions/irb/context.rb

@@ -41,12 +41,16 @@ module IRB
         # skip setting last_value for non_setting_commands
         if line =~ /^\s*(#{quoted_option_string(IRT.log.non_setting_commands)})\b(.*)$/
           command, args = $1, $2
-          if command =~ /^(sh|ri)$/ && irt_mode != :file
+          if command =~ /^(sh|ri|pri)$/ && irt_mode != :file
             args = args.strip if args
-            args = "%(#{args})" unless args.empty? || args.match(/^('|").+\1$/)
-            line = "#{command} #{args}"
+            line = if args.match(/^('|").+\1$/)
+                     command == 'sh' ? "#{command} #{args}" : "#{command} #{args}, true"
+                   else
+                     args = "%(#{args})" unless args.empty?
+                     "#{command} #{args}"
+                   end
           end
-          IRT::Commands::Ri.reset_choices_map unless command == 'ri'
+          IRT::Commands::Ri.reset_choices_map unless command =~ /^(ri|pri)$/
           self.echo = false
           res = @workspace.evaluate(self, line, irb_path, line_no)
           if command =~ /^(#{IRT.log.ignored_echo_commands * '|'})$/

data/lib/irt/extensions/object.rb

@@ -1,7 +1,28 @@
+require 'tempfile'
+
 class Object
 
   def own_methods
     methods - self.class.methods
   end
 
+  IRT::EDITORS.each_pair do |name, short|
+    # with IDEs we cannot come back after editing
+    next if name == :edit
+
+    define_method(name) do
+      t = Tempfile.new(['', '.yml'])
+      t << to_yaml
+      t.flush
+      IRT.edit_with(name, t.path)
+      return self unless File.exists?( t.path )
+      obj = YAML::load_file t.path
+      t.close
+      obj
+    end
+
+    alias_method short, name if short
+
+  end
+
 end

data/lib/irt/utils.rb

@@ -2,17 +2,23 @@ require 'irt/prompter'
 
 module IRT
 
-  extend self
-
   def cli?
     !!ENV['IRT_COMMAND']
   end
 
+  def lib_path
+    File.expand_path '../../../lib', __FILE__
+  end
+
+  # this fixes a little imperfection of the YAML::dump method
+  # which adds a space at the end of the class
+  def yaml_dump(val)
+    yml = "\n" + YAML.dump(val)
+    yml.gsub(/ +\n/, "\n")
+  end
 
   module Utils
 
-    extend self
-
     def create_tmp_file()
       require 'tempfile'
       tmp_file = Tempfile.new(['', '.irt'])
@@ -35,6 +41,12 @@ module IRT
       ask_run_new_file new_file_path, source_path, tmp
     end
 
+    def edit_with(editor, file, line=nil)
+      cmd_format = IRT.send("#{editor}_command_format".to_sym)
+      raise IRT::NotImplementedError, "#{cmd}_command_format missing" unless cmd_format
+      system sprintf(cmd_format, file, line||0)
+    end
+
     def version
       @version ||= File.read(File.expand_path('../../../VERSION', __FILE__)).strip
     end
@@ -73,4 +85,8 @@ module IRT
     end
 
   end
+
+  extend self
+  extend Utils
+
 end

data/lib/irt.rb

@@ -9,11 +9,6 @@ require 'pp'
 require 'yaml'
 require 'rbconfig'
 require 'pathname'
-require 'irt/extensions/kernel'
-require 'irt/extensions/object'
-require 'irt/extensions/method'
-require 'irt/extensions/irb'
-require 'irb/completion'
 require 'dye'
 require 'irt/log'
 require 'irt/hunks'
@@ -25,8 +20,6 @@ require 'irt/utils'
 
 module IRT
 
-  VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip
-
   OS = case RbConfig::CONFIG['host_os']
        when /mswin|msys|mingw32|windows/i
          :windows
@@ -40,6 +33,13 @@ module IRT
          :unknown
        end
 
+  EDITORS = { :vi    => nil,
+              :nano  => :nn,
+              :emacs => :em,
+              :edit  => :ed }
+
+  EDITORS.keys.each {|k| attr_accessor :"#{k}_command_format" }
+
   class IndexError < RuntimeError ; end
   class SessionModeError < RuntimeError ; end
   class ArgumentTypeError < RuntimeError ; end
@@ -50,7 +50,8 @@ module IRT
   attr_accessor :irt_on_diffs, :tail_on_irt, :fix_readline_prompt, :debug,
                 :rails_log, :dye_rails_log, :rails_server, :rails_server_sigint_trap,
                 :full_exit, :session_no, :autoload_helper_files, :dye_styles,
-                :copy_to_clipboard_command, :nano_command_format, :vi_command_format, :edit_command_format, :ri_command_format
+                :copy_to_clipboard_command, :pager_command, :ri_command_format
+
   attr_reader :log, :irt_file, :initialized
 
   def force_color=(bool)
@@ -98,7 +99,9 @@ module IRT
     end
     @vi_command_format = %(vi "%1$s" +%2$d)
     @nano_command_format = %(nano +%2$d "%1$s")
+    @emacs_command_format = %(emacs +%2$d "%1$s")
     @ri_command_format =  IRT::RubyVersion >= '1.9.2' ? %(bri "%s") : %(qri -f #{Dye.color? ? 'ansi' : 'plain'} "%s")
+    @pager_command = 'less -R'
     @debug = false
   end
 
@@ -128,30 +131,24 @@ module IRT
     @log.print_running_file
   end
 
-  def lib_path
-    File.expand_path '../../lib', __FILE__
-  end
-
-  # this fixes a little imperfection of the YAML::dump method
-  # which adds a space at the end of the class
-  def yaml_dump(val)
-    yml = "\n" + YAML.dump(val)
-    yml.gsub(/ +\n/, "\n")
-  end
-
   # this will create a tmp file and start IRB
   # but it will be left in file mode at EOF (sort of irt-standby)
   def start
     return if initialized
-    puts IRT::Utils.copyright
+    puts copyright
     ARGV.clear
-    ARGV.push IRT::Utils.create_tmp_file
+    ARGV.push create_tmp_file
     IRB.start
   end
 
 end
 
+require 'irt/extensions/irb'
+require 'irb/completion'
 IRT.init_config
+require 'irt/extensions/kernel'
+require 'irt/extensions/object'
+require 'irt/extensions/method'
 require 'irt/prompter'
 require 'irt/extensions/rails' if defined?(ActiveSupport::BufferedLogger)
 

metadata

@@ -2,7 +2,7 @@
 name: irt
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors: 
 - Domizio Demichelis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-05 00:00:00 -04:00
+date: 2011-03-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,17 +46,6 @@ dependencies:
         version: 0.1.4
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: bri
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.1.5
-  type: :runtime
-  version_requirements: *id004
 description: If you use IRT in place of irb or Rails Console, you will have more tools that will make your life a lot easier.
 email: dd.nexus@gmail.com
 executables: 
@@ -110,7 +99,9 @@ has_rdoc: true
 homepage: http://github.com/ddnexus/irt
 licenses: []
 
-post_install_message: 
+post_install_message: "\n\
+  ********************************************************************************\n\n  In order to use the IRT contextual ri command you must also install the gem:\n  \"bri\"    if you run ruby >= 1.9.2\n  \"fastri\" if you run ruby  < 1.9.2\n\n\
+  ********************************************************************************\n\n"
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -127,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       version: 1.3.6
-requirements: []
-
+requirements: 
+- In order to use the IRT contextual ri command you must install the gem 'bri' (ruby >=1.9.2) or 'fastri' (ruby < 1.9.2)
 rubyforge_project: 
 rubygems_version: 1.5.0
 signing_key: