irbtools 0.7.2 → 0.7.3

data/CHANGELOG

@@ -1,4 +1,9 @@
-0.7.1
+0.7.3
+* refactored file structure and added new Irbtools.add_lib method
+* load railsrc if executed with rails and Irbtools.railsrc is set
+* more little fixes
+
+0.7.2
 * fixed Rails 3 bug
 * added boson gem (command repository)
 * remember history when resetting or switching ruby version

data/README.rdoc

@@ -23,11 +23,9 @@ 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 Irbtools.libs array
+  # here you can edit the <tt>Irbtools.libs</tt> array or add libraries inclusive load callbacks with <tt>Irbtools.add_library</tt>
   Irbtools.init
 
-You could also just read and copy the irbtools/configure.rb and irbtools.rb source files, tweak them and use them directly as <tt>.irbrc</tt> ;)
-
 == Features
 
 See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented source file: lib/irbtools.rb

data/Rakefile

@@ -18,7 +18,6 @@ begin
     gem.add_dependency 'g'
     gem.add_dependency 'clipboard'
     gem.add_dependency 'guessmethod'
-    # gem.add_dependency 'drx'
     gem.add_dependency 'interactive_editor'
     gem.add_dependency 'coderay'
     gem.add_dependency 'boson'

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.7.3

data/irbtools.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{irbtools}
-  s.version = "0.7.2"
+  s.version = "0.7.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jan Lelis"]
-  s.date = %q{2010-10-07}
+  s.date = %q{2010-10-08}
   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 = [
@@ -27,6 +27,9 @@ Gem::Specification.new do |s|
      "irbtools.gemspec",
      "lib/irbtools.rb",
      "lib/irbtools/configure.rb",
+     "lib/irbtools/general.rb",
+     "lib/irbtools/libraries.rb",
+     "lib/irbtools/workarounds.rb",
      "screenshots/examples1.png",
      "screenshots/examples2.png"
   ]

data/lib/irbtools.rb

@@ -8,69 +8,14 @@ require File.expand_path('irbtools/configure', File.dirname(__FILE__) )
 
 # # # # #
 # load libraries
-Irbtools.libs.each{ |lib|
+remember_verbose_and_debug = $VERBOSE, $DEBUG
+$VERBOSE = $DEBUG = false
+
+Irbtools.libraries.each{ |lib|
   begin
-    require lib # &&
-    case lib
-
-    when 'wirble'
-      Wirble.init
-      Wirble.colorize unless OS.windows?
-
-    when 'hirb'
-      Hirb::View.enable
-
-    when 'fileutils'
-     include FileUtils::Verbose
-
-     # patch cd so that it also shows the current directory
-     def cd(path = '/', *args)
-       FileUtils::Verbose.cd path, *args
-       ls
-     end
-
-    when 'clipboard'
-      # copies the clipboard
-      def copy(str)
-        Clipboard.copy(str)
-      end
-
-      # pastes the clipboard
-      def paste
-        Clipboard.paste
-      end
-
-      # copies everything you have entered in this irb session
-      def copy_input
-        copy session_history
-        "The session input history has been copied to the clipboard."
-      end
-      alias copy_session_input copy_input
-
-      # copies the output of all irb commands in this irb session
-      def copy_output
-        copy context.instance_variable_get(:@eval_history_values).inspect.gsub(/^\d+ (.*)/, '\1')
-        "The session output history has been copied to the clipboard."
-      end
-      alias copy_session_output copy_output
-
-
-    when 'coderay'
-      # syntax highlight a string
-      def colorize(string)
-        puts CodeRay.scan( string, :ruby ).term
-      end
-
-      # syntax highlight a file
-      def ray(path)
-        puts CodeRay.scan( File.read(path), :ruby ).term
-      end
-
-    when 'boson'
-      undef :install if respond_to?( :install, true )
-      Boson.start :verbose => false
+    require lib.to_s
 
-    end
+    Irbtools.send :library_loaded, lib
 
   rescue LoadError => err
     if err.to_s =~ /irb_rocket/ && RubyEngine.mri?
@@ -82,76 +27,11 @@ You can install it with: gem install irb_rocket --source http://merbi.st"
   end
 }
 
+$VERBOSE, $DEBUG = remember_verbose_and_debug
+
 # # # # #
 # general shortcuts & helper methods
-
-# shows the contents of your current directory (more such commands available by FileUtils)
-def ls(path='.')
-  Dir[ File.join( path, '*' )].map{|res| res =~ /^#{path}\/?/; $' }
-end
-alias dir ls
-
-# read file contents (also see ray for ruby source files ;) )
-def cat(path)
-  File.read path
-end
-
-# allows concise syntax like rq:mathn
-def rq(lib)
-  require lib.to_s
-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"
-end
-
-# restart irb
-def reset!
-  at_exit { exec$0 } # remember history
-  exit
-end
-
-def ruby_version(which = nil)
-  # test if installed
-  unless `rvm -v` =~ /Seguin/
-    raise 'Ruby Version Manager must be installed to use this command'
-  end
-
-  # show rubies if called without options
-  if !which
-    puts 'Availabe Rubies: ' +
-          `rvm list`.scan( /^(?:  |=>) (.*) \[/ )*", "
-    return
-  end
-
-  # get irb suffix
-  rv = `rvm use #{which}` # e.g. => "\ninfo: Using ruby 1.9.2 p0\n"
-                          # it does not change the ruby for the current user
-  rv =~ /^.*Using(.*)\n/
-
-  # if ruby is found, start it
-  if $1
-    ruby_name = File.split( $1 )[-1].tr(' ', '-')
-    irbname = $0 + '-' + ruby_name# + '@global'
-    at_exit { exec irbname } # remember history
-    exit
-  else
-    puts "Sorry, that Ruby version could not be found."
-  end
-end
-alias use ruby_version
-
-# load debugger, inspired by rdp
-def debuger 
-  begin
-    require 'ruby-debug'
-    debugger
-  rescue LoadError => e 
-    throw "Sorry, unable to load ruby-debug gem for debugger: #{e}"
-  end  
-end
-
+require File.expand_path('irbtools/general', File.dirname(__FILE__) )
 
 # # # # #
 # irb options
@@ -173,54 +53,21 @@ IRB.conf[:PROMPT_MODE] = :IRBTOOLS
 
 # # # # #
 # misc
-Zucker.more_aliases!  # RubyVersion --> RV, RubyEngine --> RE
+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
+    load File.expand_path( Irbtools.railsrc )
+  end
+rescue
+end
 
 # # # # #
 # workarounds
-
-# irb_rocket stdout problems
-if IRB.const_defined? :CaptureIO
-  module IRB
-    class CaptureIO
-      def self.streams
-        {
-           :stdout => @@current_capture.instance_variable_get( :@out ),
-           :stderr => @@current_capture.instance_variable_get( :@err ),
-        }
-      end
-
-      alias original_capture capture
-      def capture(&block)
-        @@current_capture = self
-        original_capture &block
-      end
-    end
-  end
-
-  # patch method using stdout
-  module Kernel
-    alias exec_unpatched exec
-    def exec(*args)
-      STDOUT.reopen(IRB::CaptureIO.streams[:stdout])
-      STDERR.reopen(IRB::CaptureIO.streams[:stderr])
-      exec_unpatched *args
-    end
-  end
-
-  if Object.const_defined? :InteractiveEditor
-    InteractiveEditor::Editors.class_eval do
-      editors = %w[vi vim emacs nano mate ed]
-      editors.each{ |editor|
-        alias_for editor, editor_unpatched = ( editor +  '_unpatched' ).to_sym
-        define_method editor do
-          STDOUT.reopen(IRB::CaptureIO.streams[:stdout])
-          STDERR.reopen(IRB::CaptureIO.streams[:stderr])
-          send editor_unpatched
-        end
-      }
-    end
-  end
-end
+require File.expand_path('irbtools/workarounds', File.dirname(__FILE__) )
 
 # # # # #
 # done :)

data/lib/irbtools/configure.rb

@@ -9,52 +9,64 @@ begin
   require 'zucker/alias_for'
   require 'zucker/env'       # Info, OS, RubyVersion, RubyEngine
 rescue LoadError
-  puts "The irbtools couldn't load, because the zucker gem is not available"
-else
-  # suggested libraries
-  module Irbtools
-    @libs = ['rubygems',
-       'wirble',        # colors
-       'hirb',          # active record tables
-       'fileutils',     # cd, pwd, ln_s, mv, rm, mkdir, touch ... ;)
-       'zucker/debug',  # nice debug printing (q, o, c, .m, .d)
-       'ap',            # nice debug printing (ap)
-       'yaml',          # nice debug printing (y)
-       'g',             # nice debug printing (g) - MacOS only :/
-       'clipboard',     # easy clipboard access (copy & paste)
-       'guessmethod',   # automatically correct typos (method_missing hook)
-        # 'drx',           # nice tk object inspector (.see) [not included because it fails to install out of the box on lots of systems]
-       'interactive_editor',  # lets you open vim (or your favourite editor), hack something, save it, and it's loaded in the current irb session
-       'coderay',       # some nice colorful display ;)
-       'boson',         # IRB commands repository (which also works for the shell!)
-       'irb_rocket',    # put result as comment instead of a new line!
-       # 'zucker/all'   # see rubyzucker.info
-      ]
-
-    if OS.windows?
-      @libs -= %w[irb_rocket coderay]
-    end
-
-    unless OS.mac?
-      @libs -= %w[g]
-    end
-
-    if RubyVersion.is? 1.9
-      @libs -= %w[guessmethod]
-    end
-
-    class << self
-      def libs
-        @libs
-      end
-      aliases_for :libs, :gems, :libraries
-
-      def init
-        require File.expand_path( '../irbtools.rb', File.dirname(__FILE__) )
-      end
-    end
-    VERSION = File.read File.expand_path( '../../VERSION', File.dirname(__FILE__) )
-  end#module
+  raise "Sorry, the irbtools couldn't load, because the zucker gem is not available"
 end
 
+# # # # #
+# define module methods
+module Irbtools
+  @lib_hooks = Hash.new{|h,k| h[k] = [] }
+  @libs = %w[rubygems]
+  @railsrc = '~/.railsrc'
+
+  class << self
+    def libraries
+      @libs
+    end
+    aliases_for :libraries, :gems, :libs
+
+    def libraries=(value)
+      @libs = value
+    end
+    aliases_for :'libraries=', :'gems=', :'libs='
+
+    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
+
+    def remove_library(lib)
+      @libs.delete lib.to_s
+      @lib_hooks.delete lib.to_s
+    end
+    aliases_for :remove_library, :remove_lib, :remove_gem
+
+    def railsrc
+      @railsrc
+    end
+
+    def railsrc=(path)
+      @railsrc = path
+    end
+
+    def library_loaded(lib)
+      @lib_hooks[lib.to_s].each{ |hook| hook.call }
+    end
+    private :library_loaded
+
+    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__) )
+end
+
+# # # # #
+# libraries
+require File.expand_path( 'libraries.rb', File.dirname(__FILE__) )
+
 # J-_-L
+

data/lib/irbtools/general.rb

@@ -0,0 +1,66 @@
+# shows the contents of your current directory (more such commands available by FileUtils)
+def ls(path='.')
+  Dir[ File.join( path, '*' )].map{|res| res =~ /^#{path}\/?/; $' }
+end
+alias dir ls
+
+# read file contents (also see ray for ruby source files ;) )
+def cat(path)
+  File.read path
+end
+
+# allows concise syntax like rq:mathn
+def rq(lib)
+  require lib.to_s
+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"
+end
+
+# restart irb
+def reset!
+  at_exit { exec$0 } # remember history
+  exit
+end
+
+def ruby_version(which = nil)
+  # test if installed
+  unless `rvm -v` =~ /Seguin/
+    raise 'Ruby Version Manager must be installed to use this command'
+  end
+
+  # show rubies if called without options
+  if !which
+    puts 'Availabe Rubies: ' +
+          `rvm list`.scan( /^(?:  |=>) (.*) \[/ )*", "
+    return
+  end
+
+  # get irb suffix
+  rv = `rvm use #{which}` # e.g. => "\ninfo: Using ruby 1.9.2 p0\n"
+                          # it does not change the ruby for the current user
+  rv =~ /^.*Using(.*)\n/
+
+  # if ruby is found, start it
+  if $1
+    ruby_name = File.split( $1 )[-1].tr(' ', '-')
+    irbname = $0 + '-' + ruby_name# + '@global'
+    at_exit { exec irbname } # remember history
+    exit
+  else
+    puts "Sorry, that Ruby version could not be found."
+  end
+end
+alias use ruby_version
+
+# load debugger, inspired by rdp
+def dbg
+  begin
+    require 'ruby-debug'
+    debugger
+  rescue LoadError => e
+    throw "Sorry, unable to load ruby-debug gem for debugger: #{e}"
+  end
+end

data/lib/irbtools/libraries.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+
+# # # # #
+# require 'irbtools' in your .irbrc
+# but you could also require 'irbtools/configure' and then call Irbtools.init to modify the loaded libraries
+# see the README file for more information
+
+Irbtools.add_library :wirble do # colors
+  Wirble.init
+  Wirble.colorize unless OS.windows?
+end
+
+Irbtools.add_library :hirb do # active record tables
+  Hirb::View.enable
+end
+
+Irbtools.add_library :fileutils do # cd, pwd, ln_s, mv, rm, mkdir, touch ... ;)
+  include FileUtils::Verbose
+
+  # patch cd so that it also shows the current directory
+  def cd(path = '/', *args)
+    FileUtils::Verbose.cd path, *args
+    ls
+  end
+
+end
+
+Irbtools.add_library :coderay do
+  # syntax highlight a string
+  def colorize(string)
+    puts CodeRay.scan( string, :ruby ).term
+  end
+
+  # syntax highlight a file
+  def ray(path)
+    puts CodeRay.scan( File.read(path), :ruby ).term
+  end
+end
+
+Irbtools.add_library :clipboard do # access the clipboard
+  # copies the clipboard
+  def copy(str)
+    Clipboard.copy(str)
+  end
+
+  # pastes the clipboard
+  def paste
+    Clipboard.paste
+  end
+
+  # copies everything you have entered in this irb session
+  def copy_input
+    copy session_history
+    "The session input history has been copied to the clipboard."
+  end
+  alias copy_session_input copy_input
+
+  # copies the output of all irb commands in this irb session
+  def copy_output
+    copy context.instance_variable_get(:@eval_history_values).inspect.gsub(/^\d+ (.*)/, '\1')
+    "The session output history has been copied to the clipboard."
+  end
+  alias copy_session_output copy_output
+end
+
+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 '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 'irb_rocket'   # put result as comment instead of a new line!
+#Irbtools.add_library 'zucker/all'   # see rubyzucker.info
+
+Irbtools.add_library :boson do
+    undef :install if respond_to?( :install, true )
+      Boson.start :verbose => false
+end
+
+# remove failing/not needed libs
+if OS.windows?
+  Irbtools.libraries -= %w[irb_rocket coderay]
+end
+
+unless OS.mac?
+  Irbtools.libraries -= %w[g]
+end
+
+if RubyVersion.is? 1.9
+  Irbtools.libraries -= %w[guessmethod]
+end
+
+# J-_-L
+

data/lib/irbtools/workarounds.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+# # # # #
+# require 'irbtools' in your .irbrc
+# but you could also require 'irbtools/configure' and then call Irbtools.init to modify the loaded libraries
+# see the README file for more information
+
+# irb_rocket stdout problems
+if IRB.const_defined? :CaptureIO
+  module IRB
+    class CaptureIO
+      def self.streams
+        {
+           :stdout => @@current_capture.instance_variable_get( :@out ),
+           :stderr => @@current_capture.instance_variable_get( :@err ),
+        }
+      end
+
+      alias original_capture capture
+      def capture(&block)
+        @@current_capture = self
+        original_capture &block
+      end
+    end
+  end
+
+  # patch methods using stdout
+  module Kernel
+    private
+
+    alias exec_unpatched exec
+    def exec(*args)
+      STDOUT.reopen(IRB::CaptureIO.streams[:stdout])
+      STDERR.reopen(IRB::CaptureIO.streams[:stderr])
+      exec_unpatched *args
+    end
+  end
+
+  alias dbg_unpatched dbg
+  def dbg
+    STDOUT.reopen(IRB::CaptureIO.streams[:stdout])
+    STDERR.reopen(IRB::CaptureIO.streams[:stderr])
+    dbg_unpatched
+  end
+
+  if Object.const_defined? :InteractiveEditor
+    InteractiveEditor::Editors.class_eval do
+      editors = %w[vi vim emacs nano mate ed]
+      editors.each{ |editor|
+        alias_for editor, editor_unpatched = ( editor +  '_unpatched' ).to_sym
+        define_method editor do
+          STDOUT.reopen(IRB::CaptureIO.streams[:stdout])
+          STDERR.reopen(IRB::CaptureIO.streams[:stderr])
+          send editor_unpatched
+        end
+      }
+    end
+  end
+end
+
+# J-_-L
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: irbtools
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 7
-  - 2
-  version: 0.7.2
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Jan Lelis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-07 00:00:00 +02:00
+date: 2010-10-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -178,6 +178,9 @@ files:
 - irbtools.gemspec
 - lib/irbtools.rb
 - lib/irbtools/configure.rb
+- lib/irbtools/general.rb
+- lib/irbtools/libraries.rb
+- lib/irbtools/workarounds.rb
 - screenshots/examples1.png
 - screenshots/examples2.png
 has_rdoc: true