core_docs 0.9.0

data/lib/core_docs/version.rb

@@ -0,0 +1,3 @@
+module CoreDocs
+  VERSION = '0.9.0'
+end

data/spec/core_docs_spec.rb

@@ -0,0 +1,199 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/core_docs"
+require "#{direc}/helper"
+require "#{direc}/gem_with_cext/gems/sample"
+require 'bacon'
+require 'set'
+require 'fileutils'
+require 'readline'
+
+puts "Testing core_docs version #{CoreDocs::VERSION}..."
+puts "Ruby version: #{RUBY_VERSION}"
+
+describe CoreDocs do
+
+  describe "core C methods" do
+    it 'should look up core (C) methods' do
+      obj = CoreDocs::MethodInfo.info_for(method(:puts))
+      obj.source.should.not == nil
+    end
+
+    it 'should look up core (C) instance methods' do
+      Module.module_eval do
+        obj = CoreDocs::MethodInfo.info_for(instance_method(:include))
+        obj.source.should.not == nil
+      end
+    end
+
+    it 'should look up core (C) class method (by Method object)' do
+      Module.module_eval do
+        obj = CoreDocs::MethodInfo.info_for(Dir.method(:glob))
+        obj.source.should.not == nil
+      end
+    end
+
+    it 'should look up core (C) class method (by UnboundMethod object)' do
+      Module.module_eval do
+        obj = CoreDocs::MethodInfo.info_for(class << Dir; instance_method(:glob); end)
+        obj.source.should.not == nil
+      end
+    end
+  end
+
+  describe "eval methods" do
+    it 'should return nil for eval methods' do
+      TOPLEVEL_BINDING.eval("def hello; end")
+      obj = CoreDocs::MethodInfo.info_for(method(:hello))
+      obj.should == nil
+    end
+  end
+
+  describe "pure ruby methods" do
+    it 'should look up ruby methods' do
+      obj = CoreDocs::MethodInfo.info_for(C.new.method(:message))
+      obj.should.not == nil
+    end
+
+    it 'should look up ruby instance methods' do
+      obj = CoreDocs::MethodInfo.info_for(C.instance_method(:message))
+      obj.should.not == nil
+    end
+  end
+
+  describe "Ruby stdlib methods" do
+    it "should look up ruby stdlib method" do
+      obj = CoreDocs::MethodInfo.info_for(Set.instance_method(:union))
+      obj.should.not == nil
+    end
+  end
+
+  describe "C ext methods" do
+
+    it "should lookup C ext methods" do
+      obj = CoreDocs::MethodInfo.info_for(Sample.instance_method(:gleezor))
+      obj.should.not == nil
+    end
+
+    it "should lookup aliased C ext methods" do
+      obj = CoreDocs::MethodInfo.info_for(Sample.instance_method(:remove))
+      obj.should.not == nil
+    end
+
+    it "should lookup C ext instance methods even when its owners don't have any ruby methods" do
+      obj = CoreDocs::MethodInfo.info_for(Sample::A::B.instance_method(:gleezor))
+      obj.should.not == nil
+    end
+
+    it "should lookup C ext class methods even when its owners don't have any ruby methods" do
+      obj = CoreDocs::MethodInfo.info_for(Sample::A::B.method(:gleezor))
+      obj.should.not == nil
+    end
+  end
+
+  describe "C stdlib methods" do
+    it "finds them" do
+      obj = CoreDocs::MethodInfo.info_for(Readline.method(:readline))
+      obj.should.not == nil
+    end
+
+    it "finds well hidden docs like BigDecimal docs" do
+      require 'bigdecimal'
+      obj = CoreDocs::MethodInfo.info_for(BigDecimal.instance_method(:finite?))
+      obj.should.not == nil
+    end
+  end
+
+  describe ".aliases" do
+    it "should return empty array if method does not have any alias" do
+      aliases = CoreDocs::MethodInfo.aliases(Sample.instance_method(:some_meth))
+      aliases.should == []
+    end
+
+    it "should return aliases of a (C) method" do
+      orig = Sample.instance_method(:gleezor)
+      copy = Sample.instance_method(:remove)
+
+      aliases = CoreDocs::MethodInfo.aliases(orig)
+      aliases.should == [copy]
+
+      aliases = CoreDocs::MethodInfo.aliases(copy)
+      aliases.should == [orig]
+    end
+
+    it "should return aliases of a ruby method" do
+      C.class_eval { alias msg message }
+
+      orig = C.instance_method(:message)
+      copy = C.instance_method(:msg)
+
+      aliases = CoreDocs::MethodInfo.aliases(orig)
+      aliases.should == [copy]
+
+      aliases = CoreDocs::MethodInfo.aliases(copy)
+      aliases.should == [orig]
+    end
+
+    it "should return aliases of protected method" do
+      orig = Sample.instance_method(:gleezor_1)
+      copy = Sample.instance_method(:remove_1)
+
+      aliases = CoreDocs::MethodInfo.aliases(orig)
+      aliases.should == [copy]
+    end
+
+    it "should return aliases of private method" do
+      orig = Sample.instance_method(:gleezor_2)
+      copy = Sample.instance_method(:remove_2)
+
+      aliases = CoreDocs::MethodInfo.aliases(orig)
+      aliases.should == [copy]
+    end
+
+    it 'does not error when given a singleton method' do
+      c = Class.new do
+        def self.my_method; end
+      end
+
+      lambda { CoreDocs::MethodInfo.aliases(c.method(:my_method)) }.should.not.raise NameError
+    end
+  end
+
+  describe ".gem_root" do
+    # it "should return the path to the gem" do
+    #   path = Pry::WrappedModule.new(Sample).source_location[0]
+
+    #   CoreDocs::MethodInfo.gem_root(path).should ==
+    #     File.expand_path("gem_with_cext/gems", direc)
+    # end
+
+    it "should not be fooled by a parent 'lib' or 'ext' dir" do
+      path = "/foo/.rbenv/versions/1.9.3-p429/lib/ruby/gems/"\
+             "1.9.1/gems/activesupport-4.0.2/lib/active_support/"\
+             "core_ext/kernel/reporting.rb"
+
+      CoreDocs::MethodInfo.gem_root(path).should ==
+        "/foo/.rbenv/versions/1.9.3-p429/lib/ruby/"\
+        "gems/1.9.1/gems/activesupport-4.0.2"
+    end
+  end
+
+  describe "1.9 and higher specific docs" do
+    it "finds Kernel#require_relative" do
+      obj = CoreDocs::MethodInfo.info_for(Kernel.instance_method(:require_relative))
+      obj.should.not == nil
+    end
+  end
+
+  # For the time being, Pry doesn't define `mri_20?` helper method.
+  if RUBY_VERSION =~ /2.0/ && RbConfig::CONFIG['ruby_install_name'] == 'ruby'
+    describe "2.0 specific docs" do
+      it "finds Module#refine" do
+        obj = CoreDocs::MethodInfo.info_for(Module.instance_method(:refine))
+        obj.should.not == nil
+      end
+    end
+  end
+
+end

