rbx-linecache 0.44-universal-rubinius-1.2 → 1.0-universal-rubinius-1.2

data/ChangeLog

@@ -1,3 +1,64 @@
+2011-01-18 20:02  Rocky Bernstein
+
+	* lib/linecache.rb: Was redoing highlighting incorrectly. Need to
+	  add more tests.
+
+2011-01-18 18:13  Rocky Bernstein
+
+	* lib/linecache.rb: Add routine to clear syntax-highlight cache
+
+2011-01-17 23:46  Rocky Bernstein
+
+	* lib/linecache.rb: Bump version number. We're in dev now and
+	  syntax highlighting adds incompatible (but probably not noticed)
+	  changes.
+
+2011-01-17 15:45  Rocky Bernstein
+
+	* lib/linecache.rb: More on-the-fly formatting possibilities
+
+2011-01-17 15:00  Rocky Bernstein
+
+	* lib/linecache.rb: getlines: fold reload_on_change into options
+	  hash
+
+2011-01-17 12:48  Rocky Bernstein
+
+	* lib/linecache.rb: Add syntax highlighting via CodeRay and
+	  TERM:ANSIColor (if available).
+
+2010-12-27 15:31  Rocky Bernstein
+
+	* .gemspec, Rakefile: Packaging: Probably need
+	  universal-rubinius-1.2 in gem name
+
+2010-12-25 14:27  Rocky Bernstein
+
+	* release-0.44: Tag release.
+
+2010-12-25 14:22  Rocky Bernstein
+
+	* ChangeLog, NEWS, Rakefile, lib/linecache.rb, test/data/match3.rb,
+	  test/test-linecache.rb, test/test-tracelines.rb: Revise for
+	  Rubinius 1.2 and beyond where line numbers have been improved.
+	  Get Ready for 0.44 release.
+
+2010-12-14 20:04  Rocky Bernstein
+
+	* .gemspec, Rakefile: Package now builds with package
+	  rubinius-universal in the gem name and checks for version 1.1 or
+	  1.2
+
+2010-12-14 19:37  Rocky Bernstein
+
+	* test/data/case2.rb, test/data/match3.rb: Line numbers changed a
+	  little in rubinius 1.2.
+
+2010-11-27 02:49  Rocky Bernstein
+
+	* lib/linecache.rb: Bump version number. We've added static scope
+	  since the last release.
+
 2010-11-21 01:56  Rocky Bernstein
 
 	* lib/linecache.rb, test/test-linecache.rb: Handle rubinius script

data/NEWS

@@ -1,7 +1,11 @@
-December 25 2010
+1.0
+February 1, 2011
+- Add syntax highlight caching
+
+December 25, 2010
 - Handle Rubinius eval_source to temp file remapping.
 
-October 27 2010
+October 27, 2010
 - First gemcutter rubinius release 
 
 

data/lib/linecache.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
-#   Copyright (C) 2007, 2008, 2010 Rocky Bernstein <rockyb@rubyforge.net>
+#   Copyright (C) 2007, 2008, 2010, 2011
+#     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
@@ -63,7 +64,7 @@ require_relative 'tracelines'
 # = module LineCache
 # A module to read and cache lines of a Ruby program. 
 module LineCache
-  VERSION = '0.44'
+  VERSION = '1.0'
   LineCacheInfo = Struct.new(:stat, :line_numbers, :lines, :path, :sha1) unless
     defined?(LineCacheInfo)
  
@@ -71,6 +72,10 @@ module LineCache
   # __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).
@@ -89,34 +94,51 @@ module LineCache
 
   @@script2file = {} 
 
+  module_function
+
   def remove_script_temps
     @@script2file.values.each do |filename|
-      File.unlink(filename)
+      File.unlink(filename) if File.exist?(filename)
     end
   end
-  module_function :remove_script_temps
   at_exit { remove_script_temps }
 
   
   # Clear the file cache entirely.
