irbtools 0.8.0 → 0.8.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.8.1
+* rewrote irb_rocket: fancy_irb. No more workarounds needed, anymore.
+* added sketches gem
+* customizable welcome message
+* more little fixes/enhancements
+
 0.8.0
 * added Object#ri method
 * feature: extension package loading (e.g. irbtools-more)

data/README.rdoc

@@ -5,17 +5,15 @@ This is a meta gem which installs some useful irb gems and configures your irb.
 == Setup
 
   gem install irbtools
-  gem install irb_rocket --source http://merbi.st
   
 * On Linux, you also need the +xclip+ program: sudo <tt>apt-get install xclip</tt>
-* The <tt>irb_rocket</tt> gem might require <tt>libncurses-dev</tt>
 * On MacOS, you need growl, if you want to use the +g+ gem.
 
 == Usage
 
-To use it, put the following in your <tt>~/.irbrc</tt> file (this file is loaded everytime you start an irb):
+To use it, put the following in your <tt>~/.irbrc</tt> file (this file is loaded every time you start an irb):
 
-  require 'rubygems' # only needed in 1.8
+  require 'rubygems' if RUBY_VERSION[2] == ?8 # rubygems is only needed in 1.8
   require 'irbtools'
 
 If it does not exist, just create a new one.
@@ -41,8 +39,9 @@ See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented s
 
 === Included gems and libraries
 