data/spec/gem_with_cext/gems/ext/extconf.rb

@@ -0,0 +1,2 @@
+require 'mkmf'
+create_makefile("sample")

data/spec/gem_with_cext/gems/ext/sample.c

@@ -0,0 +1,17 @@
+#include "ruby.h"
+
+static VALUE gleezor(VALUE self)
+{
+  return 1;
+}
+
+void Init_sample(void)
+{
+  VALUE klass = rb_define_class("Sample", rb_cObject);
+  VALUE A = rb_define_module_under(klass, "A");
+  VALUE B = rb_define_module_under(A, "B");
+
+  rb_define_method(klass, "gleezor", gleezor, 0);
+  rb_define_method(B, "gleezor", gleezor, 0);
+  rb_define_singleton_method(B, "gleezor", gleezor, 0);
+}

data/spec/gem_with_cext/gems/lib/sample.rb

@@ -0,0 +1,18 @@
+class Sample
+  # ruby method
+  def some_meth; end
+
+  # aliasing a C method
+  alias :remove :gleezor
+
+  protected
+
+  def gleezor_1; end
+  alias :remove_1 :gleezor_1
+
+  private
+
+  def gleezor_2; end
+
+  alias :remove_2 :gleezor_2
+end

data/spec/gem_with_cext/gems/sample.rb

@@ -0,0 +1,4 @@
+direc = File.dirname(__FILE__)
+
+require "#{direc}/ext/sample"
+require "#{direc}/lib/sample"

data/spec/helper.rb

@@ -0,0 +1,11 @@
+direc = File.dirname(__FILE__)
+
+class C
+  def message; end
+end
+
+puts
+puts "Building Sample Gem with C Extensions for testing.."
+system("cd #{direc}/gem_with_cext/gems/ext/ && ruby extconf.rb && make")
+puts
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: core_docs
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- John Mair (banisterfiend)
+- Jan Lelis (non-pry version)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: latest_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: |
+  Pry Doc is a Pry REPL plugin. It provides extended documentation support for the
+  REPL by means of improving the `show-doc` and `show-source` commands. With help
+  of the plugin the commands are be able to display the source code and the docs
+  of Ruby methods and classes implemented in C.
+  documentation
+email:
+- jrmair@gmail.com
+- mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- core_docs.gemspec
+- lib/core_docs.rb
+- lib/core_docs/core_docs_20/checksums
+- lib/core_docs/core_docs_20/object_types
+- lib/core_docs/core_docs_20/objects/root.dat
+- lib/core_docs/core_docs_20/proxy_types
+- lib/core_docs/core_docs_21/checksums
+- lib/core_docs/core_docs_21/object_types
+- lib/core_docs/core_docs_21/objects/root.dat
+- lib/core_docs/core_docs_21/proxy_types
+- lib/core_docs/core_docs_22/checksums
+- lib/core_docs/core_docs_22/object_types
+- lib/core_docs/core_docs_22/objects/root.dat
+- lib/core_docs/core_docs_22/proxy_types
+- lib/core_docs/version.rb
+- spec/core_docs_spec.rb
+- spec/gem_with_cext/gems/ext/extconf.rb
+- spec/gem_with_cext/gems/ext/sample.c
+- spec/gem_with_cext/gems/lib/sample.rb
+- spec/gem_with_cext/gems/sample.rb
+- spec/helper.rb
+homepage: https://github.com/janlelis/core_docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Provides YARD and extended documentation support for Pry
+test_files: []
+has_rdoc: