jro_apps/redmine Commit - r8990:90c6a8579bb4

Merged r8876 from trunk....

Jean-Philippe Lang -

r8990:90c6a8579bb4

parent child

Context file:

r8990:90c6a8579bb4

Collapse all files

lib/redmine/unified_diff.rb +25 -24

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # 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 Redmine
               # Class used to parse unified diffs
               class UnifiedDiff < Array
                 attr_reader :diff_type
                 def initialize(diff, options={})
                   options.assert_valid_keys(:type, :max_lines)
                   diff = diff.split("\n") if diff.is_a?(String)
                   @diff_type = options[:type] || 'inline'
                   lines = 0
                   @truncated = false
                   diff_table = DiffTable.new(@diff_type)
                   diff.each do |line|
                     line_encoding = nil
                     if line.respond_to?(:force_encoding)
                       line_encoding = line.encoding
                       # TODO: UTF-16 and Japanese CP932 which is imcompatible with ASCII
                       #       In Japan, diffrence between file path encoding
                       #       and file contents encoding is popular.
                       line.force_encoding('ASCII-8BIT')
                     end
                     unless diff_table.add_line line
                       line.force_encoding(line_encoding) if line_encoding
                       self << diff_table if diff_table.length > 0
                       diff_table = DiffTable.new(diff_type)
                     end
                     lines += 1
                     if options[:max_lines] && lines > options[:max_lines]
                       @truncated = true
                       break
                     end
                   end
                   self << diff_table unless diff_table.empty?
                   self
                 end
                 def truncated?; @truncated; end
               end
               # Class that represents a file diff
               class DiffTable < Array
                 attr_reader :file_name
                 # Initialize with a Diff file and the type of Diff View
                 # The type view must be inline or sbs (side_by_side)
                 def initialize(type="inline")
                   @parsing = false
                   @added = 0
                   @removed = 0
                   @type = type
                 end
                 # Function for add a line of this Diff
                 # Returns false when the diff ends
                 def add_line(line)
                   unless @parsing
                     if line =~ /^(---|\+\+\+) (.*)$/
                       @file_name = $2
                     elsif line =~ /^@@ (\+|\-)(\d+)(,\d+)? (\+|\-)(\d+)(,\d+)? @@/
                       @line_num_l = $2.to_i
                       @line_num_r = $5.to_i
                       @parsing = true
                     end
                   else
                     if line =~ /^[^\+\-\s@\\]/
                       @parsing = false
                       return false
                     elsif line =~ /^@@ (\+|\-)(\d+)(,\d+)? (\+|\-)(\d+)(,\d+)? @@/
                       @line_num_l = $2.to_i
                       @line_num_r = $5.to_i
                     else
                       parse_line(line, @type)
                     end
                   end
                   return true
                 end
                 def each_line
                   prev_line_left, prev_line_right = nil, nil
                   each do |line|
                     spacing = prev_line_left && prev_line_right && (line.nb_line_left != prev_line_left+1) && (line.nb_line_right != prev_line_right+1)
                     yield spacing, line
                     prev_line_left = line.nb_line_left.to_i if line.nb_line_left.to_i > 0
                     prev_line_right = line.nb_line_right.to_i if line.nb_line_right.to_i > 0
                   end
                 end
                 def inspect
                   puts '### DIFF TABLE ###'
                   puts "file : #{file_name}"
                   self.each do |d|
                     d.inspect
                   end
                 end
                 private
-                # Escape the HTML for the diff
-                def escapeHTML(line)
-                    CGI.escapeHTML(line)
-                end
                 def diff_for_added_line
                   if @type == 'sbs' && @removed > 0 && @added < @removed
                     self[-(@removed - @added)]
                   else
                     diff = Diff.new
                     self << diff
                     diff
                   end
                 end
                 def parse_line(line, type="inline")
                   if line[0, 1] == "+"
                     diff = diff_for_added_line
-                    diff.line_right = escapeHTML line[1..-1]
+                    diff.line_right = line[1..-1]
                     diff.nb_line_right = @line_num_r
                     diff.type_diff_right = 'diff_in'
                     @line_num_r += 1
                     @added += 1
                     true
                   elsif line[0, 1] == "-"
                     diff = Diff.new
-                    diff.line_left = escapeHTML line[1..-1]
+                    diff.line_left = line[1..-1]
                     diff.nb_line_left = @line_num_l
                     diff.type_diff_left = 'diff_out'
                     self << diff
                     @line_num_l += 1
                     @removed += 1
                     true
                   else
                     write_offsets
                     if line[0, 1] =~ /\s/
                       diff = Diff.new
-                      diff.line_right = escapeHTML line[1..-1]
+                      diff.line_right = line[1..-1]
                       diff.nb_line_right = @line_num_r
