who_called_me 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 Alain Ravet
+
+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,17 @@
+= who_called_me
+
+Description goes here.
+
+== 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 Alain Ravet. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "who_called_me"
+    gem.summary     = %Q{track and list the code lines that exercise a line}
+    gem.description = %Q{track and list the code lines that exercise a line}
+    gem.email       = "alain.ravet+git@gmail.com"
+    gem.homepage    = "http://github.com/alainravet/who_called_me"
+    gem.authors     = ["Alain Ravet"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs    << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov    = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "who_called_me #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/who_called_me/array_utils.rb

@@ -0,0 +1,25 @@
+module WhoCalledMe
+  module ArrayUtils
+
+    def self.first_elements_with_common_prefix(arr, pre_len_to_ignore=0)
+      arr.each_index do |i|
+        # exclude the n first characters from the comparison <- remove them
+        arr[i] =  arr[i][pre_len_to_ignore..-1]
+      end
+
+      [].tap do |results|
+        first_line = arr.first
+        results << first_line
+        (0..arr.length-2).each do |i|
+          line, next_line = arr[i], arr[i+1]
+
+          next_line_not_in_same_code_tree = !StringUtils.common_substring?(line, next_line)
+          next_line_not_in_same_code_tree ?
+            break :
+            (results << next_line)
+        end
+      end
+    end
+
+  end
+end

data/lib/who_called_me/string_utils.rb

@@ -0,0 +1,16 @@
+module WhoCalledMe
+  module StringUtils
+
+    def self.common_substring?(a, b)
+      1 <= common_substring(a, b).length
+    end
+
+    def self.common_substring(a, b)
+      difference = a.to_str.each_char.with_index.find { |ch, idx|
+        b[idx].nil? or ch != b[idx].chr
+      }
+      difference ? b[0, difference.last] : b
+    end
+
+  end
+end

data/lib/who_called_me/trace_utils.rb

@@ -0,0 +1,11 @@
+module WhoCalledMe
+  module TraceUtils
+
+    def self.fulltrace
+      raise
+    rescue
+      $!.backtrace
+    end
+
+  end
+end

data/lib/who_called_me/who_called_me.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/string_utils'
+require File.dirname(__FILE__) + '/array_utils'
+require File.dirname(__FILE__) + '/trace_utils'
+
+module WhoCalledMe
+
+  @@__who_called_me_accumul_h = {}
+  @@__disable_puts          = false
+
+  def self.disable_puts ; @@__disable_puts = true  end
+  def self.enable_puts  ; @@__disable_puts = false end
+
+
+  def self._who_called_me(msg=nil, nof_internal_methods_to_skim=1+1) # this + _fulltrace
+    fulltrace = TraceUtils.fulltrace
+    trace = ArrayUtils.first_elements_with_common_prefix(fulltrace, 1)
+    trace = trace[nof_internal_methods_to_skim..-1]
+    trace.reverse!
+
+    record(msg || :all, trace)
+
+    trace
+  end
+
+  def self.record(key, trace)
+    @@__who_called_me_accumul_h[key] ||= []
+    @@__who_called_me_accumul_h[key] << trace
+  end
+
+
+
+  def self._who_called_me_data(options={})
+    if options[:only_top]
+      {}.tap do |result|
+        @@__who_called_me_accumul_h.each do |key, traces|
+          result[key] = traces.collect{|trace| trace.first }.uniq
+        end
+      end
+    else
+      @@__who_called_me_accumul_h
+    end
+  end
+
+
+  def self.puts_formatted_traces
+    return if _who_called_me_data.empty?
+    return if @@__disable_puts
+    l0 = '-'*99
+    puts l0
+    puts 'who_called_me report :'
+    puts '======================'
+    _who_called_me_data.keys.each do |key|
+      puts
+      puts "+----------------------------"
+      puts (key == :all) ? '| who_called_me' : "| who_called_me(#{key})"
+      puts "+----------------------------"
+      _who_called_me_data[key].each do |trace|
+        puts
+        puts trace.shift
+        puts '  was called by :'
+        padding = ''
+        trace.each do |line|
+          padding += '  '
+          puts "  .#{padding}#{line}"
+        end
+      end
+    end
+    puts
+    puts l0
+  end
+
+  # used by tests only
+  def self.reset
+    @@__who_called_me_accumul_h = {}
+    @@__disable_puts          = false
+  end
+end

data/lib/who_called_me.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/who_called_me/who_called_me.rb'
+
+module Kernel
+  def who_called_me(msg=nil)
+    nof_internal_methods_to_skim = 3  #this + WhoCalledMe._who_called_me + _fulltrace
+    WhoCalledMe._who_called_me(msg, nof_internal_methods_to_skim)
+  end
+  def who_called_me_data(options={})
+    WhoCalledMe._who_called_me_data(options)
+  end
+end
+
+at_exit do
+  if !who_called_me_data.empty?
+    WhoCalledMe.puts_formatted_traces
+  end
+end

data/spec/fixtures/foo.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/who_called_me')
+
+class Foo
+  def foo
+    bar
+  end
+  def bar
+    who_called_me
+  end
+
+  def self.point_1
+    FooFoo.point_1
+  end
+end

data/spec/fixtures/foo_foo.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/foo')
+
+class FooFoo
+  def foofoo
+    Foo.new.bar
+    Foo.new.foo
+  end
+
+  def self.point_1
+    who_called_me('point 1')
+  end
+end

data/spec/fixtures/foo_foo_caller.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/foo_foo')
+FooFoo.new.foofoo
+FooFoo.point_1
+Foo.point_1

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'who_called_me'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    WhoCalledMe.reset
+  end
+  
+end
+
+def capture_stdout
+  @@original_stdout = STDOUT
+  $stdout = StringIO.new
+end
+
+def restore_stdout
+  $stdout = @@original_stdout
+end

data/spec/who_called_me_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/foo')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/foo_foo')
+
+# Simplest call : no parameter
+#
+describe "who_called_me_data()" do
+  before { WhoCalledMe.disable_puts}
+  #don't restore in :after, because the puts happens in at_exit
+
+  before  do
+    @dir = File.dirname(__FILE__)[1..-1]
+    FooFoo.new.foofoo ; @line = __LINE__
+  end
+
+  it "who_called_me_data() returns 2 fulltraces" do
+    who_called_me_data[:all].should == [
+      ["#{@dir}/who_called_me_spec.rb:#{@line}" ,
+       "#{@dir}/fixtures/foo_foo.rb:5:in `foofoo'",
+       "#{@dir}/fixtures/foo.rb:8:in `bar'"
+      ],
+      ["#{@dir}/who_called_me_spec.rb:#{@line}" ,
+       "#{@dir}/fixtures/foo_foo.rb:6:in `foofoo'",
+       "#{@dir}/fixtures/foo.rb:5:in `foo'"       ,
+       "#{@dir}/fixtures/foo.rb:8:in `bar'"
+      ]
+    ]
+  end
+
+  it "who_called_me_data(:only_top=>true}) returns only the unique 1st lines" do
+    who_called_me_data(:only_top=>true).should ==
+      {
+        :all => ["#{@dir}/who_called_me_spec.rb:#{@line}"]
+      }
+  end
+end
+
+# call with parameter
+#   who_called_me_data('point 1')
+#
+describe "who_called_me_data('point 1')" do
+  before { WhoCalledMe.disable_puts}
+  #don't restore in :after, because the puts happens in at_exit
+
+  before  do
+    @dir = File.dirname(__FILE__)[1..-1]
+    FooFoo.point_1; @line = __LINE__
+    Foo   .point_1; @line2= __LINE__
+  end
+
+  it "who_called_me_data() returns 2 fulltraces" do
+
+    who_called_me_data.should ==
+      {
+        'point 1' => [
+                      ["#{@dir}/who_called_me_spec.rb:#{@line}" ,
+                       "#{@dir}/fixtures/foo_foo.rb:10:in `point_1'"
+                      ],
+                      ["#{@dir}/who_called_me_spec.rb:#{@line2}" ,
+                       "#{@dir}/fixtures/foo.rb:12:in `point_1'" ,
+                       "#{@dir}/fixtures/foo_foo.rb:10:in `point_1'"
+                      ]
+                    ]
+      }
+  end
+
+  it "who_called_me_data(:only_top=>true}) returns only the unique 1st lines" do
+    who_called_me_data(:only_top=>true).should ==
+      {
+        'point 1' => ["#{@dir}/who_called_me_spec.rb:#{@line }",
+                      "#{@dir}/who_called_me_spec.rb:#{@line2}"] 
+
+      }
+  end
+end

data/who_called_me.gemspec

@@ -0,0 +1,65 @@
+# 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{who_called_me}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alain Ravet"]
+  s.date = %q{2010-08-23}
+  s.description = %q{track and list the code lines that exercise a line}
+  s.email = %q{alain.ravet+git@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/who_called_me.rb",
+     "lib/who_called_me/array_utils.rb",
+     "lib/who_called_me/string_utils.rb",
+     "lib/who_called_me/trace_utils.rb",
+     "lib/who_called_me/who_called_me.rb",
+     "spec/fixtures/foo.rb",
+     "spec/fixtures/foo_foo.rb",
+     "spec/fixtures/foo_foo_caller.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/who_called_me_spec.rb",
+     "who_called_me.gemspec"
+  ]
+  s.homepage = %q{http://github.com/alainravet/who_called_me}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{track and list the code lines that exercise a line}
+  s.test_files = [
+    "spec/fixtures/foo.rb",
+     "spec/fixtures/foo_foo.rb",
+     "spec/fixtures/foo_foo_caller.rb",
+     "spec/spec_helper.rb",
+     "spec/who_called_me_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: who_called_me
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alain Ravet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: track and list the code lines that exercise a line
+email: alain.ravet+git@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/who_called_me.rb
+- lib/who_called_me/array_utils.rb
+- lib/who_called_me/string_utils.rb
+- lib/who_called_me/trace_utils.rb
+- lib/who_called_me/who_called_me.rb
+- spec/fixtures/foo.rb
+- spec/fixtures/foo_foo.rb
+- spec/fixtures/foo_foo_caller.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/who_called_me_spec.rb
+- who_called_me.gemspec
+has_rdoc: true
+homepage: http://github.com/alainravet/who_called_me
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: track and list the code lines that exercise a line
+test_files: 
+- spec/fixtures/foo.rb
+- spec/fixtures/foo_foo.rb
+- spec/fixtures/foo_foo_caller.rb
+- spec/spec_helper.rb
+- spec/who_called_me_spec.rb