-  def clear_file_cache()
-    @@file_cache = {}
-    @@file2file_remap = {}
-    @@file2file_remap_lines = {}
+  def clear_file_cache(filename=nil)
+    if filename 
+      if @@file_cache[filename]
+        @@file_cache.delete(filename)
+      end
+    else
+      @@file_cache = {}
+      @@file2file_remap = {}
+      @@file2file_remap_lines = {}
+    end
+  end
+
+  # 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 
+  # syntax marked.
+  def clear_file_format_cache
+    @@file_cache.each_pair do |fname, cache_info|
+      cache_info.lines.each_pair do |format, lines|
+        next if :plain == format
+        @@file_cache[fname].lines[format] = nil
+      end
+    end
   end
-  module_function :clear_file_cache
 
   # Clear the script cache entirely.
   def clear_script_cache()
     @@script_cache = {}
   end
-  module_function :clear_file_cache
 
   # Return an array of cached file names
   def cached_files()
     @@file_cache.keys
   end
-  module_function :cached_files
 
   # Discard cache entries that are out of date. If +filename+ is +nil+
   # all entries in the file cache +@@file_cache+ are checked.
@@ -124,8 +146,8 @@ module LineCache
   # if the file was read from __SCRIPT_LINES but no corresponding file
   # is found, it will be kept. Return a list of invalidated filenames.
   # nil is returned if a filename was given but not found cached.
-  def checkcache(filename=nil, use_script_lines=false)
-    
+  def checkcache(filename=nil, opts={})
+
     if !filename
       filenames = @@file_cache.keys()
     elsif @@file_cache.member?(filename)
@@ -145,26 +167,24 @@ module LineCache
           if stat && 
               (cache_info.size != stat.size or cache_info.mtime != stat.mtime)
             result << filename
-            update_cache(filename, use_script_lines)
+            update_cache(filename, opts)
           end
         else
           result << filename
-          update_cache(filename, use_script_lines)
+          update_cache(filename, opts)
         end
       end
     end
     return result
   end
-  module_function :checkcache
 
   # Cache script if it's not already cached.
-  def cache_script(script, string=nil, sha1=nil)
+  def cache_script(script, opts={})
     if !@@script_cache.member?(script)
-      update_script_cache(script, string, sha1)
+      update_script_cache(script, opts)
     end
     script
   end
-  module_function :cache_script
 
   # Cache file name or script object if it's not already cached.
   # Return the expanded filename for it in the cache if a filename,
@@ -176,16 +196,16 @@ module LineCache
       cache_script(file_or_script)
     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_file(filename, reload_on_change=false)
+  def cache_file(filename, reload_on_change=false, opts={})
     if @@file_cache.member?(filename)
       checkcache(filename) if reload_on_change
     else
-      update_cache(filename, true)
+      opts[:use_script_lines] = true
+      update_cache(filename, opts)
     end
     if @@file_cache.member?(filename)
       @@file_cache[filename].path
@@ -193,7 +213,6 @@ module LineCache
       nil
     end
   end
-  module_function :cache_file
       
   # Return true if file_or_script is cached
   def cached?(file_or_script)
@@ -203,18 +222,15 @@ module LineCache
       cached_script?(file_or_script)
     end
   end
-  module_function :cached?
 
   def cached_script?(script)
       @@script_cache.member?(script)
   end
-  module_function :cached_script?
       
   def empty?(filename)
     filename=map_file(filename)
-    @@file_cache[filename].lines.empty?
+    !!@@file_cache[filename].lines[:plain]
   end
-  module_function :empty?
 
   # Get line +line_number+ from file named +filename+. Return nil if
   # there was a problem. If a file named filename is not found, the
@@ -227,12 +243,12 @@ module LineCache
   #  $: << '/tmp'
   #  lines = LineCache.getlines('myfile.rb')
   #
-  def getline(file_or_script, line_number, reload_on_change=true)
+  def getline(file_or_script, line_number, opts={})
     lines = 
       if file_or_script.kind_of?(String)
         filename = map_file(file_or_script)
         filename, line_number = map_file_line(filename, line_number)
