irbtools 1.2.3 → 1.4.0

data/CHANGELOG

@@ -1,4 +1,12 @@
-1.3.0
+1.4.0
+* every_day_irb is now a module that extends self
+* specs for most of every_day_irb's functionality
+* add helper method for paging output with hirb: page
+* version bumps, including wirb and fancy_irb
+* remove sketches dependency, it's a great gem, but very similar to interactive_editor
+* Object#mlp alias for method_lookup_path
+
+1.3.0 == 1.2.3
 * add modern debundle note
 * remove loading of .railsrc
 * remove dbg method

data/README.rdoc

@@ -1,18 +1,17 @@
 = irbtools
-The irbtools gem is a meta gem that installs handy and useful irb gems and provides an appealing ready-to-use irb configuration. It has a modular structure and supports multiple library-loading mechanisms, e.g. via <tt>autoload</tt> or threads.
+irbtools improves Ruby's irb console. Unlike pry, you are still in your normal irb, but you have colors and lots of helpful methods.
 
 == Setup
 
   gem install irbtools
   
 * On Linux, you need +xclip+ or +xsel+ to use the clipboard: sudo <tt>apt-get install xclip</tt>
-* On Windows, you need ansicon[https://github.com/adoxa/ansicon] to enjoy all the colors
+* On Windows, you need ansicon[https://github.com/adoxa/ansicon] to enable colors
 * On MacOS, you need growl, to use the +g+ gem.
 
 == Usage
-To use *irbtools*, put the following in your <tt>~/.irbrc</tt> file (this file is loaded every time you start irb):
+To use *irbtools*, put the following in your <tt>~/.irbrc</tt> file (it is loaded every time you start irb):
 
-  require 'rubygems' unless defined? Gem # rubygems is only needed in 1.8
   require 'irbtools'
 
 If the file does not exist, just create a new one. See further below on how to customize loaded libraries.
@@ -32,8 +31,6 @@ Another way is to add a debundle hack on top of your <tt>~/.irbrc</tt>:
     alias gem require                                                              
   end
 
-See {this blog post}[http://rbjl.net/49-railsrc-rails-console-snippets] for some Rails integration features.
-
 === Yesterday's Ruby versions
 
 *irbtools* focuses on Ruby 1.9 support. To get it working with 1.8.7, use the following line in your Gemfile:
@@ -42,7 +39,7 @@ See {this blog post}[http://rbjl.net/49-railsrc-rails-console-snippets] for some
 
 === This is irbtools "light"
 
-When installing *irbtools*, some gems won't be installed to keep windows support, e.g. better auto-completion or the looksee gem. These are packaged in the {irbtools-more}[https://github.com/janlelis/irbtools-more] gem. To use them, you need to change your <tt>.irbrc</tt> to:
+When installing *irbtools*, some gems won't be installed to keep windows support, e.g. better auto-completion or the looksee gem. These are packaged into the {irbtools-more}[https://github.com/janlelis/irbtools-more] gem. To use them, you need to change your <tt>.irbrc</tt> to:
 
   require 'irbtools/configure'
   Irbtools.add_package :more
@@ -52,7 +49,7 @@ When installing *irbtools*, some gems won't be installed to keep windows support
 
 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.
 
-[wirb[https://github.com/janlelis/wirb/]]                  Colorizes Ruby objects (used for the results)
+[wirb[https://github.com/janlelis/wirb/]]                  Colorizes resulting Ruby objects
 [paint[https://github.com/janlelis/paint/]]                Provides easily to use terminal colors
 [hirb[http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html]]
                                                            Custom views for specific objects, e.g. tables for ActiveRecord
@@ -61,15 +58,14 @@ See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented s
                                                            Contains helper methods that might be useful in every-day irb usage, see below for details
 [clipboard[http://github.com/janlelis/clipboard]]          Easy clipboard access
 [interactive_editor[https://github.com/jberkel/interactive_editor]]
-                                                           Lets you open vim from within irb to hack something that 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
+                                                           Lets you open vim (or emacs) from within irb to hack something that gets loaded into the current session, also possible: yaml object editing
 [zucker[http:/rubyzucker.info]]                            Nice debug printing (<tt>q</tt>, <tt>o</tt>, <tt>c</tt>, <tt>Object#m</tt>, <tt>Object#d</tt>) and useful pseudo-constants (<tt>Info</tt>, <tt>OS</tt>, <tt>RubyVersion</tt>, <tt>RubyEngine</tt>)
-[ap[https://github.com/michaeldv/awesome_print]]           Nice debug printing commands (<tt>ap</tt>) [also possible: <tt>wp</tt> from wirb/wp]
+[ap[https://github.com/michaeldv/awesome_print]]           Alternative for displaying Ruby objects
 [coderay[http://coderay.rubychan.de/]]                     Colorizes Ruby code (<tt>colorize</tt>, <tt>ray</tt>)
 [boson[http://tagaholic.me/boson/]]                        "A command/task framework similar to rake and thor that opens your ruby universe to the commandline and irb."
 [methodfinder[https://github.com/citizen428/methodfinder]] Interesting method finder (<tt>mf</tt>)
 [ori[https://github.com/dadooda/ori]]                      Adds an <tt>Object#ri</tt> method
-[method_locator[https://github.com/ryanlecompte/method_locator]] Provides <tt>Object#method_lookup_path</tt> (improved version of <tt>Module#ancestors</tt>) and <tt>Object#methods_for</tt> (get this method from all ancestors)
+[method_locator[https://github.com/ryanlecompte/method_locator]] Provides <tt>Object#mlp</tt> (improved version of <tt>Module#ancestors</tt>) and <tt>Object#methods_for(m)</tt> (get this method from all ancestors)
 [method_source[https://github.com/banister/method_source]] <tt>Object#src</tt> can be shown for Ruby methods
 [bond[http://tagaholic.me/bond/]]                          <b>irbtools-more:</b> Improves irb tab-completion
 [looksee[https://github.com/oggy/looksee]]                 <b>irbtools-more:</b> Great load path inspector: <tt>Object#l</tt> (Extended version of <tt>Object#m</tt>), also provides the ability to <tt>Object#edit</tt> methods.
@@ -78,6 +74,7 @@ See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented s
 
 === Not included anymore
 
+[sketches[http://sketches.rubyforge.org/]]                 Another, more flexible "start editor and it gets loaded into your irb session" plugin. It's a great gem, but the reason it's not included anymore is that it's functionality is very similar to the one provided by the interactive_editor gem
 [guessmethod[http://guessmethod.rubyforge.org/]] Automatically tries to corrects typos in method names
 [rvm_loader] RVM helpers
 
@@ -106,6 +103,7 @@ Irbtools also defines some more helpers in combination with the loaded gems:
 [copy_input]  Copies the session_history to the clipboard
 [copy_output] Copies this session's results to the clipboard
 [mf]     Shortcut for using the *methodfinder*
+[page]   Shortcut for using the pager from *hirb*
 
 These are the custom public +Object+ methods renamed/patched for some gems
 
@@ -114,6 +112,7 @@ These are the custom public +Object+ methods renamed/patched for some gems
 [l/ll]   Alternative method name to trigger the *looksee* gem (<b>irbtools-more</b>)
 
 
+== Advanced tweaking
 === How to load more or less libraries
 
 It's possible to modify, which libraries should get loaded:
@@ -143,7 +142,7 @@ When adding a new library, you should firstly consider some way to load it via <
 If not possible, try loading via thread.
 If that is not possible either, fallback to the default loading.
 
-== Troubleshooting: Unicode caused Wrong display widths?
+== Troubleshooting: Unicode causes wrong display widths?
 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

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.4.0

data/irbtools.gemspec

@@ -19,23 +19,22 @@ Gem::Specification.new do |s|
   s.add_dependency %q<boson>,         "~> 1.2.4"
   s.add_dependency %q<clipboard>,     "~> 1.0.1"
   s.add_dependency %q<interactive_editor>, ">= 0.0.10"
-  s.add_dependency %q<sketches>,      ">= 0.1.1"
   s.add_dependency %q<every_day_irb>, ">= #{ s.version }"
 
   # display
   s.add_dependency %q<paint>,         ">= 0.8.5"
-  s.add_dependency %q<fancy_irb>,     ">= 0.7.2"
-  s.add_dependency %q<wirb>,          ">= 0.4.2"
+  s.add_dependency %q<fancy_irb>,     ">= 0.7.3"
+  s.add_dependency %q<wirb>,          ">= 0.4.3"
   s.add_dependency %q<hirb>,          "~> 0.7.0"
   s.add_dependency %q<awesome_print>, "~> 1.0.2"
-  s.add_dependency %q<coderay>,       "~> 1.0.7"
+  s.add_dependency %q<coderay>,       "~> 1.0.8"
   s.add_dependency %q<g>,             ">= 1.7.1"
 
   # introspection / docs
   s.add_dependency %q<ori>,           "~> 0.1.0"
   s.add_dependency %q<methodfinder>,  ">= 1.2.5"
   s.add_dependency %q<method_locator>,">= 0.0.4"
-  s.add_dependency %q<method_source>, ">= 0.8.0"
+  s.add_dependency %q<method_source>, ">= 0.8.1"
 
   len = s.homepage.size
   s.post_install_message = \

data/lib/irbtools/libraries.rb

@@ -19,15 +19,13 @@ Irbtools.add_library :fileutils, :thread => :stdlib do # cd, pwd, ln_s, mv, rm,
   def cd( path = '~' )
     new_last_path = FileUtils.pwd
     if path == '-'
-      if $irbtools_last_cd_path
-        path = $irbtools_last_cd_path
-      else
+      unless path = Irbtools.instance_variable_get(:@last_cd_path)
         warn 'Sorry, there is no previous directory.'
         return
       end
     end
     super(File.expand_path(path))
-    $irbtools_last_cd_path = new_last_path
+    Irbtools.instance_variable_set(:@last_cd_path, new_last_path)
     ls
   end
 end
@@ -47,9 +45,6 @@ Irbtools.add_library 'g', :thread => 40 if RbConfig::CONFIG['host_os'] =~ /mac|d
 # lets you open vim (or your favourite editor), hack something, save it, and it's loaded in the current irb session
 Irbtools.add_library 'interactive_editor', :thread => :stdlib
 
-# another, more flexible "start editor and it gets loaded into your irb session" plugin
-Irbtools.add_library 'sketches', :thread => :stdlib
-
 # object oriented ri method
 Irbtools.add_library :ori, :thread => 50 do
   class Object
@@ -72,7 +67,11 @@ Irbtools.add_library :ori, :thread => 50 do
 end
 
 # Object#method_lookup_path (improved ancestors) & Object#methods_for (get this method from all ancestors)
-Irbtools.add_library :method_locator, :thread => 60
+Irbtools.add_library :method_locator, :thread => 60 do
+  module MethodLocator
+    alias mlp method_lookup_path
+  end
+end
 
 # view method source :)
 Irbtools.add_library :method_source, :thread => 70 do
@@ -104,8 +103,7 @@ end
 Irbtools.add_library :paint, :late => true
 
 # result colors, install ripl-color_result for ripl colorization
-Irbtools.add_library :wirb, :late => true do 
-  Wirb.load_schema :classic_paint
+Irbtools.add_library :wirb, :late => true do
   Wirb.start
 end
 
@@ -129,6 +127,10 @@ Irbtools.add_library :hirb, :late_thread => :hirb do
                     :pager_command => 'less -R'
   extend Hirb::Console
 
+  def page(what, options = {})
+    Hirb::Pager.command_pager(what, options = {})
+  end
+
   # page wirb output hacks
   if defined?(Wirb) && defined?(Paint)
     class Hirb::Pager
@@ -219,7 +221,7 @@ end
 
 # small-talk like method finder
 Irbtools.add_library :methodfinder, :autoload => :MethodFinder do
-  MethodFinder::INSTANCE_METHOD_BLACKLIST[:Object] += [:ri, :vi, :vim, :emacs, :nano, :mate, :mvim, :ed, :sketch]
+  MethodFinder::INSTANCE_METHOD_BLACKLIST[:Object] += [:ri, :vi, :vim, :emacs, :nano, :mate, :mvim, :ed]
   
   def mf(*args, &block)
     args.empty? ? MethodFinder : MethodFinder.find(*args, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irbtools
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-09 00:00:00.000000000 Z
+date: 2012-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zucker
@@ -75,22 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.0.10
-- !ruby/object:Gem::Dependency
-  name: sketches
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: every_day_irb
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +82,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +90,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +114,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -138,7 +122,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
   name: wirb
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +130,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -154,7 +138,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: hirb
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +178,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 1.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -202,7 +186,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 1.0.8
 - !ruby/object:Gem::Dependency
   name: g
   requirement: !ruby/object:Gem::Requirement
@@ -274,7 +258,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -282,7 +266,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.1
 description: irbtools is a "meta gem" that installs a bunch of useful irb gems and
   configures them for you. Simply put a require "irbtools" in the .irbrc file in your
   home directory.