looksee 0.0.2 → 0.1.0

data/History.txt

@@ -1,3 +1,7 @@
+== 0.1.0 2009-08-20
+
+* Add methods undefined with Module#undef_method.  Blue by default.
+
 == 0.0.2 2009-07-28
 
 * Added #grep to filter methods shown: lp(object).grep(/pattern/)

data/README.rdoc

@@ -65,7 +65,8 @@ This defines a method +lp+ ("lookup path") which lets you do:
       frozen?   nil?                        untaint
 
 It'll also color the methods according to whether they're public,
-protected, private, or overridden.  So pretty.  You gotta try it.
+protected, private, undefined (using Module#undef_method), or
+overridden.  So pretty.  You gotta try it.
 
 By default, it shows public and protected methods.  Add private ones
 like so:

data/ext/looksee/looksee.c

@@ -115,6 +115,23 @@ VALUE Looksee_internal_private_instance_methods(VALUE self, VALUE klass) {
   return internal_instance_methods(klass, NOEX_PRIVATE);
 }
 
+static int add_method_if_undefined(ID method_name, NODE *body, VALUE *names) {
+  /* Module#undef_method sets body->nd_body to NULL. */
+  if (body && !body->nd_body)
+    rb_ary_push(*names, ID2SYM(method_name));
+  return ST_CONTINUE;
+}
+
+/*
+ * Return the list of undefined instance methods (as Symbols) of the
+ * given internal class.
+ */
+VALUE Looksee_internal_undefined_instance_methods(VALUE self, VALUE klass) {
+  VALUE names = rb_ary_new();
+  st_foreach(RCLASS_M_TBL(klass), add_method_if_undefined, (st_data_t)&names);
+  return names;
+}
+
 void Init_looksee(void) {
   VALUE mLooksee = rb_define_module("Looksee");
   rb_define_singleton_method(mLooksee, "internal_superclass", Looksee_internal_superclass, 1);
@@ -123,4 +140,5 @@ void Init_looksee(void) {
   rb_define_singleton_method(mLooksee, "internal_public_instance_methods", Looksee_internal_public_instance_methods, 1);
   rb_define_singleton_method(mLooksee, "internal_protected_instance_methods", Looksee_internal_protected_instance_methods, 1);
   rb_define_singleton_method(mLooksee, "internal_private_instance_methods", Looksee_internal_private_instance_methods, 1);
+  rb_define_singleton_method(mLooksee, "internal_undefined_instance_methods", Looksee_internal_undefined_instance_methods, 1);
 }

data/lib/looksee.rb

@@ -32,8 +32,8 @@ require "looksee/version"
 #
 # +lp+ returns a LookupPath object, which has +inspect+ defined to
 # print things out pretty.  By default, it shows public, protected,
-# and overridden methods.  They're all colored, which makes showing
-# overridden methods not such a strange idea.
+# undefined, and overridden methods.  They're all colored, which makes
+# showing overridden methods not such a strange idea.
 #
 # Some examples of the other shortcuts:
 #
@@ -66,9 +66,11 @@ module Looksee
     # * +:public+ - include public methods
     # * +:protected+ - include protected methods
     # * +:private+ - include private methods
+    # * +:undefined+ - include undefined methods (see Module#undef_method)
     # * +:overridden+ - include methods overridden by subclasses
     #
-    # The default (if options is nil or omitted) is [:public].
+    # The default (if options is nil or omitted) is given by
+    # #default_lookup_path_options.
     #
     def lookup_path(object, *options)
       normalized_options = Looksee.default_lookup_path_options.dup
@@ -83,7 +85,8 @@ module Looksee
     #
     # The default options passed to lookup_path.
     #
-    # Default: <tt>{:public => true, :protected => true, :overridden => true}</tt>
+    # Default: <tt>{:public => true, :protected => true, :undefined =>
+    # true, :overridden => true}</tt>
     #
     attr_accessor :default_lookup_path_options
 
@@ -104,6 +107,7 @@ module Looksee
     # * :public
     # * :protected
     # * :private
+    # * :undefined
     # * :overridden
     #
     # The values are format strings.  They should all contain a single
@@ -116,6 +120,7 @@ module Looksee
     #         :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",
     #       }
     #
@@ -136,13 +141,14 @@ module Looksee
     end
   end
 
-  self.default_lookup_path_options = {:public => true, :protected => true, :overridden => true}
+  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",
   }
 
@@ -162,6 +168,7 @@ module Looksee
     #   :public
     #   :protected
     #   :private
+    #   :undefined
     #   :overridden
     #
     def self.for(object, options={})
@@ -226,6 +233,7 @@ module Looksee
         add_methods(Looksee.internal_public_instance_methods(@module).map{|sym| sym.to_s}   , :public   , seen) if options[:public   ]
         add_methods(Looksee.internal_protected_instance_methods(@module).map{|sym| sym.to_s}, :protected, seen) if options[:protected]
         add_methods(Looksee.internal_private_instance_methods(@module).map{|sym| sym.to_s}  , :private  , seen) if options[:private  ]
+        add_methods(Looksee.internal_undefined_instance_methods(@module).map{|sym| sym.to_s}, :undefined, seen) if options[:undefined]
         @methods.sort!
       end
 
@@ -256,7 +264,7 @@ module Looksee
 
       #
       # Yield each method along with its visibility (:public,
-      # :private, :protected, or :overridden).
+      # :private, :protected, :undefined, or :overridden).
       #
       def each
         @methods.each do |name|

data/lib/looksee/version.rb

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

data/looksee.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{looksee}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["George Ogata"]
-  s.date = %q{2009-07-05}
+  s.date = %q{2009-08-20}
   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"]
   s.extensions = ["ext/looksee/extconf.rb"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
-  s.files = [".autotest", "History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "ext/looksee/extconf.rb", "ext/looksee/looksee.c", "ext/looksee/node-1.9.h", "lib/looksee.rb", "lib/looksee/shortcuts.rb", "lib/looksee/version.rb", "script/console", "script/destroy", "script/generate", "spec/looksee_spec.rb", "spec/spec_helper.rb", "tasks/extconf.rake", "tasks/extconf/looksee.rake"]
+  s.files = [".autotest", "History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "ext/looksee/extconf.rb", "ext/looksee/looksee.c", "ext/looksee/node-1.9.h", "lib/looksee.rb", "lib/looksee/shortcuts.rb", "lib/looksee/version.rb", "lib/looksee/wirble_compatibility.rb", "looksee.gemspec", "script/console", "script/destroy", "script/generate", "spec/looksee_spec.rb", "spec/spec_helper.rb", "spec/wirble_compatibility_spec.rb", "tasks/extconf.rake", "tasks/extconf/looksee.rake"]
   s.homepage = %q{http://github.com/oggy/looksee}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib", "ext/looksee"]
@@ -25,18 +25,18 @@ possible in plain ruby.}
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<newgem>, [">= 1.5.1"])
+      s.add_development_dependency(%q<newgem>, [">= 1.5.2"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.7"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.5"])
       s.add_development_dependency(%q<hoe>, [">= 2.3.2"])
     else
-      s.add_dependency(%q<newgem>, [">= 1.5.1"])
+      s.add_dependency(%q<newgem>, [">= 1.5.2"])
       s.add_dependency(%q<rspec>, [">= 1.2.7"])
       s.add_dependency(%q<mocha>, [">= 0.9.5"])
       s.add_dependency(%q<hoe>, [">= 2.3.2"])
     end
   else
-    s.add_dependency(%q<newgem>, [">= 1.5.1"])
+    s.add_dependency(%q<newgem>, [">= 1.5.2"])
     s.add_dependency(%q<rspec>, [">= 1.2.7"])
     s.add_dependency(%q<mocha>, [">= 0.9.5"])
     s.add_dependency(%q<hoe>, [">= 2.3.2"])

data/spec/looksee_spec.rb

@@ -171,16 +171,61 @@ describe Looksee do
       it_should_list_methods_with_visibility :private
       it_should_not_list_methods_with_visibility :public, :protected
     end
+
+    describe ".internal_undefined_instance_methods" do
+      it "should return the list of undefined instance methods directly on a class" do
+        temporary_class :C
+        C.send(:define_method, :f){}
+        C.send(:undef_method, :f)
+        Looksee.internal_undefined_instance_methods(C).should == [:f]
+      end
+
+      it "should return the list of undefined instance methods directly on a module" do
+        temporary_module :M
+        M.send(:define_method, :f){}
+        M.send(:undef_method, :f)
+        Looksee.internal_undefined_instance_methods(M).should == [:f]
+      end
+
+      it "should return the list of undefined instance methods directly on a singleton class" do
+        temporary_class :C
+        c = C.new
+        c.singleton_class.send(:define_method, :f){}
+        c.singleton_class.send(:undef_method, :f)
+        Looksee.internal_undefined_instance_methods(c.singleton_class).should == [:f]
+      end
+
+      it "should return the list of undefined instance methods directly on a class' singleton class" do
+        temporary_class :C
+        C.singleton_class.send(:define_method, :f){}
+        C.singleton_class.send(:undef_method, :f)
+        Looksee.internal_undefined_instance_methods(C.singleton_class).should == [:f]
+      end
+
+      it "should not return defined methods" do
+        temporary_class :C
+        C.send(:define_method, :f){}
+        Looksee.internal_undefined_instance_methods(C).should == []
+      end
+
+      it "should not return removed methods" do
+        temporary_class :C
+        C.send(:define_method, :f){}
+        C.send(:remove_method, :f)
+        Looksee.internal_undefined_instance_methods(C).should == []
+      end
+    end
   end
 end
 
 describe Looksee::LookupPath do
   include TemporaryClasses
 
-  def stub_methods(mod, public, protected, private)
+  def stub_methods(mod, public, protected, private, undefined)
     Looksee.stubs(:internal_public_instance_methods   ).with(mod).returns(public)
     Looksee.stubs(:internal_protected_instance_methods).with(mod).returns(protected)
     Looksee.stubs(:internal_private_instance_methods  ).with(mod).returns(private)
+    Looksee.stubs(:internal_undefined_instance_methods).with(mod).returns(undefined)
   end
 
   describe "#entries" do
@@ -197,8 +242,8 @@ describe Looksee::LookupPath do
     it "should only include methods matching the given regexp" do
       temporary_class :C
       temporary_class :D
-      stub_methods(C, ['axbyc', 'xy'], [], [])
-      stub_methods(D, ['axbyc', 'xdy'], [], [])
+      stub_methods(C, ['axbyc', 'xy'], [], [], [])
+      stub_methods(D, ['axbyc', 'xdy'], [], [], [])
       object = Object.new
       Looksee.stubs(:lookup_modules).with(object).returns([C, D])
       lookup_path = Looksee::LookupPath.for(object, :public => true, :overridden => true).grep(/x.y/)
@@ -210,8 +255,8 @@ describe Looksee::LookupPath do
     it "should only include methods including the given string" do
       temporary_class :C
       temporary_class :D
-      stub_methods(C, ['axxa', 'axa'], [], [])
-      stub_methods(D, ['bxxb', 'axxa'], [], [])
+      stub_methods(C, ['axxa', 'axa'], [], [], [])
+      stub_methods(D, ['bxxb', 'axxa'], [], [], [])
       object = Object.new
       Looksee.stubs(:lookup_modules).with(object).returns([C, D])
       lookup_path = Looksee::LookupPath.for(object, :public => true, :overridden => true).grep('xx')
@@ -238,8 +283,8 @@ describe Looksee::LookupPath do
         end
         @object = Object.new
         Looksee.stubs(:lookup_modules).with(@object).returns([C, M])
-        stub_methods(C, ['public1', 'public2'], ['protected1', 'protected2'], ['private1', 'private2'])
-        stub_methods(M, ['public1', 'public2'], ['protected1', 'protected2'], ['private1', 'private2'])
+        stub_methods(C, ['public1', 'public2'], ['protected1', 'protected2'], ['private1', 'private2'], ['undefined1', 'undefined2'])
+        stub_methods(M, ['public1', 'public2'], ['protected1', 'protected2'], ['private1', 'private2'], ['undefined1', 'undefined2'])
       end
 
       it "should show only public instance methods when only public methods are requested" do
@@ -272,6 +317,16 @@ describe Looksee::LookupPath do
         EOS
       end
 
+      it "should show modules and undefined instance methods when only undefined methods are requested" do
+        lookup_path = Looksee::LookupPath.for(@object, :undefined => true, :overridden => true)
+        lookup_path.inspect.should == <<-EOS.demargin.chomp
+          |C
+          |  undefined1  undefined2
+          |M
+          |  undefined1  undefined2
+        EOS
+      end
+
       it "should show modules with public and private instance methods when only public and private methods are requested" do
         lookup_path = Looksee::LookupPath.for(@object, :public => true, :private => true, :overridden => true)
         lookup_path.inspect.should == <<-EOS.demargin.chomp
@@ -284,7 +339,7 @@ describe Looksee::LookupPath do
 
       it "should show singleton classes as class names in brackets" do
         Looksee.stubs(:lookup_modules).with(C).returns([C.singleton_class])
-        stub_methods(C.singleton_class, ['public1', 'public2'], [], [])
+        stub_methods(C.singleton_class, ['public1', 'public2'], [], [], [])
         lookup_path = Looksee::LookupPath.for(C, :public => true)
         lookup_path.inspect.should == <<-EOS.demargin.chomp
           |[C]
@@ -294,7 +349,7 @@ describe Looksee::LookupPath do
 
       it "should handle singleton classes of singleton classes correctly" do
         Looksee.stubs(:lookup_modules).with(C.singleton_class).returns([C.singleton_class.singleton_class])
-        stub_methods(C.singleton_class.singleton_class, ['public1', 'public2'], [], [])
+        stub_methods(C.singleton_class.singleton_class, ['public1', 'public2'], [], [], [])
         lookup_path = Looksee::LookupPath.for(C.singleton_class, :public => true)
         lookup_path.inspect.should == <<-EOS.demargin.chomp
           |[[C]]
@@ -303,7 +358,7 @@ describe Looksee::LookupPath do
       end
 
       it "should not show any blank lines if a module has no methods" do
-        stub_methods(C, [], [], [])
+        stub_methods(C, [], [], [], [])
         lookup_path = Looksee::LookupPath.for(@object, :public => true, :overridden => true)
         lookup_path.inspect.should == <<-EOS.demargin.chomp
           |C
@@ -320,6 +375,7 @@ describe Looksee::LookupPath do
           :public     => "{%s}",
           :protected  => "[%s]",
           :private    => "<%s>",
+          :undefined  => "~%s~",
           :overridden => "(%s)",
         }
         Looksee.stubs(:styles).returns(styles)
@@ -328,11 +384,11 @@ describe Looksee::LookupPath do
       it "should delimit each word with the configured delimiters" do
         temporary_class :C
         Looksee.stubs(:lookup_modules).returns([C])
-        stub_methods(C, ['public'], ['protected'], ['private'])
-        lookup_path = Looksee::LookupPath.for(Object.new, :public => true, :protected => true, :private => true, :overridden => true)
+        stub_methods(C, ['public'], ['protected'], ['private'], ['undefined'])
+        lookup_path = Looksee::LookupPath.for(Object.new, :public => true, :protected => true, :private => true, :undefined => true, :overridden => true)
         lookup_path.inspect.should == <<-EOS.demargin.chomp
           |\`C\'
-          |  <private>  [protected]  {public}
+          |  <private>  [protected]  {public}  ~undefined~
         EOS
       end
     end
@@ -341,7 +397,7 @@ describe Looksee::LookupPath do
       it "should wrap method lists at the configured number of columns, sorting vertically first, and aligning into a grid" do
         temporary_class :C
         Looksee.stubs(:lookup_modules).returns([C])
-        stub_methods(C, %w'aa b c dd ee f g hh i', [], [])
+        stub_methods(C, %w'aa b c dd ee f g hh i', [], [], [])
         lookup_path = Looksee::LookupPath.for(Object.new, :public => true)
         lookup_path.inspect(:width => 20).should == <<-EOS.demargin.chomp
           |C
@@ -354,8 +410,8 @@ describe Looksee::LookupPath do
         temporary_class :A
         temporary_class :B
         Looksee.stubs(:lookup_modules).returns([A, B])
-        stub_methods(A, ['a', 'long_long_long_long_name'], [], [])
-        stub_methods(B, ['long_long_long', 'short'], [], [])
+        stub_methods(A, ['a', 'long_long_long_long_name'], [], [], [])
+        stub_methods(B, ['long_long_long', 'short'], [], [], [])
         lookup_path = Looksee::LookupPath.for(Object.new, :public => true)
         lookup_path.inspect.should == <<-EOS.demargin.chomp
           |A

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: looksee
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - George Ogata
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-01 00:00:00 +12:00
+date: 2009-08-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.1
+        version: 1.5.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec