looksee 0.1.0 → 0.2.1

data/History.txt

@@ -1,3 +1,11 @@
+== 0.2.1 2009-08-30
+
+* Updated history.
+
+== 0.2.0 2009-08-30
+
+* Add Looksee.help for printing a quick reference.  [Brian Morearty]
+
 == 0.1.0 2009-08-20
 
 * Add methods undefined with Module#undef_method.  Blue by default.
@@ -7,7 +15,7 @@
 * Added #grep to filter methods shown: lp(object).grep(/pattern/)
 * Fix #1: Play nice with Wirble.
 * Fix #3: Don't die when examining immediate objects (fixnum, symbol,
-  true, false, nil)
+  true, false, nil) [Leonard Chin]
 
 == 0.0.1 2009-07-05
 

data/README.rdoc

@@ -66,7 +66,13 @@ This defines a method +lp+ ("lookup path") which lets you do:
 
 It'll also color the methods according to whether they're public,
 protected, private, undefined (using Module#undef_method), or
-overridden.  So pretty.  You gotta try it.
+overridden.  So pretty.  The default colors are:
+
+    public:     green
+    protected:  yellow
+    private:    red
+    undefined:  blue
+    overridden: black
 
 By default, it shows public and protected methods.  Add private ones
 like so:
@@ -83,6 +89,10 @@ use it as a library without polluting the built-in classes.  See:
 
     $ ri Looksee
 
+Or do this in IRB for a quick reference:
+
+    Looksee.help
+
 Enjoy!
 
 == INSTALL

data/lib/looksee.rb

@@ -46,6 +46,10 @@ require "looksee/version"
 #     require 'looksee'
 #     Looksee.lookup_path(thing)  # like "lp thing"
 #
+# For a quick reference:
+#
+#     Looksee.help
+#
 # == Configuration
 #
 # Set these:
@@ -116,12 +120,12 @@ module Looksee
     # Default:
     #
     #       {
-    #         :module     => "\e[1;37m%s\e[0m",
-    #         :public     => "\e[1;32m%s\e[0m",
-    #         :protected  => "\e[1;33m%s\e[0m",
-    #         :private    => "\e[1;31m%s\e[0m",
-    #         :undefined  => "\e[1;34m%s\e[0m",
-    #         :overridden => "\e[1;30m%s\e[0m",
+    #         :module     => "\e[1;37m%s\e[0m", # white
+    #         :public     => "\e[1;32m%s\e[0m", # green
+    #         :protected  => "\e[1;33m%s\e[0m", # yellow
+    #         :private    => "\e[1;31m%s\e[0m", # red
+    #         :undefined  => "\e[1;34m%s\e[0m", # blue
+    #         :overridden => "\e[1;30m%s\e[0m", # black
     #       }
     #
     attr_accessor :styles
@@ -144,12 +148,12 @@ module Looksee
   self.default_lookup_path_options = {:public => true, :protected => true, :undefined => true, :overridden => true}
   self.default_width = 80
   self.styles = {
-    :module     => "\e[1;37m%s\e[0m",
-    :public     => "\e[1;32m%s\e[0m",
-    :protected  => "\e[1;33m%s\e[0m",
-    :private    => "\e[1;31m%s\e[0m",
-    :undefined  => "\e[1;34m%s\e[0m",
-    :overridden => "\e[1;30m%s\e[0m",
+    :module     => "\e[1;37m%s\e[0m", # white
+    :public     => "\e[1;32m%s\e[0m", # green
+    :protected  => "\e[1;33m%s\e[0m", # yellow
+    :private    => "\e[1;31m%s\e[0m", # red
+    :undefined  => "\e[1;34m%s\e[0m", # blue
+    :overridden => "\e[1;30m%s\e[0m", # black
   }
 
   class LookupPath

data/lib/looksee/shortcuts.rb

@@ -52,3 +52,56 @@ class Object
     self
   end
 end
+
+module Looksee
+  #
+  # Show a quick reference.
+  #
+  def self.help
+    Help.new
+  end
+
+  class Help
+    def inspect
+      <<-EOS.gsub(/^ *\|/, '')
+        |== Looksee Quick Reference
+        |
+        |  lp(object)
+        |  object.lookup_path
+        |    Print the method lookup path of \`object\'
+        |
+        |  lpi(klass)
+        |    Print the method lookup path of an instance of \`klass\'.
+        |
+        |Add .grep(/pattern/) to restrict the methods listed:
+        |
+        |  lp(object).grep(/foo/)
+        |
+        |== Visibilities
+        |
+        |Methods are printed according to their visibility:
+        |
+        |#{style_info}
+        |
+        |Pass options to specify which visibilities to show:
+        |
+        |  lp(object, :private => true, :overridden => false)
+        |  lp(object, :private        , :overridden => false)  # shortcut
+      EOS
+    end
+
+    def style_info
+      max_width = 0
+      styles = [:public, :protected, :private, :undefined, :overridden]
+      data = styles.map do |name|
+        display_style = Looksee.styles[name] % name
+        display_length = display_style.length
+        max_width = display_length if display_length > max_width
+        on = Looksee.default_lookup_path_options[name] ? 'on' : 'off'
+        [display_style, on]
+      end.map do |display_style, on|
+        "  * #{display_style.ljust(max_width)}  (#{on} by default)"
+      end.join("\n")
+    end
+  end
+end

data/lib/looksee/version.rb

@@ -1,3 +1,3 @@
 module Looksee
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/lib/looksee/wirble_compatibility.rb

@@ -38,7 +38,8 @@ module Looksee
       def hook_into_irb_output_value
         IRB::Irb.class_eval do
           def output_value_with_looksee
-            if @context.last_value.is_a?(Looksee::LookupPath)
+            case @context.last_value
+            when Looksee::LookupPath, Looksee::Help
               non_color_output_value
             else
               output_value_without_looksee

data/looksee.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{looksee}
-  s.version = "0.1.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["George Ogata"]
-  s.date = %q{2009-08-20}
+  s.date = %q{2009-08-30}
   s.description = %q{Looksee lets you examine the method lookup path of objects in ways not
 possible in plain ruby.}
   s.email = ["george.ogata@gmail.com"]
@@ -17,7 +17,7 @@ possible in plain ruby.}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib", "ext/looksee"]
   s.rubyforge_project = %q{looksee}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Looksee lets you examine the method lookup path of objects in ways not possible in plain ruby.}
 
   if s.respond_to? :specification_version then

data/script/console

@@ -1,10 +1,7 @@
 #!/usr/bin/env ruby
 # File: script/console
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs =  " -r irb/completion"
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/looksee.rb'}"
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'irb'
 puts "Loading looksee gem"
-exec "#{irb} #{libs} --simple-prompt"
+require 'looksee/shortcuts'
+IRB.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: looksee
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - George Ogata
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-20 00:00:00 -04:00
+date: 2009-08-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: looksee
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Looksee lets you examine the method lookup path of objects in ways not possible in plain ruby.