rbx-linecache 1.2-universal-rubinius-1.2 → 1.4-universal-rubinius-1.2

data/NEWS

@@ -1,3 +1,12 @@
+1.4
+- static_scope -> constant_scope to rubinius 2.0.rc1
+
+1.3
+- CompiledMethod#lines tuple changes and allow rubinius 2.0.pre
+
+1.2
+- Add CompiledMethod caching.
+
 1.1.1
 March 15, 2011
 - Cache compiled methods for rbx-trepanning
@@ -10,14 +19,14 @@ December 25, 2010
 - Handle Rubinius eval_source to temp file remapping.
 
 October 27, 2010
-- First gemcutter rubinius release 
+- First gemcutter rubinius release
 
 
 0.43
 06-12-08
 - tolerance for finding windows extension in lib rather than ext.
 
-0.41 
+0.41
 - add test/data/* to gem.
 
 0.4
@@ -26,18 +35,17 @@ October 27, 2010
 0.3
 - Add tracelines: get line numbers that can be stopped at.
 
-- Add routines to allow line-number 
-  remapping and filename remapping. 
+- Add routines to allow line-number
+  remapping and filename remapping.
 
 - Add access methods to get the number of lines in a file.
 
 0.2
 - Make this work with ruby-debug-base. Add reload-on-change parameters.
-  add checkcache, cache, cached? sha1, and stat methods. 
-  
+  add checkcache, cache, cached? sha1, and stat methods.
+
 - Use SCRIPT_LINES__.
 
 0.1
 
 - Initial release of LineCache, a module for reading and caching lines.
-

data/README

@@ -1,6 +1,4 @@
-= LineCache - A module to read and cache file information of a Ruby program.
-
-== SYNOPSIS
+## LineCache - A module to read and cache file information of a Ruby program.
 
 The LineCache module allows one to get any line from any file, caching
 the lines and file information on first access to the file. Although
@@ -12,39 +10,37 @@ The routines here may be is useful when a small random sets of lines
 are read from a single file, in particular in a debugger to show
 source lines.
 
-== Summary
+## Summary
 
-  require 'linecache'
-  lines = LineCache::getlines('/tmp/myruby.rb')
-  # The following lines have same effect as the above.
-  $: << '/tmp'
-  Dir.chdir('/tmp') {lines = LineCache::getlines('myruby.rb')
+    require 'linecache'
+    lines = LineCache::getlines('/tmp/myruby.rb')
+    # The following lines have same effect as the above.
+    $: << '/tmp'
+    Dir.chdir('/tmp') {lines = LineCache::getlines('myruby.rb')
 
-  line = LineCache::getline('/tmp/myruby.rb', 6)
-  # Note lines[6] == line (if /tmp/myruby.rb has 6 lines)
+    line = LineCache::getline('/tmp/myruby.rb', 6)
+    # Note lines[6] == line (if /tmp/myruby.rb has 6 lines)
 
-  LineCache::clear_file_cache
-  LineCache::clear_file_cache('/tmp/myruby.rb')
-  LineCache::update_cache   # Check for modifications of all cached files.
+    LineCache::clear_file_cache
+    LineCache::clear_file_cache('/tmp/myruby.rb')
+    LineCache::update_cache   # Check for modifications of all cached files.
 
-== Credits
+## Credits
 
   This is a port of the module of the same name from the Python distribution.
 
   The idea for how TraceLineNumbers works, and some code was taken
   from ParseTree by Ryan Davis.
 
-== Other stuff
+## Other stuff
 
 Author::   Rocky Bernstein <rockyb@rubyforge.net>
-License::  Copyright (c) 2007, 2008 Rocky Bernstein
+License::  Copyright (c) 2007, 2008, 2013 Rocky Bernstein
            Released under the GNU GPL 2 license
 
-== Warranty
+## Warranty
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
-
-$Id: README 169 2009-02-08 17:19:33Z rockyb $

data/Rakefile

@@ -1,15 +1,13 @@
 #!/usr/bin/env rake
-# Are we Rubinius? We'll test by checking the specific function we need.
-raise RuntimeError, 'This package is for Rubinius 1.2.x only!' unless
-  Object.constants.include?('Rubinius') && 
-  Rubinius.constants.include?('VM') && 
-  Rubinius::VERSION =~ /1\.2.+/
-
+# -*- Ruby -*-
+# Are we Rubinius? The right versions of it?
+raise RuntimeError,
+'This package is for Rubinius 1.2.[34] or 2.0.x only!' unless
+  Object.constants.include?('Rubinius') &&
+  Rubinius.constants.include?('VM') &&
+  Rubinius::VERSION =~ /1\.2\.[34]/ || Rubinius::VERSION =~ /2\.0/
 
 require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/testtask'
 
 ROOT_DIR = File.dirname(__FILE__)
 Gemspec_filename = 'rbx-linecache.gemspec'
@@ -19,28 +17,80 @@ def gemspec
   @gemspec ||= eval(File.read(Gemspec_filename), binding, Gemspec_filename)
 end
 
+require 'rubygems/package_task'
 desc "Build the gem"
 task :package=>:gem
 task :gem=>:gemspec do
   Dir.chdir(ROOT_DIR) do
     sh "gem build #{Gemspec_filename}"
     FileUtils.mkdir_p 'pkg'
-    FileUtils.mv("#{gemspec.file_name}", "pkg/")
+    FileUtils.mv gemspec.file_name, 'pkg'
+
+    # Now make a 2.0 package by changing 1.2 to 2.0 in the gemspec
+    # and creating another gemspec and moving that accordingly
+    lines = File.open(Gemspec_filename).readlines.map{|line|
+      line.gsub(/'universal', 'rubinius', '1\.2'/,
+                "'universal', 'rubinius', '2.0'");
+    }
+
+    two_filename = gemspec.file_name.gsub(/1\.2/, '2.0')
+    gemspec_filename2 = "rbx-linecache2.gemspec"
+    f = File.open(gemspec_filename2, "w")
+    f.write(lines); f.close
+    sh "gem build #{gemspec_filename2}"
+    FileUtils.mv("#{two_filename}", "pkg/")
   end
 end
 
-task :default => [:test]
-
 desc 'Install the gem locally'
-task :install => :package do
+task :install => :gem do
   Dir.chdir(ROOT_DIR) do
     sh %{gem install --local pkg/#{gemspec.file_name}}
   end
-end    
+end
+
+require 'rake/testtask'
+desc "Test everything."
+Rake::TestTask.new(:test) do |t|
+  t.libs << './lib'
+  t.pattern = 'test/test-*.rb'
+  t.verbose = true
+end
+task :test => :lib
+
+desc "same as test"
+task :check => :test
+
+require 'rbconfig'
+def RbConfig.ruby
+  File.join(RbConfig::CONFIG['bindir'],
+            RbConfig::CONFIG['RUBY_INSTALL_NAME'] +
+            RbConfig::CONFIG['EXEEXT'])
+end unless defined? RbConfig.ruby
+
+def run_standalone_ruby_files(list, opts={})
+  puts '*' * 40
+  list.each do |ruby_file|
+    system(RbConfig.ruby, ruby_file)
+    p $?.exitstatus
+    break if $?.exitstatus != 0 && !opts[:continue]
+  end
+end
 
-desc "Create a GNU-style ChangeLog via svn2cl"
+def run_standalone_ruby_file(directory, opts={})
+  puts(('*' * 10) + ' ' + directory + ' ' + ('*' * 10))
+  Dir.chdir(directory) do
+    Dir.glob('*.rb').each do |ruby_file|
+      puts(('-' * 20) + ' ' + ruby_file + ' ' + ('-' * 20))
+      system(RbConfig.ruby, ruby_file)
+      break if $?.exitstatus != 0 && !opts[:continue]
+    end
+  end
+end
+
+desc 'Create a GNU-style ChangeLog via git2cl'
 task :ChangeLog do
-  system("svn2cl --authors=svn2cl_usermap")
+  system('git log --pretty --numstat --summary | git2cl > ChangeLog')
 end
 
 desc 'Test units - the smaller tests'
@@ -50,17 +100,21 @@ Rake::TestTask.new(:'test') do |t|
   t.options = '--verbose' if $VERBOSE
 end
 
+desc "Default action is same as 'test'."
+task :default => :test
+
 desc "Generate the gemspec"
 task :generate do
   puts gemspec.to_ruby
 end
 
-desc "Validate the gemspec"
+desc 'Validate the gemspec'
 task :gemspec do
   gemspec.validate
 end
 
 # ---------  RDoc Documentation ------
+require 'rdoc/task'
 desc "Generate rdoc documentation"
 Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'
@@ -68,16 +122,27 @@ Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_files.include(%w(lib/*.rb))
 end
 
-desc "Same as rdoc"
+desc 'Same as rdoc'
 task :doc => :rdoc
 
 task :clobber_package do
-  FileUtils.rm_rf File.join(ROOT_DIR, 'pkg')
+  FileUtils.rm_rf File.join(ROOT_DIR, 'pkg'), :verbose => true
 end
 
 task :clobber_rdoc do
-  FileUtils.rm_rf File.join(ROOT_DIR, 'doc')
+  FileUtils.rm_rf File.join(ROOT_DIR, 'doc'), :verbose => true
+end
+
+desc 'Remove residue from running patch'
+task :rm_patch_residue do
+  FileUtils.rm_rf Dir.glob('**/*.{rej,orig}'), :verbose => true
+end
+
+desc 'Remove ~ backup files'
+task :rm_tilde_backups do
+  FileUtils.rm_rf Dir.glob('**/*~'), :verbose => true
 end
 
-desc "Remove built files"
-task :clean => [:clobber_package, :clobber_rdoc]
+desc 'Remove built files'
+task :clean => [:clobber_package, :clobber_rdoc, :rm_patch_residue,
+                :rm_tilde_backups]

data/lib/linecache.rb

@@ -21,12 +21,12 @@
 # Author::    Rocky Bernstein  (mailto:rockyb@rubyforge.net)
 #
 # = linecache
-# A module to read and cache lines of a Ruby program. 
+# A module to read and cache lines of a Ruby program.
 
 # == SYNOPSIS
 #
 # The LineCache module allows one to get any line from any file,
-# caching lines of the file on first access to the file. Although the 
+# caching lines of the file on first access to the file. Although the
 # file may be any file, the common use is when the file is a Ruby
 # script since parsing of the file is done to figure out where the
 # statement boundaries are.
@@ -62,22 +62,22 @@ require 'require_relative'
 require_relative 'tracelines'
 
 # = module LineCache
-# A module to read and cache lines of a Ruby program. 
+# A module to read and cache lines of a Ruby program.
 module LineCache
-  VERSION = '1.2'
-  LineCacheInfo = Struct.new(:stat, :line_numbers, :lines, :path, 
+  VERSION = '1.4'
+  LineCacheInfo = Struct.new(:stat, :line_numbers, :lines, :path,
                              :sha1, :compiled_method) unless
     defined?(LineCacheInfo)
- 
-  # The file cache. The key is a name as would be given by Ruby for 
-  # __FILE__. The value is a LineCacheInfo object. 
-  @@file_cache = {} 
-  @@script_cache = {} 
+
+  # The file cache. The key is a name as would be given by Ruby for
+  # __FILE__. The value is a LineCacheInfo object.
+  @@file_cache = {}
+  @@script_cache = {}
 
 
   # Used for CodeRay syntax highlighting
   @@ruby_highlighter = nil
-  
+
   # Maps a string filename (a String) to a key in @@file_cache (a
   # String).
   #
@@ -90,10 +90,10 @@ module LineCache
   # Another related use is when a template system is used.  Here we'll
   # probably want to remap not only the file name but also line
   # ranges. Will probably use this for that, but I'm not sure.
-  @@file2file_remap = {} 
+  @@file2file_remap = {}
   @@file2file_remap_lines = {}
 
-  @@script2file = {} 
+  @@script2file = {}
 
   module_function
 
@@ -104,10 +104,10 @@ module LineCache
   end
   at_exit { remove_script_temps }
 
-  
+
   # Clear the file cache entirely.
   def clear_file_cache(filename=nil)
-    if filename 
+    if filename
       if @@file_cache[filename]
         @@file_cache.delete(filename)
       end
@@ -120,7 +120,7 @@ module LineCache
 
   # Remove syntax-formatted lines in the cache. Use this
   # when you change the CodeRay syntax or Token formatting
-  # and want to redo how files may have previously been 
+  # and want to redo how files may have previously been
   # syntax marked.
   def clear_file_format_cache
     @@file_cache.each_pair do |fname, cache_info|
@@ -165,7 +165,7 @@ module LineCache
         cache_info = @@file_cache[filename].stat
         stat = File.stat(path)
         if cache_info
-          if stat && 
+          if stat &&
               (cache_info.size != stat.size or cache_info.mtime != stat.mtime)
             result << filename
             update_cache(filename, opts)
@@ -214,12 +214,12 @@ module LineCache
       nil
     end
   end
-      
+
   # Return true if file_or_script is cached
   def cached?(file_or_script)
-    if file_or_script.kind_of?(String) 
+    if file_or_script.kind_of?(String)
       @@file_cache.member?(map_file(file_or_script))
-    else 
+    else
       cached_script?(file_or_script)
     end
   end
@@ -227,7 +227,7 @@ module LineCache
   def cached_script?(script)
       @@script_cache.member?(script)
   end
-      
+
   def empty?(filename)
     filename=map_file(filename)
     !!@@file_cache[filename].lines[:plain]
@@ -236,16 +236,16 @@ module LineCache
   # Get line +line_number+ from file named +filename+. Return nil if
   # there was a problem. If a file named filename is not found, the
   # function will look for it in the $: array.
-  # 
+  #
   # Examples:
-  # 
+  #
   #  lines = LineCache::getline('/tmp/myfile.rb')
   #  # Same as above
   #  $: << '/tmp'
   #  lines = LineCache.getlines('myfile.rb')
   #
   def getline(file_or_script, line_number, opts={})
-    lines = 
+    lines =
       if file_or_script.kind_of?(String)
         filename = map_file(file_or_script)
         filename, line_number = map_file_line(filename, line_number)
@@ -265,7 +265,7 @@ module LineCache
   # if we can't get lines
   def script_getlines(script, opts={})
     format = opts[:output] || :plain
-    line_formats = 
+    line_formats =
       if @@script_cache.member?(script)
         @@script_cache[script].lines
       else
@@ -294,7 +294,7 @@ module LineCache
     if @@file_cache.member?(filename)
       lines = @@file_cache[filename].lines
       if opts[:output] && !lines[format]
-        lines[format] = 
+        lines[format] =
           highlight_string(lines[:plain].join(''), format).split(/\n/)
       end
       return lines[format]
@@ -337,7 +337,7 @@ module LineCache
   def remap_file_lines(from_file, to_file, range, start)
     range = (range..range) if range.kind_of?(Fixnum)
     to_file = from_file unless to_file
-    if @@file2file_remap_lines[to_file] 
+    if @@file2file_remap_lines[to_file]
       # FIXME: need to check for overwriting ranges: whether
       # they intersect or one encompasses another.
       @@file2file_remap_lines[to_file] << [from_file, range, start]
@@ -346,11 +346,11 @@ module LineCache
     end
   end
   module_function :remap_file_lines
-  
+
   # Return any compiled method saved for a filename.
   def compiled_method(filename)
     if (file = map_file(filename)) && @@file_cache[file]
-      return @@file_cache[file].compiled_method 
+      return @@file_cache[file].compiled_method
     else
       return nil
     end
@@ -360,7 +360,7 @@ module LineCache
   def sha1(filename)
     filename = map_file(filename)
     return nil unless @@file_cache.member?(filename)
-    return @@file_cache[filename].sha1.hexdigest if 
+    return @@file_cache[filename].sha1.hexdigest if
       @@file_cache[filename].sha1
     sha1 = Digest::SHA1.new
     @@file_cache[filename].lines[:plain].each do |line|
@@ -369,7 +369,7 @@ module LineCache
     @@file_cache[filename].sha1 = sha1
     sha1.hexdigest
   end
-      
+
   # Return the number of lines in filename
   def size(file_or_script)
     cache(file_or_script)
@@ -399,21 +399,21 @@ module LineCache
     return nil unless fullname
     e = @@file_cache[filename]
     unless e.line_numbers
-      e.line_numbers = 
+      e.line_numbers =
         TraceLineNumbers.lnums_for_str_array(e.lines[:plain])
       e.line_numbers = false unless e.line_numbers
     end
     e.line_numbers
   end
-    
+
   def map_file(file)
     @@file2file_remap[file] ? @@file2file_remap[file] : file
   end
 
   def map_script(script)
-    if @@script2file[script] 
-      @@script2file[script] 
-    else 
+    if @@script2file[script]
+      @@script2file[script]
+    else
       # Doc says there's new takes an optional string parameter
       # But it doesn't work for me
       sha1 = Digest::SHA1.new
@@ -431,8 +431,8 @@ module LineCache
     if @@file2file_remap_lines[file]
       @@file2file_remap_lines[file].each do |from_file, range, start|
         if range === line
-          from_file = from_file || file 
-          return [from_file, start+line-range.begin] 
+          from_file = from_file || file
+          return [from_file, start+line-range.begin]
         end
       end
     end
@@ -444,15 +444,15 @@ module LineCache
   end
 
   # Update a cache entry.  If something is wrong, return nil. Return
-  # true if the cache was updated and false if not. 
+  # true if the cache was updated and false if not.
   def update_script_cache(script, opts)
     return false unless script_is_eval?(script)
     string = opts[:string] || script.eval_source
     lines = {:plain => string.split(/\n/)}
     lines[opts[:output]] = highlight_string(string, opts[:output]) if
       opts[:output]
-    @@script_cache[script] = 
-      LineCacheInfo.new(nil, nil, lines, nil, opts[:sha1], 
+    @@script_cache[script] =
+      LineCacheInfo.new(nil, nil, lines, nil, opts[:sha1],
                         opts[:compiled_method])
     return true
   end
@@ -466,7 +466,7 @@ module LineCache
 
     @@file_cache.delete(filename)
     path = File.expand_path(filename)
-    
+
     if File.exist?(path)
       stat = File.stat(path)
     elsif File.basename(filename) == filename
@@ -487,15 +487,15 @@ module LineCache
       fp.rewind
       lines = {:plain => fp.readlines}
       fp.close()
-      lines[opts[:output]] = 
-        highlight_string(raw_string, opts[:output]).split(/\n/) if 
+      lines[opts[:output]] =
+        highlight_string(raw_string, opts[:output]).split(/\n/) if
         opts[:output]
-    rescue 
+    rescue
       ##  print '*** cannot open', path, ':', msg
       return nil
     end
-    @@file_cache[filename] = 
-      LineCacheInfo.new(File.stat(path), nil, lines, path, nil, 
+    @@file_cache[filename] =
+      LineCacheInfo.new(File.stat(path), nil, lines, path, nil,
                         opts[:compiled_method])
     @@file2file_remap[path] = filename
     return true
@@ -503,15 +503,15 @@ module LineCache
 end
 
 # example usage
-if __FILE__ == $0 
-  def yes_no(var) 
+if __FILE__ == $0
+  def yes_no(var)
     return var ? "" : "not "
   end
 
   lines = LineCache::getlines(__FILE__)
   puts "#{__FILE__} has #{LineCache.size(__FILE__)} lines"
   line = LineCache::getline(__FILE__, 6)
-  puts "The 6th line is\n#{line}" 
+  puts "The 6th line is\n#{line}"
   line = LineCache::remap_file(__FILE__, 'another_name')
   puts LineCache::getline('another_name', 7)
 
@@ -519,23 +519,23 @@ if __FILE__ == $0
   LineCache::update_cache(__FILE__)
   LineCache::checkcache(__FILE__)
   puts "#{__FILE__} has #{LineCache::size(__FILE__)} lines"
-  puts "#{__FILE__} trace line numbers:\n" + 
+  puts "#{__FILE__} trace line numbers:\n" +
     "#{LineCache::trace_line_numbers(__FILE__).to_a.sort.inspect}"
-  puts("#{__FILE__} is %scached." % 
+  puts("#{__FILE__} is %scached." %
        yes_no(LineCache::cached?(__FILE__)))
   puts LineCache::stat(__FILE__).inspect
   puts "Full path: #{LineCache::path(__FILE__)}"
   LineCache::checkcache # Check all files in the cache
-  LineCache::clear_file_cache 
-  puts("#{__FILE__} is now %scached." % 
+  LineCache::clear_file_cache
+  puts("#{__FILE__} is now %scached." %
        yes_no(LineCache::cached?(__FILE__)))
   # digest = SCRIPT_LINES__.select{|k,v| k =~ /digest.rb$/}
   # puts digest.first[0] if digest
   line = LineCache::getline(__FILE__, 7)
-  puts "The 7th line is\n#{line}" 
+  puts "The 7th line is\n#{line}"
   LineCache::remap_file_lines(__FILE__, 'test2', (10..20), 6)
   puts LineCache::getline('test2', 10)
-  puts "Remapped 10th line of test2 is\n#{line}" 
+  puts "Remapped 10th line of test2 is\n#{line}"
   eval("loc = Rubinius::VM::backtrace(0)[0]
   puts LineCache::getline(loc.static_scope.script, 1)")
   eval("loc = Rubinius::VM::backtrace(0)[0]