looksee 0.2.1 → 1.0.0

data/CHANGELOG

@@ -0,0 +1,14 @@
+== 1.0.0 2011-03-09
+
+ * New API.
+   * old: lp(object, :private => true, :undefined => false).grep(/blah/)
+   * new: object.ls :private, :noundefined, /blah/
+ * Configuration has changed accordingly.
+   * old: Looksee.default_lookup_path_options = {:private => true, :undefined => false}
+   * new: Looksee.default_specifiers = [:private, :noundefined]
+ * Require 'looksee' instead of 'looksee/shortcuts'. For
+   non-pollutiness, use "require 'looksee/clean'".
+ * All methods are now listed by default.
+ * Modules are now listed root class first.
+ * Support for Ruby MRI 1.9, JRuby, and Rubinius.
+ * Add Object#edit(METHOD), to open Object#METHOD in your text editor.

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) George Ogata
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,161 @@
+# Looksee
+
+A tool for illustrating the ancestry and method lookup path of
+objects. Great for exploring unfamiliar codebases!
+
+## How
+
+Install me:
+
+    gem install looksee
+
+Pop this in your `.irbrc`:
+
+    require 'looksee'
+
+Now each object has a method `ls`, which shows you all its methods.
+
+    irb> [].ls
+     => BasicObject
+      !   __send__    instance_eval   singleton_method_added    
+      !=  equal?      instance_exec   singleton_method_removed  
+      ==  initialize  method_missing  singleton_method_undefined
+    Kernel
+      !~                       freeze                      puts                    
+      <=>                      frozen?                     raise                   
+      ===                      gem                         rand                    
+      =~                       gem_original_require        readline                
+      Array                    gets                        readlines               
+      Complex                  global_variables            remove_instance_variable
+      Float                    hash                        require                 
+      Integer                  initialize_clone            require_relative        
+      Rational                 initialize_copy             respond_to?             
+      String                   initialize_dup              respond_to_missing?     
+      URI                      inspect                     select                  
+      __callee__               instance_of?                send                    
+      __id__                   instance_variable_defined?  set_trace_func          
+      __method__               instance_variable_get       singleton_class         
+      `                        instance_variable_set       singleton_methods       
+      abort                    instance_variables          sleep                   
+      at_exit                  is_a?                       spawn                   
+      autoload                 iterator?                   sprintf                 
+      autoload?                kind_of?                    srand                   
+      binding                  lambda                      syscall                 
+      block_given?             load                        system                  
+      caller                   local_variables             taint                   
+      catch                    loop                        tainted?                
+      class                    method                      tap                     
+      clone                    methods                     test                    
+      define_singleton_method  nil?                        throw                   
+      display                  object_id                   to_enum                 
+      dup                      open                        to_s                    
+      enum_for                 p                           trace_var               
+      eql?                     print                       trap                    
+      eval                     printf                      trust                   
+      exec                     private_methods             untaint                 
+      exit                     proc                        untrace_var             
+      exit!                    protected_methods           untrust                 
+      extend                   public_method               untrusted?              
+      fail                     public_methods              warn                    
+      fork                     public_send                 y                       
+      format                   putc                      
+    Looksee::ObjectMixin
+      edit  ls
+    Object
+      default_src_encoding  oauth            taguri   to_yaml_properties
+      in?                   patch            taguri=  to_yaml_style     
+      irb_binding           singleton_class  timeout
+      load_if_available     syck_to_yaml     to_yaml
+    Enumerable
+      all?            drop_while        first     min           select      
+      any?            each_cons         flat_map  min_by        slice_before
+      by              each_entry        grep      minmax        sort        
+      chunk           each_slice        group_by  minmax_by     sort_by     
+      collect         each_with_index   include?  none?         take        
+      collect_concat  each_with_object  inject    one?          take_while  
+      count           entries           map       partition     to_a        
+      cycle           find              max       reduce        to_set      
+      detect          find_all          max_by    reject        zip         
+      drop            find_index        member?   reverse_each
+    Array
+      &            drop_while       map!                  size           
+      *            each             pack                  slice          
+      +            each_index       permutation           slice!         
+      -            empty?           pop                   sort           
+      <<           eql?             product               sort!          
+      <=>          fetch            push                  sort_by!       
+      ==           fill             rassoc                taguri         
+      []           find_index       reject                taguri=        
+      []=          first            reject!               take           
+      assoc        flatten          repeated_combination  take_while     
+      at           flatten!         repeated_permutation  to_a           
+      clear        frozen?          replace               to_ary         
+      collect      hash             reverse               to_s           
+      collect!     include?         reverse!              to_yaml        
+      combination  index            reverse_each          transpose      
+      compact      initialize       rindex                uniq           
+      compact!     initialize_copy  rotate                uniq!          
+      concat       insert           rotate!               unshift        
+      count        inspect          sample                values_at      
+      cycle        join             select                yaml_initialize
+      delete       keep_if          select!               zip            
+      delete_at    last             shift                 |              
+      delete_if    length           shuffle             
+      drop         map              shuffle!             
+
+Methods are colored according to whether they're public, protected,
+private, undefined (using Module#undef_method), or overridden.
+
+You can hide, say, private methods like this:
+
+    irb> [].ls :noprivate
+
+Or filter the list by Regexp:
+
+    irb> [].ls /^to_/
+     => BasicObject
+    Kernel
+      to_enum  to_s
+    Looksee::ObjectMixin
+    Object
+      to_yaml  to_yaml_properties  to_yaml_style
+    Enumerable
+      to_a  to_set
+    Array
+      to_a  to_ary  to_s  to_yaml 
+
+And if you want to know more about any of those methods, Looksee can
+take you straight to the source in your editor:
+
+    > [].edit('to_set')
+
+By default, this uses `vi`; customize it like this:
+
+    # %f = file, %l = line number
+    Looksee.editor = "mate -l%l %f"
+
+See more in the quick reference:
+
+    irb> Looksee.help
+
+Enjoy!
+
+## Support
+
+Looksee works with:
+
+ *  MRI/REE (>= 1.8.6)
+ * JRuby (>= 1.5.6)
+ * Rubinius (>= 1.2.1)
+
+## Contributing
+
+ * [Bug reports](https://github.com/oggy/looksee/issues)
+ * [Source](https://github.com/oggy/looksee)
+ * Patches: Fork on Github, send pull request.
+   * Include tests where practical.
+   * Leave the version alone, or bump it in a separate commit.
+
+## Copyright
+
+Copyright (c) George Ogata. See LICENSE for details.

data/Rakefile

@@ -1,37 +1,10 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-
-require './lib/looksee/version'
-
-Hoe.plugin :newgem
-Hoe.plugin :email  # from seattlerb - configure via ~/.hoerc
-
-$hoe = Hoe.spec 'looksee' do
-  self.developer 'George Ogata', 'george.ogata@gmail.com'
-  self.rubyforge_name       = self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-  self.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"],
-    ['rspec', '>= 1.2.7'],
-    ['mocha', '>= 0.9.5'],
-  ]
+require 'ritual'
+
+case (Object.const_defined?(:RUBY_ENGINE) ? RUBY_ENGINE : 'ruby')
+when 'ruby'
+  extension :mri
+when 'rbx'
+  extension :rbx
+when 'jruby'
+  extension :jruby, :type => :jruby
 end
-
-# Configure the clean and clobber tasks.
-require 'rake/clean'
-require 'rbconfig'
-CLEAN.include('**/*.o')
-CLOBBER.include("ext/looksee/looksee.#{Config::CONFIG['DLEXT']}")
-
-require 'newgem/tasks' # loads /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-desc "Rebuild the gem from scratch."
-task :regem => [:clobber, :gem]
-
-# Force build before running specs.
-Rake::Task['spec'].prerequisites << 'extconf:compile'
-
-task :default => :spec

data/ext/extconf.rb

@@ -0,0 +1,9 @@
+ruby_engine = Object.const_defined?(:RUBY_ENGINE) ? RUBY_ENGINE : 'mri'
+extension = ruby_engine == 'ruby' ? 'mri' : ruby_engine
+
+require 'mkmf'
+$CPPFLAGS << " -DRUBY_VERSION=#{RUBY_VERSION.tr('.', '')}"
+if extension == 'mri'
+  $CPPFLAGS << " -Imri/1.9.2" if RUBY_VERSION >= '1.9.2'
+end
+create_makefile "looksee/#{extension}", extension

data/ext/mri/1.9.2/debug.h

@@ -0,0 +1,36 @@
+/**********************************************************************
+
+  debug.h - YARV Debug function interface
+
+  $Author: akr $
+  created at: 04/08/25 02:33:49 JST
+
+  Copyright (C) 2004-2007 Koichi Sasada
+
+**********************************************************************/
+
+#ifndef RUBY_DEBUG_H
+#define RUBY_DEBUG_H
+
+#include "ruby/ruby.h"
+#include "node.h"
+
+#define dpv(h,v) ruby_debug_print_value(-1, 0, h, v)
+#define dp(v)    ruby_debug_print_value(-1, 0, "", v)
+#define dpi(i)   ruby_debug_print_id(-1, 0, "", i)
+#define dpn(n)   ruby_debug_print_node(-1, 0, "", n)
+
+#define bp()     ruby_debug_breakpoint()
+
+VALUE ruby_debug_print_value(int level, int debug_level, const char *header, VALUE v);
+ID    ruby_debug_print_id(int level, int debug_level, const char *header, ID id);
+NODE *ruby_debug_print_node(int level, int debug_level, const char *header, const NODE *node);
+int   ruby_debug_print_indent(int level, int debug_level, int indent_level);
+void  ruby_debug_breakpoint(void);
+void  ruby_debug_gc_check_func(void);
+
+#ifdef RUBY_DEBUG_ENV
+void ruby_set_debug_option(const char *str);
+#endif
+
+#endif /* RUBY_DEBUG_H */

data/ext/mri/1.9.2/id.h

@@ -0,0 +1,170 @@
+/* DO NOT EDIT THIS FILE DIRECTLY */
+/**********************************************************************
+
+  id.h -
+
+  $Author: akr $
+  created at: Sun Oct 19 21:12:51 2008
+
+  Copyright (C) 2007 Koichi Sasada
+
+**********************************************************************/
+
+#ifndef RUBY_ID_H
+#define RUBY_ID_H
+
+#define ID_SCOPE_SHIFT 3
+#define ID_SCOPE_MASK 0x07
+#define ID_LOCAL      0x00
+#define ID_INSTANCE   0x01
+#define ID_GLOBAL     0x03
+#define ID_ATTRSET    0x04
+#define ID_CONST      0x05
+#define ID_CLASS      0x06
+#define ID_JUNK       0x07
+#define ID_INTERNAL   ID_JUNK
+
+#ifdef USE_PARSE_H
+#include "parse.h"
+#endif
+
+#define symIFUNC ID2SYM(idIFUNC)
+#define symCFUNC ID2SYM(idCFUNC)
+
+#if !defined tLAST_TOKEN && defined YYTOKENTYPE
+#define tLAST_TOKEN tLAST_TOKEN
+#endif
+
+enum ruby_method_ids {
+#ifndef tLAST_TOKEN
+    tUPLUS = 321,
+    tUMINUS = 322,
+    tPOW = 323,
+    tCMP = 324,
+    tEQ = 325,
+    tEQQ = 326,
+    tNEQ = 327,
+    tGEQ = 328,
+    tLEQ = 329,
+    tANDOP = 330,
+    tOROP = 331,
+    tMATCH = 332,
+    tNMATCH = 333,
+    tDOT2 = 334,
+    tDOT3 = 335,
+    tAREF = 336,
+    tASET = 337,
+    tLSHFT = 338,
+    tRSHFT = 339,
+    tLAMBDA = 352,
+    idNULL = 365,
+    idRespond_to = 366,
+    idIFUNC = 367,
+    idCFUNC = 368,
+    id_core_set_method_alias = 369,
+    id_core_set_variable_alias = 370,
+    id_core_undef_method = 371,
+    id_core_define_method = 372,
+    id_core_define_singleton_method = 373,
+    id_core_set_postexe = 374,
+    tLAST_TOKEN = 375,
+#endif
+    idDot2 = tDOT2,
+    idDot3 = tDOT3,
+    idUPlus = tUPLUS,
+    idUMinus = tUMINUS,
+    idPow = tPOW,
+    idCmp = tCMP,
+    idPLUS = '+',
+    idMINUS = '-',
+    idMULT = '*',
+    idDIV = '/',
+    idMOD = '%',
+    idLT = '<',
+    idLTLT = tLSHFT,
+    idLE = tLEQ,
+    idGT = '>',
+    idGE = tGEQ,
+    idEq = tEQ,
+    idEqq = tEQQ,
+    idNeq = tNEQ,
+    idNot = '!',
+    idBackquote = '`',
+    idEqTilde = tMATCH,
+    idNeqTilde = tNMATCH,
+    idAREF = tAREF,
+    idASET = tASET,
+    idLAST_TOKEN = tLAST_TOKEN >> ID_SCOPE_SHIFT,
+    tIntern,
+    tMethodMissing,
+    tLength,
+    tSize,
+    tGets,
+    tSucc,
+    tEach,
+    tLambda,
+    tSend,
+    t__send__,
+    tInitialize,
+#if SUPPORT_JOKE
+    tBitblt,
+    tAnswer,
+#endif
+    tLAST_ID,
+#define TOKEN2ID(n) id##n = ((t##n<<ID_SCOPE_SHIFT)|ID_LOCAL)
+#if SUPPORT_JOKE
+    TOKEN2ID(Bitblt),
+    TOKEN2ID(Answer),
+#endif
+    TOKEN2ID(Intern),
+    TOKEN2ID(MethodMissing),
+    TOKEN2ID(Length),
+    TOKEN2ID(Size),
+    TOKEN2ID(Gets),
+    TOKEN2ID(Succ),
+    TOKEN2ID(Each),
+    TOKEN2ID(Lambda),
+    TOKEN2ID(Send),
+    TOKEN2ID(__send__),
+    TOKEN2ID(Initialize)
+};
+
+#ifdef tLAST_TOKEN
+struct ruby_method_ids_check {
+#define ruby_method_id_check_for(name, value) \
+    int checking_for_##name[name == value ? 1 : -1]
+ruby_method_id_check_for(tUPLUS, 321);
+ruby_method_id_check_for(tUMINUS, 322);
+ruby_method_id_check_for(tPOW, 323);
+ruby_method_id_check_for(tCMP, 324);
+ruby_method_id_check_for(tEQ, 325);
+ruby_method_id_check_for(tEQQ, 326);
+ruby_method_id_check_for(tNEQ, 327);
+ruby_method_id_check_for(tGEQ, 328);
+ruby_method_id_check_for(tLEQ, 329);
+ruby_method_id_check_for(tANDOP, 330);
+ruby_method_id_check_for(tOROP, 331);
+ruby_method_id_check_for(tMATCH, 332);
+ruby_method_id_check_for(tNMATCH, 333);
+ruby_method_id_check_for(tDOT2, 334);
+ruby_method_id_check_for(tDOT3, 335);
+ruby_method_id_check_for(tAREF, 336);
+ruby_method_id_check_for(tASET, 337);
+ruby_method_id_check_for(tLSHFT, 338);
+ruby_method_id_check_for(tRSHFT, 339);
+ruby_method_id_check_for(tLAMBDA, 352);
+ruby_method_id_check_for(idNULL, 365);
+ruby_method_id_check_for(idRespond_to, 366);
+ruby_method_id_check_for(idIFUNC, 367);
+ruby_method_id_check_for(idCFUNC, 368);
+ruby_method_id_check_for(id_core_set_method_alias, 369);
+ruby_method_id_check_for(id_core_set_variable_alias, 370);
+ruby_method_id_check_for(id_core_undef_method, 371);
+ruby_method_id_check_for(id_core_define_method, 372);
+ruby_method_id_check_for(id_core_define_singleton_method, 373);
+ruby_method_id_check_for(id_core_set_postexe, 374);
+ruby_method_id_check_for(tLAST_TOKEN, 375);
+};
+#endif
+
+#endif /* RUBY_ID_H */