-                      diff.line_left = escapeHTML line[1..-1]
+                      diff.line_left = line[1..-1]
                       diff.nb_line_left = @line_num_l
                       self << diff
                       @line_num_l += 1
                       @line_num_r += 1
                       true
                     elsif line[0, 1] = "\\"
                       true
                     else
                       false
                     end
                   end
                 end
                 def write_offsets
                   if @added > 0 && @added == @removed
                     @added.times do |i|
                       line = self[-(1 + i)]
                       removed = (@type == 'sbs') ? line : self[-(1 + @added + i)]
                       offsets = offsets(removed.line_left, line.line_right)
                       removed.offsets = line.offsets = offsets
                     end
                   end
                   @added = 0
                   @removed = 0
                 end
                 def offsets(line_left, line_right)
                   if line_left.present? && line_right.present? && line_left != line_right
                     max = [line_left.size, line_right.size].min
                     starting = 0
                     while starting < max && line_left[starting] == line_right[starting]
                       starting += 1
                     end
                     ending = -1
                     while ending >= -(max - starting) && line_left[ending] == line_right[ending]
                       ending -= 1
                     end
                     unless starting == 0 && ending == -1
                       [starting, ending]
                     end
                   end
                 end
               end
               # A line of diff
               class Diff
                 attr_accessor :nb_line_left
                 attr_accessor :line_left
                 attr_accessor :nb_line_right
                 attr_accessor :line_right
                 attr_accessor :type_diff_right
                 attr_accessor :type_diff_left
                 attr_accessor :offsets
                 def initialize()
                   self.nb_line_left = ''
                   self.nb_line_right = ''
                   self.line_left = ''
                   self.line_right = ''
                   self.type_diff_right = ''
                   self.type_diff_left = ''
                 end
                 def type_diff
                   type_diff_right == 'diff_in' ? type_diff_right : type_diff_left
                 end
                 def line
                   type_diff_right == 'diff_in' ? line_right : line_left
                 end
                 def html_line_left
-                  if offsets
+                  line_to_html(line_left, offsets)
-                    line_left.dup.insert(offsets.first, '<span>').insert(offsets.last, '</span>')
-                  else
-                    line_left
-                  end
                 end
                 def html_line_right
-                  if offsets
+                  line_to_html(line_right, offsets)
-                    line_right.dup.insert(offsets.first, '<span>').insert(offsets.last, '</span>')
-                  else
-                    line_right
-                  end
                 end
                 def html_line
-                  if offsets
+                  line_to_html(line, offsets)
-                    line.dup.insert(offsets.first, '<span>').insert(offsets.last, '</span>')
-                  else
-                    line
-                  end
                 end
                 def inspect
                   puts '### Start Line Diff ###'
                   puts self.nb_line_left
                   puts self.line_left
                   puts self.nb_line_right
                   puts self.line_right
                 end
+                private
+                def line_to_html(line, offsets)
+                  if offsets
+                    s = ''
+                    unless offsets.first == 0
+                      s << CGI.escapeHTML(line[0..offsets.first-1])
+                    end
+                    s << '<span>' + CGI.escapeHTML(line[offsets.first..offsets.last]) + '</span>'
+                    unless offsets.last == -1
+                      s << CGI.escapeHTML(line[offsets.last+1..-1])
+                    end
+                    s
+                  else
+                    CGI.escapeHTML(line)
+                  end
+                end
               end
             end

test/unit/lib/redmine/unified_diff_test.rb +23 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # 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.
             require File.expand_path('../../../../test_helper', __FILE__)
             class Redmine::UnifiedDiffTest < ActiveSupport::TestCase
               def setup
               end
               def test_subversion_diff
                 diff = Redmine::UnifiedDiff.new(read_diff_fixture('subversion.diff'))
                 # number of files
                 assert_equal 4, diff.size
                 assert diff.detect {|file| file.file_name =~ %r{^config/settings.yml}}
               end
               def test_truncate_diff
                 diff = Redmine::UnifiedDiff.new(read_diff_fixture('subversion.diff'), :max_lines => 20)
                 assert_equal 2, diff.size
               end
               def test_inline_partials
                 diff = Redmine::UnifiedDiff.new(read_diff_fixture('partials.diff'))
                 assert_equal 1, diff.size
                 diff = diff.first
                 assert_equal 43, diff.size
                 assert_equal [51, -1], diff[0].offsets
                 assert_equal [51, -1], diff[1].offsets
                 assert_equal 'Lorem ipsum dolor sit amet, consectetur adipiscing <span>elit</span>', diff[0].html_line
                 assert_equal 'Lorem ipsum dolor sit amet, consectetur adipiscing <span>xx</span>', diff[1].html_line
                 assert_nil diff[2].offsets
                 assert_equal 'Praesent et sagittis dui. Vivamus ac diam diam', diff[2].html_line
                 assert_equal [0, -14], diff[3].offsets
                 assert_equal [0, -14], diff[4].offsets
                 assert_equal '<span>Ut sed</span> auctor justo', diff[3].html_line
                 assert_equal '<span>xxx</span> auctor justo', diff[4].html_line
                 assert_equal [13, -19], diff[6].offsets
                 assert_equal [13, -19], diff[7].offsets
                 assert_equal [24, -8], diff[9].offsets
                 assert_equal [24, -8], diff[10].offsets
                 assert_equal [37, -1], diff[12].offsets
                 assert_equal [37, -1], diff[13].offsets
                 assert_equal [0, -38], diff[15].offsets
                 assert_equal [0, -38], diff[16].offsets
               end
               def test_side_by_side_partials
                 diff = Redmine::UnifiedDiff.new(read_diff_fixture('partials.diff'), :type => 'sbs')
                 assert_equal 1, diff.size
                 diff = diff.first
                 assert_equal 32, diff.size
                 assert_equal [51, -1], diff[0].offsets
                 assert_equal 'Lorem ipsum dolor sit amet, consectetur adipiscing <span>elit</span>', diff[0].html_line_left
                 assert_equal 'Lorem ipsum dolor sit amet, consectetur adipiscing <span>xx</span>', diff[0].html_line_right
                 assert_nil diff[1].offsets
                 assert_equal 'Praesent et sagittis dui. Vivamus ac diam diam', diff[1].html_line_left
                 assert_equal 'Praesent et sagittis dui. Vivamus ac diam diam', diff[1].html_line_right
                 assert_equal [0, -14], diff[2].offsets
                 assert_equal '<span>Ut sed</span> auctor justo', diff[2].html_line_left
                 assert_equal '<span>xxx</span> auctor justo', diff[2].html_line_right
                 assert_equal [13, -19], diff[4].offsets
                 assert_equal [24, -8], diff[6].offsets
                 assert_equal [37, -1], diff[8].offsets
                 assert_equal [0, -38], diff[10].offsets
               end
+              def test_partials_with_html_entities
+                raw = <<-DIFF
+            --- test.orig.txt Wed Feb 15 16:10:39 2012
+            +++ test.new.txt  Wed Feb 15 16:11:25 2012
+            @@ -1,5 +1,5 @@
+             Semicolons were mysteriously appearing in code diffs in the repository
+            -void DoSomething(std::auto_ptr<MyClass> myObj)
+            +void DoSomething(const MyClass& myObj)
+            DIFF
+                diff = Redmine::UnifiedDiff.new(raw, :type => 'sbs')
+                assert_equal 1, diff.size
+                assert_equal 'void DoSomething(<span>std::auto_ptr&lt;MyClass&gt;</span> myObj)', diff.first[2].html_line_left
+                assert_equal 'void DoSomething(<span>const MyClass&amp;</span> myObj)', diff.first[2].html_line_right
+                diff = Redmine::UnifiedDiff.new(raw, :type => 'inline')
+                assert_equal 1, diff.size
+                assert_equal 'void DoSomething(<span>std::auto_ptr&lt;MyClass&gt;</span> myObj)', diff.first[2].html_line
+                assert_equal 'void DoSomething(<span>const MyClass&amp;</span> myObj)', diff.first[3].html_line
+              end
               def test_line_starting_with_dashes
                 diff = Redmine::UnifiedDiff.new(<<-DIFF
             --- old.txt Wed Nov 11 14:24:58 2009
             +++ new.txt Wed Nov 11 14:25:02 2009
             @@ -1,8 +1,4 @@
             -Lines that starts with dashes:
             -
             -------------------------
             --- file.c
             -------------------------
             +A line that starts with dashes:
              and removed.
             @@ -23,4 +19,4 @@
             -Another chunk of change
             +Another chunk of changes
             DIFF
                 )
                 assert_equal 1, diff.size
               end
               def test_one_line_new_files
                 diff = Redmine::UnifiedDiff.new(<<-DIFF
             diff -r 000000000000 -r ea98b14f75f0 README1
             --- /dev/null
             +++ b/README1
             @@ -0,0 +1,1 @@
             +test1
             diff -r 000000000000 -r ea98b14f75f0 README2
             --- /dev/null
             +++ b/README2
             @@ -0,0 +1,1 @@
             +test2
             diff -r 000000000000 -r ea98b14f75f0 README3
             --- /dev/null
             +++ b/README3
             @@ -0,0 +1,3 @@
             +test4
             +test5
             +test6
             diff -r 000000000000 -r ea98b14f75f0 README4
             --- /dev/null
             +++ b/README4
             @@ -0,0 +1,3 @@
             +test4
             +test5
             +test6
             DIFF
                 )
                 assert_equal 4, diff.size
               end
               private
               def read_diff_fixture(filename)
                 File.new(File.join(File.dirname(__FILE__), '/../../../fixtures/diffs', filename)).read
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages