linecache2 1.4.0

data/lib/linecache2/colors.rb

@@ -0,0 +1,77 @@
+require 'term/ansicolor'
+require 'coderay'
+module LineCache
+  ColorScheme = {
+    light: CodeRay::Encoders::Terminal::TOKEN_COLORS.clone,
+    # Adapted from the above
+    dark: {:debug=>"\e[1;37;44m",
+           :annotation=>"\e[33m",
+           :attribute_name=>"\e[35m",
+           :attribute_value=>"\e[31m",
+           :binary=>{:self=>"\e[31m", :char=>"\e[1;31m", :delimiter=>"\e[1;31m"},
+           :char=>{:self=>"\e[35m", :delimiter=>"\e[1;35m"},
+           :class=> '',  # "\e[1;36m",
+           :class_variable=> '', # "\e[0;33m",
+           :color=> '', # "\e[32m",
+           :comment=>{:self=>"\e[3;31m", :char=>"\e[0;36m", :delimiter=>"\e[0;36m"},
+           :constant=>"\e[0;36;4m",
+           :decorator=>"\e[35m",
+           :definition=>"\e[1;33m",
+           :directive=>"\e[33m",
+           :docstring=>"\e[31m",
+           :doctype=>"\e[1;33m",
+           :done=>"\e[1;30;2m",
+           :entity=>"\e[31m",
+           :error=>"\e[1;37;41m",
+           :exception=>"\e[1;31m",
+           :float=>"\e[1;35m",
+           :function=>"\e[1;33m",
+           :global_variable=>"\e[1;32m",
+           :hex=>"\e[1;36m",
+           :id=>"\e[1;33m",
+           :include=>"\e[31m",
+           :integer=>"\e[1;34m",
+           :imaginary=>"\e[1;34m",
+           :important=>"\e[1;31m",
+           :key=>{:self=>"\e[35m", :char=>"\e[1;35m", :delimiter=>"\e[1;35m"},
+           :keyword=>"\e[32m",
+           :label=>"\e[1;33m",
+           :local_variable=>"\e[33m",
+           :namespace=>"\e[1;35m",
+           :octal=>"\e[1;33m",
+           :predefined=>"\e[36m",
+           :predefined_constant=>"\e[1;36m",
+           :predefined_type=>"\e[1;32m",
+           :preprocessor=>"\e[1;36m",
+           :pseudo_class=>"\e[1;33m",
+           :regexp=>
+           {:self=>"\e[35m",
+            :delimiter=>"\e[1;35m",
+            :modifier=>"\e[35m",
+            :char=>"\e[1;35m"},
+           :reserved=>"\e[32m",
+           :shell=>
+           {:self=>"\e[33m",
+            :char=>"\e[1;33m",
+            :delimiter=>"\e[1;33m",
+            :escape=>"\e[1;33m"},
+           :string=>
+           {:self=>"\e[33m",
+            :modifier=>"\e[1;31m",
+            :char=>"\e[1;35m",
+            :delimiter=>"\e[1;36m",
+            :escape=>"\e[1;31m"},
+           :symbol=>{:self=>"\e[33m", :delimiter=>"\e[1;33m"},
+           :tag=>"\e[32m",
+           :type=>"\e[1;33m",
+           :value=>"\e[36m",
+           :variable=>"\e[33m",
+           :insert=>{:self=>"\e[42m", :insert=>"\e[1;32;42m", :eyecatcher=>"\e[102m"},
+           :delete=>{:self=>"\e[41m", :delete=>"\e[1;31;41m", :eyecatcher=>"\e[101m"},
+           :change=>{:self=>"\e[44m", :change=>"\e[37;44m"},
+           :head=>{:self=>"\e[45m", :filename=>"\e[37;45m"},
+           :method=>"\e[3;33m",
+           :escape=>nil}
+    # Extend by adding keys for your own style
+    }
+end

data/lib/linecache2/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+#
+# Reopen main module to define the library version
+#
+module LineCache
+  VERSION = '1.4.0'.freeze
+end

data/lib/tracelines.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+#   Copyright (C) 2007, 2008, 2009, 2010, 2014
+#   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
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    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.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program; if not, write to the Free Software
+#    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+#    02110-1301 USA.
+
+module TraceLineNumbers
+
+  def self.lnums_for_str src
+    name = "#{Time.new.to_i}_#{rand(2**31)}"
+    iseq = RubyVM::InstructionSequence.compile(src, name)
+    lines = {}
+    iseq.disasm.each_line{|line|
+      if /^\d+ (\w+)\s+.+\(\s*(\d+)\)$/ =~ line
+        insn = $1
+        lineno = $2.to_i
+        next unless insn == 'trace'
+        lines[lineno] = true
+        # p [lineno, line]
+      end
+    }
+    lines.keys
+  end
+
+  # Return an array of lines numbers that could be
+  # stopped at given a file name of a Ruby program.
+  def lnums_for_file(file)
+    lnums_for_str(File.read(file))
+  end
+  module_function :lnums_for_file
+
+  # Return an array of lines numbers that could be
+  # stopped at given a string array.
+  def lnums_for_str_array(string_array, newline='', uniq=true)
+    lnums_for_str(string_array.join(newline))
+  end
+  module_function :lnums_for_str_array
+end
+
+if __FILE__ == $0
+  SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
+  # test_file = '../test/rcov-bug.rb'
+  test_file = '../test/lnum-data/begin1.rb'
+  if  File.exists?(test_file)
+    puts TraceLineNumbers.lnums_for_file(test_file).inspect
+    load(test_file, 0) # for later
+  end
+  puts TraceLineNumbers.lnums_for_file(__FILE__).inspect
+  unless SCRIPT_LINES__.empty?
+    key = SCRIPT_LINES__.keys.first
+    puts key
+    puts SCRIPT_LINES__[key]
+    puts TraceLineNumbers.lnums_for_str_array(SCRIPT_LINES__[key]).inspect
+  end
+end

data/test/data/begin1.rb

@@ -0,0 +1,3 @@
+# [ 3 ]
+begin
+end

data/test/data/begin2.rb

@@ -0,0 +1,3 @@
+# [ 2 ]
+begin begin end end
+  

data/test/data/begin3.rb

@@ -0,0 +1,5 @@
+# [ 4 ]
+begin
+  begin
+  end
+end 

data/test/data/block1.rb

@@ -0,0 +1,7 @@
+# [2, 3, 4, 6]
+if true
+  puts '3'
+  puts '4'
+end
+if true
+end

data/test/data/block2.rb

@@ -0,0 +1,4 @@
+# [2, 4, 3]
+def foo(&block)
+end
+foo{4}

data/test/data/case1.rb

@@ -0,0 +1,6 @@
+# [ 2 ]
+case 2
+when 3
+when 4
+else
+end

data/test/data/case2.rb

@@ -0,0 +1,5 @@
+# [ 5 ]
+case
+when 3 != 3
+when 4 != 4
+end

data/test/data/case3.rb

@@ -0,0 +1,5 @@
+# [2]
+case "2"
+when Array
+when Fixnum
+end

data/test/data/case4.rb

@@ -0,0 +1,4 @@
+# [2]
+case "2"
+when Array, Fixnum
+end

data/test/data/case5.rb

@@ -0,0 +1,9 @@
+# [ 2, 4, 6]
+case '3'
+when '4'
+  x = 5
+when '6'
+  x = 7
+else
+  x = 9
+end

data/test/data/class1.rb

@@ -0,0 +1,5 @@
+# [3, 4, 5]
+class
+  A 
+  class B ; 
+  end end

data/test/data/comments1.rb

@@ -0,0 +1,3 @@
+# [ ]
+
+ # space here and in next line

data/test/data/def1.rb

@@ -0,0 +1,9 @@
+# [2, 4, 6, 3, 5, 9]
+def
+  a ; end
+def b
+end
+def c(
+      a=7,
+      b=8)
+end

data/test/data/each1.rb

@@ -0,0 +1,3 @@
+# [ 2 ]
+[2].each { }
+

data/test/data/end.rb

@@ -0,0 +1,3 @@
+# [ 3 ]
+# POSTEXE
+END { }

data/test/data/for1.rb

@@ -0,0 +1,4 @@
+# [ 2, 3, 4 ]
+for i in [2] 
+  i
+end

data/test/data/if1.rb

@@ -0,0 +1,4 @@
+# [ 2 ]
+x = true ? 1 : 2
+  
+

data/test/data/if2.rb

@@ -0,0 +1,4 @@
+# [ 2 ]
+x = 2 if false
+  
+

data/test/data/if3.rb

@@ -0,0 +1,9 @@
+# [ 2, 3, 4, 5, 6]
+lines = ''
+opts = {:print_source => true}
+if opts[:print_source]
+    puts 5
+    puts lines
+end
+  
+

data/test/data/if4.rb

@@ -0,0 +1,12 @@
+# [ 6, 7, 8, 10, 12 ]
+
+# Running through Tracer will not give the line numbers in the same
+# order. Also note 9 before 7. This is because in the parse tree
+# != has been turned into == with the branches switched.
+[true, false].each do |t|
+  if t != true
+    8
+  else
+    10
+  end
+end

data/test/data/if5.rb

@@ -0,0 +1,6 @@
+# [2, 4]
+x=2
+x=3 if x=='a' or
+  false
+# What's weird here is we get two stops on line 4 and both times x is
+# 4. In Ruby 1.9 we don't get *any* line traces.

data/test/data/if6.rb

@@ -0,0 +1,4 @@
+# [ 2 ]
+x = 2 if x==3
+  
+

data/test/data/if7.rb

@@ -0,0 +1,6 @@
+# [ 2, 6, 3, 4, 5 ]
+def f()
+  y=1
+  true
+end
+x = 2 if f()

data/test/data/match.rb

@@ -0,0 +1,3 @@
+# [ 3 ]
+# MATCH -- FIXME we are not getting a match token.
+/.*/

data/test/data/match3.rb

@@ -0,0 +1,5 @@
+# [ 5 ]
+# MATCH3
+3 =~ /
+  x*
+/

data/test/data/match3a.rb

@@ -0,0 +1,6 @@
+# [ 3, 6 ]
+# MATCH3
+y = 3
+4 =~ /
+  #{y}*
+/

data/test/data/not-lit.rb

@@ -0,0 +1,6 @@
+# [ 4, 6 ]
+# not and lit
+3 
+not 4
+not 
+  6

data/test/lnum-diag.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+
+# begin require 'rubygems' rescue LoadError end
+# require 'ruby-debug' ; Debugger.start
+
+TEST_DIR = File.expand_path(File.dirname(__FILE__))
+TOP_SRC_DIR = File.join(TEST_DIR, '..')
+require File.join(TOP_SRC_DIR, 'lib', 'tracelines.rb')
+
+def dump_file(file, opts)
+  puts file
+  begin
+    fp = File.open(file, 'r')
+  rescue Errno::ENOENT
+    puts "File #{file} is not readable."
+    return
+  end
+  lines = fp.read
+  if opts[:print_source]
+    puts '=' * 80
+    puts lines
+  end
+  if opts[:print_parse]
+    puts '=' * 80
+    cmd = "#{File.join(TEST_DIR, 'parse-show.rb')} #{file}"
+    system(cmd)
+  end
+  if opts[:print_trace]
+    require 'tracer'
+    puts '=' * 80
+    tracer = Tracer.new
+    tracer.add_filter lambda {|event, f, line, id, binding, klass|
+      __FILE__ != f && event == 'line'
+    }
+    tracer.on{load(file)}
+  end
+  expected_lnums = nil
+  if opts[:expect_line]
+    fp.rewind
+    first_line = fp.readline.chomp
+    expected_str = first_line[1..-1]
+    begin
+      expected_lnums = eval(expected_str, binding, __FILE__, __LINE__)
+    rescue SyntaxError
+      puts '=' * 80
+      puts "Failed reading expected values from #{file}"
+    end
+  end
+  fp.close()
+  got_lnums = TraceLineNumbers.lnums_for_str(lines)
+  if expected_lnums
+    puts "expecting: #{expected_lnums.inspect}"
+    puts '-' * 80
+    if expected_lnums 
+      if got_lnums != expected_lnums
+        puts "mismatch: #{got_lnums.inspect}"
+      else
+        puts 'Got what was expected.'
+      end
+    else
+      puts got_lnums.inspect
+    end
+  else
+    puts got_lnums.inspect
+  end
+end
+
+require 'getoptlong'
+program = File.basename($0)
+opts = {
+  :print_source => true,  # Print source file? 
+  :print_trace  => true,  # Run Tracer over file? 
+  :expect_line  => true,  # Source file has expected (correct) list of lines?
+  :print_parse  => true,  # Show ParseTree output?
+}
+
+getopts = GetoptLong.new(
+                         [ '--expect',      '-e', GetoptLong::NO_ARGUMENT ],
+                         [ '--no-expect',   '-E', GetoptLong::NO_ARGUMENT ],
+                         [ '--help',        '-h', GetoptLong::NO_ARGUMENT ],
+                         [ '--parse',       '-p', GetoptLong::NO_ARGUMENT ],
+                         [ '--no-parse',    '-P', GetoptLong::NO_ARGUMENT ],
+                         [ '--source',      '-s', GetoptLong::NO_ARGUMENT ],
+                         [ '--no-source',   '-S', GetoptLong::NO_ARGUMENT ],
+                         [ '--trace',       '-t', GetoptLong::NO_ARGUMENT ],
+                         [ '--no-trace',    '-T', GetoptLong::NO_ARGUMENT ])
+
+getopts.each do |opt, arg|
+  case opt
+    when '--help'
+    puts "usage 
+Usage: #{$program} [options] file1 file2 ...
+
+Diagnostic program to make see what TraceLineNumbers does and compare
+against other output.
+
+options:
+    -e --expect      Read source file expected comment (default)
+    -E --no-expect   Don't look for source file expected comment
+    -p --parse       Show ParseTree Output (default)
+    -P --no-parse    Don't show ParseTree output
+    -s --source      Show source file (default)
+    -S --no-source   Don't print source
+    -t --trace       Show Tracer output (default)
+    -T --no-trace    Don't show Tracer output
+"
+  when '--expect'
+    opts[:expect_line] = true
+  when '--no-expect'
+    opts[:expect_line] = false
+  when '--parse'
+    opts[:print_parse] = true
+  when '--no-parse'
+    opts[:print_parse] = false
+  when '--source'
+    opts[:print_source] = true
+  when '--no-source'
+    opts[:print_source] = false
+  when '--trace'
+    opts[:print_trace] = true
+  when '--no-trace'
+    opts[:print_trace] = false
+  else
+    puts "Unknown and ignored option #{opt}"
+  end
+end
+
+ARGV.each do |file| 
+  dump_file(file, opts)
+end