irbtools 1.0.5 → 1.0.6

data/CHANGELOG

@@ -1,3 +1,8 @@
+1.0.6
+* add possibility to modify library callbacks without removing the library by using: replace_library_callback or add_library_callback
+* fix hirb dependency issue
+* readme improvements
+
 1.0.5
 * use paint gem for terminal colors
 

data/README.rdoc

@@ -1,5 +1,5 @@
 = irbtools
-This is a meta gem that installs useful irb gems and configures your irb. It has a modular structure and supports multiple library-loading mechanisms, e.g. via <tt>autoload</tt> or threads.
+This is a meta gem that installs useful irb gems and configures them for you. It has a modular structure and supports multiple library-loading mechanisms, e.g. via <tt>autoload</tt> or threads, allowing you to use only the gems you need.
 
 == Setup
   gem install irbtools
@@ -9,84 +9,88 @@ This is a meta gem that installs useful irb gems and configures your irb. It has
 * On MacOS, you will need growl, if you want to use the +g+ gem.
 
 === Wrong display widths?
-When using double-width unicode chars, you should need to pass the <tt>:east_asian_width = true</tt> when starting <tt>FancyIrb</tt>. It is deactivated because of performance issues.
+When using double-width unicode chars, you need to paste the following snippet to your <tt>.irbrc</tt>.
+
+  Irbtools.replace_library_callback :fancy_irb do
+    FancyIrb.start :east_asian_width => true
+  end
+
+This setting is deactivated by default because of performance issues.
 
 == Usage
-To use it, put the following in your <tt>~/.irbrc</tt> file (this file is loaded every time you start an irb):
+To use it, put the following in your <tt>~/.irbrc</tt> file (this file is loaded every time you start irb):
 
   require 'rubygems' unless defined? Gem # rubygems is only needed in 1.8
   require 'irbtools'
 
-If it does not exist, just create a new one.
+If the file does not exist, just create a new one.
 
-It's possible to modify, which libraries get loaded:
+It's possible to modify, which libraries should be loaded:
 
-  # don't require 'irbtools'
+  # don't require 'irbtools', but:
   require 'irbtools/configure'
-  # here you can modify which libraries get loaded (see below)
+  # here you can modify the libraries using the methods below
   Irbtools.start
 
-You can also deactivate the loading of the complete default set of irbtools libraries by using <tt>require 'irbtools/minimal'</tt> instead of <tt>configure</tt>. You need to use the below methods for adding libraries in this case, or it won't modify anything of your irb ;).
+If you don't want to load the default set of irbtools gems, you will have to use <tt>require 'irbtools/minimal'</tt> instead of <tt>configure</tt>. You need to use the below methods for adding libraries in this case or *Irbtools* won't modify anything of your irb ;).
 
 === Rails notes
-To use irbtools within the rails console, you will have to add irbtools to your Gemfile <b>in this way:</b> (or there will be some bundler double require issues..)
+To use irbtools within the rails console, you will have to add <tt>irbtools</tt> to your Gemfile <b>in this way:</b> (or there will be some bundler double require issues..)
 
   gem 'irbtools', :require => 'irbtools/configure'
 
