linecache-tf 0.44 → 0.45

data/ChangeLog

@@ -1,3 +1,42 @@
+2010-11-26 04:27  Rocky Bernstein
+
+	* .gemspec: Don't use lib/version.rb any more. Also rvm lists Ruby
+	  as 1.9.2-nframe no just 1.9.2.
+
+2010-11-26 02:23  Rocky Bernstein
+
+	* lib/linecache.rb: Work more on iseq caching.
+
+2010-11-26 02:01  Rocky Bernstein
+
+	* Rakefile, lib/linecache.rb, lib/version.rb,
+	  test/test-linecache.rb: Pick up version from LineCache module.
+	  Include "\n" in sha1 calculation. Start work on iseq caching.
+
+2010-09-22 17:00  Rocky Bernstein
+
+	* Rakefile: Correct suspicious test task so it doesn't modify
+	  itself.
+
+2010-09-21 21:12  Rocky Bernstein
+
+	* .gemspec, Rakefile: Title on RDOC referred to wrong package
+
+2010-09-21 04:13  Rocky Bernstein
+
+	* .gemspec: Testing for wrong constant.
+
+2010-09-21 00:47  Rocky Bernstein
+
+	* Rakefile: Small tweaks to Rakefile building on previous stuff
+
+2010-09-20 23:13  Rocky Bernstein
+
+	* .gemspec, ChangeLog, Makefile, Rakefile, VERSION, lib/Makefile,
+	  lib/linecache.rb, lib/version.rb: Administrivia: Add gemspec
+	  file, simplify Rakefile. Add Makefile for compatibility for us
+	  old farts.
+
 2010-09-13 14:49  Rocky Bernstein
 
 	* ChangeLog, NEWS, Rakefile, VERSION: Update description for

data/NEWS

@@ -1,3 +1,9 @@
+tf-0.45
+Dec 10, 2010  Phel. Mad. Release
+- Work on iseq caching.
+- Include "\n"'s in SHA1 calculations.
+- Correct suspicious test task so it doesn't modify iteslf.
+
 tf-0.44
 Sept 13, 2010
 - First 1.9.2 release via rb-threadframe

data/Rakefile

@@ -4,135 +4,84 @@ require 'rubygems'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'rake/testtask'
+require 'fileutils'
 
