matthew-method_lister 0.3.0 → 0.3.1

data/README.markdown

@@ -53,10 +53,23 @@ vary, depending on what you have loaded):
     require respond_to? send singleton_methods taint tainted? to_a to_s type
     untaint which
 
+    PRIVATE: Array Float Integer String URI ` abort at_exit autoload autoload?
+    binding block_given? callcc caller catch chomp chomp! chop chop! eval exec
+    exit exit! fail fork format gem_original_require getc gets
+    global_variables gsub gsub! initialize_copy iterator? lambda load
+    local_variables loop method_missing open p pp print printf proc putc puts
+    raise rand readline readlines remove_instance_variable scan select
+    set_trace_func singleton_method_added singleton_method_removed
+    singleton_method_undefined sleep split sprintf srand sub sub! syscall
+    system test throw trace_var trap untrace_var warn
+
     ========== Module PP::ObjectMixin ==========
     PUBLIC: pretty_print pretty_print_cycle pretty_print_inspect
     pretty_print_instance_variables
 
+    ========== Class Object ==========
+    PRIVATE: initialize irb_binding timeout
+
     ========== Module Enumerable ==========
     PUBLIC: all? any? collect detect each_with_index entries find find_all
     grep include? inject map max member? min partition reject select sort
@@ -71,7 +84,9 @@ vary, depending on what you have loaded):
     reverse! reverse_each rindex select shift size slice slice! sort sort!
     to_a to_ary to_s transpose uniq uniq! unshift values_at zip |
 
-You can show protected and private methods too by passing in "true":
+    PRIVATE: initialize initialize_copy
+
+You can show only the public methods by passing in "true":
 
     >> [].ls true
     ========== Module Kernel ==========
@@ -83,23 +98,10 @@ You can show protected and private methods too by passing in "true":
     require respond_to? send singleton_methods taint tainted? to_a to_s type
     untaint which
 
-    PRIVATE: Array Float Integer String URI ` abort at_exit autoload autoload?
-    binding block_given? callcc caller catch chomp chomp! chop chop! eval exec
-    exit exit! fail fork format gem_original_require getc gets
-    global_variables gsub gsub! initialize_copy iterator? lambda load
-    local_variables loop method_missing open p pp print printf proc putc puts
-    raise rand readline readlines remove_instance_variable scan select
-    set_trace_func singleton_method_added singleton_method_removed
-    singleton_method_undefined sleep split sprintf srand sub sub! syscall
-    system test throw trace_var trap untrace_var warn
-
     ========== Module PP::ObjectMixin ==========
     PUBLIC: pretty_print pretty_print_cycle pretty_print_inspect
     pretty_print_instance_variables
 
-    ========== Class Object ==========
-    PRIVATE: initialize irb_binding timeout
-
     ========== Module Enumerable ==========
     PUBLIC: all? any? collect detect each_with_index entries find find_all
     grep include? inject map max member? min partition reject select sort
@@ -114,8 +116,6 @@ You can show protected and private methods too by passing in "true":
     reverse! reverse_each rindex select shift size slice slice! sort sort!
     to_a to_ary to_s transpose uniq uniq! unshift values_at zip |
 
-    PRIVATE: initialize initialize_copy
-    
 `grep` or `mgrep`
 -----------------
 
@@ -127,28 +127,28 @@ objects `grep` is already taken:
     ========== Module Kernel ==========
     PUBLIC: freeze frozen? instance_of? instance_variable_defined? kind_of?
 
+    PRIVATE: fail fork format method_missing printf set_trace_func
+    singleton_method_undefined sprintf
+
     ========== Module Enumerable ==========
     PUBLIC: find find_all
 
     ========== Class Array ==========
     PUBLIC: delete_if fetch fill first flatten flatten! frozen? shift unshift
 
-Similar to `ls` you can pass in an extra argument of "true" to see protected
-and private methods:
+Similar to `ls` you can pass in an extra argument of "true" to see only the
+public methods:
 
     >> [].mgrep /f/, true
     ========== Module Kernel ==========
     PUBLIC: freeze frozen? instance_of? instance_variable_defined? kind_of?
 
-    PRIVATE: fail fork format method_missing printf set_trace_func
-    singleton_method_undefined sprintf
-
     ========== Module Enumerable ==========
     PUBLIC: find find_all
 
     ========== Class Array ==========
     PUBLIC: delete_if fetch fill first flatten flatten! frozen? shift unshift
-    
+
 Note that `method_missing` is always considered a match, since it could always
 potentially execute.
 
@@ -170,12 +170,12 @@ method you're seeking. You can pass the method name in as a string or symbol.
 
 Logically the `which` command is the same as `grep(/^your_method$/)` and so
 the same comments apply about `method_missing` and the optional parameter to
-see protected/private methods.
+see only public methods.
 
 License
 =======
 
-Copyright 2008, Matthew O'Connor All rights reserved.
+Copyright 2008, 2009, Matthew O'Connor All rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under
 the same terms as Ruby 1.8.7 itself.

data/lib/method_lister/ruby_ext.rb

@@ -1,24 +1,24 @@
 module Kernel
-  def mls(show_non_public=false, 
+  def mls(show_public_only=false, 
           displayer=MethodLister::ColorDisplay.new, 
           finder=MethodLister::Finder.new)
-    displayer.display finder.ls(self), show_non_public
+    displayer.display finder.ls(self), show_public_only
   end
   alias :ls :mls
 
   def mgrep(regex,
-            show_non_public=false,
+            show_public_only=false,
             displayer=MethodLister::ColorDisplay.new,
             finder=MethodLister::Finder.new)
-    displayer.display finder.grep(regex, self), show_non_public
+    displayer.display finder.grep(regex, self), show_public_only
   end
   alias :grep :mgrep
 
   def mwhich(method,
-             show_non_public=false,
+             show_public_only=false,
              displayer=MethodLister::ColorDisplay.new, 
              finder=MethodLister::Finder.new)
-    displayer.display finder.which(method, self), show_non_public
+    displayer.display finder.which(method, self), show_public_only
   end
   alias :which :mwhich
 end

data/lib/method_lister/simple_display.rb

@@ -1,8 +1,8 @@
 module MethodLister
   class SimpleDisplay
-    def display(findings, show_non_public=false)
+    def display(findings, show_public_only=false)
       findings.reverse.each do |result|
-        list = method_list(result, show_non_public)
+        list = method_list(result, show_public_only)
         if !list.empty?
           puts header(result)
           puts list
@@ -18,9 +18,9 @@ module MethodLister
       "========== #{location_description(result)} =========="
     end
 
-    def method_list(result, show_non_public)
+    def method_list(result, show_public_only)
       FindResult::VISIBILITIES.map do |visibility|
-        (visibility == :public || show_non_public) ?
+        (visibility == :public || !show_public_only) ?
           method_set(result, visibility) : 
           nil
       end.compact.join("\n\n")

data/spec/simple_display_spec.rb

@@ -23,16 +23,16 @@ describe MethodLister::SimpleDisplay do
       @output.should =~ /Module Kernel.*baz.*Class Object.*bar.*Eigenclass.*foo/m
     end
     
-    it "does not show private methods by default" do
+    it "does show private methods by default" do
       @displayer.display @results
-      @output.should_not =~ /PRIVATE/
-      @output.should_not =~ /Class Array/
+      @output.should =~ /PRIVATE/
+      @output.should =~ /Class Array/
     end
     
-    it "shows private methods if told to" do
+    it "shows only public methods if told to" do
       @displayer.display @results, true
-      @output.should =~ /PRIVATE/
-      @output.should =~ /Class Array/
+      @output.should_not =~ /PRIVATE/
+      @output.should_not =~ /Class Array/
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: matthew-method_lister
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Matthew O'Connor