irbtools 0.7.4 → 0.8.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.8.0
+* added Object#ri method
+* feature: extension package loading (e.g. irbtools-more)
+* feature: loading in IRB.conf[:IRB_RC] (loading when a subirb starts, no more guessmethod rails errors)
+* added rerequire (rrq) and ld load helper
+
 0.7.4
 * added workaround to use irb_rocket and hirb at the same time (basic hack, e.g. paging does not work)
 * fixed little VERSION bug

data/README.rdoc

@@ -23,12 +23,21 @@ If it does not exist, just create a new one.
 It's possible to modify, which libraries get loaded:
 
   require 'irbtools/configure'
-  # here you can edit the <tt>Irbtools.libs</tt> array or add libraries inclusive load callbacks with <tt>Irbtools.add_library</tt>
+  # here you can modify which libraries get loaded (see below)
   Irbtools.init
 
+=== How to load more or less libraries
+
+You have the following ways:
+* <tt>Irbtools.add_library(lib, in_proc = false, &block)</tt>
+* <tt>Irbtools.remove_library(lib)</tt>
+* <tt>Irbtools.add_package(pkg)</tt>
+* <tt>Irbtools.remove_package(pkg)</tt>
+* Edit the <tt>Irbtools.libraries</tt>, <tt>Irbtools.libraries_in_proc</tt> or <tt>Irbtools.packages</tt> arrays directly (no way to set callbacks).
+
 == Features
 
-See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented source file: lib/irbtools.rb
+See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented source file.
 
 === Included gems and libraries
 
@@ -46,16 +55,27 @@ See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented s
 * boson[http://tagaholic.me/boson/]  IRB commands repository (which also works for the shell!)
 * irb_rocket[http://merbi.st/plugins/22]   put result as comment instead of a new line!
 
+=== Helper methods
+See the source/rdoc for a description. These methods are defined directly by irbtools.
+
+*General*: <tt>ls, cat, rq, rrq/rerequire, ls, session_history, reset!, clear, use_ruby/use, dbg, Object#ri</tt>
+
+*Clipboard*: <tt>copy, paste, copy_input, copy_output</tt>
+
+*CodeRay*: <tt>colorize, ray</tt>
+
 == Bugs / TODO
 
 * Make guessmethod 1.9 compatible
 * Fix Clipboard Windows issues
 * Fix irb_rockets general stdout problem. If something stdout related fails, odds are high that it's irb_rockets fault.
+* Pager for hirb and ri
+* Use RDoc driver instead of system ri for ri (?)
 * ...
 
 == More Features
 
-* suggest something ;)
+* See the irbtools-more[http://github.com/janlelis/irbtools-more] package.
 
 == Copyright
 

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "mail@janlelis.de"
     gem.homepage = "http://github.com/janlelis/irbtools"
     gem.authors = ["Jan Lelis"]
-    gem.requirements << 'You need to add http://merbi.st to your gem sources (irb_rocket)'
+    gem.requirements << "It's recommended to use the irb_rocket gem: gem install irb_rocket --source http://merbi.st"
     gem.add_dependency 'wirble'
     gem.add_dependency 'hirb'
     gem.add_dependency 'zucker', '>=8'
@@ -30,7 +30,7 @@ end
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION').chomp : ""
 
   rdoc.rdoc_dir = 'doc'
   rdoc.title = "irbtools #{version}"

data/VERSION

@@ -1 +1 @@
-0.7.4
+0.8.0

data/irbtools.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{irbtools}
-  s.version = "0.7.4"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jan Lelis"]
-  s.date = %q{2010-10-09}
+  s.date = %q{2010-10-12}
   s.description = %q{irbtools is a meta gem which installs some useful irb gems and configures your irb. Simply put a require 'irbtools' in the .irbrc file in your home directory.}
   s.email = %q{mail@janlelis.de}
   s.extra_rdoc_files = [
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/janlelis/irbtools}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.requirements = ["You need to add http://merbi.st to your gem sources (irb_rocket)"]
+  s.requirements = ["It's recommended to use the irb_rocket gem: gem install irb_rocket --source http://merbi.st"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{irbtools is a meta gem which installs some useful irb gems and configures your irb.}
 

data/lib/irbtools.rb

@@ -3,31 +3,56 @@
 # # # # #
 # require 'irbtools' in your .irbrc
 # see the README file for more information
-
 require File.expand_path('irbtools/configure', File.dirname(__FILE__) ) unless defined? Irbtools
 
+# # # # #
+# load extension packages
+Irbtools.packages.each{ |pkg|
+  begin
+    require "irbtools/#{pkg}"
+
+  rescue LoadError => err
+    warn "Couldn't load an extension package: #{err}"
+  end
+}
+
 # # # # #
 # load libraries
-remember_verbose_and_debug = $VERBOSE, $DEBUG
-$VERBOSE = $DEBUG = false
 
-Irbtools.libraries.each{ |lib|
-  begin
-    require lib.to_s
+# load helper proc
+load_libraries_proc = proc{ |libs|
+  remember_verbose_and_debug = $VERBOSE, $DEBUG
+  $VERBOSE = $DEBUG = false
 
-    Irbtools.send :library_loaded, lib
+  libs.each{ |lib|
+    begin
+      require lib.to_s
 
-  rescue LoadError => err
-    if err.to_s =~ /irb_rocket/ && RubyEngine.mri?
-      warn "Couldn't load the irb_rocket gem.
+      Irbtools.send :library_loaded, lib
+
+    rescue LoadError => err
+      if err.to_s =~ /irb_rocket/ && RubyEngine.mri?
+        warn "Couldn't load the irb_rocket gem.
 You can install it with: gem install irb_rocket --source http://merbi.st"
-    else
-      warn "Couldn't load an irb library: #{err}"
+      else
+        warn "Couldn't load an irb library: #{err}"
+      end
     end
-  end
+  }
+  $VERBOSE, $DEBUG = remember_verbose_and_debug
 }
 
-$VERBOSE, $DEBUG = remember_verbose_and_debug
+# load them :)
+load_libraries_proc[ Irbtools.libraries ]
+
+# load these each time a new sub irb starts
+original_irbrc_proc = IRB.conf[:IRB_RC]
+IRB.conf[:IRB_RC] = proc{
+  load_libraries_proc[ Irbtools.libraries_in_proc ]
+  original_irbrc_proc[ ]  if original_irbrc_proc
+}
+
+
 
 # # # # #
 # general shortcuts & helper methods
@@ -53,10 +78,14 @@ IRB.conf[:PROMPT_MODE] = :IRBTOOLS
 
 # # # # #
 # misc
+
+# add current directory to the loadpath
+$: << '.'  if RubyVersion.is.at_least? '1.9.2'
+
+# shoter ruby info constants
 Object.const_set 'RV', RubyVersion  rescue nil
 Object.const_set 'RE', RubyEngine   rescue nil
 
-# # # # # 
 # load rails.rc
 begin 
   if ( ENV['RAILS_ENV'] || defined? Rails ) && Irbtools.railsrc

data/lib/irbtools/configure.rb

@@ -16,52 +16,70 @@ end
 # define module methods
 module Irbtools
   @lib_hooks = Hash.new{|h,k| h[k] = [] }
-  @libs = %w[rubygems]
+  @libs = [] # %w[rubygems]
+  @libs_in_proc = []
+  @packages = []
   @railsrc = '~/.railsrc'
 
   class << self
-    def libraries
-      @libs
-    end
-    aliases_for :libraries, :gems, :libs
+    # lets you define the path to the irbrc or deactivate this feature with nil
+    attr_accessor :railsrc
 
-    def libraries=(value)
-      @libs = value
-    end
-    aliases_for :'libraries=', :'gems=', :'libs='
+    # an array of the libraries which get loaded at start
+    attr_accessor :libs
+    aliases_for :libs, :libraries, :gems
+    aliases_for :libs=, :libraries=, :gems=
+
+    # an array of the libraries which get loaded everytime a new subirb starts (IRB.conf[:IRB_RC])
+    attr_accessor :libs_in_proc
+    aliases_for :libs_in_proc, :libraries_in_proc, :gems_in_proc
+    aliases_for :libs_in_proc=, :libraries_in_proc=, :gems_in_proc=
+
+    # an array of extension packages which get loaded (e.g. irbtools-more)
+    attr_accessor :packages
+
+    # add a library. the block gets executed, when the library was loaded.
+    # if the second param is true, it's hooked in into IRB.conf[:IRB_RC] instead of the start.
+    def add_library(lib, in_proc = false, &block)
+      libs = in_proc ? @libs_in_proc : @libs
+      libs << lib.to_s unless libs.include? lib.to_s
 
-    def add_library(lib, &block)
-      @libs << lib.to_s unless @libs.include? lib.to_s
       @lib_hooks[lib.to_s] << block if block_given?
     end
     aliases_for :add_library, :add_lib, :add_gem
 
+    # don't load a specific library
     def remove_library(lib)
       @libs.delete lib.to_s
+      @libs_in_proc.delete lib.to_s
       @lib_hooks.delete lib.to_s
     end
     aliases_for :remove_library, :remove_lib, :remove_gem
 
-    def railsrc
-      @railsrc
+    # add extensions packages
+    def add_package(pkg)
+      @packages << pkg.to_s
     end
 
-    def railsrc=(path)
-      @railsrc = path
+    # remove extension package
+    def remove_package(pkg)
+      @packages.delete pkg.to_s
     end
 
-    def library_loaded(lib)
+
+    def library_loaded(lib) #:nodoc:
       @lib_hooks[lib.to_s].each{ |hook| hook.call }
     end
     private :library_loaded
 
+    # loads all the stuff ;)
     def init
       require File.expand_path( '../irbtools.rb', File.dirname(__FILE__) )
     end
     alias start init
   end
 
-  VERSION = File.read File.expand_path( '../../VERSION', File.dirname(__FILE__) ).chomp
+  VERSION = ( File.read File.expand_path( '../../VERSION', File.dirname(__FILE__)) ).chomp
 end
 
 # # # # #

data/lib/irbtools/general.rb

@@ -9,11 +9,23 @@ def cat(path)
   File.read path
 end
 
-# allows concise syntax like rq:mathn
+# allows concise syntax like rq:mathn and reloading/requireing
 def rq(lib)
   require lib.to_s
 end
 
+# reloading, hints from http://www.themomorohoax.com/2009/03/27/irb-tip-load-files-faster
+def rerequire(lib)
+  $".delete( "#{lib}.rb" )
+  require( lib.to_s )
+end
+alias rrq rerequire
+
+# load shortcut
+def ld(lib)
+  load lib.to_s + '.rb'
+end
+
 # returns the last lines, needed for some copy_ methods
 def session_history(number_of_lines = context.instance_variable_get(:@line_no) )
   Readline::HISTORY.entries[-number_of_lines...-1]*"\n"
@@ -25,7 +37,13 @@ def reset!
   exit
 end
 
-def ruby_version(which = nil)
+# just clear the screen
+def clear
+  system 'clear'
+end
+
+# change ruby version (requires rvm)
+def use_ruby(which = nil)
   # test if installed
   unless `rvm -v` =~ /Seguin/
     raise 'Ruby Version Manager must be installed to use this command'
@@ -53,7 +71,7 @@ def ruby_version(which = nil)
     puts "Sorry, that Ruby version could not be found."
   end
 end
-alias use ruby_version
+alias use use_ruby
 
 # load debugger, inspired by rdp
 def dbg
@@ -64,3 +82,19 @@ def dbg
     throw "Sorry, unable to load ruby-debug gem for debugger: #{e}"
   end
 end
+
+class Object
+  # display ri entry
+  def ri(meth)
+    ri_cmd = 'ri'
+    if instance_of?( Kernel ) || instance_of?( Object )
+      puts `#{ri_cmd} #{meth}`
+    elsif is_a? Module
+      puts `#{ri_cmd} #{self}.#{meth}`
+    else
+      puts `#{ri_cmd} #{self.class}##{meth}`
+    end
+  end
+end
+
+# J-_-L

data/lib/irbtools/libraries.rb

@@ -70,13 +70,13 @@ Irbtools.add_library 'zucker/debug' # nice debug printing (q, o, c, .m, .d)
 Irbtools.add_library 'ap'           # nice debug printing (ap)
 Irbtools.add_library 'yaml'         # nice debug printing (y)
 Irbtools.add_library 'g'            # nice debug printing (g) - MacOS only :/
-Irbtools.add_library 'guessmethod'  # automatically correct typos (method_missing hook)
+Irbtools.add_library 'guessmethod', true   # automatically correct typos (method_missing hook)
 Irbtools.add_library 'interactive_editor'  # lets you open vim (or your favourite editor), hack something, save it, and it's loaded in the current irb session
-#Irbtools.add_library 'zucker/all'   # see rubyzucker.info
+#Irbtools.add_library 'zucker/all'         # see rubyzucker.info
 
 Irbtools.add_library :boson do
-    undef :install if respond_to?( :install, true )
-      Boson.start :verbose => false
+  undef :install if respond_to?( :install, true )
+  Boson.start :verbose => false
 end
 
 # remove failing/not needed libs
@@ -89,8 +89,7 @@ unless OS.mac?
 end
 
 if RubyVersion.is? 1.9
-  Irbtools.libraries -= %w[guessmethod]
+  Irbtools.libraries_in_proc -= %w[guessmethod]
 end
 
 # J-_-L
-

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: irbtools
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 4
-  version: 0.7.4
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Jan Lelis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-09 00:00:00 +02:00
+date: 2010-10-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 requirements: 
-- You need to add http://merbi.st to your gem sources (irb_rocket)
+- "It's recommended to use the irb_rocket gem: gem install irb_rocket --source http://merbi.st"
 rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: