linecache-tf 1.0 → 1.2

data/NEWS

@@ -1,3 +1,12 @@
+tf-1.2
+Nov 20, 2014
+- Handle UTF-8, update rake task for this year's way to do the same thing
+
+
+tf-1.0
+Feb 1, 2011
+- Add syntax highlight caching
+
 tf-0.45
 Dec 10, 2010  Phel. Mad. Release
 - Work on iseq caching.
@@ -12,7 +21,7 @@ Sept 13, 2010
 06-12-08
 - tolerance for finding windows extension in lib rather than ext.
 
-0.41 
+0.41
 - add test/data/* to gem.
 
 0.4
@@ -21,15 +30,15 @@ Sept 13, 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

data/README

@@ -1,4 +1,4 @@
-= LineCache - A module to read and cache file information of a Ruby program.
+= LineCache - a module to read and cache Ruby program files and file information
 
 == SYNOPSIS
 

data/Rakefile

@@ -1,8 +1,6 @@
 #!/usr/bin/env rake
 # -*- Ruby -*-
 require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
 require 'rake/testtask'
 require 'fileutils'
 
@@ -13,20 +11,21 @@ def gemspec
   @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
 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"
     FileUtils.mkdir_p 'pkg'
-    FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+    FileUtils.mv("#{gemspec.file_name}", "pkg/")
   end
 end
 
 desc "Install the gem locally"
 task :install => :gem do
   Dir.chdir(ROOT_DIR) do
-    sh %{gem install --local pkg/#{gemspec.name}-#{gemspec.version}}
+    sh %{gem install --local pkg/#{gemspec.file_name}}
   end
 end
 
@@ -34,7 +33,7 @@ desc "Test everything"
 Rake::TestTask.new(:test) do |t|
   t.libs << './lib'
   t.pattern = 'test/test-*.rb'
-  t.verbose = true
+  t.options = '--verbose' if $VERBOSE
 end
 task :test => :lib
 
@@ -43,7 +42,7 @@ task :check => :test
 
 desc "Create a GNU-style ChangeLog via svn2cl"
 task :ChangeLog do
-  system("svn2cl --authors=svn2cl_usermap")
+  system('git log --pretty --numstat --summary | git2cl > ChangeLog')
 end
 
 task :default => [:test]
@@ -62,6 +61,7 @@ task :gemspec do
 end
 
 # ---------  RDoc Documentation ------
+require 'rdoc/task'
 desc "Generate rdoc documentation"
 Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'

data/lib/linecache.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-#   Copyright (C) 2007, 2008, 2009, 2010, 2011 Rocky Bernstein 
+#   Copyright (C) 2007-2011, 2014 Rocky Bernstein
 #   <rockyb@rubyforge.net>
 #
 #    This program is free software; you can redistribute it and/or modify
@@ -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.
@@ -59,23 +59,26 @@
 # and never destroys SCRIPT_LINES__
 SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
 
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
 require 'tempfile'
 require 'digest/sha1'
 require 'set'
 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.0'
+  VERSION = '1.2'
   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 = {} 
-  
+
+  # 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 = {}
+
   # Used for CodeRay syntax highlighting
   @@ruby_highlighter = nil
 
@@ -91,10 +94,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 = {}
 
-  @@iseq2file = {} 
+  @@iseq2file = {}
 
   module_function
 
@@ -105,10 +108,10 @@ module LineCache
   end
   at_exit { remove_iseq_temps }
 
-  
+
   # 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|
@@ -121,7 +124,7 @@ module LineCache
 
   # Clear the file cache entirely.
   def clear_file_cache(filename=nil)
-    if filename 
+    if filename
       if @@file_cache[filename]
         @@file_cache.delete(filename)
       end
@@ -150,7 +153,7 @@ module LineCache
   # 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, opts={})
-    
+
     if !filename
       filenames = @@file_cache.keys()
     elsif @@file_cache.member?(filename)
@@ -167,7 +170,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)
@@ -217,12 +220,12 @@ module LineCache
       nil
     end
   end
-      
+
   # Return true if file_or_iseq is cached
   def cached?(file_or_iseq)
-    if file_or_iseq.kind_of?(String) 
+    if file_or_iseq.kind_of?(String)
       @@file_cache.member?(map_file(file_or_iseq))
-    else 
+    else
       cached_iseq?(file_or_iseq)
     end
   end
@@ -232,7 +235,7 @@ module LineCache
     SCRIPT_LINES__.member?(map_file(filename))
   end
   module_function :cached_script?
-      
+
   def empty?(filename)
     filename=map_file(filename)
     @@file_cache[filename].lines.empty?
@@ -242,16 +245,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_iseq, line_number, opts={})
-    lines = 
+    lines =
       if file_or_iseq.kind_of?(String)
         filename = map_file(file_or_iseq)
         filename, line_number = map_file_line(filename, line_number)
@@ -272,7 +275,7 @@ module LineCache
   def iseq_getlines(iseq, opts={})
     return nil unless iseq.kind_of? RubyVM::InstructionSequence
     format = opts[:output] || :plain
-    line_formats = 
+    line_formats =
       if @@iseq_cache.member?(iseq)
         @@iseq_cache[iseq].lines
       else
@@ -301,7 +304,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]
@@ -343,7 +346,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]
@@ -351,12 +354,12 @@ module LineCache
       @@file2file_remap_lines[to_file]  = [[from_file, range, start]]
     end
   end
-  
+
   # Return SHA1 of filename.
   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|
@@ -365,7 +368,7 @@ module LineCache
     @@file_cache[filename].sha1 = sha1
     sha1.hexdigest
   end
-      
+
   # Return the number of lines in filename
   def size(file_or_iseq)
     cache(file_or_iseq)
@@ -396,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_iseq(iseq)
-    if @@iseq2file[iseq] 
-      @@iseq2file[iseq] 
-    else 
+    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
@@ -428,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
@@ -443,14 +446,14 @@ module LineCache
   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. 
+  # true if the cache was updated and false if not.
   def update_iseq_cache(iseq, opts)
     return false unless iseq_is_eval?(iseq)
     string = opts[:string] || iseq.eval_source
     lines = {:plain => string.split(/\n/)}
     lines[opts[:output]] = highlight_string(string, opts[:output]) if
       opts[:output]
-    @@iseq_cache[iseq] = 
+    @@iseq_cache[iseq] =
       LineCacheInfo.new(nil, nil, lines, nil, opts[:sha1])
     return true
   end
@@ -465,7 +468,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
@@ -486,10 +489,10 @@ 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
@@ -501,15 +504,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)
 
@@ -517,23 +520,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}"
   require 'thread_frame'
   puts eval("x=1
  LineCache::getline(RubyVM::ThreadFrame.current.iseq, 1)")

data/lib/tracelines.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# $Id: tracelines.rb 233 2010-12-18 23:12:20Z rockyb $
+# $Id$
 #   Copyright (C) 2007, 2008, 2009, 2010 
 #   Rocky Bernstein <rockyb@rubyforge.net>
 #

data/test/test-tracelines.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# $Id: test-tracelines.rb 191 2010-04-21 22:02:50Z rockyb $
+# $Id$
 require 'test/unit'
 require 'fileutils'
 require 'tempfile'

metadata

@@ -1,51 +1,49 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: linecache-tf
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  version: "1.0"
+version: !ruby/object:Gem::Version
+  version: '1.2'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - R. Bernstein
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-01 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rb-threadframe
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 32
-        version: "0.32"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.32'
   type: :runtime
-  version_requirements: *id001
-description: |
-  LineCache is a module for reading and caching lines. This may be useful for
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.32'
+description: ! '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.
 
+
+  This version works only with a patched version of Ruby 1.9.2 or 1.9.3 and rb-threadframe.
+
+'
 email: rockyb@rubyforge.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
 - lib/linecache.rb
 - lib/tracelines.rb
-files: 
+files:
 - AUTHORS
 - COPYING
 - ChangeLog
@@ -54,76 +52,67 @@ files:
 - Rakefile
 - lib/linecache.rb
 - lib/tracelines.rb
-- test/test-lnum.rb
-- test/test-tracelines.rb
-- test/parse-show.rb
-- test/test-linecache.rb
 - test/lnum-diag.rb
+- test/parse-show.rb
 - test/rcov-bug.rb
-- test/data/if4.rb
+- test/test-linecache.rb
+- test/test-lnum.rb
+- test/test-tracelines.rb
 - test/data/end.rb
-- test/data/if6.rb
-- test/data/begin3.rb
-- test/data/if3.rb
-- test/data/block2.rb
-- test/data/case2.rb
-- test/data/begin2.rb
 - test/data/each1.rb
-- test/data/if2.rb
-- test/data/case4.rb
-- test/data/if5.rb
-- test/data/if7.rb
+- test/data/not-lit.rb
 - test/data/match.rb
-- test/data/def1.rb
+- test/data/begin1.rb
+- test/data/begin2.rb
+- test/data/begin3.rb
+- test/data/block1.rb
+- test/data/block2.rb
 - test/data/case1.rb
+- test/data/case2.rb
 - test/data/case3.rb
-- test/data/match3a.rb
-- test/data/for1.rb
+- test/data/case4.rb
+- test/data/case5.rb
 - test/data/class1.rb
-- test/data/not-lit.rb
 - test/data/comments1.rb
+- test/data/def1.rb
+- test/data/for1.rb
 - test/data/if1.rb
-- test/data/block1.rb
-- test/data/case5.rb
+- test/data/if2.rb
+- test/data/if3.rb
+- test/data/if4.rb
+- test/data/if5.rb
+- test/data/if6.rb
+- test/data/if7.rb
 - test/data/match3.rb
-- test/data/begin1.rb
+- test/data/match3a.rb
 - 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 1.0 Documentation
-require_paths: 
+- LineCache 1.2 Documentation
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ~>
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 2
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: columnize
-rubygems_version: 1.3.7
+rubyforge_project: rocky-hacks
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Module to format an Array as an Array of String aligned in columns
+summary: Module to read and cache Ruby program files and file information
 test_files: []
-