reflectorr 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Christiaan Van den Poel
+
+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.rdoc

@@ -0,0 +1,121 @@
+= Reflectorr
+
+Ruby is a great and powerful language, you can do some really cool stuff. But sometimes, as a developer, you're typing some code and you are 
+at a place where you wished you had some superintelligent, real cool context-sensitive intellisense that you could use to see which method exactly 
+you can use at that place.  But we all use {vim|emacs|textmate|...} which are simple but effective editors. Although there's some completion you
+can use, it will not provide completion for some fancy module you've included, but you know it's there. 
+Sure, you can go through the documentation, but still you're not sure whether it is there or not.
+
+I find myself, from time to time, wondering "what methods can I use here?". Sure, I can fireup Rubymine and hope it's intelligent enough 
+to interpret my whole project and tell me perfectly all the methods I can use when I tab CTRL-SPACE. Most of the times, I'm disappointed 
+by the fact Im not getting what I wanted.
+
+Enter 'reflectorr', it provides one single method called 'show_methods' which you can use everywhere in your code and it returns a hash 
+containing every included module as the key and an array of methods you can call at that place where you called it.
+
+An example:
+
+    require 'pp'
+    require 'reflectorr'
+    class MyClass
+        def an_instance_method
+        end
+        def self.a_class_method
+        end
+        pp show_methods
+        def self.a_second_class_method
+        end
+    end
+
+And this will return this
+
+   {"Object"=>        ["yaml_tag_subclasses?"],
+     "PP::ObjectMixin"=>[],
+     "Kernel"=>       ["test",
+                       "callcc",
+                       "gsub",
+                       "String",
+                       "exit",
+                       "require",
+                       "trap",
+                       "proc",
+                       "`",
+                       "fork",
+                       "global_variables",
+                       "print",
+                       "chomp!",
+                       "sprintf",
+                       "Integer",
+                       "fail",
+                       "rand",
+                       "autoload?",
+                       "readlines",
+                       "catch",
+                       "exit!",
+                       "open",
+                       "gsub!",
+                       "set_trace_func",
+                       "gets",
+                       "sleep",
+                       "iterator?",
+                       "select",
+                       "autoload",
+                       "getc",
+                       "chop",
+                       "Array",
+                       "abort",
+                       "pp",
+                       "lambda",
+                       "trace_var",
+                       "method_missing",
+                       "format",
+                       "local_variables",
+                       "putc",
+                       "exec",
+                       "split",
+                       "sub",
+                       "Float",
+                       "caller",
+                       "load",
+                       "eval",
+                       "binding",
+                       "p",
+                       "chop!",
+                       "URI",
+                       "throw",
+                       "printf",
+                       "srand",
+                       "raise",
+                       "readline",
+                       "block_given?",
+                       "at_exit",
+                       "syscall",
+                       "sub!",
+                       "chomp",
+                       "scan",
+                       "loop",
+                       "untrace_var",
+                       "warn",
+                       "system",
+                       "__method__",
+                       "puts"],
+    "MyClass"=>        ["a_class_method"]} 
+
+You can see it will show for 'MyClass' only the method 'a_class_method'.  'a_second_class_method' is defined after the 'show_methods' call and isn't
+available yet.  So keep this in mind also.
+
+So have fun, I hope you'll learn from it, and find it useful.  If not, just discard this :).
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Christiaan Van den Poel. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "reflectorr"
+    gem.summary = %Q{Show me the methods}
+    gem.description = %Q{This simple gem will show you all the methods you can use at the place where you call the method 'show_methods'}
+    gem.email = "christiaan@oneye.be"
+    gem.homepage = "http://github.com/khelben/reflectorr"
+    gem.authors = ["Christiaan Van den Poel"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "reflectorr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/reflectorr.rb

@@ -0,0 +1,21 @@
+#module ShowMethods
+class Object
+  def show_methods
+    result = {}
+    is_eigenklass = self.instance_of?(Class)
+    (is_eigenklass ? self : self.class).ancestors.each do |a|
+       result[a.name]=[]
+       if is_eigenklass 
+         a.singleton_methods(false).each do |m|
+           result[a.name].push m
+         end
+       else
+         a.instance_methods(false).each do |m|
+           result[a.name].push m
+         end
+       end
+    end
+    result
+  end
+end
+#end

data/reflectorr.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{reflectorr}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christiaan Van den Poel"]
+  s.date = %q{2010-02-24}
+  s.description = %q{This simple gem will show you all the methods you can use at the place where you call the method 'show_methods'}
+  s.email = %q{christiaan@oneye.be}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/reflectorr.rb",
+     "reflectorr.gemspec",
+     "test/fixtures/first_class.rb",
+     "test/helper.rb",
+     "test/test_show_methods.rb"
+  ]
+  s.homepage = %q{http://github.com/khelben/reflectorr}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Show me the methods}
+  s.test_files = [
+    "test/test_show_methods.rb",
+     "test/helper.rb",
+     "test/fixtures/first_class.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/test/fixtures/first_class.rb

@@ -0,0 +1,24 @@
+module ShowMethods
+  module Fixtures
+    class FirstClass
+      def simple_method
+        {}
+      end
+    end
+    class SecondClass < FirstClass
+      def second_simple_method
+        ""
+      end
+    end
+    class ThirdClass
+      def self.third_method
+        ""
+      end
+    end
+    class FourthClass < ThirdClass
+      def self.fourth_method
+
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'reflectorr'
+# require everything in the 'fixtures/*' folders
+Dir[File.dirname(__FILE__) + "/fixtures/**/*.rb"].each do |f|
+  require f
+end
+
+class Test::Unit::TestCase
+end

data/test/test_show_methods.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+class TestShowMethods < Test::Unit::TestCase
+  context "instance methods" do
+    context "simple_methods" do
+      should "show the method" do
+        result = ShowMethods::Fixtures::FirstClass.new.send(:show_methods)
+        assert result.is_a?(Hash), "Result should be an Hash"
+        "ShowMethods::Fixtures::FirstClass".tap do |m|
+          assert result.has_key?(m), "the module ShowMethods should be a key in the result hash"
+          assert_contains result[m], "simple_method", "the method 'simple_method' should be in the result"
+        end
+      end
+    end
+
+    context "subclass" do
+      should "show methods of superclass" do
+        result = ShowMethods::Fixtures::SecondClass.new.send(:show_methods)
+        assert result.is_a?(Hash), "Result should be an Hash"
+        "ShowMethods::Fixtures::SecondClass".tap do |m|
+          assert result.has_key?(m)
+          assert_contains result[m], "second_simple_method"
+        end
+        "ShowMethods::Fixtures::FirstClass".tap do |m|
+          assert result.has_key?(m), "the module ShowMethods should be a key in the result hash"
+          assert_contains result[m], "simple_method", "the method 'simple_method' should be in the result"
+        end
+      end
+    end
+  end
+  context "class methods" do
+    context "third_method" do
+      should "show the method" do
+        result = ShowMethods::Fixtures::ThirdClass.send(:show_methods)
+        "ShowMethods::Fixtures::ThirdClass".tap do |m|
+          assert result.has_key?(m)
+          assert_contains result[m], "third_method"
+        end
+      end
+    end
+    context "subclass" do
+      should "show class methods from FourthClass and ThirdClass" do
+         result = ShowMethods::Fixtures::FourthClass.send(:show_methods)
+         "ShowMethods::Fixtures::FourthClass".tap do |m|
+           assert result.has_key?(m)
+           assert_contains result[m], "fourth_method"
+         end
+         "ShowMethods::Fixtures::ThirdClass".tap do |m|
+           assert result.has_key?(m)
+           assert_contains result[m], "third_method"
+         end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: reflectorr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christiaan Van den Poel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This simple gem will show you all the methods you can use at the place where you call the method 'show_methods'
+email: christiaan@oneye.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/reflectorr.rb
+- reflectorr.gemspec
+- test/fixtures/first_class.rb
+- test/helper.rb
+- test/test_show_methods.rb
+has_rdoc: true
+homepage: http://github.com/khelben/reflectorr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Show me the methods
+test_files: 
+- test/test_show_methods.rb
+- test/helper.rb
+- test/fixtures/first_class.rb