linecache 0.1 → 0.2

data/ChangeLog

@@ -1,22 +1,53 @@
+2007-12-10 16:24  rockyb
+
+	* linecache/linecache: release 0.1
+
+2007-12-09 17:47  rockyb
+
+	* linecache/trunk/lib/linecache.rb: Make Ruby 1.9 compatible.
+
+2007-12-09 17:17  rockyb
+
+	* linecache/trunk/ChangeLog, linecache/trunk/Rakefile,
+	  linecache/trunk/lib/linecache.rb,
+	  linecache/trunk/test/test-linecache.rb: Better tests mean more
+	  bugs found. "rake" defaults now to "test".
+
+2007-12-09 14:10  rockyb
+
+	* linecache/trunk/Rakefile: Add VERSION to gem.
+
+2007-12-09 14:09  rockyb
+
+	* linecache/trunk/test/test-linecache.rb: Change classname to
+	  something more appropriate.
+
 2007-12-09 13:41  rockyb
 
-	* ., Rakefile: . : ignore doc and pkg
+	* linecache/trunk, linecache/trunk/Rakefile: . : ignore doc and pkg
 	  Rakefile: clean now does clobber_rdoc and clobber_package, i.e.
 	  removes
 	  the doc and pkg directories.
 
 2007-12-09 13:15  rockyb
 
-	* ChangeLog, NEWS, README, Rakefile, lib/linecache.rb,
-	  test/test-linecache.rb: NEWS, README, linecache.rb: Add $Id$ line
+	* linecache/trunk/ChangeLog, linecache/trunk/NEWS,
+	  linecache/trunk/README, linecache/trunk/Rakefile,
+	  linecache/trunk/lib/linecache.rb,
+	  linecache/trunk/test/test-linecache.rb: NEWS, README,
+	  linecache.rb: Add $Id$ line
 	  test-linecache.rb: make executable
 	  Rakefile: Correct documentation
 
 2007-12-09 12:58  rockyb
 
-	* linecache, ., AUTHORS, COPYING, ChangeLog, NEWS, README,
-	  Rakefile, VERSION, lib, lib/linecache.rb, test,
-	  test/test-linecache.rb: Initial import of LineCache, a module for
-	  reading and caching lines.
+	* linecache, linecache/trunk, linecache/trunk/AUTHORS,
+	  linecache/trunk/COPYING, linecache/trunk/ChangeLog,
+	  linecache/trunk/NEWS, linecache/trunk/README,
+	  linecache/trunk/Rakefile, linecache/trunk/VERSION,
+	  linecache/trunk/lib, linecache/trunk/lib/linecache.rb,
+	  linecache/trunk/test, linecache/trunk/test/test-linecache.rb:
+	  Initial import of LineCache, a module for reading and caching
+	  lines.
 	  This time to trunk.
 

data/NEWS

@@ -1,5 +1,9 @@
+0.2
+- Make this work with ruby-debug-base. Add reload-on-change parameters.
+  add checkcache, cache, cached? sha1, and stat methods. 
+  
 0.1
 
 - Initial release of LineCache, a module for reading and caching lines.
 
-$Id: NEWS 4 2007-12-09 13:15:09Z rockyb $
+$Id: NEWS 25 2008-01-16 01:30:13Z rockyb $

data/Rakefile

@@ -19,7 +19,8 @@ FILES = FileList[
   'Rakefile',
   'VERSION',
   'lib/*.rb',
-  'test/*.rb'
+  'test/*.rb',
+  'test/short-file'
 ]                        
 
 desc "Test everything."

data/VERSION

@@ -1 +1 @@
-0.1
+0.2

data/lib/linecache.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-# $Id: linecache.rb 15 2007-12-09 17:47:02Z rockyb $
+# $Id: linecache.rb 23 2008-01-15 22:42:39Z rockyb $
 # 
-#   Copyright (C) 2007 Rocky Bernstein <rockyb@rubyforge.net>
+#   Copyright (C) 2007, 2008 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
@@ -29,9 +29,9 @@
 # == SYNOPSIS
 #
 # The LineCache module allows one to get any line from any file,
-# caching lines of the file on first access to the file. The common
-# case where many lines are read from a single file. This can be used
-# for example in a debugger to show source lines.
+# caching lines of the file on first access to the file. The 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.
 #
 #  require 'linecache'
 #  lines = LineCache::getlines('/tmp/myruby.rb')
@@ -46,20 +46,29 @@
 #  LineCache::clear_file_cache('/tmp/myruby.rb')
 #  LineCache::update_cache   # Check for modifications of all cached files.
 #
-# This code is derived from the Python module of the same name.
+# Some parts of the interface is derived from the Python module of the
+# same name.
 #
 
+require 'digest/sha1'
+
+# Defining SCRIPT_LINES__ causes Ruby to cache the lines of files
+# it reads. The key the setting of __FILE__ at the time when Ruby does
+# its read. LineCache keeps a separate copy of the lines elsewhere
+# and never destroys __SCRIPT_LINES
+SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
+
 # require "rubygems"
 # require "ruby-debug" ; Debugger.start
 
 # = module LineCache
 # Module caching lines of a file
 module LineCache
-  LineCacheInfo = Struct.new(:stat, :lines, :fullname) 
+  LineCacheInfo = Struct.new(:stat, :lines, :fullname, :sha1)
  
-  # Get line +lineno+ 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 $: path array.
+  # 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 $: path array.
   # 
   # Examples:
   # 
@@ -70,10 +79,10 @@ module LineCache
   #     lines = LineCache::getlines ('myfile.rb')
   #  end
   #
-  def getline(filename, lineno)
-    lines = getlines(filename)
-    if (1..lines.size) === lineno
-        return lines[lineno-1]
+  def getline(filename, line_number, reload_on_change=true)
+    lines = getlines(filename, reload_on_change)
+    if (1..lines.size) === line_number
+        return lines[line_number-1]
     else
         return nil
     end
@@ -92,11 +101,12 @@ module LineCache
 
   # Read lines of +filename+ and cache the results. However +filename+ was
   # previously cached use the results from the cache.
-  def getlines(filename)
+  def getlines(filename, reload_on_change=false)
+    checkcache(filename) if reload_on_change
     if @@file_cache.member?(filename)
         return @@file_cache[filename].lines
     else
-        return update_cache(filename)
+        return update_cache(filename, true)
     end
   end
 
@@ -104,6 +114,9 @@ module LineCache
 
   # Discard cache entries that are out of date. If +filename+ is +nil+
   # all entries in the file cache +@@file_cache+ are checked.
+  # If we don't have stat information about a file which can happen
+  # if the file was read from __SCRIPT_LINES but no corresponding file
+  # is found, it will be kept.
   def checkcache(filename=nil)
     
     if !filename
@@ -120,7 +133,8 @@ module LineCache
       if File.exist?(fullname)
         cache_info = @@file_cache[filename]
         stat = File.stat(fullname)
-        if cache_info.size != stat.size or cache_info.mtime != stat.mtime
+        if stat && 
+            (cache_info.size != stat.size or cache_info.mtime != stat.mtime)
           @@file_cache.delete(filename)
         end
       else
@@ -128,19 +142,77 @@ module LineCache
       end
     end
   end
-
   module_function :checkcache
+
+  # 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)
+    if @@file_cache.member?(filename)
+      checkcache(filename) if reload_on_change
+    else
+      return update_cache(filename, true)
+    end
+    if @@file_cache.member?(filename)
+      @@file_cache[filename].fullname
+    else
+      nil
+    end
+  end
+  module_function :cache
+      
+  # Return true if filename is cached
+  def cached?(filename)
+    @@file_cache.member?(filename)
+  end
+  module_function :cached?
+      
+  # Return SHA1 of filename.
+  def sha1(filename)
+    return nil unless @@file_cache.member?(filename)
+    return @@file_cache[filename].sha1.hexdigest if 
+      @@file_cache[filename].sha1
+    sha1 = Digest::SHA1.new
+    @@file_cache[filename].lines.each do |line|
+      sha1 << line
+    end
+    @@file_cache[filename].sha1 = sha1
+    sha1.hexdigest
+  end
+  module_function :sha1
       
+  # Return File.stat in the cache for filename.
+  def stat(filename)
+    return nil unless @@file_cache.member?(filename)
+    @@file_cache[filename].stat
+  end
+  module_function :stat
+
   # Update a cache entry and return its list of lines.  if something's
   # wrong, discard the cache entry, and return an empty list.
-  def update_cache(filename)
+  # If use_script_lines is true, try to get the 
+  def update_cache(filename, use_script_lines=false)
 
     return [] unless filename
 
     @@file_cache.delete(filename)
-      
     fullname = File.expand_path(filename)
-
+    
+    if use_script_lines
+      [filename, fullname].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, lines, fullname, nil)
+          return lines
+        end
+      end
+    end
+      
     if File.exist?(fullname)
       stat = File.stat(fullname)
     else
@@ -166,7 +238,7 @@ module LineCache
       return []
     end
     @@file_cache[filename] = LineCacheInfo.new(File.stat(fullname), lines, 
-                                               fullname)
+                                               fullname, nil)
     return lines
   end
 
@@ -176,11 +248,23 @@ end
 
 # example usage
 if __FILE__ == $0 or
-    ($DEBUG and ['rdebug', 'rcov'].include?(File.basename($0)))
+    ($DEBUG and ['rcov'].include?(File.basename($0)))
+  def yes_no(var) 
+    return var ? "" : "not "
+  end
+
   lines = LineCache::getlines(__FILE__)
+  puts "#{__FILE__} has #{lines.size} lines"
   line = LineCache::getline(__FILE__, 6)
+  puts "The 6th line is\n#{line}" 
   LineCache::update_cache(__FILE__)
   LineCache::checkcache(__FILE__)
+  puts("#{__FILE__} is %scached." % 
+       yes_no(LineCache::cached?(__FILE__)))
+  LineCache::stat(__FILE__).inspect
   LineCache::checkcache # Check all files in the cache
   LineCache::clear_file_cache 
+  puts("#{__FILE__} is now %scached." % 
+       yes_no(LineCache::cached?(__FILE__)))
+
 end

data/test/short-file

@@ -0,0 +1,2 @@
+This is a small test file.
+

data/test/test-linecache.rb

@@ -5,10 +5,14 @@ require "tempfile"
 
 # Test LineCache module
 class TestLineCache < Test::Unit::TestCase
-  @@TOP_SRC_DIR = File.join(File.expand_path(File.dirname(__FILE__)), 
-                            '..', 'lib')
+  @@TEST_DIR = File.expand_path(File.dirname(__FILE__))
+  @@TOP_SRC_DIR = File.join(@@TEST_DIR, '..', 'lib')
   require File.join(@@TOP_SRC_DIR, 'linecache.rb')
   
+  def setup
+    LineCache::clear_file_cache
+  end
+  
   def test_basic
     fp = File.open(__FILE__, 'r')
     compare_lines = fp.readlines()
@@ -57,4 +61,30 @@ class TestLineCache < Test::Unit::TestCase
     LineCache::update_cache(__FILE__)
     LineCache::clear_file_cache
   end
+
+  def test_cached
+    assert_equal(false, LineCache::cached?(__FILE__),
+                 "file #{__FILE__} shouldn't be cached - just cleared cache.")
+    line = LineCache::getline(__FILE__, 1)
+    assert line
+    assert_equal(true, LineCache::cached?(__FILE__),
+                 "file #{__FILE__} should now be cached")
+  end
+
+  def test_stat
+    assert_equal(nil, LineCache::stat(__FILE__),
+                 "stat for #{__FILE__} shouldn't be nil - just cleared cache.")
+    line = LineCache::getline(__FILE__, 1)
+    assert line
+    assert(LineCache::stat(__FILE__),
+           "file #{__FILE__} should now have a stat")
+  end
+
+  def test_sha1
+    test_file = File.join(@@TEST_DIR, 'short-file') 
+    LineCache::cache(test_file)
+    assert_equal('d7ae2d65d8815607ddffa005e91a8add77ef4a1e', 
+                 LineCache::sha1(test_file))
+  end
+
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: linecache
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2007-12-09 00:00:00 -05:00
+  version: "0.2"
+date: 2008-01-15 00:00:00 -05:00
 summary: Read file with caching
 require_paths: 
 - lib
@@ -38,6 +38,7 @@ files:
 - VERSION
 - lib/linecache.rb
 - test/test-linecache.rb
+- test/short-file
 test_files: []
 
 rdoc_options: []