-# ------- Default Package ----------
-PKG_VERSION = open(File.join(File.dirname(__FILE__), 'VERSION')) do 
-  |f| f.readlines[0].chomp
+ROOT_DIR = File.dirname(__FILE__)
+require File.join %W(#{ROOT_DIR} lib linecache)
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
 end
-PKG_NAME           = 'linecache'
-PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = 'rocky-hacks'
-RUBY_FORGE_USER    = 'rockyb'
-
-FILES = FileList[
-  'AUTHORS',
-  'COPYING',
-  'ChangeLog',
-  'NEWS',
-  'README',
-  'Rakefile',
-  'VERSION',
-  'lib/*.rb',
-  'test/*.rb',
-  'test/data/*.rb',
-  'test/short-file'
-]                        
-
-desc "Test everything."
-test_task = task :test => :lib do 
-  Rake::TestTask.new(:test) do |t|
-    t.pattern = 'test/test-*.rb'
-    t.verbose = true
+
+desc "Build the gem"
+task :package=>:gem
+task :gem=>:gemspec do
+  Dir.chdir(ROOT_DIR) do
+    sh "gem build .gemspec"
+    FileUtils.mkdir_p 'pkg'
+    FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
   end
 end
 
-desc "Test everything - same as test."
-task :check => :test
-
-desc "Create a GNU-style ChangeLog via svn2cl"
-task :ChangeLog do
-  system("svn2cl svn+ssh://rockyb@rubyforge.org/var/svn/rocky-hacks/linecache/branches/ruby-1.9 --authors=svn2cl_usermap")
+desc "Install the gem locally"
+task :install => :gem do
+  Dir.chdir(ROOT_DIR) do
+    sh %{gem install --local pkg/#{gemspec.name}-#{gemspec.version}}
+  end
 end
 
-# Base GEM Specification
-default_spec = Gem::Specification.new do |spec|
-  spec.name = "linecache-tf"
-  
-  spec.homepage = "http://rubyforge.org/projects/rocky-hacks/linecache"
-  spec.summary = "Read file with caching"
-  spec.description = <<-EOF
-LineCache is a module for reading and caching lines. This may be useful for
-example in a debugger where the same lines are shown many times.
-
-This version works only with a patched version of Ruby 1.9.2 and rb-threadframe.
-EOF
-
-  spec.version = "#{PKG_VERSION}"
-
-  spec.author = "R. Bernstein"
-  spec.email = "rockyb@rubyforge.net"
-  spec.platform = Gem::Platform::RUBY
-  spec.require_path = "lib"
-  spec.files = FILES.to_a  
-
-  spec.required_ruby_version = '>= 1.9.2'
-  spec.date = Time.now
-  spec.add_dependency('rb-threadframe', '>= 0.32')
-  spec.rubyforge_project = 'rocky-hacks'
-  
-  # rdoc
-  spec.has_rdoc = true
-  spec.extra_rdoc_files = %w(README lib/linecache.rb lib/tracelines.rb)
-
-  spec.test_files = FileList['test/*.rb']
+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
 
-# Rake task to build the default package
-Rake::GemPackageTask.new(default_spec) do |pkg|
-  pkg.need_tar = true
+desc "Create a GNU-style ChangeLog via svn2cl"
+task :ChangeLog do
+  system("svn2cl --authors=svn2cl_usermap")
 end
 
 task :default => [:test]
 
-# desc "Publish linecache to RubyForge."
-# task :publish do 
-#   require 'rake/contrib/sshpublisher'
-  
-#   # Get ruby-debug path.
-#   ruby_debug_path = File.expand_path(File.dirname(__FILE__))
-
-#   publisher = Rake::SshDirPublisher.new("rockyb@rubyforge.org",
-#         "/var/www/gforge-projects/rocky-hacks/linecache", ruby_debug_path)
-# end
-
 desc "Remove built files"
 task :clean => [:clobber_package, :clobber_rdoc]
 
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
 # ---------  RDoc Documentation ------
 desc "Generate rdoc documentation"
 Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "linecache"
+  rdoc.title    = "LineCache #{LineCache::VERSION} Documentation"
+
   # Show source inline with line numbers
-  rdoc.options << "--inline-source" << "--line-numbers"
-  # Make the readme file the start page for the generated html
-  rdoc.options << '--main' << 'README'
-  rdoc.rdoc_files.include(%w(lib/*.rb README COPYING))
-end
+  rdoc.options += %w(--inline-source --line-numbers)
+
+  # Make the README file the start page for the generated html
+  rdoc.options += %w(--main README)
 
-# desc "Publish the release files to RubyForge."
-# task :rubyforge_upload do
-#   `rubyforge login`
-#   release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} '#{PKG_NAME}-#{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.gem"
-#   puts release_command
-#   system(release_command)
-# end
-
-def install(spec, *opts)
-  args = ['gem', 'install', "pkg/#{spec.name}-#{spec.version}.gem"] + opts
-  system(*args)
+  rdoc.rdoc_files.include('lib/*.rb', 'README', 'COPYING')
 end
+desc "Same as rdoc"
+task :doc => :rdoc
 
-desc 'Install locally'
-task :install => :package do
-  Dir.chdir(File::dirname(__FILE__)) do
-    # ri and rdoc take lots of time
-    install(default_spec, '--no-ri', '--no-rdoc')
-  end
-end    
+task :clobber_package do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'pkg')
+end
 
-task :install_full => :package do
-  Dir.chdir(File::dirname(__FILE__)) do
-    install(default_spec)
-  end
+task :clobber_rdoc do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'doc')
 end

data/lib/linecache.rb

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
-# $Id: linecache.rb 184 2009-10-22 13:05:11Z rockyb $
-# 
-#   Copyright (C) 2007, 2008, 2009 Rocky Bernstein <rockyb@rubyforge.net>
+#   Copyright (C) 2007, 2008, 2009, 2010 Rocky Bernstein <rockyb@rubyforge.net>
 #
 #    This program is free software; you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -23,8 +21,6 @@
 #
 # = linecache
 # A module to read and cache lines of a Ruby program. 
-# == Version
-# :include:VERSION
 
 # == SYNOPSIS
 #
@@ -62,21 +58,22 @@
 # and never destroys SCRIPT_LINES__
 SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
 
+require 'tempfile'
 require 'digest/sha1'
 require 'set'
 require_relative 'tracelines'
 
-# require 'ruby-debug' ; Debugger.start
-
 # = module LineCache
 # A module to read and cache lines of a Ruby program. 
 module LineCache
+  VERSION = '0.45'
   LineCacheInfo = Struct.new(:stat, :line_numbers, :lines, :path, :sha1) 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 = {} 
+  @@iseq_cache = {} 
   
   # Maps a string filename (a String) to a key in @@file_cache (a
   # String).
@@ -92,6 +89,17 @@ module LineCache
   # ranges. Will probably use this for that, but I'm not sure.
   @@file2file_remap = {} 
   @@file2file_remap_lines = {}
+
+  @@iseq2file = {} 
+
+  def remove_iseq_temps
+    @@iseq2file.values.each do |filename|
+      File.unlink(filename)
+    end
+  end
+  module_function :remove_iseq_temps
+  at_exit { remove_iseq_temps }
+
   
   # Clear the file cache entirely.
   def clear_file_cache()
@@ -101,6 +109,12 @@ module LineCache
   end
   module_function :clear_file_cache
 
+  # Clear the iseq cache entirely.
+  def clear_iseq_cache()
+    @@iseq_cache = {}
+  end
+  module_function :clear_file_cache
+
   # Return an array of cached file names
   def cached_files()
     @@file_cache.keys
@@ -146,10 +160,31 @@ module LineCache
   end
   module_function :checkcache
 
+  # Cache iseq if it's not already cached.
+  def cache_iseq(iseq, string=nil, sha1=nil)
+    if !@@iseq_cache.member?(iseq)
+      update_iseq_cache(iseq, string, sha1)
+    end
+    iseq
+  end
+  module_function :cache_iseq
+
+  # Cache file name or iseq object if it's not already cached.
+  # Return the expanded filename for it in the cache if a filename,
+  # or the iseq, or nil if we can't find the file.
+  def cache(file_or_iseq, reload_on_change=false)
+    if file_or_iseq.kind_of?(String)
+      cache_file(file_or_iseq, reload_on_change)
+    else
+      cache_iseq(file_or_iseq)
+    end
+  end
+  module_function :cache
+
   # Cache filename if it's not already cached.
   # Return the expanded filename for it in the cache
   # or nil if we can't find the file.
-  def cache(filename, reload_on_change=false)
+  def cache_file(filename, reload_on_change=false)
     if @@file_cache.member?(filename)
       checkcache(filename) if reload_on_change
     else
@@ -161,11 +196,15 @@ module LineCache
       nil
     end
   end
-  module_function :cache
+  module_function :cache_file
       
-  # Return true if filename is cached
-  def cached?(filename)
-    @@file_cache.member?(map_file(filename))
+  # Return true if file_or_iseq is cached
+  def cached?(file_or_iseq)
+    if file_or_iseq.kind_of?(String) 
+      @@file_cache.member?(map_file(file_or_iseq))
+    else 
+      cached_iseq?(file_or_iseq)
+    end
   end
   module_function :cached?
 
@@ -191,10 +230,15 @@ module LineCache
   #  $: << '/tmp'
   #  lines = LineCache.getlines('myfile.rb')
   #
-  def getline(filename, line_number, reload_on_change=true)
-    filename = map_file(filename)
-    filename, line_number = map_file_line(filename, line_number)
-    lines = getlines(filename, reload_on_change)
+  def getline(file_or_iseq, line_number, reload_on_change=true)
+    lines = 
+      if file_or_iseq.kind_of?(String)
+        filename = map_file(file_or_iseq)
+        filename, line_number = map_file_line(filename, line_number)
+        getlines(filename, reload_on_change)
+      else
+        iseq_getlines(file_or_iseq)
+      end
     if lines and (1..lines.size) === line_number
         return lines[line_number-1]
     else
@@ -203,6 +247,23 @@ module LineCache
   end
   module_function :getline
 
+  # Read lines of +iseq+ and cache the results. However +iseq+ was
+  # previously cached use the results from the cache. Return nil
+  # if we can't get lines
+  def iseq_getlines(iseq)
+    if @@iseq_cache.member?(iseq)
+      return @@iseq_cache[iseq].lines
+    else
+      update_iseq_cache(iseq)
+      if @@iseq_cache.member?(iseq)
+        return @@iseq_cache[iseq].lines 
+      else
+        return nil
+      end
+    end
+  end
+  module_function :iseq_getlines
+
   # Read lines of +filename+ and cache the results. However +filename+ was
   # previously cached use the results from the cache. Return nil
   # if we can't get lines
@@ -213,13 +274,18 @@ module LineCache
       return @@file_cache[filename].lines
     else
       update_cache(filename, true)
-      return @@file_cache[filename].lines if @@file_cache.member?(filename)
+      if @@file_cache.member?(filename)
+        return @@file_cache[filename].lines 
+      else
+        return nil
+      end
     end
   end
   module_function :getlines
 
   # Return full filename path for filename
   def path(filename)
+    return unless filename.kind_of?(String)
     filename = map_file(filename)
     return nil unless @@file_cache.member?(filename)
     @@file_cache[filename].path
@@ -232,7 +298,7 @@ module LineCache
   module_function :remap_file
 
   def remap_file_lines(from_file, to_file, range, start)
-    range = (range..range) if range.is_a?(Fixnum)
+    range = (range..range) if range.kind_of?(Fixnum)
     to_file = from_file unless to_file
     if @@file2file_remap_lines[to_file] 
       # FIXME: need to check for overwriting ranges: whether
@@ -252,7 +318,7 @@ module LineCache
       @@file_cache[filename].sha1
     sha1 = Digest::SHA1.new
     @@file_cache[filename].lines.each do |line|
-      sha1 << line
+      sha1 << line + "\n"
     end
     @@file_cache[filename].sha1 = sha1
     sha1.hexdigest
@@ -260,10 +326,16 @@ module LineCache
   module_function :sha1
       
   # Return the number of lines in filename
-  def size(filename)
-    filename = map_file(filename)
-    return nil unless @@file_cache.member?(filename)
-    @@file_cache[filename].lines.length
+  def size(file_or_iseq)
+    cache(file_or_iseq)
+    if file_or_iseq.kind_of?(String)
+      file_or_iseq = map_file(file_or_iseq)
+      return nil unless @@file_cache.member?(file_or_iseq)
+      @@file_cache[file_or_iseq].lines.length
+    else
+      return nil unless @@iseq_cache.member?(file_or_iseq)
+      @@iseq_cache[file_or_iseq].lines.length
+    end
   end
   module_function :size
 
@@ -296,6 +368,25 @@ module LineCache
   end
   module_function :map_file
 
+  def map_iseq(iseq)
+    if @@iseq2file[iseq] 
+      @@iseq2file[iseq] 
+    else 
+      # Doc says there's new takes an optional string parameter
+      # But it doesn't work for me
+      sha1 = Digest::SHA1.new
+      string = iseq.source
+      sha1 << iseq.source
+      tempfile = Tempfile.new(["eval-#{sha1.hexdigest[0...7]}-", '.rb'])
+      tempfile.open.puts(string)
+      tempfile.close
+      # cache_iseq(iseq, string, sha1.hexdigest)
+      @@iseq2file[iseq] = tempfile.path
+      tempfile.path
+    end
+  end
+  module_function :map_iseq
+
   def map_file_line(file, line)
     if @@file2file_remap_lines[file]
       @@file2file_remap_lines[file].each do |from_file, range, start|
@@ -309,6 +400,22 @@ module LineCache
   end
   module_function :map_file_line
 
+  def iseq_is_eval?(iseq)
+    !!iseq.source
+  end
+  module_function :iseq_is_eval?
+
+  # Update a cache entry.  If something is wrong, return nil. Return
+  # true if the cache was updated and false if not. 
+  def update_iseq_cache(iseq, string=nil, sha1=nil)
+    return false unless iseq_is_eval?(iseq)
+    string = iseq.source unless string
+    @@iseq_cache[iseq] = 
+      LineCacheInfo.new(nil, nil, string.split(/\n/), nil, sha1)
+    return true
+  end
+  module_function :update_iseq_cache
+
   # Update a cache entry.  If something's
   # wrong, return nil. Return true if the cache was updated and false
   # if not.  If use_script_lines is true, use that as the source for the
@@ -320,24 +427,6 @@ module LineCache
     @@file_cache.delete(filename)
     path = File.expand_path(filename)
     
-    if use_script_lines
-      list = [filename]
-      list << @@file2file_remap[path] if @@file2file_remap[path]
-      list.each do |name| 
-        if !SCRIPT_LINES__[name].nil? && SCRIPT_LINES__[name] != true
-          begin 
-            stat = File.stat(name)
-          rescue
-            stat = nil
-          end
-          lines = SCRIPT_LINES__[name]
-          @@file_cache[filename] = LineCacheInfo.new(stat, nil, lines, path, nil)
-          @@file2file_remap[path] = filename
-          return true
-        end
-      end
-    end
-      
     if File.exist?(path)
       stat = File.stat(path)
     elsif File.basename(filename) == filename
@@ -367,7 +456,6 @@ module LineCache
   end
 
   module_function :update_cache
-
 end
 
 # example usage
@@ -404,4 +492,9 @@ if __FILE__ == $0
   LineCache::remap_file_lines(__FILE__, 'test2', (10..20), 6)
   puts LineCache::getline('test2', 10)
   puts "Remapped 10th line of test2 is\n#{line}" 
+  require 'thread_frame'
+  puts eval("x=1
+LineCache::getline(RubyVM::ThreadFrame.current.iseq, 1)")
+  puts eval("x=2
+LineCache::getline(RubyVM::ThreadFrame.current.iseq, 2)")
 end

data/test/test-linecache.rb

@@ -146,8 +146,24 @@ class TestLineCache < Test::Unit::TestCase
   def test_sha1
     test_file = File.join(@@TEST_DIR, 'short-file') 
     LineCache::cache(test_file)
-    assert_equal('1134f95ea84a3dcc67d7d1bf41390ee1a03af6d2',
+    assert_equal('3e1d87f3399fc73ae5683e106bce1b5ba823fc50',
                  LineCache::sha1(test_file))
   end
 
+  def test_iseq_cache
+    require 'thread_frame'
+    template = "x=1
+y=2
+LineCache::getline(RubyVM::ThreadFrame.current.iseq, %d)"
+    assert_equal("x=1", eval(template % 1))
+    assert_equal("y=2", eval(template % 2))
+    string = "a = 1
+b = 2
+LineCache::map_iseq(RubyVM::ThreadFrame.current.iseq)"
+    temp_filename = eval(string)
+    got_lines = File.open(temp_filename).readlines.join('')
+    assert_equal(string, got_lines.chomp)
+    assert_equal(1, File.unlink(temp_filename))
+  end
+
 end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 44
-  version: "0.44"
+  - 45
+  version: "0.45"
 platform: ruby
 authors: 
 - R. Bernstein
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-13 00:00:00 -04:00
+date: 2010-12-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,6 @@ files:
 - NEWS
 - README
 - Rakefile
-- VERSION
 - lib/tracelines.rb
 - lib/linecache.rb
 - test/parse-show.rb
@@ -91,17 +90,20 @@ files:
 - test/short-file
 has_rdoc: true
 homepage: http://rubyforge.org/projects/rocky-hacks/linecache
-licenses: []
-
+licenses: 
+- GPL2
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README
+- --title
+- LineCache 0.45 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ~>
     - !ruby/object:Gem::Version 
       segments: 
       - 1
@@ -118,15 +120,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: rocky-hacks
+rubyforge_project: columnize
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Read file with caching
-test_files: 
-- test/parse-show.rb
-- test/lnum-diag.rb
-- test/rcov-bug.rb
-- test/test-lnum.rb
-- test/test-linecache.rb
-- test/test-tracelines.rb
+summary: Module to format an Array as an Array of String aligned in columns
+test_files: []
+

data/VERSION

@@ -1 +0,0 @@
-0.44