-You can put Rails specific configuration in a <tt>~/.railsrc</tt> file which gets loaded only in Rails environments.
-
-=== How to load more or less libraries
-You have the following ways:
-* <tt>Irbtools.add_library(lib, options_hash, &block)</tt>
-* <tt>Irbtools.remove_library(lib)</tt>
-
-The <tt>options_hash</tt> defines the way in which Irbtools loads the library. Following options are possible
-* (no options)/<tt>:start</tt> - The library is required on startup before doing anything else (before displaying the prompt)
-* <tt>:thread => identifier</tt> - After loading everything else, the library is required in a thread (while continuing loading). You can choose any identifier, but if you take the same one for multiple libraries, they will be loaded in the same thread (in the order that you define)
-* <tt>:late => true</tt> - The library is required just before showing the prompt (note: loading threads might still be in process)
-* <tt>:late_thread => identifier</tt> - Same as <tt>:thread</tt>, but after loading late libraries.
-* <tt>:sub_session => true</tt> - The library is loaded every time a sub-session starts (using <tt>IRB.conf[:IRB_RC]</tt>). In ripl[https://github.com/cldwalker/ripl], <tt>ripl-after_rc</tt> is used.
-* <tt>:autoload => :Constant</tt> - Use Ruby's <tt>autoload</tt> feature. It loads the library as soon as the constant is encountered.
+You can put Rails specific configuration in a <tt>~/.railsrc</tt> file that gets only loaded in Rails environments.
 
-You can also apply a block that gets executed after the library is loaded (except for autoload, the code will executed on startup in this case).
+See {this blog post}[http://rbjl.net/49-railsrc-rails-console-snippets] for some Rails goodies. Please open an issue/say +1 in the comments there to get that stuff packaged into a gem.
 
-When adding a new library, you should consider adding it via autoload, try loading it via thread if autoload is not suitable and fallback to some other method, if not via thread is not possible.
+=== Included gems and libraries
 
-See the <tt>Irbtools.libraries</tt> hash for the current Irbtools configuration that actually will be used when calling <tt>Irbtools.start</tt>.
+See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented source files to get some examples of what you can do with irbtools.
+
+[paint[https://github.com/janlelis/paint/]]                terminal colors
+[wirb[https://github.com/janlelis/wirb/]]                  colorize ruby objects
+[hirb[http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html]]
+                                                           (active record) tables and custom views for specific objects
+[fancy_irb[https://github.com/janlelis/fancy_irb]]         use hash rockets for output and more colorization
+[every_day_irb[https://github.com/janlelis/irbtools/tree/master/lib/every_day_irb.rb]]
+                                                           helper methods that might be useful in every-day irb usage, e.g.: ls, cat, rq, rrq, ld, session_history, reset!, clear, dbg
+[clipboard[http://github.com/janlelis/clipboard]]          easy clipboard access (copy & paste)
+[interactive_editor[https://github.com/jberkel/interactive_editor]]
+                                                           lets you open vim, hack something, and it gets loaded into the current session, also possible: yaml object editing
+[sketches[http://sketches.rubyforge.org/]]                 another, more flexible "start editor and it gets loaded into your irb session" plugin
+[zucker[http:/rubyzucker.info]]                            nice debug printing (q, o, c, .m, .d) + useful pseudo-constants (Info, OS, RubyVersion, RubyEngine)
+[ap[https://github.com/michaeldv/awesome_print]]           nice debug printing (ap) [also see wp from wirb/wp]
+[coderay[http://coderay.rubychan.de/]]                     some colorful code view helpers :)
+[boson[http://tagaholic.me/boson/]]                        commands framework (commands also work in the shell!)
+[methodfinder[https://github.com/citizen428/methodfinder]] interesting method finder (mf)
+[ori[https://github.com/dadooda/ori]]                      object-oriented <tt>.ri</tt> method
+[*fileutils* (stdlib)]                                     cd, pwd, ln_s, mv, rm, mkdir, touch ... ;)
 
-==== Packages
-There are irbtools extension packages, which can be modified via:
-* <tt>Irbtools.add_package(pkg)</tt>
-* <tt>Irbtools.remove_package(pkg)</tt>
+=== Not included anymore
 
-These packages add/modify the libraries to be loaded. For an example, see {irbtools-more}[https://github.com/janlelis/irbtools-more].
+[guessmethod[http://guessmethod.rubyforge.org/]]    automatically corrects typos (method_missing hook)
 
-== Features
-See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented source files.
+==== RVM
+If you have RVM installed, you can switch your gemset or ruby with <tt>gemset</tt> and <tt>use</tt> (use <tt>gemsets</tt> and <tt>rubies</tt> to get a list). The gemset can be changed within the session, while changing ruby starts a new one. Please also note that you need to have installed irbtools for that ruby version. I recommend installing it in the <tt>global</tt> gemset.
 
-=== Included gems and libraries
-* paint[https://github.com/janlelis/paint/]    terminal colors
-* wirb[https://github.com/janlelis/wirb/]      colorize ruby objects
-* hirb[http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html]     (active record) tables and custom views for specific objects
-* fancy_irb[https://github.com/janlelis/fancy_irb]   put result as comment and more colorization
-* every_day_irb[https://github.com/janlelis/irbtools/tree/master/lib/every_day_irb.rb]   helper methods that might be useful in every-day irb usage, e.g.: ls, cat, rq, rrq, ld, session_history, reset!, clear, dbg
-* clipboard[http://github.com/janlelis/clipboard]     easy clipboard access (copy & paste)
-* interactive_editor[https://github.com/jberkel/interactive_editor]    lets you open vim, hack something, and it gets loaded into the current session, also possible: yaml object editing
-* sketches[http://sketches.rubyforge.org/]   another, more flexible "start editor and it gets loaded into your irb session" plugin
-* zucker[http:/rubyzucker.info]   nice debug printing (q, o, c, .m, .d) + useful pseudo-constants (Info, OS, RubyVersion, RubyEngine)
-* ap[https://github.com/michaeldv/awesome_print]      nice debug printing (ap) [also see wp from wirb/wp]
-* coderay[http://coderay.rubychan.de/]    some colorful code displaying ;)
-* boson[http://tagaholic.me/boson/]  commands repository (commands also work in the shell!)
-* methodfinder[https://github.com/citizen428/methodfinder] interesting method finder (mf)
-* ori[https://github.com/dadooda/ori] object-oriented ri method
-* *fileutils* (stdlib) cd, pwd, ln_s, mv, rm, mkdir, touch ... ;)
+=== How to load more or less libraries
+You have the following methods:
+* <tt>Irbtools.add_library(lib, options_hash, &block)</tt>
+* <tt>Irbtools.remove_library(lib)</tt>
 
-=== Not included anymore
+The <tt>options_hash</tt> defines the way in which Irbtools loads the library. Following options are possible
+[(no options)/<tt>:start</tt>] The library is required on startup before doing anything else (before displaying the prompt)
+[<tt>:thread => identifier</tt>] After loading everything else, the library is required in a thread (while continuing loading). You can choose any identifier, but if you take the same one for multiple libraries, they will be loaded in the same thread (in the order that you define)
+[<tt>:late => true</tt>] The library is required just before showing the prompt (note: loading threads might still be in process)
+[<tt>:late_thread => identifier</tt>] Same as <tt>:thread</tt>, but after loading late libraries.
+[<tt>:sub_session => true</tt>] The library is loaded every time a sub-session starts (using <tt>IRB.conf[:IRB_RC]</tt>). In ripl[https://github.com/cldwalker/ripl], <tt>ripl-after_rc</tt> is used.
+[<tt>:autoload => :Constant</tt>] Use Ruby's <tt>autoload</tt> feature. It loads the library as soon as the constant is encountered.
 
-* guessmethod[http://guessmethod.rubyforge.org/]    automatically corrects typos (method_missing hook)
+You can also apply a block that gets executed after the library is loaded (except for autoload, the code will executed on startup in this case). You can also just add callback block by using the <tt>Irbtools.add_library_callback</tt> or the <tt>Irbtools.replace_library_callback</tt> method.
 
-==== RVM
-If you have RVM installed, you can switch your gemset or ruby with <tt>gemset</tt> and <tt>use</tt> (use <tt>gemsets</tt> and <tt>rubies</tt> to get a list). The gemset can be changed within the session, while changing ruby starts a new one. Please also note that you need to have installed irbtools for that ruby version. I recommend installing it in the <tt>global</tt> gemset.
+When adding a new library, you should firstly consider some way to load it via <tt>:autoload</tt>.
+If not possible, try loading via thread.
+If that is not possible either, fallback to the default loading.
 
 == Hint: Faster start-up
 
@@ -102,6 +106,19 @@ You can get an about a second faster start-up time by changing the loading metho
 == Welcome message
 The welcome message can be customized with <tt>Irbtools.welcome_message=</tt>
 
+== Packages
+There are irbtools extension packages, which can be modified via:
+* <tt>Irbtools.add_package(pkg)</tt>
+* <tt>Irbtools.remove_package(pkg)</tt>
+
+These packages add/modify the libraries to be loaded. For an example, see {irbtools-more}[https://github.com/janlelis/irbtools-more].
+
+== TODO irbtools 1.1.0
+* Fix/Improve RVM stuff
+* Way to use irbtools without
+* Better hirb interaction
+* Show some features in README
+
 == Copyright
 Copyright (c) 2010-2011 Jan Lelis, http://rbjl.net, released under the MIT license.
 

data/VERSION

@@ -1 +1 @@
-1.0.5
+1.0.6

data/irbtools.gemspec

@@ -14,15 +14,15 @@ Gem::Specification.new do |s|
   s.homepage              = 'https://github.com/janlelis/irbtools'
   s.required_ruby_version = '>= 1.8.7'
 
-  s.add_dependency %q<paint>,         ">= 0.8.1"
+  s.add_dependency %q<paint>,         ">= 0.8.3"
   s.add_dependency %q<fancy_irb>,     ">= 0.7.0"
   s.add_dependency %q<zucker>,        ">= 11"
-  s.add_dependency %q<hirb>,          "~> 0.4.5"
+  s.add_dependency %q<hirb>,          "~> 0.5.0"
   s.add_dependency %q<awesome_print>, "~> 0.4.0"
   s.add_dependency %q<clipboard>,     ">= 0.9.9"
   s.add_dependency %q<coderay>,       "~> 0.9"
-  s.add_dependency %q<boson>,         ">= 0.3.3"
-  s.add_dependency %q<wirb>,          ">= 0.4.0"
+  s.add_dependency %q<boson>,         ">= 0.3.4"
+  s.add_dependency %q<wirb>,          ">= 0.4.1"
   s.add_dependency %q<interactive_editor>, ">= 0.0.8"
   s.add_dependency %q<ori>,           "~> 0.1.0"
   s.add_dependency %q<sketches>,      ">= 0"

data/lib/irbtools/configure.rb

@@ -71,11 +71,29 @@ module Irbtools
         @libraries[:start] << lib
       end
 
-      @lib_hooks[lib] << block if block_given?
+      add_library_callback(lib, &block) if block_given?
     end
     alias add_lib add_library
     alias add_gem add_library
 
+    # add a callback that gets (usually) executed after loading the library
+    def add_library_callback(lib, &block)
+      lib = lib.to_s
+      @lib_hooks[lib] << block
+    end
+    alias add_lib_callback add_library_callback
+    alias add_gem_callback add_library_callback
+
+    # replace all callbacks with the new one given in the block
+    # a callback that gets (usually) executed after loading the library
+    def replace_library_callback(lib, &block)
+      lib = lib.to_s
+      @lib_hooks[lib].clear
+      @lib_hooks[lib] << block
+    end
+    alias replace_lib_callback replace_library_callback
+    alias replace_gem_callback replace_library_callback
+
     # don't load a specific library
     def remove_library(lib)
       lib = lib.to_s

metadata

@@ -2,7 +2,7 @@
 name: irbtools
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors: 
 - Jan Lelis
@@ -10,7 +10,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 Z
+date: 2011-08-20 00:00:00 +02:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: paint
@@ -20,7 +21,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.1
+        version: 0.8.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -53,7 +54,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.4.5
+        version: 0.5.0
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -97,7 +98,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.3
+        version: 0.3.4
   type: :runtime
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
@@ -108,7 +109,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.0
+        version: 0.4.1
   type: :runtime
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
@@ -185,7 +186,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.5
+        version: 1.0.6
   type: :runtime
   version_requirements: *id016
 description: irbtools is a meta gem that installs useful irb gems and configures your irb. Simply put a require "irbtools" in the .irbrc file in your home directory.
@@ -208,6 +209,7 @@ files:
 - irbtools.gemspec
 - LICENSE
 - README.rdoc
+has_rdoc: true
 homepage: https://github.com/janlelis/irbtools
 licenses: []
 
@@ -231,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: irbtools is a meta gem that installs useful irb gems and configures your irb.