code 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a7b939fc81c175fd4e2b1f0b1c80c48c0b0581c
+  data.tar.gz: 8bf7922b9a0248111210ffb31a291af4c46df40f
+SHA512:
+  metadata.gz: cbf364a3586ae292ca1bd595f4e5100c911f6b2461f993384dd9b2576b07c6fd9d6430e3f2cf3b2593ac84aadbc68d83a84bfbcfae68e1c15535fdc6f35d9a5e
+  data.tar.gz: 2e5b379b87ca8bf7d5260899fe33fdd826c375063865a4b9a63dd58b850ee37b39318058ad64a4f17fb22744a82841f5d149d8f1fbd1d7ad13e011ce72168e48

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## CHANGELOG
+
+### 0.9.0
+
+* Inital release
+

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jan Lelis, mail@janlelis.de
+
+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.md

@@ -0,0 +1,162 @@
+# code [![[version]](https://badge.fury.io/rb/code.svg)](http://badge.fury.io/rb/code)
+
+Shows a method's code with syntax highlighting. Tries to find the Ruby definition of method first, then falls back to the C version (if the `core_docs` gem is available).
+
+## Setup
+
+```
+gem install code core_docs
+```
+
+
+## Usage
+
+```ruby
+# in /home/jan/.rvm/rubies/ruby-2.2.1/lib/ruby/site_ruby/2.2.0/rubygems/core_ext/kernel_require.rb:38
+##
+# When RubyGems is required, Kernel#require is replaced with our own which
+# is capable of loading gems on demand.
+#
+# When you call <tt>require 'x'</tt>, this is what happens:
+# * If the file can be loaded from the existing Ruby loadpath, it
+#   is.
+# * Otherwise, installed gems are searched for a file that matches.
+#   If it's found in gem 'y', that gem is activated (added to the
+#   loadpath).
+#
+# The normal <tt>require</tt> functionality of returning false if
+# that file has already been loaded is preserved.
+def require path
+  RUBYGEMS_ACTIVATION_MONITOR.enter
+
+  path = path.to_path if path.respond_to? :to_path
+
+  spec = Gem.find_unresolved_default_spec(path)
+  if spec
+    Gem.remove_unresolved_default_spec(spec)
+    gem(spec.name)
+  end
+
+  # If there are no unresolved deps, then we can use just try
+  # normal require handle loading a gem from the rescue below.
+
+  if Gem::Specification.unresolved_deps.empty? then
+    RUBYGEMS_ACTIVATION_MONITOR.exit
+    return gem_original_require(path)
+  end
+
+  # If +path+ is for a gem that has already been loaded, don't
+  # bother trying to find it in an unresolved gem, just go straight
+  # to normal require.
+  #--
+  # TODO request access to the C implementation of this to speed up RubyGems
+
+  spec = Gem::Specification.stubs.find { |s|
+    s.activated? and s.contains_requirable_file? path
+  }
+
+  begin
+    RUBYGEMS_ACTIVATION_MONITOR.exit
+    return gem_original_require(spec.to_fullpath(path) || path)
+  end if spec
+
+  # Attempt to find +path+ in any unresolved gems...
+
+  found_specs = Gem::Specification.find_in_unresolved path
+
+  # If there are no directly unresolved gems, then try and find +path+
+  # in any gems that are available via the currently unresolved gems.
+  # For example, given:
+  #
+  #   a => b => c => d
+  #
+  # If a and b are currently active with c being unresolved and d.rb is
+  # requested, then find_in_unresolved_tree will find d.rb in d because
+  # it's a dependency of c.
+  #
+  if found_specs.empty? then
+    found_specs = Gem::Specification.find_in_unresolved_tree path
+
+    found_specs.each do |found_spec|
+      found_spec.activate
+    end
+
+  # We found +path+ directly in an unresolved gem. Now we figure out, of
+  # the possible found specs, which one we should activate.
+  else
+
+    # Check that all the found specs are just different
+    # versions of the same gem
+    names = found_specs.map(&:name).uniq
+
+    if names.size > 1 then
+      RUBYGEMS_ACTIVATION_MONITOR.exit
+      raise Gem::LoadError, "#{path} found in multiple gems: #{names.join ', '}"
+    end
+
+    # Ok, now find a gem that has no conflicts, starting
+    # at the highest version.
+    valid = found_specs.select { |s| s.conflicts.empty? }.last
+
+    unless valid then
+      le = Gem::LoadError.new "unable to find a version of '#{names.first}' to activate"
+      le.name = names.first
+      RUBYGEMS_ACTIVATION_MONITOR.exit
+      raise le
+    end
+
+    valid.activate
+  end
+
+  RUBYGEMS_ACTIVATION_MONITOR.exit
+  return gem_original_require(path)
+rescue LoadError => load_error
+  RUBYGEMS_ACTIVATION_MONITOR.enter
+
+  if load_error.message.start_with?("Could not find") or
+      (load_error.message.end_with?(path) and Gem.try_activate(path)) then
+    RUBYGEMS_ACTIVATION_MONITOR.exit
+    return gem_original_require(path)
+  else
+    RUBYGEMS_ACTIVATION_MONITOR.exit
+  end
+
+  raise load_error
+end
+```
+
+```c
+>> Code.for File, :open #=> nil
+// in io.c:6219
+// call-seq:
+//    IO.open(fd, mode="r" [, opt])                -> io
+//    IO.open(fd, mode="r" [, opt]) { |io| block } -> obj
+// 
+// With no associated block, <code>IO.open</code> is a synonym for IO.new.  If
+// the optional code block is given, it will be passed +io+ as an argument,
+// and the IO object will automatically be closed when the block terminates.
+// In this instance, IO.open returns the value of the block.
+// 
+// See IO.new for a description of the +fd+, +mode+ and +opt+ parameters.
+static VALUE
+rb_io_s_open(int argc, VALUE *argv, VALUE klass)
+{
+    VALUE io = rb_class_new_instance(argc, argv, klass);
+
+    if (rb_block_given_p()) {
+	return rb_ensure(rb_yield, io, io_close, io);
+    }
+
+    return io;
+}
+
+```
+
+## Goal
+
+Be as powerful as pry's source browsing: https://github.com/pry/pry/wiki/Source-browsing
+
+
+## MIT License
+
+Copyright (C) 2015 Jan Lelis <http://janlelis.com>. Released under the MIT license.