-        getlines(filename, reload_on_change)
+        getlines(filename, opts)
       else
         script_getlines(file_or_script)
       end
@@ -242,43 +258,67 @@ module LineCache
         return nil
     end
   end
-  module_function :getline
 
   # Read lines of +script+ and cache the results. However +script+ was
   # previously cached use the results from the cache. Return nil
   # if we can't get lines
-  def script_getlines(script)
-    if @@script_cache.member?(script)
-      return @@script_cache[script].lines
-    else
-      update_script_cache(script)
+  def script_getlines(script, opts={})
+    format = opts[:output] || :plain
+    line_formats = 
       if @@script_cache.member?(script)
-        return @@script_cache[script].lines 
+        @@script_cache[script].lines
       else
-        return nil
+        update_script_cache(script, opts)
+        if @@script_cache.member?(script)
+          @@script_cache[script].lines
+        else
+          nil
+        end
       end
+    return nil unless line_formats
+    if format != :plain && !line_formats[format]
+      highlight_string(line_formats[:plain].join('')).split(/\n/)
+    else
+      line_formats[format]
     end
   end
-  module_function :script_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
-  def getlines(filename, reload_on_change=false)
+  def getlines(filename, opts={})
     filename = map_file(filename)
-    checkcache(filename) if reload_on_change
+    checkcache(filename) if opts[:reload_on_change]
+    format = opts[:output] || :plain
     if @@file_cache.member?(filename)
-      return @@file_cache[filename].lines
+      lines = @@file_cache[filename].lines
+      if opts[:output] && !lines[format]
+        lines[format] = 
+          highlight_string(lines[:plain].join(''), format).split(/\n/)
+      end
+      return lines[format]
     else
-      update_cache(filename, true)
+      opts[:use_script_lines] = true
+      update_cache(filename, opts)
       if @@file_cache.member?(filename)
-        return @@file_cache[filename].lines 
+        return @@file_cache[filename].lines[format]
       else
         return nil
       end
     end
   end
-  module_function :getlines
+
+  def highlight_string(string, output_type)
+    require 'rubygems'
+    begin
+      require 'coderay'
+      require 'term/ansicolor'
+    rescue LoadError
+      return string
+    end
+    @@ruby_highlighter ||= CodeRay::Duo[:ruby, output_type]
+    @@ruby_highlighter.encode(string)
+  end
 
   # Return full filename path for filename
   def path(filename)
@@ -287,12 +327,10 @@ module LineCache
     return nil unless @@file_cache.member?(filename)
     @@file_cache[filename].path
   end
-  module_function :path
 
   def remap_file(to_file, from_file)
     @@file2file_remap[to_file] = from_file
   end
-  module_function :remap_file
 
   def remap_file_lines(from_file, to_file, range, start)
     range = (range..range) if range.kind_of?(Fixnum)
@@ -314,13 +352,12 @@ module LineCache
     return @@file_cache[filename].sha1.hexdigest if 
       @@file_cache[filename].sha1
     sha1 = Digest::SHA1.new
-    @@file_cache[filename].lines.each do |line|
+    @@file_cache[filename].lines[:plain].each do |line|
       sha1 << line + "\n"
     end
     @@file_cache[filename].sha1 = sha1
     sha1.hexdigest
   end
-  module_function :sha1
       
   # Return the number of lines in filename
   def size(file_or_script)
@@ -328,13 +365,12 @@ module LineCache
     if file_or_script.kind_of?(String)
       file_or_script = map_file(file_or_script)
       return nil unless @@file_cache.member?(file_or_script)
-      @@file_cache[file_or_script].lines.length
+      @@file_cache[file_or_script].lines[:plain].length
     else
       return nil unless @@script_cache.member?(file_or_script)
-      @@script_cache[file_or_script].lines.length
+      @@script_cache[file_or_script].lines[:plain].length
     end
   end
-  module_function :size
 
   # Return File.stat in the cache for filename.
   def stat(filename)
@@ -353,17 +389,15 @@ module LineCache
     e = @@file_cache[filename]
     unless e.line_numbers
       e.line_numbers = 
-        TraceLineNumbers.lnums_for_str_array(e.lines)
+        TraceLineNumbers.lnums_for_str_array(e.lines[:plain])
       e.line_numbers = false unless e.line_numbers
     end
     e.line_numbers
   end
-  module_function :trace_line_numbers
     
   def map_file(file)
     @@file2file_remap[file] ? @@file2file_remap[file] : file
   end
-  module_function :map_file
 
   def map_script(script)
     if @@script2file[script] 
@@ -377,12 +411,10 @@ module LineCache
       tempfile = Tempfile.new(["eval-#{sha1.hexdigest[0...7]}-", '.rb'])
       tempfile.open.puts(string)
       tempfile.close
-      # cache_script(script, string, sha1.hexdigest)
       @@script2file[script] = tempfile.path
       tempfile.path
     end
   end
-  module_function :map_script
 
   def map_file_line(file, line)
     if @@file2file_remap_lines[file]
@@ -395,30 +427,29 @@ module LineCache
     end
     return [map_file(file), line]
   end
-  module_function :map_file_line
 
   def script_is_eval?(script)
     !!script.eval_source
   end
-  module_function :script_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_script_cache(script, string=nil, sha1=nil)
+  def update_script_cache(script, opts)
     return false unless script_is_eval?(script)
-    string = script.eval_source unless string
+    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, string.split(/\n/), nil, sha1)
+      LineCacheInfo.new(nil, nil, lines, nil, opts[:sha1])
     return true
   end
-  module_function :update_script_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
+  # Update a cache entry.  If something's wrong, return nil. Return
+  # true if the cache was updated and false if not.  If
+  # opts[:use_script_lines] is true, use that as the source for the
   # lines of the file
-  def update_cache(filename, use_script_lines=false)
-
+  def update_cache(filename, opts={})
     return nil unless filename
 
     @@file_cache.delete(filename)
@@ -440,8 +471,13 @@ module LineCache
     end
     begin
       fp = File.open(path, 'r')
-      lines = fp.readlines()
+      raw_string = fp.read
+      fp.rewind
+      lines = {:plain => fp.readlines}
       fp.close()
+      lines[opts[:output]] = 
+        highlight_string(raw_string, opts[:output]).split(/\n/) if 
+        opts[:output]
     rescue 
       ##  print '*** cannot open', path, ':', msg
       return nil
@@ -451,8 +487,6 @@ module LineCache
     @@file2file_remap[path] = filename
     return true
   end
-
-  module_function :update_cache
 end
 
 # example usage
@@ -495,4 +529,19 @@ if __FILE__ == $0
   puts LineCache::size(loc.static_scope.script)")
   eval("loc = Rubinius::VM::backtrace(0)[0]
   puts LineCache::map_script(loc.static_scope.script)")
+
+  # Try new ANSI Terminal syntax coloring
+  LineCache::clear_file_cache(__FILE__)
+  LineCache::update_cache(__FILE__, :output => :term)
+  50.upto(60) do |i|
+    line = LineCache::getline(__FILE__, i, :output => :term)
+    # puts line.inspect
+    puts line
+  end
+  puts '-' * 20
+  50.upto(60) do |i|
+    line = LineCache::getline(__FILE__, i)
+    # puts line.inspect
+    puts line
+  end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rbx-linecache
 version: !ruby/object:Gem::Version 
-  hash: 83
+  hash: 15
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 44
-  version: "0.44"
+  version: "1.0"
 platform: universal-rubinius-1.2
 authors: 
 - R. Bernstein
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-27 00:00:00 -05:00
+date: 2011-02-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,7 +95,7 @@ licenses:
 post_install_message: 
 rdoc_options: 
 - --title
-- LineCache 0.44 Documentation
+- LineCache 1.0 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement