pry 0.9.11.4-java → 0.9.12-java

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.9.11.4"
+  VERSION = "0.9.12"
 end

data/lib/pry/wrapped_module.rb

@@ -65,6 +65,30 @@ class Pry
       @doc = nil
     end
 
+    # Returns an array of the names of the constants accessible in the wrapped
+    # module. This provides a consistent interface between 1.8 and 1.9 and also
+    # avoids the problem of accidentally calling the singleton method
+    # `Module.constants`.
+    # @param [Boolean] inherit (true) Include the names of constants from
+    #   included modules?
+    def constants(inherit = true)
+      method = Module.instance_method(:constants).bind(@wrapped)
+
+      # If we're on 1.8, we have to manually remove ancestors' constants. If
+      # we're on 1.9, though, it's better to use the built-in `inherit` param,
+      # since it doesn't do things like incorrectly remove Pry::Config.
+      if method.arity == 0
+        consts = method.call
+        if !inherit
+          consts -= (@wrapped.ancestors - [@wrapped]).map(&:constants).flatten
+        end
+      else
+        consts = method.call(inherit)
+      end
+
+      consts
+    end
+
     # The prefix that would appear before methods defined on this class.
     #
     # i.e. the "String." or "String#" in String.new and String#initialize.
@@ -99,6 +123,18 @@ class Pry
       wrapped != wrapped.ancestors.first
     end
 
+    # Is this strictly a module? (does not match classes)
+    # @return [Boolean]
+    def module?
+      wrapped.instance_of?(Module)
+    end
+
+    # Is this strictly a class?
+    # @return [Boolean]
+    def class?
+      wrapped.instance_of?(Class)
+    end
+
     # Get the instance associated with this singleton class.
     #
     # @raise ArgumentError: tried to get instance of non singleton class
@@ -205,13 +241,27 @@ class Pry
       @memoized_candidates[rank] ||= Candidate.new(self, rank)
     end
 
-
     # @return [Fixnum] The number of candidate definitions for the
     #   current module.
     def number_of_candidates
       method_candidates.count
     end
 
+    # @note On JRuby 1.9 and higher, in certain conditions, this method chucks
+    #   away its ability to be quick (when there are lots of monkey patches,
+    #   like in Rails). However, it should be efficient enough on other rubies.
+    # @see https://github.com/jruby/jruby/issues/525
+    # @return [Enumerator, Array] on JRuby 1.9 and higher returns Array, on
+    #  other rubies returns Enumerator
+    def candidates
+      enum = generator.new do |y|
+               (0...number_of_candidates).each do |num|
+                 y.yield candidate(num)
+               end
+             end
+      Pry::Helpers::BaseHelpers.jruby_19? ? enum.to_a : enum
+    end
+
     # @return [Boolean] Whether YARD docs are available for this module.
     def yard_docs?
       !!(defined?(YARD) && YARD::Registry.at(name))
@@ -237,6 +287,18 @@ class Pry
 
     private
 
+    # Ruby 1.8 doesn't support `Enumerator` (it's called Generator instead)
+    #
+    # @return [Object] Return the appropriate generator class.
+    def generator
+      @generator ||= if defined?(Enumerator)
+                       Enumerator
+                     else
+                       require 'generator'
+                       Generator
+                     end
+    end
+
     # @return [Pry::WrappedModule::Candidate] The candidate of rank 0,
     #   that is the 'monkey patch' of this module with the highest
     #   number of methods. It is considered the 'canonical' definition

data/spec/Procfile

@@ -0,0 +1,3 @@
+# Run this with:
+# gem install foreman && foreman start -f spec/Procfile
+pryhere: sh -c '(cd ..; rake pry)'

data/spec/command_helpers_spec.rb

@@ -5,5 +5,25 @@ describe Pry::Helpers::CommandHelpers do
     @helper = Pry::Helpers::CommandHelpers
   end
 
-  # FIXME: currently no tests
+  describe "unindent" do
+    it "should remove the same prefix from all lines" do
+      @helper.unindent(" one\n two\n").should == "one\ntwo\n"
+    end
+
+    it "should not be phased by empty lines" do
+      @helper.unindent(" one\n\n two\n").should == "one\n\ntwo\n"
+    end
+
+    it "should only remove a common prefix" do
+      @helper.unindent("  one\n two\n").should == " one\ntwo\n"
+    end
+
+    it "should also remove tabs if present" do
+      @helper.unindent("\tone\n\ttwo\n").should == "one\ntwo\n"
+    end
+
+    it "should ignore lines starting with --" do
+      @helper.unindent(" one\n--\n two\n").should == "one\n--\ntwo\n"
+    end
+  end
 end

data/spec/commands/ls_spec.rb

@@ -93,6 +93,10 @@ describe "ls" do
         "ls Module.new{ def shinanagarns; 4; end; public :shinanagarns }")
       output.should =~ /shinanagarns/
     end
+
+    it "should behave normally when invoked on Module itself" do
+      pry_eval("ls Module").should.not =~ /Pry/
+    end
   end
 
   describe "constants" do

data/spec/commands/show_doc_spec.rb

@@ -200,179 +200,311 @@ if !PryTestHelpers.mri18_and_no_real_source_location?
                 def woof
                 end
               end
-            RUBY
-            t.eval('show-doc TobinaMyDog').should =~ /hello tobina/
-            Object.remove_const :TobinaMyDog
+              RUBY
+              t.eval('show-doc TobinaMyDog').should =~ /hello tobina/
+              Object.remove_const :TobinaMyDog
+            end
           end
         end
-      end
 
-      it 'should lookup module name with respect to current context' do
-        constant_scope(:AlphaClass, :BetaClass) do
-          # top-level beta
-          class BetaClass
-            def alpha
+        it 'should lookup module name with respect to current context' do
+          constant_scope(:AlphaClass, :BetaClass) do
+            # top-level beta
+            class BetaClass
+              def alpha
+              end
+            end
+
+            class AlphaClass
+              # nested beta
+              class BetaClass
+                def beta
+                end
+              end
             end
+
+            pry_eval(AlphaClass, "show-doc BetaClass").should =~ /nested beta/
           end
+        end
 
-          class AlphaClass
-            # nested beta
-            class BetaClass
+        it 'should look up nested modules' do
+          constant_scope(:AlphaClass) do
+            class AlphaClass
+              # nested beta
+              class BetaClass
+                def beta
+                end
+              end
+            end
+
+            pry_eval("show-doc AlphaClass::BetaClass").should =~
+              /nested beta/
+          end
+        end
+
+        describe "show-doc -a" do
+          it 'should show the docs for all monkeypatches defined in different files' do
+            # local monkeypatch
+            class TestClassForShowSource
               def beta
               end
             end
+
+            result = pry_eval("show-doc TestClassForShowSource -a")
+            result.should =~ /used by/
+            result.should =~ /local monkeypatch/
           end
 
-          pry_eval(AlphaClass, "show-doc BetaClass").should =~ /nested beta/
+          describe "messages relating to -a" do
+            it 'indicates all available monkeypatches can be shown with -a when (when -a not used and more than one candidate exists for class)' do
+              class TestClassForShowSource
+                def beta
+                end
+              end
+
+              result = pry_eval('show-doc TestClassForShowSource')
+              result.should =~ /available monkeypatches/
+            end
+
+            it 'shouldnt say anything about monkeypatches when only one candidate exists for selected class' do
+              class Aarrrrrghh
+                def o;end
+              end
+
+              result = pry_eval('show-doc Aarrrrrghh')
+              result.should.not =~ /available monkeypatches/
+              Object.remove_const(:Aarrrrrghh)
+            end
+          end
         end
-      end
 
-      it 'should look up nested modules' do
-        constant_scope(:AlphaClass) do
-          class AlphaClass
-            # nested beta
-            class BetaClass
-              def beta
+        describe "when no class/module arg is given" do
+          before do
+            module TestHost
+
+              # hello there froggy
+              module M
+                def d; end
+                def e; end
               end
             end
           end
 
-          pry_eval("show-doc AlphaClass::BetaClass").should =~
-            /nested beta/
+          after do
+            Object.remove_const(:TestHost)
+          end
+
+          it 'should return doc for current module' do
+            pry_eval(TestHost::M, "show-doc").should =~ /hello there froggy/
+          end
         end
-      end
 
-      describe "show-doc -a" do
-        it 'should show the docs for all monkeypatches defined in different files' do
-          # local monkeypatch
-          class TestClassForShowSource
-            def beta
+        # FIXME: THis is nto a good spec anyway, because i dont think it
+        # SHOULD skip!
+        describe "should skip over broken modules" do
+          before do
+            module TestHost
+              # hello
+              module M
+                binding.eval("def a; end", "dummy.rb", 1)
+                binding.eval("def b; end", "dummy.rb", 2)
+                binding.eval("def c; end", "dummy.rb", 3)
+              end
+
+              # goodbye
+              module M
+                def d; end
+                def e; end
+              end
             end
           end
 
-          result = pry_eval("show-doc TestClassForShowSource -a")
-          result.should =~ /used by/
-          result.should =~ /local monkeypatch/
+          after do
+            Object.remove_const(:TestHost)
+          end
+
+          it 'should return doc for first valid module' do
+            result = pry_eval("show-doc TestHost::M")
+            result.should =~ /goodbye/
+            result.should.not =~ /hello/
+          end
         end
       end
 
-      describe "when no class/module arg is given" do
+      describe "on commands" do
+        # mostly copied & modified from test_help.rb
         before do
-          module TestHost
-
-            # hello there froggy
-            module M
-              def d; end
-              def e; end
-            end
+          @oldset = Pry.config.commands
+          @set = Pry.config.commands = Pry::CommandSet.new do
+            import Pry::Commands
           end
         end
 
         after do
-          Object.remove_const(:TestHost)
+          Pry.config.commands = @oldset
         end
 
-        it 'should return doc for current module' do
-          pry_eval(TestHost::M, "show-doc").should =~ /hello there froggy/
+        it 'should display help for a specific command' do
+          pry_eval('show-doc ls').should =~ /Usage: ls/
         end
-      end
 
-      # FIXME: THis is nto a good spec anyway, because i dont think it
-      # SHOULD skip!
-      # describe "should skip over broken modules" do
-      #   before do
-      #     module TestHost
-      #       # hello
-      #       module M
-      #         binding.eval("def a; end", "dummy.rb", 1)
-      #         binding.eval("def b; end", "dummy.rb", 2)
-      #         binding.eval("def c; end", "dummy.rb", 3)
-      #       end
-
-      #       # goodbye
-      #       module M
-      #         def d; end
-      #         def e; end
-      #       end
-      #     end
-      #   end
-
-      #   after do
-      #     Object.remove_const(:TestHost)
-      #   end
-
-      #   it 'should return doc for first valid module' do
-      #     result = pry_eval("show-doc TestHost::M")
-      #     result.should =~ /goodbye/
-      #     result.should.not =~ /hello/
-      #   end
-      # end
-    end
+        it 'should display help for a regex command with a "listing"' do
+          @set.command /bar(.*)/, "Test listing", :listing => "foo" do; end
+          pry_eval('show-doc foo').should =~ /Test listing/
+        end
 
-    describe "on commands" do
-      # mostly copied & modified from test_help.rb
-      before do
-        @oldset = Pry.config.commands
-        @set = Pry.config.commands = Pry::CommandSet.new do
-          import Pry::Commands
+        it 'should display help for a command with a spaces in its name' do
+          @set.command "command with spaces", "description of a command with spaces" do; end
+          pry_eval('show-doc command with spaces').should =~ /description of a command with spaces/
         end
-      end
 
-      after do
-        Pry.config.commands = @oldset
-      end
+        describe "class commands" do
+          before do
+            # pretty pink pincers
+            class LobsterLady < Pry::ClassCommand
+              match "lobster-lady"
+              description "nada."
+              def process
+                "lobster"
+              end
+            end
 
-      it 'should display help for a specific command' do
-        pry_eval('show-doc ls').should =~ /Usage: ls/
-      end
+            Pry.commands.add_command(LobsterLady)
+          end
+
+          after do
+            Object.remove_const(:LobsterLady)
+          end
 
-      it 'should display help for a regex command with a "listing"' do
-        @set.command /bar(.*)/, "Test listing", :listing => "foo" do; end
-        pry_eval('show-doc foo').should =~ /Test listing/
+          it 'should display "help" when looking up by command name' do
+            pry_eval('show-doc lobster-lady').should =~ /nada/
+            Pry.commands.delete("lobster-lady")
+          end
+
+          it 'should display actual preceding comment for a class command, when class is used (rather than command name) when looking up' do
+            pry_eval('show-doc LobsterLady').should =~ /pretty pink pincers/
+            Pry.commands.delete("lobster-lady")
+          end
+        end
       end
 
-      it 'should display help for a command with a spaces in its name' do
-        @set.command "command with spaces", "description of a command with spaces" do; end
-        pry_eval('show-doc command with spaces').should =~ /description of a command with spaces/
+      describe "should set _file_ and _dir_" do
+        it 'should set _file_ and _dir_ to file containing method source' do
+          t = pry_tester
+          t.process_command "show-doc TestClassForShowSource#alpha"
+          t.pry.last_file.should =~ /show_source_doc_examples/
+          t.pry.last_dir.should =~ /fixtures/
+        end
       end
 
-      describe "class commands" do
-        before do
-          # pretty pink pincers
-          class LobsterLady < Pry::ClassCommand
-            match "lobster-lady"
-            description "nada."
-            def process
-              "lobster"
+      unless Pry::Helpers::BaseHelpers.rbx?
+        describe "can't find class docs" do
+          describe "for classes" do
+            before do
+              module Jesus
+                class Brian; end
+
+                # doink-doc
+                class Jingle
+                  def a; :doink; end
+                end
+
+                class Jangle < Jingle; end
+                class Bangle < Jangle; end
+              end
+            end
+
+            after do
+              Object.remove_const(:Jesus)
+            end
+
+            it 'shows superclass doc' do
+              t = pry_tester
+              t.process_command "show-doc Jesus::Jangle"
+              t.last_output.should =~ /doink-doc/
+            end
+
+            it 'errors when class has no superclass to show' do
+              t = pry_tester
+              lambda { t.process_command "show-doc Jesus::Brian" }.should.raise(Pry::CommandError).message.
+                should =~ /Couldn't locate/
+            end
+
+            it 'shows warning when reverting to superclass docs' do
+              t = pry_tester
+              t.process_command "show-doc Jesus::Jangle"
+              t.last_output.should =~ /Warning.*?Cannot find.*?Jesus::Jangle.*Showing.*Jesus::Jingle instead/
+            end
+
+            it 'shows nth level superclass docs (when no intermediary superclasses have code either)' do
+              t = pry_tester
+              t.process_command "show-doc Jesus::Bangle"
+              t.last_output.should =~ /doink-doc/
+            end
+
+            it 'shows correct warning when reverting to nth level superclass' do
+              t = pry_tester
+              t.process_command "show-doc Jesus::Bangle"
+              t.last_output.should =~ /Warning.*?Cannot find.*?Jesus::Bangle.*Showing.*Jesus::Jingle instead/
             end
           end
 
-          Pry.commands.add_command(LobsterLady)
-        end
+          describe "for modules" do
+            before do
+              module Jesus
 
-        after do
-          Object.remove_const(:LobsterLady)
-        end
+                # alpha-doc
+                module Alpha
+                  def alpha; :alpha; end
+                end
 
-        it 'should display "help" when looking up by command name' do
-          pry_eval('show-doc lobster-lady').should =~ /nada/
-          Pry.commands.delete("lobster-lady")
-        end
+                module Zeta; end
 
-        it 'should display actual preceding comment for a class command, when class is used (rather than command name) when looking up' do
-          pry_eval('show-doc LobsterLady').should =~ /pretty pink pincers/
-          Pry.commands.delete("lobster-lady")
-        end
-      end
-    end
+                module Beta
+                  include Alpha
+                end
+
+                module Gamma
+                  include Beta
+                end
+              end
+            end
 
-    describe "should set _file_ and _dir_" do
-      it 'should set _file_ and _dir_ to file containing method source' do
-        t = pry_tester
-        t.process_command "show-doc TestClassForShowSource#alpha"
-        t.pry.last_file.should =~ /show_source_doc_examples/
-        t.pry.last_dir.should =~ /fixtures/
+            after do
+              Object.remove_const(:Jesus)
+            end
+
+            it 'shows included module doc' do
+              t = pry_tester
+              t.process_command "show-doc Jesus::Beta"
+              t.last_output.should =~ /alpha-doc/
+            end
+
+            it 'shows warning when reverting to included module doc' do
+              t = pry_tester
+              t.process_command "show-doc Jesus::Beta"
+              t.last_output.should =~ /Warning.*?Cannot find.*?Jesus::Beta.*Showing.*Jesus::Alpha instead/
+            end
+
+            it 'errors when module has no included module to show' do
+              t = pry_tester
+              lambda { t.process_command "show-source Jesus::Zeta" }.should.raise(Pry::CommandError).message.
+                should =~ /Couldn't locate/
+            end
+
+            it 'shows nth level included module doc (when no intermediary modules have code either)' do
+              t = pry_tester
+              t.process_command "show-doc Jesus::Gamma"
+              t.last_output.should =~ /alpha-doc/
+            end
+
+            it 'shows correct warning when reverting to nth level included module' do
+              t = pry_tester
+              t.process_command "show-source Jesus::Gamma"
+              t.last_output.should =~ /Warning.*?Cannot find.*?Jesus::Gamma.*Showing.*Jesus::Alpha instead/
+            end
+          end
+        end
       end
     end
   end
-end