data/Rakefile

@@ -0,0 +1,30 @@
+# # #
+# Get gemspec info
+
+gemspec_file = Dir['*.gemspec'].first 
+gemspec = eval File.read(gemspec_file), binding, gemspec_file
+info = "#{gemspec.name} | #{gemspec.version} | " \
+       "#{gemspec.runtime_dependencies.size} dependencies | " \
+       "#{gemspec.files.size} files"
+
+
+# # #
+# Gem build and install task
+
+desc info
+task :gem do
+  puts info + "\n\n"
+  print "  "; sh "gem build #{gemspec_file}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  puts; sh %{gem install --no-document pkg/#{gemspec.name}-#{gemspec.version}.gem}
+end
+
+
+# # #
+# Start an IRB session with the gem loaded
+
+desc "#{gemspec.name} | IRB"
+task :irb do
+  sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
+end

data/code.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/code/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "code"
+  gem.version       = Code::VERSION
+  gem.summary       = "Displays a method's code."
+  gem.description   = "Displays a method's code (from source or docs)."
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = "mail@janlelis.de"
+  gem.homepage      = "https://github.com/janlelis/code"
+  gem.license       = "MIT"
+
+  gem.files         = Dir['{**/}{.*,*}'].select{ |path| File.file?(path) && path !~ /^pkg/ }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = "~> 2.0"
+  gem.add_dependency "method_source", "~> 0.8", ">= 0.8.2"
+  gem.add_dependency "coderay", "~> 1.1"
+end

data/lib/code.rb

@@ -0,0 +1,60 @@
+require_relative "code/version"
+
+require 'method_source'
+require 'coderay'
+
+begin
+  require 'core_docs'
+rescue LoadError
+end
+
+
+module Code
+  class NotFound < StandardError
+  end
+
+  # API for end user
+  def self.for(object = self, method_name)
+    m = object.method(method_name)
+    begin
+      from_ruby(m)
+    rescue MethodSource::SourceNotFoundError
+      from_docs(m)
+    end
+  rescue NameError, NotFound
+    warn $!.message
+  end
+
+  # Syntax highlight code string
+  def self.display(string, language = :ruby)
+    puts CodeRay.scan(string, language).term
+  end
+
+  # Find Ruby definition of code
+  def self.from_ruby(m)
+    source   = m.source || ""
+    indent   = source.match(/\A +/)
+    source   = source.gsub(/^#{indent}/,"")
+    comment  = m.comment && !m.comment.empty? ? "#{ m.comment }" : ""
+    location = m.source_location ? "# in #{ m.source_location*':' }\n" : ""
+
+    display location + comment + source
+  end
+
+  # Find C definition of Code
+  def self.from_docs(m)
+    if RUBY_ENGINE != "ruby"
+      raise Code::NotFound, "Method source not found for non-CRuby."
+    elsif !defined?(CoreDocs)
+      raise Code::NotFound, 'Method source not found. Might be possible with core_docs gem'
+    elsif !(method_info = CoreDocs::MethodInfo.info_for(m))
+      raise Code::NotFound, 'Method source not found.'
+    else
+      source = method_info.source
+      location = "// in #{method_info.file}:#{method_info.line}\n"
+      comment = method_info.docstring ?  method_info.docstring.gsub(/^/, '// ') + "\n" : ""
+
+      display location + comment + source, :c
+    end
+  end
+end

data/lib/code/version.rb

@@ -0,0 +1,5 @@
+module Code
+  VERSION = "0.9.0".freeze
+end
+
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: code
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Displays a method's code (from source or docs).
+email: mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- code.gemspec
+- lib/code.rb
+- lib/code/version.rb
+homepage: https://github.com/janlelis/code
+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: Displays a method's code.
+test_files: []
+has_rdoc: