looksee 4.4.0 → 5.1.0

data/ext/mri/mri.c

@@ -1,56 +1,28 @@
 #include "ruby.h"
 
-#if RUBY_VERSION >= 230
-#  define VM_ASSERT(expr) ((void)0)
-#endif
-
-#include "method.h"
-#include "internal.h"
-
-#ifndef Looksee_method_table_foreach
-#  define Looksee_method_table_foreach st_foreach
-#  define Looksee_method_table_lookup st_lookup
-#endif
-
-#if RUBY_VERSION < 230
-static int add_method_if_undefined(ID method_name, rb_method_entry_t *me, VALUE *names) {
-#  ifdef ID_ALLOCATOR
-  /* The allocator can be undefined with rb_undef_alloc_func, e.g. Struct. */
-  if (method_name == ID_ALLOCATOR)
-    return ST_CONTINUE;
-#  endif
-
-  if (UNDEFINED_METHOD_ENTRY_P(me))
-    rb_ary_push(*names, ID2SYM(method_name));
-  return ST_CONTINUE;
-}
-#endif
-
+#if RUBY_VERSION < 320
 /*
  * Return the list of undefined instance methods (as Symbols) of the
  * given internal class.
  */
 VALUE Looksee_internal_undefined_instance_methods(VALUE self, VALUE klass) {
-#if RUBY_VERSION >= 230
   static int warned = 0;
   if (!warned) {
-    rb_warn("Looksee cannot display undef-ed methods on MRI 2.3 or later");
+    rb_warn("Looksee cannot display undef-ed methods on MRI < 3.2");
     warned = 1;
   }
   return rb_ary_new();
-#else
-  VALUE names = rb_ary_new();
-  if (RCLASS_ORIGIN(klass) != klass)
-    klass = RCLASS_ORIGIN(klass);
-  Looksee_method_table_foreach(RCLASS_M_TBL(klass), add_method_if_undefined, (st_data_t)&names);
-  return names;
-#endif
 }
+#endif
 
 VALUE Looksee_singleton_instance(VALUE self, VALUE klass) {
   if (!SPECIAL_CONST_P(klass) && BUILTIN_TYPE(klass) == T_CLASS && FL_TEST(klass, FL_SINGLETON)) {
-    VALUE object;
-    if (!Looksee_method_table_lookup(RCLASS_IV_TBL(klass), rb_intern("__attached__"), (st_data_t *)&object))
+#if RUBY_VERSION < 330
+    VALUE object = rb_ivar_get(klass, rb_intern("__attached__"));
+#else
+    VALUE object = rb_class_attached_object(klass);
+#endif
+    if (object == Qnil)
       rb_raise(rb_eRuntimeError, "[looksee bug] can't find singleton object");
     return object;
   } else {
@@ -63,6 +35,8 @@ void Init_mri(void) {
   VALUE mAdapter = rb_const_get(mLooksee, rb_intern("Adapter"));
   VALUE mBase = rb_const_get(mAdapter, rb_intern("Base"));
   VALUE mMRI = rb_define_class_under(mAdapter, "MRI", mBase);
+#if RUBY_VERSION < 320
   rb_define_method(mMRI, "internal_undefined_instance_methods", Looksee_internal_undefined_instance_methods, 1);
+#endif
   rb_define_method(mMRI, "singleton_instance", Looksee_singleton_instance, 1);
 }

data/lib/looksee/adapter/base.rb

@@ -9,11 +9,11 @@ module Looksee
         start =
           begin
             singleton_class = (class << object; self; end)
-            singleton_class unless has_no_methods?(singleton_class) && !(Class === object)
+            singleton_class unless has_no_methods?(singleton_class) && includes_no_modules?(singleton_class) && !(Class === object)
           rescue TypeError  # immediate object
           end
         start ||= Looksee.safe_call(Object, :class, object)
-        start.ancestors
+        Looksee.safe_call(Module, :ancestors, start)
       end
 
       #
@@ -48,6 +48,14 @@ module Looksee
         end
       end
 
+      def undefined_instance_methods(mod)
+        if Module.method_defined?(:undefined_instance_methods)
+          mod.undefined_instance_methods
+        else
+          internal_undefined_instance_methods(mod)
+        end
+      end
+
       def internal_undefined_instance_methods(mod)
         raise NotImplementedError, "abstract"
       end
@@ -55,7 +63,13 @@ module Looksee
       def has_no_methods?(mod)
         [:public, :protected, :private].all? do |visibility|
           Looksee.safe_call(Module, "#{visibility}_instance_methods", mod, false).empty?
-        end && internal_undefined_instance_methods(mod).empty?
+        end && undefined_instance_methods(mod).empty?
+      end
+
+      def includes_no_modules?(klass)
+        ancestors = Looksee.safe_call(Module, :ancestors, klass)
+        ancestors.size == 1 ||
+          klass.included_modules == klass.ancestors[1].included_modules
       end
 
       def singleton_instance(singleton_class)

data/lib/looksee/adapter.rb

@@ -3,6 +3,5 @@ module Looksee
     autoload :Base, 'looksee/adapter/base'
     autoload :MRI, "looksee/mri.#{Looksee::Config::CONFIG['DLEXT']}"
     autoload :JRuby, 'looksee/JRuby.jar'
-    autoload :Rubinius, "looksee/adapter/rubinius"
   end
 end

data/lib/looksee/clean.rb

@@ -15,10 +15,11 @@ module Looksee
   autoload :Help, 'looksee/help'
   autoload :Inspector, 'looksee/inspector'
   autoload :LookupPath, 'looksee/lookup_path'
+  autoload :PrettyPrintHack, 'looksee/pretty_print_hack'
 
   class << self
     #
-    # The default options passed to #ls.
+    # The default options passed to #look.
     #
     # Default: <tt>[:public, :protected, :private, :undefined,
     # :overridden]</tt>
@@ -165,8 +166,6 @@ module Looksee
   case ruby_engine
   when 'jruby'
     self.adapter = Adapter::JRuby.new
-  when 'rbx'
-    self.adapter = Adapter::Rubinius.new
   else
     self.adapter = Adapter::MRI.new
   end

data/lib/looksee/core_ext.rb

@@ -3,28 +3,40 @@ module Looksee
     #
     # Shortcut for Looksee[self, *args].
     #
-    def ls(*args)
+    def look(*args)
       Looksee[self, *args]
     end
 
     def self.rename(name)  # :nodoc:
-      name = name[:ls] if name.is_a?(Hash)
-      alias_method name, :ls
-      remove_method :ls
+      if name.is_a?(Hash)
+        warning = "You have renamed Looksee's method with Looksee.rename(#{name.inspect}).\n\n" +
+                  "Looksee now uses #look instead of #ls."
+        if name[:ls].to_s == 'look'
+          warn warning << " You can remove this customization."
+        elsif name[:ls]
+          warn warning << " Please rename with Looksee.rename(#{name[:ls].inspect}), or remove this customization."
+        end
+      elsif name.to_s == 'look'
+        warn warning << " You can remove this customization."
+      end
+
+      name = name[:look] || name[:ls] if name.is_a?(Hash)
+      alias_method name, :look
+      remove_method :look
     end
   end
 
   #
-  # Rename the #ls method, added to every object. Example:
+  # Rename the #look method, added to every object. Example:
   #
-  #     rename :_ls
+  #     rename :_look
   #
-  # This renames Looksee's #ls method to #_ls.
+  # This renames Looksee's #look method to #_look.
   #
   # For backward compatibility, the old-style invocation is also
-  # supported. Please note this is deprecated.
+  # supported. This is deprecated, and will shortly be removed.
   #
-  #     rename :ls => :_ls
+  #     rename :look => :_look
   #
   def self.rename(name)
     ObjectMixin.rename(name)

data/lib/looksee/help.rb

@@ -1,10 +1,12 @@
 module Looksee
   class Help
+    include PrettyPrintHack
+
     def inspect
       <<-EOS.gsub(/^ *\|/, '')
         |== Looksee Quick Reference
         |
-        |  \e[1mobject.ls(*specifiers)\e[0m  or  \e[1mLooksee[object, *specifiers]\e[0m
+        |  \e[1mobject.look(*specifiers)\e[0m  or  \e[1mLooksee[object, *specifiers]\e[0m
         |
         |    Print the methods of \`object\'.
         |
@@ -41,7 +43,7 @@ module Looksee
         |          ...
         |        }
         |
-        |  \e[1mobject.ls.edit(method)\e[0m
+        |  \e[1mobject.look.edit(method)\e[0m
         |
         |    Jump to the source of the given method. Set your editor
         |    with Looksee.editor or the LOOKSEE_EDITOR environment

data/lib/looksee/inspector.rb

@@ -1,5 +1,7 @@
 module Looksee
   class Inspector
+    include PrettyPrintHack
+
     def initialize(lookup_path, options={})
       @lookup_path = lookup_path
       @visibilities = (vs = options[:visibilities]) ? vs.to_set : Set[]

data/lib/looksee/lookup_path.rb

@@ -89,7 +89,7 @@ module Looksee
             methods[method.to_s] = visibility
           end
         end
-        Looksee.adapter.send("internal_undefined_instance_methods", @module).each do |method|
+        Looksee.adapter.undefined_instance_methods(@module).each do |method|
           methods[method.to_s] = :undefined
         end
         methods

data/lib/looksee/pretty_print_hack.rb

@@ -0,0 +1,14 @@
+module Looksee
+  module PrettyPrintHack
+    def pretty_print(pp)
+      # In the default IRB inspect mode (pp), IRB assumes that an inspect string
+      # that doesn't look like a bunch of known patterns is a code blob, and
+      # formats accordingly. That messes up our color escapes.
+      if Object.const_defined?(:IRB) && IRB.const_defined?(:ColorPrinter) && pp.is_a?(IRB::ColorPrinter)
+        PP.instance_method(:text).bind(pp).call(inspect)
+      else
+        pp.text(inspect)
+      end
+    end
+  end
+end

data/lib/looksee/version.rb

@@ -1,5 +1,5 @@
 module Looksee
-  VERSION = [4, 4, 0]
+  VERSION = [5, 1, 0]
 
   class << VERSION
     include Comparable

data/spec/looksee/adapter_spec.rb

@@ -67,6 +67,14 @@ describe "Looksee.adapter" do
         ['[C]', '[Object]', '[BasicObject]', 'Class', 'Module', 'Object', 'Kernel', 'BasicObject']
     end
 
+    it "should contain entries for modules included in the singleton class" do
+      temporary_module :M
+      c = Object.new
+      c.extend(M)
+      filtered_lookup_modules(c).should ==
+        ['[Object instance]', 'M', 'Object', 'Kernel', 'BasicObject']
+    end
+
     it "should work for immediate objects" do
       if RUBY_VERSION >= "2.4.0"
         filtered_lookup_modules(1).first.should == 'Integer'
@@ -76,61 +84,59 @@ describe "Looksee.adapter" do
     end
   end
 
-  describe "internal instance methods:" do
+  describe ".undefined_instance_methods" do
     def self.target_method(name)
       define_method(:target_method){name}
     end
 
-    describe ".internal_undefined_instance_methods" do
-      if Looksee.ruby_engine == 'ruby' && RUBY_VERSION >= '2.3'
-        it "just returns an empty array" do
-          temporary_class :C
-          add_methods C, undefined: [:f]
-          @adapter.internal_undefined_instance_methods(C).should == []
-        end
-      else
-        it "should return the list of undefined instance methods directly on a class" do
-          temporary_class :C
-          add_methods(C, undefined: [:f])
-          @adapter.internal_undefined_instance_methods(C).should == [:f]
-        end
+    if Looksee.ruby_engine == 'ruby' && RUBY_VERSION >= '2.3' && RUBY_VERSION < '3.2'
+      it "just returns an empty array" do
+        temporary_class :C
+        add_methods C, undefined: [:f]
+        @adapter.undefined_instance_methods(C).should == []
+      end
+    else
+      it "should return the list of undefined instance methods directly on a class" do
+        temporary_class :C
+        add_methods(C, undefined: [:f])
+        @adapter.undefined_instance_methods(C).should == [:f]
+      end
 
-        it "should return the list of undefined instance methods directly on a module" do
-          temporary_module :M
-          add_methods(M, undefined: [:f])
-          @adapter.internal_undefined_instance_methods(M).should == [:f]
-        end
+      it "should return the list of undefined instance methods directly on a module" do
+        temporary_module :M
+        add_methods(M, undefined: [:f])
+        @adapter.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
-          add_methods(c.singleton_class, undefined: [:f])
-          @adapter.internal_undefined_instance_methods(c.singleton_class).should == [:f]
-        end
+      it "should return the list of undefined instance methods directly on a singleton class" do
+        temporary_class :C
+        c = C.new
+        add_methods(c.singleton_class, undefined: [:f])
+        @adapter.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
-          add_methods(C.singleton_class, undefined: [:f])
-          @adapter.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
+        add_methods(C.singleton_class, undefined: [:f])
+        @adapter.undefined_instance_methods(C.singleton_class).should == [:f]
+      end
 
-        it "should not return defined methods" do
-          temporary_class :C
-          C.send(:define_method, :f){}
-          @adapter.internal_undefined_instance_methods(C).should == []
-        end
+      it "should not return defined methods" do
+        temporary_class :C
+        C.send(:define_method, :f){}
+        @adapter.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)
-          @adapter.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)
+        @adapter.undefined_instance_methods(C).should == []
+      end
 
-        it "should handle the MRI allocator being undefined (e.g. Struct)" do
-          struct_singleton_class = (class << Struct; self; end)
-          @adapter.internal_undefined_instance_methods(struct_singleton_class).should == []
-        end
+      it "should handle the MRI allocator being undefined (e.g. Struct)" do
+        struct_singleton_class = (class << Struct; self; end)
+        @adapter.undefined_instance_methods(struct_singleton_class).should == []
       end
     end
   end

data/spec/looksee/core_ext_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
 describe Looksee::ObjectMixin do
-  describe "#ls" do
+  describe "#look" do
     before do
       @object = Object.new
       Looksee.stub(:default_specifiers).and_return([])
     end
 
     it "should return an Inspector for the object's lookup path using the given arguments" do
-      result = @object.ls(:private)
+      result = @object.look(:private)
       result.should be_a(Looksee::Inspector)
       result.lookup_path.object.should.equal?(@object)
       result.visibilities.should == Set[:private]

data/spec/looksee/inspector_spec.rb

@@ -150,6 +150,48 @@ describe Looksee::Inspector do
     end
   end
 
+  describe "#pretty_print" do
+    before do
+      Looksee.stub(:default_lookup_path_options).and_return({})
+      Looksee.stub(:styles).and_return(Hash.new{"\e[1;31m%s\e[0m"})
+
+      @object = Object.new
+      temporary_class :C
+      Looksee.adapter.ancestors[@object] = [C]
+
+      add_methods C, public: ['aa']
+      @lookup_path = Looksee::LookupPath.new(@object)
+      @inspector = Looksee::Inspector.new(@lookup_path, :visibilities => [:public])
+    end
+
+    it "should produce the same output as #inspect" do
+      pp = PP.new
+      @inspector.pretty_print(pp)
+      pp.output.should == <<-EOS.demargin.chomp
+        |\e[1;31mC\e[0m
+        |  \e[1;31maa\e[0m
+      EOS
+    end
+
+    it "should not get messed up by IRB::ColorPrinter" do
+      begin
+        require 'irb/color_printer'
+        has_irb_color_printer = true
+      rescue LoadError
+        has_irb_color_printer = false
+      end
+
+      if has_irb_color_printer
+        pp = IRB::ColorPrinter.new
+        @inspector.pretty_print(pp)
+        pp.output.should == <<-EOS.demargin.chomp
+          |\e[1;31mC\e[0m
+          |  \e[1;31maa\e[0m
+        EOS
+      end
+    end
+  end
+
   describe ".styles" do
     before do
       styles = {

data/spec/looksee/lookup_path_spec.rb

@@ -89,7 +89,7 @@ describe Looksee::LookupPath do
     end
   end
 
-  describe Looksee::LookupPath::Entry do
+  describe 'Looksee::LookupPath::Entry' do
     it "should iterate over methods in alphabetical order" do
       temporary_class(:C)
       add_methods(C, public: [:a, :c, :b])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: looksee
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 5.1.0
 platform: ruby
 authors:
 - George Ogata
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -26,12 +26,6 @@ files:
 - README.markdown
 - Rakefile
 - ext/extconf.rb
-- ext/mri/2.1.0/internal.h
-- ext/mri/2.1.0/method.h
-- ext/mri/2.2.0/internal.h
-- ext/mri/2.2.0/method.h
-- ext/mri/2.3.0/internal.h
-- ext/mri/2.3.0/method.h
 - ext/mri/2.7.0/internal.h
 - ext/mri/2.7.0/method.h
 - ext/mri/3.0.0/id_table.h
@@ -45,12 +39,21 @@ files:
 - ext/mri/3.0.0/internal/static_assert.h
 - ext/mri/3.0.0/internal/warnings.h
 - ext/mri/3.0.0/method.h
+- ext/mri/3.2.0/id_table.h
+- ext/mri/3.2.0/internal.h
+- ext/mri/3.2.0/internal/array.h
+- ext/mri/3.2.0/internal/class.h
+- ext/mri/3.2.0/internal/compilers.h
+- ext/mri/3.2.0/internal/gc.h
+- ext/mri/3.2.0/internal/imemo.h
+- ext/mri/3.2.0/internal/serial.h
+- ext/mri/3.2.0/internal/static_assert.h
+- ext/mri/3.2.0/internal/warnings.h
+- ext/mri/3.2.0/method.h
 - ext/mri/mri.c
-- ext/rbx/rbx.c
 - lib/looksee.rb
 - lib/looksee/adapter.rb
 - lib/looksee/adapter/base.rb
-- lib/looksee/adapter/rubinius.rb
 - lib/looksee/clean.rb
 - lib/looksee/columnizer.rb
 - lib/looksee/core_ext.rb
@@ -58,7 +61,7 @@ files:
 - lib/looksee/help.rb
 - lib/looksee/inspector.rb
 - lib/looksee/lookup_path.rb
-- lib/looksee/mri.bundle
+- lib/looksee/pretty_print_hack.rb
 - lib/looksee/version.rb
 - spec/looksee/adapter_spec.rb
 - spec/looksee/clean_spec.rb
@@ -83,14 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 3
 summary: Supercharged method introspection in IRB.