-* wirble[http://pablotron.org/software/wirble/]      colors
-* hirb[http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html]     active record tables
+* wirble[http://pablotron.org/software/wirble/]      colorize output
+* fancy_irbt[tODO]   put result as comment and more colorization
+* hirb[http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html]     (active record) tables and custom views for specific objects
 * *fileutils*    cd, pwd, ln_s, mv, rm, mkdir, touch ... ;)
 * zucker/env[http://rubyzucker.info]   Info, OS, RubyVersion, RubyEngine
 * zucker/debug[http:/rubyzucker.info]   nice debug printing (q, o, c, .m, .d)
@@ -51,34 +50,34 @@ See http://rbjl.net/40-irbtools-release-the-power-of-irb or read the commented s
 * clipboard[http://github.com/janlelis/clipboard]     easy clipboard access (copy & paste)
 * guessmethod[http://guessmethod.rubyforge.org/]    automatically corrects typos (method_missing hook)
 * interactive_editor[http://github.com/jberkel/interactive_editor]    lets you open vim, hack something, and it gets loaded into the current session
+* sketches[http://sketches.rubyforge.org/] another, more flexible "start editor and it gets loaded into your irb session" plugin
 * coderay[http://coderay.rubychan.de/]    some nice colorful display ;)
 * 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.
+See the source/rdoc for a description. These methods are defined directly by irbtools. Each gem may add its own helper methods.
 
-*General*: <tt>ls, cat, rq, rrq/rerequire, ls, session_history, reset!, clear, use_ruby/use, dbg, Object#ri</tt>
+*General*: <tt>ls, cat, rq, rrq/rerequire, ld, 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>
 
+== Welcome message
+
+You can customize the welcome message with <tt>Irbtools.welcome_message=</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 (?)
-* ...
+* Nicer ri command
 
 == More Features
 
-* See the irbtools-more[http://github.com/janlelis/irbtools-more] package.
+* See the irbtools-more[https://github.com/janlelis/irbtools-more] package.
 
 == Copyright
 
-Copyright (c) 2010 Jan Lelis, http://rbjl.net. See LICENSE for details.
+Copyright (c) 2010 Jan Lelis, http://rbjl.net, released under the MIT license.
 
 J-_-L

data/Rakefile

@@ -10,18 +10,18 @@ begin
     gem.email = "mail@janlelis.de"
     gem.homepage = "http://github.com/janlelis/irbtools"
     gem.authors = ["Jan Lelis"]
-    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 'fancy_irb'
     gem.add_dependency 'hirb'
     gem.add_dependency 'zucker', '>=8'
     gem.add_dependency 'awesome_print'
     gem.add_dependency 'g'
-    gem.add_dependency 'clipboard'
+    gem.add_dependency 'clipboard', '>=0.9'
     gem.add_dependency 'guessmethod'
     gem.add_dependency 'interactive_editor'
     gem.add_dependency 'coderay'
     gem.add_dependency 'boson'
-    # gem.add_dependency 'irb_rocket'
+    gem.add_dependency 'sketches'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/irbtools.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{irbtools}
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jan Lelis"]
-  s.date = %q{2010-10-12}
+  s.date = %q{2010-11-10}
   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 = [
@@ -29,14 +29,10 @@ Gem::Specification.new do |s|
      "lib/irbtools/configure.rb",
      "lib/irbtools/general.rb",
      "lib/irbtools/libraries.rb",
-     "lib/irbtools/workarounds.rb",
-     "screenshots/examples1.png",
-     "screenshots/examples2.png"
   ]
   s.homepage = %q{http://github.com/janlelis/irbtools}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  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.}
 
@@ -46,38 +42,44 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<wirble>, [">= 0"])
+      s.add_runtime_dependency(%q<fancy_irb>, [">= 0"])
       s.add_runtime_dependency(%q<hirb>, [">= 0"])
       s.add_runtime_dependency(%q<zucker>, [">= 8"])
       s.add_runtime_dependency(%q<awesome_print>, [">= 0"])
       s.add_runtime_dependency(%q<g>, [">= 0"])
-      s.add_runtime_dependency(%q<clipboard>, [">= 0"])
+      s.add_runtime_dependency(%q<clipboard>, [">= 0.9"])
       s.add_runtime_dependency(%q<guessmethod>, [">= 0"])
       s.add_runtime_dependency(%q<interactive_editor>, [">= 0"])
       s.add_runtime_dependency(%q<coderay>, [">= 0"])
       s.add_runtime_dependency(%q<boson>, [">= 0"])
+      s.add_runtime_dependency(%q<sketches>, [">= 0"])
     else
       s.add_dependency(%q<wirble>, [">= 0"])
+      s.add_dependency(%q<fancy_irb>, [">= 0"])
       s.add_dependency(%q<hirb>, [">= 0"])
       s.add_dependency(%q<zucker>, [">= 8"])
       s.add_dependency(%q<awesome_print>, [">= 0"])
       s.add_dependency(%q<g>, [">= 0"])
-      s.add_dependency(%q<clipboard>, [">= 0"])
+      s.add_dependency(%q<clipboard>, [">= 0.9"])
       s.add_dependency(%q<guessmethod>, [">= 0"])
       s.add_dependency(%q<interactive_editor>, [">= 0"])
       s.add_dependency(%q<coderay>, [">= 0"])
       s.add_dependency(%q<boson>, [">= 0"])
+      s.add_dependency(%q<sketches>, [">= 0"])
     end
   else
     s.add_dependency(%q<wirble>, [">= 0"])
+    s.add_dependency(%q<fancy_irb>, [">= 0"])
     s.add_dependency(%q<hirb>, [">= 0"])
     s.add_dependency(%q<zucker>, [">= 8"])
     s.add_dependency(%q<awesome_print>, [">= 0"])
     s.add_dependency(%q<g>, [">= 0"])
-    s.add_dependency(%q<clipboard>, [">= 0"])
+    s.add_dependency(%q<clipboard>, [">= 0.9"])
     s.add_dependency(%q<guessmethod>, [">= 0"])
     s.add_dependency(%q<interactive_editor>, [">= 0"])
     s.add_dependency(%q<coderay>, [">= 0"])
     s.add_dependency(%q<boson>, [">= 0"])
+    s.add_dependency(%q<sketches>, [">= 0"])
   end
 end
 

data/lib/irbtools.rb

@@ -53,7 +53,6 @@ IRB.conf[:IRB_RC] = proc{
 }
 
 
-
 # # # # #
 # general shortcuts & helper methods
 require File.expand_path('irbtools/general', File.dirname(__FILE__) )
@@ -68,7 +67,7 @@ IRB.conf[:SAVE_HISTORY] = 2000                 # how many lines will go to ~/.ir
 (IRB.conf[:PROMPT] ||= {} ).merge!( {:IRBTOOLS => {
   :PROMPT_I => ">> ",    # normal
   :PROMPT_N => "|  ",    # indenting
-  :PROMPT_C => "(>>) ",  # continuing a statement
+  :PROMPT_C => ".> ",  # continuing a statement
   :PROMPT_S => "%l> ",   # continuing a string
   :RETURN   => "=> %s \n",
   :AUTO_INDENT => true,
@@ -82,7 +81,7 @@ IRB.conf[:PROMPT_MODE] = :IRBTOOLS
 # add current directory to the loadpath
 $: << '.'  if RubyVersion.is.at_least? '1.9.2'
 
-# shoter ruby info constants
+# shorter ruby info constants
 Object.const_set 'RV', RubyVersion  rescue nil
 Object.const_set 'RE', RubyEngine   rescue nil
 
@@ -94,12 +93,10 @@ begin
 rescue
 end
 
-# # # # #
-# workarounds
-require File.expand_path('irbtools/workarounds', File.dirname(__FILE__) )
-
 # # # # #
 # done :)
-puts "Welcome to IRB. You are using #{ RUBY_DESCRIPTION }. Have fun ;)"
+if msg = Irbtools.welcome_message
+  puts msg
+end
 
 # J-_-L

data/lib/irbtools/configure.rb

@@ -20,8 +20,12 @@ module Irbtools
   @libs_in_proc = []
   @packages = []
   @railsrc = '~/.railsrc'
+  @welcome_message = "Welcome to IRB. You are using #{ RUBY_DESCRIPTION }. Have fun ;)"
 
   class << self
+    # message to display when starting. Set to nil to disable
+    attr_accessor :welcome_message
+
     # lets you define the path to the irbrc or deactivate this feature with nil
     attr_accessor :railsrc
 

data/lib/irbtools/libraries.rb

@@ -11,10 +11,8 @@ Irbtools.add_library :wirble do # colors
   Wirble.colorize unless OS.windows?
 end
 
-Irbtools.add_library :irb_rocket # put result as comment instead of a new line!
-
-Irbtools.add_library :hirb do # active record tables
-  Hirb::View.enable
+Irbtools.add_library :fancy_irb do # put result as comment instead of a new line!
+  FancyIrb.start
 end
 
 Irbtools.add_library :fileutils do # cd, pwd, ln_s, mv, rm, mkdir, touch ... ;)
@@ -36,7 +34,7 @@ Irbtools.add_library :coderay do
 
   # syntax highlight a file
   def ray(path)
-    puts CodeRay.scan( File.read(path), :ruby ).term
+    print CodeRay.scan( File.read(path), :ruby ).term
   end
 end
 
@@ -72,6 +70,7 @@ Irbtools.add_library 'yaml'         # nice debug printing (y)
 Irbtools.add_library 'g'            # nice debug printing (g) - MacOS only :/
 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 'sketches'            # another, more flexible "start editor and it gets loaded into your irb session" plugin
 #Irbtools.add_library 'zucker/all'         # see rubyzucker.info
 
 Irbtools.add_library :boson do
@@ -79,9 +78,15 @@ Irbtools.add_library :boson do
   Boson.start :verbose => false
 end
 
+Irbtools.add_library :hirb do # active record tables
+  Hirb::View.enable
+  extend Hirb::Console
+end
+
+
 # remove failing/not needed libs
 if OS.windows?
-  Irbtools.libraries -= %w[irb_rocket coderay]
+  Irbtools.libraries -= %w[coderay]
 end
 
 unless OS.mac?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: irbtools
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: false
   segments: 
   - 0
   - 8
-  - 0
-  version: 0.8.0
+  - 1
+  version: 0.8.1
 platform: ruby
 authors: 
 - Jan Lelis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-12 00:00:00 +02:00
+date: 2010-11-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: hirb
+  name: fancy_irb
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -47,35 +47,35 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: zucker
+  name: hirb
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 3
         segments: 
-        - 8
-        version: "8"
+        - 0
+        version: "0"
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: awesome_print
+  name: zucker
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 19
         segments: 
-        - 0
-        version: "0"
+        - 8
+        version: "8"
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: g
+  name: awesome_print
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -89,7 +89,7 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: clipboard
+  name: g
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -103,21 +103,22 @@ dependencies:
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: guessmethod
+  name: clipboard
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 25
         segments: 
         - 0
-        version: "0"
+        - 9
+        version: "0.9"
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: interactive_editor
+  name: guessmethod
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -131,7 +132,7 @@ dependencies:
   type: :runtime
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: coderay
+  name: interactive_editor
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
@@ -145,7 +146,7 @@ dependencies:
   type: :runtime
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: boson
+  name: coderay
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
@@ -158,6 +159,34 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: boson
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: sketches
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id012
 description: 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.
 email: mail@janlelis.de
 executables: []
@@ -180,9 +209,6 @@ files:
 - 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
 homepage: http://github.com/janlelis/irbtools
 licenses: []
@@ -210,8 +236,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments: 
       - 0
       version: "0"
-requirements: 
-- "It's recommended to use the irb_rocket gem: gem install irb_rocket --source http://merbi.st"
+requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: 

data/lib/irbtools/workarounds.rb

@@ -1,97 +0,0 @@
-# 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
-
-  # hacks for hirb - irb_rocket interaction
-  module IRB
-    class Irb
-      alias output_value_unrocket output_value
-      def output_value
-        return ' ' if @io.nil?
-        hirb_output = Hirb::Util.capture_stdout do output_value_unrocket end
-        if Hirb::View.did_output?
-          print hirb_output
-        else
-          last = @context.io.prompt + @last_line.split("\n").last
-          @io.print(rc + cuu1 + (cuf1*last.length) + " " +
-            Wirble::Colorize::Color.escape(:blue) + "#=>" + sgr0 +
-            " " + Wirble::Colorize.colorize(@context.last_value.inspect) + cud1)
-        end
-      end
-    end
-  end
-  
-  class << Hirb::View
-    def did_output?; @did_output; end
-
-    def render_output(output, options={})
-      @did_output = false
-      if (formatted_output = formatter.format_output(output, options))
-        render_method.call(formatted_output)
-        @did_output = true 
-        true 
-      else 
-        false
-      end  
-    end
-  end
-
-end
-
-# J-_-L
-