impl 1.0

data/README.md

@@ -0,0 +1,27 @@
+# impl: What's the implementation of a Ruby method?
+
+## Usage
+
+    $ cd ~/git/ruby193
+    $ ctags -R
+    $ impl >> tags
+
+After moving into the latest Ruby source code directory of you, the first command builds `tags` by the Ruby C source codes, using your own `ctags` command. Then impl extracts Ruby methods both from the source codes and the `tags` file. The command outputs additional tags to STDOUT, so you may want to redirect to `tags` for appending them.
+
+Now you can go into the definition of a Ruby method by Ruby method format like `Random#rand`!
+
+Higher level handy command is also available. The following command does almost equivalent to the three command previously I showed.
+
+    $ impl --suite ~/git/ruby193
+
+## Install
+
+    $ gem install impl
+
+## Author
+
+Tatsuhiro Ujihisa
+
+## Trivia
+
+`tags` is an all left handed word. `impl` is an all right handed word. If you are a dvorak user, you can type them easily.

data/Rakefile

@@ -0,0 +1,16 @@
+require "rspec/core/rake_task"
+require "rake/gempackagetask"
+
+task :default => :spec
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+	t.rspec_opts = %w[--color]
+	t.verbose = false
+end
+
+desc "Create the .gem package"
+$gemspec = eval("#{File.read('impl.gemspec')}")
+Rake::GemPackageTask.new($gemspec) do |pkg|
+	pkg.need_tar = true
+end

data/bin/impl

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'impl'
+case ARGV.shift
+when '-h'
+  puts Impl.help
+when '--suite'
+  Dir.chdir(File.expand_path(ARGV.shift)) do
+    additional = `#{__FILE__}`
+    File.open('tags', 'a') {|io| io.puts additional }
+  end
+else
+  ctags = File.read('tags')
+  dir = File.expand_path '.'
+  puts Impl.generate(ctags, dir)
+end
+# vim: set ft=ruby :

data/impl.gemspec

@@ -0,0 +1,29 @@
+require File.expand_path('../lib/impl', __FILE__)
+Gem::Specification.new do |s|
+  s.name = %q{impl}
+  s.version = Impl::VERSION.dup
+  s.date = Time.now.strftime('%Y-%m-%d')
+
+  s.summary = %q{What's the implementation of a Ruby method?}
+  s.description = %q{generates additional information for Ruby C implementation's method definitions}
+
+  s.author = 'ujihisa'
+  s.email  = %q{ujihisa at gmail.com}
+
+  s.files =
+    Dir['lib/**/*'] +
+    Dir['bin/**/*'] +
+    Dir['spec/**/*'] +
+    %w{ impl.gemspec Rakefile README.md }
+
+  s.require_paths = ["lib"]
+  s.executables = ['impl']
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.homepage = %q{https://github.com/ujihisa/impl}
+
+  s.extra_rdoc_files = %w< README.md >
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+end

data/lib/impl.rb

@@ -0,0 +1,35 @@
+module Impl
+  VERSION = '1.0'
+
+  def generate(ctags, dir)
+    memo = []
+    Dir.glob(dir + '/**/*.c') do |f|
+      File.read(f).each_line do |line|
+        if /^\s*rb_define_(singleton_)?(?:private_)?method\(rb_.(.*?),\s*"(.*?)",\s*(\w+),(?#\))/ =~ line
+          is_singleton, klass, method, func = [!!$1, $2, $3, $4]
+          fullmethod = [klass, is_singleton ? '.' : '#', method].join
+          ctags.scan(/^#{func}\t(.*)/) do |x|
+            memo << "#{fullmethod}\t#{x[0]}"
+          end
+        end
+      end
+    end
+    memo
+  end
+  module_function :generate
+
+  def help
+    <<-EOH
+    impl version #{VERSION}
+
+    USAGE
+      impl -h: shows this message
+      impl:    shows additional information, assuming you already have |tags|
+               and Ruby codes in the current directory.
+      impl --suite {directory}:
+               generates new |tags| file in {directory} using files in
+               {directory}.
+    EOH
+  end
+  module_function :help
+end

data/spec/impl_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/impl'
+
+describe Impl do
+  describe '.generate' do
+    context 'with a tag file and a repository dir' do
+      it 'returns strings of additional information like Random#rand, ' +
+        'assuming the ruby source code repo is in ~/git/ruby193' do
+        dir = File.expand_path('~/git/ruby193')
+        ctags = File.read(dir + '/tags')
+        Impl.generate(ctags, dir).should be_include 'Random#rand	random.c	/^random_rand(int argc, VALUE *argv, VALUE obj)$/;"	f	file:'
+      end
+    end
+  end
+
+  describe '.help' do
+    it 'returns help message' do
+      Impl.help.should be_include 'USAGE'
+    end
+  end
+end
+
+#describe 'bin/impl' do
+# rb_define_singleton_method(rb_vm_top_self(), "to_s", main_to_s, 0);

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: impl
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- ujihisa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: generates additional information for Ruby C implementation's method definitions
+email: ujihisa at gmail.com
+executables: 
+- impl
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/impl.rb
+- bin/impl
+- spec/impl_spec.rb
+- impl.gemspec
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: https://github.com/ujihisa/impl
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: What's the implementation of a Ruby method?
+test_files: []
+